o2g-node-sdk 2.4.0 → 2.4.1

package/dist/types/types/cc-rt/rti-context.d.ts

@@ -0,0 +1,56 @@
+import { RtiFilter } from './rti-filter';
+/**
+ * The `RtiContext` class represents a subscription to CCD real-time events
+ * provided by the `RtiService`.
+ *
+ * A context defines the set of CCD objects to monitor, the attributes of
+ * interest, the observation period, and the notification frequency for events.
+ * It is associated with a {@link RtiFilter} that specifies which agents, pilots,
+ * queues, and processing groups are included in the real-time notifications.
+ */
+export declare class RtiContext {
+    #private;
+    /**
+     * Constructs a new `RtiContext` with the specified observation period,
+     * notification frequency, and filter.
+     *
+     * @param obsPeriod - The observation period in minutes. Must be between 15 and 60 minutes.
+     * @param notifFrequency - The frequency of real-time notifications in seconds. Minimum value is 5 seconds.
+     * @param filter - The {@link RtiFilter} defining which CCD objects and attributes are included in this context.
+     */
+    constructor(obsPeriod?: number, notifFrequency?: number, filter?: RtiFilter);
+    /**
+     * Returns whether this RTI context is currently active.
+     *
+     * @returns `true` if the context is active; `false` otherwise.
+     */
+    get active(): boolean;
+    /**
+     * Returns the observation period for this context.
+     *
+     * This defines the duration (in minutes) during which the context is active
+     * and collects real-time events.
+     *
+     * @returns The observation period in minutes.
+     */
+    get observationPeriod(): number;
+    /**
+     * Returns the notification frequency for this context.
+     *
+     * This defines how often (in seconds) real-time notifications are sent
+     * for changes in the monitored CCD objects.
+     *
+     * @returns The notification frequency in seconds.
+     */
+    get notificationFrequency(): number;
+    /**
+     * Returns the {@link RtiFilter} associated with this context.
+     *
+     * The filter specifies which CCD objects and their attributes will be included
+     * in real-time event notifications.
+     *
+     * @returns The filter.
+     */
+    get filter(): RtiFilter | null;
+}
+//# sourceMappingURL=rti-context.d.ts.map

package/dist/types/types/cc-rt/rti-context.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"rti-context.d.ts","sourceRoot":"","sources":["../../../../src/types/cc-rt/rti-context.ts"],"names":[],"mappings":"AAoBA,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AAEzC;;;;;;;;GAQG;AACH,qBAAa,UAAU;;IAMnB;;;;;;;OAOG;gBACS,SAAS,CAAC,EAAE,MAAM,EAAE,cAAc,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,SAAS;IAS3E;;;;OAIG;IACH,IAAI,MAAM,IAAI,OAAO,CAEpB;IAED;;;;;;;OAOG;IACH,IAAI,iBAAiB,IAAI,MAAM,CAE9B;IAED;;;;;;;OAOG;IACH,IAAI,qBAAqB,IAAI,MAAM,CAElC;IAED;;;;;;;OAOG;IACH,IAAI,MAAM,IAAI,SAAS,GAAG,IAAI,CAE7B;CAuCJ"}

package/dist/types/types/cc-rt/rti-filter.d.ts

