o2g-node-sdk 2.5.5 → 2.5.7

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (38) hide show
  1. package/README.md +10 -1
  2. package/dist/o2g-node-sdk.js +813 -697
  3. package/dist/o2g-node-sdk.js.map +1 -1
  4. package/dist/types/services/o2g-analytics.d.ts +40 -31
  5. package/dist/types/services/o2g-analytics.d.ts.map +1 -1
  6. package/dist/types/services/o2g-cc-agent.d.ts +11 -7
  7. package/dist/types/services/o2g-cc-agent.d.ts.map +1 -1
  8. package/dist/types/services/o2g-cc-mngt.d.ts +61 -40
  9. package/dist/types/services/o2g-cc-mngt.d.ts.map +1 -1
  10. package/dist/types/services/o2g-cc-pilot.d.ts +7 -5
  11. package/dist/types/services/o2g-cc-pilot.d.ts.map +1 -1
  12. package/dist/types/services/o2g-cc-rt.d.ts +4 -3
  13. package/dist/types/services/o2g-cc-rt.d.ts.map +1 -1
  14. package/dist/types/services/o2g-cc-stat.d.ts +160 -163
  15. package/dist/types/services/o2g-cc-stat.d.ts.map +1 -1
  16. package/dist/types/services/o2g-comlog.d.ts +68 -67
  17. package/dist/types/services/o2g-comlog.d.ts.map +1 -1
  18. package/dist/types/services/o2g-directory.d.ts +35 -40
  19. package/dist/types/services/o2g-directory.d.ts.map +1 -1
  20. package/dist/types/services/o2g-eventSummary.d.ts +7 -8
  21. package/dist/types/services/o2g-eventSummary.d.ts.map +1 -1
  22. package/dist/types/services/o2g-maint.d.ts +10 -10
  23. package/dist/types/services/o2g-messaging.d.ts +3 -2
  24. package/dist/types/services/o2g-messaging.d.ts.map +1 -1
  25. package/dist/types/services/o2g-routing.d.ts +37 -19
  26. package/dist/types/services/o2g-routing.d.ts.map +1 -1
  27. package/dist/types/services/o2g-rsi.d.ts +62 -54
  28. package/dist/types/services/o2g-rsi.d.ts.map +1 -1
  29. package/dist/types/services/o2g-telephony.d.ts +255 -224
  30. package/dist/types/services/o2g-telephony.d.ts.map +1 -1
  31. package/dist/types/services/o2g-users-mngt.d.ts +21 -13
  32. package/dist/types/services/o2g-users-mngt.d.ts.map +1 -1
  33. package/dist/types/services/o2g-users.d.ts +8 -5
  34. package/dist/types/services/o2g-users.d.ts.map +1 -1
  35. package/dist/types/types/telephony/call/ccd/call-profile.d.ts.map +1 -1
  36. package/dist/types/types/users/user.d.ts +6 -0
  37. package/dist/types/types/users/user.d.ts.map +1 -1
  38. package/package.json +2 -2
@@ -11,8 +11,18 @@ import { DateRange } from '../types/common/date-range';
11
11
  import { Recurrence } from '../types/cc-stats/scheduled/recurrence';
12
12
  import { ReportObservationPeriod } from '../types/cc-stats/scheduled/report-obs-period';
