o2g-node-sdk 2.4.0 → 2.5.0

package/dist/types/o2g-cc-rt.d.ts

@@ -0,0 +1,163 @@
+import EventEmitter from 'events';
+import { RtiObjects } from './types/cc-rt/rti-objects';
+import { RtiObjectIdentifier } from './types/cc-rt/rti-object-identifier';
+import { RtiContext } from './types/cc-rt/rti-context';
+/**
+ * Provides real-time information about CCD objects from an OXE system
+ * in the form of events.
+ * <p>
+ * This service is available only to administrators and delivers the same
+ * level of information as the legacy RTI interface available in the CCS.
+ * <p>
+ * The CCD objects that can be monitored include CCD agents, pilots, waiting
+ * queues, processing groups associated with agents, and other processing
+ * groups (e.g. forward, guide).
+ * <p>
+ * The typical usage sequence is:
+ * <ol>
+ * <li>Build an {@link RtiFilter} specifying which objects and attributes to monitor.</li>
+ * <li>Create an {@link RtiContext} with the filter and the desired notification frequency.</li>
+ * <li>Set the context with {@link setContext}.</li>
+ * <li>Register event listeners for the RTI events of interest.</li>
+ * <li>Start monitoring with {@link start}.</li>
+ * </ol>
+ * <p>
+ * After initialization, the application is notified whenever one or more monitored
+ * attributes change. Each event contains only the attributes that have changed
+ * since the previous notification.
+ *
+ * @example
+ * ```typescript
+ * // Build a filter for specific agents and attributes
+ * const filter = new RtiFilter();
+ * filter.setAgentAttributes(
+ *     AgentAttributes.PrivateCallsTotalDuration,
+ *     AgentAttributes.AssociatedSet,
+ *     AgentAttributes.LogonDate
+ * );
+ * filter.setAgentNumbers(["60119", "60120"]);
+ *
+ * // Create a context: notification every 30s, data refresh every 5s
+ * const context = new RtiContext(30, 5, filter);
+ * await O2G.callCenterRealtime.setContext(context);
+ *
+ * // Register event listeners
+ * O2G.callCenterRealtime.on(CallCenterRealtime.ON_AGENT_RTI_CHANGED, (event) => {
+ *     console.log("Agent RTI changed:", event);
+ * });
+ *
+ * // Start monitoring
+ * await O2G.callCenterRealtime.start();
+ *
+ * // Stop monitoring and clean up when done
+ * await O2G.callCenterRealtime.deleteContext();
+ * O2G.callCenterRealtime.removeAllListeners(CallCenterRealtime.ON_AGENT_RTI_CHANGED);
+ * ```
+ *
+ * @since 2.7.4
+ */
+export declare class CallCenterRealtime extends EventEmitter {
+    #private;
+    /**
+     * Occurs when the real-time information of a CCD agent has changed.
+     * @event
+     */
+    static readonly ON_AGENT_RTI_CHANGED = "OnAgentRtiChanged";
+    /**
+     * Occurs when the real-time information of a CCD queue has changed.
+     * @event
+     */
+    static readonly ON_QUEUE_RTI_CHANGED = "OnQueueRtiChanged";
+    /**
+     * Occurs when the real-time information of a CCD pilot has changed.
+     * @event
+     */
+    static readonly ON_PILOT_RTI_CHANGED = "OnPilotRtiChanged";
+    /**
+     * Occurs when the real-time information of a CCD agent processing group has changed.
+     * @event
+     */
+    static readonly ON_AGENT_PG_RTI_CHANGED = "OnPGAgentRtiChanged";
+    /**
+     * Occurs when the real-time information of a CCD other processing group has changed.
+     * @event
+     */
+    static readonly ON_OTHER_PG_RTI_CHANGED = "OnPGOtherRtiChanged";
+    /**
+     * Retrieves all CCD objects that currently provide real-time information.
+     *
+     * The returned {@link RtiObjects} includes collections of agents, pilots,
+     * queues, and processing groups that can be monitored.
+     *
+     * Returns `null` if no objects are available or an error occurs.
+     */
+    getRtiObjects(): Promise<RtiObjects | null>;
+    /**
+     * Returns all CCD agents that provide real-time information.
+     *
+     * @returns An array of {@link RtiObjectIdentifier} representing agents,
+     *          or an empty array if none exist.
+     */
+    getAgents(): Promise<RtiObjectIdentifier[] | null>;
+    /**
+     * Returns all CCD pilots that provide real-time information.
+     *
+     * @returns A promise resolving to an array of {@link RtiObjectIdentifier} for pilots,
+     *          or an empty array if none exist, or `null` if an error occurs.
+     */
+    getPilots(): Promise<RtiObjectIdentifier[] | null>;
+    /**
+     * Returns all CCD queues that provide real-time information.
+     *
+     * @returns A promise resolving to an array of {@link RtiObjectIdentifier} for queues,
+     *          or an empty array if none exist, or `null` if an error occurs.
+     */
+    getQueues(): Promise<RtiObjectIdentifier[] | null>;
+    /**
+     * Returns all CCD agent processing groups that provide real-time information.
+     *
+     * @returns A promise resolving to an array of {@link RtiObjectIdentifier} for agent processing groups,
+     *          or an empty array if none exist, or `null` if an error occurs.
+     */
+    getAgentProcessingGroups(): Promise<RtiObjectIdentifier[] | null>;
+    /**
+     * Returns all CCD processing groups (other than agents) that provide real-time information.
+     *
+     * @returns A promise resolving to an array of {@link RtiObjectIdentifier} for other processing groups,
+     *          or an empty array if none exist, or `null` if an error occurs.
+     */
+    getOtherProcessingGroups(): Promise<RtiObjectIdentifier[] | null>;
+    /**
+     * Returns the monitoring Context associated with this administrator (session).
+     *
+     * @returns The Context associated with this administrator, or `null` if none exists.
+     */
+    getContext(): Promise<RtiContext | null>;
+    /**
+     * Deletes the monitoring Context associated with this administrator (session),
+     * stopping any RTI event notifications.
+     *
+     * @returns `true` if the deletion was successful; `false` otherwise.
+     */
+    deleteContext(): Promise<boolean>;
+    /**
+     * Associates or updates the monitoring Context for this administrator (session).
+     * If no context exists, a new one is created.
+     *
+     * The context defines which objects and attributes are monitored and the
+     * notification frequency for RTI events.
+     *
+     * @param context The Context to associate with this administrator.
+     * @returns `true` if the update was successful; `false` otherwise.
+     */
+    setContext(context: RtiContext): Promise<boolean>;
+    /**
+     * Starts the monitoring of CCD objects according to the associated context.
+     *
+     * After calling this method, RTI events will be sent to any registered listeners.
+     *
+     * @returns `true` if the monitoring started successfully; `false` otherwise.
+     */
+    start(): Promise<boolean>;
+}
+//# sourceMappingURL=o2g-cc-rt.d.ts.map

