@wildix/wilma-copilot-sessions-client 1.0.7 → 1.0.8

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

@@ -1,5 +1,5 @@
 import type { DocumentType as __DocumentType, StreamingBlobTypes } from "@smithy/types";
-import type { AssetIcon, AssetSeverity, ButtonVariant, CallDevice, CallParticipantRole, CallParticipantType, CallTranscriptionSpeaker, ConferenceParticipantRole, ConferenceParticipantType, CopilotConversationKind, CopilotIngestedSessionState, CopilotLifecycleReason, CopilotSessionStatus, License, LiveEventType, MessageSmsStatus, MessageType, MessageWhatsAppStatus, PbxLicenseType, TranscriptionSentiment } from "./enums";
+import type { AssetIcon, AssetSeverity, ButtonVariant, CallDevice, CallParticipantRole, CallParticipantType, CallTranscriptionSpeaker, ConferenceParticipantRole, ConferenceParticipantType, CopilotActionStatus, CopilotConversationKind, CopilotIngestedSessionState, CopilotLifecycleReason, CopilotSessionStatus, License, LiveEventType, MessageSmsStatus, MessageType, MessageWhatsAppStatus, PbxLicenseType, TranscriptionSentiment } from "./enums";
 /**
  * @public
  */
@@ -423,6 +423,114 @@ export interface ConferenceAnalyticsLiveTranscriptionEvent {
     chunk: ConferenceTranscriptionChunk;
     participant?: ConferenceParticipant | undefined;
 }
+/**
+ * Launches the knowledge search suggested for a detected question (contextual knowledge answers, `suggest_action` mode).
+ * @public
+ */
+export interface KnowledgeSearchClientAction {
+    /**
+     * The suggested question's id — the `questionId` carried by the suggestion asset's action payload.
+     * @public
+     */
+    questionId: string;
+    /**
+     * The question text; used when the suggestion is no longer part of the live session state (e.g. after a revive).
+     * @public
+     */
+    question?: string | undefined;
+}
+/**
+ * Invokes one smart action offered by an asset.
+ * @public
+ */
+export interface SmartActionClientAction {
+    /**
+     * Id of the asset carrying the smart action.
+     * @public
+     */
+    assetId: string;
+    /**
+     * Id of the clicked action inside the asset's smart-action list.
+     * @public
+     */
+    actionId: string;
+    /**
+     * Values for `guided` variable bindings collected from the user, keyed by variable name.
+     * @public
+     */
+    variables?: __DocumentType | undefined;
+}
+/**
+ * One user interaction with copilot output. Exactly one member is set.
+ * @public
+ */
+export type CopilotClientAction = CopilotClientAction.KnowledgeSearchMember | CopilotClientAction.SmartActionMember | CopilotClientAction.$UnknownMember;
+/**
+ * @public
+ */
+export declare namespace CopilotClientAction {
+    /**
+     * Launches the knowledge search suggested for a detected question (contextual knowledge answers, `suggest_action` mode).
+     * @public
+     */
+    interface KnowledgeSearchMember {
+        knowledgeSearch: KnowledgeSearchClientAction;
+        smartAction?: never;
+        $unknown?: never;
+    }
+    /**
+     * Invokes one smart action offered by an asset.
+     * @public
+     */
+    interface SmartActionMember {
+        knowledgeSearch?: never;
+        smartAction: SmartActionClientAction;
+        $unknown?: never;
+    }
+    /**
+     * @public
+     */
+    interface $UnknownMember {
+        knowledgeSearch?: never;
+        smartAction?: never;
+        $unknown: [string, any];
+    }
+    /**
+     * @deprecated unused in schema-serde mode.
+     *
+     */
+    interface Visitor<T> {
+        knowledgeSearch: (value: KnowledgeSearchClientAction) => T;
+        smartAction: (value: SmartActionClientAction) => T;
+        _: (name: string, value: any) => T;
+    }
+}
+/**
+ * @public
+ */
+export interface ActInput {
+    sessionId: string;
+    /**
+     * Company that owns the session. Required when calling with a service (s2s) token, which is not scoped to a single company.
+     * @public
+     */
+    company?: string | undefined;
+    /**
+     * One user interaction with copilot output. Exactly one member is set.
+     * @public
+     */
+    action: CopilotClientAction;
+}
+/**
+ * @public
+ */
+export interface ActOutput {
+    /**
+     * True when the action was accepted into the session mailbox. Follow the event log for outcomes.
+     * @public
+     */
+    accepted: boolean;
+}
 /**
  * @public
  */
@@ -458,6 +566,48 @@ export interface AskOutput {
      */
     index: number;
 }
