Class EventsApi

Hierarchy

ConversationDomainApi
- EventsApi

Index

Methods

delete get list send sendAgentJoinedEvent sendAgentLeftEvent sendCommentReplyEvent sendComposingEndEvent sendComposingEvent sendGenericEvent setBasePath

Methods

delete

delete(data: DeleteEventRequestData): Promise<any>
Delete an event Delete a specific event by its ID.
Parameters
- data: DeleteEventRequestData
  The data to provide to the API call.
Returns Promise<any>

get

get(data: GetEventRequestData): Promise<ConversationEvent>
Get an event Get event from ID
Parameters
- data: GetEventRequestData
  The data to provide to the API call.
Returns Promise<ConversationEvent>

list

list(data: ListEventsRequestData): ApiListPromise<ConversationEvent>
List events List all events in a project
Parameters
- data: ListEventsRequestData
  The data to provide to the API call.
Returns ApiListPromise<ConversationEvent>

send

send(data: SendEventRequestData<Recipient>): Promise<SendEventResponse>
Send an event Sends an event to the referenced contact from the referenced app. Note that this operation enqueues the event in a queue so a successful response only indicates that the event has been queued.
Parameters
- data: SendEventRequestData<Recipient>
  The data to provide to the API call.
Returns Promise<SendEventResponse>

sendAgentJoinedEvent

sendAgentJoinedEvent(
data: SendAgentJoinedEventRequestData<Recipient>,
): Promise<SendEventResponse>
Send an agent joined event Sends an event to the referenced contact from the referenced app. Note that this operation enqueues the event in a queue so a successful response only indicates that the event has been queued.
Parameters
- data: SendAgentJoinedEventRequestData<Recipient>
  The data to provide to the API call.
Returns Promise<SendEventResponse>

sendAgentLeftEvent

sendAgentLeftEvent(
data: SendAgentLeftEventRequestData<Recipient>,
): Promise<SendEventResponse>
Send an agent left event Sends an event to the referenced contact from the referenced app. Note that this operation enqueues the event in a queue so a successful response only indicates that the event has been queued.
Parameters
- data: SendAgentLeftEventRequestData<Recipient>
  The data to provide to the API call.
Returns Promise<SendEventResponse>

sendCommentReplyEvent

sendCommentReplyEvent(
data: SendCommentReplyEventRequestData<Recipient>,
): Promise<SendEventResponse>
Send a composing reply event Sends an event to the referenced contact from the referenced app. Note that this operation enqueues the event in a queue so a successful response only indicates that the event has been queued.
Parameters
- data: SendCommentReplyEventRequestData<Recipient>
  The data to provide to the API call.
Returns Promise<SendEventResponse>

sendComposingEndEvent

sendComposingEndEvent(
data: SendComposingEndEventRequestData<Recipient>,
): Promise<SendEventResponse>
Send a composing end event Sends an event to the referenced contact from the referenced app. Note that this operation enqueues the event in a queue so a successful response only indicates that the event has been queued.
Parameters
- data: SendComposingEndEventRequestData<Recipient>
  The data to provide to the API call.
Returns Promise<SendEventResponse>

sendComposingEvent

sendComposingEvent(
data: SendComposingEventRequestData<Recipient>,
): Promise<SendEventResponse>
Send a composing event Sends an event to the referenced contact from the referenced app. Note that this operation enqueues the event in a queue so a successful response only indicates that the event has been queued.
Parameters
- data: SendComposingEventRequestData<Recipient>
  The data to provide to the API call.
Returns Promise<SendEventResponse>

sendGenericEvent

sendGenericEvent(
data: SendGenericEventRequestData<Recipient>,
): Promise<SendEventResponse>
Send a generic event Sends an event to the referenced contact from the referenced app. Note that this operation enqueues the event in a queue so a successful response only indicates that the event has been queued.
Parameters
- data: SendGenericEventRequestData<Recipient>
  The data to provide to the API call.
Returns Promise<SendEventResponse>

setBasePath

setBasePath(basePath: string): void
Update the default basePath for the API
Parameters
- basePath: string
  The new base path to use for the APIs.
Returns void
Inherited from ConversationDomainApi.setBasePath