@wildix/wilma-copilot-sessions-client 1.0.2

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

@@ -0,0 +1,757 @@
+import type { DocumentType as __DocumentType, StreamingBlobTypes } from "@smithy/types";
+import type { AssetIcon, AssetSeverity, ButtonVariant, CallDevice, CallParticipantRole, CallParticipantType, CallTranscriptionSpeaker, ConferenceParticipantRole, ConferenceParticipantType, CopilotSessionStatus, License, LiveEventType, MessageSmsStatus, MessageType, MessageWhatsAppStatus, PbxLicenseType, TranscriptionSentiment } from "./enums";
+/**
+ * @public
+ */
+export interface TemplateParameter {
+    name: string;
+    value: string;
+}
+/**
+ * @public
+ */
+export interface TemplateWithParameters {
+    name: string;
+    parameters?: TemplateParameter[] | undefined;
+}
+/**
+ * @public
+ */
+export interface CallParticipant {
+    type: CallParticipantType;
+    phone?: string | undefined;
+    name?: string | undefined;
+    company?: string | undefined;
+    email?: string | undefined;
+    userId?: string | undefined;
+    userExtension?: string | undefined;
+    userDepartment?: string | undefined;
+    groupId?: string | undefined;
+    groupName?: string | undefined;
+    userAgent?: string | undefined;
+    userDevice?: CallDevice | undefined;
+    role: CallParticipantRole;
+    license?: string | undefined;
+    /**
+     * A unique identifier for the SIP call session used to control the call e.g., answer, hold, transfer, hang up.
+     * @public
+     */
+    sipCallId?: string | undefined;
+    /**
+     * Represents a network endpoint consisting of a public IP address and a port number. Example: '123.45.67.89:59317'
+     * @public
+     */
+    publicAddress?: string | undefined;
+    /**
+     * Represents a network endpoint consisting of a private IP address and a port number. Example: '172.16.1.2:54003'
+     * @public
+     */
+    privateAddress?: string | undefined;
+    /**
+     * The location specifies a geographic point using latitude and longitude coordinates. Example 'lat=29.3008&lon=1.7002'
+     * @public
+     */
+    location?: string | undefined;
+}
+/**
+ * @public
+ */
+export interface CallTranscriptionChunk {
+    id: string;
+    time: number;
+    speaker: CallTranscriptionSpeaker;
+    text: string;
+    language?: string | undefined;
+    isFinal: boolean;
+    start: number;
+    end: number;
+    /**
+     * Transcription confidence score (accuracy level) in range from 0.0 to 1.0. Value -1.0 indicates confidence is unavailable.
+     * @public
+     */
+    confidence?: number | undefined;
+    /**
+     * Sentiment label for a transcription chunk. Shared between calls and conferences.
+     * @public
+     */
+    sentiment?: TranscriptionSentiment | undefined;
+}
+/**
+ * @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
+ */
+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];
+    }
+    /**
+     * @deprecated unused in schema-serde mode.
+     *
+     */
+    interface Visitor<T> {
+        link: (value: ButtonLinkHandler) => T;
+        reply: (value: ButtonReplyHandler) => T;
+        action: (value: ButtonActionHandler) => T;
+        _: (name: string, value: any) => T;
+    }
+}
+/**
+ * @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];
+    }
+    /**
+     * @deprecated unused in schema-serde mode.
+     *
+     */
+    interface Visitor<T> {
+        button: (value: ButtonElement) => T;
+        _: (name: string, value: any) => 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];
+    }
+    /**
+     * @deprecated unused in schema-serde mode.
+     *
+     */
+    interface Visitor<T> {
+        template: (value: MessageTemplateConfig) => T;
+        actions: (value: ActionElement[]) => T;
+        _: (name: string, value: any) => 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
+ */
+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;
+    markdown?: boolean | 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 ConferenceParticipant {
+    type: ConferenceParticipantType;
+    role?: ConferenceParticipantRole | undefined;
+    /**
+     * A unique identifier to avoid duplicates if user re-connect from different devices.
+     * @public
+     */
+    jid?: string | undefined;
+    name?: string | undefined;
+    email?: string | undefined;
+    phone?: string | undefined;
+    department?: string | undefined;
+    company?: string | undefined;
+    pbxSerial?: string | undefined;
+    pbxExtension?: string | undefined;
+    pbxGroupId?: string | undefined;
+    xbsId?: string | undefined;
+    license?: PbxLicenseType | undefined;
+}
+/**
+ * @public
+ */
+export interface ConferenceTranscriptionChunk {
+    id: string;
+    time: number;
+    jid: string;
+    text: string;
+    language?: string | undefined;
+    isFinal: boolean;
+    start: number;
+    end: number;
+    /**
+     * Sentiment label for a transcription chunk. Shared between calls and conferences.
+     * @public
+     */
+    sentiment?: TranscriptionSentiment | undefined;
+}
+/**
+ * @public
+ */
+export interface CallAnalyticsLiveTranscriptionEvent {
+    id: string;
+    pbx: string;
+    time: number;
+    company: string;
+    licenses: License[];
+    event: LiveEventType;
+    flowIndex: number;
+    flowStartTime: number;
+    callStartTime: number;
+    chunk: CallTranscriptionChunk;
+    participant?: CallParticipant | undefined;
+}
+/**
+ * @public
+ */
+export interface ChatAnalyticsLiveTranscriptionEvent {
+    /**
+     * 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;
+    event: LiveEventType;
+    message: Message;
+}
+/**
+ * @public
+ */
+export interface ConferenceAnalyticsLiveTranscriptionEvent {
+    id: string;
+    time: number;
+    company: string;
+    event: LiveEventType;
+    conferenceStartTime: number;
+    transcriptionStartTime: number;
+    chunk: ConferenceTranscriptionChunk;
+    participant?: ConferenceParticipant | undefined;
+}
+/**
+ * An asset shown or updated in the session. Carries the full asset state at this point; re-emitted on updates (e.g. playbook progress).
+ * @public
+ */
+export interface CopilotAssetEvent {
+    /**
+     * Monotonic per-session event index. Drives resumption: pass `index + 1` of the last seen event as `startIndex` when reconnecting.
+     * @public
+     */
+    index: number;
+    /**
+     * ISO-8601 time the event was recorded.
+     * @public
+     */
+    timestamp: string;
+    id: string;
+    /**
+     * Icon shown on the asset card.
+     * @public
+     */
+    icon?: AssetIcon | undefined;
+    /**
+     * Visual emphasis of the asset card.
+     * @public
+     */
+    styling?: AssetSeverity | undefined;
+    sticky?: boolean | undefined;
+    content?: string | undefined;
+    state: __DocumentType;
+}
+/**
+ * An assistant chat shown or updated in the session.
+ * @public
+ */
+export interface CopilotAssistantEvent {
+    /**
+     * Monotonic per-session event index. Drives resumption: pass `index + 1` of the last seen event as `startIndex` when reconnecting.
+     * @public
+     */
+    index: number;
+    /**
+     * ISO-8601 time the event was recorded.
+     * @public
+     */
+    timestamp: string;
+    id: string;
+    state: __DocumentType;
+}
+/**
+ * An evaluation result detected or updated in the session. Carries the full evaluation state at this point; re-emitted on updates.
+ * @public
+ */
+export interface CopilotEvaluationEvent {
+    /**
+     * Monotonic per-session event index. Drives resumption: pass `index + 1` of the last seen event as `startIndex` when reconnecting.
+     * @public
+     */
+    index: number;
+    /**
+     * ISO-8601 time the event was recorded.
+     * @public
+     */
+    timestamp: string;
+    id: string;
+    state: __DocumentType;
+}
+/**
+ * An intent detected or updated in the session. Carries the full intent state at this point; re-emitted on updates.
+ * @public
+ */
+export interface CopilotIntentEvent {
+    /**
+     * Monotonic per-session event index. Drives resumption: pass `index + 1` of the last seen event as `startIndex` when reconnecting.
+     * @public
+     */
+    index: number;
+    /**
+     * ISO-8601 time the event was recorded.
+     * @public
+     */
+    timestamp: string;
+    id: string;
+    state: __DocumentType;
+}
+/**
+ * Session lifecycle transition. Emitted on attach and on every terminal transition.
+ * @public
+ */
+export interface CopilotLifecycleEvent {
+    /**
+     * Monotonic per-session event index. Drives resumption: pass `index + 1` of the last seen event as `startIndex` when reconnecting.
+     * @public
+     */
+    index: number;
+    /**
+     * ISO-8601 time the event was recorded.
+     * @public
+     */
+    timestamp: string;
+    sessionId: string;
+    status: CopilotSessionStatus;
+}
+/**
+ * Original WDA live transcription event for the assisted conversation surface.
+ * @public
+ */
+export type CopilotTranscriptionData = CopilotTranscriptionData.CallMember | CopilotTranscriptionData.ChatMember | CopilotTranscriptionData.ConferenceMember | CopilotTranscriptionData.$UnknownMember;
+/**
+ * @public
+ */
+export declare namespace CopilotTranscriptionData {
+    interface CallMember {
+        call: CallAnalyticsLiveTranscriptionEvent;
+        chat?: never;
+        conference?: never;
+        $unknown?: never;
+    }
+    interface ChatMember {
+        call?: never;
+        chat: ChatAnalyticsLiveTranscriptionEvent;
+        conference?: never;
+        $unknown?: never;
+    }
+    interface ConferenceMember {
+        call?: never;
+        chat?: never;
+        conference: ConferenceAnalyticsLiveTranscriptionEvent;
+        $unknown?: never;
+    }
+    /**
+     * @public
+     */
+    interface $UnknownMember {
+        call?: never;
+        chat?: never;
+        conference?: never;
+        $unknown: [string, any];
+    }
+    /**
+     * @deprecated unused in schema-serde mode.
+     *
+     */
+    interface Visitor<T> {
+        call: (value: CallAnalyticsLiveTranscriptionEvent) => T;
+        chat: (value: ChatAnalyticsLiveTranscriptionEvent) => T;
+        conference: (value: ConferenceAnalyticsLiveTranscriptionEvent) => T;
+        _: (name: string, value: any) => T;
+    }
+}
+/**
+ * A live transcription segment from the assisted conversation. Carries the original WDA analytics event without simplification.
+ * @public
+ */
+export interface CopilotTranscriptionEvent {
+    /**
+     * Monotonic per-session event index. Drives resumption: pass `index + 1` of the last seen event as `startIndex` when reconnecting.
+     * @public
+     */
+    index: number;
+    /**
+     * ISO-8601 time the event was recorded.
+     * @public
+     */
+    timestamp: string;
+    /**
+     * Original WDA live transcription event for the assisted conversation surface.
+     * @public
+     */
+    data: CopilotTranscriptionData;
+}
+/**
+ * A single typed copilot session event. Exactly one member is set; the member name doubles as the `event:` field of the SSE frames produced by StreamCopilotSessionEvents.
+ * @public
+ */
+export type CopilotSessionEvent = CopilotSessionEvent.AssetMember | CopilotSessionEvent.AssistantMember | CopilotSessionEvent.EvaluationMember | CopilotSessionEvent.IntentMember | CopilotSessionEvent.LifecycleMember | CopilotSessionEvent.TranscriptMember | CopilotSessionEvent.$UnknownMember;
+/**
+ * @public
+ */
+export declare namespace CopilotSessionEvent {
+    /**
+     * Session lifecycle transition. Emitted on attach and on every terminal transition.
+     * @public
+     */
+    interface LifecycleMember {
+        lifecycle: CopilotLifecycleEvent;
+        transcript?: never;
+        intent?: never;
+        evaluation?: never;
+        asset?: never;
+        assistant?: never;
+        $unknown?: never;
+    }
+    /**
+     * A live transcription segment from the assisted conversation. Carries the original WDA analytics event without simplification.
+     * @public
+     */
+    interface TranscriptMember {
+        lifecycle?: never;
+        transcript: CopilotTranscriptionEvent;
+        intent?: never;
+        evaluation?: never;
+        asset?: never;
+        assistant?: never;
+        $unknown?: never;
+    }
+    /**
+     * An intent detected or updated in the session. Carries the full intent state at this point; re-emitted on updates.
+     * @public
+     */
+    interface IntentMember {
+        lifecycle?: never;
+        transcript?: never;
+        intent: CopilotIntentEvent;
+        evaluation?: never;
+        asset?: never;
+        assistant?: never;
+        $unknown?: never;
+    }
+    /**
+     * An evaluation result detected or updated in the session. Carries the full evaluation state at this point; re-emitted on updates.
+     * @public
+     */
+    interface EvaluationMember {
+        lifecycle?: never;
+        transcript?: never;
+        intent?: never;
+        evaluation: CopilotEvaluationEvent;
+        asset?: never;
+        assistant?: never;
+        $unknown?: never;
+    }
+    /**
+     * An asset shown or updated in the session. Carries the full asset state at this point; re-emitted on updates (e.g. playbook progress).
+     * @public
+     */
+    interface AssetMember {
+        lifecycle?: never;
+        transcript?: never;
+        intent?: never;
+        evaluation?: never;
+        asset: CopilotAssetEvent;
+        assistant?: never;
+        $unknown?: never;
+    }
+    /**
+     * An assistant chat shown or updated in the session.
+     * @public
+     */
+    interface AssistantMember {
+        lifecycle?: never;
+        transcript?: never;
+        intent?: never;
+        evaluation?: never;
+        asset?: never;
+        assistant: CopilotAssistantEvent;
+        $unknown?: never;
+    }
+    /**
+     * @public
+     */
+    interface $UnknownMember {
+        lifecycle?: never;
+        transcript?: never;
+        intent?: never;
+        evaluation?: never;
+        asset?: never;
+        assistant?: never;
+        $unknown: [string, any];
+    }
+    /**
+     * @deprecated unused in schema-serde mode.
+     *
+     */
+    interface Visitor<T> {
+        lifecycle: (value: CopilotLifecycleEvent) => T;
+        transcript: (value: CopilotTranscriptionEvent) => T;
+        intent: (value: CopilotIntentEvent) => T;
+        evaluation: (value: CopilotEvaluationEvent) => T;
+        asset: (value: CopilotAssetEvent) => T;
+        assistant: (value: CopilotAssistantEvent) => T;
+        _: (name: string, value: any) => T;
+    }
+}
+/**
+ * @public
+ */
+export interface GetCopilotSessionEventsInput {
+    sessionId: string;
+    /**
+     * Return events with `index >= startIndex`. Defaults to 0.
+     * @public
+     */
+    startIndex?: number | undefined;
+    /**
+     * Maximum number of events to return. Defaults to 1000.
+     * @public
+     */
+    limit?: number | undefined;
+}
+/**
+ * @public
+ */
+export interface GetCopilotSessionEventsOutput {
+    events: CopilotSessionEvent[];
+    /**
+     * Present when more events exist; pass it as `startIndex` of the next call.
+     * @public
+     */
+    nextStartIndex?: number | undefined;
+}
+/**
+ * @public
+ */
+export interface StreamCopilotSessionEventsInput {
+    sessionId: string;
+    /**
+     * Replay recorded events with `index >= startIndex` before tailing live ones. Defaults to 0.
+     * @public
+     */
+    startIndex?: number | undefined;
+}
+/**
+ * @public
+ */
+export interface StreamCopilotSessionEventsOutput {
+    /**
+     * Raw Server-Sent Events byte stream (`text/event-stream`). Each frame carries one CopilotSessionEvent: `id:` is the event index, `event:` is the union member name, and `data:` is the JSON document of the union value, e.g. `\{"asset": \{...\}\}`.
+     * @public
+     */
+    events: StreamingBlobTypes;
+    contentType: string;
+}