@meshery/schemas 1.2.22 → 1.2.23

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 (88) hide show
  1. package/dist/cloudApi.d.mts +1719 -1518
  2. package/dist/cloudApi.d.ts +1719 -1518
  3. package/dist/cloudApi.js +1 -1
  4. package/dist/cloudApi.mjs +1 -1
  5. package/dist/constructs/v1alpha1/capability/Capability.d.ts +111 -106
  6. package/dist/constructs/v1alpha1/core/Core.d.ts +734 -822
  7. package/dist/constructs/v1alpha2/catalog/Catalog.d.ts +40 -45
  8. package/dist/constructs/v1alpha3/relationship/Relationship.d.ts +1716 -1829
  9. package/dist/constructs/v1beta1/academy/Academy.d.ts +6648 -6029
  10. package/dist/constructs/v1beta1/badge/Badge.d.ts +600 -439
  11. package/dist/constructs/v1beta1/capability/Capability.d.ts +111 -106
  12. package/dist/constructs/v1beta1/catalog/Catalog.d.ts +40 -45
  13. package/dist/constructs/v1beta1/category/Category.d.ts +26 -38
  14. package/dist/constructs/v1beta1/component/Component.d.ts +729 -833
  15. package/dist/constructs/v1beta1/connection/Connection.d.ts +1357 -1170
  16. package/dist/constructs/v1beta1/core/Core.d.ts +734 -822
  17. package/dist/constructs/v1beta1/credential/Credential.d.ts +593 -458
  18. package/dist/constructs/v1beta1/environment/Environment.d.ts +835 -666
  19. package/dist/constructs/v1beta1/evaluation/Evaluation.d.ts +5508 -6030
  20. package/dist/constructs/v1beta1/event/Event.d.ts +898 -527
  21. package/dist/constructs/v1beta1/feature/Feature.d.ts +287 -249
  22. package/dist/constructs/v1beta1/invitation/Invitation.d.ts +1244 -877
  23. package/dist/constructs/v1beta1/key/Key.d.ts +589 -444
  24. package/dist/constructs/v1beta1/keychain/Keychain.d.ts +796 -575
  25. package/dist/constructs/v1beta1/model/Model.d.ts +572 -598
  26. package/dist/constructs/v1beta1/organization/Organization.d.ts +1829 -1410
  27. package/dist/constructs/v1beta1/pattern/Pattern.d.ts +17093 -17910
  28. package/dist/constructs/v1beta1/plan/Plan.d.ts +159 -115
  29. package/dist/constructs/v1beta1/role/Role.d.ts +933 -688
  30. package/dist/constructs/v1beta1/schedule/Schedule.d.ts +425 -315
  31. package/dist/constructs/v1beta1/subcategory/Subcategory.d.ts +18 -61
  32. package/dist/constructs/v1beta1/subscription/Subscription.d.ts +839 -674
  33. package/dist/constructs/v1beta1/support/Support.d.ts +115 -74
  34. package/dist/constructs/v1beta1/system/System.d.ts +434 -0
  35. package/dist/constructs/v1beta1/system/System.js +1 -0
  36. package/dist/constructs/v1beta1/system/System.mjs +0 -0
  37. package/dist/constructs/v1beta1/system/SystemSchema.d.ts +2 -0
  38. package/dist/constructs/v1beta1/system/SystemSchema.js +2 -0
  39. package/dist/constructs/v1beta1/system/SystemSchema.mjs +2 -0
  40. package/dist/constructs/v1beta1/team/Team.d.ts +1028 -762
  41. package/dist/constructs/v1beta1/token/Token.d.ts +612 -475
  42. package/dist/constructs/v1beta1/user/User.d.ts +1723 -1554
  43. package/dist/constructs/v1beta1/view/View.d.ts +833 -664
  44. package/dist/constructs/v1beta1/workspace/Workspace.d.ts +4900 -4695
  45. package/dist/constructs/v1beta2/academy/Academy.d.ts +7840 -7222
  46. package/dist/constructs/v1beta2/badge/Badge.d.ts +610 -453
  47. package/dist/constructs/v1beta2/catalog/Catalog.d.ts +40 -45
  48. package/dist/constructs/v1beta2/component/Component.d.ts +747 -851
  49. package/dist/constructs/v1beta2/connection/Connection.d.ts +1376 -1189
  50. package/dist/constructs/v1beta2/core/Core.d.ts +768 -856
  51. package/dist/constructs/v1beta2/credential/Credential.d.ts +572 -437
  52. package/dist/constructs/v1beta2/design/Design.d.ts +17682 -18467
  53. package/dist/constructs/v1beta2/event/Event.d.ts +946 -575
  54. package/dist/constructs/v1beta2/invitation/Invitation.d.ts +1268 -901
  55. package/dist/constructs/v1beta2/key/Key.d.ts +599 -454
  56. package/dist/constructs/v1beta2/keychain/Keychain.d.ts +806 -585
  57. package/dist/constructs/v1beta2/model/Model.d.ts +610 -636
  58. package/dist/constructs/v1beta2/organization/Organization.d.ts +2135 -1724
  59. package/dist/constructs/v1beta2/plan/Plan.d.ts +169 -128
  60. package/dist/constructs/v1beta2/relationship/Relationship.d.ts +1842 -2011
  61. package/dist/constructs/v1beta2/role/Role.d.ts +940 -695
  62. package/dist/constructs/v1beta2/schedule/Schedule.d.ts +466 -356
  63. package/dist/constructs/v1beta2/subscription/Subscription.d.ts +866 -701
  64. package/dist/constructs/v1beta2/team/Team.d.ts +1118 -852
  65. package/dist/constructs/v1beta2/token/Token.d.ts +616 -479
  66. package/dist/constructs/v1beta2/user/User.d.ts +1723 -1554
  67. package/dist/constructs/v1beta2/view/View.d.ts +838 -669
  68. package/dist/constructs/v1beta3/academy/Academy.d.ts +7836 -7218
  69. package/dist/constructs/v1beta3/component/Component.d.ts +753 -857
  70. package/dist/constructs/v1beta3/connection/Connection.d.ts +1447 -1260
  71. package/dist/constructs/v1beta3/design/Design.d.ts +5727 -5305
  72. package/dist/constructs/v1beta3/environment/Environment.d.ts +858 -689
  73. package/dist/constructs/v1beta3/event/Event.d.ts +1041 -666
  74. package/dist/constructs/v1beta3/filter/Filter.d.ts +1437 -1299
  75. package/dist/constructs/v1beta3/invitation/Invitation.d.ts +1277 -910
  76. package/dist/constructs/v1beta3/performance_profile/PerformanceProfile.d.ts +850 -690
  77. package/dist/constructs/v1beta3/plan/Plan.d.ts +197 -156
  78. package/dist/constructs/v1beta3/relationship/Relationship.d.ts +1842 -2011
  79. package/dist/constructs/v1beta3/subscription/Subscription.d.ts +969 -804
  80. package/dist/constructs/v1beta3/token/Token.d.ts +616 -479
  81. package/dist/constructs/v1beta3/workspace/Workspace.d.ts +5030 -4822
  82. package/dist/index.d.mts +5480 -5022
  83. package/dist/index.d.ts +5480 -5022
  84. package/dist/mesheryApi.d.mts +1314 -522
  85. package/dist/mesheryApi.d.ts +1314 -522
  86. package/dist/mesheryApi.js +1 -1
  87. package/dist/mesheryApi.mjs +1 -1
  88. package/package.json +1 -2
