@produce8/analytics-openapi-types 1.0.0 → 1.0.2
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.
- package/openapi-types.ts +726 -2
- package/package.json +1 -1
package/openapi-types.ts
CHANGED
|
@@ -11,6 +11,7 @@ export interface paths {
|
|
|
11
11
|
path?: never;
|
|
12
12
|
cookie?: never;
|
|
13
13
|
};
|
|
14
|
+
/** Health check endpoint */
|
|
14
15
|
get: operations["HealthController_healthCheck"];
|
|
15
16
|
put?: never;
|
|
16
17
|
post?: never;
|
|
@@ -20,10 +21,511 @@ export interface paths {
|
|
|
20
21
|
patch?: never;
|
|
21
22
|
trace?: never;
|
|
22
23
|
};
|
|
24
|
+
"/get-user-real-time-working-sessions": {
|
|
25
|
+
parameters: {
|
|
26
|
+
query?: never;
|
|
27
|
+
header?: never;
|
|
28
|
+
path?: never;
|
|
29
|
+
cookie?: never;
|
|
30
|
+
};
|
|
31
|
+
get: operations["RealTimeWorkingSessionsController_getRealTimeWorkingSessions"];
|
|
32
|
+
put?: never;
|
|
33
|
+
post?: never;
|
|
34
|
+
delete?: never;
|
|
35
|
+
options?: never;
|
|
36
|
+
head?: never;
|
|
37
|
+
patch?: never;
|
|
38
|
+
trace?: never;
|
|
39
|
+
};
|
|
40
|
+
"/app-usage-metrics": {
|
|
41
|
+
parameters: {
|
|
42
|
+
query?: never;
|
|
43
|
+
header?: never;
|
|
44
|
+
path?: never;
|
|
45
|
+
cookie?: never;
|
|
46
|
+
};
|
|
47
|
+
get: operations["AppUsageReportController_getAppUsageMetrics"];
|
|
48
|
+
put?: never;
|
|
49
|
+
post?: never;
|
|
50
|
+
delete?: never;
|
|
51
|
+
options?: never;
|
|
52
|
+
head?: never;
|
|
53
|
+
patch?: never;
|
|
54
|
+
trace?: never;
|
|
55
|
+
};
|
|
56
|
+
"/app-usage-metrics/highlights": {
|
|
57
|
+
parameters: {
|
|
58
|
+
query?: never;
|
|
59
|
+
header?: never;
|
|
60
|
+
path?: never;
|
|
61
|
+
cookie?: never;
|
|
62
|
+
};
|
|
63
|
+
get: operations["AppUsageReportController_getAppUsageMetricsHighlights"];
|
|
64
|
+
put?: never;
|
|
65
|
+
post?: never;
|
|
66
|
+
delete?: never;
|
|
67
|
+
options?: never;
|
|
68
|
+
head?: never;
|
|
69
|
+
patch?: never;
|
|
70
|
+
trace?: never;
|
|
71
|
+
};
|
|
72
|
+
"/app-usage-metrics/search": {
|
|
73
|
+
parameters: {
|
|
74
|
+
query?: never;
|
|
75
|
+
header?: never;
|
|
76
|
+
path?: never;
|
|
77
|
+
cookie?: never;
|
|
78
|
+
};
|
|
79
|
+
get: operations["AppUsageReportController_searchAppUsageMetrics"];
|
|
80
|
+
put?: never;
|
|
81
|
+
post?: never;
|
|
82
|
+
delete?: never;
|
|
83
|
+
options?: never;
|
|
84
|
+
head?: never;
|
|
85
|
+
patch?: never;
|
|
86
|
+
trace?: never;
|
|
87
|
+
};
|
|
23
88
|
}
|
|
24
89
|
export type webhooks = Record<string, never>;
|
|
25
90
|
export interface components {
|
|
26
|
-
schemas:
|
|
91
|
+
schemas: {
|
|
92
|
+
RealTimeWorkingSessionsRequestDto: {
|
|
93
|
+
/**
|
|
94
|
+
* Format: uuid
|
|
95
|
+
* @description User ID (UUID)
|
|
96
|
+
* @example 123e4567-e89b-12d3-a456-426614174000
|
|
97
|
+
*/
|
|
98
|
+
userId: string;
|
|
99
|
+
/**
|
|
100
|
+
* Format: uuid
|
|
101
|
+
* @description Account ID (UUID)
|
|
102
|
+
* @example 123e4567-e89b-12d3-a456-426614174000
|
|
103
|
+
*/
|
|
104
|
+
accountId: string;
|
|
105
|
+
/**
|
|
106
|
+
* Format: date
|
|
107
|
+
* @description Date in YYYY-MM-DD format
|
|
108
|
+
* @example 2025-11-22
|
|
109
|
+
*/
|
|
110
|
+
date: string;
|
|
111
|
+
/**
|
|
112
|
+
* @description UTC offset in format: UTC, UTC-8, UTC+5, etc.
|
|
113
|
+
* @example UTC-8
|
|
114
|
+
*/
|
|
115
|
+
utcOffset: string;
|
|
116
|
+
};
|
|
117
|
+
RealTimeWorkingSessionItemDto: {
|
|
118
|
+
/**
|
|
119
|
+
* Format: uuid
|
|
120
|
+
* @description Session identifier (UUID)
|
|
121
|
+
*/
|
|
122
|
+
id: string;
|
|
123
|
+
/**
|
|
124
|
+
* Format: uuid
|
|
125
|
+
* @description Account identifier (UUID)
|
|
126
|
+
*/
|
|
127
|
+
accountId: string;
|
|
128
|
+
/**
|
|
129
|
+
* Format: uuid
|
|
130
|
+
* @description User identifier (UUID)
|
|
131
|
+
*/
|
|
132
|
+
userId: string;
|
|
133
|
+
/**
|
|
134
|
+
* Format: date-time
|
|
135
|
+
* @description Session start time in local timezone (ISO 8601)
|
|
136
|
+
*/
|
|
137
|
+
localStartTime: string;
|
|
138
|
+
/**
|
|
139
|
+
* Format: date-time
|
|
140
|
+
* @description Session end time in local timezone (ISO 8601)
|
|
141
|
+
*/
|
|
142
|
+
localEndTime: string;
|
|
143
|
+
/** @description Total session duration in milliseconds */
|
|
144
|
+
sessionDuration: number;
|
|
145
|
+
/** @description Number of activities in the session */
|
|
146
|
+
activityCount: number;
|
|
147
|
+
/** @description Total activity duration in milliseconds */
|
|
148
|
+
activityDuration: number;
|
|
149
|
+
/** @description Number of calls in the session */
|
|
150
|
+
callCount: number;
|
|
151
|
+
/** @description Total call duration in milliseconds */
|
|
152
|
+
callDuration: number;
|
|
153
|
+
/** @description Number of context switches in the session */
|
|
154
|
+
contextSwitchCount: number;
|
|
155
|
+
/** @description Focus score (0-100) */
|
|
156
|
+
focusScore: number;
|
|
157
|
+
/** @description Intensity score (0-100) */
|
|
158
|
+
intensityScore: number;
|
|
159
|
+
/** @description User's timezone (e.g., 'America/New_York', 'UTC') */
|
|
160
|
+
timezone: string;
|
|
161
|
+
/**
|
|
162
|
+
* Format: date
|
|
163
|
+
* @description Session date in YYYY-MM-DD format
|
|
164
|
+
*/
|
|
165
|
+
localStartDate: string;
|
|
166
|
+
};
|
|
167
|
+
RealTimeWorkingSessionsResponseDto: {
|
|
168
|
+
/** @description Array of working sessions */
|
|
169
|
+
sessions: components["schemas"]["RealTimeWorkingSessionItemDto"][];
|
|
170
|
+
/** @description Total count of sessions */
|
|
171
|
+
count: number;
|
|
172
|
+
};
|
|
173
|
+
AppUsageMetricsReportRequestDto: {
|
|
174
|
+
/**
|
|
175
|
+
* @description Averaging period for metrics
|
|
176
|
+
* @enum {string}
|
|
177
|
+
*/
|
|
178
|
+
averagingPeriod: "day" | "week" | "month" | "quarter" | "year";
|
|
179
|
+
/**
|
|
180
|
+
* @description Averaging type (total or perUser)
|
|
181
|
+
* @enum {string}
|
|
182
|
+
*/
|
|
183
|
+
averagingType: "total" | "perUser";
|
|
184
|
+
/**
|
|
185
|
+
* Format: date
|
|
186
|
+
* @description Start date for the metrics period
|
|
187
|
+
*/
|
|
188
|
+
startDate: string;
|
|
189
|
+
/**
|
|
190
|
+
* Format: date
|
|
191
|
+
* @description End date for the metrics period
|
|
192
|
+
*/
|
|
193
|
+
endDate?: string;
|
|
194
|
+
/** @description Filter by user IDs */
|
|
195
|
+
userIds?: string[];
|
|
196
|
+
/**
|
|
197
|
+
* Format: uuid
|
|
198
|
+
* @description Filter by department ID
|
|
199
|
+
*/
|
|
200
|
+
departmentId?: string;
|
|
201
|
+
/**
|
|
202
|
+
* Format: uuid
|
|
203
|
+
* @description Filter by workspace ID
|
|
204
|
+
*/
|
|
205
|
+
workspaceId?: string;
|
|
206
|
+
/**
|
|
207
|
+
* Format: uuid
|
|
208
|
+
* @description Filter by app category ID
|
|
209
|
+
*/
|
|
210
|
+
appCategoryId?: string;
|
|
211
|
+
/** @description Filter by app IDs */
|
|
212
|
+
appIds?: string[];
|
|
213
|
+
/**
|
|
214
|
+
* Format: uuid
|
|
215
|
+
* @description Filter by account ID
|
|
216
|
+
*/
|
|
217
|
+
accountId?: string;
|
|
218
|
+
/**
|
|
219
|
+
* Format: date
|
|
220
|
+
* @description Start date for comparison period
|
|
221
|
+
*/
|
|
222
|
+
comparisonStartDate?: string;
|
|
223
|
+
/**
|
|
224
|
+
* Format: date
|
|
225
|
+
* @description End date for comparison period
|
|
226
|
+
*/
|
|
227
|
+
comparisonEndDate?: string;
|
|
228
|
+
/** @description Hourly rate for cost calculation */
|
|
229
|
+
hourlyRate?: number;
|
|
230
|
+
/** @description Number of items to return */
|
|
231
|
+
first?: number;
|
|
232
|
+
/** @description Cursor for pagination */
|
|
233
|
+
after?: number;
|
|
234
|
+
/**
|
|
235
|
+
* @description Field to sort by
|
|
236
|
+
* @enum {string}
|
|
237
|
+
*/
|
|
238
|
+
sortField?: "appName" | "appCreatedDate" | "appCategoryName" | "uniqueUsers" | "uniqueUsersDeviation" | "duration" | "durationDeviation" | "interactions" | "interactionsDeviation" | "cost" | "costDeviation";
|
|
239
|
+
/**
|
|
240
|
+
* @description Sort direction
|
|
241
|
+
* @enum {string}
|
|
242
|
+
*/
|
|
243
|
+
sortDirection?: "ASC" | "DESC";
|
|
244
|
+
/**
|
|
245
|
+
* @description Type of metric to retrieve
|
|
246
|
+
* @enum {string}
|
|
247
|
+
*/
|
|
248
|
+
metricType: "uniqueUsers" | "duration" | "interactions" | "cost";
|
|
249
|
+
};
|
|
250
|
+
AppUsageMetricsHighlightsRequestDto: {
|
|
251
|
+
/**
|
|
252
|
+
* @description Averaging period for metrics
|
|
253
|
+
* @enum {string}
|
|
254
|
+
*/
|
|
255
|
+
averagingPeriod: "day" | "week" | "month" | "quarter" | "year";
|
|
256
|
+
/**
|
|
257
|
+
* @description Averaging type (total or perUser)
|
|
258
|
+
* @enum {string}
|
|
259
|
+
*/
|
|
260
|
+
averagingType: "total" | "perUser";
|
|
261
|
+
/**
|
|
262
|
+
* Format: date
|
|
263
|
+
* @description Start date for the metrics period
|
|
264
|
+
*/
|
|
265
|
+
startDate: string;
|
|
266
|
+
/**
|
|
267
|
+
* Format: date
|
|
268
|
+
* @description End date for the metrics period
|
|
269
|
+
*/
|
|
270
|
+
endDate?: string;
|
|
271
|
+
/** @description Filter by user IDs */
|
|
272
|
+
userIds?: string[];
|
|
273
|
+
/**
|
|
274
|
+
* Format: uuid
|
|
275
|
+
* @description Filter by department ID
|
|
276
|
+
*/
|
|
277
|
+
departmentId?: string;
|
|
278
|
+
/**
|
|
279
|
+
* Format: uuid
|
|
280
|
+
* @description Filter by workspace ID
|
|
281
|
+
*/
|
|
282
|
+
workspaceId?: string;
|
|
283
|
+
/**
|
|
284
|
+
* Format: uuid
|
|
285
|
+
* @description Filter by app category ID
|
|
286
|
+
*/
|
|
287
|
+
appCategoryId?: string;
|
|
288
|
+
/** @description Filter by app IDs */
|
|
289
|
+
appIds?: string[];
|
|
290
|
+
/**
|
|
291
|
+
* Format: uuid
|
|
292
|
+
* @description Filter by account ID
|
|
293
|
+
*/
|
|
294
|
+
accountId?: string;
|
|
295
|
+
/**
|
|
296
|
+
* Format: date
|
|
297
|
+
* @description Start date for comparison period
|
|
298
|
+
*/
|
|
299
|
+
comparisonStartDate: string;
|
|
300
|
+
/**
|
|
301
|
+
* Format: date
|
|
302
|
+
* @description End date for comparison period
|
|
303
|
+
*/
|
|
304
|
+
comparisonEndDate: string;
|
|
305
|
+
/** @description Hourly rate for cost calculation */
|
|
306
|
+
hourlyRate?: number;
|
|
307
|
+
/** @description Number of items to return */
|
|
308
|
+
first?: number;
|
|
309
|
+
/** @description Cursor for pagination */
|
|
310
|
+
after?: number;
|
|
311
|
+
/**
|
|
312
|
+
* @description Field to sort by
|
|
313
|
+
* @enum {string}
|
|
314
|
+
*/
|
|
315
|
+
sortField?: "appName" | "appCreatedDate" | "appCategoryName" | "uniqueUsers" | "uniqueUsersDeviation" | "duration" | "durationDeviation" | "interactions" | "interactionsDeviation" | "cost" | "costDeviation";
|
|
316
|
+
/**
|
|
317
|
+
* @description Sort direction
|
|
318
|
+
* @enum {string}
|
|
319
|
+
*/
|
|
320
|
+
sortDirection?: "ASC" | "DESC";
|
|
321
|
+
/**
|
|
322
|
+
* @description Type of metric to retrieve
|
|
323
|
+
* @enum {string}
|
|
324
|
+
*/
|
|
325
|
+
metricType: "uniqueUsers" | "duration" | "interactions" | "cost";
|
|
326
|
+
};
|
|
327
|
+
AppUsageMetricsSearchRequestDto: {
|
|
328
|
+
/** @description Search query string */
|
|
329
|
+
query: string;
|
|
330
|
+
/**
|
|
331
|
+
* @description Averaging period for metrics
|
|
332
|
+
* @enum {string}
|
|
333
|
+
*/
|
|
334
|
+
averagingPeriod: "day" | "week" | "month" | "quarter" | "year";
|
|
335
|
+
/**
|
|
336
|
+
* @description Averaging type (total or perUser)
|
|
337
|
+
* @enum {string}
|
|
338
|
+
*/
|
|
339
|
+
averagingType: "total" | "perUser";
|
|
340
|
+
/**
|
|
341
|
+
* Format: date
|
|
342
|
+
* @description Start date for the metrics period
|
|
343
|
+
*/
|
|
344
|
+
startDate: string;
|
|
345
|
+
/**
|
|
346
|
+
* Format: date
|
|
347
|
+
* @description End date for the metrics period
|
|
348
|
+
*/
|
|
349
|
+
endDate?: string;
|
|
350
|
+
/** @description Filter by user IDs */
|
|
351
|
+
userIds?: string[];
|
|
352
|
+
/**
|
|
353
|
+
* Format: uuid
|
|
354
|
+
* @description Filter by department ID
|
|
355
|
+
*/
|
|
356
|
+
departmentId?: string;
|
|
357
|
+
/**
|
|
358
|
+
* Format: uuid
|
|
359
|
+
* @description Filter by workspace ID
|
|
360
|
+
*/
|
|
361
|
+
workspaceId?: string;
|
|
362
|
+
/**
|
|
363
|
+
* Format: uuid
|
|
364
|
+
* @description Filter by app category ID
|
|
365
|
+
*/
|
|
366
|
+
appCategoryId?: string;
|
|
367
|
+
/** @description Filter by app IDs */
|
|
368
|
+
appIds?: string[];
|
|
369
|
+
/**
|
|
370
|
+
* Format: uuid
|
|
371
|
+
* @description Filter by account ID
|
|
372
|
+
*/
|
|
373
|
+
accountId?: string;
|
|
374
|
+
/** @description Hourly rate for cost calculation */
|
|
375
|
+
hourlyRate?: number;
|
|
376
|
+
/**
|
|
377
|
+
* Format: date
|
|
378
|
+
* @description Start date for comparison period
|
|
379
|
+
*/
|
|
380
|
+
comparisonStartDate?: string;
|
|
381
|
+
/**
|
|
382
|
+
* Format: date
|
|
383
|
+
* @description End date for comparison period
|
|
384
|
+
*/
|
|
385
|
+
comparisonEndDate?: string;
|
|
386
|
+
/** @description Number of items to return */
|
|
387
|
+
first?: number;
|
|
388
|
+
/** @description Cursor for pagination */
|
|
389
|
+
after?: number;
|
|
390
|
+
/**
|
|
391
|
+
* @description Field to sort by
|
|
392
|
+
* @enum {string}
|
|
393
|
+
*/
|
|
394
|
+
sortField?: "appName" | "appCreatedDate" | "appCategoryName" | "uniqueUsers" | "uniqueUsersDeviation" | "duration" | "durationDeviation" | "interactions" | "interactionsDeviation" | "cost" | "costDeviation";
|
|
395
|
+
/**
|
|
396
|
+
* @description Sort direction
|
|
397
|
+
* @enum {string}
|
|
398
|
+
*/
|
|
399
|
+
sortDirection?: "ASC" | "DESC";
|
|
400
|
+
/**
|
|
401
|
+
* @description Type of metric to retrieve
|
|
402
|
+
* @enum {string}
|
|
403
|
+
*/
|
|
404
|
+
metricType: "uniqueUsers" | "duration" | "interactions" | "cost";
|
|
405
|
+
};
|
|
406
|
+
AppCategoryDto: {
|
|
407
|
+
/**
|
|
408
|
+
* Format: uuid
|
|
409
|
+
* @description App category ID
|
|
410
|
+
*/
|
|
411
|
+
id: string;
|
|
412
|
+
/** @description App category name */
|
|
413
|
+
name: string;
|
|
414
|
+
/** @description App category display name */
|
|
415
|
+
displayName: string;
|
|
416
|
+
/** @description App category color */
|
|
417
|
+
color: string;
|
|
418
|
+
/**
|
|
419
|
+
* Format: date-time
|
|
420
|
+
* @description Creation timestamp
|
|
421
|
+
*/
|
|
422
|
+
createdAt: string;
|
|
423
|
+
/**
|
|
424
|
+
* Format: date-time
|
|
425
|
+
* @description Last update timestamp
|
|
426
|
+
*/
|
|
427
|
+
updatedAt: string;
|
|
428
|
+
/**
|
|
429
|
+
* Format: date-time
|
|
430
|
+
* @description Deletion timestamp
|
|
431
|
+
*/
|
|
432
|
+
deletedAt?: string | null;
|
|
433
|
+
};
|
|
434
|
+
AppDto: {
|
|
435
|
+
/**
|
|
436
|
+
* Format: uuid
|
|
437
|
+
* @description App ID
|
|
438
|
+
*/
|
|
439
|
+
id: string;
|
|
440
|
+
/** @description App name */
|
|
441
|
+
appCategoryId: string;
|
|
442
|
+
/** @description App display color */
|
|
443
|
+
displayColor: string;
|
|
444
|
+
/** @description App logo URL */
|
|
445
|
+
logoUrl: string;
|
|
446
|
+
/** @description App logo background color */
|
|
447
|
+
logoBackgroundColor: string;
|
|
448
|
+
/**
|
|
449
|
+
* @description App status
|
|
450
|
+
* @enum {string}
|
|
451
|
+
*/
|
|
452
|
+
status: "ACTIVE" | "PENDING" | "INACTIVE";
|
|
453
|
+
/** @description App category information */
|
|
454
|
+
appCategory: components["schemas"]["AppCategoryDto"];
|
|
455
|
+
/**
|
|
456
|
+
* Format: date-time
|
|
457
|
+
* @description Creation timestamp
|
|
458
|
+
*/
|
|
459
|
+
createdAt: string;
|
|
460
|
+
/**
|
|
461
|
+
* Format: date-time
|
|
462
|
+
* @description Last update timestamp
|
|
463
|
+
*/
|
|
464
|
+
updatedAt: string;
|
|
465
|
+
/**
|
|
466
|
+
* Format: date-time
|
|
467
|
+
* @description Deletion timestamp
|
|
468
|
+
*/
|
|
469
|
+
deletedAt?: string | null;
|
|
470
|
+
};
|
|
471
|
+
MetricWithDeviationDto: {
|
|
472
|
+
/** @description Metric value */
|
|
473
|
+
value: number;
|
|
474
|
+
/** @description Comparison value from previous period */
|
|
475
|
+
comparisonValue?: number;
|
|
476
|
+
/** @description Deviation from comparison value */
|
|
477
|
+
deviation?: number;
|
|
478
|
+
};
|
|
479
|
+
AppUsageMetricsDto: {
|
|
480
|
+
/** @description App information */
|
|
481
|
+
app: components["schemas"]["AppDto"];
|
|
482
|
+
/** @description Unique users metric */
|
|
483
|
+
uniqueUsers: components["schemas"]["MetricWithDeviationDto"];
|
|
484
|
+
/** @description Duration metric (in seconds) */
|
|
485
|
+
duration: components["schemas"]["MetricWithDeviationDto"];
|
|
486
|
+
/** @description Interactions metric */
|
|
487
|
+
interactions: components["schemas"]["MetricWithDeviationDto"];
|
|
488
|
+
/** @description Cost metric (in cents) */
|
|
489
|
+
cost?: components["schemas"]["MetricWithDeviationDto"];
|
|
490
|
+
};
|
|
491
|
+
AppUsageMetricsListResponseDto: {
|
|
492
|
+
/** @description Array of app usage metrics */
|
|
493
|
+
data: components["schemas"]["AppUsageMetricsDto"][];
|
|
494
|
+
/**
|
|
495
|
+
* @description Averaging type used for the metrics
|
|
496
|
+
* @enum {string}
|
|
497
|
+
*/
|
|
498
|
+
averagingType: "total" | "perUser";
|
|
499
|
+
/** @description Number of items returned */
|
|
500
|
+
limit: number;
|
|
501
|
+
/** @description Whether there are more items available */
|
|
502
|
+
has_more: boolean;
|
|
503
|
+
/** @description Total count of items */
|
|
504
|
+
total_count: number;
|
|
505
|
+
};
|
|
506
|
+
AppUsageMetricsHighlightsDataDto: {
|
|
507
|
+
/** @description Top app by metric value */
|
|
508
|
+
topApp?: components["schemas"]["AppUsageMetricsDto"] | null;
|
|
509
|
+
/** @description App with biggest increase */
|
|
510
|
+
biggestIncrease?: components["schemas"]["AppUsageMetricsDto"] | null;
|
|
511
|
+
/** @description App with biggest decrease */
|
|
512
|
+
biggestDecrease?: components["schemas"]["AppUsageMetricsDto"] | null;
|
|
513
|
+
};
|
|
514
|
+
AppUsageMetricsHighlightsResponseDto: {
|
|
515
|
+
/**
|
|
516
|
+
* @description Averaging type used for the metrics
|
|
517
|
+
* @enum {string}
|
|
518
|
+
*/
|
|
519
|
+
averagingType: "total" | "perUser";
|
|
520
|
+
/**
|
|
521
|
+
* @description Type of metric used for highlights
|
|
522
|
+
* @enum {string}
|
|
523
|
+
*/
|
|
524
|
+
metricType: "uniqueUsers" | "duration" | "interactions" | "cost";
|
|
525
|
+
/** @description Highlights data */
|
|
526
|
+
data: components["schemas"]["AppUsageMetricsHighlightsDataDto"];
|
|
527
|
+
};
|
|
528
|
+
};
|
|
27
529
|
responses: never;
|
|
28
530
|
parameters: never;
|
|
29
531
|
requestBodies: never;
|
|
@@ -41,11 +543,233 @@ export interface operations {
|
|
|
41
543
|
};
|
|
42
544
|
requestBody?: never;
|
|
43
545
|
responses: {
|
|
546
|
+
/** @description Service health status */
|
|
547
|
+
200: {
|
|
548
|
+
headers: {
|
|
549
|
+
[name: string]: unknown;
|
|
550
|
+
};
|
|
551
|
+
content: {
|
|
552
|
+
"application/json": {
|
|
553
|
+
/** @example ok */
|
|
554
|
+
status?: string;
|
|
555
|
+
/** Format: date-time */
|
|
556
|
+
timestamp?: string;
|
|
557
|
+
};
|
|
558
|
+
};
|
|
559
|
+
};
|
|
560
|
+
};
|
|
561
|
+
};
|
|
562
|
+
RealTimeWorkingSessionsController_getRealTimeWorkingSessions: {
|
|
563
|
+
parameters: {
|
|
564
|
+
query: {
|
|
565
|
+
/**
|
|
566
|
+
* @description User ID (UUID)
|
|
567
|
+
* @example 123e4567-e89b-12d3-a456-426614174000
|
|
568
|
+
*/
|
|
569
|
+
userId: string;
|
|
570
|
+
/**
|
|
571
|
+
* @description Account ID (UUID)
|
|
572
|
+
* @example 123e4567-e89b-12d3-a456-426614174000
|
|
573
|
+
*/
|
|
574
|
+
accountId: string;
|
|
575
|
+
/**
|
|
576
|
+
* @description Date in YYYY-MM-DD format
|
|
577
|
+
* @example 2025-11-22
|
|
578
|
+
*/
|
|
579
|
+
date: string;
|
|
580
|
+
/**
|
|
581
|
+
* @description UTC offset in format: UTC, UTC-8, UTC+5, etc.
|
|
582
|
+
* @example UTC-8
|
|
583
|
+
*/
|
|
584
|
+
utcOffset: string;
|
|
585
|
+
};
|
|
586
|
+
header?: never;
|
|
587
|
+
path?: never;
|
|
588
|
+
cookie?: never;
|
|
589
|
+
};
|
|
590
|
+
requestBody?: never;
|
|
591
|
+
responses: {
|
|
592
|
+
/** @description Returns real-time working sessions for the user */
|
|
593
|
+
200: {
|
|
594
|
+
headers: {
|
|
595
|
+
[name: string]: unknown;
|
|
596
|
+
};
|
|
597
|
+
content: {
|
|
598
|
+
"application/json": components["schemas"]["RealTimeWorkingSessionsResponseDto"];
|
|
599
|
+
};
|
|
600
|
+
};
|
|
601
|
+
};
|
|
602
|
+
};
|
|
603
|
+
AppUsageReportController_getAppUsageMetrics: {
|
|
604
|
+
parameters: {
|
|
605
|
+
query: {
|
|
606
|
+
/** @description Averaging period for metrics */
|
|
607
|
+
averagingPeriod: "day" | "week" | "month" | "quarter" | "year";
|
|
608
|
+
/** @description Averaging type (total or perUser) */
|
|
609
|
+
averagingType: "total" | "perUser";
|
|
610
|
+
/** @description Start date for the metrics period */
|
|
611
|
+
startDate: string;
|
|
612
|
+
/** @description End date for the metrics period */
|
|
613
|
+
endDate?: string;
|
|
614
|
+
/** @description Filter by user IDs */
|
|
615
|
+
userIds?: string[];
|
|
616
|
+
/** @description Filter by department ID */
|
|
617
|
+
departmentId?: string;
|
|
618
|
+
/** @description Filter by workspace ID */
|
|
619
|
+
workspaceId?: string;
|
|
620
|
+
/** @description Filter by app category ID */
|
|
621
|
+
appCategoryId?: string;
|
|
622
|
+
/** @description Filter by app IDs */
|
|
623
|
+
appIds?: string[];
|
|
624
|
+
/** @description Filter by account ID */
|
|
625
|
+
accountId?: string;
|
|
626
|
+
/** @description Start date for comparison period */
|
|
627
|
+
comparisonStartDate?: string;
|
|
628
|
+
/** @description End date for comparison period */
|
|
629
|
+
comparisonEndDate?: string;
|
|
630
|
+
/** @description Hourly rate for cost calculation */
|
|
631
|
+
hourlyRate?: number;
|
|
632
|
+
/** @description Number of items to return */
|
|
633
|
+
first?: number;
|
|
634
|
+
/** @description Cursor for pagination */
|
|
635
|
+
after?: number;
|
|
636
|
+
/** @description Field to sort by */
|
|
637
|
+
sortField?: "appName" | "appCreatedDate" | "appCategoryName" | "uniqueUsers" | "uniqueUsersDeviation" | "duration" | "durationDeviation" | "interactions" | "interactionsDeviation" | "cost" | "costDeviation";
|
|
638
|
+
/** @description Sort direction */
|
|
639
|
+
sortDirection?: "ASC" | "DESC";
|
|
640
|
+
/** @description Type of metric to retrieve */
|
|
641
|
+
metricType: "uniqueUsers" | "duration" | "interactions" | "cost";
|
|
642
|
+
};
|
|
643
|
+
header?: never;
|
|
644
|
+
path?: never;
|
|
645
|
+
cookie?: never;
|
|
646
|
+
};
|
|
647
|
+
requestBody?: never;
|
|
648
|
+
responses: {
|
|
649
|
+
/** @description Returns app usage metrics list */
|
|
44
650
|
200: {
|
|
45
651
|
headers: {
|
|
46
652
|
[name: string]: unknown;
|
|
47
653
|
};
|
|
48
|
-
content
|
|
654
|
+
content: {
|
|
655
|
+
"application/json": components["schemas"]["AppUsageMetricsListResponseDto"];
|
|
656
|
+
};
|
|
657
|
+
};
|
|
658
|
+
};
|
|
659
|
+
};
|
|
660
|
+
AppUsageReportController_getAppUsageMetricsHighlights: {
|
|
661
|
+
parameters: {
|
|
662
|
+
query: {
|
|
663
|
+
/** @description Averaging period for metrics */
|
|
664
|
+
averagingPeriod: "day" | "week" | "month" | "quarter" | "year";
|
|
665
|
+
/** @description Averaging type (total or perUser) */
|
|
666
|
+
averagingType: "total" | "perUser";
|
|
667
|
+
/** @description Start date for the metrics period */
|
|
668
|
+
startDate: string;
|
|
669
|
+
/** @description End date for the metrics period */
|
|
670
|
+
endDate?: string;
|
|
671
|
+
/** @description Filter by user IDs */
|
|
672
|
+
userIds?: string[];
|
|
673
|
+
/** @description Filter by department ID */
|
|
674
|
+
departmentId?: string;
|
|
675
|
+
/** @description Filter by workspace ID */
|
|
676
|
+
workspaceId?: string;
|
|
677
|
+
/** @description Filter by app category ID */
|
|
678
|
+
appCategoryId?: string;
|
|
679
|
+
/** @description Filter by app IDs */
|
|
680
|
+
appIds?: string[];
|
|
681
|
+
/** @description Filter by account ID */
|
|
682
|
+
accountId?: string;
|
|
683
|
+
/** @description Start date for comparison period */
|
|
684
|
+
comparisonStartDate: string;
|
|
685
|
+
/** @description End date for comparison period */
|
|
686
|
+
comparisonEndDate: string;
|
|
687
|
+
/** @description Hourly rate for cost calculation */
|
|
688
|
+
hourlyRate?: number;
|
|
689
|
+
/** @description Number of items to return */
|
|
690
|
+
first?: number;
|
|
691
|
+
/** @description Cursor for pagination */
|
|
692
|
+
after?: number;
|
|
693
|
+
/** @description Field to sort by */
|
|
694
|
+
sortField?: "appName" | "appCreatedDate" | "appCategoryName" | "uniqueUsers" | "uniqueUsersDeviation" | "duration" | "durationDeviation" | "interactions" | "interactionsDeviation" | "cost" | "costDeviation";
|
|
695
|
+
/** @description Sort direction */
|
|
696
|
+
sortDirection?: "ASC" | "DESC";
|
|
697
|
+
/** @description Type of metric to retrieve */
|
|
698
|
+
metricType: "uniqueUsers" | "duration" | "interactions" | "cost";
|
|
699
|
+
};
|
|
700
|
+
header?: never;
|
|
701
|
+
path?: never;
|
|
702
|
+
cookie?: never;
|
|
703
|
+
};
|
|
704
|
+
requestBody?: never;
|
|
705
|
+
responses: {
|
|
706
|
+
/** @description Returns app usage metrics highlights */
|
|
707
|
+
200: {
|
|
708
|
+
headers: {
|
|
709
|
+
[name: string]: unknown;
|
|
710
|
+
};
|
|
711
|
+
content: {
|
|
712
|
+
"application/json": components["schemas"]["AppUsageMetricsHighlightsResponseDto"];
|
|
713
|
+
};
|
|
714
|
+
};
|
|
715
|
+
};
|
|
716
|
+
};
|
|
717
|
+
AppUsageReportController_searchAppUsageMetrics: {
|
|
718
|
+
parameters: {
|
|
719
|
+
query: {
|
|
720
|
+
/** @description Search query string */
|
|
721
|
+
query: string;
|
|
722
|
+
/** @description Averaging period for metrics */
|
|
723
|
+
averagingPeriod: "day" | "week" | "month" | "quarter" | "year";
|
|
724
|
+
/** @description Averaging type (total or perUser) */
|
|
725
|
+
averagingType: "total" | "perUser";
|
|
726
|
+
/** @description Start date for the metrics period */
|
|
727
|
+
startDate: string;
|
|
728
|
+
/** @description End date for the metrics period */
|
|
729
|
+
endDate?: string;
|
|
730
|
+
/** @description Filter by user IDs */
|
|
731
|
+
userIds?: string[];
|
|
732
|
+
/** @description Filter by department ID */
|
|
733
|
+
departmentId?: string;
|
|
734
|
+
/** @description Filter by workspace ID */
|
|
735
|
+
workspaceId?: string;
|
|
736
|
+
/** @description Filter by app category ID */
|
|
737
|
+
appCategoryId?: string;
|
|
738
|
+
/** @description Filter by app IDs */
|
|
739
|
+
appIds?: string[];
|
|
740
|
+
/** @description Filter by account ID */
|
|
741
|
+
accountId?: string;
|
|
742
|
+
/** @description Hourly rate for cost calculation */
|
|
743
|
+
hourlyRate?: number;
|
|
744
|
+
/** @description Start date for comparison period */
|
|
745
|
+
comparisonStartDate?: string;
|
|
746
|
+
/** @description End date for comparison period */
|
|
747
|
+
comparisonEndDate?: string;
|
|
748
|
+
/** @description Number of items to return */
|
|
749
|
+
first?: number;
|
|
750
|
+
/** @description Cursor for pagination */
|
|
751
|
+
after?: number;
|
|
752
|
+
/** @description Field to sort by */
|
|
753
|
+
sortField?: "appName" | "appCreatedDate" | "appCategoryName" | "uniqueUsers" | "uniqueUsersDeviation" | "duration" | "durationDeviation" | "interactions" | "interactionsDeviation" | "cost" | "costDeviation";
|
|
754
|
+
/** @description Sort direction */
|
|
755
|
+
sortDirection?: "ASC" | "DESC";
|
|
756
|
+
/** @description Type of metric to retrieve */
|
|
757
|
+
metricType: "uniqueUsers" | "duration" | "interactions" | "cost";
|
|
758
|
+
};
|
|
759
|
+
header?: never;
|
|
760
|
+
path?: never;
|
|
761
|
+
cookie?: never;
|
|
762
|
+
};
|
|
763
|
+
requestBody?: never;
|
|
764
|
+
responses: {
|
|
765
|
+
/** @description Returns app usage metrics search results */
|
|
766
|
+
200: {
|
|
767
|
+
headers: {
|
|
768
|
+
[name: string]: unknown;
|
|
769
|
+
};
|
|
770
|
+
content: {
|
|
771
|
+
"application/json": components["schemas"]["AppUsageMetricsListResponseDto"];
|
|
772
|
+
};
|
|
49
773
|
};
|
|
50
774
|
};
|
|
51
775
|
};
|
package/package.json
CHANGED