Class EventsApi

Hierarchy

ConversationDomainApi
- EventsApi

Index

Methods

delete get list send 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): 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
  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