**@8x8/pui-partner-comm types** --- # @8x8/pui-partner-comm types ## Interfaces ### ActivityScreenValue The value type when we respond with activity screen HTML content #### Properties | Property | Type | | -------------------------------- | -------- | | `content` | `string` | --- ### BaseEventMessage\ The interface for the message property when the type is event #### Type Parameters | Type Parameter | Description | | ---------------------- | ---------------------- | | `T` | The type for the value | | `U` _extends_ `string` | the event name | #### Properties | Property | Type | Description | | ------------------------------------ | ---- | ----------------------- | | `eventName` | `U` | the name of the event | | `value` | `T` | the value for the event | --- ### BaseNamespaceMessage\ The interface for the message property when the type is response #### Type Parameters | Type Parameter | Description | | ---------------------- | ---------------------- | | `T` | The type for the value | | `U` _extends_ `string` | the namespace name | #### Properties | Property | Type | | ------------------------------------ | -------- | | `namespace` | `U` | | `request` | `string` | | `value` | `T` | --- ### ContextValue The type when we respond with context as value #### Properties | Property | Type | | ------------------------------ | -------- | | `locale` | `string` | | `theme` | `string` | --- ### DataSchema\ Schema interface for the data #### Type Parameters | Type Parameter | Description | | --------------------------------------------- | -------------------------------- | | `T` | the typing for the message | | `U` _extends_ [`DataType`](TYPES.md#datatype) | the typing for the type property | #### Properties | Property | Type | Description | | -------------------------------------------- | --------- | --------------------------------------- | | `message` | `T` | the message part of the data sent | | `schemaVersion` | `"1.0.0"` | the schemaVersion part of the data sent | | `type` | `U` | the type part of the data sent | --- ### FileMetadata #### Properties | Property | Type | | --------------------------------------------- | --------- | | `encrypted?` | `boolean` | | `encryptionKey?` | `string` | | `hash?` | `string` | | `id` | `string` | | `lastModified` | `number` | | `name` | `string` | | `size` | `number` | | `type` | `string` | --- ### FileTransferChunk #### Properties | Property | Type | | ---------------------------------------- | ------------- | | `chunkId` | `string` | | `chunkIndex` | `number` | | `data` | `ArrayBuffer` | | `fileId` | `string` | | `iv?` | `ArrayBuffer` | | `size` | `number` | | `totalChunks` | `number` | --- ### FileTransferMessage #### Properties | Property | Type | | ------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `action` | [`FileTransferAction`](TYPES.md#filetransferaction) | | `value` | \| [`FileTransferChunk`](TYPES.md#filetransferchunk) \| [`FileTransferRequest`](TYPES.md#filetransferrequest) \| [`FileTransferResponse`](TYPES.md#filetransferresponse) | --- ### FileTransferRequest #### Properties | Property | Type | | ------------------------------------- | --------------------------------------- | | `chunkSize?` | `number` | | `fileId` | `string` | | `metadata` | [`FileMetadata`](TYPES.md#filemetadata) | --- ### FileTransferResponse #### Properties | Property | Type | | --------------------------------------------------- | --------------------------------------------------- | | `error?` | `string` | | `fileId` | `string` | | `progress?` | `number` | | `status` | [`FileTransferStatus`](TYPES.md#filetransferstatus) | | `totalBytes?` | `number` | | `transferredBytes?` | `number` | --- ### LoginValue The type when we respond for the login request #### Properties | Property | Type | | -------------------------------- | --------- | | `success` | `boolean` | --- ### ParentVersionValue The value type corresponding to the versions exposed by the parent package #### Extended by - [`VersionValue`](TYPES.md#versionvalue) #### Properties | Property | Type | | -------------------------------------------- | -------- | | `mfeVersion` | `string` | | `parentVersion` | `string` | --- ### ReceivedEventsMap #### Properties | Property | Type | | ------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `aw-chat-message-received-v1` | \[`ZodObject`\<\{ `interactionId`: `ZodString`; `message`: `ZodString`; `schemaVersion`: `ZodLiteral`\<`"1.0.0"`\>; \}, `"strip"`, `ZodTypeAny`, \{ `interactionId`: `string`; `message`: `string`; `schemaVersion`: `"1.0.0"`; \}, \{ `interactionId`: `string`; `message`: `string`; `schemaVersion`: `"1.0.0"`; \}\>\] | --- ### VersionValue The value type when we respond with for the getVersion request #### Extends - [`ParentVersionValue`](TYPES.md#parentversionvalue) #### Properties | Property | Type | Inherited from | | ---------------------------------------------- | -------- | ----------------------------------------------------------------------------------------------- | | `mfeVersion` | `string` | [`ParentVersionValue`](TYPES.md#parentversionvalue).[`mfeVersion`](TYPES.md#mfeversion-1) | | `parentVersion` | `string` | [`ParentVersionValue`](TYPES.md#parentversionvalue).[`parentVersion`](TYPES.md#parentversion-1) | | `partnerVersion` | `string` | - | ## Type Aliases ### AuthData ```ts type AuthData = DataSchema; ``` The type for the data when we have a response from the auth namespace --- ### AuthMessage ```ts type AuthMessage = BaseNamespaceMessage; ``` The type for the message when we have a response from the auth namespace --- ### AuthMessageValue ```ts type AuthMessageValue = LoginValue; ``` The type for the message value as part of the auth namespace --- ### AuthNamespace ```ts type AuthNamespace = "auth"; ``` --- ### ChatAcceptedCCData ```ts type ChatAcceptedCCData = DataSchema; ``` Complete data type for the "mashell-chat-accepted-cc-event-v1" event --- ### ChatAcceptedCCEventName ```ts type ChatAcceptedCCEventName = typeof CHAT_ACCEPTED_CC_EVENT; ``` Type for the event name --- ### ChatAcceptedCCMessage ```ts type ChatAcceptedCCMessage = BaseEventMessage; ``` Type for the message for this event --- ### ChatAcceptedCCMessageValue ```ts type ChatAcceptedCCMessageValue = ChatAcceptedCCPayload; ``` Type for the message value for this event --- ### ChatAcceptedCCPayload ```ts type ChatAcceptedCCPayload = z.infer; ``` --- ### ChatCompletedCCData ```ts type ChatCompletedCCData = DataSchema; ``` Complete data type for the "mashell-chat-completed-cc-event-v1" event --- ### ChatCompletedCCEventName ```ts type ChatCompletedCCEventName = typeof CHAT_COMPLETED_CC_EVENT; ``` Type for the event name --- ### ChatCompletedCCMessage ```ts type ChatCompletedCCMessage = BaseEventMessage; ``` Type for the message for this event --- ### ChatCompletedCCMessageValue ```ts type ChatCompletedCCMessageValue = ChatCompletedCCPayload; ``` Type for the message value for this event --- ### ChatCompletedCCPayload ```ts type ChatCompletedCCPayload = z.infer; ``` --- ### ChatInitPayload ```ts type ChatInitPayload = z.infer; ``` --- ### ChatInitV1Data ```ts type ChatInitV1Data = DataSchema; ``` Complete data type for the "chat-init-v1" event --- ### ChatInitV1EventName ```ts type ChatInitV1EventName = typeof CHAT_INIT_EVENT; ``` Type for the event name --- ### ChatInitV1Message ```ts type ChatInitV1Message = BaseEventMessage; ``` Type for the message for the "chat-init-v1" event --- ### ChatInitV1MessageValue ```ts type ChatInitV1MessageValue = ChatInitPayload; ``` Type for the message value for the "chat-init-v1" event --- ### ChatMessageReceivedPayload ```ts type ChatMessageReceivedPayload = z.infer; ``` --- ### ChatMessageSentPayload ```ts type ChatMessageSentPayload = z.infer; ``` --- ### ChatMessageSentV1Data ```ts type ChatMessageSentV1Data = DataSchema; ``` Complete data type for the "chat-message-sent-v1" event --- ### ChatMessageSentV1EventName ```ts type ChatMessageSentV1EventName = typeof CHAT_MESSAGE_SENT_EVENT; ``` Type for the event name --- ### ChatMessageSentV1Message ```ts type ChatMessageSentV1Message = BaseEventMessage; ``` Type for the message for the "chat-message-sent-v1" event --- ### ChatMessageSentV1MessageValue ```ts type ChatMessageSentV1MessageValue = ChatMessageSentPayload; ``` Type for the message value for the "chat-message-sent-v1" event --- ### ChatNextgenAcceptedCCData ```ts type ChatNextgenAcceptedCCData = DataSchema; ``` Complete data type for the "mashell-chat-nextgen-accepted-cc-event-v1" event --- ### ChatNextgenAcceptedCCEventName ```ts type ChatNextgenAcceptedCCEventName = typeof CHAT_NEXTGEN_ACCEPTED_CC_EVENT; ``` Type for the event name --- ### ChatNextgenAcceptedCCMessage ```ts type ChatNextgenAcceptedCCMessage = BaseEventMessage; ``` Type for the message for this event --- ### ChatNextgenAcceptedCCMessageValue ```ts type ChatNextgenAcceptedCCMessageValue = ChatNextgenAcceptedCCPayload; ``` Type for the message value for this event --- ### ChatNextgenAcceptedCCPayload ```ts type ChatNextgenAcceptedCCPayload = z.infer; ``` --- ### ChatNextgenCompletedCCData ```ts type ChatNextgenCompletedCCData = DataSchema; ``` Complete data type for the "mashell-chat-nextgen-completed-cc-event-v1" event --- ### ChatNextgenCompletedCCEventName ```ts type ChatNextgenCompletedCCEventName = typeof CHAT_NEXTGEN_COMPLETED_CC_EVENT; ``` Type for the event name --- ### ChatNextgenCompletedCCMessage ```ts type ChatNextgenCompletedCCMessage = BaseEventMessage< ChatNextgenCompletedCCMessageValue, ChatNextgenCompletedCCEventName >; ``` Type for the message for this event --- ### ChatNextgenCompletedCCMessageValue ```ts type ChatNextgenCompletedCCMessageValue = ChatNextgenCompletedCCPayload; ``` Type for the message value for this event --- ### ChatNextgenCompletedCCPayload ```ts type ChatNextgenCompletedCCPayload = z.infer; ``` --- ### ChatNextgenOfferedCCData ```ts type ChatNextgenOfferedCCData = DataSchema; ``` Complete data type for the "mashell-chat-nextgen-offered-cc-event-v1" event --- ### ChatNextgenOfferedCCEventName ```ts type ChatNextgenOfferedCCEventName = typeof CHAT_NEXTGEN_OFFERED_CC_EVENT; ``` Type for the event name --- ### ChatNextgenOfferedCCMessage ```ts type ChatNextgenOfferedCCMessage = BaseEventMessage; ``` Type for the message for this event --- ### ChatNextgenOfferedCCMessageValue ```ts type ChatNextgenOfferedCCMessageValue = ChatNextgenOfferedCCPayload; ``` Type for the message value for this event --- ### ChatNextgenOfferedCCPayload ```ts type ChatNextgenOfferedCCPayload = z.infer; ``` --- ### ChatNextgenTerminatedCCData ```ts type ChatNextgenTerminatedCCData = DataSchema; ``` Complete data type for the "mashell-chat-nextgen-terminated-cc-event-v1" event --- ### ChatNextgenTerminatedCCEventName ```ts type ChatNextgenTerminatedCCEventName = typeof CHAT_NEXTGEN_TERMINATED_CC_EVENT; ``` Type for the event name --- ### ChatNextgenTerminatedCCMessage ```ts type ChatNextgenTerminatedCCMessage = BaseEventMessage< ChatNextgenTerminatedCCMessageValue, ChatNextgenTerminatedCCEventName >; ``` Type for the message for this event --- ### ChatNextgenTerminatedCCMessageValue ```ts type ChatNextgenTerminatedCCMessageValue = ChatNextgenTerminatedCCPayload; ``` Type for the message value for this event --- ### ChatNextgenTerminatedCCPayload ```ts type ChatNextgenTerminatedCCPayload = z.infer; ``` --- ### ChatOfferedCCData ```ts type ChatOfferedCCData = DataSchema; ``` Complete data type for the "mashell-chat-offered-cc-event-v1" event --- ### ChatOfferedCCEventName ```ts type ChatOfferedCCEventName = typeof CHAT_OFFERED_CC_EVENT; ``` Type for the event name --- ### ChatOfferedCCMessage ```ts type ChatOfferedCCMessage = BaseEventMessage; ``` Type for the message for this event --- ### ChatOfferedCCMessageValue ```ts type ChatOfferedCCMessageValue = ChatOfferedCCPayload; ``` Type for the message value for this event --- ### ChatOfferedCCPayload ```ts type ChatOfferedCCPayload = z.infer; ``` --- ### ChatTerminatedCCData ```ts type ChatTerminatedCCData = DataSchema; ``` Complete data type for the "mashell-chat-terminated-cc-event-v1" event --- ### ChatTerminatedCCEventName ```ts type ChatTerminatedCCEventName = typeof CHAT_TERMINATED_CC_EVENT; ``` Type for the event name --- ### ChatTerminatedCCMessage ```ts type ChatTerminatedCCMessage = BaseEventMessage; ``` Type for the message for this event --- ### ChatTerminatedCCMessageValue ```ts type ChatTerminatedCCMessageValue = ChatTerminatedCCPayload; ``` Type for the message value for this event --- ### ChatTerminatedCCPayload ```ts type ChatTerminatedCCPayload = z.infer; ``` --- ### CloseAgentAssistData ```ts type CloseAgentAssistData = DataSchema; ``` Complete data type for the "closeAgentAssist" event --- ### CloseAgentAssistEventName ```ts type CloseAgentAssistEventName = typeof CLOSE_AGENT_ASSIST_EVENT; ``` Type for the event name --- ### CloseAgentAssistMessage ```ts type CloseAgentAssistMessage = BaseEventMessage; ``` Type for the message for the "closeAgentAssist" event --- ### CloseAgentAssistMessageValue ```ts type CloseAgentAssistMessageValue = CloseAgentAssistPayload; ``` Type for the message value for the "closeAgentAssist" event --- ### CloseAgentAssistPayload ```ts type CloseAgentAssistPayload = z.infer; ``` --- ### DataType ```ts type DataType = (typeof DATA_TYPES)[keyof typeof DATA_TYPES]; ``` The type for the "type" property that exists on data --- ### EmailAcceptedCCData ```ts type EmailAcceptedCCData = DataSchema; ``` Complete data type for the "mashell-email-accepted-cc-event-v1" event --- ### EmailAcceptedCCEventName ```ts type EmailAcceptedCCEventName = typeof EMAIL_ACCEPTED_CC_EVENT; ``` Type for the event name --- ### EmailAcceptedCCMessage ```ts type EmailAcceptedCCMessage = BaseEventMessage; ``` Type for the message for this event --- ### EmailAcceptedCCMessageValue ```ts type EmailAcceptedCCMessageValue = EmailAcceptedCCPayload; ``` Type for the message value for this event --- ### EmailAcceptedCCPayload ```ts type EmailAcceptedCCPayload = z.infer; ``` --- ### EmailTerminatedCCData ```ts type EmailTerminatedCCData = DataSchema; ``` Complete data type for the "mashell-email-terminated-cc-event-v1" event --- ### EmailTerminatedCCEventName ```ts type EmailTerminatedCCEventName = typeof EMAIL_TERMINATED_CC_EVENT; ``` Type for the event name --- ### EmailTerminatedCCMessage ```ts type EmailTerminatedCCMessage = BaseEventMessage; ``` Type for the message for this event --- ### EmailTerminatedCCMessageValue ```ts type EmailTerminatedCCMessageValue = EmailTerminatedCCPayload; ``` Type for the message value for this event --- ### EmailTerminatedCCPayload ```ts type EmailTerminatedCCPayload = z.infer; ``` --- ### EventsData ```ts type EventsData = | UserDetailsData | MuteData | HoldData | UnmuteData | CloseAgentAssistData | InteractionFocusData | ResumeData | WrapUpCodesData | ChatInitV1Data | ChatMessageSentV1Data | ChatNextgenOfferedCCData | ChatNextgenAcceptedCCData | ChatNextgenCompletedCCData | ChatNextgenTerminatedCCData | ChatOfferedCCData | ChatAcceptedCCData | ChatCompletedCCData | ChatTerminatedCCData | EmailAcceptedCCData | EmailTerminatedCCData | VoicePhoneOfferedCCData | VoicePhoneAcceptedCCData | VoicePhoneCompletedCCData | VoicePhoneTerminatedCCData | VoicePhoneOfferedUCData | VoicePhoneAcceptedUCData | VoicePhoneTerminatedUCData | VoicemailOfferedCCData | VoicemailAcceptedCCData | VoicemailCompletedCCData | VoicemailTerminatedCCData; ``` The type that corresponds to the data when has type event --- ### EventsName ```ts type EventsName = | UserDetailsEventName | MuteEventName | HoldEventName | UnmuteEventName | CloseAgentAssistEventName | InteractionFocusEventName | ResumeEventName | WrapUpCodesEventName | ChatInitV1EventName | ChatMessageSentV1EventName | ChatNextgenOfferedCCEventName | ChatNextgenAcceptedCCEventName | ChatNextgenCompletedCCEventName | ChatNextgenTerminatedCCEventName | ChatOfferedCCEventName | ChatAcceptedCCEventName | ChatCompletedCCEventName | ChatTerminatedCCEventName | EmailAcceptedCCEventName | EmailTerminatedCCEventName | VoicePhoneOfferedCCEventName | VoicePhoneAcceptedCCEventName | VoicePhoneCompletedCCEventName | VoicePhoneTerminatedCCEventName | VoicePhoneOfferedUCEventName | VoicePhoneAcceptedUCEventName | VoicePhoneTerminatedUCEventName | VoicemailOfferedCCEventName | VoicemailAcceptedCCEventName | VoicemailCompletedCCEventName | VoicemailTerminatedCCEventName; ``` The type that correspond to the message event name when the data has type event --- ### EventsValue ```ts type EventsValue = { [key in EventsName]?: schemaVersion[] }; ``` The value type when we respond with for the getEvents request --- ### Exclude\ ```ts type Exclude = T extends U ? never : T; ``` Exclude from T those types that are assignable to U #### Type Parameters | Type Parameter | | -------------- | | `T` | | `U` | --- ### FileTransferAction ```ts type FileTransferAction = (typeof FILE_TRANSFER_ACTIONS)[keyof typeof FILE_TRANSFER_ACTIONS]; ``` --- ### FileTransferData ```ts type FileTransferData = DataSchema; ``` --- ### FileTransferStatus ```ts type FileTransferStatus = (typeof FILE_TRANSFER_STATUS)[keyof typeof FILE_TRANSFER_STATUS]; ``` --- ### HoldData ```ts type HoldData = DataSchema; ``` Complete data type for the "hold" event --- ### HoldEventName ```ts type HoldEventName = typeof HOLD_EVENT; ``` Type for the event name --- ### HoldMessage ```ts type HoldMessage = BaseEventMessage; ``` Type for the message for the "hold" event --- ### HoldMessageValue ```ts type HoldMessageValue = HoldPayload; ``` Type for the message value for the "hold" event --- ### HoldPayload ```ts type HoldPayload = z.infer; ``` --- ### InteractionFocusData ```ts type InteractionFocusData = DataSchema; ``` Complete data type for the "interactionFocus" event --- ### InteractionFocusEventName ```ts type InteractionFocusEventName = typeof INTERACTION_FOCUS_EVENT; ``` Type for the event name --- ### InteractionFocusMessage ```ts type InteractionFocusMessage = BaseEventMessage; ``` Type for the message for the "interactionFocus" event --- ### InteractionFocusMessageValue ```ts type InteractionFocusMessageValue = InteractionFocusPayload; ``` Type for the message value for the "interactionFocus" event --- ### InteractionFocusPayload ```ts type InteractionFocusPayload = z.infer; ``` --- ### LocaleValue ```ts type LocaleValue = string; ``` The type when we respond with the locale as value --- ### MuteData ```ts type MuteData = DataSchema; ``` Complete data type for the "mute" event --- ### MuteEventName ```ts type MuteEventName = typeof MUTE_EVENT; ``` Type for the event name --- ### MuteMessage ```ts type MuteMessage = BaseEventMessage; ``` Type for the message for the "mute" event --- ### MuteMessageValue ```ts type MuteMessageValue = MutePayload; ``` Type for the message value for the "mute" event --- ### MutePayload ```ts type MutePayload = z.infer; ``` --- ### NamespacesData ```ts type NamespacesData = SystemData | AuthData | ResourcesData; ``` The type that corresponds to the data when has type response --- ### Omit\ ```ts type Omit = Pick>; ``` Construct a type with the properties of T except for those in type K. #### Type Parameters | Type Parameter | | ------------------------- | | `T` | | `K` _extends_ keyof `any` | --- ### OnMessage() ```ts type OnMessage = (data) => void; ``` The type for the function that the partner will implement #### Parameters | Parameter | Type | | --------- | --------------------------------------- | | `data` | [`ResponseData`](TYPES.md#responsedata) | #### Returns `void` --- ### Pick\ ```ts type Pick = { [P in K]: T[P] }; ``` From T, pick a set of properties whose keys are in the union K #### Type Parameters | Type Parameter | | ----------------------- | | `T` | | `K` _extends_ keyof `T` | --- ### ReceivedEventsMessageData ```ts type ReceivedEventsMessageData = ChatMessageReceivedPayload; ``` --- ### ReceivedEventsName ```ts type ReceivedEventsName = typeof CHAT_MESSAGE_RECEIVED_EVENT; ``` --- ### Record\ ```ts type Record = { [P in K]: T }; ``` Construct a type with a set of properties K of type T #### Type Parameters | Type Parameter | | ------------------------- | | `K` _extends_ keyof `any` | | `T` | --- ### ResourcesData ```ts type ResourcesData = DataSchema; ``` The type for the data when we have a response from the resources namespace --- ### ResourcesMessage ```ts type ResourcesMessage = BaseNamespaceMessage; ``` The type for the message when we have a response from the resources namespace --- ### ResourcesMessageValue ```ts type ResourcesMessageValue = ActivityScreenValue; ``` The type for the message value as part of the resources namespace --- ### ResourcesNamespace ```ts type ResourcesNamespace = "resources"; ``` --- ### ResponseData ```ts type ResponseData = NamespacesData | EventsData | FileTransferData; ``` The data that will be received by the partner --- ### ResumeData ```ts type ResumeData = DataSchema; ``` Complete data type for the "resume" event --- ### ResumeEventName ```ts type ResumeEventName = typeof RESUME_EVENT; ``` Type for the event name --- ### ResumeMessage ```ts type ResumeMessage = BaseEventMessage; ``` Type for the message for the "resume" event --- ### ResumeMessageValue ```ts type ResumeMessageValue = ResumePayload; ``` Type for the message value for the "resume" event --- ### ResumePayload ```ts type ResumePayload = z.infer; ``` --- ### schemaVersion ```ts type schemaVersion = string; ``` The type corresponding to the value for the schemaVersion, it is a string representing the version (follows semver) --- ### ShellUserDetailsPayload ```ts type ShellUserDetailsPayload = z.infer; ``` --- ### SystemData ```ts type SystemData = DataSchema; ``` The type for the data when we have a response from the system namespace --- ### SystemMessage ```ts type SystemMessage = BaseNamespaceMessage; ``` The type for the message when we have a response from the system namespace --- ### SystemMessageValue ```ts type SystemMessageValue = VersionValue | ContextValue | LocaleValue | ThemeValue | EventsValue; ``` The type for the message value as part of the system namespace --- ### SystemNamespace ```ts type SystemNamespace = "system"; ``` --- ### ThemeValue ```ts type ThemeValue = string; ``` The type when we respond with the theme as value --- ### UnmuteData ```ts type UnmuteData = DataSchema; ``` Complete data type for the "unmute" event --- ### UnmuteEventName ```ts type UnmuteEventName = typeof UNMUTE_EVENT; ``` Type for the event name --- ### UnmuteMessage ```ts type UnmuteMessage = BaseEventMessage; ``` Type for the message for the "unmute" event --- ### UnmuteMessageValue ```ts type UnmuteMessageValue = UnmutePayload; ``` Type for the message value for the "unmute" event --- ### UnmutePayload ```ts type UnmutePayload = z.infer; ``` --- ### UserDetailsData ```ts type UserDetailsData = DataSchema; ``` Complete data type for the "user-details" event --- ### UserDetailsEventName ```ts type UserDetailsEventName = typeof SHELL_USER_DETAILS_EVENT; ``` Type for the event name --- ### UserDetailsMessage ```ts type UserDetailsMessage = BaseEventMessage; ``` Type for the message for this event --- ### UserDetailsMessageValue ```ts type UserDetailsMessageValue = ShellUserDetailsPayload; ``` Type for the message value for this event --- ### VoicemailAcceptedCCData ```ts type VoicemailAcceptedCCData = DataSchema; ``` Complete data type for the "mashell-voicemail-accepted-cc-event-v1" event --- ### VoicemailAcceptedCCEventName ```ts type VoicemailAcceptedCCEventName = typeof VOICEMAIL_ACCEPTED_CC_EVENT; ``` Type for the event name --- ### VoicemailAcceptedCCMessage ```ts type VoicemailAcceptedCCMessage = BaseEventMessage; ``` Type for the message for this event --- ### VoicemailAcceptedCCMessageValue ```ts type VoicemailAcceptedCCMessageValue = VoicemailAcceptedCCPayload; ``` Type for the message value for this event --- ### VoicemailAcceptedCCPayload ```ts type VoicemailAcceptedCCPayload = z.infer; ``` --- ### VoicemailCompletedCCData ```ts type VoicemailCompletedCCData = DataSchema; ``` Complete data type for the "mashell-voicemail-completed-cc-event-v1" event --- ### VoicemailCompletedCCEventName ```ts type VoicemailCompletedCCEventName = typeof VOICEMAIL_COMPLETED_CC_EVENT; ``` Type for the event name --- ### VoicemailCompletedCCMessage ```ts type VoicemailCompletedCCMessage = BaseEventMessage; ``` Type for the message for this event --- ### VoicemailCompletedCCMessageValue ```ts type VoicemailCompletedCCMessageValue = VoicemailCompletedCCPayload; ``` Type for the message value for this event --- ### VoicemailCompletedCCPayload ```ts type VoicemailCompletedCCPayload = z.infer; ``` --- ### VoicemailOfferedCCData ```ts type VoicemailOfferedCCData = DataSchema; ``` Complete data type for the "mashell-voicemail-offered-cc-event-v1" event --- ### VoicemailOfferedCCEventName ```ts type VoicemailOfferedCCEventName = typeof VOICEMAIL_OFFERED_CC_EVENT; ``` Type for the event name --- ### VoicemailOfferedCCMessage ```ts type VoicemailOfferedCCMessage = BaseEventMessage; ``` Type for the message for this event --- ### VoicemailOfferedCCMessageValue ```ts type VoicemailOfferedCCMessageValue = VoicemailOfferedCCPayload; ``` Type for the message value for this event --- ### VoicemailOfferedCCPayload ```ts type VoicemailOfferedCCPayload = z.infer; ``` --- ### VoicemailTerminatedCCData ```ts type VoicemailTerminatedCCData = DataSchema; ``` Complete data type for the "mashell-voicemail-terminated-cc-event-v1" event --- ### VoicemailTerminatedCCEventName ```ts type VoicemailTerminatedCCEventName = typeof VOICEMAIL_TERMINATED_CC_EVENT; ``` Type for the event name --- ### VoicemailTerminatedCCMessage ```ts type VoicemailTerminatedCCMessage = BaseEventMessage; ``` Type for the message for this event --- ### VoicemailTerminatedCCMessageValue ```ts type VoicemailTerminatedCCMessageValue = VoicemailTerminatedCCPayload; ``` Type for the message value for this event --- ### VoicemailTerminatedCCPayload ```ts type VoicemailTerminatedCCPayload = z.infer; ``` --- ### VoicePhoneAcceptedCCData ```ts type VoicePhoneAcceptedCCData = DataSchema; ``` Complete data type for the "mashell-voice-phone-accepted-cc-event-v1" event --- ### VoicePhoneAcceptedCCEventName ```ts type VoicePhoneAcceptedCCEventName = typeof VOICE_PHONE_ACCEPTED_CC_EVENT; ``` Type for the event name --- ### VoicePhoneAcceptedCCMessage ```ts type VoicePhoneAcceptedCCMessage = BaseEventMessage; ``` Type for the message for this event --- ### VoicePhoneAcceptedCCMessageValue ```ts type VoicePhoneAcceptedCCMessageValue = VoicePhoneAcceptedCCPayload; ``` Type for the message value for this event --- ### VoicePhoneAcceptedCCPayload ```ts type VoicePhoneAcceptedCCPayload = z.infer; ``` --- ### VoicePhoneAcceptedUCData ```ts type VoicePhoneAcceptedUCData = DataSchema; ``` Complete data type for the "mashell-voice-phone-accepted-uc-event-v1" event --- ### VoicePhoneAcceptedUCEventName ```ts type VoicePhoneAcceptedUCEventName = typeof VOICE_PHONE_ACCEPTED_UC_EVENT; ``` Type for the event name --- ### VoicePhoneAcceptedUCMessage ```ts type VoicePhoneAcceptedUCMessage = BaseEventMessage; ``` Type for the message for this event --- ### VoicePhoneAcceptedUCMessageValue ```ts type VoicePhoneAcceptedUCMessageValue = VoicePhoneAcceptedUCPayload; ``` Type for the message value for this event --- ### VoicePhoneAcceptedUCPayload ```ts type VoicePhoneAcceptedUCPayload = z.infer; ``` --- ### VoicePhoneCompletedCCData ```ts type VoicePhoneCompletedCCData = DataSchema; ``` Complete data type for the "mashell-voice-phone-completed-cc-event-v1" event --- ### VoicePhoneCompletedCCEventName ```ts type VoicePhoneCompletedCCEventName = typeof VOICE_PHONE_COMPLETED_CC_EVENT; ``` Type for the event name --- ### VoicePhoneCompletedCCMessage ```ts type VoicePhoneCompletedCCMessage = BaseEventMessage; ``` Type for the message for this event --- ### VoicePhoneCompletedCCMessageValue ```ts type VoicePhoneCompletedCCMessageValue = VoicePhoneCompletedCCPayload; ``` Type for the message value for this event --- ### VoicePhoneCompletedCCPayload ```ts type VoicePhoneCompletedCCPayload = z.infer; ``` --- ### VoicePhoneOfferedCCData ```ts type VoicePhoneOfferedCCData = DataSchema; ``` Complete data type for the "mashell-voice-phone-offered-cc-event-v1" event --- ### VoicePhoneOfferedCCEventName ```ts type VoicePhoneOfferedCCEventName = typeof VOICE_PHONE_OFFERED_CC_EVENT; ``` Type for the event name --- ### VoicePhoneOfferedCCMessage ```ts type VoicePhoneOfferedCCMessage = BaseEventMessage; ``` Type for the message for this event --- ### VoicePhoneOfferedCCMessageValue ```ts type VoicePhoneOfferedCCMessageValue = VoicePhoneOfferedCCPayload; ``` Type for the message value for this event --- ### VoicePhoneOfferedCCPayload ```ts type VoicePhoneOfferedCCPayload = z.infer; ``` --- ### VoicePhoneOfferedUCData ```ts type VoicePhoneOfferedUCData = DataSchema; ``` Complete data type for the "mashell-voice-phone-offered-uc-event-v1" event --- ### VoicePhoneOfferedUCEventName ```ts type VoicePhoneOfferedUCEventName = typeof VOICE_PHONE_OFFERED_UC_EVENT; ``` Type for the event name --- ### VoicePhoneOfferedUCMessage ```ts type VoicePhoneOfferedUCMessage = BaseEventMessage; ``` Type for the message for this event --- ### VoicePhoneOfferedUCMessageValue ```ts type VoicePhoneOfferedUCMessageValue = VoicePhoneOfferedUCPayload; ``` Type for the message value for this event --- ### VoicePhoneOfferedUCPayload ```ts type VoicePhoneOfferedUCPayload = z.infer; ``` --- ### VoicePhoneTerminatedCCData ```ts type VoicePhoneTerminatedCCData = DataSchema; ``` Complete data type for the "mashell-voice-phone-terminated-cc-event-v1" event --- ### VoicePhoneTerminatedCCEventName ```ts type VoicePhoneTerminatedCCEventName = typeof VOICE_PHONE_TERMINATED_CC_EVENT; ``` Type for the event name --- ### VoicePhoneTerminatedCCMessage ```ts type VoicePhoneTerminatedCCMessage = BaseEventMessage< VoicePhoneTerminatedCCMessageValue, VoicePhoneTerminatedCCEventName >; ``` Type for the message for this event --- ### VoicePhoneTerminatedCCMessageValue ```ts type VoicePhoneTerminatedCCMessageValue = VoicePhoneTerminatedCCPayload; ``` Type for the message value for this event --- ### VoicePhoneTerminatedCCPayload ```ts type VoicePhoneTerminatedCCPayload = z.infer; ``` --- ### VoicePhoneTerminatedUCData ```ts type VoicePhoneTerminatedUCData = DataSchema; ``` Complete data type for the "mashell-voice-phone-terminated-uc-event-v1" event --- ### VoicePhoneTerminatedUCEventName ```ts type VoicePhoneTerminatedUCEventName = typeof VOICE_PHONE_TERMINATED_UC_EVENT; ``` Type for the event name --- ### VoicePhoneTerminatedUCMessage ```ts type VoicePhoneTerminatedUCMessage = BaseEventMessage< VoicePhoneTerminatedUCMessageValue, VoicePhoneTerminatedUCEventName >; ``` Type for the message for this event --- ### VoicePhoneTerminatedUCMessageValue ```ts type VoicePhoneTerminatedUCMessageValue = VoicePhoneTerminatedUCPayload; ``` Type for the message value for this event --- ### VoicePhoneTerminatedUCPayload ```ts type VoicePhoneTerminatedUCPayload = z.infer; ``` --- ### WrapUpCodesData ```ts type WrapUpCodesData = DataSchema; ``` Complete data type for the "wrapUpCodes" event --- ### WrapUpCodesEventName ```ts type WrapUpCodesEventName = typeof WRAP_UP_CODES_EVENT; ``` Type for the event name --- ### WrapUpCodesMessage ```ts type WrapUpCodesMessage = BaseEventMessage; ``` Type for the message for the "wrapUpCodes" event --- ### WrapUpCodesMessageValue ```ts type WrapUpCodesMessageValue = WrapUpCodesPayload; ``` Type for the message value for the "wrapUpCodes" event --- ### WrapUpCodesPayload ```ts type WrapUpCodesPayload = z.infer; ``` ## Variables ### CHAT_ACCEPTED_CC_EVENT ```ts const CHAT_ACCEPTED_CC_EVENT: "mashell-chat-accepted-cc-event-v1" = "mashell-chat-accepted-cc-event-v1"; ``` --- ### CHAT_COMPLETED_CC_EVENT ```ts const CHAT_COMPLETED_CC_EVENT: "mashell-chat-completed-cc-event-v1" = "mashell-chat-completed-cc-event-v1"; ``` --- ### CHAT_INIT_EVENT ```ts const CHAT_INIT_EVENT: "aw-chat-init-v1" = "aw-chat-init-v1"; ``` --- ### CHAT_MESSAGE_RECEIVED_EVENT ```ts const CHAT_MESSAGE_RECEIVED_EVENT: "aw-chat-message-received-v1" = "aw-chat-message-received-v1"; ``` --- ### CHAT_MESSAGE_SENT_EVENT ```ts const CHAT_MESSAGE_SENT_EVENT: "aw-chat-message-sent-v1" = "aw-chat-message-sent-v1"; ``` --- ### CHAT_NEXTGEN_ACCEPTED_CC_EVENT ```ts const CHAT_NEXTGEN_ACCEPTED_CC_EVENT: "mashell-chat-nextgen-accepted-cc-event-v1" = "mashell-chat-nextgen-accepted-cc-event-v1"; ``` --- ### CHAT_NEXTGEN_COMPLETED_CC_EVENT ```ts const CHAT_NEXTGEN_COMPLETED_CC_EVENT: "mashell-chat-nextgen-completed-cc-event-v1" = "mashell-chat-nextgen-completed-cc-event-v1"; ``` --- ### CHAT_NEXTGEN_OFFERED_CC_EVENT ```ts const CHAT_NEXTGEN_OFFERED_CC_EVENT: "mashell-chat-nextgen-offered-cc-event-v1" = "mashell-chat-nextgen-offered-cc-event-v1"; ``` --- ### CHAT_NEXTGEN_TERMINATED_CC_EVENT ```ts const CHAT_NEXTGEN_TERMINATED_CC_EVENT: "mashell-chat-nextgen-terminated-cc-event-v1" = "mashell-chat-nextgen-terminated-cc-event-v1"; ``` --- ### CHAT_OFFERED_CC_EVENT ```ts const CHAT_OFFERED_CC_EVENT: "mashell-chat-offered-cc-event-v1" = "mashell-chat-offered-cc-event-v1"; ``` --- ### CHAT_TERMINATED_CC_EVENT ```ts const CHAT_TERMINATED_CC_EVENT: "mashell-chat-terminated-cc-event-v1" = "mashell-chat-terminated-cc-event-v1"; ``` --- ### ChatCompletedCCPayloadSchema ```ts const ChatCompletedCCPayloadSchema: z.ZodObject< { additionalData: z.ZodObject< { description: z.ZodString; name: z.ZodString; }, "strip", z.ZodTypeAny, { description: string; name: string; }, { description: string; name: string; } >; direction: z.ZodEnum<["inbound", "outbound"]>; endTime: z.ZodString; eventId: z.ZodString; eventName: z.ZodLiteral<"completed">; media: z.ZodLiteral<"chat">; mediaType: z.ZodLiteral<"web_chat">; method: z.ZodLiteral<"mapEvent">; schemaVersion: z.ZodLiteral<"1.0.0">; searchContext: z.ZodString; }, "strip", z.ZodTypeAny, { additionalData: { description: string; name: string; }; direction: "inbound" | "outbound"; endTime: string; eventId: string; eventName: "completed"; media: "chat"; mediaType: "web_chat"; method: "mapEvent"; schemaVersion: "1.0.0"; searchContext: string; }, { additionalData: { description: string; name: string; }; direction: "inbound" | "outbound"; endTime: string; eventId: string; eventName: "completed"; media: "chat"; mediaType: "web_chat"; method: "mapEvent"; schemaVersion: "1.0.0"; searchContext: string; } >; ``` --- ### ChatInitPayloadSchema ```ts const ChatInitPayloadSchema: z.ZodObject<{ interactionId: z.ZodString; messages: z.ZodArray>; size: z.ZodNumber; thumbnailUrl: z.ZodOptional; type: z.ZodEnum<[..., ..., ..., ...]>; }, "strip", z.ZodTypeAny, { filename: string; id: string; meta: | { originalHeight: ...; originalWidth: ...; thumbnailContentType: ...; thumbnailHeight: ...; thumbnailWidth: ...; } | null; size: number; thumbnailUrl: string; type: "image" | "recording" | "document" | "generic"; }, { filename: string; id: string; meta: | { originalHeight: ...; originalWidth: ...; thumbnailContentType: ...; thumbnailHeight: ...; thumbnailWidth: ...; } | null; size: number; thumbnailUrl: string; type: "image" | "recording" | "document" | "generic"; }>, "many">>; author: z.ZodOptional>; botName: z.ZodOptional; displayName: z.ZodOptional; id: z.ZodString; isBot: z.ZodOptional; isDeleted: z.ZodOptional; lastUpdatedTimestamp: z.ZodOptional; meta: z.ZodOptional; conversation_message_id: z.ZodOptional; has_cards: z.ZodOptional; type: z.ZodString; }, "strip", z.ZodTypeAny, { app: string; conversation_id: string; conversation_message_id: string; has_cards: string; type: string; }, { app: string; conversation_id: string; conversation_message_id: string; has_cards: string; type: string; }>>; msgStatus: z.ZodOptional; originalMessage: z.ZodOptional; rawMessage: z.ZodUnion<[z.ZodString, z.ZodRecord]>; resent: z.ZodOptional; timestamp: z.ZodNumber; translatedMessage: z.ZodOptional>; type: z.ZodString; variables: z.ZodOptional>; }, "strip", z.ZodTypeAny, { attachments: { filename: string; id: string; meta: | { originalHeight: number; originalWidth: number; thumbnailContentType: string; thumbnailHeight: number; thumbnailWidth: number; } | null; size: number; thumbnailUrl: string; type: "image" | "recording" | "document" | "generic"; }[]; author: { email: string; id: string; name: string; }; botName: string; displayName: string; id: string; isBot: boolean; isDeleted: boolean; lastUpdatedTimestamp: number; meta: { app: string; conversation_id: string; conversation_message_id: string; has_cards: string; type: string; }; msgStatus: string; originalMessage: string; rawMessage: string | Record; resent: boolean; timestamp: number; translatedMessage: string | null; type: string; variables: Record; }, { attachments: { filename: string; id: string; meta: | { originalHeight: number; originalWidth: number; thumbnailContentType: string; thumbnailHeight: number; thumbnailWidth: number; } | null; size: number; thumbnailUrl: string; type: "image" | "recording" | "document" | "generic"; }[]; author: { email: string; id: string; name: string; }; botName: string; displayName: string; id: string; isBot: boolean; isDeleted: boolean; lastUpdatedTimestamp: number; meta: { app: string; conversation_id: string; conversation_message_id: string; has_cards: string; type: string; }; msgStatus: string; originalMessage: string; rawMessage: string | Record; resent: boolean; timestamp: number; translatedMessage: string | null; type: string; variables: Record; }>, "many">; schemaVersion: z.ZodLiteral<"1.0.0">; }, "strip", z.ZodTypeAny, { interactionId: string; messages: { attachments: { filename: string; id: string; meta: | { originalHeight: number; originalWidth: number; thumbnailContentType: string; thumbnailHeight: number; thumbnailWidth: number; } | null; size: number; thumbnailUrl: string; type: "image" | "recording" | "document" | "generic"; }[]; author: { email: string; id: string; name: string; }; botName: string; displayName: string; id: string; isBot: boolean; isDeleted: boolean; lastUpdatedTimestamp: number; meta: { app: string; conversation_id: string; conversation_message_id: string; has_cards: string; type: string; }; msgStatus: string; originalMessage: string; rawMessage: string | Record; resent: boolean; timestamp: number; translatedMessage: string | null; type: string; variables: Record; }[]; schemaVersion: "1.0.0"; }, { interactionId: string; messages: { attachments: { filename: string; id: string; meta: | { originalHeight: number; originalWidth: number; thumbnailContentType: string; thumbnailHeight: number; thumbnailWidth: number; } | null; size: number; thumbnailUrl: string; type: "image" | "recording" | "document" | "generic"; }[]; author: { email: string; id: string; name: string; }; botName: string; displayName: string; id: string; isBot: boolean; isDeleted: boolean; lastUpdatedTimestamp: number; meta: { app: string; conversation_id: string; conversation_message_id: string; has_cards: string; type: string; }; msgStatus: string; originalMessage: string; rawMessage: string | Record; resent: boolean; timestamp: number; translatedMessage: string | null; type: string; variables: Record; }[]; schemaVersion: "1.0.0"; }>; ``` --- ### ChatMessageReceivedPayloadSchema ```ts const ChatMessageReceivedPayloadSchema: z.ZodObject< { interactionId: z.ZodString; message: z.ZodString; schemaVersion: z.ZodLiteral<"1.0.0">; }, "strip", z.ZodTypeAny, { interactionId: string; message: string; schemaVersion: "1.0.0"; }, { interactionId: string; message: string; schemaVersion: "1.0.0"; } >; ``` --- ### ChatMessageSentPayloadSchema ```ts const ChatMessageSentPayloadSchema: z.ZodObject<{ interactionId: z.ZodString; message: z.ZodObject<{ attachments: z.ZodOptional>; size: z.ZodNumber; thumbnailUrl: z.ZodOptional; type: z.ZodEnum<["image", "document", "recording", "generic"]>; }, "strip", z.ZodTypeAny, { filename: string; id: string; meta: | { originalHeight: number; originalWidth: number; thumbnailContentType: string; thumbnailHeight: number; thumbnailWidth: number; } | null; size: number; thumbnailUrl: string; type: "image" | "recording" | "document" | "generic"; }, { filename: string; id: string; meta: | { originalHeight: number; originalWidth: number; thumbnailContentType: string; thumbnailHeight: number; thumbnailWidth: number; } | null; size: number; thumbnailUrl: string; type: "image" | "recording" | "document" | "generic"; }>, "many">>; author: z.ZodOptional>; botName: z.ZodOptional; displayName: z.ZodOptional; id: z.ZodString; isBot: z.ZodOptional; isDeleted: z.ZodOptional; lastUpdatedTimestamp: z.ZodOptional; meta: z.ZodOptional; conversation_message_id: z.ZodOptional; has_cards: z.ZodOptional; type: z.ZodString; }, "strip", z.ZodTypeAny, { app: string; conversation_id: string; conversation_message_id: string; has_cards: string; type: string; }, { app: string; conversation_id: string; conversation_message_id: string; has_cards: string; type: string; }>>; msgStatus: z.ZodOptional; originalMessage: z.ZodOptional; rawMessage: z.ZodUnion<[z.ZodString, z.ZodRecord]>; resent: z.ZodOptional; timestamp: z.ZodNumber; translatedMessage: z.ZodOptional>; type: z.ZodString; variables: z.ZodOptional>; }, "strip", z.ZodTypeAny, { attachments: { filename: string; id: string; meta: | { originalHeight: number; originalWidth: number; thumbnailContentType: string; thumbnailHeight: number; thumbnailWidth: number; } | null; size: number; thumbnailUrl: string; type: "image" | "recording" | "document" | "generic"; }[]; author: { email: string; id: string; name: string; }; botName: string; displayName: string; id: string; isBot: boolean; isDeleted: boolean; lastUpdatedTimestamp: number; meta: { app: string; conversation_id: string; conversation_message_id: string; has_cards: string; type: string; }; msgStatus: string; originalMessage: string; rawMessage: string | Record; resent: boolean; timestamp: number; translatedMessage: string | null; type: string; variables: Record; }, { attachments: { filename: string; id: string; meta: | { originalHeight: number; originalWidth: number; thumbnailContentType: string; thumbnailHeight: number; thumbnailWidth: number; } | null; size: number; thumbnailUrl: string; type: "image" | "recording" | "document" | "generic"; }[]; author: { email: string; id: string; name: string; }; botName: string; displayName: string; id: string; isBot: boolean; isDeleted: boolean; lastUpdatedTimestamp: number; meta: { app: string; conversation_id: string; conversation_message_id: string; has_cards: string; type: string; }; msgStatus: string; originalMessage: string; rawMessage: string | Record; resent: boolean; timestamp: number; translatedMessage: string | null; type: string; variables: Record; }>; schemaVersion: z.ZodLiteral<"1.0.0">; }, "strip", z.ZodTypeAny, { interactionId: string; message: { attachments: { filename: string; id: string; meta: | { originalHeight: number; originalWidth: number; thumbnailContentType: string; thumbnailHeight: number; thumbnailWidth: number; } | null; size: number; thumbnailUrl: string; type: "image" | "recording" | "document" | "generic"; }[]; author: { email: string; id: string; name: string; }; botName: string; displayName: string; id: string; isBot: boolean; isDeleted: boolean; lastUpdatedTimestamp: number; meta: { app: string; conversation_id: string; conversation_message_id: string; has_cards: string; type: string; }; msgStatus: string; originalMessage: string; rawMessage: string | Record; resent: boolean; timestamp: number; translatedMessage: string | null; type: string; variables: Record; }; schemaVersion: "1.0.0"; }, { interactionId: string; message: { attachments: { filename: string; id: string; meta: | { originalHeight: number; originalWidth: number; thumbnailContentType: string; thumbnailHeight: number; thumbnailWidth: number; } | null; size: number; thumbnailUrl: string; type: "image" | "recording" | "document" | "generic"; }[]; author: { email: string; id: string; name: string; }; botName: string; displayName: string; id: string; isBot: boolean; isDeleted: boolean; lastUpdatedTimestamp: number; meta: { app: string; conversation_id: string; conversation_message_id: string; has_cards: string; type: string; }; msgStatus: string; originalMessage: string; rawMessage: string | Record; resent: boolean; timestamp: number; translatedMessage: string | null; type: string; variables: Record; }; schemaVersion: "1.0.0"; }>; ``` --- ### ChatNextgenAcceptedCCPayloadSchema ```ts const ChatNextgenAcceptedCCPayloadSchema: z.ZodObject< Omit< { direction: z.ZodEnum<["inbound", "outbound"]>; eventId: z.ZodString; eventName: z.ZodLiteral<"offered">; media: z.ZodLiteral<"chat">; mediaType: z.ZodEnum<["sms", "whatsapp"]>; method: z.ZodLiteral<"mapEvent">; schemaVersion: z.ZodLiteral<"1.0.0">; searchContext: z.ZodString; }, "schemaVersion" | "eventName" > & { eventName: z.ZodLiteral<"accepted">; schemaVersion: z.ZodLiteral<"1.0.0">; }, "strip", z.ZodTypeAny, { direction: "inbound" | "outbound"; eventId: string; eventName: "accepted"; media: "chat"; mediaType: "sms" | "whatsapp"; method: "mapEvent"; schemaVersion: "1.0.0"; searchContext: string; }, { direction: "inbound" | "outbound"; eventId: string; eventName: "accepted"; media: "chat"; mediaType: "sms" | "whatsapp"; method: "mapEvent"; schemaVersion: "1.0.0"; searchContext: string; } >; ``` --- ### ChatNextgenCompletedCCPayloadSchema ```ts const ChatNextgenCompletedCCPayloadSchema: z.ZodObject< { additionalData: z.ZodObject< { description: z.ZodString; }, "strip", z.ZodTypeAny, { description: string; }, { description: string; } >; direction: z.ZodEnum<["inbound", "outbound"]>; endTime: z.ZodString; eventId: z.ZodString; eventName: z.ZodLiteral<"completed">; media: z.ZodLiteral<"chat">; mediaType: z.ZodEnum<["sms", "whatsapp"]>; method: z.ZodLiteral<"mapEvent">; schemaVersion: z.ZodLiteral<"1.0.0">; searchContext: z.ZodString; }, "strip", z.ZodTypeAny, { additionalData: { description: string; }; direction: "inbound" | "outbound"; endTime: string; eventId: string; eventName: "completed"; media: "chat"; mediaType: "sms" | "whatsapp"; method: "mapEvent"; schemaVersion: "1.0.0"; searchContext: string; }, { additionalData: { description: string; }; direction: "inbound" | "outbound"; endTime: string; eventId: string; eventName: "completed"; media: "chat"; mediaType: "sms" | "whatsapp"; method: "mapEvent"; schemaVersion: "1.0.0"; searchContext: string; } >; ``` --- ### ChatNextgenOfferedCCPayloadSchema ```ts const ChatNextgenOfferedCCPayloadSchema: z.ZodObject< { direction: z.ZodEnum<["inbound", "outbound"]>; eventId: z.ZodString; eventName: z.ZodLiteral<"offered">; media: z.ZodLiteral<"chat">; mediaType: z.ZodEnum<["sms", "whatsapp"]>; method: z.ZodLiteral<"mapEvent">; schemaVersion: z.ZodLiteral<"1.0.0">; searchContext: z.ZodString; }, "strip", z.ZodTypeAny, { direction: "inbound" | "outbound"; eventId: string; eventName: "offered"; media: "chat"; mediaType: "sms" | "whatsapp"; method: "mapEvent"; schemaVersion: "1.0.0"; searchContext: string; }, { direction: "inbound" | "outbound"; eventId: string; eventName: "offered"; media: "chat"; mediaType: "sms" | "whatsapp"; method: "mapEvent"; schemaVersion: "1.0.0"; searchContext: string; } >; ``` --- ### ChatNextgenTerminatedCCPayloadSchema ```ts const ChatNextgenTerminatedCCPayloadSchema: z.ZodObject< { additionalData: z.ZodObject< { description: z.ZodString; }, "strip", z.ZodTypeAny, { description: string; }, { description: string; } >; direction: z.ZodEnum<["inbound", "outbound"]>; endTime: z.ZodString; eventId: z.ZodString; eventName: z.ZodLiteral<"terminated">; media: z.ZodLiteral<"chat">; mediaType: z.ZodEnum<["sms", "whatsapp"]>; method: z.ZodLiteral<"mapEvent">; schemaVersion: z.ZodLiteral<"1.0.0">; searchContext: z.ZodString; }, "strip", z.ZodTypeAny, { additionalData: { description: string; }; direction: "inbound" | "outbound"; endTime: string; eventId: string; eventName: "terminated"; media: "chat"; mediaType: "sms" | "whatsapp"; method: "mapEvent"; schemaVersion: "1.0.0"; searchContext: string; }, { additionalData: { description: string; }; direction: "inbound" | "outbound"; endTime: string; eventId: string; eventName: "terminated"; media: "chat"; mediaType: "sms" | "whatsapp"; method: "mapEvent"; schemaVersion: "1.0.0"; searchContext: string; } >; ``` --- ### ChatOfferedCCPayloadSchema ```ts const ChatOfferedCCPayloadSchema: z.ZodObject< { additionalData: z.ZodObject< { name: z.ZodString; }, "strip", z.ZodTypeAny, { name: string; }, { name: string; } >; direction: z.ZodEnum<["inbound", "outbound"]>; eventId: z.ZodString; eventName: z.ZodLiteral<"offered">; media: z.ZodLiteral<"chat">; mediaType: z.ZodLiteral<"web_chat">; method: z.ZodLiteral<"mapEvent">; schemaVersion: z.ZodLiteral<"1.0.0">; searchContext: z.ZodString; }, "strip", z.ZodTypeAny, { additionalData: { name: string; }; direction: "inbound" | "outbound"; eventId: string; eventName: "offered"; media: "chat"; mediaType: "web_chat"; method: "mapEvent"; schemaVersion: "1.0.0"; searchContext: string; }, { additionalData: { name: string; }; direction: "inbound" | "outbound"; eventId: string; eventName: "offered"; media: "chat"; mediaType: "web_chat"; method: "mapEvent"; schemaVersion: "1.0.0"; searchContext: string; } >; ``` --- ### ChatTerminatedCCPayloadSchema ```ts const ChatTerminatedCCPayloadSchema: z.ZodObject< { additionalData: z.ZodObject< { description: z.ZodString; name: z.ZodString; }, "strip", z.ZodTypeAny, { description: string; name: string; }, { description: string; name: string; } >; direction: z.ZodEnum<["inbound", "outbound"]>; endTime: z.ZodString; eventId: z.ZodString; eventName: z.ZodLiteral<"terminated">; media: z.ZodLiteral<"chat">; mediaType: z.ZodLiteral<"web_chat">; method: z.ZodLiteral<"mapEvent">; schemaVersion: z.ZodLiteral<"1.0.0">; searchContext: z.ZodString; }, "strip", z.ZodTypeAny, { additionalData: { description: string; name: string; }; direction: "inbound" | "outbound"; endTime: string; eventId: string; eventName: "terminated"; media: "chat"; mediaType: "web_chat"; method: "mapEvent"; schemaVersion: "1.0.0"; searchContext: string; }, { additionalData: { description: string; name: string; }; direction: "inbound" | "outbound"; endTime: string; eventId: string; eventName: "terminated"; media: "chat"; mediaType: "web_chat"; method: "mapEvent"; schemaVersion: "1.0.0"; searchContext: string; } >; ``` --- ### CLOSE_AGENT_ASSIST_EVENT ```ts const CLOSE_AGENT_ASSIST_EVENT: "aw-close-agent-assist-v1" = "aw-close-agent-assist-v1"; ``` --- ### CloseAgentAssistPayloadSchema ```ts const CloseAgentAssistPayloadSchema: z.ZodObject< { interactionId: z.ZodString; schemaVersion: z.ZodLiteral<"1.0.0">; }, "strip", z.ZodTypeAny, { interactionId: string; schemaVersion: "1.0.0"; }, { interactionId: string; schemaVersion: "1.0.0"; } >; ``` --- ### DATA_TYPES ```ts const DATA_TYPES: { ERROR: "error"; EVENT: "event"; FILE_TRANSFER: "file-transfer"; GENERIC: "message"; RESPONSE: "response"; }; ``` A map with the types that can exist on the data #### Type declaration | Name | Type | Default value | | -------------------------------------------- | ----------------- | --------------- | | `ERROR` | `"error"` | "error" | | `EVENT` | `"event"` | "event" | | `FILE_TRANSFER` | `"file-transfer"` | "file-transfer" | | `GENERIC` | `"message"` | "message" | | `RESPONSE` | `"response"` | "response" | --- ### EMAIL_ACCEPTED_CC_EVENT ```ts const EMAIL_ACCEPTED_CC_EVENT: "mashell-email-accepted-cc-event-v1" = "mashell-email-accepted-cc-event-v1"; ``` --- ### EMAIL_TERMINATED_CC_EVENT ```ts const EMAIL_TERMINATED_CC_EVENT: "mashell-email-terminated-cc-event-v1" = "mashell-email-terminated-cc-event-v1"; ``` --- ### EmailAcceptedCCPayloadSchema ```ts const EmailAcceptedCCPayloadSchema: z.ZodObject< { childNumberId: z.ZodOptional; contact: z.ZodObject< { emailAddress: z.ZodString; firstName: z.ZodOptional; lastName: z.ZodOptional; }, "strip", z.ZodTypeAny, { emailAddress: string; firstName: string; lastName: string; }, { emailAddress: string; firstName: string; lastName: string; } >; direction: z.ZodEnum<["inbound", "outbound"]>; eventId: z.ZodString; eventName: z.ZodLiteral<"accepted">; isReplyEmail: z.ZodBoolean; isStandAloneTerminated: z.ZodBoolean; mainNumberId: z.ZodString; media: z.ZodLiteral<"email">; method: z.ZodLiteral<"mapEvent">; schemaVersion: z.ZodLiteral<"1.0.0">; searchContext: z.ZodString; url: z.ZodString; }, "strip", z.ZodTypeAny, { childNumberId: string; contact: { emailAddress: string; firstName: string; lastName: string; }; direction: "inbound" | "outbound"; eventId: string; eventName: "accepted"; isReplyEmail: boolean; isStandAloneTerminated: boolean; mainNumberId: string; media: "email"; method: "mapEvent"; schemaVersion: "1.0.0"; searchContext: string; url: string; }, { childNumberId: string; contact: { emailAddress: string; firstName: string; lastName: string; }; direction: "inbound" | "outbound"; eventId: string; eventName: "accepted"; isReplyEmail: boolean; isStandAloneTerminated: boolean; mainNumberId: string; media: "email"; method: "mapEvent"; schemaVersion: "1.0.0"; searchContext: string; url: string; } >; ``` --- ### EmailTerminatedCCPayloadSchema ```ts const EmailTerminatedCCPayloadSchema: z.ZodObject< Omit< { childNumberId: z.ZodOptional; contact: z.ZodObject< { emailAddress: z.ZodString; firstName: z.ZodOptional; lastName: z.ZodOptional; }, "strip", z.ZodTypeAny, { emailAddress: string; firstName: string; lastName: string; }, { emailAddress: string; firstName: string; lastName: string; } >; direction: z.ZodEnum<["inbound", "outbound"]>; eventId: z.ZodString; eventName: z.ZodLiteral<"accepted">; isReplyEmail: z.ZodBoolean; isStandAloneTerminated: z.ZodBoolean; mainNumberId: z.ZodString; media: z.ZodLiteral<"email">; method: z.ZodLiteral<"mapEvent">; schemaVersion: z.ZodLiteral<"1.0.0">; searchContext: z.ZodString; url: z.ZodString; }, "schemaVersion" | "eventName" > & { eventName: z.ZodLiteral<"terminated">; schemaVersion: z.ZodLiteral<"1.0.0">; }, "strip", z.ZodTypeAny, { childNumberId: string; contact: { emailAddress: string; firstName: string; lastName: string; }; direction: "inbound" | "outbound"; eventId: string; eventName: "terminated"; isReplyEmail: boolean; isStandAloneTerminated: boolean; mainNumberId: string; media: "email"; method: "mapEvent"; schemaVersion: "1.0.0"; searchContext: string; url: string; }, { childNumberId: string; contact: { emailAddress: string; firstName: string; lastName: string; }; direction: "inbound" | "outbound"; eventId: string; eventName: "terminated"; isReplyEmail: boolean; isStandAloneTerminated: boolean; mainNumberId: string; media: "email"; method: "mapEvent"; schemaVersion: "1.0.0"; searchContext: string; url: string; } >; ``` --- ### FILE_TRANSFER_ACTIONS ```ts const FILE_TRANSFER_ACTIONS: { CANCEL: "cancel"; CHUNK: "chunk"; COMPLETE: "complete"; ERROR: "error"; SEND_FILE: "send-file"; }; ``` File transfer action constants #### Type declaration | Name | Type | Default value | | ------------------------------------ | ------------- | ------------- | | `CANCEL` | `"cancel"` | "cancel" | | `CHUNK` | `"chunk"` | "chunk" | | `COMPLETE` | `"complete"` | "complete" | | `ERROR` | `"error"` | "error" | | `SEND_FILE` | `"send-file"` | "send-file" | --- ### FILE_TRANSFER_STATUS ```ts const FILE_TRANSFER_STATUS: { COMPLETED: "completed"; FAILED: "failed"; UPLOADING: "uploading"; }; ``` File transfer status constants #### Type declaration | Name | Type | Default value | | ------------------------------------ | ------------- | ------------- | | `COMPLETED` | `"completed"` | "completed" | | `FAILED` | `"failed"` | "failed" | | `UPLOADING` | `"uploading"` | "uploading" | --- ### HOLD_EVENT ```ts const HOLD_EVENT: "aw-interaction-hold-v1" = "aw-interaction-hold-v1"; ``` --- ### HoldPayloadSchema ```ts const HoldPayloadSchema: z.ZodObject< { interactionId: z.ZodString; schemaVersion: z.ZodLiteral<"1.0.0">; }, "strip", z.ZodTypeAny, { interactionId: string; schemaVersion: "1.0.0"; }, { interactionId: string; schemaVersion: "1.0.0"; } >; ``` --- ### INTERACTION_FOCUS_EVENT ```ts const INTERACTION_FOCUS_EVENT: "aw-interaction-focus-v1" = "aw-interaction-focus-v1"; ``` --- ### InteractionFocusPayloadSchema ```ts const InteractionFocusPayloadSchema: z.ZodObject< { interactionId: z.ZodString; schemaVersion: z.ZodLiteral<"1.0.0">; }, "strip", z.ZodTypeAny, { interactionId: string; schemaVersion: "1.0.0"; }, { interactionId: string; schemaVersion: "1.0.0"; } >; ``` --- ### MUTE_EVENT ```ts const MUTE_EVENT: "aw-interaction-mute-v1" = "aw-interaction-mute-v1"; ``` --- ### MutePayloadSchema ```ts const MutePayloadSchema: z.ZodObject< { interactionId: z.ZodString; schemaVersion: z.ZodLiteral<"1.0.0">; }, "strip", z.ZodTypeAny, { interactionId: string; schemaVersion: "1.0.0"; }, { interactionId: string; schemaVersion: "1.0.0"; } >; ``` --- ### RESUME_EVENT ```ts const RESUME_EVENT: "aw-interaction-resume-v1" = "aw-interaction-resume-v1"; ``` --- ### ResumePayloadSchema ```ts const ResumePayloadSchema: z.ZodObject< { interactionId: z.ZodString; schemaVersion: z.ZodLiteral<"1.0.0">; }, "strip", z.ZodTypeAny, { interactionId: string; schemaVersion: "1.0.0"; }, { interactionId: string; schemaVersion: "1.0.0"; } >; ``` --- ### SHELL_USER_DETAILS_EVENT ```ts const SHELL_USER_DETAILS_EVENT: "global-user-details-v1" = "global-user-details-v1"; ``` --- ### ShellUserDetailsPayloadSchema ```ts const ShellUserDetailsPayloadSchema: z.ZodObject< { customerId: z.ZodString; email: z.ZodOptional; firstName: z.ZodString; jobTitle: z.ZodString; language: z.ZodOptional; lastName: z.ZodString; loginId: z.ZodString; name: z.ZodString; schemaVersion: z.ZodLiteral<"1.0.0">; userId: z.ZodString; }, "strip", z.ZodTypeAny, { customerId: string; email: string; firstName: string; jobTitle: string; language: string; lastName: string; loginId: string; name: string; schemaVersion: "1.0.0"; userId: string; }, { customerId: string; email: string; firstName: string; jobTitle: string; language: string; lastName: string; loginId: string; name: string; schemaVersion: "1.0.0"; userId: string; } >; ``` --- ### UNMUTE_EVENT ```ts const UNMUTE_EVENT: "aw-interaction-unmute-v1" = "aw-interaction-unmute-v1"; ``` --- ### UnmutePayloadSchema ```ts const UnmutePayloadSchema: z.ZodObject< { interactionId: z.ZodString; schemaVersion: z.ZodLiteral<"1.0.0">; }, "strip", z.ZodTypeAny, { interactionId: string; schemaVersion: "1.0.0"; }, { interactionId: string; schemaVersion: "1.0.0"; } >; ``` --- ### VOICE_PHONE_ACCEPTED_CC_EVENT ```ts const VOICE_PHONE_ACCEPTED_CC_EVENT: "mashell-voice-phone-accepted-cc-event-v1" = "mashell-voice-phone-accepted-cc-event-v1"; ``` --- ### VOICE_PHONE_ACCEPTED_UC_EVENT ```ts const VOICE_PHONE_ACCEPTED_UC_EVENT: "mashell-voice-phone-accepted-uc-event-v1" = "mashell-voice-phone-accepted-uc-event-v1"; ``` --- ### VOICE_PHONE_COMPLETED_CC_EVENT ```ts const VOICE_PHONE_COMPLETED_CC_EVENT: "mashell-voice-phone-completed-cc-event-v1" = "mashell-voice-phone-completed-cc-event-v1"; ``` --- ### VOICE_PHONE_OFFERED_CC_EVENT ```ts const VOICE_PHONE_OFFERED_CC_EVENT: "mashell-voice-phone-offered-cc-event-v1" = "mashell-voice-phone-offered-cc-event-v1"; ``` --- ### VOICE_PHONE_OFFERED_UC_EVENT ```ts const VOICE_PHONE_OFFERED_UC_EVENT: "mashell-voice-phone-offered-uc-event-v1" = "mashell-voice-phone-offered-uc-event-v1"; ``` --- ### VOICE_PHONE_TERMINATED_CC_EVENT ```ts const VOICE_PHONE_TERMINATED_CC_EVENT: "mashell-voice-phone-terminated-cc-event-v1" = "mashell-voice-phone-terminated-cc-event-v1"; ``` --- ### VOICE_PHONE_TERMINATED_UC_EVENT ```ts const VOICE_PHONE_TERMINATED_UC_EVENT: "mashell-voice-phone-terminated-uc-event-v1" = "mashell-voice-phone-terminated-uc-event-v1"; ``` --- ### VOICEMAIL_ACCEPTED_CC_EVENT ```ts const VOICEMAIL_ACCEPTED_CC_EVENT: "mashell-voicemail-accepted-cc-event-v1" = "mashell-voicemail-accepted-cc-event-v1"; ``` --- ### VOICEMAIL_COMPLETED_CC_EVENT ```ts const VOICEMAIL_COMPLETED_CC_EVENT: "mashell-voicemail-completed-cc-event-v1" = "mashell-voicemail-completed-cc-event-v1"; ``` --- ### VOICEMAIL_OFFERED_CC_EVENT ```ts const VOICEMAIL_OFFERED_CC_EVENT: "mashell-voicemail-offered-cc-event-v1" = "mashell-voicemail-offered-cc-event-v1"; ``` --- ### VOICEMAIL_TERMINATED_CC_EVENT ```ts const VOICEMAIL_TERMINATED_CC_EVENT: "mashell-voicemail-terminated-cc-event-v1" = "mashell-voicemail-terminated-cc-event-v1"; ``` --- ### VoicemailAcceptedCCPayloadSchema ```ts const VoicemailAcceptedCCPayloadSchema: z.ZodObject< Omit< { callingName: z.ZodString; direction: z.ZodEnum<["inbound", "outbound"]>; eventId: z.ZodString; eventName: z.ZodLiteral<"offered">; media: z.ZodLiteral<"voicemail">; method: z.ZodString; schemaVersion: z.ZodLiteral<"1.0.0">; searchContext: z.ZodString; }, "schemaVersion" | "eventName" > & { eventName: z.ZodLiteral<"accepted">; schemaVersion: z.ZodLiteral<"1.0.0">; }, "strip", z.ZodTypeAny, { callingName: string; direction: "inbound" | "outbound"; eventId: string; eventName: "accepted"; media: "voicemail"; method: string; schemaVersion: "1.0.0"; searchContext: string; }, { callingName: string; direction: "inbound" | "outbound"; eventId: string; eventName: "accepted"; media: "voicemail"; method: string; schemaVersion: "1.0.0"; searchContext: string; } >; ``` --- ### VoicemailCompletedCCPayloadSchema ```ts const VoicemailCompletedCCPayloadSchema: z.ZodObject< { additionalData: z.ZodOptional< z.ZodObject< { notes: z.ZodOptional; }, "strip", z.ZodTypeAny, { notes: string; }, { notes: string; } > >; callDuration: z.ZodString; callingName: z.ZodString; direction: z.ZodEnum<["inbound", "outbound"]>; endTime: z.ZodString; eventId: z.ZodString; eventName: z.ZodLiteral<"completed">; media: z.ZodLiteral<"voicemail">; method: z.ZodLiteral<"mapEvent">; schemaVersion: z.ZodLiteral<"1.0.0">; searchContext: z.ZodString; startTime: z.ZodString; }, "strip", z.ZodTypeAny, { additionalData: { notes: string; }; callDuration: string; callingName: string; direction: "inbound" | "outbound"; endTime: string; eventId: string; eventName: "completed"; media: "voicemail"; method: "mapEvent"; schemaVersion: "1.0.0"; searchContext: string; startTime: string; }, { additionalData: { notes: string; }; callDuration: string; callingName: string; direction: "inbound" | "outbound"; endTime: string; eventId: string; eventName: "completed"; media: "voicemail"; method: "mapEvent"; schemaVersion: "1.0.0"; searchContext: string; startTime: string; } >; ``` --- ### VoicemailOfferedCCPayloadSchema ```ts const VoicemailOfferedCCPayloadSchema: z.ZodObject< { callingName: z.ZodString; direction: z.ZodEnum<["inbound", "outbound"]>; eventId: z.ZodString; eventName: z.ZodLiteral<"offered">; media: z.ZodLiteral<"voicemail">; method: z.ZodString; schemaVersion: z.ZodLiteral<"1.0.0">; searchContext: z.ZodString; }, "strip", z.ZodTypeAny, { callingName: string; direction: "inbound" | "outbound"; eventId: string; eventName: "offered"; media: "voicemail"; method: string; schemaVersion: "1.0.0"; searchContext: string; }, { callingName: string; direction: "inbound" | "outbound"; eventId: string; eventName: "offered"; media: "voicemail"; method: string; schemaVersion: "1.0.0"; searchContext: string; } >; ``` --- ### VoicemailTerminateCCPayloadSchema ```ts const VoicemailTerminateCCPayloadSchema: z.ZodObject< { additionalData: z.ZodObject< { disposition_code: z.ZodString; lastTclCodeDesc: z.ZodOptional; lastTclCodeShort: z.ZodOptional; notes: z.ZodOptional; }, "strip", z.ZodTypeAny, { disposition_code: string; lastTclCodeDesc: string; lastTclCodeShort: string; notes: string; }, { disposition_code: string; lastTclCodeDesc: string; lastTclCodeShort: string; notes: string; } >; callDuration: z.ZodString; callingName: z.ZodString; direction: z.ZodEnum<["inbound", "outbound"]>; endTime: z.ZodString; eventId: z.ZodString; eventName: z.ZodLiteral<"terminated">; media: z.ZodLiteral<"voicemail">; method: z.ZodLiteral<"mapEvent">; schemaVersion: z.ZodLiteral<"1.0.0">; searchContext: z.ZodString; startTime: z.ZodString; }, "strip", z.ZodTypeAny, { additionalData: { disposition_code: string; lastTclCodeDesc: string; lastTclCodeShort: string; notes: string; }; callDuration: string; callingName: string; direction: "inbound" | "outbound"; endTime: string; eventId: string; eventName: "terminated"; media: "voicemail"; method: "mapEvent"; schemaVersion: "1.0.0"; searchContext: string; startTime: string; }, { additionalData: { disposition_code: string; lastTclCodeDesc: string; lastTclCodeShort: string; notes: string; }; callDuration: string; callingName: string; direction: "inbound" | "outbound"; endTime: string; eventId: string; eventName: "terminated"; media: "voicemail"; method: "mapEvent"; schemaVersion: "1.0.0"; searchContext: string; startTime: string; } >; ``` --- ### VoicePhoneAcceptedCCPayloadSchema ```ts const VoicePhoneAcceptedCCPayloadSchema: z.ZodObject< Omit< { direction: z.ZodEnum<["inbound", "outbound"]>; eventId: z.ZodString; eventName: z.ZodLiteral<"offered">; media: z.ZodLiteral<"phone">; method: z.ZodLiteral<"mapEvent">; schemaVersion: z.ZodLiteral<"1.0.0">; searchContext: z.ZodString; }, "schemaVersion" | "eventName" > & { eventName: z.ZodLiteral<"accepted">; schemaVersion: z.ZodLiteral<"1.0.0">; }, "strip", z.ZodTypeAny, { direction: "inbound" | "outbound"; eventId: string; eventName: "accepted"; media: "phone"; method: "mapEvent"; schemaVersion: "1.0.0"; searchContext: string; }, { direction: "inbound" | "outbound"; eventId: string; eventName: "accepted"; media: "phone"; method: "mapEvent"; schemaVersion: "1.0.0"; searchContext: string; } >; ``` --- ### VoicePhoneAcceptedUCPayloadSchema ```ts const VoicePhoneAcceptedUCPayloadSchema: z.ZodObject< Omit< { direction: z.ZodEnum<["inbound", "outbound"]>; eventId: z.ZodString; eventName: z.ZodLiteral<"offered">; media: z.ZodLiteral<"phone">; method: z.ZodLiteral<"mapEvent">; schemaVersion: z.ZodLiteral<"1.0.0">; searchContext: z.ZodString; startTime: z.ZodString; }, "schemaVersion" | "eventName" > & { eventName: z.ZodLiteral<"accepted">; schemaVersion: z.ZodLiteral<"1.0.0">; }, "strip", z.ZodTypeAny, { direction: "inbound" | "outbound"; eventId: string; eventName: "accepted"; media: "phone"; method: "mapEvent"; schemaVersion: "1.0.0"; searchContext: string; startTime: string; }, { direction: "inbound" | "outbound"; eventId: string; eventName: "accepted"; media: "phone"; method: "mapEvent"; schemaVersion: "1.0.0"; searchContext: string; startTime: string; } >; ``` --- ### VoicePhoneCompletedCCPayloadSchema ```ts const VoicePhoneCompletedCCPayloadSchema: z.ZodObject< { additionalData: z.ZodOptional< z.ZodObject< { notes: z.ZodOptional; }, "strip", z.ZodTypeAny, { notes: string; }, { notes: string; } > >; callDuration: z.ZodString; callRecording: z.ZodOptional; direction: z.ZodEnum<["inbound", "outbound"]>; endTime: z.ZodString; eventId: z.ZodString; eventName: z.ZodLiteral<"completed">; hasRecording: z.ZodBoolean; media: z.ZodLiteral<"phone">; method: z.ZodLiteral<"mapEvent">; schemaVersion: z.ZodLiteral<"1.0.0">; searchContext: z.ZodString; startTime: z.ZodString; }, "strip", z.ZodTypeAny, { additionalData: { notes: string; }; callDuration: string; callRecording: string; direction: "inbound" | "outbound"; endTime: string; eventId: string; eventName: "completed"; hasRecording: boolean; media: "phone"; method: "mapEvent"; schemaVersion: "1.0.0"; searchContext: string; startTime: string; }, { additionalData: { notes: string; }; callDuration: string; callRecording: string; direction: "inbound" | "outbound"; endTime: string; eventId: string; eventName: "completed"; hasRecording: boolean; media: "phone"; method: "mapEvent"; schemaVersion: "1.0.0"; searchContext: string; startTime: string; } >; ``` --- ### VoicePhoneOfferedCCPayloadSchema ```ts const VoicePhoneOfferedCCPayloadSchema: z.ZodObject< { direction: z.ZodEnum<["inbound", "outbound"]>; eventId: z.ZodString; eventName: z.ZodLiteral<"offered">; media: z.ZodLiteral<"phone">; method: z.ZodLiteral<"mapEvent">; schemaVersion: z.ZodLiteral<"1.0.0">; searchContext: z.ZodString; }, "strip", z.ZodTypeAny, { direction: "inbound" | "outbound"; eventId: string; eventName: "offered"; media: "phone"; method: "mapEvent"; schemaVersion: "1.0.0"; searchContext: string; }, { direction: "inbound" | "outbound"; eventId: string; eventName: "offered"; media: "phone"; method: "mapEvent"; schemaVersion: "1.0.0"; searchContext: string; } >; ``` --- ### VoicePhoneOfferedUCPayloadSchema ```ts const VoicePhoneOfferedUCPayloadSchema: z.ZodObject< { direction: z.ZodEnum<["inbound", "outbound"]>; eventId: z.ZodString; eventName: z.ZodLiteral<"offered">; media: z.ZodLiteral<"phone">; method: z.ZodLiteral<"mapEvent">; schemaVersion: z.ZodLiteral<"1.0.0">; searchContext: z.ZodString; startTime: z.ZodString; }, "strip", z.ZodTypeAny, { direction: "inbound" | "outbound"; eventId: string; eventName: "offered"; media: "phone"; method: "mapEvent"; schemaVersion: "1.0.0"; searchContext: string; startTime: string; }, { direction: "inbound" | "outbound"; eventId: string; eventName: "offered"; media: "phone"; method: "mapEvent"; schemaVersion: "1.0.0"; searchContext: string; startTime: string; } >; ``` --- ### VoicePhoneTerminatedCCPayloadSchema ```ts const VoicePhoneTerminatedCCPayloadSchema: z.ZodObject< { additionalData: z.ZodObject< { disposition_code: z.ZodString; lastTclCodeDesc: z.ZodOptional; lastTclCodeShort: z.ZodOptional; notes: z.ZodOptional; }, "strip", z.ZodTypeAny, { disposition_code: string; lastTclCodeDesc: string; lastTclCodeShort: string; notes: string; }, { disposition_code: string; lastTclCodeDesc: string; lastTclCodeShort: string; notes: string; } >; callDuration: z.ZodString; callRecording: z.ZodOptional; direction: z.ZodEnum<["inbound", "outbound"]>; endTime: z.ZodString; eventId: z.ZodString; eventName: z.ZodLiteral<"terminated">; hasRecording: z.ZodBoolean; media: z.ZodLiteral<"phone">; method: z.ZodLiteral<"mapEvent">; schemaVersion: z.ZodLiteral<"1.0.0">; searchContext: z.ZodString; startTime: z.ZodString; }, "strip", z.ZodTypeAny, { additionalData: { disposition_code: string; lastTclCodeDesc: string; lastTclCodeShort: string; notes: string; }; callDuration: string; callRecording: string; direction: "inbound" | "outbound"; endTime: string; eventId: string; eventName: "terminated"; hasRecording: boolean; media: "phone"; method: "mapEvent"; schemaVersion: "1.0.0"; searchContext: string; startTime: string; }, { additionalData: { disposition_code: string; lastTclCodeDesc: string; lastTclCodeShort: string; notes: string; }; callDuration: string; callRecording: string; direction: "inbound" | "outbound"; endTime: string; eventId: string; eventName: "terminated"; hasRecording: boolean; media: "phone"; method: "mapEvent"; schemaVersion: "1.0.0"; searchContext: string; startTime: string; } >; ``` --- ### VoicePhoneTerminatedUCPayloadSchema ```ts const VoicePhoneTerminatedUCPayloadSchema: z.ZodObject< { callDuration: z.ZodString; callRecording: z.ZodOptional; direction: z.ZodEnum<["inbound", "outbound"]>; endTime: z.ZodString; eventId: z.ZodString; eventName: z.ZodLiteral<"terminated">; hasRecording: z.ZodBoolean; media: z.ZodLiteral<"phone">; method: z.ZodLiteral<"mapEvent">; schemaVersion: z.ZodLiteral<"1.0.0">; searchContext: z.ZodString; startTime: z.ZodString; }, "strip", z.ZodTypeAny, { callDuration: string; callRecording: string; direction: "inbound" | "outbound"; endTime: string; eventId: string; eventName: "terminated"; hasRecording: boolean; media: "phone"; method: "mapEvent"; schemaVersion: "1.0.0"; searchContext: string; startTime: string; }, { callDuration: string; callRecording: string; direction: "inbound" | "outbound"; endTime: string; eventId: string; eventName: "terminated"; hasRecording: boolean; media: "phone"; method: "mapEvent"; schemaVersion: "1.0.0"; searchContext: string; startTime: string; } >; ``` --- ### WRAP_UP_CODES_EVENT ```ts const WRAP_UP_CODES_EVENT: "aw-interaction-wrap-up-codes-v1" = "aw-interaction-wrap-up-codes-v1"; ``` --- ### WrapUpCodesPayloadSchema ```ts const WrapUpCodesPayloadSchema: z.ZodObject< { interactionId: z.ZodString; schemaVersion: z.ZodLiteral<"1.0.0">; wrapUpCodes: z.ZodArray< z.ZodObject< { ani: z.ZodOptional; assignments: z.ZodObject< { list: z.ZodArray; type: z.ZodString; }, "strip", z.ZodTypeAny, { list: string[]; type: string; }, { list: string[]; type: string; } >; autoSort: z.ZodBoolean; id: z.ZodString; isAgentDefault: z.ZodBoolean; items: z.ZodArray< z.ZodObject< { callBackTime: z.ZodNumber; callLineId: z.ZodString; dispositionCode: z.ZodString; id: z.ZodString; menuText: z.ZodString; ordinate: z.ZodString; parentId: z.ZodString; queueObjId: z.ZodString; reportText: z.ZodString; shortCodeText: z.ZodString; shortKeyText: z.ZodString; }, "strip", z.ZodTypeAny, { callBackTime: number; callLineId: string; dispositionCode: string; id: string; menuText: string; ordinate: string; parentId: string; queueObjId: string; reportText: string; shortCodeText: string; shortKeyText: string; }, { callBackTime: number; callLineId: string; dispositionCode: string; id: string; menuText: string; ordinate: string; parentId: string; queueObjId: string; reportText: string; shortCodeText: string; shortKeyText: string; } >, "many" >; multiChoice: z.ZodBoolean; name: z.ZodString; primaryLang: z.ZodString; reqBeforeOutbound: z.ZodBoolean; required: z.ZodBoolean; }, "strip", z.ZodTypeAny, { ani: string; assignments: { list: string[]; type: string; }; autoSort: boolean; id: string; isAgentDefault: boolean; items: { callBackTime: number; callLineId: string; dispositionCode: string; id: string; menuText: string; ordinate: string; parentId: string; queueObjId: string; reportText: string; shortCodeText: string; shortKeyText: string; }[]; multiChoice: boolean; name: string; primaryLang: string; reqBeforeOutbound: boolean; required: boolean; }, { ani: string; assignments: { list: string[]; type: string; }; autoSort: boolean; id: string; isAgentDefault: boolean; items: { callBackTime: number; callLineId: string; dispositionCode: string; id: string; menuText: string; ordinate: string; parentId: string; queueObjId: string; reportText: string; shortCodeText: string; shortKeyText: string; }[]; multiChoice: boolean; name: string; primaryLang: string; reqBeforeOutbound: boolean; required: boolean; } >, "many" >; }, "strip", z.ZodTypeAny, { interactionId: string; schemaVersion: "1.0.0"; wrapUpCodes: { ani: string; assignments: { list: string[]; type: string; }; autoSort: boolean; id: string; isAgentDefault: boolean; items: { callBackTime: number; callLineId: string; dispositionCode: string; id: string; menuText: string; ordinate: string; parentId: string; queueObjId: string; reportText: string; shortCodeText: string; shortKeyText: string; }[]; multiChoice: boolean; name: string; primaryLang: string; reqBeforeOutbound: boolean; required: boolean; }[]; }, { interactionId: string; schemaVersion: "1.0.0"; wrapUpCodes: { ani: string; assignments: { list: string[]; type: string; }; autoSort: boolean; id: string; isAgentDefault: boolean; items: { callBackTime: number; callLineId: string; dispositionCode: string; id: string; menuText: string; ordinate: string; parentId: string; queueObjId: string; reportText: string; shortCodeText: string; shortKeyText: string; }[]; multiChoice: boolean; name: string; primaryLang: string; reqBeforeOutbound: boolean; required: boolean; }[]; } >; ```