Class ConversationsClient

Hierarchy

GhlClient
- ConversationsClient

Index

Constructors

Methods

findById update remove create search findEmailById cancelScheduledEmail findMessageById findMessagesByConversationId sendMessage addInboundMessage addOutboundMessage cancelScheduledMessage uploadFileAttachments updateMessageStatus findMessageRecording findMessageTranscription downloadMessageTranscription

Constructors

constructor

new ConversationsClient(accessToken: string): ConversationsClient
Parameters
- accessToken: string
Returns ConversationsClient
Overrides GhlClient.constructor
- Defined in conversations/conversations.client.ts:26

Methods

findById

findById(id: string): Promise<ConversationResponse>
Parameters
- id: string
Returns Promise<ConversationResponse>
- Defined in conversations/conversations.client.ts:30

update

update(
id: string,
dto: UpdateConversationDto,
): Promise<ConversationActionResponse>
Parameters
- id: string
- dto: UpdateConversationDto
Returns Promise<ConversationActionResponse>
- Defined in conversations/conversations.client.ts:34

remove

remove(id: string): Promise<SuccessDeleteResponse>
Parameters
- id: string
Returns Promise<SuccessDeleteResponse>
- Defined in conversations/conversations.client.ts:41

create

create(dto: CreateConversationDto): Promise<ConversationActionResponse>
Parameters
- dto: CreateConversationDto
Returns Promise<ConversationActionResponse>
- Defined in conversations/conversations.client.ts:45

search

search(params: ConversationSearchParams): Promise<ConversationSearchResponse>
Parameters
- params: ConversationSearchParams
Returns Promise<ConversationSearchResponse>
- Defined in conversations/conversations.client.ts:51

findEmailById

findEmailById(emailId: string): Promise<ConversationEmailResponse>
Parameters
- emailId: string
Returns Promise<ConversationEmailResponse>
- Defined in conversations/conversations.client.ts:57

cancelScheduledEmail

cancelScheduledEmail(
emailId: string,
): Promise<ConversationCancelScheduledResponse>
Parameters
- emailId: string
Returns Promise<ConversationCancelScheduledResponse>
- Defined in conversations/conversations.client.ts:63

findMessageById

findMessageById(messageId: string): Promise<ConversationMessageResponse>
Parameters
- messageId: string
Returns Promise<ConversationMessageResponse>
- Defined in conversations/conversations.client.ts:69

findMessagesByConversationId

findMessagesByConversationId(
conversationId: string,
params: ConversationSearchParams,
): Promise<ListConversationMessagesResponse>
Parameters
- conversationId: string
- params: ConversationSearchParams
Returns Promise<ListConversationMessagesResponse>
- Defined in conversations/conversations.client.ts:75

sendMessage

sendMessage(
dto: ConversationMessageDto,
): Promise<SendConversationMessageResponse>
Parameters
- dto: ConversationMessageDto
Returns Promise<SendConversationMessageResponse>
- Defined in conversations/conversations.client.ts:82

addInboundMessage

addInboundMessage(
dto: ConversationInboundMessageDto,
): Promise<ConversationProcessMessageResponse>
Parameters
- dto: ConversationInboundMessageDto
Returns Promise<ConversationProcessMessageResponse>
- Defined in conversations/conversations.client.ts:88

addOutboundMessage

addOutboundMessage(
dto: ConversationOutboundMessageDto,
): Promise<ConversationProcessMessageResponse>
Parameters
- dto: ConversationOutboundMessageDto
Returns Promise<ConversationProcessMessageResponse>
- Defined in conversations/conversations.client.ts:94

cancelScheduledMessage

cancelScheduledMessage(
messageId: string,
): Promise<ConversationCancelScheduledResponse>
Parameters
- messageId: string
Returns Promise<ConversationCancelScheduledResponse>
- Defined in conversations/conversations.client.ts:100

uploadFileAttachments

uploadFileAttachments(
dto: ConversationUploadFilesDto,
): Promise<ConversationUploadFilesResponse>
Parameters
- dto: ConversationUploadFilesDto
Returns Promise<ConversationUploadFilesResponse>
- Defined in conversations/conversations.client.ts:106

updateMessageStatus

updateMessageStatus(
messageId: string,
dto: ConversationUpdateMessageStatusDto,
): Promise<SendConversationMessageResponse>
Parameters
- messageId: string
- dto: ConversationUpdateMessageStatusDto
Returns Promise<SendConversationMessageResponse>
- Defined in conversations/conversations.client.ts:112

findMessageRecording

findMessageRecording(locationId: string, messageId: string): Promise<any>
Parameters
- locationId: string
- messageId: string
Returns Promise<any>
- Defined in conversations/conversations.client.ts:119

findMessageTranscription

findMessageTranscription(
locationId: string,
messageId: string,
): Promise<ConverstationMessageTranscriptionResponse>
Parameters
- locationId: string
- messageId: string
Returns Promise<ConverstationMessageTranscriptionResponse>
- Defined in conversations/conversations.client.ts:128

downloadMessageTranscription

downloadMessageTranscription(
locationId: string,
messageId: string,
): Promise<any>
Parameters
- locationId: string
- messageId: string
Returns Promise<any>
- Defined in conversations/conversations.client.ts:137