13
13
  /**
14
- * CallCenterStatistics provides access to historical ACD statistics and reporting.
15
- * Using this service requires having a <b>CONTACTCENTER_SRV</b> license.
14
+ * Provides access to historical ACD statistics and reporting for CCD agents and pilots.
15
+ * <p>
16
+ * Using this service requires a <b>CONTACTCENTER_SERVICE</b> license in CAPEX mode, or a
17
+ * <b>40 api-tel-f</b> subscription in OPEX mode (Purple On Demand).
18
+ * <p>
19
+ * This service supports two modes of data retrieval:
20
+ * <ul>
21
+ * <li><b>Immediate reports</b> — statistics retrieved on demand, returned as in-memory data
22
+ * or exported as CSV or Excel files.</li>
23
+ * <li><b>Scheduled reports</b> — recurring statistics delivered as email attachments to
24
+ * predefined recipients.</li>
25
+ * </ul>
16
26
  * <p>
17
27
  * Statistics are accessed through a two-level hierarchy:
18
28
  * <ul>
@@ -65,22 +75,22 @@ import { ReportObservationPeriod } from '../types/cc-stats/scheduled/report-obs-
65
75
  export declare class CallCenterStatistics {
66
76
  #private;
67
77
  /**
68
- * Returns whether there is an asynchronous statistics request currently in progress.
69
- *
70
- * This can be useful to check before calling {@link getDayFileData} or {@link getDaysFileData},
71
- * since both methods enforce that only one request can run at a time.
78
+ * Returns whether an asynchronous statistics report generation request is currently in progress.
79
+ * <p>
80
+ * Use this method to check before calling {@link getDayFileData} or {@link getDaysFileData},
81
+ * since both methods enforce that only one request can be active at a time.
72
82
  *
73
- * @returns `true` if a statistics request is currently active, `false` otherwise
83
+ * @returns `true` if a statistics request is currently active; `false` otherwise
74
84
  */
75
85
  hasAsyncRequestInProgress(): boolean;
76
86
  /**
77
- * Creates a new `Requester` with the specified identifier, language, and time zone,
78
- * and establishes the statistics scope defining which agents' data the requester
79
- * is authorized to access.
80
- *
81
- * This method determines the set of agents whose statistics can be retrieved by
82
- * the specified requester. Once the scope is created, the requester can query
83
- * individual or aggregated statistics for those agents through the reporting services.
87
+ * Creates a new {@link Requester} with the specified identifier, language, and time zone,
88
+ * and establishes the statistics scope defining which agents' data the requester is
89
+ * authorized to access.
90
+ * <p>
91
+ * The agent scope determines which agents' statistics can be retrieved by the requester.
92
+ * Once created, the requester can query individual or aggregated statistics for those
93
+ * agents through the reporting services.
84
94
  *
85
95
  * @example
86
96
  * ```typescript
@@ -101,144 +111,131 @@ export declare class CallCenterStatistics {
101
111
  * );
102
112
  * ```
103
113
  *
104
- * @param id the unique identifier of the requester
114
+ * @param id the unique identifier of the requester (e.g., a supervisor ID)
105
115
  * @param language the requester's preferred {@link Language}
106
116
  * @param timezone the requester's time zone (e.g. `"Europe/Paris"`)
107
- * @param agents the agent identifiers that define the scope of accessible statistics
108
- * @returns the newly created {@link Requester} on success; `null` otherwise.
117
+ * @param agents the agent directory numbers that define the scope of accessible statistics
118
+ * @returns the newly created {@link Requester} on success; `null` otherwise
109
119
  * @see deleteRequester
110
120
  */
111
121
  createRequester(id: string, language: Language, timezone: string, ...agents: string[]): Promise<Requester | null>;
112
122
  /**
113
- * Removes the requester and all its associated contexts.
114
- *
115
- * After calling this method, the specified requester will no longer have
116
- * access to any agent statistics defined under their scope.
123
+ * Removes the specified requester and all its associated contexts.
124
+ * <p>
125
+ * After this call, the requester no longer has access to any agent statistics defined
126
+ * under its scope.
117
127
  *
118
- * @param requester - The requester to removed.
119
- * @returns `true` if the requester was successfully removed; otherwise, `false`.
128
+ * @param requester the requester to remove
129
+ * @returns `true` if the requester was successfully removed; `false` otherwise
120
130
  */
121
131
  deleteRequester(requester: Requester): Promise<boolean>;
122
132
  /**
123
133
  * Retrieves the requester associated with the specified identifier.
134
+ * <p>
135
+ * The returned requester represents the scope of agents for which statistics can be
136
+ * accessed. If no requester exists with the given ID, this method returns `null`.
124
137
  *
125
- * The returned requester represents the scope of agents for which statistics
126
- * can be accessed. If no requester exists with the given ID, this method
127
- * returns `null`.
128
- *
129
- * @param id - The unique identifier of the requester.
130
- * @returns The `Requester` object corresponding to the ID, or `null`
131
- * if no matching requester is found.
138
+ * @param id the unique identifier of the requester
139
+ * @returns the {@link Requester} object corresponding to the ID, or `null` if no matching
140
+ * requester is found
132
141
  */
