@leaflow/sdk 0.0.0-dev.101.g01ce843

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 (48) hide show
  1. package/README.md +34 -0
  2. package/dist/account/v1/index.d.ts +54 -0
  3. package/dist/account/v1/index.js +5 -0
  4. package/dist/account/v1/schema.d.ts +1157 -0
  5. package/dist/account/v1/schema.js +5 -0
  6. package/dist/assistant/v1/index.d.ts +108 -0
  7. package/dist/assistant/v1/index.js +5 -0
  8. package/dist/assistant/v1/schema.d.ts +2840 -0
  9. package/dist/assistant/v1/schema.js +5 -0
  10. package/dist/billing/v1/index.d.ts +74 -0
  11. package/dist/billing/v1/index.js +5 -0
  12. package/dist/billing/v1/schema.d.ts +2445 -0
  13. package/dist/billing/v1/schema.js +5 -0
  14. package/dist/canopy/v1/index.d.ts +48 -0
  15. package/dist/canopy/v1/index.js +5 -0
  16. package/dist/canopy/v1/schema.d.ts +1100 -0
  17. package/dist/canopy/v1/schema.js +5 -0
  18. package/dist/compute/v1/index.d.ts +246 -0
  19. package/dist/compute/v1/index.js +5 -0
  20. package/dist/compute/v1/schema.d.ts +4924 -0
  21. package/dist/compute/v1/schema.js +5 -0
  22. package/dist/dns/v1/index.d.ts +42 -0
  23. package/dist/dns/v1/index.js +5 -0
  24. package/dist/dns/v1/schema.d.ts +883 -0
  25. package/dist/dns/v1/schema.js +5 -0
  26. package/dist/iam/v1/index.d.ts +84 -0
  27. package/dist/iam/v1/index.js +5 -0
  28. package/dist/iam/v1/schema.d.ts +1658 -0
  29. package/dist/iam/v1/schema.js +5 -0
  30. package/dist/index.d.ts +11 -0
  31. package/dist/index.js +6 -0
  32. package/dist/monitoring/v1/index.d.ts +176 -0
  33. package/dist/monitoring/v1/index.js +5 -0
  34. package/dist/monitoring/v1/schema.d.ts +4181 -0
  35. package/dist/monitoring/v1/schema.js +5 -0
  36. package/dist/notification/v1/index.d.ts +76 -0
  37. package/dist/notification/v1/index.js +5 -0
  38. package/dist/notification/v1/schema.d.ts +2038 -0
  39. package/dist/notification/v1/schema.js +5 -0
  40. package/dist/support/v1/index.d.ts +50 -0
  41. package/dist/support/v1/index.js +5 -0
  42. package/dist/support/v1/schema.d.ts +1078 -0
  43. package/dist/support/v1/schema.js +5 -0
  44. package/dist/tunnel/v1/index.d.ts +16 -0
  45. package/dist/tunnel/v1/index.js +5 -0
  46. package/dist/tunnel/v1/schema.d.ts +401 -0
  47. package/dist/tunnel/v1/schema.js +5 -0
  48. package/package.json +74 -0