@@ -0,0 +1,117 @@
+import { RtiAgentAttributes } from './agent-attributes';
+import { RtiAgentProcessingGroupAttributes } from './agent-pg-attributes';
+import { RtiOtherProcessingGroupAttributes } from './other-pg-attributes';
+import { RtiPilotAttributes } from './pilot-attributes';
+import { RtiQueueAttributes } from './queue-attributes';
+/**
+ * The `Filter` class specifies which CCD objects and their attributes
+ * should be included in real-time eventing.
+ *
+ * For each category of CCD objects (agents, pilots, queues, agent processing groups,
+ * other processing groups), this class maintains a filter that defines:
+ *
+ * - The specific objects to monitor (directory numbers)
+ * - The attributes of each object to include in the real-time notifications
+ *
+ * Typical usage:
+ * ```ts
+ * const filter = new RtiFilter();
+ *
+ * // Monitor specific agents with selected attributes
+ * filter.setAgentNumbers(["60119", "60120"]);
+ * filter.setAgentAttributes(RtiAgentAttributes.PrivateCallsTotalDuration, RtiAgentAttributes.LogonDate);
+ *
+ * // Monitor queues with selected attributes
+ * filter.setQueueNumbers(["1001", "1002"]);
+ * filter.setQueueAttributes(RtiQueueAttributes.WaitingCalls, RtiQueueAttributes.AverageWaitTime);
+ *
+ * // Use the filter to create a real-time context
+ * const context = new RtiContext(30, 5, filter);
+ * const rtiService = session.getCallCenterRealtimeService();
+ * rtiService.setContext(context);
+ * rtiService.start();
+ * ```
+ *
+ * @see CallCenterRealtimeService
+ * @see RtiObjects
+ * @since 2.7.4
+ */
+export declare class RtiFilter {
+    #private;
+    /**
+     * Sets the attributes of agents to include in real-time eventing.
+     * Only the specified attributes of the selected agents will be included
+     * in the real-time notifications.
+     *
+     * @param attributes The agent attributes to monitor
+     */
+    setAgentAttributes(...attributes: RtiAgentAttributes[]): void;
+    /**
+     * Sets the directory numbers of agents to include in real-time eventing.
+     * Only events related to these agents will be sent.
+     *
+     * @param numbers The agent directory numbers to monitor
+     */
+    setAgentNumbers(numbers: string[]): void;
+    /**
+     * Sets the attributes of pilots to include in real-time eventing.
+     * Only the specified attributes of the selected pilots will be included
+     * in the real-time notifications.
+     *
+     * @param attributes The pilot attributes to monitor
+     */
+    setPilotAttributes(...attributes: RtiPilotAttributes[]): void;
+    /**
+     * Sets the directory numbers of pilots to include in real-time eventing.
+     * Only events related to these pilots will be sent.
+     *
+     * @param numbers The pilot directory numbers to monitor
+     */
+    setPilotNumbers(numbers: string[]): void;
+    /**
+     * Sets the attributes of queues to include in real-time eventing.
+     * Only the specified attributes of the selected queues will be included
+     * in the real-time notifications.
+     *
+     * @param attributes The queue attributes to monitor
+     */
+    setQueueAttributes(...attributes: RtiQueueAttributes[]): void;
+    /**
+     * Sets the directory numbers of queues to include in real-time eventing.
+     * Only events related to these queues will be sent.
+     *
+     * @param numbers The queue directory numbers to monitor
+     */
+    setQueueNumbers(numbers: string[]): void;
+    /**
+     * Sets the attributes of agent processing groups to include in real-time eventing.
+     * Only the specified attributes of the selected processing groups will be included
+     * in the real-time notifications.
+     *
+     * @param attributes The agent processing group attributes to monitor
+     */
+    setAgentProcessingGroupAttributes(...attributes: RtiAgentProcessingGroupAttributes[]): void;
+    /**
+     * Sets the directory numbers of agent processing groups to include in real-time eventing.
+     * Only events related to these processing groups will be sent.
+     *
+     * @param numbers The agent processing group directory numbers to monitor
+     */
+    setAgentProcessingGroupNumbers(numbers: string[]): void;
+    /**
+     * Sets the attributes of other processing groups to include in real-time eventing.
+     * Only the specified attributes of the selected processing groups will be included
+     * in the real-time notifications.
+     *
+     * @param attributes The other processing group attributes to monitor
+     */
+    setOtherProcessingGroupAttributes(...attributes: RtiOtherProcessingGroupAttributes[]): void;
+    /**
+     * Sets the directory numbers of other processing groups to include in real-time eventing.
+     * Only events related to these processing groups will be sent.
+     *
+     * @param numbers The other processing group directory numbers to monitor
+     */
+    setOtherProcessingGroupNumbers(numbers: string[]): void;
+}
+//# sourceMappingURL=rti-filter.d.ts.map