133
142
  getRequester(id: string): Promise<Requester | null>;
134
143
  /**
135
- * Creates a new statistical context with the specified label, description, and filter
144
+ * Creates a new statistics context with the specified label, description, and filter
136
145
  * for the given requester.
137
- *
138
- * A context defines a scope for which call center statistics can be collected and analyzed
139
- * according to the specified filter criteria.
140
- *
141
- * @param requester - the requester for whom the context is being created
142
- * @param label - a short label identifying this context
143
- * @param description - a detailed description of the context
144
- * @param filter - the filter defining the selection criteria for the context
145
- * @returns the created `StatContext` if successful; `null` otherwise
146
+ * <p>
147
+ * A context defines the filter criteria (pilots, agents, queues) for which call-center
148
+ * statistics are collected and analyzed.
149
+ *
150
+ * @param requester the requester for whom the context is created
151
+ * @param label a short label identifying this context
152
+ * @param description a detailed description of the context
153
+ * @param filter the filter defining the selection criteria for the context
154
+ * @returns the created {@link StatsContext} if successful; `null` otherwise
146
155
  */
147
156
  createContext(requester: Requester, label: string, description: string, filter: StatsFilter): Promise<StatsContext | null>;
148
157
  /**
149
- * Deletes all statistical contexts associated with the specified requester.
150
- *
151
- * A context defines a scope for collecting and analyzing call center statistics
152
- * according to its associated filter criteria.
153
- *
154
- * @param requester - The requester whose contexts should be deleted.
155
- * @returns `true` if all contexts were successfully deleted; `false`
156
- * if an error occurred or no contexts were deleted.
158
+ * Deletes all statistics contexts associated with the specified requester.
157
159
  *
160
+ * @param requester the requester whose contexts should be deleted
161
+ * @returns `true` if all contexts were successfully deleted; `false` if an error occurred
162
+ * or no contexts were deleted
158
163
  * @see createContext
159
164
  */
160
165
  deleteContexts(requester: Requester): Promise<boolean>;
161
166
  /**
162
- * Retrieves the statistical contexts created for the specified requester.
163
- *
164
- * Each context defines a scope for collecting and analyzing call center statistics
165
- * according to its associated filter criteria.
167
+ * Retrieves all statistics contexts created for the specified requester.
166
168
  *
167
- * @param requester - The requester whose contexts are being retrieved.
168
- * @returns An array of `Context` objects if successful; `null`
169
- * if there is an error or if no contexts exist for this requester.
169
+ * @param requester the requester whose contexts are retrieved
170
+ * @returns an array of {@link StatsContext} objects if successful; `null` if there is an
171
+ * error or if no contexts exist for this requester
170
172
  * @see createContext
171
173
  */
172
174
  getContexts(requester: Requester): Promise<StatsContext[] | null>;
173
175
  /**
174
- * Retrieves a statistical context by its identifier for the specified requester.
176
+ * Retrieves a statistics context by its identifier for the specified requester.
175
177
  *
176
- * A context defines a scope for collecting and analyzing call center statistics
177
- * according to its associated filter criteria.
178
- *
179
- * @param requester - The requester who owns the context.
180
- * @param contextId - The unique identifier of the context.
181
- * @returns The {@link StatsContext} if found and retrieval is successful; `null`
182
- * if there is an error or if no context exists with the specified identifier.
178
+ * @param requester the requester who owns the context
179
+ * @param contextId the unique identifier of the context
180
+ * @returns the {@link StatsContext} if found; `null` if no context exists with the
181
+ * specified identifier or if an error occurred
183
182
  */
184
183
  getContext(requester: Requester, contextId: string): Promise<StatsContext | null>;
185
184
  /**
186
- * Deletes the specified statistical context.
187
- *
188
- * A context defines a scope for collecting and analyzing call center statistics
189
- * according to its associated filter criteria.
185
+ * Deletes the specified statistics context.
190
186
  *
191
- * @param context - The context to be deleted.
192
- * @returns `true` if the context was successfully deleted; `false`
193
- * if an error occurred or the context could not be deleted.
194
- * @see createContext(requester: Requester, name: string, description: string, filter: Filter)
187
+ * @param context the context to delete
188
+ * @returns `true` if the context was successfully deleted; `false` if an error occurred or
189
+ * the context could not be deleted
190
+ * @see createContext
195
191
  */
