@wildix/wda-history-client 1.2.24 → 1.2.25

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

@@ -1,5 +1,6 @@
 import { WdaHistoryServiceException as __BaseException } from "./WdaHistoryServiceException";
 import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
+import { DocumentType as __DocumentType } from "@smithy/types";
 /**
  * @public
  */
@@ -62,6 +63,184 @@ export interface TemplateWithParameters {
     name: string;
     parameters?: (TemplateParameter)[] | undefined;
 }
+/**
+ * @public
+ */
+export declare class CallAnnotationsNotFoundException extends __BaseException {
+    readonly name: "CallAnnotationsNotFoundException";
+    readonly $fault: "client";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<CallAnnotationsNotFoundException, __BaseException>);
+}
+/**
+ * Tool result captured for an annotation. Runtime services enforce serialized payload size limits.
+ * @public
+ */
+export interface AnnotationResultValue {
+    value: __DocumentType;
+}
+/**
+ * Capability variable values captured for an annotation. Runtime services enforce serialized payload size limits.
+ * @public
+ */
+export interface AnnotationVariablesValue {
+    value: __DocumentType;
+}
+/**
+ * @public
+ */
+export type AnnotationPayload = AnnotationPayload.ResultMember | AnnotationPayload.TagMember | AnnotationPayload.TextMember | AnnotationPayload.VariablesMember | AnnotationPayload.$UnknownMember;
+/**
+ * @public
+ */
+export declare namespace AnnotationPayload {
+    interface TagMember {
+        tag: string;
+        text?: never;
+        variables?: never;
+        result?: never;
+        $unknown?: never;
+    }
+    interface TextMember {
+        tag?: never;
+        text: string;
+        variables?: never;
+        result?: never;
+        $unknown?: never;
+    }
+    /**
+     * Capability variable values captured for an annotation. Runtime services enforce serialized payload size limits.
+     * @public
+     */
+    interface VariablesMember {
+        tag?: never;
+        text?: never;
+        variables: AnnotationVariablesValue;
+        result?: never;
+        $unknown?: never;
+    }
+    /**
+     * Tool result captured for an annotation. Runtime services enforce serialized payload size limits.
+     * @public
+     */
+    interface ResultMember {
+        tag?: never;
+        text?: never;
+        variables?: never;
+        result: AnnotationResultValue;
+        $unknown?: never;
+    }
+    /**
+     * @public
+     */
+    interface $UnknownMember {
+        tag?: never;
+        text?: never;
+        variables?: never;
+        result?: never;
+        $unknown: [string, any];
+    }
+    interface Visitor<T> {
+        tag: (value: string) => T;
+        text: (value: string) => T;
+        variables: (value: AnnotationVariablesValue) => T;
+        result: (value: AnnotationResultValue) => T;
+        _: (name: string, value: any) => T;
+    }
+    const visit: <T>(value: AnnotationPayload, visitor: Visitor<T>) => T;
+}
+/**
+ * @public
+ * @enum
+ */
+export declare const AnnotationSourceType: {
+    readonly CHATBOT: "chatbot";
+    readonly SYSTEM: "system";
+    readonly USER: "user";
+    readonly VOICEBOT: "voicebot";
+};
+/**
+ * @public
+ */
+export type AnnotationSourceType = typeof AnnotationSourceType[keyof typeof AnnotationSourceType];
+/**
+ * Producer of an annotation. Generic identifiers allow callers to attach context such as tool id/name, user id/name, etc., without constraining the source type to a fixed shape.
+ * @public
+ */
+export interface AnnotationSource {
+    type: AnnotationSourceType;
+    /**
+     * Stable identifier of the producer (e.g. tool id, user id).
+     * @public
+     */
+    id?: string | undefined;
+    /**
+     * Human-readable name of the producer (e.g. tool name, user display name).
+     * @public
+     */
+    name?: string | undefined;
+}
+/**
+ * @public
+ */
+export interface Annotation {
+    id: string;
+    time: number;
+    payload: AnnotationPayload;
+    /**
+     * Producer of an annotation. Generic identifiers allow callers to attach context such as tool id/name, user id/name, etc., without constraining the source type to a fixed shape.
+     * @public
+     */
+    source: AnnotationSource;
+}
+/**
+ * @public
+ * @enum
+ */
+export declare const License: {
+    readonly UC: "uc";
+    readonly XBEES: "x-bees";
+};
+/**
+ * @public
+ */
+export type License = typeof License[keyof typeof License];
+/**
+ * @public
+ * @enum
+ */
+export declare const RecordType: {
+    readonly CALL: "call";
+    readonly CALL_ANNOTATIONS: "call_annotations";
+    readonly CALL_TRANSCRIPTION: "call_transcription";
+    readonly CHAT: "chat";
+    readonly CHAT_ANNOTATIONS: "chat_annotations";
+    readonly CHAT_TRANSCRIPTION: "chat_transcription";
+    readonly CONFERENCE: "conference";
+    readonly CONFERENCE_ANNOTATIONS: "conference_annotations";
+    readonly CONFERENCE_TRANSCRIPTION: "conference_transcription";
+};
+/**
+ * @public
+ */
+export type RecordType = typeof RecordType[keyof typeof RecordType];
+/**
+ * @public
+ */
+export interface CallAnnotationsRecord {
+    id: string;
+    pbx: string;
+    time: number;
+    company: string;
+    licenses: (License)[];
+    type: RecordType;
+    flowIndex: number;
+    flowStartTime: number;
+    callStartTime: number;
+    annotations: (Annotation)[];
+}
 /**
  * @public
  */