+/**
+ * A client action recorded in the session with its execution outcome. Emitted when the action is accepted (`launched`) and re-emitted when its execution settles (`completed` / `failed`).
+ * @public
+ */
+export interface CopilotActionEvent {
+    /**
+     * 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 of the asset the action belongs to.
+     * @public
+     */
+    id: string;
+    /**
+     * What was invoked: `knowledge_search`, `runAgent`, `runTool`, `transfer`, `handover` or `openUrl`.
+     * @public
+     */
+    kind: string;
+    status: CopilotActionStatus;
+    /**
+     * The user who triggered the action.
+     * @public
+     */
+    userId?: string | undefined;
+    /**
+     * Execution result payload, for smart actions with `show_card` result mode.
+     * @public
+     */
+    result?: __DocumentType | undefined;
+    /**
+     * Failure description when status is `failed`.
+     * @public
+     */
+    error?: string | undefined;
+}
 /**
  * An ask recorded in the session. The ask itself runs as a regular Wilma session (wilma-assistant); any agent in the company can render its output by presenting `accessToken` to wilma-assistant — copilot sessions are shared within the tenant.
  * @public
@@ -519,6 +669,18 @@ export interface CopilotAssetEvent {
     content?: string | undefined;
     state: __DocumentType;
 }
+/**
+ * One asset the user actually saw rendered in the copilot panel.
+ * @public
+ */
+export interface CopilotAssetView {
+    assetId: string;
+    /**
+     * When the asset became visible. Defaults to the time the report is ingested.
+     * @public
+     */
+    at?: string | undefined;
+}
 /**
  * An assistant chat shown or updated in the session.
  * @public
@@ -756,7 +918,7 @@ export interface CopilotTranscriptionEvent {
  * 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 StreamSessionEvents.
  * @public
  */
-export type CopilotSessionEvent = CopilotSessionEvent.AskMember | CopilotSessionEvent.AssetMember | CopilotSessionEvent.AssistantMember | CopilotSessionEvent.EvaluationMember | CopilotSessionEvent.IntentMember | CopilotSessionEvent.LifecycleMember | CopilotSessionEvent.RelationshipMember | CopilotSessionEvent.TranscriptMember | CopilotSessionEvent.$UnknownMember;
+export type CopilotSessionEvent = CopilotSessionEvent.ActionMember | CopilotSessionEvent.AskMember | CopilotSessionEvent.AssetMember | CopilotSessionEvent.AssistantMember | CopilotSessionEvent.EvaluationMember | CopilotSessionEvent.IntentMember | CopilotSessionEvent.LifecycleMember | CopilotSessionEvent.RelationshipMember | CopilotSessionEvent.TranscriptMember | CopilotSessionEvent.$UnknownMember;
 /**
  * @public
  */
@@ -774,6 +936,7 @@ export declare namespace CopilotSessionEvent {
         assistant?: never;
         relationship?: never;
         ask?: never;
+        action?: never;
         $unknown?: never;
     }
     /**
@@ -789,6 +952,7 @@ export declare namespace CopilotSessionEvent {
         assistant?: never;
         relationship?: never;
         ask?: never;
+        action?: never;
         $unknown?: never;
     }
     /**
@@ -804,6 +968,7 @@ export declare namespace CopilotSessionEvent {
         assistant?: never;
         relationship?: never;
         ask?: never;
+        action?: never;
         $unknown?: never;
     }
     /**
@@ -819,6 +984,7 @@ export declare namespace CopilotSessionEvent {
         assistant?: never;
         relationship?: never;
         ask?: never;
+        action?: never;
         $unknown?: never;
     }
     /**
@@ -834,6 +1000,7 @@ export declare namespace CopilotSessionEvent {
         assistant?: never;
         relationship?: never;
         ask?: never;
+        action?: never;
         $unknown?: never;
     }
     /**
@@ -849,6 +1016,7 @@ export declare namespace CopilotSessionEvent {
         assistant: CopilotAssistantEvent;
         relationship?: never;
         ask?: never;
+        action?: never;
         $unknown?: never;
     }
     /**
@@ -864,6 +1032,7 @@ export declare namespace CopilotSessionEvent {
         assistant?: never;
         relationship: CopilotRelationshipEvent;
         ask?: never;
+        action?: never;
         $unknown?: never;
     }
     /**
@@ -879,6 +1048,23 @@ export declare namespace CopilotSessionEvent {
         assistant?: never;
         relationship?: never;
         ask: CopilotAskEvent;
+        action?: never;
+        $unknown?: never;
+    }
+    /**
+     * A client action recorded in the session with its execution outcome. Emitted when the action is accepted (`launched`) and re-emitted when its execution settles (`completed` / `failed`).
+     * @public
+     */
+    interface ActionMember {
+        lifecycle?: never;
+        transcript?: never;
+        intent?: never;
+        evaluation?: never;
+        asset?: never;
+        assistant?: never;
+        relationship?: never;
+        ask?: never;
+        action: CopilotActionEvent;
         $unknown?: never;
     }
     /**
@@ -893,6 +1079,7 @@ export declare namespace CopilotSessionEvent {
         assistant?: never;
         relationship?: never;
         ask?: never;
+        action?: never;
         $unknown: [string, any];
     }
     /**
@@ -908,6 +1095,7 @@ export declare namespace CopilotSessionEvent {
         assistant: (value: CopilotAssistantEvent) => T;
         relationship: (value: CopilotRelationshipEvent) => T;
         ask: (value: CopilotAskEvent) => T;
+        action: (value: CopilotActionEvent) => T;
         _: (name: string, value: any) => T;
     }
 }
@@ -1125,3 +1313,25 @@ export interface StreamSessionEventsOutput {
     events: StreamingBlobTypes;
     contentType: string;
 }
+/**
+ * @public
+ */
+export interface TrackInput {
+    sessionId: string;
+    /**
+     * Company that owns the session. Required when calling with a service (s2s) token, which is not scoped to a single company.
+     * @public
+     */
+    company?: string | undefined;
+    views: CopilotAssetView[];
+}
+/**
+ * @public
+ */
+export interface TrackOutput {
+    /**
+     * True when the views were recorded.
+     * @public
+     */
+    accepted: boolean;
+}