196
192
  deleteContext(context: StatsContext): Promise<boolean>;
197
193
  /**
198
- * Retrieves statistical data for the specified context.
199
- *
200
- * This method generates a multi-day report corresponding to the time range
201
- * defined by the provided {@link DateRange}. It allows reporting and analysis
202
- * of call center metrics across multiple days within the selected period.
203
- *
204
- * The returned {@link StatisticsData} object contains the aggregated data,
205
- * suitable for further processing or integration.
206
- *
207
- * @param context - The context defining the scope and filters for the statistics.
208
- * @param range - The date range over which to collect statistics.
209
- * @param shortHeader - True to return only limited number of headers in response
210
- * @returns A {@link StatisticsData} object containing the data,
211
- * or `null` if the data could not be retrieved.
194
+ * Returns aggregated statistics for a range of days.
195
+ * <p>
196
+ * Multi-day reports provide one row of aggregated data per agent or pilot per day.
197
+ * The range can cover up to 31 consecutive days within the last 12 months and may span
198
+ * month boundaries.
199
+ *
200
+ * @param context the context defining the scope and filters for the statistics
201
+ * @param range the date range over which to collect statistics
202
+ * @param shortHeader `true` to return only a limited number of headers in the response
203
+ * @returns a {@link StatisticsData} object containing the aggregated data, or `null` if the
204
+ * data could not be retrieved
212
205
  */
213
206
  getDaysData(context: StatsContext, range: DateRange, shortHeader?: boolean): Promise<StatisticsData | null>;
214
207
  /**
215
- * Retrieves statistical data for the specified context for a single day.
216
- *
217
- * The statistics are provided in time slots according to the `timeInterval` parameter.
218
- *
219
- * - If `date` is not provided, the current day is used.
220
- * - If `timeInterval` is not provided or `undefined`, it is ignored and
221
- * `TimeInterval.QUARTE_HOUR` is used as the default value.
222
- *
223
- * @param context - The context defining the scope and filters for the statistics
224
- * @param date - (Optional) The specific day for which to collect statistics; defaults to today if not provided
225
- * @param timeInterval - (Optional) The time slot interval for reporting (e.g., 15 or 30 minutes);
226
- * defaults to `TimeInterval.QUARTE_HOUR` if not provided
227
- * @param shortHeader - True to return only limited number of headers in response
228
- * @returns A `StatisticsData` object containing the data, or `null` if the data could not be retrieved
208
+ * Returns statistics for a single day.
209
+ * <p>
210
+ * Statistics are provided in time slots according to the `timeInterval` parameter,
211
+ * spanning from 00:00 until the last completed interval of the specified day.
212
+ * <p>
213
+ * If `date` is not provided, the current day is used. If `timeInterval` is not provided,
214
+ * `TimeInterval.QUARTE_HOUR` (15-minute slots) is used as the default.
215
+ *
216
+ * @param context the context defining the scope and filters for the statistics
217
+ * @param date (optional) the day for which to collect statistics; defaults to today
218
+ * @param timeInterval (optional) the time slot interval for reporting (e.g., 15 or 30 minutes);
219
+ * defaults to `TimeInterval.QUARTE_HOUR`
220
+ * @param shortHeader `true` to return only a limited number of headers in the response
221
+ * @returns a {@link StatisticsData} object containing the data, or `null` if the data could
222
+ * not be retrieved
229
223
  */
230
224
  getDayData(context: StatsContext, date?: Date, timeInterval?: TimeInterval, shortHeader?: boolean): Promise<StatisticsData | null>;
