@wildix/wda-stream-client 1.1.59 → 1.1.61

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

@@ -582,6 +582,11 @@ export interface CallRecord {
     trunkDirection?: string | undefined;
     queueName?: string | undefined;
     queueId?: string | undefined;
+    /**
+     * Position of the call in the queue (1-based). Updated from consume events and emitted on live progress and record flows.
+     * @public
+     */
+    queuePosition?: number | undefined;
     tags?: (string)[] | undefined;
     flags?: (string)[] | undefined;
     callerMos?: string | undefined;
@@ -1590,6 +1595,7 @@ export declare const LiveEventType: {
     readonly CONFERENCE_TRANSCRIPTION: "conference_transcription";
     readonly SERVICE: "service";
     readonly SERVICE_AGENT: "service_agent";
+    readonly SERVICE_AGENT_STATUS: "service_agent_status";
     readonly SERVICE_CALL: "service_call";
     readonly SERVICE_CALL_COMPLETE: "service_call_complete";
     readonly SERVICE_COMPLETE: "service_complete";
@@ -1756,6 +1762,11 @@ export interface CallAnalyticsLiveProgressEventFlow {
     trunkDirection?: string | undefined;
     queueName?: string | undefined;
     queueId?: string | undefined;
+    /**
+     * Position of the call in the queue (1-based). Updated from consume events and emitted on live progress and record flows.
+     * @public
+     */
+    queuePosition?: number | undefined;
     tags?: (string)[] | undefined;
     flags?: (string)[] | undefined;
     callerMos?: string | undefined;
@@ -1915,6 +1926,11 @@ export interface CallAnalyticsRecordEventFlow {
     trunkDirection?: string | undefined;
     queueName?: string | undefined;
     queueId?: string | undefined;
+    /**
+     * Position of the call in the queue (1-based). Updated from consume events and emitted on live progress and record flows.
+     * @public
+     */
+    queuePosition?: number | undefined;
     tags?: (string)[] | undefined;
     flags?: (string)[] | undefined;
     callerMos?: string | undefined;
@@ -2285,6 +2301,11 @@ export interface CallSplitConsumeEventData {
     serviceNumber?: string | undefined;
     trunk?: CallFlowConsumeTrunk | undefined;
     queue?: CallFlowConsumeQueue | undefined;
+    /**
+     * Position of the call in the queue (1-based).
+     * @public
+     */
+    queuePosition?: number | undefined;
     tags?: (string)[] | undefined;
     flags?: (string)[] | undefined;
     sipCallId?: string | undefined;
@@ -2317,6 +2338,11 @@ export interface CallStartConsumeEventData {
     serviceNumber?: string | undefined;
     trunk?: CallFlowConsumeTrunk | undefined;
     queue?: CallFlowConsumeQueue | undefined;
+    /**
+     * Position of the call in the queue (1-based).
+     * @public
+     */
+    queuePosition?: number | undefined;
     tags?: (string)[] | undefined;
     flags?: (string)[] | undefined;
     sipCallId?: string | undefined;
@@ -2370,6 +2396,11 @@ export interface CallUpdateConsumeEventData {
     serviceNumber?: string | undefined;
     trunk?: CallFlowConsumeTrunk | undefined;
     queue?: CallFlowConsumeQueue | undefined;
+    /**
+     * Position of the call in the queue (1-based).
+     * @public
+     */
+    queuePosition?: number | undefined;
     tags?: (string)[] | undefined;
     flags?: (string)[] | undefined;
     sipCallId?: string | undefined;
@@ -3206,9 +3237,14 @@ export interface ServiceAgentConsumeEventData {
     penalty?: string | undefined;
     type?: ServiceAgentType | undefined;
     paused?: boolean | undefined;
+    status?: string | undefined;
+    reason?: string | undefined;
+    message?: string | undefined;
     lastQueueCallEnd?: number | undefined;
     userExtension?: string | undefined;
+    department?: string | undefined;
     name?: string | undefined;
+    aclGroup?: string | undefined;
 }
 /**
  * @public
@@ -3233,9 +3269,17 @@ export type ServiceConsumeEventType = typeof ServiceConsumeEventType[keyof typeo
  * @public
  */
 export interface ServiceAgentJoinConsumeEvent {
+    /**
+     * The unique identifier of the service.
+     * @public
+     */
     id: string;
-    time: number;
+    /**
+     * The PBX identifier of the service.
+     * @public
+     */
     pbx: string;
+    time: number;
     company: string;
     type: ServiceConsumeEventType;
     data: ServiceAgentConsumeEventData;
@@ -3244,9 +3288,17 @@ export interface ServiceAgentJoinConsumeEvent {
  * @public
  */
 export interface ServiceAgentLeaveConsumeEvent {
+    /**
+     * The unique identifier of the service.
+     * @public
+     */
     id: string;
-    time: number;
+    /**
+     * The PBX identifier of the service.
+     * @public
+     */
     pbx: string;
+    time: number;
     company: string;
     type: ServiceConsumeEventType;
     data: ServiceAgentConsumeEventData;
@@ -3255,9 +3307,17 @@ export interface ServiceAgentLeaveConsumeEvent {
  * @public
  */
 export interface ServiceAgentUpdateConsumeEvent {
+    /**
+     * The unique identifier of the service.
+     * @public
+     */
     id: string;
-    time: number;
+    /**
+     * The PBX identifier of the service.
+     * @public
+     */
     pbx: string;
+    time: number;
     company: string;
     type: ServiceConsumeEventType;
     data: ServiceAgentConsumeEventData;
@@ -3269,43 +3329,69 @@ export interface ServiceAgentUpdateConsumeEvent {
 export declare const ServiceCallAction: {
     readonly ANSWER: "ANSWER";
     readonly CANCEL: "CANCEL";
+    readonly END: "END";
+    readonly INIT: "INIT";
     readonly REJECT: "REJECT";
     readonly RING: "RING";
+    readonly WAIT: "WAIT";
 };
 /**
  * @public
  */
 export type ServiceCallAction = typeof ServiceCallAction[keyof typeof ServiceCallAction];
 /**
- * @public
- */
-export interface ServiceCustomer {
-    phone: string;
-    name?: string | undefined;
-}
-/**
- * Service call data shared by live events and record representation.
+ * Base service call structure.
  * @public
  */
 export interface ServiceCallConsumeEventData {
+    /**
+     * Action performed at this step (e.g., INIT, RING, CANCEL, ANSWER, END).
+     *   It's optional, can be absent in case some service call fields updated, while action is not changed.
+     * @public
+     */
+    action?: ServiceCallAction | undefined;
+    /**
+     * Optional human-readable reason (e.g., 'timeout', 'Normal call clearing').
+     * @public
+     */
+    reason?: string | undefined;
+    /**
+     * Agents related to this action (typically those ringing/answering/cancelling).
+     * @public
+     */
+    relatedAgents?: (string)[] | undefined;
+    /**
+     * Identifier of the call this record describes.
+     * @public
+     */
     callId: string;
+    /**
+     * Index of a call segment inside one call session. A call can have several flows after CALL.SPLIT (transfer, redirect, etc.)
+     * @public
+     */
+    flowId?: number | undefined;
     startTime?: number | undefined;
     direction?: CallDirection | undefined;
-    action?: ServiceCallAction | undefined;
-    customer?: ServiceCustomer | undefined;
-    relatedAgents?: (string)[] | undefined;
 }
 /**
  * @public
  */
 export interface ServiceCallEndConsumeEvent {
+    /**
+     * The unique identifier of the service.
+     * @public
+     */
     id: string;
-    time: number;
+    /**
+     * The PBX identifier of the service.
+     * @public
+     */
     pbx: string;
+    time: number;
     company: string;
     type: ServiceConsumeEventType;
     /**
-     * Service call data shared by live events and record representation.
+     * Base service call structure.
      * @public
      */
     data: ServiceCallConsumeEventData;
@@ -3314,13 +3400,21 @@ export interface ServiceCallEndConsumeEvent {
  * @public
  */
 export interface ServiceCallInitConsumeEvent {
+    /**
+     * The unique identifier of the service.
+     * @public
+     */
     id: string;
-    time: number;
+    /**
+     * The PBX identifier of the service.
+     * @public
+     */
     pbx: string;
+    time: number;
     company: string;
     type: ServiceConsumeEventType;
     /**
-     * Service call data shared by live events and record representation.
+     * Base service call structure.
      * @public
      */
     data: ServiceCallConsumeEventData;
@@ -3329,13 +3423,21 @@ export interface ServiceCallInitConsumeEvent {
  * @public
  */
 export interface ServiceCallUpdateConsumeEvent {
+    /**
+     * The unique identifier of the service.
+     * @public
+     */
     id: string;
-    time: number;
+    /**
+     * The PBX identifier of the service.
+     * @public
+     */
     pbx: string;
+    time: number;
     company: string;
     type: ServiceConsumeEventType;
     /**
-     * Service call data shared by live events and record representation.
+     * Base service call structure.
      * @public
      */
     data: ServiceCallConsumeEventData;
@@ -3344,9 +3446,17 @@ export interface ServiceCallUpdateConsumeEvent {
  * @public
  */
 export interface ServiceEndConsumeEvent {
+    /**
+     * The unique identifier of the service.
+     * @public
+     */
     id: string;
-    time: number;
+    /**
+     * The PBX identifier of the service.
+     * @public
+     */
     pbx: string;
+    time: number;
     company: string;
     type: ServiceConsumeEventType;
 }
@@ -3358,18 +3468,45 @@ export interface ServiceAgent {
     penalty?: string | undefined;
     type?: ServiceAgentType | undefined;
     paused?: boolean | undefined;
+    status?: string | undefined;
+    reason?: string | undefined;
+    message?: string | undefined;
     lastQueueCallEnd?: number | undefined;
     userExtension?: string | undefined;
+    department?: string | undefined;
     name?: string | undefined;
+    aclGroup?: string | undefined;
 }
 /**
  * @public
  */
 export interface ServiceConsumeEventData {
-    name?: string | undefined;
+    /**
+     * The display name of the service.
+     * @public
+     */
+    name: string;
+    /**
+     * Call distribution strategy inside the service (e.g., 'ringall', 'linear', 'rrmemory')
+     * @public
+     */
     strategy?: string | undefined;
     maxCalls?: string | undefined;
+    /**
+     * Defines the service priority among other services in terms of call distribution to an agent
+     * @public
+     */
     weight?: string | undefined;
+    /**
+     * PBX timeZone (e.g., 'Europe/Kyiv').
+     * @public
+     */
+    timeZone?: string | undefined;
+    /**
+     * ACL group identifier associated with the service.
+     * @public
+     */
+    aclGroup?: string | undefined;
     agents?: (ServiceAgent)[] | undefined;
     calls?: (string)[] | undefined;
 }
@@ -3377,9 +3514,17 @@ export interface ServiceConsumeEventData {
  * @public
  */
 export interface ServiceInitConsumeEvent {
+    /**
+     * The unique identifier of the service.
+     * @public
+     */
     id: string;
-    time: number;
+    /**
+     * The PBX identifier of the service.
+     * @public
+     */
     pbx: string;
+    time: number;
     company: string;
     type: ServiceConsumeEventType;
     data: ServiceConsumeEventData;
@@ -3388,9 +3533,17 @@ export interface ServiceInitConsumeEvent {
  * @public
  */
 export interface ServiceUpdateConsumeEvent {
+    /**
+     * The unique identifier of the service.
+     * @public
+     */
     id: string;
-    time: number;
+    /**
+     * The PBX identifier of the service.
+     * @public
+     */
     pbx: string;
+    time: number;
     company: string;
     type: ServiceConsumeEventType;
     data: ServiceConsumeEventData;
@@ -6113,15 +6266,76 @@ export declare const PresenceEventType: {
  * @public
  */
 export type PresenceEventType = typeof PresenceEventType[keyof typeof PresenceEventType];
+/**
+ * Record representation of a service agent status update.
+ * @public
+ */
+export interface ServiceAgentsStatusAnalyticsRecordEvent {
+    /**
+     * The unique identifier of the service.
+     * @public
+     */
+    id: string;
+    /**
+     * The PBX identifier of the service.
+     * @public
+     */
+    pbx: string;
+    time: number;
+    company: string;
+    /**
+     * The display name of the service.
+     * @public
+     */
+    name: string;
+    /**
+     * Call distribution strategy inside the service (e.g., 'ringall', 'linear', 'rrmemory')
+     * @public
+     */
+    strategy?: string | undefined;
+    maxCalls?: string | undefined;
+    /**
+     * Defines the service priority among other services in terms of call distribution to an agent
+     * @public
+     */
+    weight?: string | undefined;
+    /**
+     * PBX timeZone (e.g., 'Europe/Kyiv').
+     * @public
+     */
+    timeZone?: string | undefined;
+    /**
+     * ACL group identifier associated with the service.
+     * @public
+     */
+    aclGroup?: string | undefined;
+    /**
+     * Type discriminator; always 'service_agent_status' for this event.
+     * @public
+     */
+    type: LiveEventType;
+    /**
+     * List of agent objects for which status was recorded.
+     * @public
+     */
+    agents: (ServiceAgent)[];
+}
 /**
  * @public
  */
 export interface ServiceAnalyticsLiveCompleteEvent {
+    /**
+     * The unique identifier of the service.
+     * @public
+     */
     id: string;
+    /**
+     * The PBX identifier of the service.
+     * @public
+     */
     pbx: string;
     time: number;
     company: string;
-    licenses: (License)[];
     event: LiveEventType;
 }
 /**
@@ -6147,22 +6361,27 @@ export type ServiceAnalyticsEventTrigger = typeof ServiceAnalyticsEventTrigger[k
  * @public
  */
 export interface ServiceAnalyticsLiveProgressEvent {
+    /**
+     * The unique identifier of the service.
+     * @public
+     */
     id: string;
+    /**
+     * The PBX identifier of the service.
+     * @public
+     */
     pbx: string;
     time: number;
     company: string;
-    licenses: (License)[];
-    event: LiveEventType;
     /**
-     * An original event that triggers current one.
+     * The display name of the service.
      * @public
      */
-    eventTrigger: ServiceAnalyticsEventTrigger;
+    name: string;
     /**
-     * Service name.
+     * Call distribution strategy inside the service (e.g., 'ringall', 'linear', 'rrmemory')
      * @public
      */
-    name?: string | undefined;
     strategy?: string | undefined;
     maxCalls?: string | undefined;
     /**
@@ -6170,6 +6389,22 @@ export interface ServiceAnalyticsLiveProgressEvent {
      * @public
      */
     weight?: string | undefined;
+    /**
+     * PBX timeZone (e.g., 'Europe/Kyiv').
+     * @public
+     */
+    timeZone?: string | undefined;
+    /**
+     * ACL group identifier associated with the service.
+     * @public
+     */
+    aclGroup?: string | undefined;
+    event: LiveEventType;
+    /**
+     * An original event that triggers current one.
+     * @public
+     */
+    eventTrigger: ServiceAnalyticsEventTrigger;
     /**
      * List of agents assigned to the service
      * @public
@@ -6182,39 +6417,97 @@ export interface ServiceAnalyticsLiveProgressEvent {
     calls?: (string)[] | undefined;
 }
 /**
- * Service call data shared by live events and record representation.
+ * Base service call structure.
  * @public
  */
 export interface ServiceCallAnalyticsLiveCompleteEvent {
+    /**
+     * The unique identifier of the service.
+     * @public
+     */
     id: string;
+    /**
+     * The PBX identifier of the service.
+     * @public
+     */
     pbx: string;
     time: number;
     company: string;
-    licenses: (License)[];
+    /**
+     * Action performed at this step (e.g., INIT, RING, CANCEL, ANSWER, END).
+     *   It's optional, can be absent in case some service call fields updated, while action is not changed.
+     * @public
+     */
+    action?: ServiceCallAction | undefined;
+    /**
+     * Optional human-readable reason (e.g., 'timeout', 'Normal call clearing').
+     * @public
+     */
+    reason?: string | undefined;
+    /**
+     * Agents related to this action (typically those ringing/answering/cancelling).
+     * @public
+     */
+    relatedAgents?: (string)[] | undefined;
+    /**
+     * Identifier of the call this record describes.
+     * @public
+     */
     callId: string;
+    /**
+     * Index of a call segment inside one call session. A call can have several flows after CALL.SPLIT (transfer, redirect, etc.)
+     * @public
+     */
+    flowId?: number | undefined;
     startTime?: number | undefined;
     direction?: CallDirection | undefined;
-    action?: ServiceCallAction | undefined;
-    customer?: ServiceCustomer | undefined;
-    relatedAgents?: (string)[] | undefined;
     event: LiveEventType;
 }
 /**
- * Service call data shared by live events and record representation.
+ * Base service call structure.
  * @public
  */
 export interface ServiceCallAnalyticsLiveProgressEvent {
+    /**
+     * The unique identifier of the service.
+     * @public
+     */
     id: string;
+    /**
+     * The PBX identifier of the service.
+     * @public
+     */
     pbx: string;
     time: number;
     company: string;
-    licenses: (License)[];
+    /**
+     * Action performed at this step (e.g., INIT, RING, CANCEL, ANSWER, END).
+     *   It's optional, can be absent in case some service call fields updated, while action is not changed.
+     * @public
+     */
+    action?: ServiceCallAction | undefined;
+    /**
+     * Optional human-readable reason (e.g., 'timeout', 'Normal call clearing').
+     * @public
+     */
+    reason?: string | undefined;
+    /**
+     * Agents related to this action (typically those ringing/answering/cancelling).
+     * @public
+     */
+    relatedAgents?: (string)[] | undefined;
+    /**
+     * Identifier of the call this record describes.
+     * @public
+     */
     callId: string;
+    /**
+     * Index of a call segment inside one call session. A call can have several flows after CALL.SPLIT (transfer, redirect, etc.)
+     * @public
+     */
+    flowId?: number | undefined;
     startTime?: number | undefined;
     direction?: CallDirection | undefined;
-    action?: ServiceCallAction | undefined;
-    customer?: ServiceCustomer | undefined;
-    relatedAgents?: (string)[] | undefined;
     event: LiveEventType;
     /**
      * An original event that triggers current one.
@@ -6222,6 +6515,109 @@ export interface ServiceCallAnalyticsLiveProgressEvent {
      */
     eventTrigger: ServiceAnalyticsEventTrigger;
 }
+/**
+ * A single lifecycle entry inside ServiceCallAnalyticsRecordEvent.actions, capturing the original triggering event, the resulting action, and the agents involved at that moment.
+ * @public
+ */
+export interface ServiceCallRecord {
+    /**
+     * Action performed at this step (e.g., INIT, RING, CANCEL, ANSWER, END).
+     *   It's optional, can be absent in case some service call fields updated, while action is not changed.
+     * @public
+     */
+    action?: ServiceCallAction | undefined;
+    /**
+     * Optional human-readable reason (e.g., 'timeout', 'Normal call clearing').
+     * @public
+     */
+    reason?: string | undefined;
+    /**
+     * Agents related to this action (typically those ringing/answering/cancelling).
+     * @public
+     */
+    relatedAgents?: (string)[] | undefined;
+    /**
+     * Time when the action was emitted (epoch ms).
+     * @public
+     */
+    time: number;
+    /**
+     * Original event that triggered this action.
+     * @public
+     */
+    eventTrigger: ServiceAnalyticsEventTrigger;
+}
+/**
+ * Finalized record representation of a service call lifecycle, containing the full ordered sequence of lifecycle actions from queue entry to end.
+ * @public
+ */
+export interface ServiceCallAnalyticsRecordEvent {
+    /**
+     * The unique identifier of the service.
+     * @public
+     */
+    id: string;
+    /**
+     * The PBX identifier of the service.
+     * @public
+     */
+    pbx: string;
+    time: number;
+    company: string;
+    /**
+     * The display name of the service.
+     * @public
+     */
+    name: string;
+    /**
+     * Call distribution strategy inside the service (e.g., 'ringall', 'linear', 'rrmemory')
+     * @public
+     */
+    strategy?: string | undefined;
+    maxCalls?: string | undefined;
+    /**
+     * Defines the service priority among other services in terms of call distribution to an agent
+     * @public
+     */
+    weight?: string | undefined;
+    /**
+     * PBX timeZone (e.g., 'Europe/Kyiv').
+     * @public
+     */
+    timeZone?: string | undefined;
+    /**
+     * ACL group identifier associated with the service.
+     * @public
+     */
+    aclGroup?: string | undefined;
+    /**
+     * Identifier of the call this record describes.
+     * @public
+     */
+    callId: string;
+    /**
+     * Index of a call segment inside one call session. A call can have several flows after CALL.SPLIT (transfer, redirect, etc.)
+     * @public
+     */
+    flowId?: number | undefined;
+    startTime?: number | undefined;
+    direction?: CallDirection | undefined;
+    /**
+     * Type discriminator; always 'service_call' for this event.
+     * @public
+     */
+    type: LiveEventType;
+    /**
+     * Agents assigned to the service at record finalization time.
+     * @public
+     */
+    agents?: (ServiceAgent)[] | undefined;
+    /**
+     * Ordered list of lifecycle actions for the service call.
+     * @public
+     */
+    actions: (ServiceCallRecord)[];
+}
 /**
  * @public
  * @enum
@@ -6229,6 +6625,7 @@ export interface ServiceCallAnalyticsLiveProgressEvent {
 export declare const ServiceCallEventType: {
     readonly LIVE_COMPLETE_EVENT: "ServiceCallAnalyticsLiveCompleteEvent";
     readonly LIVE_PROGRESS_EVENT: "ServiceCallAnalyticsLiveProgressEvent";
+    readonly RECORD_EVENT: "ServiceCallAnalyticsRecordEvent";
 };
 /**
  * @public
@@ -6239,6 +6636,7 @@ export type ServiceCallEventType = typeof ServiceCallEventType[keyof typeof Serv
  * @enum
  */
 export declare const ServiceEventType: {
+    readonly AGENTS_STATUS_RECORD_EVENT: "ServiceAgentsStatusAnalyticsRecordEvent";
     readonly LIVE_COMPLETE_EVENT: "ServiceAnalyticsLiveCompleteEvent";
     readonly LIVE_PROGRESS_EVENT: "ServiceAnalyticsLiveProgressEvent";
 };
@@ -6659,27 +7057,3 @@ export interface WebhookConferenceLiveCompletedEvent {
     integrationId: string;
     data: ConferenceAnalyticsLiveCompleteEvent;
 }
-/**
- * @public
- */
-export interface WebhookConferenceLiveInterruptedEvent {
-    id: string;
-    pbx?: string | undefined;
-    company?: string | undefined;
-    type: WebhookEventType;
-    time: number;
-    integrationId: string;
-    data: ConferenceAnalyticsLiveInterruptedEvent;
-}
-/**
- * @public
- */
-export interface WebhookConferenceLiveJoinEvent {
-    id: string;
-    pbx?: string | undefined;
-    company?: string | undefined;
-    type: WebhookEventType;
-    time: number;
-    integrationId: string;
-    data: ConferenceAnalyticsLiveJoinEvent;
-}