package/dist/types/o2g-cc-rt.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"o2g-cc-rt.d.ts","sourceRoot":"","sources":["../../src/o2g-cc-rt.ts"],"names":[],"mappings":"AAmBA,OAAO,YAAY,MAAM,QAAQ,CAAC;AAElC,OAAO,EAAE,UAAU,EAAE,MAAM,2BAA2B,CAAC;AAEvD,OAAO,EAAE,mBAAmB,EAAE,MAAM,qCAAqC,CAAC;AAC1E,OAAO,EAAE,UAAU,EAAE,MAAM,2BAA2B,CAAC;AASvD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqDG;AACH,qBAAa,kBAAmB,SAAQ,YAAY;;IAGhD;;;OAGG;IACH,MAAM,CAAC,QAAQ,CAAC,oBAAoB,uBAAuB;IAE3D;;;OAGG;IACH,MAAM,CAAC,QAAQ,CAAC,oBAAoB,uBAAuB;IAE3D;;;OAGG;IACH,MAAM,CAAC,QAAQ,CAAC,oBAAoB,uBAAuB;IAE3D;;;OAGG;IACH,MAAM,CAAC,QAAQ,CAAC,uBAAuB,yBAAyB;IAEhE;;;OAGG;IACH,MAAM,CAAC,QAAQ,CAAC,uBAAuB,yBAAyB;IAgBhE;;;;;;;OAOG;IACG,aAAa,IAAI,OAAO,CAAC,UAAU,GAAG,IAAI,CAAC;IAIjD;;;;;OAKG;IACG,SAAS,IAAI,OAAO,CAAC,mBAAmB,EAAE,GAAG,IAAI,CAAC;IAIxD;;;;;OAKG;IACG,SAAS,IAAI,OAAO,CAAC,mBAAmB,EAAE,GAAG,IAAI,CAAC;IAIxD;;;;;OAKG;IACG,SAAS,IAAI,OAAO,CAAC,mBAAmB,EAAE,GAAG,IAAI,CAAC;IAIxD;;;;;OAKG;IACG,wBAAwB,IAAI,OAAO,CAAC,mBAAmB,EAAE,GAAG,IAAI,CAAC;IAIvE;;;;;OAKG;IACG,wBAAwB,IAAI,OAAO,CAAC,mBAAmB,EAAE,GAAG,IAAI,CAAC;IAIvE;;;;OAIG;IACG,UAAU,IAAI,OAAO,CAAC,UAAU,GAAG,IAAI,CAAC;IAI9C;;;;;OAKG;IACG,aAAa,IAAI,OAAO,CAAC,OAAO,CAAC;IAIvC;;;;;;;;;OASG;IACG,UAAU,CAAC,OAAO,EAAE,UAAU,GAAG,OAAO,CAAC,OAAO,CAAC;IAIvD;;;;;;OAMG;IACG,KAAK,IAAI,OAAO,CAAC,OAAO,CAAC;CAGlC"}