231
225
  /**
232
- * Asynchronously retrieves statistical data for the specified context for a single day
233
- * and stores it as a report file in the given directory.
226
+ * Asynchronously downloads statistics for a single day as a report file.
227
+ * <p>
228
+ * The server generates the file asynchronously. The result is delivered as a ZIP archive
229
+ * whose single entry is extracted and saved into the specified directory. The returned
230
+ * `Promise` resolves when the extracted file has been saved to disk.
234
231
  * <p>
235
- * The statistics are reported in time slots defined by the `timeInterval` parameter,
232
+ * Statistics are reported in time slots defined by the `timeInterval` parameter,
236
233
  * spanning from 00:00 until the last completed interval of the specified day.
237
234
  * <p>
238
235
  * Only one report generation request can be active at a time. Use
239
- * {@link hasAsyncRequestInProgress} to check before calling this method. Any attempt
240
- * to start another request while one is already in progress will reject the returned
241
- * `Promise` with an `Error`.
236
+ * {@link hasAsyncRequestInProgress} to check before calling this method. Any attempt to
237
+ * start another request while one is already in progress will reject the returned `Promise`
238
+ * with an `Error`.
242
239
  *
243
240
  * @example
244
241
  * ```typescript
@@ -261,27 +258,33 @@ export declare class CallCenterStatistics {
261
258
  *
262
259
  * @param context the context defining the scope and filters for the statistics
263
260
  * @param date the date for which to generate the report
264
- * @param timeInterval the length of each reporting interval within the day
261
+ * @param timeInterval the length of each reporting time slot within the day
265
262
  * @param format the output format for the report file
266
- * @param shortHeader true to return only limited number of headers in response
263
+ * @param shortHeader `true` to return only a limited number of headers in the response
267
264
  * @param directory the directory in which to save the generated report file
268
265
  * @param progressCallback optional callback invoked to report progress of the operation
269
- * @returns a `Promise` that resolves with the path to the generated report file,
270
- * or rejects if an error occurs, the operation is cancelled, or another
271
- * request is already in progress
266
+ * @returns a `Promise` that resolves with the path to the generated report file, or rejects
267
+ * if an error occurs, the operation is cancelled, or another request is already in
268
+ * progress
272
269
  * @see getDaysFileData
273
270
  * @see hasAsyncRequestInProgress
274
271
  * @see cancelRequest
275
272
  */
276
273
  getDayFileData(context: StatsContext, date: Date, timeInterval: TimeInterval, format: StatsFormat, shortHeader: boolean | undefined, directory: string, progressCallback?: ProgressCallback): Promise<string>;
277
274
  /**
278
- * Asynchronously retrieves statistical data for the specified context over a date range
279
- * and stores it as a report file in the given directory.
275
+ * Asynchronously downloads statistics for a range of days as a report file.
276
+ * <p>
277
+ * The server generates the file asynchronously. The result is delivered as a ZIP archive
278
+ * whose single entry is extracted and saved into the specified directory. The returned
279
+ * `Promise` resolves when the extracted file has been saved to disk.
280
+ * <p>
281
+ * Multi-day reports provide one row of aggregated data per agent or pilot per day. The range
282
+ * can cover up to 31 consecutive days within the last 12 months and may span month boundaries.
280
283
  * <p>
281
284
  * Only one report generation request can be active at a time. Use
282
- * {@link hasAsyncRequestInProgress} to check before calling this method. Any attempt
283
- * to start another request while one is already in progress will reject the returned
284
- * `Promise` with an `Error`.
285
+ * {@link hasAsyncRequestInProgress} to check before calling this method. Any attempt to
286
+ * start another request while one is already in progress will reject the returned `Promise`
287
+ * with an `Error`.
285
288
  *
286
289
  * @example
287
290
  * ```typescript
@@ -308,37 +311,36 @@ export declare class CallCenterStatistics {
308
311
  * @param context the context defining the scope and filters for the statistics
309
312
  * @param range the date range over which to collect statistics
310
313
  * @param format the output format for the report file
311
- * @param shortHeader true to return only limited number of headers in response
314
+ * @param shortHeader `true` to return only a limited number of headers in the response
312
315
  * @param directory the directory in which to save the generated report file
313
316
  * @param progressCallback optional callback invoked to report progress of the operation
314
- * @returns a `Promise` that resolves with the path to the generated report file,
315
- * or rejects if an error occurs, the operation is cancelled, or another
316
- * request is already in progress
317
+ * @returns a `Promise` that resolves with the path to the generated report file, or rejects
318
+ * if an error occurs, the operation is cancelled, or another request is already in
319
+ * progress
317
320
  * @see getDayFileData
318
321
  * @see hasAsyncRequestInProgress
319
322
  * @see cancelRequest
320
323
  */
