Skip to main content

@wildix/xbees-kite-client

xbees-kite-client package

Classes

Class

Description

CancelCalendarEventCommand

ChannelNotFoundException

CreateOrUpdateWidgetPreviewCommand

Creates or updates a temporary widget to assist with configuration testing. Preview widgets mimic the behavior and appearance of regular widgets but are automatically deleted after two hours. They are primarily designed for use in the Kite configuration interface, enabling users to experiment with settings and instantly visualize how changes affect the widget's design and functionality.

CreateWidgetCommand

Creates a new widget.

DeleteWidgetCommand

Deletes an existing widget. This operation is idempotent, meaning that if the widget does not exist, the operation will still return a successful response.

EventNotFoundException

ForbiddenException

GetCalendarSlotsCommand

GetConfigCommand

GetSmsNumberConfigurationCommand

GetWhatsAppNumberConfigurationCommand

GetWidgetCommand

Retrieves details of a specific widget by its unique identifier.

Kite

KiteClient

KiteServiceException

Base exception class for all service exceptions from Kite service.

ListAgentsCommand

ListServicesCommand

ListSmsConfigurationsCommand

ListSmsNumbersCommand

ListWhatsAppConfigurationsCommand

ListWhatsAppNumbersCommand

ListWhatsAppTemplatesCommand

ListWidgetsCommand

NotFoundException

PutSmsNumberConfigurationCommand

PutWhatsAppNumberConfigurationCommand

RateLimitExceededException

RescheduleCalendarEventCommand

ScheduleCalendarEventCommand

TargetNotFoundException

UpdateWidgetCommand

Updates the configuration of an existing widget.

ValidationException

WidgetNotFoundException

Interfaces

Interface

Description

BodyTextNamedParam

Button

ButtonActionHandler

ButtonElement

ButtonLinkHandler

ButtonReplyHandler

CalendarAvailability

CalendarAvailabilitySettings

CalendarDaySlots

CalendarEvent

CalendarSlot

CancelCalendarEventCommandInput

The input for CancelCalendarEventCommand.

CancelCalendarEventCommandOutput

The output of CancelCalendarEventCommand.

CancelCalendarEventInput

CancelCalendarEventOutput

Channel

ChannelContext

ChannelContextEvent

ChannelContextEventAttendee

ChannelContextPushToTalk

ClientDefaults

Component

ComponentExample

CreateOrUpdateWidgetPreviewCommandInput

The input for CreateOrUpdateWidgetPreviewCommand.

CreateOrUpdateWidgetPreviewCommandOutput

The output of CreateOrUpdateWidgetPreviewCommand.

CreateOrUpdateWidgetPreviewInput

CreateOrUpdateWidgetPreviewOutput

CreateWidgetCommandInput

The input for CreateWidgetCommand.

CreateWidgetCommandOutput

The output of CreateWidgetCommand.

CreateWidgetInput

CreateWidgetOutput

DeleteWidgetCommandInput

The input for DeleteWidgetCommand.

DeleteWidgetCommandOutput

The output of DeleteWidgetCommand.

DeleteWidgetInput

DeleteWidgetOutput

GetCalendarSlotsCommandInput

The input for GetCalendarSlotsCommand.

GetCalendarSlotsCommandOutput

The output of GetCalendarSlotsCommand.

GetCalendarSlotsInput

GetCalendarSlotsOutput

GetConfigCommandInput

The input for GetConfigCommand.

GetConfigCommandOutput

The output of GetConfigCommand.

GetConfigInput

GetConfigOutput

GetSmsNumberConfigurationCommandInput

The input for GetSmsNumberConfigurationCommand.

GetSmsNumberConfigurationCommandOutput

The output of GetSmsNumberConfigurationCommand.

GetSmsNumberConfigurationInput

GetSmsNumberConfigurationOutput

GetWhatsAppNumberConfigurationCommandInput

The input for GetWhatsAppNumberConfigurationCommand.

GetWhatsAppNumberConfigurationCommandOutput

The output of GetWhatsAppNumberConfigurationCommand.

GetWhatsAppNumberConfigurationInput

GetWhatsAppNumberConfigurationOutput

GetWidgetCommandInput

The input for GetWidgetCommand.

GetWidgetCommandOutput

The output of GetWidgetCommand.

GetWidgetInput

GetWidgetOutput

InactivityTimeoutCondition

Kite

KiteClientConfig

The configuration interface of KiteClient class constructor that set the region, credentials and other options.

KiteClientResolvedConfig

The resolved configuration interface of KiteClient class. This is resolved and normalized from the constructor configuration interface.

KiteConfig

KiteTargetService

ListAgentsCommandInput

The input for ListAgentsCommand.

ListAgentsCommandOutput

The output of ListAgentsCommand.

ListAgentsInput

ListAgentsOutput

ListServicesCommandInput

The input for ListServicesCommand.

ListServicesCommandOutput

The output of ListServicesCommand.

ListServicesInput

ListServicesOutput

ListSmsConfigurationsCommandInput

The input for ListSmsConfigurationsCommand.