package/dist/types/types/cc-rt/rti-filter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"rti-filter.d.ts","sourceRoot":"","sources":["../../../../src/types/cc-rt/rti-filter.ts"],"names":[],"mappings":"AAoBA,OAAO,EAAE,kBAAkB,EAAE,MAAM,oBAAoB,CAAC;AACxD,OAAO,EAAE,iCAAiC,EAAE,MAAM,uBAAuB,CAAC;AAC1E,OAAO,EAAE,iCAAiC,EAAE,MAAM,uBAAuB,CAAC;AAC1E,OAAO,EAAE,kBAAkB,EAAE,MAAM,oBAAoB,CAAC;AACxD,OAAO,EAAE,kBAAkB,EAAE,MAAM,oBAAoB,CAAC;AAyCxD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;AACH,qBAAa,SAAS;;IA2DlB;;;;;;OAMG;IACH,kBAAkB,CAAC,GAAG,UAAU,EAAE,kBAAkB,EAAE,GAAG,IAAI;IAI7D;;;;;OAKG;IACH,eAAe,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,IAAI;IAMxC;;;;;;OAMG;IACH,kBAAkB,CAAC,GAAG,UAAU,EAAE,kBAAkB,EAAE,GAAG,IAAI;IAI7D;;;;;OAKG;IACH,eAAe,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,IAAI;IAMxC;;;;;;OAMG;IACH,kBAAkB,CAAC,GAAG,UAAU,EAAE,kBAAkB,EAAE,GAAG,IAAI;IAI7D;;;;;OAKG;IACH,eAAe,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,IAAI;IAMxC;;;;;;OAMG;IACH,iCAAiC,CAAC,GAAG,UAAU,EAAE,iCAAiC,EAAE,GAAG,IAAI;IAI3F;;;;;OAKG;IACH,8BAA8B,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,IAAI;IAMvD;;;;;;OAMG;IACH,iCAAiC,CAAC,GAAG,UAAU,EAAE,iCAAiC,EAAE,GAAG,IAAI;IAI3F;;;;;OAKG;IACH,8BAA8B,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,IAAI;CA+E1D"}

package/dist/types/types/cc-rt/rti-object-identifier.d.ts

@@ -0,0 +1,34 @@
+/**
+ * Represents a CCD object identifier for which real-time information is available.
+ *
+ * Instances of this class provide details about a CCD object, such as agents, pilots,
+ * or queues, that can be monitored using the {@link CallCenterRealtime}.
+ *
+ * Each object includes a directory number, last name, first name, and a unique key.
+ * This class is typically used to retrieve and reference objects for real-time events.
+ *
+ * @see CallCenterRealtime
+ * @since 2.7.4
+ */
+export declare class RtiObjectIdentifier {
+    #private;
+    /**
+     * Returns the directory number associated with this identifier.
+     *
+     * @returns The directory number of the object.
+     */
+    get number(): string;
+    /**
+     * Returns the last name associated with this identifier.
+     *
+     * @returns The last name of the object.
+     */
+    get name(): string;
+    /**
+     * Returns the first name associated with this identifier.
+     *
+     * @returns The first name of the object.
+     */
+    get firstName(): string | null;
+}
+//# sourceMappingURL=rti-object-identifier.d.ts.map

package/dist/types/types/cc-rt/rti-object-identifier.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"rti-object-identifier.d.ts","sourceRoot":"","sources":["../../../../src/types/cc-rt/rti-object-identifier.ts"],"names":[],"mappings":"AAqBA;;;;;;;;;;;GAWG;AACH,qBAAa,mBAAmB;;IAc5B;;;;OAIG;IACH,IAAI,MAAM,IAAI,MAAM,CAEnB;IAED;;;;OAIG;IACH,IAAI,IAAI,IAAI,MAAM,CAEjB;IAED;;;;OAIG;IACH,IAAI,SAAS,IAAI,MAAM,GAAG,IAAI,CAE7B;CAQJ"}

package/dist/types/types/cc-rt/rti-objects.d.ts