321
324
  getDaysFileData(context: StatsContext, range: DateRange, format: StatsFormat, shortHeader: boolean | undefined, directory: string, progressCallback?: ProgressCallback): Promise<string>;
322
325
  /**
323
- * Attempts to cancel an ongoing statistics report generation for the specified context.
324
- *
325
- * If a report generation process for the given `context` is currently running,
326
- * this method will attempt to stop it. Cancellation may succeed only if the process
327
- * has not already completed.
328
- *
326
+ * Attempts to cancel an ongoing asynchronous statistics report generation for the
327
+ * specified context.
328
+ * <p>
329
+ * Cancellation may succeed only if the server-side process has not already completed.
329
330
  * The method returns immediately and does not block until the process is fully terminated.
330
331
  *
331
- * @param context - The context identifying the report generation process to cancel
332
- * @returns `true` if a running report generation was found and successfully requested to be cancelled,
333
- * `false` if there was no running process for the specified context or if it could not be cancelled
332
+ * @param context the context identifying the report generation process to cancel
333
+ * @returns `true` if a running request was found and cancellation was successfully requested;
334
+ * `false` if there was no running process for the specified context or if it could
335
+ * not be cancelled
334
336
  */
335
337
  cancelRequest(context: StatsContext): Promise<boolean>;
336
338
  /**
337
- * Creates a new recurrent scheduled report with the specified configuration.
339
+ * Creates a new recurring scheduled report with the specified configuration.
338
340
  * <p>
339
- * The report will be generated repeatedly according to the given `recurrence`
340
- * pattern and `observationPeriod`, formatted in the specified output format,
341
- * and sent to the provided recipients.
341
+ * The report is generated repeatedly according to the given `recurrence` pattern and
342
+ * `observationPeriod`, formatted in the specified output format, and sent as a ZIP file
343
+ * attachment to the provided recipients.
342
344
  *
343
345
  * @example
344
346
  * ```typescript
@@ -363,11 +365,11 @@ export declare class CallCenterStatistics {
363
365
  * @param context the context defining which data and counters to include
364
366
  * @param id a unique identifier for the scheduled report
365
367
  * @param description a human-readable description of the report
366
- * @param observationPeriod the period over which statistics are collected
368
+ * @param observationPeriod the observation period over which statistics are collected
367
369
  * @param recurrence the recurrence pattern for generating the report
368
370
  * @param format the output format of the report
369
371
  * @param recipients the list of email addresses to receive the report
370
- * @returns the newly created {@link ScheduledReport} on success; `null` otherwise.
372
+ * @returns the newly created {@link ScheduledReport} on success; `null` otherwise
371
373
  * @see createOneTimeScheduledReport
372
374
  * @see deleteScheduledReport
373
375
  * @see setScheduledReportEnabled
@@ -376,8 +378,8 @@ export declare class CallCenterStatistics {
376
378
  /**
377
379
  * Creates a new one-time scheduled report with the specified configuration.
378
380
  * <p>
379
- * Unlike {@link createRecurrentScheduledReport}, this report is generated only
380
- * once for the specified `observationPeriod`, then it is no longer active.
381
+ * Unlike {@link createRecurrentScheduledReport}, this report is generated only once for
382
+ * the specified `observationPeriod` and is no longer active afterwards.
381
383
  *
382
384
  * @example
383
385
  * ```typescript
@@ -395,59 +397,54 @@ export declare class CallCenterStatistics {
395
397
  * @param context the context defining which data and counters to include
396
398
  * @param id a unique identifier for the scheduled report
397
399
  * @param description a human-readable description of the report
398
- * @param observationPeriod the period over which statistics are collected
400
+ * @param observationPeriod the observation period over which statistics are collected
399
401
  * @param format the output format of the report
400
402
  * @param recipients the list of email addresses to receive the report
401
- * @returns the newly created {@link ScheduledReport} on success; `null` otherwise.
403
+ * @returns the newly created {@link ScheduledReport} on success; `null` otherwise
402
404
  * @see createRecurrentScheduledReport
403
405
  * @see deleteScheduledReport
404
406
  */
