@wildix/wda-stream-client 1.0.1

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

@@ -0,0 +1,857 @@
+import { WdaStreamServiceException as __BaseException } from "./WdaStreamServiceException";
+import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
+/**
+ * @public
+ */
+export declare class ForbiddenException extends __BaseException {
+    readonly name: "ForbiddenException";
+    readonly $fault: "client";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<ForbiddenException, __BaseException>);
+}
+/**
+ * @public
+ */
+export declare class ValidationException extends __BaseException {
+    readonly name: "ValidationException";
+    readonly $fault: "client";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
+}
+/**
+ * @public
+ * @enum
+ */
+export declare const LiveEventType: {
+    readonly CALL: "call";
+    readonly CALL_COMPLETE: "call_complete";
+    readonly CALL_INTERRUPTED: "call_interrupted";
+    readonly CALL_TRANSCRIPTION: "call_transcription";
+    readonly CALL_TRANSCRIPTION_COMPLETE: "call_transcription_complete";
+    readonly CHAT: "chat";
+    readonly CHAT_COMPLETE: "chat_complete";
+    readonly CHAT_INTERRUPTED: "chat_interrupted";
+    readonly CHAT_MISSED: "chat_missed";
+    readonly CONFERENCE: "conference";
+    readonly CONFERENCE_COMPLETE: "conference_complete";
+    readonly CONFERENCE_INTERRUPTED: "conference_interrupted";
+    readonly CONFERENCE_TRANSCRIPTION: "conference_transcription";
+    readonly CONFERENCE_TRANSCRIPTION_COMPLETE: "conference_transcription_complete";
+};
+/**
+ * @public
+ */
+export type LiveEventType = typeof LiveEventType[keyof typeof LiveEventType];
+/**
+ * @public
+ * @enum
+ */
+export declare const License: {
+    readonly XBEES: "x-bees";
+};
+/**
+ * @public
+ */
+export type License = typeof License[keyof typeof License];
+/**
+ * @public
+ */
+export interface CallAnalyticsLiveCompleteEvent {
+    id: string;
+    pbx: string;
+    time: number;
+    company: string;
+    licenses: (License | string)[];
+    event: LiveEventType | string;
+}
+/**
+ * @public
+ */
+export interface CallAnalyticsLiveInterruptedEvent {
+    id: string;
+    pbx: string;
+    time: number;
+    company: string;
+    licenses: (License | string)[];
+    event: LiveEventType | string;
+}
+/**
+ * @public
+ */
+export interface CallFlowAttachmentDestination {
+    phone?: string;
+    name?: string;
+    email?: string;
+    userId?: string;
+    userExtension?: string;
+    userDepartment?: string;
+    groupId?: string;
+    groupName?: string;
+}
+/**
+ * @public
+ * @enum
+ */
+export declare const CallFlowAttachmentType: {
+    readonly FAX: "FAX";
+    readonly VOICEMAIL: "VOICEMAIL";
+};
+/**
+ * @public
+ */
+export type CallFlowAttachmentType = typeof CallFlowAttachmentType[keyof typeof CallFlowAttachmentType];
+/**
+ * @public
+ * @enum
+ */
+export declare const CallParticipantRole: {
+    readonly AGENT: "AGENT";
+    readonly CLIENT: "CLIENT";
+};
+/**
+ * @public
+ */
+export type CallParticipantRole = typeof CallParticipantRole[keyof typeof CallParticipantRole];
+/**
+ * @public
+ * @enum
+ */
+export declare const CallParticipantType: {
+    readonly LOCAL: "LOCAL";
+    readonly REMOTE: "REMOTE";
+};
+/**
+ * @public
+ */
+export type CallParticipantType = typeof CallParticipantType[keyof typeof CallParticipantType];
+/**
+ * @public
+ * @enum
+ */
+export declare const CallDevice: {
+    readonly COLLABORATION_ANDROID: "COLLABORATION_ANDROID";
+    readonly COLLABORATION_IOS: "COLLABORATION_IOS";
+    readonly COLLABORATION_WEB: "COLLABORATION_WEB";
+    readonly UNKNOWN: "UNKNOWN";
+    readonly WILDIX_DEVICE: "WILDIX_DEVICE";
+    readonly WILDIX_PHONE: "WILDIX_PHONE";
+    readonly XBEES_ANDROID: "XBEES_ANDROID";
+    readonly XBEES_IOS: "XBEES_IOS";
+    readonly XBEES_WEB: "XBEES_WEB";
+};
+/**
+ * @public
+ */
+export type CallDevice = typeof CallDevice[keyof typeof CallDevice];
+/**
+ * @public
+ */
+export interface CallParticipant {
+    type: CallParticipantType | string;
+    phone?: string;
+    name?: string;
+    company?: string;
+    email?: string;
+    userId?: string;
+    userExtension?: string;
+    userDepartment?: string;
+    groupId?: string;
+    groupName?: string;
+    userAgent?: string;
+    userDevice?: CallDevice | string;
+    role: CallParticipantRole | string;
+    license?: string;
+}
+/**
+ * @public
+ * @enum
+ */
+export declare const ConversationStatus: {
+    readonly COMPLETED: "COMPLETED";
+    readonly MISSED: "MISSED";
+};
+/**
+ * @public
+ */
+export type ConversationStatus = typeof ConversationStatus[keyof typeof ConversationStatus];
+/**
+ * @public
+ * @enum
+ */
+export declare const CallDirection: {
+    readonly INBOUND: "INBOUND";
+    readonly INTERNAL: "INTERNAL";
+    readonly OUTBOUND: "OUTBOUND";
+    readonly UNDEFINED: "UNDEFINED";
+};
+/**
+ * @public
+ */
+export type CallDirection = typeof CallDirection[keyof typeof CallDirection];
+/**
+ * @public
+ * @enum
+ */
+export declare const CallFlowStatus: {
+    readonly CONNECTING: "CONNECTING";
+    readonly HOLD: "HOLD";
+    readonly TALKING: "TALKING";
+};
+/**
+ * @public
+ */
+export type CallFlowStatus = typeof CallFlowStatus[keyof typeof CallFlowStatus];
+/**
+ * @public
+ * @enum
+ */
+export declare const CallFlowTranscriptionStatus: {
+    readonly AVAILABLE: "AVAILABLE";
+    readonly UNAVAILABLE: "UNAVAILABLE";
+};
+/**
+ * @public
+ */
+export type CallFlowTranscriptionStatus = typeof CallFlowTranscriptionStatus[keyof typeof CallFlowTranscriptionStatus];
+/**
+ * @public
+ */
+export interface CallAnalyticsLiveProgressEventFlow {
+    status: CallFlowStatus | string;
+    /**
+     * @public
+     * Time of the last status change in yyyy-MM-dd'T'HH:mm:ss.SSS'Z' format.
+     */
+    statusChangeDate: string;
+    startTime: number;
+    connectTime?: number;
+    talkTime?: number;
+    waitTime?: number;
+    caller?: CallParticipant;
+    callee?: CallParticipant;
+    service?: string;
+    serviceNumber?: string;
+    destination?: string;
+    direction?: CallDirection | string;
+    trunkName?: string;
+    trunkDirection?: string;
+    queueName?: string;
+    queueId?: string;
+    tags?: (string)[];
+    flags?: (string)[];
+    callerMos?: string;
+    calleeMos?: string;
+    xhoppersConfId?: string;
+    recordings?: (string)[];
+    mergeWith?: string;
+    splitReason?: string;
+    splitTransferType?: string;
+    remotePhone?: string;
+    remotePhoneCountryCode?: number;
+    remotePhoneCountryCodeStr?: string;
+    remotePhoneLocation?: string;
+    callStatus?: ConversationStatus | string;
+    transcriptionStatus: CallFlowTranscriptionStatus | string;
+    attachment?: string;
+    attachmentType?: CallFlowAttachmentType | string;
+    attachmentDestinations?: (CallFlowAttachmentDestination)[];
+}
+/**
+ * @public
+ */
+export interface CallAnalyticsLiveProgressEvent {
+    id: string;
+    pbx: string;
+    time: number;
+    company: string;
+    licenses: (License | string)[];
+    event: LiveEventType | string;
+    start: string;
+    flows: (CallAnalyticsLiveProgressEventFlow)[];
+}
+/**
+ * @public
+ */
+export interface CallAnalyticsLiveTranscriptionCompleteEvent {
+    id: string;
+    pbx: string;
+    time: number;
+    company: string;
+    licenses: (License | string)[];
+    event: LiveEventType | string;
+}
+/**
+ * @public
+ * @enum
+ */
+export declare const CallTranscriptionSpeaker: {
+    readonly CALLEE: "callee";
+    readonly CALLER: "caller";
+};
+/**
+ * @public
+ */
+export type CallTranscriptionSpeaker = typeof CallTranscriptionSpeaker[keyof typeof CallTranscriptionSpeaker];
+/**
+ * @public
+ */
+export interface CallTranscriptionChunk {
+    id: string;
+    time: number;
+    speaker: CallTranscriptionSpeaker | string;
+    text: string;
+    language?: string;
+    isFinal: boolean;
+}
+/**
+ * @public
+ */
+export interface CallAnalyticsLiveTranscriptionEvent {
+    id: string;
+    pbx: string;
+    time: number;
+    company: string;
+    licenses: (License | string)[];
+    event: LiveEventType | string;
+    flowIndex: number;
+    chunk: CallTranscriptionChunk;
+    participant: CallParticipant;
+}
+/**
+ * @public
+ */
+export interface User {
+    id: string;
+    name?: string;
+    email?: string;
+    phone?: string;
+    picture?: string;
+    company?: string;
+    pbxDomain?: string;
+    pbxPort?: string;
+    pbxExtension?: string;
+    pbxSerial?: string;
+    pbxUserId?: string;
+    createdAt?: string;
+    updatedAt?: string;
+}
+/**
+ * @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 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 ChatParticipant {
+    id: string;
+    name?: string;
+    email?: string;
+    phone?: string;
+    picture?: string;
+    company?: string;
+    pbxDomain?: string;
+    pbxPort?: string;
+    pbxExtension?: string;
+    pbxSerial?: string;
+    pbxUserId?: string;
+    createdAt?: string;
+    updatedAt?: string;
+    type: ChatParticipantType | string;
+    role: ChatParticipantRole | string;
+}
+/**
+ * @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";
+};
+/**
+ * @public
+ */
+export type ChatTag = typeof ChatTag[keyof typeof ChatTag];
+/**
+ * @public
+ */
+export interface ChatAnalyticsLiveProgressEvent {
+    id: string;
+    time: number;
+    company: string;
+    event: LiveEventType | string;
+    start: string;
+    channelId: string;
+    channelType: ChannelType | string;
+    subject: string;
+    service?: string;
+    serviceTitle?: string;
+    participants: (ChatParticipant)[];
+    agents: (User)[];
+    agentsCount: number;
+    customers: (User)[];
+    customersCount: number;
+    tags?: (ChatTag | string)[];
+    direction: ChatDirection | string;
+    status: ChatStatus | string;
+}
+/**
+ * @public
+ */
+export interface ChatConsumeEventParticipants {
+    /**
+     * @public
+     * A list of Agents available in the Chat, up to 8 items, sorted by name.
+     */
+    agents: (User)[];
+    agentsCount: number;
+    /**
+     * @public
+     * A list of Customers available in the Chat, up to 8 items, sorted by name.
+     */
+    customers: (User)[];
+    customersCount: number;
+}
+/**
+ * @public
+ * @enum
+ */
+export declare const ChatConsumeEventType: {
+    readonly CHAT_NEW: "CHAT.NEW";
+    readonly CHAT_UPDATE: "CHAT.UPDATE";
+};
+/**
+ * @public
+ */
+export type ChatConsumeEventType = typeof ChatConsumeEventType[keyof typeof ChatConsumeEventType];
+/**
+ * @public
+ */
+export interface ChatNewConsumeEventData {
+    channelId: string;
+    channelType: ChannelType | string;
+    subject: string;
+    service?: string;
+    serviceTitle?: string;
+    participants: ChatConsumeEventParticipants;
+    tags?: (ChatTag | string)[];
+    sender: User;
+}
+/**
+ * @public
+ */
+export interface ChatNewConsumeEvent {
+    type: ChatConsumeEventType | string;
+    company: string;
+    time: number;
+    data: ChatNewConsumeEventData;
+}
+/**
+ * @public
+ */
+export interface ChatUpdateConsumeEventData {
+    channelId: string;
+    channelType: ChannelType | string;
+    subject: string;
+    service?: string;
+    serviceTitle?: string;
+    participants: ChatConsumeEventParticipants;
+    tags?: (ChatTag | string)[];
+}
+/**
+ * @public
+ */
+export interface ChatUpdateConsumeEvent {
+    type: ChatConsumeEventType | string;
+    company: string;
+    time: number;
+    data: ChatUpdateConsumeEventData;
+}
+/**
+ * @public
+ */
+export interface ConferenceAnalyticsLiveCompleteEvent {
+    id: string;
+    time: number;
+    company: string;
+    event: LiveEventType | string;
+}
+/**
+ * @public
+ */
+export interface ConferenceAnalyticsLiveInterruptedEvent {
+    id: string;
+    time: number;
+    company: string;
+    event: LiveEventType | string;
+}
+/**
+ * @public
+ * @enum
+ */
+export declare const ConferenceParticipantRole: {
+    readonly AGENT: "AGENT";
+    readonly CLIENT: "CLIENT";
+};
+/**
+ * @public
+ */
+export type ConferenceParticipantRole = typeof ConferenceParticipantRole[keyof typeof ConferenceParticipantRole];
+/**
+ * @public
+ * @enum
+ */
+export declare const ConferenceParticipantType: {
+    readonly EXTERNAL: "EXTERNAL";
+    readonly EXTERNAL_DIAL_IN: "EXTERNAL_DIAL_IN";
+    readonly PBX: "PBX";
+    readonly PBX_SIP: "PBX_SIP";
+    readonly XBS: "XBS";
+};
+/**
+ * @public
+ */
+export type ConferenceParticipantType = typeof ConferenceParticipantType[keyof typeof ConferenceParticipantType];
+/**
+ * @public
+ */
+export interface ConferenceParticipant {
+    type: ConferenceParticipantType | string;
+    role?: ConferenceParticipantRole | string;
+    /**
+     * @public
+     * A unique identifier to avoid duplicates if user re-connect from different devices.
+     */
+    jid?: string;
+    name?: string;
+    email?: string;
+    phone?: string;
+    department?: string;
+    company?: string;
+    pbxSerial?: string;
+    pbxExtension?: string;
+    xbsId?: string;
+}
+/**
+ * @public
+ * @enum
+ */
+export declare const ConferenceTranscriptionStatus: {
+    readonly AVAILABLE: "AVAILABLE";
+    readonly UNAVAILABLE: "UNAVAILABLE";
+};
+/**
+ * @public
+ */
+export type ConferenceTranscriptionStatus = typeof ConferenceTranscriptionStatus[keyof typeof ConferenceTranscriptionStatus];
+/**
+ * @public
+ */
+export interface ConferenceAnalyticsLiveProgressEvent {
+    id: string;
+    time: number;
+    company: string;
+    event: LiveEventType | string;
+    start: string;
+    subject: string;
+    participants: (ConferenceParticipant)[];
+    transcriptionStatus: ConferenceTranscriptionStatus | string;
+}
+/**
+ * @public
+ */
+export interface ConferenceAnalyticsLiveTranscriptionCompleteEvent {
+    id: string;
+    time: number;
+    company: string;
+    event: LiveEventType | string;
+}
+/**
+ * @public
+ */
+export interface ConferenceTranscriptionChunk {
+    id: string;
+    time: number;
+    jid: string;
+    text: string;
+    language?: string;
+    isFinal: boolean;
+}
+/**
+ * @public
+ */
+export interface ConferenceAnalyticsLiveTranscriptionEvent {
+    id: string;
+    time: number;
+    company: string;
+    event: LiveEventType | string;
+    chunk: ConferenceTranscriptionChunk;
+    participant: ConferenceParticipant;
+}
+/**
+ * @public
+ */
+export interface SmsInboundConsumeEventData {
+    /**
+     * @public
+     * A unique ID of the SMS message (example fb0ee129-f98f-4d7f-af1e-32b657aa3a56)
+     */
+    id: string;
+    from: string;
+    to: string;
+    message: string;
+}
+/**
+ * @public
+ * @enum
+ */
+export declare const SmsConsumeEventType: {
+    readonly SMS_INBOUND: "SMS.INBOUND";
+    readonly SMS_STATUS: "SMS.STATUS";
+};
+/**
+ * @public
+ */
+export type SmsConsumeEventType = typeof SmsConsumeEventType[keyof typeof SmsConsumeEventType];
+/**
+ * @public
+ */
+export interface SmsInboundConsumeEvent {
+    pbx: string;
+    company: string;
+    time: number;
+    type: SmsConsumeEventType | string;
+    data: SmsInboundConsumeEventData;
+}
+/**
+ * @public
+ * @enum
+ */
+export declare const SmsChannelType: {
+    readonly ONE_WAY: "1-way-sms";
+    readonly TWO_WAY: "2-way-sms";
+};
+/**
+ * @public
+ */
+export type SmsChannelType = typeof SmsChannelType[keyof typeof SmsChannelType];
+/**
+ * @public
+ * @enum
+ */
+export declare const SmsStatus: {
+    readonly DELIVERED: "delivered";
+    readonly ERROR: "error";
+    readonly SENT: "sent";
+    readonly TRYING: "trying";
+};
+/**
+ * @public
+ */
+export type SmsStatus = typeof SmsStatus[keyof typeof SmsStatus];
+/**
+ * @public
+ */
+export interface SmsStatusConsumeEventData {
+    id: string;
+    from: string;
+    to: string;
+    status: SmsStatus | string;
+    channel: SmsChannelType | string;
+    parts: number;
+}
+/**
+ * @public
+ */
+export interface SmsStatusConsumeEvent {
+    pbx: string;
+    company: string;
+    time: number;
+    type: SmsConsumeEventType | string;
+    data: SmsStatusConsumeEventData;
+}
+/**
+ * @public
+ */
+export type ConsumeEventInputEvent = ConsumeEventInputEvent.ChatNewMember | ConsumeEventInputEvent.ChatUpdateMember | ConsumeEventInputEvent.SmsInboundMember | ConsumeEventInputEvent.SmsStatusMember | ConsumeEventInputEvent.$UnknownMember;
+/**
+ * @public
+ */
+export declare namespace ConsumeEventInputEvent {
+    interface ChatNewMember {
+        chatNew: ChatNewConsumeEvent;
+        chatUpdate?: never;
+        smsInbound?: never;
+        smsStatus?: never;
+        $unknown?: never;
+    }
+    interface ChatUpdateMember {
+        chatNew?: never;
+        chatUpdate: ChatUpdateConsumeEvent;
+        smsInbound?: never;
+        smsStatus?: never;
+        $unknown?: never;
+    }
+    interface SmsInboundMember {
+        chatNew?: never;
+        chatUpdate?: never;
+        smsInbound: SmsInboundConsumeEvent;
+        smsStatus?: never;
+        $unknown?: never;
+    }
+    interface SmsStatusMember {
+        chatNew?: never;
+        chatUpdate?: never;
+        smsInbound?: never;
+        smsStatus: SmsStatusConsumeEvent;
+        $unknown?: never;
+    }
+    /**
+     * @public
+     */
+    interface $UnknownMember {
+        chatNew?: never;
+        chatUpdate?: never;
+        smsInbound?: never;
+        smsStatus?: never;
+        $unknown: [string, any];
+    }
+    interface Visitor<T> {
+        chatNew: (value: ChatNewConsumeEvent) => T;
+        chatUpdate: (value: ChatUpdateConsumeEvent) => T;
+        smsInbound: (value: SmsInboundConsumeEvent) => T;
+        smsStatus: (value: SmsStatusConsumeEvent) => T;
+        _: (name: string, value: any) => T;
+    }
+    const visit: <T>(value: ConsumeEventInputEvent, visitor: Visitor<T>) => T;
+}
+/**
+ * @public
+ */
+export interface ConsumeEventInput {
+    event: ConsumeEventInputEvent;
+}
+/**
+ * @public
+ */
+export interface ConsumeEventOutput {
+}
+/**
+ * @public
+ */
+export interface SmsInboundEvent {
+    pbx: string;
+    company: string;
+    time: number;
+    type: SmsConsumeEventType | string;
+    data: SmsInboundConsumeEventData;
+}
+/**
+ * @public
+ */
+export interface SmsStatusEvent {
+    pbx: string;
+    company: string;
+    time: number;
+    type: SmsConsumeEventType | string;
+    data: SmsStatusConsumeEventData;
+}
+/**
+ * @public
+ */
+export interface DescribeEventInput {
+    SmsInboundEvent?: SmsInboundEvent;
+    SmsStatusEvent?: SmsStatusEvent;
+}
+/**
+ * @public
+ */
+export interface DescribeEventOutput {
+    CallAnalyticsLiveProgressEvent?: CallAnalyticsLiveProgressEvent;
+    CallAnalyticsLiveCompleteEvent?: CallAnalyticsLiveCompleteEvent;
+    CallAnalyticsLiveInterruptedEvent?: CallAnalyticsLiveInterruptedEvent;
+    CallAnalyticsLiveTranscriptionEvent?: CallAnalyticsLiveTranscriptionEvent;
+    CallAnalyticsLiveTranscriptionCompleteEvent?: CallAnalyticsLiveTranscriptionCompleteEvent;
+    ConferenceAnalyticsLiveProgressEvent?: ConferenceAnalyticsLiveProgressEvent;
+    ConferenceAnalyticsLiveCompleteEvent?: ConferenceAnalyticsLiveCompleteEvent;
+    ConferenceAnalyticsLiveInterruptedEvent?: ConferenceAnalyticsLiveInterruptedEvent;
+    ConferenceAnalyticsLiveTranscriptionEvent?: ConferenceAnalyticsLiveTranscriptionEvent;
+    ConferenceAnalyticsLiveTranscriptionCompleteEvent?: ConferenceAnalyticsLiveTranscriptionCompleteEvent;
+}
+/**
+ * @public
+ */
+export interface GetOngoingConversationsInput {
+    company?: string;
+}
+/**
+ * @public
+ */
+export interface GetOngoingConversationsOutput {
+    calls: (CallAnalyticsLiveProgressEvent)[];
+    conferences: (ConferenceAnalyticsLiveProgressEvent)[];
+    chats: (ChatAnalyticsLiveProgressEvent)[];
+}