@@ -73,6 +252,18 @@ export declare class CallNotFoundException extends __BaseException {
      */
     constructor(opts: __ExceptionOptionType<CallNotFoundException, __BaseException>);
 }
+/**
+ * @public
+ * @enum
+ */
+export declare const AnnotationsStatus: {
+    readonly AVAILABLE: "AVAILABLE";
+    readonly UNAVAILABLE: "UNAVAILABLE";
+};
+/**
+ * @public
+ */
+export type AnnotationsStatus = typeof AnnotationsStatus[keyof typeof AnnotationsStatus];
 /**
  * @public
  */
@@ -306,18 +497,6 @@ export interface CallParticipant {
      */
     location?: string | undefined;
 }
-/**
- * @public
- * @enum
- */
-export declare const License: {
-    readonly UC: "uc";
-    readonly XBEES: "x-bees";
-};
-/**
- * @public
- */
-export type License = typeof License[keyof typeof License];
 /**
  * @public
  */
@@ -338,22 +517,6 @@ export declare const CallFlowTranscriptionStatus: {
  * @public
  */
 export type CallFlowTranscriptionStatus = typeof CallFlowTranscriptionStatus[keyof typeof CallFlowTranscriptionStatus];
-/**
- * @public
- * @enum
- */
-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";
-};
-/**
- * @public
- */
-export type RecordType = typeof RecordType[keyof typeof RecordType];
 /**
  * @public
  */
@@ -436,6 +599,7 @@ export interface CallRecord {
     transcriptionStatus?: CallFlowTranscriptionStatus | undefined;
     transcriptionLanguage?: string | undefined;
     transcriptionSeconds?: number | undefined;
+    annotationsStatus?: AnnotationsStatus | undefined;
     /**
      * Consider to use `attachments` instead.
      *
@@ -622,6 +786,36 @@ export interface CallTranscriptionRecord {
     callStartTime: number;
     chunks: (CallTranscriptionChunk)[];
 }
+/**
+ * @public
+ */
+export declare class ChatAnnotationsNotFoundException extends __BaseException {
+    readonly name: "ChatAnnotationsNotFoundException";
+    readonly $fault: "client";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<ChatAnnotationsNotFoundException, __BaseException>);
+}
+/**
+ * @public
+ */
+export interface ChatAnnotationsRecord {
+    /**
+     * 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;
+    annotations: (Annotation)[];
+}
 /**
  * @public
  */
@@ -924,6 +1118,7 @@ export interface ChatRecord {
     channel: Channel;
     status?: ChatStatus | undefined;
     participants: (ChatParticipant)[];
+    annotationsStatus?: AnnotationsStatus | undefined;
     type: RecordType;
 }
 /**
@@ -1237,6 +1432,27 @@ export interface ChatTranscriptionRecord {
     type: RecordType;
     messages: (Message)[];
 }
+/**
+ * @public
+ */
+export declare class ConferenceAnnotationsNotFoundException extends __BaseException {
+    readonly name: "ConferenceAnnotationsNotFoundException";
+    readonly $fault: "client";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<ConferenceAnnotationsNotFoundException, __BaseException>);
+}
+/**
+ * @public
+ */
+export interface ConferenceAnnotationsRecord {
+    id: string;
+    time: number;
+    company: string;
+    type: RecordType;
+    annotations: (Annotation)[];
+}
 /**
  * @public
  */