405
407
  createOneTimeScheduledReport(context: StatsContext, id: string, description: string, observationPeriod: ReportObservationPeriod, format: StatsFormat, recipients: string[]): Promise<ScheduledReport | null>;
406
408
  /**
407
- * Returns all scheduled reports associated with the given context.
409
+ * Returns all scheduled reports associated with the specified context.
408
410
  *
409
- * @param context - The context defining which reports to retrieve
410
- * @returns An array of {@link ScheduledReport} objects for the specified context;
411
- * may be empty if no reports exist
411
+ * @param context the context whose reports are retrieved
412
+ * @returns an array of {@link ScheduledReport} objects, or `null` on failure
412
413
  */
413
414
  getScheduledReports(context: StatsContext): Promise<ScheduledReport[] | null>;
414
415
  /**
415
416
  * Deletes the specified scheduled report.
416
417
  *
417
- * @param report The scheduled report to delete.
418
- * @returns `true` if the report was successfully deleted, `false` otherwise.
418
+ * @param report the scheduled report to delete
419
+ * @returns `true` if the report was successfully deleted; `false` otherwise
419
420
  */
420
421
  deleteScheduledReport(report: ScheduledReport): Promise<boolean>;
421
422
  /**
422
423
  * Enables or disables the specified scheduled report.
423
424
  *
424
- * @param report The scheduled report to update.
425
- * @param enabled `true` to enable the report, `false` to disable it.
426
- * @returns `true` if the report state was successfully updated, `false` otherwise.
425
+ * @param report the scheduled report to update
426
+ * @param enabled `true` to enable the report; `false` to disable it
427
+ * @returns `true` if the report state was successfully updated; `false` otherwise
427
428
  */
428
429
  setScheduledReportEnabled(report: ScheduledReport, enabled: boolean): Promise<boolean>;
429
430
  /**
430
- * Retrieves a previously created scheduled report by its unique identifier.
431
- *
432
- * This method requires a valid `StatsContext` to perform the retrieval operation.
433
- * The `scheduleReportId` must correspond to an existing scheduled report.
431
+ * Returns the scheduled report with the specified identifier.
434
432
  *
435
- * @param context The session context used to access the service.
436
- * @param scheduleReportId The unique identifier of the scheduled report to retrieve.
437
- * @returns The `ScheduledReport` corresponding to the specified ID,
438
- * or `null` if no report exists with that ID.
433
+ * @param context the statistics context that owns the report
434
+ * @param scheduleReportId the unique identifier of the scheduled report to retrieve
435
+ * @returns the {@link ScheduledReport} corresponding to the specified ID, or `null` if no
436
+ * report exists with that ID
439
437
  */
440
438
  getScheduledReport(context: StatsContext, scheduleReportId: string): Promise<ScheduledReport | null>;
441
439
  /**
442
- * Updates the configuration of an existing scheduled report.
443
- *
444
- * This method persists any changes made to the provided `ScheduledReport` instance,
445
- * including its description, observation period, recurrence, format, and recipients.
446
- * Implementations should ensure that the report exists and that the updates are valid.
440
+ * Persists any changes made to the specified scheduled report.
441
+ * <p>
442
+ * Fields that can be updated include the description, observation period, recurrence
443
+ * pattern, output format, and recipient list.
447
444
  *
448
- * @param report The `ScheduledReport` instance containing the updated information.
449
- * @returns `true` if the update was successful; `false` if the report does not exist
450
- * or the update could not be applied.
445
+ * @param report the {@link ScheduledReport} instance containing the updated fields
446
+ * @returns `true` if the update was successful; `false` if the report does not exist or
447
+ * the update could not be applied
451
448
  */
452
449
  updateScheduledReport(report: ScheduledReport): Promise<boolean>;
453
450
  }
