@wildix/wilma-copilot-sessions-client 1.0.4 → 1.0.6

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, CopilotSessionStatus, License, LiveEventType, MessageSmsStatus, MessageType, MessageWhatsAppStatus, PbxLicenseType, TranscriptionSentiment } from "./enums";
+import type { AssetIcon, AssetSeverity, ButtonVariant, CallDevice, CallParticipantRole, CallParticipantType, CallTranscriptionSpeaker, ConferenceParticipantRole, ConferenceParticipantType, CopilotConversationKind, CopilotIngestedSessionState, CopilotLifecycleReason, CopilotSessionStatus, License, LiveEventType, MessageSmsStatus, MessageType, MessageWhatsAppStatus, PbxLicenseType, TranscriptionSentiment } from "./enums";
 /**
  * @public
  */
@@ -423,6 +423,72 @@ export interface ConferenceAnalyticsLiveTranscriptionEvent {
     chunk: ConferenceTranscriptionChunk;
     participant?: ConferenceParticipant | undefined;
 }
+/**
+ * @public
+ */
+export interface AskInput {
+    /**
+     * The copilot session to record the ask in.
+     * @public
+     */
+    sessionId: string;
+    /**
+     * Company that owns the session. Required when calling with a service (s2s) token.
+     * @public
+     */
+    company?: string | undefined;
+    /**
+     * The Wilma session (wilma-sessions) holding the ask and its output.
+     * @public
+     */
+    wilmaSessionId: string;
+    /**
+     * Read-only, expiring token scoped to `wilmaSessionId`, issued by wilma-sessions. Published on the `ask` event so other agents can view the output.
+     * @public
+     */
+    accessToken?: string | undefined;
+}
+/**
+ * @public
+ */
+export interface AskOutput {
+    /**
+     * Index of the recorded `ask` event in the session log.
+     * @public
+     */
+    index: number;
+}
+/**
+ * An ask recorded in the session. The ask itself runs as a regular Wilma session (wilma-sessions); any agent in the company can render its output by presenting `accessToken` to wilma-sessions — copilot sessions are shared within the tenant.
+ * @public
+ */
+export interface CopilotAskEvent {
+    /**
+     * 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;
+    /**
+     * The user who asked.
+     * @public
+     */
+    userId: string;
+    /**
+     * The Wilma session (wilma-sessions) holding the ask and its output.
+     * @public
+     */
+    wilmaSessionId: string;
+    /**
+     * Read-only, session-scoped, expiring token other agents present to wilma-sessions to view the ask output.
+     * @public
+     */
+    accessToken?: string | 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
@@ -471,6 +537,56 @@ export interface CopilotAssistantEvent {
     id: string;
     state: __DocumentType;
 }
+/**
+ * The conversation a copilot session is bound to. Server-reported (in session summaries) — clients never construct these ids.
+ * @public
+ */
+export interface CopilotContextConversation {
+    /**
+     * Channel id (chats and conferences), WDA call id (calls), or a server-minted id (`app` sessions).
+     * @public
+     */
+    id: string;
+    /**
+     * The kind of conversation a context event or session refers to.
+     * @public
+     */
+    kind: CopilotConversationKind;
+}
+/**
+ * A typed reference to a record in an external system. `type` is dot-namespaced by system, e.g. `salesforce.contact`, `salesforce.account`, `hubspot.contact`, `phonebook.contact`.
+ * @public
+ */
+export interface CopilotContextEntity {
+    id: string;
+    type: string;
+}
+/**
+ * The result of a client-side contact lookup: the identities and enrichment in scope for the customer. Reused by Open (optional — an already-bound channel or an anonymous call needs none) and Enrich (late-arriving evidence, e.g. a CRM match resolved after open).
+ * @public
+ */
+export interface CopilotContextLookup {
+    /**
+     * Customer email addresses. Identity, first-class: merged into the relationship.
+     * @public
+     */
+    emails?: string[] | undefined;
+    /**
+     * Customer phone numbers. Identity, first-class: merged into the relationship.
+     * @public
+     */
+    phones?: string[] | undefined;
+    /**
+     * Typed references to records in external systems, e.g. a Salesforce contact. Identity, first-class: merged into the relationship.
+     * @public
+     */
+    entities?: CopilotContextEntity[] | undefined;
+    /**
+     * Everything else, as an open string-to-string map keyed by dot-namespaced source, e.g. `phonebook.name`, `salesforce.deal_stage`, `match.confidence`.
+     * @public
+     */
+    attributes?: Record<string, string> | undefined;
+}
 /**
  * An evaluation result detected or updated in the session. Carries the full evaluation state at this point; re-emitted on updates.
  * @public
@@ -489,6 +605,18 @@ export interface CopilotEvaluationEvent {
     id: string;
     state: __DocumentType;
 }
+/**
+ * The session an ingested context event was routed to.
+ * @public
+ */
+export interface CopilotIngestedSession {
+    id: string;
+    /**
+     * How an ingested event was attached to a session.
+     * @public
+     */
+    state: CopilotIngestedSessionState;
+}
 /**
  * An intent detected or updated in the session. Carries the full intent state at this point; re-emitted on updates.
  * @public
@@ -508,7 +636,7 @@ export interface CopilotIntentEvent {
     state: __DocumentType;
 }
 /**
- * Session lifecycle transition. Emitted on attach and on every terminal transition.
+ * Session lifecycle transition. Emitted on attach and on every status transition; `reason` says why the session moved.
  * @public
  */
 export interface CopilotLifecycleEvent {
@@ -524,6 +652,37 @@ export interface CopilotLifecycleEvent {
     timestamp: string;
     sessionId: string;
     status: CopilotSessionStatus;
+    /**
+     * Why a lifecycle transition happened.
+     * @public
+     */
+    reason?: CopilotLifecycleReason | undefined;
+}
+/**
+ * A relationship update visible to an active session — e.g. another session was created or revived on the same relationship.
+ * @public
+ */
+export interface CopilotRelationshipEvent {
+    /**
+     * 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 a relationship: the durable, cross-channel view of one customer that copilot sessions attach to. Identities (emails, phones, entities) merge into it as context is ingested.
+     * @public
+     */
+    relationshipId: string;
+    /**
+     * The other session attached to the same relationship, when the update is about one.
+     * @public
+     */
+    sessionId?: string | undefined;
 }
 /**
  * Original WDA live transcription event for the assisted conversation surface.
@@ -594,16 +753,16 @@ export interface CopilotTranscriptionEvent {
     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.
+ * 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.AssetMember | CopilotSessionEvent.AssistantMember | CopilotSessionEvent.EvaluationMember | CopilotSessionEvent.IntentMember | CopilotSessionEvent.LifecycleMember | CopilotSessionEvent.TranscriptMember | CopilotSessionEvent.$UnknownMember;
+export type CopilotSessionEvent = CopilotSessionEvent.AskMember | CopilotSessionEvent.AssetMember | CopilotSessionEvent.AssistantMember | CopilotSessionEvent.EvaluationMember | CopilotSessionEvent.IntentMember | CopilotSessionEvent.LifecycleMember | CopilotSessionEvent.RelationshipMember | CopilotSessionEvent.TranscriptMember | CopilotSessionEvent.$UnknownMember;
 /**
  * @public
  */
 export declare namespace CopilotSessionEvent {
     /**
-     * Session lifecycle transition. Emitted on attach and on every terminal transition.
+     * Session lifecycle transition. Emitted on attach and on every status transition; `reason` says why the session moved.
      * @public
      */
     interface LifecycleMember {
@@ -613,6 +772,8 @@ export declare namespace CopilotSessionEvent {
         evaluation?: never;
         asset?: never;
         assistant?: never;
+        relationship?: never;
+        ask?: never;
         $unknown?: never;
     }
     /**
@@ -626,6 +787,8 @@ export declare namespace CopilotSessionEvent {
         evaluation?: never;
         asset?: never;
         assistant?: never;
+        relationship?: never;
+        ask?: never;
         $unknown?: never;
     }
     /**
@@ -639,6 +802,8 @@ export declare namespace CopilotSessionEvent {
         evaluation?: never;
         asset?: never;
         assistant?: never;
+        relationship?: never;
+        ask?: never;
         $unknown?: never;
     }
     /**
@@ -652,6 +817,8 @@ export declare namespace CopilotSessionEvent {
         evaluation: CopilotEvaluationEvent;
         asset?: never;
         assistant?: never;
+        relationship?: never;
+        ask?: never;
         $unknown?: never;
     }
     /**
@@ -665,6 +832,8 @@ export declare namespace CopilotSessionEvent {
         evaluation?: never;
         asset: CopilotAssetEvent;
         assistant?: never;
+        relationship?: never;
+        ask?: never;
         $unknown?: never;
     }
     /**
@@ -678,6 +847,38 @@ export declare namespace CopilotSessionEvent {
         evaluation?: never;
         asset?: never;
         assistant: CopilotAssistantEvent;
+        relationship?: never;
+        ask?: never;
+        $unknown?: never;
+    }
+    /**
+     * A relationship update visible to an active session — e.g. another session was created or revived on the same relationship.
+     * @public
+     */
+    interface RelationshipMember {
+        lifecycle?: never;
+        transcript?: never;
+        intent?: never;
+        evaluation?: never;
+        asset?: never;
+        assistant?: never;
+        relationship: CopilotRelationshipEvent;
+        ask?: never;
+        $unknown?: never;
+    }
+    /**
+     * An ask recorded in the session. The ask itself runs as a regular Wilma session (wilma-sessions); any agent in the company can render its output by presenting `accessToken` to wilma-sessions — copilot sessions are shared within the tenant.
+     * @public
+     */
+    interface AskMember {
+        lifecycle?: never;
+        transcript?: never;
+        intent?: never;
+        evaluation?: never;
+        asset?: never;
+        assistant?: never;
+        relationship?: never;
+        ask: CopilotAskEvent;
         $unknown?: never;
     }
     /**
@@ -690,6 +891,8 @@ export declare namespace CopilotSessionEvent {
         evaluation?: never;
         asset?: never;
         assistant?: never;
+        relationship?: never;
+        ask?: never;
         $unknown: [string, any];
     }
     /**
@@ -703,13 +906,73 @@ export declare namespace CopilotSessionEvent {
         evaluation: (value: CopilotEvaluationEvent) => T;
         asset: (value: CopilotAssetEvent) => T;
         assistant: (value: CopilotAssistantEvent) => T;
+        relationship: (value: CopilotRelationshipEvent) => T;
+        ask: (value: CopilotAskEvent) => T;
         _: (name: string, value: any) => T;
     }
 }
+/**
+ * A compact view of a copilot session associated with a relationship. Sessions are owned by the company and shared within the tenant.
+ * @public
+ */
+export interface CopilotSessionSummary {
+    id: string;
+    status: CopilotSessionStatus;
+    /**
+     * The conversation the session is bound to (`app` for sessions opened without a call, chat or conference). Clients use this to open the underlying surface — session ids are opaque and must not be parsed for it.
+     * @public
+     */
+    conversation: CopilotContextConversation;
+    /**
+     * ISO-8601 timestamp with millisecond precision, e.g. '2026-07-10T14:12:30.123Z'.
+     * @public
+     */
+    startedAt?: string | undefined;
+    /**
+     * Time of the last event applied to the session; drives the idle and archive transitions.
+     * @public
+     */
+    lastActivityAt?: string | undefined;
+}
+/**
+ * @public
+ */
+export interface EnrichInput {
+    /**
+     * Company that owns the relationship. Required when calling with a service (s2s) token.
+     * @public
+     */
+    company?: string | undefined;
+    /**
+     * Id of a relationship: the durable, cross-channel view of one customer that copilot sessions attach to. Identities (emails, phones, entities) merge into it as context is ingested.
+     * @public
+     */
+    relationshipId: string;
+    /**
+     * The result of a client-side contact lookup: the identities and enrichment in scope for the customer. Reused by Open (optional — an already-bound channel or an anonymous call needs none) and Enrich (late-arriving evidence, e.g. a CRM match resolved after open).
+     * @public
+     */
+    lookup: CopilotContextLookup;
+}
+/**
+ * @public
+ */
+export interface EnrichOutput {
+    /**
+     * The authoritative relationship after applying the evidence. May differ from the input when strong evidence re-resolves the customer.
+     * @public
+     */
+    relationshipId: string;
+    /**
+     * Sessions associated with the authoritative relationship, most recent first.
+     * @public
+     */
+    related: CopilotSessionSummary[];
+}
 /**
  * @public
  */
-export interface GetCopilotSessionEventsInput {
+export interface GetSessionEventsInput {
     sessionId: string;
     /**
      * Company that owns the session. Required when calling with a service (s2s) token, which is not scoped to a single company.
@@ -730,7 +993,7 @@ export interface GetCopilotSessionEventsInput {
 /**
  * @public
  */
-export interface GetCopilotSessionEventsOutput {
+export interface GetSessionEventsOutput {
     events: CopilotSessionEvent[];
     /**
      * Present when more events exist; pass it as `startIndex` of the next call.
@@ -741,7 +1004,104 @@ export interface GetCopilotSessionEventsOutput {
 /**
  * @public
  */
-export interface StreamCopilotSessionEventsInput {
+export interface ListSessionsInput {
+    /**
+     * Company scope. Required when calling with a service (s2s) token.
+     * @public
+     */
+    company?: string | undefined;
+    /**
+     * The user whose participated sessions to list. Defaults to the caller; required when calling with a service (s2s) token.
+     * @public
+     */
+    user?: string | undefined;
+    limit?: number | undefined;
+    /**
+     * Opaque cursor returned by a previous page; pass it back to fetch the next page.
+     * @public
+     */
+    cursor?: string | undefined;
+}
+/**
+ * @public
+ */
+export interface ListSessionsOutput {
+    sessions: CopilotSessionSummary[];
+    /**
+     * Present when more sessions exist; pass it as `cursor` of the next call.
+     * @public
+     */
+    nextCursor?: string | undefined;
+}
+/**
+ * @public
+ */
+export interface OpenInput {
+    /**
+     * Company that owns the relationship. Required when calling with a service (s2s) token, which is not scoped to a single company.
+     * @public
+     */
+    company?: string | undefined;
+    /**
+     * The client-side contact lookup result. Omit when there is nothing resolved yet, e.g. an anonymous call.
+     * @public
+     */
+    lookup?: CopilotContextLookup | undefined;
+}
+/**
+ * @public
+ */
+export interface OpenOutput {
+    /**
+     * Id of a relationship: the durable, cross-channel view of one customer that copilot sessions attach to. Identities (emails, phones, entities) merge into it as context is ingested.
+     * @public
+     */
+    relationshipId: string;
+    /**
+     * The session the open was routed to.
+     * @public
+     */
+    session: CopilotIngestedSession;
+    /**
+     * Sessions already associated with the relationship, most recent first. Excludes the session the open was routed to.
+     * @public
+     */
+    related: CopilotSessionSummary[];
+}
+/**
+ * @public
+ */
+export interface ResolveInput {
+    /**
+     * Company scope. Required when calling with a service (s2s) token.
+     * @public
+     */
+    company?: string | undefined;
+    /**
+     * The result of a client-side contact lookup: the identities and enrichment in scope for the customer. Reused by Open (optional — an already-bound channel or an anonymous call needs none) and Enrich (late-arriving evidence, e.g. a CRM match resolved after open).
+     * @public
+     */
+    lookup: CopilotContextLookup;
+}
+/**
+ * @public
+ */
+export interface ResolveOutput {
+    /**
+     * The relationship the lookup resolved to, when one matched. Lookup never creates relationships.
+     * @public
+     */
+    relationshipId?: string | undefined;
+    /**
+     * Sessions associated with the matched relationship, most recent first. Empty when nothing matched.
+     * @public
+     */
+    sessions: CopilotSessionSummary[];
+}
+/**
+ * @public
+ */
+export interface StreamSessionEventsInput {
     sessionId: string;
     /**
      * Company that owns the session. Required when calling with a service (s2s) token, which is not scoped to a single company.
@@ -757,7 +1117,7 @@ export interface StreamCopilotSessionEventsInput {
 /**
  * @public
  */
-export interface StreamCopilotSessionEventsOutput {
+export interface StreamSessionEventsOutput {
     /**
      * 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

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

@@ -19,16 +19,33 @@ export declare var ChatAnalyticsLiveTranscriptionEvent$: StaticStructureSchema;
 export declare var ConferenceAnalyticsLiveTranscriptionEvent$: StaticStructureSchema;
 export declare var ConferenceParticipant$: StaticStructureSchema;
 export declare var ConferenceTranscriptionChunk$: StaticStructureSchema;
+export declare var AskInput$: StaticStructureSchema;
+export declare var AskOutput$: StaticStructureSchema;
+export declare var CopilotAskEvent$: StaticStructureSchema;
 export declare var CopilotAssetEvent$: StaticStructureSchema;
 export declare var CopilotAssistantEvent$: StaticStructureSchema;
+export declare var CopilotContextConversation$: StaticStructureSchema;
+export declare var CopilotContextEntity$: StaticStructureSchema;
+export declare var CopilotContextLookup$: StaticStructureSchema;
 export declare var CopilotEvaluationEvent$: StaticStructureSchema;
+export declare var CopilotIngestedSession$: StaticStructureSchema;
 export declare var CopilotIntentEvent$: StaticStructureSchema;
 export declare var CopilotLifecycleEvent$: StaticStructureSchema;
+export declare var CopilotRelationshipEvent$: StaticStructureSchema;
+export declare var CopilotSessionSummary$: StaticStructureSchema;
 export declare var CopilotTranscriptionEvent$: StaticStructureSchema;
-export declare var GetCopilotSessionEventsInput$: StaticStructureSchema;
-export declare var GetCopilotSessionEventsOutput$: StaticStructureSchema;
-export declare var StreamCopilotSessionEventsInput$: StaticStructureSchema;
-export declare var StreamCopilotSessionEventsOutput$: StaticStructureSchema;
+export declare var EnrichInput$: StaticStructureSchema;
+export declare var EnrichOutput$: StaticStructureSchema;
+export declare var GetSessionEventsInput$: StaticStructureSchema;
+export declare var GetSessionEventsOutput$: 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 StreamSessionEventsInput$: StaticStructureSchema;
+export declare var StreamSessionEventsOutput$: StaticStructureSchema;
 export declare var ButtonActionHandler$: StaticStructureSchema;
 export declare var ButtonElement$: StaticStructureSchema;
 export declare var ButtonLinkHandler$: StaticStructureSchema;
@@ -46,5 +63,10 @@ export declare var CopilotTranscriptionData$: StaticUnionSchema;
 export declare var ActionElement$: StaticUnionSchema;
 export declare var ButtonHandler$: StaticUnionSchema;
 export declare var Element$: StaticUnionSchema;
-export declare var GetCopilotSessionEvents$: StaticOperationSchema;
-export declare var StreamCopilotSessionEvents$: StaticOperationSchema;
+export declare var Ask$: StaticOperationSchema;
+export declare var Enrich$: StaticOperationSchema;
+export declare var GetSessionEvents$: StaticOperationSchema;
+export declare var ListSessions$: StaticOperationSchema;
+export declare var Open$: StaticOperationSchema;
+export declare var Resolve$: StaticOperationSchema;
+export declare var StreamSessionEvents$: StaticOperationSchema;

package/package.json

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