@@ -1377,6 +1593,7 @@ export interface ConferenceRecord {
     transcriptionStatus: ConferenceTranscriptionStatus;
     transcriptionLanguage?: string | undefined;
     transcriptionSeconds?: number | undefined;
+    annotationsStatus?: AnnotationsStatus | undefined;
     type: RecordType;
 }
 /**
@@ -1553,6 +1770,20 @@ export interface GetCallInput {
 export interface GetCallOutput {
     call: CallRecord;
 }
+/**
+ * @public
+ */
+export interface GetCallAnnotationsInput {
+    company?: string | undefined;
+    callId: string;
+    flowIndex: number;
+}
+/**
+ * @public
+ */
+export interface GetCallAnnotationsOutput {
+    annotations: CallAnnotationsRecord;
+}
 /**
  * @public
  */
@@ -1615,6 +1846,23 @@ export interface GetChatInput {
 export interface GetChatOutput {
     chat: ChatRecord;
 }
+/**
+ * @public
+ */
+export interface GetChatAnnotationsInput {
+    company?: string | undefined;
+    /**
+     * A unique identifier that distinguishes each chat session within a channel.
+     * @public
+     */
+    chatId: string;
+}
+/**
+ * @public
+ */
+export interface GetChatAnnotationsOutput {
+    annotations: ChatAnnotationsRecord;
+}
 /**
  * @public
  */
@@ -1664,6 +1912,19 @@ export interface GetConferenceInput {
 export interface GetConferenceOutput {
     conference: ConferenceRecord;
 }
+/**
+ * @public
+ */
+export interface GetConferenceAnnotationsInput {
+    company?: string | undefined;
+    conferenceId: string;
+}
+/**
+ * @public
+ */
+export interface GetConferenceAnnotationsOutput {
+    annotations: ConferenceAnnotationsRecord;
+}
 /**
  * @public
  */

package/dist-types/protocols/Aws_restJson1.d.ts

@@ -1,9 +1,12 @@
+import { GetCallAnnotationsCommandInput, GetCallAnnotationsCommandOutput } from "../commands/GetCallAnnotationsCommand";
 import { GetCallCommandInput, GetCallCommandOutput } from "../commands/GetCallCommand";
 import { GetCallTranscriptionCommandInput, GetCallTranscriptionCommandOutput } from "../commands/GetCallTranscriptionCommand";
 import { GetCallTranscriptionTextCommandInput, GetCallTranscriptionTextCommandOutput } from "../commands/GetCallTranscriptionTextCommand";
+import { GetChatAnnotationsCommandInput, GetChatAnnotationsCommandOutput } from "../commands/GetChatAnnotationsCommand";
 import { GetChatCommandInput, GetChatCommandOutput } from "../commands/GetChatCommand";
 import { GetChatTranscriptionCommandInput, GetChatTranscriptionCommandOutput } from "../commands/GetChatTranscriptionCommand";
 import { GetChatTranscriptionTextCommandInput, GetChatTranscriptionTextCommandOutput } from "../commands/GetChatTranscriptionTextCommand";
+import { GetConferenceAnnotationsCommandInput, GetConferenceAnnotationsCommandOutput } from "../commands/GetConferenceAnnotationsCommand";
 import { GetConferenceCommandInput, GetConferenceCommandOutput } from "../commands/GetConferenceCommand";
 import { GetConferenceTranscriptionCommandInput, GetConferenceTranscriptionCommandOutput } from "../commands/GetConferenceTranscriptionCommand";
 import { GetConferenceTranscriptionTextCommandInput, GetConferenceTranscriptionTextCommandOutput } from "../commands/GetConferenceTranscriptionTextCommand";
@@ -16,6 +19,10 @@ import { SerdeContext as __SerdeContext } from "@smithy/types";
  * serializeAws_restJson1GetCallCommand
  */
 export declare const se_GetCallCommand: (input: GetCallCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
+/**
+ * serializeAws_restJson1GetCallAnnotationsCommand
+ */
+export declare const se_GetCallAnnotationsCommand: (input: GetCallAnnotationsCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
 /**
  * serializeAws_restJson1GetCallTranscriptionCommand
  */
@@ -28,6 +35,10 @@ export declare const se_GetCallTranscriptionTextCommand: (input: GetCallTranscri
  * serializeAws_restJson1GetChatCommand
  */
 export declare const se_GetChatCommand: (input: GetChatCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
+/**
+ * serializeAws_restJson1GetChatAnnotationsCommand
+ */
+export declare const se_GetChatAnnotationsCommand: (input: GetChatAnnotationsCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
 /**
  * serializeAws_restJson1GetChatTranscriptionCommand
  */
@@ -40,6 +51,10 @@ export declare const se_GetChatTranscriptionTextCommand: (input: GetChatTranscri
  * serializeAws_restJson1GetConferenceCommand
  */
 export declare const se_GetConferenceCommand: (input: GetConferenceCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
+/**
+ * serializeAws_restJson1GetConferenceAnnotationsCommand
+ */
+export declare const se_GetConferenceAnnotationsCommand: (input: GetConferenceAnnotationsCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
 /**
  * serializeAws_restJson1GetConferenceTranscriptionCommand
  */
@@ -64,6 +79,10 @@ export declare const se_UpdateCallCommand: (input: UpdateCallCommandInput, conte
  * deserializeAws_restJson1GetCallCommand
  */
 export declare const de_GetCallCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<GetCallCommandOutput>;
+/**
+ * deserializeAws_restJson1GetCallAnnotationsCommand
+ */
+export declare const de_GetCallAnnotationsCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<GetCallAnnotationsCommandOutput>;
 /**
  * deserializeAws_restJson1GetCallTranscriptionCommand
  */
@@ -76,6 +95,10 @@ export declare const de_GetCallTranscriptionTextCommand: (output: __HttpResponse
  * deserializeAws_restJson1GetChatCommand
  */
 export declare const de_GetChatCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<GetChatCommandOutput>;
+/**
+ * deserializeAws_restJson1GetChatAnnotationsCommand
+ */
+export declare const de_GetChatAnnotationsCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<GetChatAnnotationsCommandOutput>;
 /**
  * deserializeAws_restJson1GetChatTranscriptionCommand
  */
@@ -88,6 +111,10 @@ export declare const de_GetChatTranscriptionTextCommand: (output: __HttpResponse
  * deserializeAws_restJson1GetConferenceCommand
  */
 export declare const de_GetConferenceCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<GetConferenceCommandOutput>;
+/**
+ * deserializeAws_restJson1GetConferenceAnnotationsCommand
+ */
+export declare const de_GetConferenceAnnotationsCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<GetConferenceAnnotationsCommandOutput>;
 /**
  * deserializeAws_restJson1GetConferenceTranscriptionCommand
  */

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@wildix/wda-history-client",
     "description": "@wildix/wda-history-client client",
-    "version": "1.2.24",
+    "version": "1.2.25",
     "scripts": {
         "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
         "build:cjs": "tsc -p tsconfig.cjs.json",