@wildix/wda-history-client 1.2.1 → 1.2.8

package/dist-types/models/models_0.d.ts

@@ -48,6 +48,20 @@ export declare class ForbiddenException extends __BaseException {
      */
     constructor(opts: __ExceptionOptionType<ForbiddenException, __BaseException>);
 }
+/**
+ * @public
+ */
+export interface TemplateParameter {
+    name: string;
+    value: string;
+}
+/**
+ * @public
+ */
+export interface TemplateWithParameters {
+    name: string;
+    parameters: (TemplateParameter)[];
+}
 /**
  * @public
  */
@@ -308,6 +322,8 @@ export type CallFlowTranscriptionStatus = typeof CallFlowTranscriptionStatus[key
 export declare const RecordType: {
     readonly CALL: "call";
     readonly CALL_TRANSCRIPTION: "call_transcription";
+    readonly CHAT: "chat";
+    readonly CHAT_TRANSCRIPTION: "chat_transcription";
     readonly CONFERENCE: "conference";
     readonly CONFERENCE_TRANSCRIPTION: "conference_transcription";
 };
@@ -549,6 +565,619 @@ export interface CallTranscriptionRecord {
     callStartTime: number;
     chunks: (CallTranscriptionChunk)[];
 }
+/**
+ * @public
+ */
+export declare class ChatNotFoundException extends __BaseException {
+    readonly name: "ChatNotFoundException";
+    readonly $fault: "client";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<ChatNotFoundException, __BaseException>);
+}
+/**
+ * @public
+ * @enum
+ */
+export declare const ChannelAccess: {
+    readonly PRIVATE: "private";
+    readonly PUBLIC: "public";
+};
+/**
+ * @public
+ */
+export type ChannelAccess = typeof ChannelAccess[keyof typeof ChannelAccess];
+/**
+ * @public
+ */
+export interface User {
+    id: string;
+    name?: string | undefined;
+    email?: string | undefined;
+    phone?: string | undefined;
+    picture?: string | undefined;
+    locale?: string | undefined;
+    timeZone?: string | undefined;
+    company?: string | undefined;
+    bot?: boolean | undefined;
+    pbxDomain?: string | undefined;
+    pbxPort?: string | undefined;
+    pbxExtension?: string | undefined;
+    pbxSerial?: string | undefined;
+    pbxUserId?: string | undefined;
+    pbxGroupId?: string | undefined;
+    createdAt?: string | undefined;
+    updatedAt?: string | undefined;
+}
+/**
+ * @public
+ * @enum
+ */
+export declare const ChannelType: {
+    readonly DIRECT: "direct";
+    readonly GROUP: "group";
+};
+/**
+ * @public
+ */
+export type ChannelType = typeof ChannelType[keyof typeof ChannelType];
+/**
+ * @public
+ * @enum
+ */
+export declare const ChannelContextEventAttendeeStatus: {
+    readonly ACCEPTED: "accepted";
+    readonly DECLINED: "declined";
+    readonly NONE: "none";
+    readonly TENTATIVE: "tentative";
+};
+/**
+ * @public
+ */
+export type ChannelContextEventAttendeeStatus = typeof ChannelContextEventAttendeeStatus[keyof typeof ChannelContextEventAttendeeStatus];
+/**
+ * @public
+ */
+export interface ChannelContextEventAttendee {
+    email: string;
+    name?: string | undefined;
+    status: ChannelContextEventAttendeeStatus;
+}
+/**
+ * @public
+ */
+export interface ChannelContextEvent {
+    id?: string | undefined;
+    owner?: string | undefined;
+    start?: string | undefined;
+    end?: string | undefined;
+    summary?: string | undefined;
+    attendees?: (ChannelContextEventAttendee)[] | undefined;
+}
+/**
+ * @public
+ */
+export interface ChannelContextPushToTalk {
+    /**
+     * A unique identifier of x-hoppers broadcast conference. If present x-hoppers application will use broadcast and push-to-talk functionality for the channel.
+     * @public
+     */
+    broadcastId?: string | undefined;
+}
+/**
+ * @public
+ * @enum
+ */
+export declare const ChannelContextSource: {
+    readonly KITE: "kite";
+};
+/**
+ * @public
+ */
+export type ChannelContextSource = typeof ChannelContextSource[keyof typeof ChannelContextSource];
+/**
+ * @public
+ */
+export interface ChannelContext {
+    source?: ChannelContextSource | undefined;
+    target?: string | undefined;
+    events?: (ChannelContextEvent)[] | undefined;
+    ptt?: ChannelContextPushToTalk | undefined;
+}
+/**
+ * @public
+ * @enum
+ */
+export declare const ChannelWhatsAppStatus: {
+    readonly CHANNEL_CLOSED: "24h_channel_closed";
+};
+/**
+ * @public
+ */
+export type ChannelWhatsAppStatus = typeof ChannelWhatsAppStatus[keyof typeof ChannelWhatsAppStatus];
+/**
+ * @public
+ */
+export interface Channel {
+    subject?: string | undefined;
+    description?: string | undefined;
+    /**
+     * Picture URL
+     * @public
+     */
+    picture?: string | undefined;
+    /**
+     * Picture dominant color represented by a hex value.
+     * @public
+     */
+    pictureColor?: string | undefined;
+    access?: ChannelAccess | undefined;
+    company?: string | undefined;
+    context?: ChannelContext | undefined;
+    kite?: boolean | undefined;
+    kiteTarget?: string | undefined;
+    kiteVariant?: string | undefined;
+    kiteAssign?: string | undefined;
+    kiteServiceName?: string | undefined;
+    kiteDefaultSubject?: string | undefined;
+    service?: string | undefined;
+    serviceTitle?: string | undefined;
+    serviceRecipient?: string | undefined;
+    assignee?: User | undefined;
+    telephony?: boolean | undefined;
+    sms?: boolean | undefined;
+    mms?: boolean | undefined;
+    whatsapp?: boolean | undefined;
+    whatsappStatus?: ChannelWhatsAppStatus | undefined;
+    broadcast?: boolean | undefined;
+    external?: boolean | undefined;
+    autoRecord?: boolean | undefined;
+    transcriptionLanguage?: string | undefined;
+    channelId: string;
+    channelType: ChannelType;
+    memberCount: number;
+    createdAt: string;
+    createdBy: string;
+    updatedAt?: string | undefined;
+}
+/**
+ * @public
+ * @enum
+ */
+export declare const ChatDirection: {
+    readonly INBOUND: "INBOUND";
+    readonly INTERNAL: "INTERNAL";
+    readonly OUTBOUND: "OUTBOUND";
+};
+/**
+ * @public
+ */
+export type ChatDirection = typeof ChatDirection[keyof typeof ChatDirection];
+/**
+ * @public
+ * @enum
+ */
+export declare const ChatParticipantRole: {
+    readonly AGENT: "AGENT";
+    readonly CLIENT: "CLIENT";
+};
+/**
+ * @public
+ */
+export type ChatParticipantRole = typeof ChatParticipantRole[keyof typeof ChatParticipantRole];
+/**
+ * @public
+ * @enum
+ */
+export declare const ChatParticipantType: {
+    readonly LOCAL: "LOCAL";
+    readonly REMOTE: "REMOTE";
+};
+/**
+ * @public
+ */
+export type ChatParticipantType = typeof ChatParticipantType[keyof typeof ChatParticipantType];
+/**
+ * @public
+ */
+export interface ChatParticipantInfo {
+    id: string;
+    name?: string | undefined;
+    email?: string | undefined;
+    phone?: string | undefined;
+    picture?: string | undefined;
+    locale?: string | undefined;
+    timeZone?: string | undefined;
+    company?: string | undefined;
+    bot?: boolean | undefined;
+    pbxDomain?: string | undefined;
+    pbxPort?: string | undefined;
+    pbxExtension?: string | undefined;
+    pbxSerial?: string | undefined;
+    pbxUserId?: string | undefined;
+    pbxGroupId?: string | undefined;
+    createdAt?: string | undefined;
+    updatedAt?: string | undefined;
+    type: ChatParticipantType;
+    role: ChatParticipantRole;
+}
+/**
+ * @public
+ */
+export interface ChatParticipant {
+    id: string;
+    info: ChatParticipantInfo;
+}
+/**
+ * @public
+ * @enum
+ */
+export declare const ChatStatus: {
+    readonly COMPLETED: "COMPLETED";
+    readonly MISSED: "MISSED";
+    readonly WAITFIRSTREPLY: "WAITFIRSTREPLY";
+    readonly WAITREPLYFROMAGENT: "WAITREPLYFROMAGENT";
+    readonly WAITREPLYFROMGUEST: "WAITREPLYFROMGUEST";
+};
+/**
+ * @public
+ */
+export type ChatStatus = typeof ChatStatus[keyof typeof ChatStatus];
+/**
+ * @public
+ * @enum
+ */
+export declare const ChatTag: {
+    readonly SMS: "sms";
+    readonly TELEPHONY: "telephony";
+    readonly WHATSAPP: "whatsapp";
+};
+/**
+ * @public
+ */
+export type ChatTag = typeof ChatTag[keyof typeof ChatTag];
+/**
+ * @public
+ */
+export interface ChatRecord {
+    /**
+     * A unique chat channel identifier, distinguish each chat channel across different types.
+     * @public
+     */
+    id?: string | undefined;
+    /**
+     * A unique identifier that distinguishes each chat session within a channel.
+     * @public
+     */
+    chatId?: string | undefined;
+    time: number;
+    company: string;
+    pbx?: string | undefined;
+    startTime?: number | undefined;
+    endTime?: number | undefined;
+    waitTime?: number | undefined;
+    duration?: number | undefined;
+    direction?: ChatDirection | undefined;
+    subject?: string | undefined;
+    service?: string | undefined;
+    serviceTitle?: string | undefined;
+    tags?: (ChatTag)[] | undefined;
+    channel?: Channel | undefined;
+    status?: ChatStatus | undefined;
+    participants?: (ChatParticipant)[] | undefined;
+    type: RecordType;
+}
+/**
+ * @public
+ */
+export declare class ChatTranscriptionNotFoundException extends __BaseException {
+    readonly name: "ChatTranscriptionNotFoundException";
+    readonly $fault: "client";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<ChatTranscriptionNotFoundException, __BaseException>);
+}
+/**
+ * @public
+ */
+export interface MessageAttachment {
+    id: string;
+    /**
+     * This *is* documentation about the field. Describe here what fsId and how to get it.
+     * @public
+     */
+    fsId: string;
+    mime?: string | undefined;
+    name: string;
+    size: number;
+    width?: number | undefined;
+    height?: number | undefined;
+    thumbnail?: string | undefined;
+}
+/**
+ * @public
+ */
+export interface ButtonActionHandler {
+    /**
+     * A unique ID of the action within the message.
+     * @public
+     */
+    id: string;
+}
+/**
+ * @public
+ */
+export interface ButtonLinkHandler {
+    url: string;
+}
+/**
+ * @public
+ */
+export interface ButtonReplyHandler {
+    text?: string | undefined;
+}
+/**
+ * @public
+ */
+export type ButtonHandler = ButtonHandler.ActionMember | ButtonHandler.LinkMember | ButtonHandler.ReplyMember | ButtonHandler.$UnknownMember;
+/**
+ * @public
+ */
+export declare namespace ButtonHandler {
+    interface LinkMember {
+        link: ButtonLinkHandler;
+        reply?: never;
+        action?: never;
+        $unknown?: never;
+    }
+    interface ReplyMember {
+        link?: never;
+        reply: ButtonReplyHandler;
+        action?: never;
+        $unknown?: never;
+    }
+    interface ActionMember {
+        link?: never;
+        reply?: never;
+        action: ButtonActionHandler;
+        $unknown?: never;
+    }
+    /**
+     * @public
+     */
+    interface $UnknownMember {
+        link?: never;
+        reply?: never;
+        action?: never;
+        $unknown: [string, any];
+    }
+    interface Visitor<T> {
+        link: (value: ButtonLinkHandler) => T;
+        reply: (value: ButtonReplyHandler) => T;
+        action: (value: ButtonActionHandler) => T;
+        _: (name: string, value: any) => T;
+    }
+    const visit: <T>(value: ButtonHandler, visitor: Visitor<T>) => T;
+}
+/**
+ * @public
+ * @enum
+ */
+export declare const ButtonVariant: {
+    readonly CONTAINED: "contained";
+    readonly OUTLINED: "outlined";
+};
+/**
+ * @public
+ */
+export type ButtonVariant = typeof ButtonVariant[keyof typeof ButtonVariant];
+/**
+ * @public
+ */
+export interface ButtonElement {
+    text: string;
+    handler: ButtonHandler;
+    variant?: ButtonVariant | undefined;
+    disabled?: boolean | undefined;
+}
+/**
+ * @public
+ */
+export type ActionElement = ActionElement.ButtonMember | ActionElement.$UnknownMember;
+/**
+ * @public
+ */
+export declare namespace ActionElement {
+    interface ButtonMember {
+        button: ButtonElement;
+        $unknown?: never;
+    }
+    /**
+     * @public
+     */
+    interface $UnknownMember {
+        button?: never;
+        $unknown: [string, any];
+    }
+    interface Visitor<T> {
+        button: (value: ButtonElement) => T;
+        _: (name: string, value: any) => T;
+    }
+    const visit: <T>(value: ActionElement, visitor: Visitor<T>) => T;
+}
+/**
+ * @public
+ */
+export interface MessageTemplateConfig {
+    whatsapp?: TemplateWithParameters | undefined;
+}
+/**
+ * @public
+ */
+export type Element = Element.ActionsMember | Element.TemplateMember | Element.$UnknownMember;
+/**
+ * @public
+ */
+export declare namespace Element {
+    interface TemplateMember {
+        template: MessageTemplateConfig;
+        actions?: never;
+        $unknown?: never;
+    }
+    interface ActionsMember {
+        template?: never;
+        actions: (ActionElement)[];
+        $unknown?: never;
+    }
+    /**
+     * @public
+     */
+    interface $UnknownMember {
+        template?: never;
+        actions?: never;
+        $unknown: [string, any];
+    }
+    interface Visitor<T> {
+        template: (value: MessageTemplateConfig) => T;
+        actions: (value: (ActionElement)[]) => T;
+        _: (name: string, value: any) => T;
+    }
+    const visit: <T>(value: Element, visitor: Visitor<T>) => T;
+}
+/**
+ * @public
+ */
+export interface MessageForward {
+    forwardCompany?: string | undefined;
+    forwardDate: string;
+    forwardEmail?: string | undefined;
+    forwardName?: string | undefined;
+    messageId: string;
+    channelId: string;
+}
+/**
+ * @public
+ */
+export interface MessageGiphy {
+    id: string;
+    size: string;
+    url: string;
+    height: string;
+    width: string;
+}
+/**
+ * @public
+ */
+export interface Reaction {
+    type?: string | undefined;
+    userId?: string | undefined;
+    messageId?: string | undefined;
+    user?: User | undefined;
+}
+/**
+ * @public
+ */
+export interface MessageQuote {
+    messageId: string;
+    channelId: string;
+    user: User;
+    text?: string | undefined;
+    attachments?: (MessageAttachment)[] | undefined;
+    forward?: MessageForward | undefined;
+    mentions?: (User)[] | undefined;
+    giphy?: MessageGiphy | undefined;
+    createdAt: string;
+    updatedAt?: string | undefined;
+}
+/**
+ * @public
+ * @enum
+ */
+export declare const MessageSmsStatus: {
+    readonly DELIVERED: "delivered";
+    readonly ERROR: "error";
+    readonly SENT: "sent";
+    readonly TRYING: "trying";
+};
+/**
+ * @public
+ */
+export type MessageSmsStatus = typeof MessageSmsStatus[keyof typeof MessageSmsStatus];
+/**
+ * @public
+ * @enum
+ */
+export declare const MessageType: {
+    readonly DELETED: "deleted";
+    readonly REGULAR: "regular";
+    readonly SYSTEM: "system";
+};
+/**
+ * @public
+ */
+export type MessageType = typeof MessageType[keyof typeof MessageType];
+/**
+ * @public
+ * @enum
+ */
+export declare const MessageWhatsAppStatus: {
+    readonly DELIVERED: "delivered";
+    readonly ERROR: "error";
+    readonly SENT: "sent";
+    readonly TRYING: "trying";
+};
+/**
+ * @public
+ */
+export type MessageWhatsAppStatus = typeof MessageWhatsAppStatus[keyof typeof MessageWhatsAppStatus];
+/**
+ * @public
+ */
+export interface Message {
+    text?: string | undefined;
+    elements?: (Element)[] | undefined;
+    attachments?: (MessageAttachment)[] | undefined;
+    quote?: MessageQuote | undefined;
+    forward?: MessageForward | undefined;
+    whatsapp?: boolean | undefined;
+    whatsappStatus?: MessageWhatsAppStatus | undefined;
+    sms?: boolean | undefined;
+    smsStatus?: MessageSmsStatus | undefined;
+    type: MessageType;
+    giphy?: MessageGiphy | undefined;
+    silent?: boolean | undefined;
+    event?: string | undefined;
+    messageId: string;
+    channelId: string;
+    user: User;
+    edit?: boolean | undefined;
+    mentions?: (User)[] | undefined;
+    latestReactions?: (Reaction)[] | undefined;
+    reactionCounts?: Record<string, number> | undefined;
+    createdAt: string;
+    updatedAt?: string | undefined;
+}
+/**
+ * @public
+ */
+export interface ChatTranscriptionRecord {
+    /**
+     * A unique chat channel identifier, distinguish each chat channel across different types.
+     * @public
+     */
+    id?: string | undefined;
+    /**
+     * A unique identifier that distinguishes each chat session within a channel.
+     * @public
+     */
+    chatId?: string | undefined;
+    time: number;
+    company: string;
+    type: RecordType;
+    messages: (Message)[];
+}
 /**
  * @public
  */