@@ -0,0 +1,72 @@
+import { RtiFilter } from './rti-filter';
+import { RtiObjectIdentifier } from './rti-object-identifier';
+/**
+ * Represents a collection of CCD objects for which real-time information is available.
+ *
+ * This class groups CCD objects by type, including agents, pilots, queues, and processing groups
+ * (both agent and other). Each object is represented by an {@link RtiObjectIdentifier}.
+ *
+ * Instances of this class are typically returned by the {@link CallCenterRealtime}
+ * to provide the list of available CCD objects for which real-time data can be retrieved.
+ *
+ * A {@link CallCenterRealtime} can be created from an `RtiObjects` instance using
+ * {@link createFilter} to subscribe only to the selected objects in real-time event monitoring.
+ *
+ * @see RtiObjectIdentifier
+ * @see RtiService
+ * @see RtiFilter
+ * @since 2.7.4
+ */
+export declare class RtiObjects {
+    #private;
+    /**
+     * Returns the list of CCD agents.
+     *
+     * @returns An array of {@link RtiObjectIdentifier} representing agents.
+     */
+    get agents(): RtiObjectIdentifier[] | null;
+    /**
+     * Returns the list of CCD pilots.
+     *
+     * @returns An array of {@link RtiObjectIdentifier} representing pilots.
+     */
+    get pilots(): RtiObjectIdentifier[] | null;
+    /**
+     * Returns the list of CCD queues.
+     *
+     * @returns An array of {@link RtiObjectIdentifier} representing queues.
+     */
+    get queues(): RtiObjectIdentifier[] | null;
+    /**
+     * Returns the list of agent processing groups.
+     *
+     * @returns An array of {@link RtiObjectIdentifier} representing agent processing groups.
+     */
+    get agentProcessingGroups(): RtiObjectIdentifier[] | null;
+    /**
+     * Returns the list of other (non-agent) processing groups.
+     *
+     * @returns An array of {@link RtiObjectIdentifier} representing other processing groups.
+     */
+    get otherProcessingGroups(): RtiObjectIdentifier[] | null;
+    /**
+     * Creates a {@link RtiFilter} initialized with all CCD objects in this instance.
+     *
+     * The resulting filter can be used to create a real-time context for event monitoring
+     * with {@link CallCenterRealtime}. It includes all agents, pilots, queues, and processing groups
+     * present in this `RtiObjects` instance.
+     *
+     * @returns A {@link RtiFilter} containing all objects from this `RtiObjects` instance.
+     *
+     * @example
+     * ```ts
+     * const rtiObjects = rtiService.getRtiObjects();
+     * const filter = rtiObjects.createFilter();
+     * const context = new RtiContext(30, 5, filter);
+     * rtiService.setContext(context);
+     * rtiService.start();
+     * ```
+     */
+    createFilter(): RtiFilter;
+}
+//# sourceMappingURL=rti-objects.d.ts.map

package/dist/types/types/cc-rt/rti-objects.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"rti-objects.d.ts","sourceRoot":"","sources":["../../../../src/types/cc-rt/rti-objects.ts"],"names":[],"mappings":"AAyBA,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AACzC,OAAO,EAAE,mBAAmB,EAAE,MAAM,yBAAyB,CAAC;AAE9D;;;;;;;;;;;;;;;;GAgBG;AACH,qBAAa,UAAU;;IAwBnB;;;;OAIG;IACH,IAAI,MAAM,IAAI,mBAAmB,EAAE,GAAG,IAAI,CAEzC;IAED;;;;OAIG;IACH,IAAI,MAAM,IAAI,mBAAmB,EAAE,GAAG,IAAI,CAEzC;IAED;;;;OAIG;IACH,IAAI,MAAM,IAAI,mBAAmB,EAAE,GAAG,IAAI,CAEzC;IAED;;;;OAIG;IACH,IAAI,qBAAqB,IAAI,mBAAmB,EAAE,GAAG,IAAI,CAExD;IAED;;;;OAIG;IACH,IAAI,qBAAqB,IAAI,mBAAmB,EAAE,GAAG,IAAI,CAExD;IAeD;;;;;;;;;;;;;;;;;OAiBG;IACH,YAAY,IAAI,SAAS;CA8B5B"}

package/dist/types/types/cc-stats/agbypilot-attributes.d.ts