@@ -4,425 +4,209 @@
4
4
  */
5
5
 
6
6
  export interface paths {
7
- "/events/{eventId}": {
8
- delete: operations["deleteEvent"];
9
- };
10
- "/events": {
11
- post: operations["createEvent"];
12
- };
13
- "/events/delete": {
14
- post: operations["bulkDeleteEvents"];
15
- };
16
- "/events/status": {
17
- put: operations["bulkUpdateEventStatus"];
18
- };
19
- "/events/{eventId}/status": {
20
- put: operations["updateEventStatus"];
21
- };
22
- "/api/workspaces/{workspaceId}/events": {
23
- /** Gets events for a workspace. */
24
- get: operations["getEventsOfWorkspace"];
25
- };
26
- "/api/events": {
27
- get: operations["getEventsAggregate"];
28
- };
29
- "/api/events/list": {
30
- get: operations["getEvents"];
31
- };
32
- "/api/events/summary": {
33
- get: operations["getEventSummaryByUser"];
34
- };
35
- "/api/events/types": {
36
- get: operations["getEventTypes"];
37
- };
38
- }
39
-
40
- export interface components {
41
- schemas: {
42
- /** @description Payload for creating a new event. */
43
- EventPayload: {
44
- /**
45
- * Format: uuid
46
- * @description UUID of the user associated with the event.
47
- */
48
- userId?: string;
49
- /** @description The category of the event. */
50
- category?: string;
51
- /** @description The action of the event. */
52
- action?: string;
53
- /** @description Description of the event. */
54
- description?: string;
55
- } & { [key: string]: unknown };
56
- /** @description Payload for updating the status of a single event. */
57
- UpdateEventStatusRequest: {
58
- /**
59
- * @description Current status of the event.
60
- * @example completed
61
- */
62
- status: string;
63
- };
64
- /** @description Response body returned after updating an event's status. */
65
- UpdateEventStatusResponse: {
66
- /** @description Human-readable status message. */
67
- message?: string;
68
- /**
69
- * Format: uuid
70
- * @description UUID of the event whose status was updated.
71
- */
72
- eventId?: string;
73
- /** @description Updated status of the event. */
74
- status?: string;
75
- };
76
- /** @description Payload for bulk-deleting events by ID. */
77
- BulkDeleteRequest: {
78
- /** @description UUIDs of the events to delete. */
79
- ids: string[];
7
+ "/events/{eventId}": {
8
+ parameters: {
9
+ query?: never;
10
+ header?: never;
11
+ path?: never;
12
+ cookie?: never;
13
+ };
14
+ get?: never;
15
+ put?: never;
16
+ post?: never;
17
+ /** Delete a single event */
18
+ delete: operations["deleteEvent"];
19
+ options?: never;
20
+ head?: never;
21
+ patch?: never;
22
+ trace?: never;
80
23
  };
81
- /** @description Response body returned after bulk event deletion. */
82
- BulkDeleteResponse: {
83
- /** @description UUIDs of events that were deleted. */
84
- deleted?: string[];
24
+ "/events": {
25
+ parameters: {
26
+ query?: never;
27
+ header?: never;
28
+ path?: never;
29
+ cookie?: never;
30
+ };
31
+ get?: never;
32
+ put?: never;
33
+ /** Create a new event */
34
+ post: operations["createEvent"];
35
+ delete?: never;
36
+ options?: never;
37
+ head?: never;
38
+ patch?: never;
39
+ trace?: never;
85
40
  };
86
- /** @description Payload for bulk-updating the status of events. */
87
- BulkUpdateStatusRequest: {
88
- /** @description UUIDs of the events to update. */
89
- ids: string[];
90
- /**
91
- * @description New status to apply to the selected events.
92
- * @example failed
93
- */
94
- status: string;
41
+ "/events/delete": {
42
+ parameters: {
43
+ query?: never;
44
+ header?: never;
45
+ path?: never;
46
+ cookie?: never;
47
+ };
48
+ get?: never;
49
+ put?: never;
50
+ /** Bulk delete events */
51
+ post: operations["bulkDeleteEvents"];
52
+ delete?: never;
53
+ options?: never;
54
+ head?: never;
55
+ patch?: never;
56
+ trace?: never;
95
57
  };
96
- /** @description Response body returned after bulk event status update. */
97
- BulkUpdateStatusResponse: {
98
- /** @description UUIDs of events whose status was updated. */
99
- updated?: string[];
58
+ "/events/status": {
59
+ parameters: {
60
+ query?: never;
61
+ header?: never;
62
+ path?: never;
63
+ cookie?: never;
64
+ };
65
+ get?: never;
66
+ /** Bulk update event status */
67
+ put: operations["bulkUpdateEventStatus"];
68
+ post?: never;
69
+ delete?: never;
70
+ options?: never;
71
+ head?: never;
72
+ patch?: never;
73
+ trace?: never;
100
74
  };
101
- /** @description EventResult entity schema. */
102
- EventResult: {
103
- /**
104
- * Format: uuid
105
- * @description UUID of the user associated with the event.
106
- */
107
- userId: string;
108
- /** @description System identifier of the event source. */
109
- systemId?: string;
110
- /** @description The category of the event. */
111
- category: string;
112
- /** @description The action of the event. */
113
- action: string;
114
- /** @description Description of the event. */
115
- description?: string;
116
- /** @description The first name of the user associated with the event. */
117
- firstName?: string;
118
- /** @description The last name of the user associated with the event. */
119
- lastName?: string;
120
- /**
121
- * Format: email
122
- * @description Email address of the user associated with the event.
123
- */
124
- email?: string;
125
- /** @description Authentication provider of the user associated with the event. */
126
- provider?: string;
127
- /**
128
- * Format: date-time
129
- * @description Timestamp when the event was recorded.
130
- */
131
- createdAt?: string;
75
+ "/events/{eventId}/status": {
76
+ parameters: {
77
+ query?: never;
78
+ header?: never;
79
+ path?: never;
80
+ cookie?: never;
81
+ };
82
+ get?: never;
83
+ /** Update status of a single event */
84
+ put: operations["updateEventStatus"];
85
+ post?: never;
86
+ delete?: never;
87
+ options?: never;
88
+ head?: never;
89
+ patch?: never;
90
+ trace?: never;
132
91
  };
133
- /** @description Paginated list of events. */
134
- EventsPage: {
135
- /** @description Zero-based page index returned in this response. */
136
- page?: number;
137
- /** @description Maximum number of items returned on each page. */
138
- pageSize?: number;
139
- /** @description Total number of items across all pages. */
140
- totalCount?: number;
141
- /** @description The events returned on the current page. */
142
- data?: {
143
- /**
144
- * Format: uuid
145
- * @description UUID of the user associated with the event.
146
- */
147
- userId: string;
148
- /** @description System identifier of the event source. */
149
- systemId?: string;
150
- /** @description The category of the event. */
151
- category: string;
152
- /** @description The action of the event. */
153
- action: string;
154
- /** @description Description of the event. */
155
- description?: string;
156
- /** @description The first name of the user associated with the event. */
157
- firstName?: string;
158
- /** @description The last name of the user associated with the event. */
159
- lastName?: string;
160
- /**
161
- * Format: email
162
- * @description Email address of the user associated with the event.
163
- */
164
- email?: string;
165
- /** @description Authentication provider of the user associated with the event. */
166
- provider?: string;
92
+ "/api/workspaces/{workspaceId}/events": {
93
+ parameters: {
94
+ query?: never;
95
+ header?: never;
96
+ path?: never;
97
+ cookie?: never;
98
+ };
167
99
  /**
168
- * Format: date-time
169
- * @description Timestamp when the event was recorded.
100
+ * Get workspace events
101
+ * @description Gets events for a workspace.
170
102
  */
171
- createdAt?: string;
172
- }[];
173
- };
174
- /** @description Aggregated event counts across categories. */
175
- EventsAggregate: {
176
- /** @description Count of audit-category events. */
177
- audit?: number;
178
- } & { [key: string]: unknown };
179
- /** @description Per-user event summary entry. */
180
- EventSummary: { [key: string]: unknown };
181
- /** @description Paginated list of per-user event summaries. */
182
- EventSummaryPage: {
183
- /** @description Current page number of the result set. */
184
- page?: number;
185
- /** @description Number of items per page. */
186
- pageSize?: number;
187
- /** @description Total number of items available. */
188
- totalCount?: number;
189
- /** @description The event summaries returned on the current page. */
190
- data?: { [key: string]: unknown }[];
103
+ get: operations["getEventsOfWorkspace"];
104
+ put?: never;
105
+ post?: never;
106
+ delete?: never;
107
+ options?: never;
108
+ head?: never;
109
+ patch?: never;
110
+ trace?: never;
191
111
  };
192
- /** @description A category/action pair describing one kind of event. */
193
- EventType: {
194
- /** @description The category of the event type. */
195
- category?: string;
196
- /** @description The action of the event type. */
197
- action?: string;
198
- };
199
- /** @description Generic error envelope returned for non-2xx responses. */
200
- ErrorResponse: {
201
- /** @description Human-readable error message. */
202
- error?: string;
203
- };
204
- };
205
- responses: {
206
- /** Invalid request body or request param */
207
- 400: {
208
- content: {
209
- "text/plain": string;
210
- };
112
+ "/api/events": {
113
+ parameters: {
114
+ query?: never;
115
+ header?: never;
116
+ path?: never;
117
+ cookie?: never;
118
+ };
119
+ /** Get events aggregate summary */
120
+ get: operations["getEventsAggregate"];
121
+ put?: never;
122
+ post?: never;
123
+ delete?: never;
124
+ options?: never;
125
+ head?: never;
126
+ patch?: never;
127
+ trace?: never;
211
128
  };
212
- /** Expired JWT token used or insufficient privilege */
213
- 401: {
214
- content: {
215
- "text/plain": string;
216
- };
129
+ "/api/events/list": {
130
+ parameters: {
131
+ query?: never;
132
+ header?: never;
133
+ path?: never;
134
+ cookie?: never;
135
+ };
136
+ /** Get events list */
137
+ get: operations["getEvents"];
138
+ put?: never;
139
+ post?: never;
140
+ delete?: never;
141
+ options?: never;
142
+ head?: never;
143
+ patch?: never;
144
+ trace?: never;
217
145
  };
218
- /** Result not found */
219
- 404: {
220
- content: {
221
- "text/plain": string;
222
- };
146
+ "/api/events/summary": {
147
+ parameters: {
148
+ query?: never;
149
+ header?: never;
150
+ path?: never;
151
+ cookie?: never;
152
+ };
153
+ /** Get event summary by user */
154
+ get: operations["getEventSummaryByUser"];
155
+ put?: never;
156
+ post?: never;
157
+ delete?: never;
158
+ options?: never;
159
+ head?: never;
160
+ patch?: never;
161
+ trace?: never;
223
162
  };
224
- /** Internal server error */
225
- 500: {
226
- content: {
227
- "text/plain": string;
228
- };
163
+ "/api/events/types": {
164
+ parameters: {
165
+ query?: never;
166
+ header?: never;
167
+ path?: never;
168
+ cookie?: never;
169
+ };
170
+ /** Get event types */
171
+ get: operations["getEventTypes"];
172
+ put?: never;
173
+ post?: never;
174
+ delete?: never;
175
+ options?: never;
176
+ head?: never;
177
+ patch?: never;
178
+ trace?: never;
229
179
  };
230
- };
231
- parameters: {
232
- /** @description ID of the event. */
233
- eventId: string;
234
- /** @description Workspace ID */
235
- workspaceId: string;
236
- /** @description Get responses by page */
237
- page: string;
238
- /** @description Get responses by pagesize */
239
- pagesize: string;
240
- /** @description Get responses that match search param value */
241
- search: string;
242
- /** @description Get ordered responses */
243
- order: string;
244
- /** @description When true, return cumulative aggregate counts across all time. */
245
- cumulative: boolean;
246
- /** @description Get filtered reponses */
247
- filter: string;
248
- /** @description Get filtered reponses */
249
- eventsFilter: string;
250
- };
251
180
  }
252
-
253
- export interface operations {
254
- deleteEvent: {
255
- parameters: {
256
- path: {
257
- /** ID of the event. */
258
- eventId: string;
259
- };
260
- };
261
- responses: {
262
- /** Event deleted */
263
- 204: never;
264
- /** Invalid request body or request param */
265
- 400: {
266
- content: {
267
- "text/plain": string;
268
- };
269
- };
270
- /** Expired JWT token used or insufficient privilege */
271
- 401: {
272
- content: {
273
- "text/plain": string;
274
- };
275
- };
276
- /** Result not found */
277
- 404: {
278
- content: {
279
- "text/plain": string;
280
- };
281
- };
282
- /** Internal server error */
283
- 500: {
284
- content: {
285
- "text/plain": string;
286
- };
287
- };
288
- };
289
- };
290
- createEvent: {
291
- responses: {
292
- /** Event created */
293
- 201: unknown;
294
- /** Invalid request body or request param */
295
- 400: {
296
- content: {
297
- "text/plain": string;
298
- };
299
- };
300
- /** Expired JWT token used or insufficient privilege */
301
- 401: {
302
- content: {
303
- "text/plain": string;
304
- };
305
- };
306
- /** Internal server error */
307
- 500: {
308
- content: {
309
- "text/plain": string;
310
- };
311
- };
312
- };
313
- requestBody: {
314
- content: {
315
- "application/json": {
316
- /**
317
- * Format: uuid
318
- * @description UUID of the user associated with the event.
319
- */
320
- userId?: string;
321
- /** @description The category of the event. */
322
- category?: string;
323
- /** @description The action of the event. */
324
- action?: string;
325
- /** @description Description of the event. */
326
- description?: string;
327
- } & { [key: string]: unknown };
328
- };
329
- };
330
- };
331
- bulkDeleteEvents: {
332
- responses: {
333
- /** Events deleted */
334
- 200: {
335
- content: {
336
- "application/json": {
337
- /** @description UUIDs of events that were deleted. */
338
- deleted?: string[];
339
- };
340
- };
341
- };
342
- /** Invalid request body or request param */
343
- 400: {
344
- content: {
345
- "text/plain": string;
346
- };
347
- };
348
- /** Expired JWT token used or insufficient privilege */
349
- 401: {
350
- content: {
351
- "text/plain": string;
352
- };
353
- };
354
- /** Internal server error */
355
- 500: {
356
- content: {
357
- "text/plain": string;
358
- };
359
- };
360
- };
361
- requestBody: {
362
- content: {
363
- "application/json": {
364
- /** @description UUIDs of the events to delete. */
365
- ids: string[];
181
+ export type webhooks = Record<string, never>;
182
+ export interface components {
183
+ schemas: {
184
+ /** @description Payload for creating a new event. */
185
+ EventPayload: {
186
+ /**
187
+ * Format: uuid
188
+ * @description UUID of the user associated with the event.
189
+ */
190
+ userId?: string;
191
+ /** @description The category of the event. */
192
+ category?: string;
193
+ /** @description The action of the event. */
194
+ action?: string;
195
+ /** @description Description of the event. */
196
+ description?: string;
197
+ } & {
198
+ [key: string]: unknown;
366
199
  };
367
- };
368
- };
369
- };
370
- bulkUpdateEventStatus: {
371
- responses: {
372
- /** Events updated */
373
- 200: {
374
- content: {
375
- "application/json": {
376
- /** @description UUIDs of events whose status was updated. */
377
- updated?: string[];
378
- };
379
- };
380
- };
381
- /** Invalid request body or request param */
382
- 400: {
383
- content: {
384
- "text/plain": string;
385
- };
386
- };
387
- /** Expired JWT token used or insufficient privilege */
388
- 401: {
389
- content: {
390
- "text/plain": string;
391
- };
392
- };
393
- /** Internal server error */
394
- 500: {
395
- content: {
396
- "text/plain": string;
397
- };
398
- };
399
- };
400
- requestBody: {
401
- content: {
402
- "application/json": {
403
- /** @description UUIDs of the events to update. */
404
- ids: string[];
405
- /**
406
- * @description New status to apply to the selected events.
407
- * @example failed
408
- */
409
- status: string;
410
- };
411
- };
412
- };
413
- };
414
- updateEventStatus: {
415
- parameters: {
416
- path: {
417
- /** ID of the event. */
418
- eventId: string;
419
- };
420
- };
421
- responses: {
422
- /** Event status updated */
423
- 200: {
424
- content: {
425
- "application/json": {
200
+ /** @description Payload for updating the status of a single event. */
201
+ UpdateEventStatusRequest: {
202
+ /**
203
+ * @description Current status of the event.
204
+ * @example completed
205
+ */
206
+ status: string;
207
+ };
208
+ /** @description Response body returned after updating an event's status. */
209
+ UpdateEventStatusResponse: {
426
210
  /** @description Human-readable status message. */
427
211
  message?: string;
428
212
  /**
@@ -432,69 +216,66 @@ export interface operations {
432
216
  eventId?: string;
433
217
  /** @description Updated status of the event. */
434
218
  status?: string;
435
- };
436
- };
437
- };
438
- /** Invalid request body or request param */
439
- 400: {
440
- content: {
441
- "text/plain": string;
442
- };
443
- };
444
- /** Expired JWT token used or insufficient privilege */
445
- 401: {
446
- content: {
447
- "text/plain": string;
448
- };
449
- };
450
- /** Result not found */
451
- 404: {
452
- content: {
453
- "text/plain": string;
454
- };
455
- };
456
- /** Internal server error */
457
- 500: {
458
- content: {
459
- "text/plain": string;
460
- };
461
- };
462
- };
463
- requestBody: {
464
- content: {
465
- "application/json": {
466
- /**
467
- * @description Current status of the event.
468
- * @example completed
469
- */
470
- status: string;
471
- };
472
- };
473
- };
474
- };
475
- /** Gets events for a workspace. */
476
- getEventsOfWorkspace: {
477
- parameters: {
478
- path: {
479
- /** Workspace ID */
480
- workspaceId: string;
481
- };
482
- query: {
483
- /** Get responses by page */
484
- page?: string;
485
- /** Get responses by pagesize */
486
- pagesize?: string;
487
- /** Get responses that match search param value */
488
- search?: string;
489
- /** Get ordered responses */
490
- order?: string;
491
- };
492
- };
493
- responses: {
494
- /** Workspace events */
495
- 200: {
496
- content: {
497
- "application/json": {
219
+ };
220
+ /** @description Payload for bulk-deleting events by ID. */
221
+ BulkDeleteRequest: {
222
+ /** @description UUIDs of the events to delete. */
223
+ ids: string[];
224
+ };
225
+ /** @description Response body returned after bulk event deletion. */
226
+ BulkDeleteResponse: {
227
+ /** @description UUIDs of events that were deleted. */
228
+ deleted?: string[];
229
+ };
230
+ /** @description Payload for bulk-updating the status of events. */
231
+ BulkUpdateStatusRequest: {
232
+ /** @description UUIDs of the events to update. */
233
+ ids: string[];
234
+ /**
235
+ * @description New status to apply to the selected events.
236
+ * @example failed
237
+ */
238
+ status: string;
239
+ };
240
+ /** @description Response body returned after bulk event status update. */
241
+ BulkUpdateStatusResponse: {
242
+ /** @description UUIDs of events whose status was updated. */
243
+ updated?: string[];
244
+ };
245
+ /** @description EventResult entity schema. */
246
+ EventResult: {
247
+ /**
248
+ * Format: uuid
249
+ * @description UUID of the user associated with the event.
250
+ */
251
+ userId: string;
252
+ /** @description System identifier of the event source. */
253
+ systemId?: string;
254
+ /** @description The category of the event. */
255
+ category: string;
256
+ /** @description The action of the event. */
257
+ action: string;
258
+ /** @description Description of the event. */
259
+ description?: string;
260
+ /** @description The first name of the user associated with the event. */
261
+ firstName?: string;
262
+ /** @description The last name of the user associated with the event. */
263
+ lastName?: string;
264
+ /**
265
+ * Format: email
266
+ * @description Email address of the user associated with the event.
267
+ */
268
+ email?: string;
269
+ /** @description Authentication provider of the user associated with the event. */
270
+ provider?: string;
271
+ /**
272
+ * Format: date-time
273
+ * @description Timestamp when the event was recorded.
274
+ */
275
+ createdAt?: string;
276
+ };
277
+ /** @description Paginated list of events. */
278
+ EventsPage: {
498
279
  /** @description Zero-based page index returned in this response. */
499
280
  page?: number;
500
281
  /** @description Maximum number of items returned on each page. */
@@ -503,170 +284,50 @@ export interface operations {
503
284
  totalCount?: number;
504
285
  /** @description The events returned on the current page. */
505
286
  data?: {
506
- /**
507
- * Format: uuid
508
- * @description UUID of the user associated with the event.
509
- */
510
- userId: string;
511
- /** @description System identifier of the event source. */
512
- systemId?: string;
513
- /** @description The category of the event. */
514
- category: string;
515
- /** @description The action of the event. */
516
- action: string;
517
- /** @description Description of the event. */
518
- description?: string;
519
- /** @description The first name of the user associated with the event. */
520
- firstName?: string;
521
- /** @description The last name of the user associated with the event. */
522
- lastName?: string;
523
- /**
524
- * Format: email
525
- * @description Email address of the user associated with the event.
526
- */
527
- email?: string;
528
- /** @description Authentication provider of the user associated with the event. */
529
- provider?: string;
530
- /**
531
- * Format: date-time
532
- * @description Timestamp when the event was recorded.
533
- */
534
- createdAt?: string;
287
+ /**
288
+ * Format: uuid
289
+ * @description UUID of the user associated with the event.
290
+ */
291
+ userId: string;
292
+ /** @description System identifier of the event source. */
293
+ systemId?: string;
294
+ /** @description The category of the event. */
295
+ category: string;
296
+ /** @description The action of the event. */
297
+ action: string;
298
+ /** @description Description of the event. */
299
+ description?: string;
300
+ /** @description The first name of the user associated with the event. */
301
+ firstName?: string;
302
+ /** @description The last name of the user associated with the event. */
303
+ lastName?: string;
304
+ /**
305
+ * Format: email
306
+ * @description Email address of the user associated with the event.
307
+ */
308
+ email?: string;
309
+ /** @description Authentication provider of the user associated with the event. */
310
+ provider?: string;
311
+ /**
312
+ * Format: date-time
313
+ * @description Timestamp when the event was recorded.
314
+ */
315
+ createdAt?: string;
535
316
  }[];
536
- };
537
317
  };
538
- };
539
- /** Invalid request */
540
- 400: {
541
- content: {
542
- "application/json": {
543
- /** @description Human-readable error message. */
544
- error?: string;
545
- };
546
- };
547
- };
548
- /** Unauthorized */
549
- 401: unknown;
550
- /** Workspace not found */
551
- 404: unknown;
552
- /** Server error */
553
- 500: unknown;
554
- };
555
- };
556
- getEventsAggregate: {
557
- parameters: {
558
- query: {
559
- /** When true, return cumulative aggregate counts across all time. */
560
- cumulative?: boolean;
561
- };
562
- };
563
- responses: {
564
- /** Events aggregate */
565
- 200: {
566
- content: {
567
- "application/json": {
318
+ /** @description Aggregated event counts across categories. */
319
+ EventsAggregate: {
568
320
  /** @description Count of audit-category events. */
569
321
  audit?: number;
570
- } & { [key: string]: unknown };
571
- };
572
- };
573
- /** Unauthorized */
574
- 401: unknown;
575
- /** Not found */
576
- 404: unknown;
577
- /** Server error */
578
- 500: unknown;
579
- };
580
- };
581
- getEvents: {
582
- parameters: {
583
- query: {
584
- /** Get responses by page */
585
- page?: string;
586
- /** Get responses by pagesize */
587
- pagesize?: string;
588
- /** Get responses that match search param value */
589
- search?: string;
590
- /** Get ordered responses */
591
- order?: string;
592
- /** Get filtered reponses */
593
- filter?: string;
594
- };
595
- };
596
- responses: {
597
- /** Events page */
598
- 200: {
599
- content: {
600
- "application/json": {
601
- /** @description Zero-based page index returned in this response. */
602
- page?: number;
603
- /** @description Maximum number of items returned on each page. */
604
- pageSize?: number;
605
- /** @description Total number of items across all pages. */
606
- totalCount?: number;
607
- /** @description The events returned on the current page. */
608
- data?: {
609
- /**
610
- * Format: uuid
611
- * @description UUID of the user associated with the event.
612
- */
613
- userId: string;
614
- /** @description System identifier of the event source. */
615
- systemId?: string;
616
- /** @description The category of the event. */
617
- category: string;
618
- /** @description The action of the event. */
619
- action: string;
620
- /** @description Description of the event. */
621
- description?: string;
622
- /** @description The first name of the user associated with the event. */
623
- firstName?: string;
624
- /** @description The last name of the user associated with the event. */
625
- lastName?: string;
626
- /**
627
- * Format: email
628
- * @description Email address of the user associated with the event.
629
- */
630
- email?: string;
631
- /** @description Authentication provider of the user associated with the event. */
632
- provider?: string;
633
- /**
634
- * Format: date-time
635
- * @description Timestamp when the event was recorded.
636
- */
637
- createdAt?: string;
638
- }[];
639
- };
640
- };
641
- };
642
- /** Unauthorized */
643
- 401: unknown;
644
- /** Not found */
645
- 404: unknown;
646
- /** Server error */
647
- 500: unknown;
648
- };
649
- };
650
- getEventSummaryByUser: {
651
- parameters: {
652
- query: {
653
- /** Get responses by page */
654
- page?: string;
655
- /** Get responses by pagesize */
656
- pagesize?: string;
657
- /** Get responses that match search param value */
658
- search?: string;
659
- /** Get ordered responses */
660
- order?: string;
661
- /** Get filtered reponses */
662
- filter?: string;
663
- };
664
- };
665
- responses: {
666
- /** Event summary page */
667
- 200: {
668
- content: {
669
- "application/json": {
322
+ } & {
323
+ [key: string]: unknown;
324
+ };
325
+ /** @description Per-user event summary entry. */
326
+ EventSummary: {
327
+ [key: string]: unknown;
328
+ };
329
+ /** @description Paginated list of per-user event summaries. */
330
+ EventSummaryPage: {
670
331
  /** @description Current page number of the result set. */
671
332
  page?: number;
672
333
  /** @description Number of items per page. */
@@ -674,47 +335,761 @@ export interface operations {
674
335
  /** @description Total number of items available. */
675
336
  totalCount?: number;
676
337
  /** @description The event summaries returned on the current page. */
677
- data?: { [key: string]: unknown }[];
678
- };
679
- };
680
- };
681
- /** Unauthorized */
682
- 401: unknown;
683
- /** Not found */
684
- 404: unknown;
685
- /** Server error */
686
- 500: unknown;
687
- };
688
- };
689
- getEventTypes: {
690
- parameters: {
691
- query: {
692
- /** Get responses by page */
693
- page?: string;
694
- /** Get responses by pagesize */
695
- pagesize?: string;
696
- };
697
- };
698
- responses: {
699
- /** Event types */
700
- 200: {
701
- content: {
702
- "application/json": {
338
+ data?: {
339
+ [key: string]: unknown;
340
+ }[];
341
+ };
342
+ /** @description A category/action pair describing one kind of event. */
343
+ EventType: {
703
344
  /** @description The category of the event type. */
704
345
  category?: string;
705
346
  /** @description The action of the event type. */
706
347
  action?: string;
707
- }[];
708
- };
709
- };
710
- /** Unauthorized */
711
- 401: unknown;
712
- /** Not found */
713
- 404: unknown;
714
- /** Server error */
715
- 500: unknown;
348
+ };
349
+ /** @description Generic error envelope returned for non-2xx responses. */
350
+ ErrorResponse: {
351
+ /** @description Human-readable error message. */
352
+ error?: string;
353
+ };
354
+ };
355
+ responses: {
356
+ /** @description Invalid request body or request param */
357
+ 400: {
358
+ headers: {
359
+ [name: string]: unknown;
360
+ };
361
+ content: {
362
+ "text/plain": string;
363
+ };
364
+ };
365
+ /** @description Expired JWT token used or insufficient privilege */
366
+ 401: {
367
+ headers: {
368
+ [name: string]: unknown;
369
+ };
370
+ content: {
371
+ "text/plain": string;
372
+ };
373
+ };
374
+ /** @description Result not found */
375
+ 404: {
376
+ headers: {
377
+ [name: string]: unknown;
378
+ };
379
+ content: {
380
+ "text/plain": string;
381
+ };
382
+ };
383
+ /** @description Internal server error */
384
+ 500: {
385
+ headers: {
386
+ [name: string]: unknown;
387
+ };
388
+ content: {
389
+ "text/plain": string;
390
+ };
391
+ };
392
+ };
393
+ parameters: {
394
+ /** @description ID of the event. */
395
+ eventId: string;
396
+ /** @description Workspace ID */
397
+ workspaceId: string;
398
+ /** @description Get responses by page */
399
+ page: string;
400
+ /** @description Get responses by pagesize */
401
+ pagesize: string;
402
+ /** @description Get responses that match search param value */
403
+ search: string;
404
+ /** @description Get ordered responses */
405
+ order: string;
406
+ /** @description When true, return cumulative aggregate counts across all time. */
407
+ cumulative: boolean;
408
+ /** @description Get filtered reponses */
409
+ filter: string;
410
+ /** @description Get filtered reponses */
411
+ eventsFilter: string;
412
+ };
413
+ requestBodies: never;
414
+ headers: never;
415
+ pathItems: never;
416
+ }
417
+ export type $defs = Record<string, never>;
418
+ export interface operations {
419
+ deleteEvent: {
420
+ parameters: {
421
+ query?: never;
422
+ header?: never;
423
+ path: {
424
+ /** @description ID of the event. */
425
+ eventId: string;
426
+ };
427
+ cookie?: never;
428
+ };
429
+ requestBody?: never;
430
+ responses: {
431
+ /** @description Event deleted */
432
+ 204: {
433
+ headers: {
434
+ [name: string]: unknown;
435
+ };
436
+ content?: never;
437
+ };
438
+ /** @description Invalid request body or request param */
439
+ 400: {
440
+ headers: {
441
+ [name: string]: unknown;
442
+ };
443
+ content: {
444
+ "text/plain": string;
445
+ };
446
+ };
447
+ /** @description Expired JWT token used or insufficient privilege */
448
+ 401: {
449
+ headers: {
450
+ [name: string]: unknown;
451
+ };
452
+ content: {
453
+ "text/plain": string;
454
+ };
455
+ };
456
+ /** @description Result not found */
457
+ 404: {
458
+ headers: {
459
+ [name: string]: unknown;
460
+ };
461
+ content: {
462
+ "text/plain": string;
463
+ };
464
+ };
465
+ /** @description Internal server error */
466
+ 500: {
467
+ headers: {
468
+ [name: string]: unknown;
469
+ };
470
+ content: {
471
+ "text/plain": string;
472
+ };
473
+ };
474
+ };
475
+ };
476
+ createEvent: {
477
+ parameters: {
478
+ query?: never;
479
+ header?: never;
480
+ path?: never;
481
+ cookie?: never;
482
+ };
483
+ requestBody: {
484
+ content: {
485
+ "application/json": {
486
+ /**
487
+ * Format: uuid
488
+ * @description UUID of the user associated with the event.
489
+ */
490
+ userId?: string;
491
+ /** @description The category of the event. */
492
+ category?: string;
493
+ /** @description The action of the event. */
494
+ action?: string;
495
+ /** @description Description of the event. */
496
+ description?: string;
497
+ } & {
498
+ [key: string]: unknown;
499
+ };
500
+ };
501
+ };
502
+ responses: {
503
+ /** @description Event created */
504
+ 201: {
505
+ headers: {
506
+ [name: string]: unknown;
507
+ };
508
+ content?: never;
509
+ };
510
+ /** @description Invalid request body or request param */
511
+ 400: {
512
+ headers: {
513
+ [name: string]: unknown;
514
+ };
515
+ content: {
516
+ "text/plain": string;
517
+ };
518
+ };
519
+ /** @description Expired JWT token used or insufficient privilege */
520
+ 401: {
521
+ headers: {
522
+ [name: string]: unknown;
523
+ };
524
+ content: {
525
+ "text/plain": string;
526
+ };
527
+ };
528
+ /** @description Internal server error */
529
+ 500: {
530
+ headers: {
531
+ [name: string]: unknown;
532
+ };
533
+ content: {
534
+ "text/plain": string;
535
+ };
536
+ };
537
+ };
538
+ };
539
+ bulkDeleteEvents: {
540
+ parameters: {
541
+ query?: never;
542
+ header?: never;
543
+ path?: never;
544
+ cookie?: never;
545
+ };
546
+ requestBody: {
547
+ content: {
548
+ "application/json": {
549
+ /** @description UUIDs of the events to delete. */
550
+ ids: string[];
551
+ };
552
+ };
553
+ };
554
+ responses: {
555
+ /** @description Events deleted */
556
+ 200: {
557
+ headers: {
558
+ [name: string]: unknown;
559
+ };
560
+ content: {
561
+ "application/json": {
562
+ /** @description UUIDs of events that were deleted. */
563
+ deleted?: string[];
564
+ };
565
+ };
566
+ };
567
+ /** @description Invalid request body or request param */
568
+ 400: {
569
+ headers: {
570
+ [name: string]: unknown;
571
+ };
572
+ content: {
573
+ "text/plain": string;
574
+ };
575
+ };
576
+ /** @description Expired JWT token used or insufficient privilege */
577
+ 401: {
578
+ headers: {
579
+ [name: string]: unknown;
580
+ };
581
+ content: {
582
+ "text/plain": string;
583
+ };
584
+ };
585
+ /** @description Internal server error */
586
+ 500: {
587
+ headers: {
588
+ [name: string]: unknown;
589
+ };
590
+ content: {
591
+ "text/plain": string;
592
+ };
593
+ };
594
+ };
595
+ };
596
+ bulkUpdateEventStatus: {
597
+ parameters: {
598
+ query?: never;
599
+ header?: never;
600
+ path?: never;
601
+ cookie?: never;
602
+ };
603
+ requestBody: {
604
+ content: {
605
+ "application/json": {
606
+ /** @description UUIDs of the events to update. */
607
+ ids: string[];
608
+ /**
609
+ * @description New status to apply to the selected events.
610
+ * @example failed
611
+ */
612
+ status: string;
613
+ };
614
+ };
615
+ };
616
+ responses: {
617
+ /** @description Events updated */
618
+ 200: {
619
+ headers: {
620
+ [name: string]: unknown;
621
+ };
622
+ content: {
623
+ "application/json": {
624
+ /** @description UUIDs of events whose status was updated. */
625
+ updated?: string[];
626
+ };
627
+ };
628
+ };
629
+ /** @description Invalid request body or request param */
630
+ 400: {
631
+ headers: {
632
+ [name: string]: unknown;
633
+ };
634
+ content: {
635
+ "text/plain": string;
636
+ };
637
+ };
638
+ /** @description Expired JWT token used or insufficient privilege */
639
+ 401: {
640
+ headers: {
641
+ [name: string]: unknown;
642
+ };
643
+ content: {
644
+ "text/plain": string;
645
+ };
646
+ };
647
+ /** @description Internal server error */
648
+ 500: {
649
+ headers: {
650
+ [name: string]: unknown;
651
+ };
652
+ content: {
653
+ "text/plain": string;
654
+ };
655
+ };
656
+ };
657
+ };
658
+ updateEventStatus: {
659
+ parameters: {
660
+ query?: never;
661
+ header?: never;
662
+ path: {
663
+ /** @description ID of the event. */
664
+ eventId: string;
665
+ };
666
+ cookie?: never;
667
+ };
668
+ requestBody: {
669
+ content: {
670
+ "application/json": {
671
+ /**
672
+ * @description Current status of the event.
673
+ * @example completed
674
+ */
675
+ status: string;
676
+ };
677
+ };
678
+ };
679
+ responses: {
680
+ /** @description Event status updated */
681
+ 200: {
682
+ headers: {
683
+ [name: string]: unknown;
684
+ };
685
+ content: {
686
+ "application/json": {
687
+ /** @description Human-readable status message. */
688
+ message?: string;
689
+ /**
690
+ * Format: uuid
691
+ * @description UUID of the event whose status was updated.
692
+ */
693
+ eventId?: string;
694
+ /** @description Updated status of the event. */
695
+ status?: string;
696
+ };
697
+ };
698
+ };
699
+ /** @description Invalid request body or request param */
700
+ 400: {
701
+ headers: {
702
+ [name: string]: unknown;
703
+ };
704
+ content: {
705
+ "text/plain": string;
706
+ };
707
+ };
708
+ /** @description Expired JWT token used or insufficient privilege */
709
+ 401: {
710
+ headers: {
711
+ [name: string]: unknown;
712
+ };
713
+ content: {
714
+ "text/plain": string;
715
+ };
716
+ };
717
+ /** @description Result not found */
718
+ 404: {
719
+ headers: {
720
+ [name: string]: unknown;
721
+ };
722
+ content: {
723
+ "text/plain": string;
724
+ };
725
+ };
726
+ /** @description Internal server error */
727
+ 500: {
728
+ headers: {
729
+ [name: string]: unknown;
730
+ };
731
+ content: {
732
+ "text/plain": string;
733
+ };
734
+ };
735
+ };
736
+ };
737
+ getEventsOfWorkspace: {
738
+ parameters: {
739
+ query?: {
740
+ /** @description Get responses by page */
741
+ page?: string;
742
+ /** @description Get responses by pagesize */
743
+ pagesize?: string;
744
+ /** @description Get responses that match search param value */
745
+ search?: string;
746
+ /** @description Get ordered responses */
747
+ order?: string;
748
+ };
749
+ header?: never;
750
+ path: {
751
+ /** @description Workspace ID */
752
+ workspaceId: string;
753
+ };
754
+ cookie?: never;
755
+ };
756
+ requestBody?: never;
757
+ responses: {
758
+ /** @description Workspace events */
759
+ 200: {
760
+ headers: {
761
+ [name: string]: unknown;
762
+ };
763
+ content: {
764
+ "application/json": {
765
+ /** @description Zero-based page index returned in this response. */
766
+ page?: number;
767
+ /** @description Maximum number of items returned on each page. */
768
+ pageSize?: number;
769
+ /** @description Total number of items across all pages. */
770
+ totalCount?: number;
771
+ /** @description The events returned on the current page. */
772
+ data?: {
773
+ /**
774
+ * Format: uuid
775
+ * @description UUID of the user associated with the event.
776
+ */
777
+ userId: string;
778
+ /** @description System identifier of the event source. */
779
+ systemId?: string;
780
+ /** @description The category of the event. */
781
+ category: string;
782
+ /** @description The action of the event. */
783
+ action: string;
784
+ /** @description Description of the event. */
785
+ description?: string;
786
+ /** @description The first name of the user associated with the event. */
787
+ firstName?: string;
788
+ /** @description The last name of the user associated with the event. */
789
+ lastName?: string;
790
+ /**
791
+ * Format: email
792
+ * @description Email address of the user associated with the event.
793
+ */
794
+ email?: string;
795
+ /** @description Authentication provider of the user associated with the event. */
796
+ provider?: string;
797
+ /**
798
+ * Format: date-time
799
+ * @description Timestamp when the event was recorded.
800
+ */
801
+ createdAt?: string;
802
+ }[];
803
+ };
804
+ };
805
+ };
806
+ /** @description Invalid request */
807
+ 400: {
808
+ headers: {
809
+ [name: string]: unknown;
810
+ };
811
+ content: {
812
+ "application/json": {
813
+ /** @description Human-readable error message. */
814
+ error?: string;
815
+ };
816
+ };
817
+ };
818
+ /** @description Unauthorized */
819
+ 401: {
820
+ headers: {
821
+ [name: string]: unknown;
822
+ };
823
+ content?: never;
824
+ };
825
+ /** @description Workspace not found */
826
+ 404: {
827
+ headers: {
828
+ [name: string]: unknown;
829
+ };
830
+ content?: never;
831
+ };
832
+ /** @description Server error */
833
+ 500: {
834
+ headers: {
835
+ [name: string]: unknown;
836
+ };
837
+ content?: never;
838
+ };
839
+ };
840
+ };
841
+ getEventsAggregate: {
842
+ parameters: {
843
+ query?: {
844
+ /** @description When true, return cumulative aggregate counts across all time. */
845
+ cumulative?: boolean;
846
+ };
847
+ header?: never;
848
+ path?: never;
849
+ cookie?: never;
850
+ };
851
+ requestBody?: never;
852
+ responses: {
853
+ /** @description Events aggregate */
854
+ 200: {
855
+ headers: {
856
+ [name: string]: unknown;
857
+ };
858
+ content: {
859
+ "application/json": {
860
+ /** @description Count of audit-category events. */
861
+ audit?: number;
862
+ } & {
863
+ [key: string]: unknown;
864
+ };
865
+ };
866
+ };
867
+ /** @description Unauthorized */
868
+ 401: {
869
+ headers: {
870
+ [name: string]: unknown;
871
+ };
872
+ content?: never;
873
+ };
874
+ /** @description Not found */
875
+ 404: {
876
+ headers: {
877
+ [name: string]: unknown;
878
+ };
879
+ content?: never;
880
+ };
881
+ /** @description Server error */
882
+ 500: {
883
+ headers: {
884
+ [name: string]: unknown;
885
+ };
886
+ content?: never;
887
+ };
888
+ };
889
+ };
890
+ getEvents: {
891
+ parameters: {
892
+ query?: {
893
+ /** @description Get responses by page */
894
+ page?: string;
895
+ /** @description Get responses by pagesize */
896
+ pagesize?: string;
897
+ /** @description Get responses that match search param value */
898
+ search?: string;
899
+ /** @description Get ordered responses */
900
+ order?: string;
901
+ /** @description Get filtered reponses */
902
+ filter?: string;
903
+ };
904
+ header?: never;
905
+ path?: never;
906
+ cookie?: never;
907
+ };
908
+ requestBody?: never;
909
+ responses: {
910
+ /** @description Events page */
911
+ 200: {
912
+ headers: {
913
+ [name: string]: unknown;
914
+ };
915
+ content: {
916
+ "application/json": {
917
+ /** @description Zero-based page index returned in this response. */
918
+ page?: number;
919
+ /** @description Maximum number of items returned on each page. */
920
+ pageSize?: number;
921
+ /** @description Total number of items across all pages. */
922
+ totalCount?: number;
923
+ /** @description The events returned on the current page. */
924
+ data?: {
925
+ /**
926
+ * Format: uuid
927
+ * @description UUID of the user associated with the event.
928
+ */
929
+ userId: string;
930
+ /** @description System identifier of the event source. */
931
+ systemId?: string;
932
+ /** @description The category of the event. */
933
+ category: string;
934
+ /** @description The action of the event. */
935
+ action: string;
936
+ /** @description Description of the event. */
937
+ description?: string;
938
+ /** @description The first name of the user associated with the event. */
939
+ firstName?: string;
940
+ /** @description The last name of the user associated with the event. */
941
+ lastName?: string;
942
+ /**
943
+ * Format: email
944
+ * @description Email address of the user associated with the event.
945
+ */
946
+ email?: string;
947
+ /** @description Authentication provider of the user associated with the event. */
948
+ provider?: string;
949
+ /**
950
+ * Format: date-time
951
+ * @description Timestamp when the event was recorded.
952
+ */
953
+ createdAt?: string;
954
+ }[];
955
+ };
956
+ };
957
+ };
958
+ /** @description Unauthorized */
959
+ 401: {
960
+ headers: {
961
+ [name: string]: unknown;
962
+ };
963
+ content?: never;
964
+ };
965
+ /** @description Not found */
966
+ 404: {
967
+ headers: {
968
+ [name: string]: unknown;
969
+ };
970
+ content?: never;
971
+ };
972
+ /** @description Server error */
973
+ 500: {
974
+ headers: {
975
+ [name: string]: unknown;
976
+ };
977
+ content?: never;
978
+ };
979
+ };
980
+ };
981
+ getEventSummaryByUser: {
982
+ parameters: {
983
+ query?: {
984
+ /** @description Get responses by page */
985
+ page?: string;
986
+ /** @description Get responses by pagesize */
987
+ pagesize?: string;
988
+ /** @description Get responses that match search param value */
989
+ search?: string;
990
+ /** @description Get ordered responses */
991
+ order?: string;
992
+ /** @description Get filtered reponses */
993
+ filter?: string;
994
+ };
995
+ header?: never;
996
+ path?: never;
997
+ cookie?: never;
998
+ };
999
+ requestBody?: never;
1000
+ responses: {
1001
+ /** @description Event summary page */
1002
+ 200: {
1003
+ headers: {
1004
+ [name: string]: unknown;
1005
+ };
1006
+ content: {
1007
+ "application/json": {
1008
+ /** @description Current page number of the result set. */
1009
+ page?: number;
1010
+ /** @description Number of items per page. */
1011
+ pageSize?: number;
1012
+ /** @description Total number of items available. */
1013
+ totalCount?: number;
1014
+ /** @description The event summaries returned on the current page. */
1015
+ data?: {
1016
+ [key: string]: unknown;
1017
+ }[];
1018
+ };
1019
+ };
1020
+ };
1021
+ /** @description Unauthorized */
1022
+ 401: {
1023
+ headers: {
1024
+ [name: string]: unknown;
1025
+ };
1026
+ content?: never;
1027
+ };
1028
+ /** @description Not found */
1029
+ 404: {
1030
+ headers: {
1031
+ [name: string]: unknown;
1032
+ };
1033
+ content?: never;
1034
+ };
1035
+ /** @description Server error */
1036
+ 500: {
1037
+ headers: {
1038
+ [name: string]: unknown;
1039
+ };
1040
+ content?: never;
1041
+ };
1042
+ };
1043
+ };
1044
+ getEventTypes: {
1045
+ parameters: {
1046
+ query?: {
1047
+ /** @description Get responses by page */
1048
+ page?: string;
1049
+ /** @description Get responses by pagesize */
1050
+ pagesize?: string;
1051
+ };
1052
+ header?: never;
1053
+ path?: never;
1054
+ cookie?: never;
1055
+ };
1056
+ requestBody?: never;
1057
+ responses: {
1058
+ /** @description Event types */
1059
+ 200: {
1060
+ headers: {
1061
+ [name: string]: unknown;
1062
+ };
1063
+ content: {
1064
+ "application/json": {
1065
+ /** @description The category of the event type. */
1066
+ category?: string;
1067
+ /** @description The action of the event type. */
1068
+ action?: string;
1069
+ }[];
1070
+ };
1071
+ };
1072
+ /** @description Unauthorized */
1073
+ 401: {
1074
+ headers: {
1075
+ [name: string]: unknown;
1076
+ };
1077
+ content?: never;
1078
+ };
1079
+ /** @description Not found */
1080
+ 404: {
1081
+ headers: {
1082
+ [name: string]: unknown;
1083
+ };
1084
+ content?: never;
1085
+ };
1086
+ /** @description Server error */
1087
+ 500: {
1088
+ headers: {
1089
+ [name: string]: unknown;
1090
+ };
1091
+ content?: never;
1092
+ };
1093
+ };
716
1094
  };
717
- };
718
1095
  }
719
-
720
- export interface external {}