@@ -905,6 +1534,59 @@ export interface GetCallTranscriptionTextOutput {
     text: string;
     chunks: (TranscriptionTextChunk)[];
 }
+/**
+ * @public
+ */
+export interface GetChatInput {
+    company?: string | undefined;
+    /**
+     * A unique identifier that distinguishes each chat session within a channel.
+     * @public
+     */
+    chatId: string;
+}
+/**
+ * @public
+ */
+export interface GetChatOutput {
+    chat: ChatRecord;
+}
+/**
+ * @public
+ */
+export interface GetChatTranscriptionInput {
+    company?: string | undefined;
+    /**
+     * A unique identifier that distinguishes each chat session within a channel.
+     * @public
+     */
+    chatId: string;
+}
+/**
+ * @public
+ */
+export interface GetChatTranscriptionOutput {
+    transcription: ChatTranscriptionRecord;
+}
+/**
+ * @public
+ */
+export interface GetChatTranscriptionTextInput {
+    company?: string | undefined;
+    /**
+     * A unique identifier that distinguishes each chat session within a channel.
+     * @public
+     */
+    chatId: string;
+}
+/**
+ * @public
+ */
+export interface GetChatTranscriptionTextOutput {
+    filename: string;
+    text: string;
+    messages: (Message)[];
+}
 /**
  * @public
  */