@@ -0,0 +1,73 @@
+/**
+ * `AgentByPilotAttributes` defines the set of statistical attributes available
+ * for a CCD agent with respect to a specific CCD pilot.
+ *
+ * These attributes are used in reports generated by `CallCenterStatisticsService`
+ * to provide insight into agent performance and activity per pilot.
+ *
+ * Attributes are grouped into:
+ * - **Counts** - number of calls received, served, transferred, etc.
+ * - **Durations** - total and average times.
+ *
+ * **Note:** The `ALL` attribute is intended for testing only and should
+ * not be used in production contexts.
+ *
+ * @since 2.7.4
+ */
+export declare enum StatsAgentByPilotAttributes {
+    /** Number of calls received for this pilot. */
+    nbCallsReceived = "nbCallsReceived",
+    /** Number of calls received by transfer. */
+    nbCallsTransfIn = "nbCallsTransfIn",
+    /** Number of calls served. */
+    nbCallsServed = "nbCallsServed",
+    /** Number of calls served too quickly. */
+    nbCallsServedTooQuickly = "nbCallsServedTooQuickly",
+    /** Number of calls with enquiry. */
+    nbCallsWithEnquiry = "nbCallsWithEnquiry",
+    /** Number of calls where help was requested. */
+    nbCallsWithHelp = "nbCallsWithHelp",
+    /** Number of calls transferred from the agent. */
+    nbCallsTransf = "nbCallsTransf",
+    /** Number of calls transferred to the agent. */
+    nbCallsTransfToAgent = "nbCallsTransfToAgent",
+    /** Number of calls in wrap-up. */
+    nbCallsInWrapup = "nbCallsInWrapup",
+    /** Maximum duration of call processing (hh:mm:ss). */
+    maxCallProcDur = "maxCallProcDur",
+    /** Maximum duration of conversation (hh:mm:ss). */
+    maxConvDur = "maxConvDur",
+    /** Maximum duration of wrap-up (hh:mm:ss). */
+    maxWrapupDur = "maxWrapupDur",
+    /** Total duration of call processing (hh:mm:ss). */
+    callProcTDur = "callProcTDur",
+    /** Average duration of call processing (hh:mm:ss). */
+    callProcADur = "callProcADur",
+    /** Total duration of conversation (hh:mm:ss). */
+    convTDur = "convTDur",
+    /** Average duration of conversation (hh:mm:ss). */
+    convADur = "convADur",
+    /** Total duration of wrap-up (hh:mm:ss). */
+    wrapupTDur = "wrapupTDur",
+    /** Average duration of wrap-up (hh:mm:ss). */
+    wrapupADur = "wrapupADur",
+    /** Total duration of conversation occurring during wrap-up (hh:mm:ss). */
+    convInWrapupTDur = "convInWrapupTDur",
+    /** Total busy time during wrap-up (hh:mm:ss). */
+    busyTimeInWrapupTDur = "busyTimeInWrapupTDur",
+    /** Total duration of calls on hold (hh:mm:ss). */
+    onHoldTDur = "onHoldTDur",
+    /** Average duration of calls on hold (hh:mm:ss). */
+    onHoldADur = "onHoldADur",
+    /** Total duration of transaction phase (hh:mm:ss). */
+    transTDur = "transTDur",
+    /** Average duration of transaction phase (hh:mm:ss). */
+    transADur = "transADur",
+    /** Total duration of pause (hh:mm:ss). */
+    pauseTDur = "pauseTDur",
+    /** Average duration of pause (hh:mm:ss). */
+    pauseADur = "pauseADur",
+    /** All attributes (for testing purposes only; not for production use). */
+    ALL = "ALL"
+}
+//# sourceMappingURL=agbypilot-attributes.d.ts.map

package/dist/types/types/cc-stats/agbypilot-attributes.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"agbypilot-attributes.d.ts","sourceRoot":"","sources":["../../../../src/types/cc-stats/agbypilot-attributes.ts"],"names":[],"mappings":"AAmBA;;;;;;;;;;;;;;;GAeG;AACH,oBAAY,2BAA2B;IACnC,+CAA+C;IAC/C,eAAe,oBAAoB;IAEnC,4CAA4C;IAC5C,eAAe,oBAAoB;IAEnC,8BAA8B;IAC9B,aAAa,kBAAkB;IAE/B,0CAA0C;IAC1C,uBAAuB,4BAA4B;IAEnD,oCAAoC;IACpC,kBAAkB,uBAAuB;IAEzC,gDAAgD;IAChD,eAAe,oBAAoB;IAEnC,kDAAkD;IAClD,aAAa,kBAAkB;IAE/B,gDAAgD;IAChD,oBAAoB,yBAAyB;IAE7C,kCAAkC;IAClC,eAAe,oBAAoB;IAEnC,sDAAsD;IACtD,cAAc,mBAAmB;IAEjC,mDAAmD;IACnD,UAAU,eAAe;IAEzB,8CAA8C;IAC9C,YAAY,iBAAiB;IAE7B,oDAAoD;IACpD,YAAY,iBAAiB;IAE7B,sDAAsD;IACtD,YAAY,iBAAiB;IAE7B,iDAAiD;IACjD,QAAQ,aAAa;IAErB,mDAAmD;IACnD,QAAQ,aAAa;IAErB,4CAA4C;IAC5C,UAAU,eAAe;IAEzB,8CAA8C;IAC9C,UAAU,eAAe;IAEzB,0EAA0E;IAC1E,gBAAgB,qBAAqB;IAErC,iDAAiD;IACjD,oBAAoB,yBAAyB;IAE7C,kDAAkD;IAClD,UAAU,eAAe;IAEzB,oDAAoD;IACpD,UAAU,eAAe;IAEzB,sDAAsD;IACtD,SAAS,cAAc;IAEvB,wDAAwD;IACxD,SAAS,cAAc;IAEvB,0CAA0C;IAC1C,SAAS,cAAc;IAEvB,4CAA4C;IAC5C,SAAS,cAAc;IAEvB,0EAA0E;IAC1E,GAAG,QAAQ;CACd"}