@@ -0,0 +1,1078 @@
1
+ /**
2
+ * This file was auto-generated by openapi-typescript.
3
+ * Do not make direct changes to the file.
4
+ */
5
+ export interface paths {
6
+ "/api/v1/notices": {
7
+ parameters: {
8
+ query?: never;
9
+ header?: never;
10
+ path?: never;
11
+ cookie?: never;
12
+ };
13
+ /**
14
+ * List the maintenance in effect right now
15
+ * @description Returns the maintenance windows that have not finished yet.
16
+ *
17
+ * **This operation requires no credentials.** It is intended for sign-in pages and status
18
+ * pages, which are reached before a project has been selected. It returns a narrower shape
19
+ * than the authenticated operations and is not paginated.
20
+ *
21
+ * Platform announcements are not part of this API. They are served by the notification
22
+ * service, which owns platform-wide announcements.
23
+ */
24
+ get: operations["list-notices"];
25
+ put?: never;
26
+ post?: never;
27
+ delete?: never;
28
+ options?: never;
29
+ head?: never;
30
+ patch?: never;
31
+ trace?: never;
32
+ };
33
+ "/api/v1/tickets": {
34
+ parameters: {
35
+ query?: never;
36
+ header?: never;
37
+ path?: never;
38
+ cookie?: never;
39
+ };
40
+ /**
41
+ * List tickets in the current project
42
+ * @description Ordered by most recent activity first, which is not the same as most recently opened.
43
+ */
44
+ get: operations["list-tickets"];
45
+ put?: never;
46
+ /**
47
+ * Open a ticket
48
+ * @description Opens a ticket and posts its first message in one request. A ticket always has at least one
49
+ * message.
50
+ *
51
+ * The new ticket is `OPEN`. Its `number` is assigned here and is the identifier to quote when
52
+ * contacting support by other means.
53
+ *
54
+ * `category_id` is optional. Submitting a category that has been disabled returns
55
+ * `TICKET_CATEGORY_DISABLED`; the categories accepting new tickets are those returned by
56
+ * `GET /api/v1/ticket-categories`.
57
+ */
58
+ post: operations["create-ticket"];
59
+ delete?: never;
60
+ options?: never;
61
+ head?: never;
62
+ patch?: never;
63
+ trace?: never;
64
+ };
65
+ "/api/v1/tickets/{ticketId}": {
66
+ parameters: {
67
+ query?: never;
68
+ header?: never;
69
+ path?: never;
70
+ cookie?: never;
71
+ };
72
+ /**
73
+ * Get a ticket
74
+ * @description Returns 404 for a ticket that belongs to another project.
75
+ */
76
+ get: operations["get-ticket"];
77
+ put?: never;
78
+ post?: never;
79
+ delete?: never;
80
+ options?: never;
81
+ head?: never;
82
+ patch?: never;
83
+ trace?: never;
84
+ };
85
+ "/api/v1/tickets/{ticketId}/close": {
86
+ parameters: {
87
+ query?: never;
88
+ header?: never;
89
+ path?: never;
90
+ cookie?: never;
91
+ };
92
+ get?: never;
93
+ put?: never;
94
+ /**
95
+ * Close a ticket
96
+ * @description Closing a ticket that is already closed succeeds and changes nothing.
97
+ *
98
+ * A closed ticket can be rated once; see `POST /api/v1/tickets/{ticketId}/satisfaction`.
99
+ * Posting a further message reopens it.
100
+ */
101
+ post: operations["close-ticket"];
102
+ delete?: never;
103
+ options?: never;
104
+ head?: never;
105
+ patch?: never;
106
+ trace?: never;
107
+ };
108
+ "/api/v1/tickets/{ticketId}/messages": {
109
+ parameters: {
110
+ query?: never;
111
+ header?: never;
112
+ path?: never;
113
+ cookie?: never;
114
+ };
115
+ /**
116
+ * List the messages on a ticket
117
+ * @description Ordered oldest first, because a ticket is a conversation.
118
+ */
119
+ get: operations["list-ticket-messages"];
120
+ put?: never;
121
+ /**
122
+ * Post a message on a ticket
123
+ * @description Moves the ticket to `OPEN`. Posting on a closed ticket reopens it.
124
+ *
125
+ * Each id in `attachment_ids` must name an attachment uploaded in this project that no other
126
+ * message references; otherwise the request fails with `TICKET_ATTACHMENT_ALREADY_ATTACHED`
127
+ * and no message is posted.
128
+ */
129
+ post: operations["create-ticket-message"];
130
+ delete?: never;
131
+ options?: never;
132
+ head?: never;
133
+ patch?: never;
134
+ trace?: never;
135
+ };
136
+ "/api/v1/tickets/{ticketId}/satisfaction": {
137
+ parameters: {
138
+ query?: never;
139
+ header?: never;
140
+ path?: never;
141
+ cookie?: never;
142
+ };
143
+ /** Get the rating submitted for a ticket */
144
+ get: operations["get-ticket-satisfaction"];
145
+ put?: never;
146
+ /**
147
+ * Rate a ticket
148
+ * @description The ticket must be closed; otherwise the request returns `TICKET_NOT_CLOSED`.
149
+ *
150
+ * A ticket can be rated once. A second submission returns
151
+ * `TICKET_SATISFACTION_ALREADY_SUBMITTED`, including after the ticket has been reopened and
152
+ * closed again.
153
+ */
154
+ post: operations["create-ticket-satisfaction"];
155
+ delete?: never;
156
+ options?: never;
157
+ head?: never;
158
+ patch?: never;
159
+ trace?: never;
160
+ };
161
+ "/api/v1/ticket-categories": {
162
+ parameters: {
163
+ query?: never;
164
+ header?: never;
165
+ path?: never;
166
+ cookie?: never;
167
+ };
168
+ /**
169
+ * List the categories accepting new tickets
170
+ * @description Ordered for presentation. Categories no longer accepting new tickets are omitted, including those still attached to existing tickets.
171
+ */
172
+ get: operations["list-ticket-categories"];
173
+ put?: never;
174
+ post?: never;
175
+ delete?: never;
176
+ options?: never;
177
+ head?: never;
178
+ patch?: never;
179
+ trace?: never;
180
+ };
181
+ "/api/v1/attachments": {
182
+ parameters: {
183
+ query?: never;
184
+ header?: never;
185
+ path?: never;
186
+ cookie?: never;
187
+ };
188
+ get?: never;
189
+ put?: never;
190
+ /**
191
+ * Upload an attachment
192
+ * @description The body is the file bytes themselves, not multipart, one file per request. The content type
193
+ * is determined from the content, not from the `Content-Type` header.
194
+ *
195
+ * Pass the returned id in `attachment_ids` when opening a ticket or posting a message. An
196
+ * attachment that is never referenced by a message is removed after a time.
197
+ */
198
+ post: operations["upload-attachment"];
199
+ delete?: never;
200
+ options?: never;
201
+ head?: never;
202
+ patch?: never;
203
+ trace?: never;
204
+ };
205
+ "/api/v1/attachments/{attachmentId}/content": {
206
+ parameters: {
207
+ query?: never;
208
+ header?: never;
209
+ path?: never;
210
+ cookie?: never;
211
+ };
212
+ /**
213
+ * Download an attachment
214
+ * @description Serves the file itself. The bytes are proxied by this API; the object store is not reachable
215
+ * from outside, and no address to it is ever handed out.
216
+ *
217
+ * `Content-Type` is the type determined from the content at upload time, not the one the
218
+ * client claimed. `Content-Disposition` is `attachment` unless `inline` is requested **and**
219
+ * the content type is one that can be rendered safely, in which case it is `inline`. Asking
220
+ * for `inline` on anything else still yields a download.
221
+ */
222
+ get: operations["download-attachment"];
223
+ put?: never;
224
+ post?: never;
225
+ delete?: never;
226
+ options?: never;
227
+ head?: never;
228
+ patch?: never;
229
+ trace?: never;
230
+ };
231
+ "/api/v1/maintenances": {
232
+ parameters: {
233
+ query?: never;
234
+ header?: never;
235
+ path?: never;
236
+ cookie?: never;
237
+ };
238
+ /**
239
+ * List maintenance notices
240
+ * @description Ordered by scheduled start, most recent first. Cancelled maintenance is omitted.
241
+ *
242
+ * `scheduled_for` and `scheduled_until` are what was announced; `started_at` and
243
+ * `completed_at` are what actually happened, and are null until it does.
244
+ */
245
+ get: operations["list-maintenances"];
246
+ put?: never;
247
+ post?: never;
248
+ delete?: never;
249
+ options?: never;
250
+ head?: never;
251
+ patch?: never;
252
+ trace?: never;
253
+ };
254
+ "/api/v1/maintenances/{maintenanceId}": {
255
+ parameters: {
256
+ query?: never;
257
+ header?: never;
258
+ path?: never;
259
+ cookie?: never;
260
+ };
261
+ /**
262
+ * Get a maintenance notice
263
+ * @description Returns 404 for cancelled maintenance.
264
+ */
265
+ get: operations["get-maintenance"];
266
+ put?: never;
267
+ post?: never;
268
+ delete?: never;
269
+ options?: never;
270
+ head?: never;
271
+ patch?: never;
272
+ trace?: never;
273
+ };
274
+ "/api/v1/maintenances/{maintenanceId}/timeline": {
275
+ parameters: {
276
+ query?: never;
277
+ header?: never;
278
+ path?: never;
279
+ cookie?: never;
280
+ };
281
+ /**
282
+ * List the updates posted during a maintenance
283
+ * @description Ordered oldest first, because it is an account of what happened.
284
+ */
285
+ get: operations["list-maintenance-timeline"];
286
+ put?: never;
287
+ post?: never;
288
+ delete?: never;
289
+ options?: never;
290
+ head?: never;
291
+ patch?: never;
292
+ trace?: never;
293
+ };
294
+ }
295
+ export type webhooks = Record<string, never>;
296
+ export interface components {
297
+ schemas: {
298
+ Error: {
299
+ code?: string;
300
+ message: string;
301
+ meta?: {
302
+ [key: string]: unknown;
303
+ };
304
+ /** Format: int64 */
305
+ status: number;
306
+ };
307
+ /**
308
+ * @description `OPEN` is waiting on us. `AWAITING_USER` is waiting on you. `CLOSED` is finished.
309
+ *
310
+ * The state follows whoever spoke last and cannot be set directly.
311
+ * @enum {string}
312
+ */
313
+ TicketStatus: "OPEN" | "AWAITING_USER" | "CLOSED";
314
+ /**
315
+ * @description How urgent the ticket is. It affects the order support works through tickets; it is not a commitment to a response time.
316
+ * @enum {string}
317
+ */
318
+ TicketPriority: "LOW" | "NORMAL" | "HIGH" | "URGENT";
319
+ /**
320
+ * @description Whether a message was written by a project member or by support.
321
+ * @enum {string}
322
+ */
323
+ TicketAuthorType: "USER" | "OPERATOR";
324
+ /**
325
+ * @description `SCHEDULED` has been announced but has not started. `IN_PROGRESS` is under way. `COMPLETED`
326
+ * has finished. `CANCELLED` was announced and then called off, and never took place.
327
+ * @enum {string}
328
+ */
329
+ MaintenanceStatus: "SCHEDULED" | "IN_PROGRESS" | "COMPLETED" | "CANCELLED";
330
+ /**
331
+ * @description What users should expect during the window.
332
+ * @enum {string}
333
+ */
334
+ MaintenanceImpact: "NONE" | "DEGRADED" | "PARTIAL_OUTAGE" | "MAJOR_OUTAGE";
335
+ /** @description A support ticket, owned by the project it was opened in. */
336
+ TicketResource: {
337
+ /** @description The category this ticket is in; null when it has none */
338
+ category: components["schemas"]["TicketCategoryResource"] | null;
339
+ /**
340
+ * Format: date-time
341
+ * @description When the ticket was closed; null while it is open
342
+ */
343
+ closed_at: string | null;
344
+ /** Format: date-time */
345
+ created_at: string;
346
+ /** @description The user who opened the ticket. Every member of the project can read and reply to it regardless */
347
+ created_by: string;
348
+ /** Format: uuid */
349
+ id: string;
350
+ /**
351
+ * Format: date-time
352
+ * @description When someone last spoke on this ticket. Changing the priority or the category does not affect it
353
+ */
354
+ last_activity_at: string;
355
+ /** @description The human-readable identifier to quote when contacting support by other means */
356
+ number: string;
357
+ priority: components["schemas"]["TicketPriority"];
358
+ /** @description The rating submitted for this ticket; null when it has not been rated */
359
+ satisfaction: components["schemas"]["TicketSatisfactionResource"] | null;
360
+ status: components["schemas"]["TicketStatus"];
361
+ subject: string;
362
+ /** Format: date-time */
363
+ updated_at: string;
364
+ };
365
+ /** @description A ticket category. */
366
+ TicketCategoryResource: {
367
+ description: string | null;
368
+ /** Format: uuid */
369
+ id: string;
370
+ name: string;
371
+ };
372
+ /** @description One message on a ticket. */
373
+ TicketMessageResource: {
374
+ attachments: components["schemas"]["TicketAttachmentResource"][];
375
+ /** @description The identifier of whoever wrote the message, interpreted according to author_type */
376
+ author_id: string;
377
+ author_type: components["schemas"]["TicketAuthorType"];
378
+ body: string;
379
+ /** Format: date-time */
380
+ created_at: string;
381
+ /** Format: uuid */
382
+ id: string;
383
+ };
384
+ /** @description A file uploaded for a ticket. The bytes are retrieved separately; see the download-url operation. */
385
+ TicketAttachmentResource: {
386
+ /** @description Determined from the content, which may differ from the Content-Type sent on upload */
387
+ content_type: string;
388
+ /** Format: date-time */
389
+ created_at: string;
390
+ filename: string;
391
+ /** Format: uuid */
392
+ id: string;
393
+ /** Format: int64 */
394
+ size_bytes: number;
395
+ };
396
+ /** @description The rating submitted for a ticket. */
397
+ TicketSatisfactionResource: {
398
+ comment: string | null;
399
+ /** Format: date-time */
400
+ created_at: string;
401
+ /** Format: uuid */
402
+ id: string;
403
+ /** Format: int64 */
404
+ score: number;
405
+ };
406
+ /** @description A scheduled maintenance notice published by platform operators. */
407
+ MaintenanceResource: {
408
+ /** @description Markdown */
409
+ body: string;
410
+ /**
411
+ * Format: date-time
412
+ * @description When the maintenance actually finished; null until it does
413
+ */
414
+ completed_at: string | null;
415
+ /** @description What this maintenance affects. The names are those used by the services concerned */
416
+ components: string[];
417
+ /** Format: uuid */
418
+ id: string;
419
+ impact: components["schemas"]["MaintenanceImpact"];
420
+ /**
421
+ * Format: date-time
422
+ * @description The announced start
423
+ */
424
+ scheduled_for: string;
425
+ /**
426
+ * Format: date-time
427
+ * @description The announced end
428
+ */
429
+ scheduled_until: string;
430
+ /**
431
+ * Format: date-time
432
+ * @description When the maintenance actually started; null until it does
433
+ */
434
+ started_at: string | null;
435
+ status: components["schemas"]["MaintenanceStatus"];
436
+ title: string;
437
+ };
438
+ /** @description One update posted during a maintenance. */
439
+ MaintenanceTimelineEntryResource: {
440
+ body: string;
441
+ /** Format: date-time */
442
+ created_at: string;
443
+ /** Format: uuid */
444
+ id: string;
445
+ /** @description The impact this update declared; null when the update did not change it */
446
+ impact: components["schemas"]["MaintenanceImpact"] | null;
447
+ /** @description The state this update moved the maintenance to; null when the update did not change it */
448
+ status: components["schemas"]["MaintenanceStatus"] | null;
449
+ };
450
+ /**
451
+ * @description What is in effect right now, for readers who have not signed in.
452
+ *
453
+ * This shape is deliberately narrower than the authenticated resources and carries no read
454
+ * state.
455
+ */
456
+ NoticeResource: {
457
+ maintenances: components["schemas"]["NoticeMaintenanceResource"][];
458
+ };
459
+ NoticeMaintenanceResource: {
460
+ /** @description Markdown */
461
+ body: string;
462
+ components: string[];
463
+ /** Format: uuid */
464
+ id: string;
465
+ impact: components["schemas"]["MaintenanceImpact"];
466
+ /** Format: date-time */
467
+ scheduled_for: string;
468
+ /** Format: date-time */
469
+ scheduled_until: string;
470
+ /** Format: date-time */
471
+ started_at: string | null;
472
+ status: components["schemas"]["MaintenanceStatus"];
473
+ title: string;
474
+ };
475
+ CreateTicketRequestBody: {
476
+ /** @description Attachments to reference from the first message. Each must have been uploaded in this project and not yet referenced */
477
+ attachment_ids?: string[];
478
+ /** @description The first message. Markdown */
479
+ body: string;
480
+ /** Format: uuid */
481
+ category_id?: string;
482
+ priority?: components["schemas"]["TicketPriority"];
483
+ subject: string;
484
+ };
485
+ CreateTicketMessageRequestBody: {
486
+ /** @description Attachments to reference. Each must have been uploaded in this project and not yet referenced */
487
+ attachment_ids?: string[];
488
+ /** @description Markdown */
489
+ body: string;
490
+ };
491
+ CreateTicketSatisfactionRequestBody: {
492
+ comment?: string;
493
+ /** Format: int64 */
494
+ score: number;
495
+ };
496
+ LengthAwarePageTicketResource: {
497
+ /** @description The contents of this page */
498
+ items: components["schemas"]["TicketResource"][];
499
+ /**
500
+ * Format: int64
501
+ * @description Maximum items per page, echoing the value in the request
502
+ */
503
+ limit: number;
504
+ /**
505
+ * Format: int64
506
+ * @description Items skipped, echoing the value in the request
507
+ */
508
+ offset: number;
509
+ /**
510
+ * Format: int64
511
+ * @description Total number of matching items, not only those in this page
512
+ */
513
+ total: number;
514
+ };
515
+ LengthAwarePageTicketMessageResource: {
516
+ /** @description The contents of this page */
517
+ items: components["schemas"]["TicketMessageResource"][];
518
+ /** Format: int64 */
519
+ limit: number;
520
+ /** Format: int64 */
521
+ offset: number;
522
+ /** Format: int64 */
523
+ total: number;
524
+ };
525
+ LengthAwarePageTicketCategoryResource: {
526
+ /** @description The contents of this page */
527
+ items: components["schemas"]["TicketCategoryResource"][];
528
+ /** Format: int64 */
529
+ limit: number;
530
+ /** Format: int64 */
531
+ offset: number;
532
+ /** Format: int64 */
533
+ total: number;
534
+ };
535
+ LengthAwarePageMaintenanceResource: {
536
+ /** @description The contents of this page */
537
+ items: components["schemas"]["MaintenanceResource"][];
538
+ /** Format: int64 */
539
+ limit: number;
540
+ /** Format: int64 */
541
+ offset: number;
542
+ /** Format: int64 */
543
+ total: number;
544
+ };
545
+ LengthAwarePageMaintenanceTimelineEntryResource: {
546
+ /** @description The contents of this page */
547
+ items: components["schemas"]["MaintenanceTimelineEntryResource"][];
548
+ /** Format: int64 */
549
+ limit: number;
550
+ /** Format: int64 */
551
+ offset: number;
552
+ /** Format: int64 */
553
+ total: number;
554
+ };
555
+ };
556
+ responses: never;
557
+ parameters: never;
558
+ requestBodies: never;
559
+ headers: never;
560
+ pathItems: never;
561
+ }
562
+ export type $defs = Record<string, never>;
563
+ export interface operations {
564
+ "list-notices": {
565
+ parameters: {
566
+ query?: never;
567
+ header?: never;
568
+ path?: never;
569
+ cookie?: never;
570
+ };
571
+ requestBody?: never;
572
+ responses: {
573
+ /** @description OK */
574
+ 200: {
575
+ headers: {
576
+ [name: string]: unknown;
577
+ };
578
+ content: {
579
+ "application/json": components["schemas"]["NoticeResource"];
580
+ };
581
+ };
582
+ /** @description Error */
583
+ default: {
584
+ headers: {
585
+ [name: string]: unknown;
586
+ };
587
+ content: {
588
+ "application/json": components["schemas"]["Error"];
589
+ };
590
+ };
591
+ };
592
+ };
593
+ "list-tickets": {
594
+ parameters: {
595
+ query?: {
596
+ /** @description Maximum number of items to return in this page */
597
+ limit?: number;
598
+ /** @description Number of items to skip */
599
+ offset?: number;
600
+ /** @description Return only tickets in this state; omit for all states */
601
+ status?: components["schemas"]["TicketStatus"];
602
+ /** @description Return only tickets at this priority; omit for all priorities */
603
+ priority?: components["schemas"]["TicketPriority"];
604
+ /** @description Return only tickets in this category; omit for all categories */
605
+ category_id?: string;
606
+ /** @description Match against the subject and the ticket number, case-insensitively */
607
+ keyword?: string;
608
+ };
609
+ header?: never;
610
+ path?: never;
611
+ cookie?: never;
612
+ };
613
+ requestBody?: never;
614
+ responses: {
615
+ /** @description OK */
616
+ 200: {
617
+ headers: {
618
+ [name: string]: unknown;
619
+ };
620
+ content: {
621
+ "application/json": components["schemas"]["LengthAwarePageTicketResource"];
622
+ };
623
+ };
624
+ /** @description Error */
625
+ default: {
626
+ headers: {
627
+ [name: string]: unknown;
628
+ };
629
+ content: {
630
+ "application/json": components["schemas"]["Error"];
631
+ };
632
+ };
633
+ };
634
+ };
635
+ "create-ticket": {
636
+ parameters: {
637
+ query?: never;
638
+ header?: never;
639
+ path?: never;
640
+ cookie?: never;
641
+ };
642
+ requestBody: {
643
+ content: {
644
+ "application/json": components["schemas"]["CreateTicketRequestBody"];
645
+ };
646
+ };
647
+ responses: {
648
+ /** @description Created */
649
+ 201: {
650
+ headers: {
651
+ [name: string]: unknown;
652
+ };
653
+ content: {
654
+ "application/json": components["schemas"]["TicketResource"];
655
+ };
656
+ };
657
+ /** @description Error */
658
+ default: {
659
+ headers: {
660
+ [name: string]: unknown;
661
+ };
662
+ content: {
663
+ "application/json": components["schemas"]["Error"];
664
+ };
665
+ };
666
+ };
667
+ };
668
+ "get-ticket": {
669
+ parameters: {
670
+ query?: never;
671
+ header?: never;
672
+ path: {
673
+ ticketId: string;
674
+ };
675
+ cookie?: never;
676
+ };
677
+ requestBody?: never;
678
+ responses: {
679
+ /** @description OK */
680
+ 200: {
681
+ headers: {
682
+ [name: string]: unknown;
683
+ };
684
+ content: {
685
+ "application/json": components["schemas"]["TicketResource"];
686
+ };
687
+ };
688
+ /** @description Error */
689
+ default: {
690
+ headers: {
691
+ [name: string]: unknown;
692
+ };
693
+ content: {
694
+ "application/json": components["schemas"]["Error"];
695
+ };
696
+ };
697
+ };
698
+ };
699
+ "close-ticket": {
700
+ parameters: {
701
+ query?: never;
702
+ header?: never;
703
+ path: {
704
+ ticketId: string;
705
+ };
706
+ cookie?: never;
707
+ };
708
+ requestBody?: never;
709
+ responses: {
710
+ /** @description OK */
711
+ 200: {
712
+ headers: {
713
+ [name: string]: unknown;
714
+ };
715
+ content: {
716
+ "application/json": components["schemas"]["TicketResource"];
717
+ };
718
+ };
719
+ /** @description Error */
720
+ default: {
721
+ headers: {
722
+ [name: string]: unknown;
723
+ };
724
+ content: {
725
+ "application/json": components["schemas"]["Error"];
726
+ };
727
+ };
728
+ };
729
+ };
730
+ "list-ticket-messages": {
731
+ parameters: {
732
+ query?: {
733
+ /** @description Maximum number of items to return in this page */
734
+ limit?: number;
735
+ /** @description Number of items to skip */
736
+ offset?: number;
737
+ };
738
+ header?: never;
739
+ path: {
740
+ ticketId: string;
741
+ };
742
+ cookie?: never;
743
+ };
744
+ requestBody?: never;
745
+ responses: {
746
+ /** @description OK */
747
+ 200: {
748
+ headers: {
749
+ [name: string]: unknown;
750
+ };
751
+ content: {
752
+ "application/json": components["schemas"]["LengthAwarePageTicketMessageResource"];
753
+ };
754
+ };
755
+ /** @description Error */
756
+ default: {
757
+ headers: {
758
+ [name: string]: unknown;
759
+ };
760
+ content: {
761
+ "application/json": components["schemas"]["Error"];
762
+ };
763
+ };
764
+ };
765
+ };
766
+ "create-ticket-message": {
767
+ parameters: {
768
+ query?: never;
769
+ header?: never;
770
+ path: {
771
+ ticketId: string;
772
+ };
773
+ cookie?: never;
774
+ };
775
+ requestBody: {
776
+ content: {
777
+ "application/json": components["schemas"]["CreateTicketMessageRequestBody"];
778
+ };
779
+ };
780
+ responses: {
781
+ /** @description Created */
782
+ 201: {
783
+ headers: {
784
+ [name: string]: unknown;
785
+ };
786
+ content: {
787
+ "application/json": components["schemas"]["TicketMessageResource"];
788
+ };
789
+ };
790
+ /** @description Error */
791
+ default: {
792
+ headers: {
793
+ [name: string]: unknown;
794
+ };
795
+ content: {
796
+ "application/json": components["schemas"]["Error"];
797
+ };
798
+ };
799
+ };
800
+ };
801
+ "get-ticket-satisfaction": {
802
+ parameters: {
803
+ query?: never;
804
+ header?: never;
805
+ path: {
806
+ ticketId: string;
807
+ };
808
+ cookie?: never;
809
+ };
810
+ requestBody?: never;
811
+ responses: {
812
+ /** @description OK */
813
+ 200: {
814
+ headers: {
815
+ [name: string]: unknown;
816
+ };
817
+ content: {
818
+ "application/json": components["schemas"]["TicketSatisfactionResource"];
819
+ };
820
+ };
821
+ /** @description Error */
822
+ default: {
823
+ headers: {
824
+ [name: string]: unknown;
825
+ };
826
+ content: {
827
+ "application/json": components["schemas"]["Error"];
828
+ };
829
+ };
830
+ };
831
+ };
832
+ "create-ticket-satisfaction": {
833
+ parameters: {
834
+ query?: never;
835
+ header?: never;
836
+ path: {
837
+ ticketId: string;
838
+ };
839
+ cookie?: never;
840
+ };
841
+ requestBody: {
842
+ content: {
843
+ "application/json": components["schemas"]["CreateTicketSatisfactionRequestBody"];
844
+ };
845
+ };
846
+ responses: {
847
+ /** @description Created */
848
+ 201: {
849
+ headers: {
850
+ [name: string]: unknown;
851
+ };
852
+ content: {
853
+ "application/json": components["schemas"]["TicketSatisfactionResource"];
854
+ };
855
+ };
856
+ /** @description Error */
857
+ default: {
858
+ headers: {
859
+ [name: string]: unknown;
860
+ };
861
+ content: {
862
+ "application/json": components["schemas"]["Error"];
863
+ };
864
+ };
865
+ };
866
+ };
867
+ "list-ticket-categories": {
868
+ parameters: {
869
+ query?: {
870
+ /** @description Maximum number of items to return in this page */
871
+ limit?: number;
872
+ /** @description Number of items to skip */
873
+ offset?: number;
874
+ };
875
+ header?: never;
876
+ path?: never;
877
+ cookie?: never;
878
+ };
879
+ requestBody?: never;
880
+ responses: {
881
+ /** @description OK */
882
+ 200: {
883
+ headers: {
884
+ [name: string]: unknown;
885
+ };
886
+ content: {
887
+ "application/json": components["schemas"]["LengthAwarePageTicketCategoryResource"];
888
+ };
889
+ };
890
+ /** @description Error */
891
+ default: {
892
+ headers: {
893
+ [name: string]: unknown;
894
+ };
895
+ content: {
896
+ "application/json": components["schemas"]["Error"];
897
+ };
898
+ };
899
+ };
900
+ };
901
+ "upload-attachment": {
902
+ parameters: {
903
+ query: {
904
+ /** @description The file name to record, and the name the file is served under when downloaded */
905
+ filename: string;
906
+ };
907
+ header?: never;
908
+ path?: never;
909
+ cookie?: never;
910
+ };
911
+ requestBody: {
912
+ content: {
913
+ "application/octet-stream": string;
914
+ };
915
+ };
916
+ responses: {
917
+ /** @description Created */
918
+ 201: {
919
+ headers: {
920
+ [name: string]: unknown;
921
+ };
922
+ content: {
923
+ "application/json": components["schemas"]["TicketAttachmentResource"];
924
+ };
925
+ };
926
+ /** @description Error */
927
+ default: {
928
+ headers: {
929
+ [name: string]: unknown;
930
+ };
931
+ content: {
932
+ "application/json": components["schemas"]["Error"];
933
+ };
934
+ };
935
+ };
936
+ };
937
+ "download-attachment": {
938
+ parameters: {
939
+ query?: {
940
+ /** @description Render in the browser instead of downloading, where the content type allows it */
941
+ inline?: boolean;
942
+ };
943
+ header?: never;
944
+ path: {
945
+ attachmentId: string;
946
+ };
947
+ cookie?: never;
948
+ };
949
+ requestBody?: never;
950
+ responses: {
951
+ /** @description OK */
952
+ 200: {
953
+ headers: {
954
+ /** @description `inline` when the content type can be rendered safely and `inline` was asked for, `attachment` otherwise. Carries the original file name */
955
+ "Content-Disposition"?: string;
956
+ [name: string]: unknown;
957
+ };
958
+ content: {
959
+ "*/*": string;
960
+ };
961
+ };
962
+ /** @description Error */
963
+ default: {
964
+ headers: {
965
+ [name: string]: unknown;
966
+ };
967
+ content: {
968
+ "application/json": components["schemas"]["Error"];
969
+ };
970
+ };
971
+ };
972
+ };
973
+ "list-maintenances": {
974
+ parameters: {
975
+ query?: {
976
+ /** @description Maximum number of items to return in this page */
977
+ limit?: number;
978
+ /** @description Number of items to skip */
979
+ offset?: number;
980
+ /** @description Return only maintenance in this state; omit for all states */
981
+ status?: components["schemas"]["MaintenanceStatus"];
982
+ /** @description Return only maintenance affecting this component; omit for all components */
983
+ component?: string;
984
+ };
985
+ header?: never;
986
+ path?: never;
987
+ cookie?: never;
988
+ };
989
+ requestBody?: never;
990
+ responses: {
991
+ /** @description OK */
992
+ 200: {
993
+ headers: {
994
+ [name: string]: unknown;
995
+ };
996
+ content: {
997
+ "application/json": components["schemas"]["LengthAwarePageMaintenanceResource"];
998
+ };
999
+ };
1000
+ /** @description Error */
1001
+ default: {
1002
+ headers: {
1003
+ [name: string]: unknown;
1004
+ };
1005
+ content: {
1006
+ "application/json": components["schemas"]["Error"];
1007
+ };
1008
+ };
1009
+ };
1010
+ };
1011
+ "get-maintenance": {
1012
+ parameters: {
1013
+ query?: never;
1014
+ header?: never;
1015
+ path: {
1016
+ maintenanceId: string;
1017
+ };
1018
+ cookie?: never;
1019
+ };
1020
+ requestBody?: never;
1021
+ responses: {
1022
+ /** @description OK */
1023
+ 200: {
1024
+ headers: {
1025
+ [name: string]: unknown;
1026
+ };
1027
+ content: {
1028
+ "application/json": components["schemas"]["MaintenanceResource"];
1029
+ };
1030
+ };
1031
+ /** @description Error */
1032
+ default: {
1033
+ headers: {
1034
+ [name: string]: unknown;
1035
+ };
1036
+ content: {
1037
+ "application/json": components["schemas"]["Error"];
1038
+ };
1039
+ };
1040
+ };
1041
+ };
1042
+ "list-maintenance-timeline": {
1043
+ parameters: {
1044
+ query?: {
1045
+ /** @description Maximum number of items to return in this page */
1046
+ limit?: number;
1047
+ /** @description Number of items to skip */
1048
+ offset?: number;
1049
+ };
1050
+ header?: never;
1051
+ path: {
1052
+ maintenanceId: string;
1053
+ };
1054
+ cookie?: never;
1055
+ };
1056
+ requestBody?: never;
1057
+ responses: {
1058
+ /** @description OK */
1059
+ 200: {
1060
+ headers: {
1061
+ [name: string]: unknown;
1062
+ };
1063
+ content: {
1064
+ "application/json": components["schemas"]["LengthAwarePageMaintenanceTimelineEntryResource"];
1065
+ };
1066
+ };
1067
+ /** @description Error */
1068
+ default: {
1069
+ headers: {
1070
+ [name: string]: unknown;
1071
+ };
1072
+ content: {
1073
+ "application/json": components["schemas"]["Error"];
1074
+ };
1075
+ };
1076
+ };
1077
+ };
1078
+ }