api.md

Organizations

Types:

• OrganizationRetrieveIDResponse

Methods:

• client.organizations.retrieveID() -> OrganizationRetrieveIDResponse

Websites

Types:

• WebsiteRetrieveResponse

Methods:

• client.websites.retrieve({ ...params }) -> WebsiteRetrieveResponse

Messages

Types:

• MessageSendResponse

Methods:

• client.messages.send({ ...params }) -> MessageSendResponse

Conversations

Types:

• ConversationCreateResponse
• ConversationRetrieveResponse
• ConversationListResponse
• ConversationGetTimelineResponse
• ConversationReportTypingResponse
• ConversationSubmitRatingResponse

Methods:

• client.conversations.create({ ...params }) -> ConversationCreateResponse
• client.conversations.retrieve(conversationID, { ...params }) -> ConversationRetrieveResponse
• client.conversations.list({ ...params }) -> ConversationListResponse
• client.conversations.getTimeline(conversationID, { ...params }) -> ConversationGetTimelineResponse
• client.conversations.reportTyping(conversationID, { ...params }) -> ConversationReportTypingResponse
• client.conversations.submitRating(conversationID, { ...params }) -> ConversationSubmitRatingResponse

Seen

Types:

• SeenGetSeenDataResponse
• SeenMarkAsSeenResponse

Methods:

• client.conversations.seen.getSeenData(conversationID) -> SeenGetSeenDataResponse
• client.conversations.seen.markAsSeen(conversationID, { ...params }) -> SeenMarkAsSeenResponse

Visitors

ID

Types:

• IDRetrieveIDResponse
• IDUpdateIDResponse
• IDUpdateMetadataResponse

Methods:

• client.visitors.id.retrieveID() -> IDRetrieveIDResponse
• client.visitors.id.updateID({ ...params }) -> IDUpdateIDResponse
• client.visitors.id.updateMetadata({ ...params }) -> IDUpdateMetadataResponse

Contacts

Types:

• ContactCreateResponse
• ContactIdentifyResponse

Methods:

• client.contacts.create({ ...params }) -> ContactCreateResponse
• client.contacts.identify({ ...params }) -> ContactIdentifyResponse

Organizations

Types:

• OrganizationCreateResponse

Methods:

• client.contacts.organizations.create({ ...params }) -> OrganizationCreateResponse

ID

Types:

• IDRetrieveIDResponse
• IDUpdateIDResponse

Methods:

• client.contacts.organizations.id.deleteID() -> void
• client.contacts.organizations.id.retrieveID() -> IDRetrieveIDResponse
• client.contacts.organizations.id.updateID({ ...params }) -> IDUpdateIDResponse

ID

Types:

• IDRetrieveIDResponse
• IDUpdateIDResponse
• IDUpdateMetadataResponse

Methods:

• client.contacts.id.deleteID() -> void
• client.contacts.id.retrieveID() -> IDRetrieveIDResponse
• client.contacts.id.updateID({ ...params }) -> IDUpdateIDResponse
• client.contacts.id.updateMetadata({ ...params }) -> IDUpdateMetadataResponse

Uploads

Types:

• UploadCreateSignURLResponse

Methods:

• client.uploads.createSignURL({ ...params }) -> UploadCreateSignURLResponse

Knowledge

Types:

• KnowledgeCreateResponse
• KnowledgeListResponse

Methods:

• client.knowledge.create({ ...params }) -> KnowledgeCreateResponse
• client.knowledge.list({ ...params }) -> KnowledgeListResponse

ID

Types:

• IDRetrieveIDResponse
• IDUpdateIDResponse

Methods:

• client.knowledge.id.deleteID() -> void
• client.knowledge.id.retrieveID() -> IDRetrieveIDResponse
• client.knowledge.id.updateID({ ...params }) -> IDUpdateIDResponse

Feedback

Types:

• FeedbackListResponse
• FeedbackRetrieveIDResponse
• FeedbackSubmitResponse

Methods:

• client.feedback.list({ ...params }) -> FeedbackListResponse
• client.feedback.retrieveID() -> FeedbackRetrieveIDResponse
• client.feedback.submit({ ...params }) -> FeedbackSubmitResponse