Class UnbluConversationTemplatesApi

Provides read access to the account's conversation templates

Index

Constructors

Methods

get getConversationTemplates

Constructors

constructor

new UnbluConversationTemplatesApi(
conversationTemplatesModule: ConversationTemplatesModule,
apiStateProvider: ApiStateProvider,
): UnbluConversationTemplatesApi
Parameters
- conversationTemplatesModule: ConversationTemplatesModule
- apiStateProvider: ApiStateProvider
Returns UnbluConversationTemplatesApi
- Defined in agent-embedded-js-api/src/unblu-conversation-templates-api.ts:13

Methods

get

get(conversationTemplateId: string): Promise<ConversationTemplate>
Returns the conversation template with the given ID.

The name and description of the conversation template are returned in the agent's language if a translation for it exists.
Parameters
- conversationTemplateId: string
  The ID of the conversation template to return.
Returns Promise<ConversationTemplate>
The conversation template with the given ID.

Throws
UnbluApiError with type UnbluErrorType.ILLEGAL_STATE when the API instance is deinitialized.

Throws
UnbluApiError with type UnbluErrorType.INVALID_FUNCTION_ARGUMENTS if the conversation template doesn't exist or can't be accessed.
- Defined in agent-embedded-js-api/src/unblu-conversation-templates-api.ts:29

getConversationTemplates

getConversationTemplates(): Promise<ConversationTemplate[]>
Returns a list of all conversation templates of the account.

The name and description of each conversation template are returned in the agent's language if a translation for it exists.

Returns Promise<ConversationTemplate[]>
A list of all conversation templates of the account.

Throws
UnbluApiError with type UnbluErrorType.ILLEGAL_STATE when the API instance is deinitialized.
- Defined in agent-embedded-js-api/src/unblu-conversation-templates-api.ts:43