package/dist/types/o2g-cc-stat.d.ts

@@ -0,0 +1,454 @@
+import { StatisticsData } from './types/cc-stats/data/stats-data';
+import { ProgressCallback } from './types/cc-stats/events/progress-callback';
+import { Language } from './types/cc-stats/language';
+import { Requester } from './types/cc-stats/requester';
+import { ScheduledReport } from './types/cc-stats/scheduled/scheduled-report';
+import { StatsFormat } from './types/cc-stats/stats-format';
+import { StatsContext } from './types/cc-stats/stats-context';
+import { StatsFilter } from './types/cc-stats/stats-filter';
+import { TimeInterval } from './types/cc-stats/time-interval';
+import { DateRange } from './types/common/date-range';
+import { Recurrence } from './types/cc-stats/scheduled/recurrence';
+import { ReportObservationPeriod } from './types/cc-stats/scheduled/report-obs-period';
+/**
+ * CallCenterStatistics provides access to historical ACD statistics and reporting.
+ * Using this service requires having a <b>CONTACTCENTER_SRV</b> license.
+ * <p>
+ * Statistics are accessed through a two-level hierarchy:
+ * <ul>
+ * <li>A {@link Requester} defines the scope of agents whose data can be accessed.</li>
+ * <li>A {@link StatsContext} defines the filter criteria (pilots, agents, queues)
+ * for which statistics are collected.</li>
+ * </ul>
+ * <p>
+ * The typical usage sequence for retrieving statistics is:
+ * <ol>
+ * <li>Create a requester with {@link createRequester}, specifying the agents in scope.</li>
+ * <li>Create a context with {@link createContext}, specifying the filter criteria.</li>
+ * <li>Retrieve data with {@link getDayData} for a single day, or {@link getDaysData}
+ * for a date range.</li>
+ * <li>Delete the context and requester when done.</li>
+ * </ol>
+ *
+ * @example
+ * ```typescript
+ * // Create a requester scoped to two agents
+ * const requester = await O2G.callCenterStatistics.createRequester(
+ *     "myRequester",
+ *     Language.ENGLISH,
+ *     "Europe/Paris",
+ *     "60119", "60120"
+ * );
+ *
+ * // Create a context with a filter on a specific pilot
+ * const filter = new StatsFilter();
+ * filter.addPilot("60141");
+ * const context = await O2G.callCenterStatistics.createContext(
+ *     requester,
+ *     "myContext",
+ *     "Pilot 60141 statistics",
+ *     filter
+ * );
+ *
+ * // Retrieve statistics for today in 30-minute intervals
+ * const data = await O2G.callCenterStatistics.getDayData(context, new Date(), TimeInterval.THIRTY_MINUTES);
+ *
+ * // Retrieve statistics for a date range
+ * const range = new DateRange(new Date("2025-01-01"), new Date("2025-01-31"));
+ * const monthData = await O2G.callCenterStatistics.getDaysData(context, range);
+ *
+ * // Clean up
+ * await O2G.callCenterStatistics.deleteContexts(requester);
+ * await O2G.callCenterStatistics.deleteRequester(requester);
+ * ```
+ */
+export declare class CallCenterStatistics {
+    #private;
+    /**
+     * Returns whether there is an asynchronous statistics request currently in progress.
+     *
+     * This can be useful to check before calling {@link getDayFileData} or {@link getDaysFileData},
+     * since both methods enforce that only one request can run at a time.
+     *
+     * @returns `true` if a statistics request is currently active, `false` otherwise
+     */
+    hasAsyncRequestInProgress(): boolean;
+    /**
+     * Creates a new `Requester` with the specified identifier, language, and time zone,
+     * and establishes the statistics scope defining which agents' data the requester
+     * is authorized to access.
+     *
+     * This method determines the set of agents whose statistics can be retrieved by
+     * the specified requester. Once the scope is created, the requester can query
+     * individual or aggregated statistics for those agents through the reporting services.
+     *
+     * @example
+     * ```typescript
+     * // Create a requester scoped to specific agents
+     * const requester = await O2G.callCenterStatistics.createRequester(
+     *     "supervisor01",
+     *     Language.ENGLISH,
+     *     "Europe/Paris",
+     *     "60119", "60120", "60121"
+     * );
+     *
+     * // Create a requester scoped to a single agent
+     * const singleAgentRequester = await O2G.callCenterStatistics.createRequester(
+     *     "supervisor02",
+     *     Language.FRENCH,
+     *     "Europe/London",
+     *     "60119"
+     * );
+     * ```
+     *
+     * @param id       the unique identifier of the requester
+     * @param language the requester's preferred {@link Language}
+     * @param timezone the requester's time zone (e.g. `"Europe/Paris"`)
+     * @param agents   the agent identifiers that define the scope of accessible statistics
+     * @returns the newly created {@link Requester} on success; `null` otherwise.
+     * @see deleteRequester
+     */
+    createRequester(id: string, language: Language, timezone: string, ...agents: string[]): Promise<Requester | null>;
+    /**
+     * Removes the requester and all its associated contexts.
+     *
+     * After calling this method, the specified requester will no longer have
+     * access to any agent statistics defined under their scope.
+     *
+     * @param requester - The requester to removed.
+     * @returns `true` if the requester was successfully removed; otherwise, `false`.
+     */
+    deleteRequester(requester: Requester): Promise<boolean>;
+    /**
+     * Retrieves the requester associated with the specified identifier.
+     *
+     * The returned requester represents the scope of agents for which statistics
+     * can be accessed. If no requester exists with the given ID, this method
+     * returns `null`.
+     *
+     * @param id - The unique identifier of the requester.
+     * @returns The `Requester` object corresponding to the ID, or `null`
+     *          if no matching requester is found.
+     */
+    getRequester(id: string): Promise<Requester | null>;
+    /**
+     * Creates a new statistical context with the specified label, description, and filter
+     * for the given requester.
+     *
+     * A context defines a scope for which call center statistics can be collected and analyzed
+     * according to the specified filter criteria.
+     *
+     * @param requester - the requester for whom the context is being created
+     * @param label - a short label identifying this context
+     * @param description - a detailed description of the context
+     * @param filter - the filter defining the selection criteria for the context
+     * @returns the created `StatContext` if successful; `null` otherwise
+     */
+    createContext(requester: Requester, label: string, description: string, filter: StatsFilter): Promise<StatsContext | null>;
+    /**
+     * Deletes all statistical contexts associated with the specified requester.
+     *
+     * A context defines a scope for collecting and analyzing call center statistics
+     * according to its associated filter criteria.
+     *
+     * @param requester - The requester whose contexts should be deleted.
+     * @returns `true` if all contexts were successfully deleted; `false`
+     * if an error occurred or no contexts were deleted.
+     *
+     * @see createContext
+     */
+    deleteContexts(requester: Requester): Promise<boolean>;
+    /**
+     * Retrieves the statistical contexts created for the specified requester.
+     *
+     * Each context defines a scope for collecting and analyzing call center statistics
+     * according to its associated filter criteria.
+     *
+     * @param requester - The requester whose contexts are being retrieved.
+     * @returns An array of `Context` objects if successful; `null`
+     *          if there is an error or if no contexts exist for this requester.
+     * @see createContext
+     */
+    getContexts(requester: Requester): Promise<StatsContext[] | null>;
+    /**
+     * Retrieves a statistical context by its identifier for the specified requester.
+     *
+     * A context defines a scope for collecting and analyzing call center statistics
+     * according to its associated filter criteria.
+     *
+     * @param requester - The requester who owns the context.
+     * @param contextId - The unique identifier of the context.
+     * @returns The {@link StatsContext} if found and retrieval is successful; `null`
+     * if there is an error or if no context exists with the specified identifier.
+     */
+    getContext(requester: Requester, contextId: string): Promise<StatsContext | null>;
+    /**
+     * Deletes the specified statistical context.
+     *
+     * A context defines a scope for collecting and analyzing call center statistics
+     * according to its associated filter criteria.
+     *
+     * @param context - The context to be deleted.
+     * @returns `true` if the context was successfully deleted; `false`
+     *          if an error occurred or the context could not be deleted.
+     * @see createContext(requester: Requester, name: string, description: string, filter: Filter)
+     */
+    deleteContext(context: StatsContext): Promise<boolean>;
+    /**
+     * Retrieves statistical data for the specified context.
+     *
+     * This method generates a multi-day report corresponding to the time range
+     * defined by the provided {@link DateRange}. It allows reporting and analysis
+     * of call center metrics across multiple days within the selected period.
+     *
+     * The returned {@link StatisticsData} object contains the aggregated data,
+     * suitable for further processing or integration.
+     *
+     * @param context - The context defining the scope and filters for the statistics.
+     * @param range - The date range over which to collect statistics.
+     * @param shortHeader - True to return only limited number of headers in response
+     * @returns A {@link StatisticsData} object containing the data,
+     *          or `null` if the data could not be retrieved.
+     */
+    getDaysData(context: StatsContext, range: DateRange, shortHeader?: boolean): Promise<StatisticsData | null>;
+    /**
+     * Retrieves statistical data for the specified context for a single day.
+     *
+     * The statistics are provided in time slots according to the `timeInterval` parameter.
+     *
+     * - If `date` is not provided, the current day is used.
+     * - If `timeInterval` is not provided or `undefined`, it is ignored and
+     *   `TimeInterval.QUARTE_HOUR` is used as the default value.
+     *
+     * @param context - The context defining the scope and filters for the statistics
+     * @param date - (Optional) The specific day for which to collect statistics; defaults to today if not provided
+     * @param timeInterval - (Optional) The time slot interval for reporting (e.g., 15 or 30 minutes);
+     *                       defaults to `TimeInterval.QUARTE_HOUR` if not provided
+     * @param shortHeader - True to return only limited number of headers in response
+     * @returns A `StatisticsData` object containing the data, or `null` if the data could not be retrieved
+     */
+    getDayData(context: StatsContext, date?: Date, timeInterval?: TimeInterval, shortHeader?: boolean): Promise<StatisticsData | null>;
+    /**
+     * Asynchronously retrieves statistical data for the specified context for a single day
+     * and stores it as a report file in the given directory.
+     * <p>
+     * The statistics are reported in time slots defined by the `timeInterval` parameter,
+     * spanning from 00:00 until the last completed interval of the specified day.
+     * <p>
+     * Only one report generation request can be active at a time. Use
+     * {@link hasAsyncRequestInProgress} to check before calling this method. Any attempt
+     * to start another request while one is already in progress will reject the returned
+     * `Promise` with an `Error`.
+     *
+     * @example
+     * ```typescript
+     * // Check no request is already running
+     * if (!O2G.callCenterStatistics.hasAsyncRequestInProgress()) {
+     *     const filePath = await O2G.callCenterStatistics.getDayFileData(
+     *         context,
+     *         new Date(2025, 9, 5), // October 5, 2025 (months are 0-based)
+     *         TimeInterval.HOUR,
+     *         StatsFormat.CSV,
+     *         "/tmp/stats",
+     *         (step) => console.log(`Progress: ${step}`)
+     *     );
+     *     console.log(`Report saved at: ${filePath}`);
+     * }
+     *
+     * // Cancel if needed
+     * await O2G.callCenterStatistics.cancelRequest(context);
+     * ```
+     *
+     * @param context          the context defining the scope and filters for the statistics
+     * @param date             the date for which to generate the report
+     * @param timeInterval     the length of each reporting interval within the day
+     * @param format           the output format for the report file
+     * @param shortHeader      true to return only limited number of headers in response
+     * @param directory        the directory in which to save the generated report file
+     * @param progressCallback optional callback invoked to report progress of the operation
+     * @returns a `Promise` that resolves with the path to the generated report file,
+     *          or rejects if an error occurs, the operation is cancelled, or another
+     *          request is already in progress
+     * @see getDaysFileData
+     * @see hasAsyncRequestInProgress
+     * @see cancelRequest
+     */
+    getDayFileData(context: StatsContext, date: Date, timeInterval: TimeInterval, format: StatsFormat, shortHeader: boolean | undefined, directory: string, progressCallback?: ProgressCallback): Promise<string>;
+    /**
+     * Asynchronously retrieves statistical data for the specified context over a date range
+     * and stores it as a report file in the given directory.
+     * <p>
+     * Only one report generation request can be active at a time. Use
+     * {@link hasAsyncRequestInProgress} to check before calling this method. Any attempt
+     * to start another request while one is already in progress will reject the returned
+     * `Promise` with an `Error`.
+     *
+     * @example
+     * ```typescript
+     * // Check no request is already running
+     * if (!O2G.callCenterStatistics.hasAsyncRequestInProgress()) {
+     *     const range = new DateRange(
+     *         new Date(2025, 8, 1),  // September 1, 2025
+     *         new Date(2025, 8, 30)  // September 30, 2025
+     *     );
+     *     const filePath = await O2G.callCenterStatistics.getDaysFileData(
+     *         context,
+     *         range,
+     *         StatsFormat.CSV,
+     *         "/tmp/stats",
+     *         (step) => console.log(`Progress: ${step}`)
+     *     );
+     *     console.log(`Report saved at: ${filePath}`);
+     * }
+     *
+     * // Cancel if needed
+     * await O2G.callCenterStatistics.cancelRequest(context);
+     * ```
+     *
+     * @param context          the context defining the scope and filters for the statistics
+     * @param range            the date range over which to collect statistics
+     * @param format           the output format for the report file
+     * @param shortHeader      true to return only limited number of headers in response
+     * @param directory        the directory in which to save the generated report file
+     * @param progressCallback optional callback invoked to report progress of the operation
+     * @returns a `Promise` that resolves with the path to the generated report file,
+     *          or rejects if an error occurs, the operation is cancelled, or another
+     *          request is already in progress
+     * @see getDayFileData
+     * @see hasAsyncRequestInProgress
+     * @see cancelRequest
+     */
+    getDaysFileData(context: StatsContext, range: DateRange, format: StatsFormat, shortHeader: boolean | undefined, directory: string, progressCallback?: ProgressCallback): Promise<string>;
+    /**
+     * Attempts to cancel an ongoing statistics report generation for the specified context.
+     *
+     * If a report generation process for the given `context` is currently running,
+     * this method will attempt to stop it. Cancellation may succeed only if the process
+     * has not already completed.
+     *
+     * The method returns immediately and does not block until the process is fully terminated.
+     *
+     * @param context - The context identifying the report generation process to cancel
+     * @returns `true` if a running report generation was found and successfully requested to be cancelled,
+     *          `false` if there was no running process for the specified context or if it could not be cancelled
+     */
+    cancelRequest(context: StatsContext): Promise<boolean>;
+    /**
+     * Creates a new recurrent scheduled report with the specified configuration.
+     * <p>
+     * The report will be generated repeatedly according to the given `recurrence`
+     * pattern and `observationPeriod`, formatted in the specified output format,
+     * and sent to the provided recipients.
+     *
+     * @example
+     * ```typescript
+     * // Create a weekly report sent every Monday covering the previous week
+     * const report = await O2G.callCenterStatistics.createRecurrentScheduledReport(
+     *     context,
+     *     "weeklyReport",
+     *     "Weekly pilot statistics",
+     *     ReportObservationPeriod.PREVIOUS_WEEK,
+     *     Recurrence.WEEKLY,
+     *     StatsFormat.CSV,
+     *     ["supervisor@company.com", "manager@company.com"]
+     * );
+     *
+     * // Disable the report temporarily
+     * await O2G.callCenterStatistics.setScheduledReportEnabled(report, false);
+     *
+     * // Re-enable it later
+     * await O2G.callCenterStatistics.setScheduledReportEnabled(report, true);
+     * ```
+     *
+     * @param context           the context defining which data and counters to include
+     * @param id                a unique identifier for the scheduled report
+     * @param description       a human-readable description of the report
+     * @param observationPeriod the period over which statistics are collected
+     * @param recurrence        the recurrence pattern for generating the report
+     * @param format            the output format of the report
+     * @param recipients        the list of email addresses to receive the report
+     * @returns the newly created {@link ScheduledReport} on success; `null` otherwise.
+     * @see createOneTimeScheduledReport
+     * @see deleteScheduledReport
+     * @see setScheduledReportEnabled
+     */
+    createRecurrentScheduledReport(context: StatsContext, id: string, description: string, observationPeriod: ReportObservationPeriod, recurrence: Recurrence, format: StatsFormat, recipients: string[]): Promise<ScheduledReport | null>;
+    /**
+     * Creates a new one-time scheduled report with the specified configuration.
+     * <p>
+     * Unlike {@link createRecurrentScheduledReport}, this report is generated only
+     * once for the specified `observationPeriod`, then it is no longer active.
+     *
+     * @example
+     * ```typescript
+     * // Create a one-time report covering the previous month
+     * const report = await O2G.callCenterStatistics.createOneTimeScheduledReport(
+     *     context,
+     *     "monthlySnapshot",
+     *     "End of month statistics snapshot",
+     *     ReportObservationPeriod.PREVIOUS_MONTH,
+     *     StatsFormat.CSV,
+     *     ["supervisor@company.com"]
+     * );
+     * ```
+     *
+     * @param context           the context defining which data and counters to include
+     * @param id                a unique identifier for the scheduled report
+     * @param description       a human-readable description of the report
+     * @param observationPeriod the period over which statistics are collected
+     * @param format            the output format of the report
+     * @param recipients        the list of email addresses to receive the report
+     * @returns the newly created {@link ScheduledReport} on success; `null` otherwise.
+     * @see createRecurrentScheduledReport
+     * @see deleteScheduledReport
+     */
+    createOneTimeScheduledReport(context: StatsContext, id: string, description: string, observationPeriod: ReportObservationPeriod, format: StatsFormat, recipients: string[]): Promise<ScheduledReport | null>;
+    /**
+     * Returns all scheduled reports associated with the given context.
+     *
+     * @param context - The context defining which reports to retrieve
+     * @returns An array of {@link ScheduledReport} objects for the specified context;
+     *          may be empty if no reports exist
+     */
+    getScheduledReports(context: StatsContext): Promise<ScheduledReport[] | null>;
+    /**
+     * Deletes the specified scheduled report.
+     *
+     * @param report The scheduled report to delete.
+     * @returns `true` if the report was successfully deleted, `false` otherwise.
+     */
+    deleteScheduledReport(report: ScheduledReport): Promise<boolean>;
+    /**
+     * Enables or disables the specified scheduled report.
+     *
+     * @param report The scheduled report to update.
+     * @param enabled `true` to enable the report, `false` to disable it.
+     * @returns `true` if the report state was successfully updated, `false` otherwise.
+     */
+    setScheduledReportEnabled(report: ScheduledReport, enabled: boolean): Promise<boolean>;
+    /**
+     * Retrieves a previously created scheduled report by its unique identifier.
+     *
+     * This method requires a valid `StatsContext` to perform the retrieval operation.
+     * The `scheduleReportId` must correspond to an existing scheduled report.
+     *
+     * @param context The session context used to access the service.
+     * @param scheduleReportId The unique identifier of the scheduled report to retrieve.
+     * @returns The `ScheduledReport` corresponding to the specified ID,
+     *          or `null` if no report exists with that ID.
+     */
+    getScheduledReport(context: StatsContext, scheduleReportId: string): Promise<ScheduledReport | null>;
+    /**
+     * Updates the configuration of an existing scheduled report.
+     *
+     * This method persists any changes made to the provided `ScheduledReport` instance,
+     * including its description, observation period, recurrence, format, and recipients.
+     * Implementations should ensure that the report exists and that the updates are valid.
+     *
+     * @param report The `ScheduledReport` instance containing the updated information.
+     * @returns `true` if the update was successful; `false` if the report does not exist
+     *          or the update could not be applied.
+     */
+    updateScheduledReport(report: ScheduledReport): Promise<boolean>;
+}
+//# sourceMappingURL=o2g-cc-stat.d.ts.map