ListSmsConfigurationsCommandOutput

The output of ListSmsConfigurationsCommand.

ListSmsConfigurationsInput

ListSmsConfigurationsOutput

ListSmsNumbersCommandInput

The input for ListSmsNumbersCommand.

ListSmsNumbersCommandOutput

The output of ListSmsNumbersCommand.

ListSmsNumbersInput

ListSmsNumbersOutput

ListWhatsAppConfigurationsCommandInput

The input for ListWhatsAppConfigurationsCommand.

ListWhatsAppConfigurationsCommandOutput

The output of ListWhatsAppConfigurationsCommand.

ListWhatsAppConfigurationsInput

ListWhatsAppConfigurationsOutput

ListWhatsAppNumbersCommandInput

The input for ListWhatsAppNumbersCommand.

ListWhatsAppNumbersCommandOutput

The output of ListWhatsAppNumbersCommand.

ListWhatsAppNumbersInput

ListWhatsAppNumbersOutput

ListWhatsAppTemplatesCommandInput

The input for ListWhatsAppTemplatesCommand.

ListWhatsAppTemplatesCommandOutput

The output of ListWhatsAppTemplatesCommand.

ListWhatsAppTemplatesInput

ListWhatsAppTemplatesOutput

ListWidgetsCommandInput

The input for ListWidgetsCommand.

ListWidgetsCommandOutput

The output of ListWidgetsCommand.

ListWidgetsInput

ListWidgetsOutput

MessageTemplateConfig

PutSmsNumberConfigurationCommandInput

The input for PutSmsNumberConfigurationCommand.

PutSmsNumberConfigurationCommandOutput

The output of PutSmsNumberConfigurationCommand.

PutSmsNumberConfigurationInput

PutSmsNumberConfigurationOutput

PutWhatsAppNumberConfigurationCommandInput

The input for PutWhatsAppNumberConfigurationCommand.

PutWhatsAppNumberConfigurationCommandOutput

The output of PutWhatsAppNumberConfigurationCommand.

PutWhatsAppNumberConfigurationInput

PutWhatsAppNumberConfigurationOutput

RescheduleCalendarEventCommandInput

The input for RescheduleCalendarEventCommand.

RescheduleCalendarEventCommandOutput

The output of RescheduleCalendarEventCommand.

RescheduleCalendarEventInput

RescheduleCalendarEventOutput

RouteAction

RouteAddMembersTask

RouteAgentTarget

RouteBotTarget

RouteEvaluationCondition

RouteGenerativeVariable

RouteNotifyEmail

RouteNotifyMessage

RouteReadTimeoutCondition

RouteReplyTimeoutCondition

RouteSendGenerativeMessageTask

RouteSendMessageTask

RouteServiceTarget

RouteTimeFrameRule

RuntimeExtension

ScheduleCalendarEventCommandInput

The input for ScheduleCalendarEventCommand.

ScheduleCalendarEventCommandOutput

The output of ScheduleCalendarEventCommand.

ScheduleCalendarEventInput

ScheduleCalendarEventOutput

Service

ServicePbx

ServiceSettings

SmsConfig

SmsConfigRoute

SmsServiceNumber

Template

TemplateParameter

TemplateWithParameters

UpdateWidgetCommandInput

The input for UpdateWidgetCommand.

UpdateWidgetCommandOutput

The output of UpdateWidgetCommand.

UpdateWidgetInput

UpdateWidgetOutput

User

WhatsAppConfig

WhatsAppConfigRoute

WhatsAppServiceNumber

Widget

WidgetAgentTarget

WidgetAppearance

WidgetBotTarget

WidgetPalleteSettings

WidgetRoute

WidgetRouteTimeFrameRule

WidgetServiceTarget

WidgetTextSettings

WidgetWelcomeMessage

Namespaces

Namespace

Description

ActionElement

ButtonHandler

Element

ListAgentsFilter

RouteActionCondition

RouteActionTask

RouteRule

RouteTarget

WidgetRouteRule

WidgetTarget

Variables

Variable

Description

ButtonType

ButtonVariant

ChannelAccess

ChannelContextEventAttendeeStatus

ChannelContextSource

ChannelType

ChannelWhatsAppStatus

ComponentFormat

ComponentType

KiteFeatures

KiteVariant

ParameterFormat

RouteTimeFrameDay

TemplateCategory

TemplateStatus

Type Aliases

Type Alias

Description

ActionElement

ButtonHandler

ButtonType

ButtonVariant

ChannelAccess

ChannelContextEventAttendeeStatus

ChannelContextSource

ChannelType

ChannelWhatsAppStatus

ComponentFormat

ComponentType

Element

KiteClientConfigType

KiteClientResolvedConfigType

KiteFeatures

KiteVariant

ListAgentsFilter

ParameterFormat

RouteActionCondition

RouteActionTask

RouteRule

RouteTarget

RouteTimeFrameDay

ServiceInputTypes

ServiceOutputTypes

TemplateCategory

TemplateStatus

WidgetRouteRule

WidgetTarget