@@ -1 +1 @@
1
- {"version":3,"file":"o2g-cc-stat.d.ts","sourceRoot":"","sources":["../../../src/services/o2g-cc-stat.ts"],"names":[],"mappings":"AAoBA,OAAO,EAAE,cAAc,EAAE,MAAM,mCAAmC,CAAC;AACnE,OAAO,EAAE,gBAAgB,EAAE,MAAM,4CAA4C,CAAC;AAC9E,OAAO,EAAE,QAAQ,EAAE,MAAM,4BAA4B,CAAC;AACtD,OAAO,EAAE,SAAS,EAAE,MAAM,6BAA6B,CAAC;AACxD,OAAO,EAAE,eAAe,EAAE,MAAM,8CAA8C,CAAC;AAC/E,OAAO,EAAE,WAAW,EAAE,MAAM,gCAAgC,CAAC;AAC7D,OAAO,EAAE,YAAY,EAAE,MAAM,iCAAiC,CAAC;AAC/D,OAAO,EAAE,WAAW,EAAE,MAAM,gCAAgC,CAAC;AAC7D,OAAO,EAAE,YAAY,EAAE,MAAM,iCAAiC,CAAC;AAC/D,OAAO,EAAE,SAAS,EAAE,MAAM,4BAA4B,CAAC;AACvD,OAAO,EAAE,UAAU,EAAE,MAAM,wCAAwC,CAAC;AACpE,OAAO,EAAE,uBAAuB,EAAE,MAAM,+CAA+C,CAAC;AAExF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;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"}
1
+ {"version":3,"file":"o2g-cc-stat.d.ts","sourceRoot":"","sources":["../../../src/services/o2g-cc-stat.ts"],"names":[],"mappings":"AAoBA,OAAO,EAAE,cAAc,EAAE,MAAM,mCAAmC,CAAC;AACnE,OAAO,EAAE,gBAAgB,EAAE,MAAM,4CAA4C,CAAC;AAC9E,OAAO,EAAE,QAAQ,EAAE,MAAM,4BAA4B,CAAC;AACtD,OAAO,EAAE,SAAS,EAAE,MAAM,6BAA6B,CAAC;AACxD,OAAO,EAAE,eAAe,EAAE,MAAM,8CAA8C,CAAC;AAC/E,OAAO,EAAE,WAAW,EAAE,MAAM,gCAAgC,CAAC;AAC7D,OAAO,EAAE,YAAY,EAAE,MAAM,iCAAiC,CAAC;AAC/D,OAAO,EAAE,WAAW,EAAE,MAAM,gCAAgC,CAAC;AAC7D,OAAO,EAAE,YAAY,EAAE,MAAM,iCAAiC,CAAC;AAC/D,OAAO,EAAE,SAAS,EAAE,MAAM,4BAA4B,CAAC;AACvD,OAAO,EAAE,UAAU,EAAE,MAAM,wCAAwC,CAAC;AACpE,OAAO,EAAE,uBAAuB,EAAE,MAAM,+CAA+C,CAAC;AAExF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6DG;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;;;;;;;;;OASG;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;;;;;;;OAOG;IACG,cAAc,CAAC,SAAS,EAAE,SAAS,GAAG,OAAO,CAAC,OAAO,CAAC;IAI5D;;;;;;;OAOG;IACG,WAAW,CAAC,SAAS,EAAE,SAAS,GAAG,OAAO,CAAC,YAAY,EAAE,GAAG,IAAI,CAAC;IAIvE;;;;;;;OAOG;IACG,UAAU,CAAC,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,GAAG,IAAI,CAAC;IAIvF;;;;;;;OAOG;IACG,aAAa,CAAC,OAAO,EAAE,YAAY,GAAG,OAAO,CAAC,OAAO,CAAC;IAI5D;;;;;;;;;;;;OAYG;IACG,WAAW,CAAC,OAAO,EAAE,YAAY,EAAE,KAAK,EAAE,SAAS,EAAE,WAAW,GAAE,OAAe,GAAG,OAAO,CAAC,cAAc,GAAG,IAAI,CAAC;IAIxH;;;;;;;;;;;;;;;;OAgBG;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;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+CG;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;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiDG;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;;;;;;;;;;;OAWG;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;;;;;OAKG;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;;;;;;;OAOG;IACG,kBAAkB,CAAC,OAAO,EAAE,YAAY,EAAE,gBAAgB,EAAE,MAAM,GAAG,OAAO,CAAC,eAAe,GAAG,IAAI,CAAC;IAI1G;;;;;;;;;OASG;IACG,qBAAqB,CAAC,MAAM,EAAE,eAAe,GAAG,OAAO,CAAC,OAAO,CAAC;CAGzE"}