package/dist/types/o2g-cc-stat.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"o2g-cc-stat.d.ts","sourceRoot":"","sources":["../../src/o2g-cc-stat.ts"],"names":[],"mappings":"AAoBA,OAAO,EAAE,cAAc,EAAE,MAAM,kCAAkC,CAAC;AAClE,OAAO,EAAE,gBAAgB,EAAE,MAAM,2CAA2C,CAAC;AAC7E,OAAO,EAAE,QAAQ,EAAE,MAAM,2BAA2B,CAAC;AACrD,OAAO,EAAE,SAAS,EAAE,MAAM,4BAA4B,CAAC;AACvD,OAAO,EAAE,eAAe,EAAE,MAAM,6CAA6C,CAAC;AAC9E,OAAO,EAAE,WAAW,EAAE,MAAM,+BAA+B,CAAC;AAC5D,OAAO,EAAE,YAAY,EAAE,MAAM,gCAAgC,CAAC;AAC9D,OAAO,EAAE,WAAW,EAAE,MAAM,+BAA+B,CAAC;AAC5D,OAAO,EAAE,YAAY,EAAE,MAAM,gCAAgC,CAAC;AAC9D,OAAO,EAAE,SAAS,EAAE,MAAM,2BAA2B,CAAC;AACtD,OAAO,EAAE,UAAU,EAAE,MAAM,uCAAuC,CAAC;AACnE,OAAO,EAAE,uBAAuB,EAAE,MAAM,8CAA8C,CAAC;AAEvF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmDG;AACH,qBAAa,oBAAoB;;IAW7B;;;;;;;OAOG;IACH,yBAAyB,IAAI,OAAO;IAIpC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;IACG,eAAe,CACjB,EAAE,EAAE,MAAM,EACV,QAAQ,EAAE,QAAQ,EAClB,QAAQ,EAAE,MAAM,EAChB,GAAG,MAAM,EAAE,MAAM,EAAE,GACpB,OAAO,CAAC,SAAS,GAAG,IAAI,CAAC;IAI5B;;;;;;;;OAQG;IACG,eAAe,CAAC,SAAS,EAAE,SAAS,GAAG,OAAO,CAAC,OAAO,CAAC;IAI7D;;;;;;;;;;OAUG;IACG,YAAY,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,GAAG,IAAI,CAAC;IAIzD;;;;;;;;;;;;OAYG;IACG,aAAa,CACf,SAAS,EAAE,SAAS,EACpB,KAAK,EAAE,MAAM,EACb,WAAW,EAAE,MAAM,EACnB,MAAM,EAAE,WAAW,GACpB,OAAO,CAAC,YAAY,GAAG,IAAI,CAAC;IAI/B;;;;;;;;;;;OAWG;IACG,cAAc,CAAC,SAAS,EAAE,SAAS,GAAG,OAAO,CAAC,OAAO,CAAC;IAI5D;;;;;;;;;;OAUG;IACG,WAAW,CAAC,SAAS,EAAE,SAAS,GAAG,OAAO,CAAC,YAAY,EAAE,GAAG,IAAI,CAAC;IAIvE;;;;;;;;;;OAUG;IACG,UAAU,CAAC,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,GAAG,IAAI,CAAC;IAIvF;;;;;;;;;;OAUG;IACG,aAAa,CAAC,OAAO,EAAE,YAAY,GAAG,OAAO,CAAC,OAAO,CAAC;IAI5D;;;;;;;;;;;;;;;OAeG;IACG,WAAW,CAAC,OAAO,EAAE,YAAY,EAAE,KAAK,EAAE,SAAS,EAAE,WAAW,GAAE,OAAe,GAAG,OAAO,CAAC,cAAc,GAAG,IAAI,CAAC;IAIxH;;;;;;;;;;;;;;;OAeG;IACG,UAAU,CAAC,OAAO,EAAE,YAAY,EAAE,IAAI,CAAC,EAAE,IAAI,EAAE,YAAY,CAAC,EAAE,YAAY,EAAE,WAAW,GAAE,OAAe,GAAG,OAAO,CAAC,cAAc,GAAG,IAAI,CAAC;IAI/I;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4CG;IACG,cAAc,CAChB,OAAO,EAAE,YAAY,EACrB,IAAI,EAAE,IAAI,EACV,YAAY,EAAE,YAAY,EAC1B,MAAM,EAAE,WAAW,EACnB,WAAW,EAAE,OAAO,YAAQ,EAC5B,SAAS,EAAE,MAAM,EACjB,gBAAgB,CAAC,EAAE,gBAAgB,GACpC,OAAO,CAAC,MAAM,CAAC;IAIlB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2CG;IACG,eAAe,CACjB,OAAO,EAAE,YAAY,EACrB,KAAK,EAAE,SAAS,EAChB,MAAM,EAAE,WAAW,EACnB,WAAW,EAAE,OAAO,YAAQ,EAC5B,SAAS,EAAE,MAAM,EACjB,gBAAgB,CAAC,EAAE,gBAAgB,GACpC,OAAO,CAAC,MAAM,CAAC;IAIlB;;;;;;;;;;;;OAYG;IACG,aAAa,CAAC,OAAO,EAAE,YAAY,GAAG,OAAO,CAAC,OAAO,CAAC;IAI5D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAsCG;IACG,8BAA8B,CAChC,OAAO,EAAE,YAAY,EACrB,EAAE,EAAE,MAAM,EACV,WAAW,EAAE,MAAM,EACnB,iBAAiB,EAAE,uBAAuB,EAC1C,UAAU,EAAE,UAAU,EACtB,MAAM,EAAE,WAAW,EACnB,UAAU,EAAE,MAAM,EAAE,GACrB,OAAO,CAAC,eAAe,GAAG,IAAI,CAAC;IAYlC;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACG,4BAA4B,CAC9B,OAAO,EAAE,YAAY,EACrB,EAAE,EAAE,MAAM,EACV,WAAW,EAAE,MAAM,EACnB,iBAAiB,EAAE,uBAAuB,EAC1C,MAAM,EAAE,WAAW,EACnB,UAAU,EAAE,MAAM,EAAE,GACrB,OAAO,CAAC,eAAe,GAAG,IAAI,CAAC;IAWlC;;;;;;OAMG;IACG,mBAAmB,CAAC,OAAO,EAAE,YAAY,GAAG,OAAO,CAAC,eAAe,EAAE,GAAG,IAAI,CAAC;IAInF;;;;;OAKG;IACG,qBAAqB,CAAC,MAAM,EAAE,eAAe,GAAG,OAAO,CAAC,OAAO,CAAC;IAItE;;;;;;OAMG;IACG,yBAAyB,CAAC,MAAM,EAAE,eAAe,EAAE,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;IAI5F;;;;;;;;;;OAUG;IACG,kBAAkB,CAAC,OAAO,EAAE,YAAY,EAAE,gBAAgB,EAAE,MAAM,GAAG,OAAO,CAAC,eAAe,GAAG,IAAI,CAAC;IAI1G;;;;;;;;;;OAUG;IACG,qBAAqB,CAAC,MAAM,EAAE,eAAe,GAAG,OAAO,CAAC,OAAO,CAAC;CAGzE"}