package/dist-types/schemas/schemas_0.d.ts

@@ -19,10 +19,14 @@ export declare var ChatAnalyticsLiveTranscriptionEvent$: StaticStructureSchema;
 export declare var ConferenceAnalyticsLiveTranscriptionEvent$: StaticStructureSchema;
 export declare var ConferenceParticipant$: StaticStructureSchema;
 export declare var ConferenceTranscriptionChunk$: StaticStructureSchema;
+export declare var ActInput$: StaticStructureSchema;
+export declare var ActOutput$: StaticStructureSchema;
 export declare var AskInput$: StaticStructureSchema;
 export declare var AskOutput$: StaticStructureSchema;
+export declare var CopilotActionEvent$: StaticStructureSchema;
 export declare var CopilotAskEvent$: StaticStructureSchema;
 export declare var CopilotAssetEvent$: StaticStructureSchema;
+export declare var CopilotAssetView$: StaticStructureSchema;
 export declare var CopilotAssistantEvent$: StaticStructureSchema;
 export declare var CopilotContextConversation$: StaticStructureSchema;
 export declare var CopilotContextEntity$: StaticStructureSchema;
@@ -38,14 +42,18 @@ export declare var EnrichInput$: StaticStructureSchema;
 export declare var EnrichOutput$: StaticStructureSchema;
 export declare var GetSessionEventsInput$: StaticStructureSchema;
 export declare var GetSessionEventsOutput$: StaticStructureSchema;
+export declare var KnowledgeSearchClientAction$: StaticStructureSchema;
 export declare var ListSessionsInput$: StaticStructureSchema;
 export declare var ListSessionsOutput$: StaticStructureSchema;
 export declare var OpenInput$: StaticStructureSchema;
 export declare var OpenOutput$: StaticStructureSchema;
 export declare var ResolveInput$: StaticStructureSchema;
 export declare var ResolveOutput$: StaticStructureSchema;
+export declare var SmartActionClientAction$: StaticStructureSchema;
 export declare var StreamSessionEventsInput$: StaticStructureSchema;
 export declare var StreamSessionEventsOutput$: StaticStructureSchema;
+export declare var TrackInput$: StaticStructureSchema;
+export declare var TrackOutput$: StaticStructureSchema;
 export declare var ButtonActionHandler$: StaticStructureSchema;
 export declare var ButtonElement$: StaticStructureSchema;
 export declare var ButtonLinkHandler$: StaticStructureSchema;
@@ -58,11 +66,13 @@ export declare var MessageQuote$: StaticStructureSchema;
 export declare var MessageTemplateConfig$: StaticStructureSchema;
 export declare var Reaction$: StaticStructureSchema;
 export declare var User$: StaticStructureSchema;
+export declare var CopilotClientAction$: StaticUnionSchema;
 export declare var CopilotSessionEvent$: StaticUnionSchema;
 export declare var CopilotTranscriptionData$: StaticUnionSchema;
 export declare var ActionElement$: StaticUnionSchema;
 export declare var ButtonHandler$: StaticUnionSchema;
 export declare var Element$: StaticUnionSchema;
+export declare var Act$: StaticOperationSchema;
 export declare var Ask$: StaticOperationSchema;
 export declare var Enrich$: StaticOperationSchema;
 export declare var GetSessionEvents$: StaticOperationSchema;
@@ -70,3 +80,4 @@ export declare var ListSessions$: StaticOperationSchema;
 export declare var Open$: StaticOperationSchema;
 export declare var Resolve$: StaticOperationSchema;
 export declare var StreamSessionEvents$: StaticOperationSchema;
+export declare var Track$: StaticOperationSchema;

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@wildix/wilma-copilot-sessions-client",
     "description": "@wildix/wilma-copilot-sessions-client client",
-    "version": "1.0.7",
+    "version": "1.0.8",
     "scripts": {
         "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
         "build:cjs": "tsc -p tsconfig.cjs.json",