@leaflow/sdk 0.75.0 → 0.77.0

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.
@@ -1,751 +0,0 @@
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/disk-types": {
7
- parameters: {
8
- query?: never;
9
- header?: never;
10
- path?: never;
11
- cookie?: never;
12
- };
13
- /** List disk types on sale */
14
- get: operations["list-disk-types"];
15
- put?: never;
16
- post?: never;
17
- delete?: never;
18
- options?: never;
19
- head?: never;
20
- patch?: never;
21
- trace?: never;
22
- };
23
- "/api/v1/disk-types/{diskTypeId}": {
24
- parameters: {
25
- query?: never;
26
- header?: never;
27
- path?: never;
28
- cookie?: never;
29
- };
30
- /** Get a disk type */
31
- get: operations["get-disk-type"];
32
- put?: never;
33
- post?: never;
34
- delete?: never;
35
- options?: never;
36
- head?: never;
37
- patch?: never;
38
- trace?: never;
39
- };
40
- "/api/v1/disks": {
41
- parameters: {
42
- query?: never;
43
- header?: never;
44
- path?: never;
45
- cookie?: never;
46
- };
47
- /** List disks in the current project */
48
- get: operations["list-disks"];
49
- put?: never;
50
- /**
51
- * Create a disk purchase
52
- * @description Checks Fleet capacity, creates the local disk intent, and places a Billing order. Reuse the same idempotency key after an uncertain response. Billing resolves contract pricing, sellable quota, grants, payment challenges, and expiry.
53
- */
54
- post: operations["create-disk"];
55
- delete?: never;
56
- options?: never;
57
- head?: never;
58
- patch?: never;
59
- trace?: never;
60
- };
61
- "/api/v1/disks/{diskId}": {
62
- parameters: {
63
- query?: never;
64
- header?: never;
65
- path?: never;
66
- cookie?: never;
67
- };
68
- /** Get a disk */
69
- get: operations["get-disk"];
70
- put?: never;
71
- post?: never;
72
- /**
73
- * Delete a disk
74
- * @description Deletion is asynchronous and is rejected while the disk has a live attachment or another live resource claim. Billing ends resource-bound subscriptions only after Cinder confirms deletion.
75
- */
76
- delete: operations["delete-disk"];
77
- options?: never;
78
- head?: never;
79
- /** Rename a disk */
80
- patch: operations["rename-disk"];
81
- trace?: never;
82
- };
83
- "/api/v1/resource-usages": {
84
- parameters: {
85
- query?: never;
86
- header?: never;
87
- path?: never;
88
- cookie?: never;
89
- };
90
- /**
91
- * List resource usages
92
- * @description Lists direct consumers and pending reservations for a resource readable in the current project.
93
- */
94
- get: operations["list-resource-usages"];
95
- put?: never;
96
- post?: never;
97
- delete?: never;
98
- options?: never;
99
- head?: never;
100
- patch?: never;
101
- trace?: never;
102
- };
103
- "/api/v1/resource-usages/{usageId}": {
104
- parameters: {
105
- query?: never;
106
- header?: never;
107
- path?: never;
108
- cookie?: never;
109
- };
110
- /** Get a resource usage */
111
- get: operations["get-resource-usage"];
112
- put?: never;
113
- post?: never;
114
- delete?: never;
115
- options?: never;
116
- head?: never;
117
- patch?: never;
118
- trace?: never;
119
- };
120
- "/api/v1/resources/{resourceType}/{resourceId}/reclamation": {
121
- parameters: {
122
- query?: never;
123
- header?: never;
124
- path?: never;
125
- cookie?: never;
126
- };
127
- /** Get resource reclamation state */
128
- get: operations["get-resource-reclamation"];
129
- put?: never;
130
- post?: never;
131
- delete?: never;
132
- options?: never;
133
- head?: never;
134
- patch?: never;
135
- trace?: never;
136
- };
137
- "/api/v1/resources/{resourceType}/{resourceId}/idle-policy": {
138
- parameters: {
139
- query?: never;
140
- header?: never;
141
- path?: never;
142
- cookie?: never;
143
- };
144
- get?: never;
145
- /**
146
- * Set resource idle policy
147
- * @description Enabling automatic cleanup starts a fresh retention interval after the last live claim is released. Existing claims and pending operations always block reclamation.
148
- */
149
- put: operations["set-resource-idle-policy"];
150
- post?: never;
151
- delete?: never;
152
- options?: never;
153
- head?: never;
154
- patch?: never;
155
- trace?: never;
156
- };
157
- "/api/v1/disks/{diskId}/attachments": {
158
- parameters: {
159
- query?: never;
160
- header?: never;
161
- path?: never;
162
- cookie?: never;
163
- };
164
- /** List disk attachments */
165
- get: operations["list-disk-attachments"];
166
- put?: never;
167
- post?: never;
168
- delete?: never;
169
- options?: never;
170
- head?: never;
171
- patch?: never;
172
- trace?: never;
173
- };
174
- "/api/v1/attachments/{attachmentId}": {
175
- parameters: {
176
- query?: never;
177
- header?: never;
178
- path?: never;
179
- cookie?: never;
180
- };
181
- /** Get a disk attachment */
182
- get: operations["get-attachment"];
183
- put?: never;
184
- post?: never;
185
- delete?: never;
186
- options?: never;
187
- head?: never;
188
- patch?: never;
189
- trace?: never;
190
- };
191
- }
192
- export type webhooks = Record<string, never>;
193
- export interface components {
194
- schemas: {
195
- Disk: {
196
- /** Format: uuid */
197
- id: string;
198
- name: string;
199
- /** Format: uuid */
200
- region_id: string;
201
- /** Format: uuid */
202
- availability_zone_id: string;
203
- /** Format: uuid */
204
- disk_type_id: string;
205
- /** Format: int64 */
206
- size_gb: number;
207
- /** @enum {string} */
208
- status: "provisioning" | "available" | "attaching" | "in_use" | "detaching" | "resizing" | "reverting" | "restoring" | "releasing" | "deleting" | "error";
209
- /** Format: date-time */
210
- created_at: string;
211
- /** Format: date-time */
212
- updated_at: string;
213
- /** Format: date-time */
214
- deleted_at?: string | null;
215
- };
216
- DiskList: {
217
- items: components["schemas"]["Disk"][];
218
- pagination: components["schemas"]["OffsetPagination"];
219
- };
220
- DiskType: {
221
- /** Format: uuid */
222
- id: string;
223
- lookup_key: string;
224
- name: string;
225
- /** @enum {string} */
226
- media: "ssd" | "hdd" | "nvme";
227
- /** Format: uuid */
228
- region_id: string;
229
- /** Format: uuid */
230
- availability_zone_id: string;
231
- /** Format: int64 */
232
- min_size_gb: number;
233
- /** Format: int64 */
234
- max_size_gb: number;
235
- /** Format: int64 */
236
- step_gb: number;
237
- for_system: boolean;
238
- /** Format: uuid */
239
- product_id: string;
240
- /** Format: uuid */
241
- plan_id: string;
242
- };
243
- DiskTypeList: {
244
- items: components["schemas"]["DiskType"][];
245
- pagination: components["schemas"]["OffsetPagination"];
246
- };
247
- /** @description Specify exactly one of id or lookup_key. A lookup key is scoped to the product of the resource service. */
248
- CatalogReference: {
249
- /** Format: uuid */
250
- id?: string;
251
- lookup_key?: string;
252
- };
253
- CreateDiskRequest: {
254
- /** Format: uuid */
255
- disk_type_id: string;
256
- name: string;
257
- /** Format: int64 */
258
- size_gb: number;
259
- price: components["schemas"]["CatalogReference"];
260
- order: components["schemas"]["OrderOptions"];
261
- };
262
- RenameRequest: {
263
- name: string;
264
- };
265
- Error: {
266
- code?: string;
267
- message: string;
268
- /**
269
- * @description What a given `code` carries alongside the message. The keys depend on the code,
270
- * and a client that does not recognise one ignores it.
271
- */
272
- meta?: {
273
- [key: string]: unknown;
274
- };
275
- /** Format: int64 */
276
- status: number;
277
- };
278
- /** @description Pagination metadata for stable numbered pages. total_count is returned only when the operation can determine it without an unbounded scan. */
279
- OffsetPagination: {
280
- /** Format: int64 */
281
- page: number;
282
- /** Format: int64 */
283
- page_size: number;
284
- /** Format: int64 */
285
- total_count?: number;
286
- };
287
- /** @description Requested funding split. This does not select a card or payment provider; complete payment through Billing. */
288
- PaymentPlan: {
289
- balance_amount: string;
290
- provider_amount: string;
291
- };
292
- /** @description Reuse the same key for retries of the same purchase. Reusing it with a different request fails. Billing selects contract pricing, applies eligible grants and promotions, and owns payment challenges and expiry. */
293
- OrderOptions: {
294
- idempotency_key: string;
295
- payment_plan?: components["schemas"]["PaymentPlan"];
296
- expected_amount?: string;
297
- redemption_code?: string;
298
- };
299
- /**
300
- * @description A billable order has been created. Read it from the billing API to find out what is
301
- * owed and whether payment is still required.
302
- *
303
- * Only the identifier is returned. Amounts and state are not repeated here; the order
304
- * itself is the single source for them.
305
- */
306
- PlacedOrder: {
307
- /**
308
- * Format: uuid
309
- * @description Identifies the order. Use it to read the order and, where payment is required,
310
- * to pay it.
311
- *
312
- * An order is created even when nothing is owed, such as a plan with no charge or one
313
- * covered entirely by granted credit. Such an order is already settled, and no
314
- * payment step applies.
315
- */
316
- order_id: string;
317
- };
318
- /** @description A resource identified within its owning service. The project is taken from the containing usage or request. */
319
- ResourceReference: {
320
- service: string;
321
- type: string;
322
- /** Format: uuid */
323
- id: string;
324
- };
325
- /** @description An authoritative claim held by the resource owner. Reserved, active and releasing claims all prevent idle reclamation. Stopped consumers retain their claims. Released claims remain readable. */
326
- ResourceUsage: {
327
- /** Format: uuid */
328
- id: string;
329
- /** Format: uuid */
330
- project_id: string;
331
- resource: components["schemas"]["ResourceReference"];
332
- consumer: components["schemas"]["ResourceReference"];
333
- purpose: string;
334
- /** @enum {string} */
335
- state: "reserved" | "active" | "releasing" | "released";
336
- /** Format: int64 */
337
- generation: number;
338
- operation_id: string;
339
- /** Format: date-time */
340
- created_at: string;
341
- /** Format: date-time */
342
- updated_at: string;
343
- /** Format: date-time */
344
- released_at?: string;
345
- };
346
- ResourceUsageList: {
347
- items: components["schemas"]["ResourceUsage"][];
348
- pagination: components["schemas"]["OffsetPagination"];
349
- };
350
- /** @description Automatic reclamation is disabled by default. When enabled, retention starts after the last live claim is confirmed released. Traffic, IO and consumer heartbeats do not affect eligibility. */
351
- IdlePolicy: {
352
- /** @default false */
353
- enabled: boolean;
354
- /** Format: int64 */
355
- retention_seconds: number;
356
- };
357
- ReclamationState: {
358
- resource: components["schemas"]["ResourceReference"];
359
- policy: components["schemas"]["IdlePolicy"];
360
- /** Format: int64 */
361
- active_usage_count: number;
362
- /** Format: date-time */
363
- unreferenced_at?: string;
364
- /** Format: date-time */
365
- eligible_at?: string;
366
- /** @enum {string} */
367
- status: "retained" | "in_use" | "idle" | "reclaiming" | "deleted";
368
- blocked_reasons: string[];
369
- };
370
- Attachment: {
371
- /** Format: uuid */
372
- id: string;
373
- /** Format: uuid */
374
- usage_id: string;
375
- resource: components["schemas"]["ResourceReference"];
376
- consumer: components["schemas"]["ResourceReference"];
377
- /** @enum {string} */
378
- state: "reserved" | "attaching" | "attached" | "detaching" | "detached" | "unknown";
379
- /** Format: int64 */
380
- generation: number;
381
- device?: string;
382
- read_only: boolean;
383
- /** Format: date-time */
384
- created_at: string;
385
- /** Format: date-time */
386
- updated_at: string;
387
- };
388
- AttachmentList: {
389
- items: components["schemas"]["Attachment"][];
390
- pagination: components["schemas"]["OffsetPagination"];
391
- };
392
- };
393
- responses: {
394
- /** @description Error */
395
- Error: {
396
- headers: {
397
- [name: string]: unknown;
398
- };
399
- content: {
400
- "application/json": components["schemas"]["Error"];
401
- };
402
- };
403
- };
404
- parameters: {
405
- DiskTypeID: string;
406
- DiskID: string;
407
- UsageID: string;
408
- AttachmentID: string;
409
- RegionID: string;
410
- RegionIDOptional: string;
411
- AvailabilityZoneIDOptional: string;
412
- ResourceType: "disk";
413
- ResourceID: string;
414
- ResourceTypePath: "disk";
415
- ResourceIDPath: string;
416
- IncludeReleased: boolean;
417
- IncludeDetached: boolean;
418
- Page: number;
419
- PageSize: number;
420
- };
421
- requestBodies: never;
422
- headers: never;
423
- pathItems: never;
424
- }
425
- export type $defs = Record<string, never>;
426
- export interface operations {
427
- "list-disk-types": {
428
- parameters: {
429
- query: {
430
- region_id: components["parameters"]["RegionID"];
431
- page?: components["parameters"]["Page"];
432
- page_size?: components["parameters"]["PageSize"];
433
- };
434
- header?: never;
435
- path?: never;
436
- cookie?: never;
437
- };
438
- requestBody?: never;
439
- responses: {
440
- /** @description OK */
441
- 200: {
442
- headers: {
443
- [name: string]: unknown;
444
- };
445
- content: {
446
- "application/json": components["schemas"]["DiskTypeList"];
447
- };
448
- };
449
- default: components["responses"]["Error"];
450
- };
451
- };
452
- "get-disk-type": {
453
- parameters: {
454
- query?: never;
455
- header?: never;
456
- path: {
457
- diskTypeId: components["parameters"]["DiskTypeID"];
458
- };
459
- cookie?: never;
460
- };
461
- requestBody?: never;
462
- responses: {
463
- /** @description OK */
464
- 200: {
465
- headers: {
466
- [name: string]: unknown;
467
- };
468
- content: {
469
- "application/json": components["schemas"]["DiskType"];
470
- };
471
- };
472
- default: components["responses"]["Error"];
473
- };
474
- };
475
- "list-disks": {
476
- parameters: {
477
- query?: {
478
- region_id?: components["parameters"]["RegionIDOptional"];
479
- availability_zone_id?: components["parameters"]["AvailabilityZoneIDOptional"];
480
- page?: components["parameters"]["Page"];
481
- page_size?: components["parameters"]["PageSize"];
482
- };
483
- header?: never;
484
- path?: never;
485
- cookie?: never;
486
- };
487
- requestBody?: never;
488
- responses: {
489
- /** @description OK */
490
- 200: {
491
- headers: {
492
- [name: string]: unknown;
493
- };
494
- content: {
495
- "application/json": components["schemas"]["DiskList"];
496
- };
497
- };
498
- default: components["responses"]["Error"];
499
- };
500
- };
501
- "create-disk": {
502
- parameters: {
503
- query?: never;
504
- header?: never;
505
- path?: never;
506
- cookie?: never;
507
- };
508
- requestBody: {
509
- content: {
510
- "application/json": components["schemas"]["CreateDiskRequest"];
511
- };
512
- };
513
- responses: {
514
- /** @description Order placed */
515
- 202: {
516
- headers: {
517
- [name: string]: unknown;
518
- };
519
- content: {
520
- "application/json": components["schemas"]["PlacedOrder"];
521
- };
522
- };
523
- default: components["responses"]["Error"];
524
- };
525
- };
526
- "get-disk": {
527
- parameters: {
528
- query?: never;
529
- header?: never;
530
- path: {
531
- diskId: components["parameters"]["DiskID"];
532
- };
533
- cookie?: never;
534
- };
535
- requestBody?: never;
536
- responses: {
537
- /** @description OK */
538
- 200: {
539
- headers: {
540
- [name: string]: unknown;
541
- };
542
- content: {
543
- "application/json": components["schemas"]["Disk"];
544
- };
545
- };
546
- default: components["responses"]["Error"];
547
- };
548
- };
549
- "delete-disk": {
550
- parameters: {
551
- query: {
552
- idempotency_key: string;
553
- };
554
- header?: never;
555
- path: {
556
- diskId: components["parameters"]["DiskID"];
557
- };
558
- cookie?: never;
559
- };
560
- requestBody?: never;
561
- responses: {
562
- /** @description Accepted */
563
- 204: {
564
- headers: {
565
- [name: string]: unknown;
566
- };
567
- content?: never;
568
- };
569
- default: components["responses"]["Error"];
570
- };
571
- };
572
- "rename-disk": {
573
- parameters: {
574
- query?: never;
575
- header?: never;
576
- path: {
577
- diskId: components["parameters"]["DiskID"];
578
- };
579
- cookie?: never;
580
- };
581
- requestBody: {
582
- content: {
583
- "application/json": components["schemas"]["RenameRequest"];
584
- };
585
- };
586
- responses: {
587
- /** @description OK */
588
- 200: {
589
- headers: {
590
- [name: string]: unknown;
591
- };
592
- content: {
593
- "application/json": components["schemas"]["Disk"];
594
- };
595
- };
596
- default: components["responses"]["Error"];
597
- };
598
- };
599
- "list-resource-usages": {
600
- parameters: {
601
- query: {
602
- resource_type: components["parameters"]["ResourceType"];
603
- resource_id: components["parameters"]["ResourceID"];
604
- include_released?: components["parameters"]["IncludeReleased"];
605
- page?: components["parameters"]["Page"];
606
- page_size?: components["parameters"]["PageSize"];
607
- };
608
- header?: never;
609
- path?: never;
610
- cookie?: never;
611
- };
612
- requestBody?: never;
613
- responses: {
614
- /** @description OK */
615
- 200: {
616
- headers: {
617
- [name: string]: unknown;
618
- };
619
- content: {
620
- "application/json": components["schemas"]["ResourceUsageList"];
621
- };
622
- };
623
- default: components["responses"]["Error"];
624
- };
625
- };
626
- "get-resource-usage": {
627
- parameters: {
628
- query?: never;
629
- header?: never;
630
- path: {
631
- usageId: components["parameters"]["UsageID"];
632
- };
633
- cookie?: never;
634
- };
635
- requestBody?: never;
636
- responses: {
637
- /** @description OK */
638
- 200: {
639
- headers: {
640
- [name: string]: unknown;
641
- };
642
- content: {
643
- "application/json": components["schemas"]["ResourceUsage"];
644
- };
645
- };
646
- default: components["responses"]["Error"];
647
- };
648
- };
649
- "get-resource-reclamation": {
650
- parameters: {
651
- query?: never;
652
- header?: never;
653
- path: {
654
- resourceType: components["parameters"]["ResourceTypePath"];
655
- resourceId: components["parameters"]["ResourceIDPath"];
656
- };
657
- cookie?: never;
658
- };
659
- requestBody?: never;
660
- responses: {
661
- /** @description OK */
662
- 200: {
663
- headers: {
664
- [name: string]: unknown;
665
- };
666
- content: {
667
- "application/json": components["schemas"]["ReclamationState"];
668
- };
669
- };
670
- default: components["responses"]["Error"];
671
- };
672
- };
673
- "set-resource-idle-policy": {
674
- parameters: {
675
- query?: never;
676
- header?: never;
677
- path: {
678
- resourceType: components["parameters"]["ResourceTypePath"];
679
- resourceId: components["parameters"]["ResourceIDPath"];
680
- };
681
- cookie?: never;
682
- };
683
- requestBody: {
684
- content: {
685
- "application/json": components["schemas"]["IdlePolicy"];
686
- };
687
- };
688
- responses: {
689
- /** @description OK */
690
- 200: {
691
- headers: {
692
- [name: string]: unknown;
693
- };
694
- content: {
695
- "application/json": components["schemas"]["ReclamationState"];
696
- };
697
- };
698
- default: components["responses"]["Error"];
699
- };
700
- };
701
- "list-disk-attachments": {
702
- parameters: {
703
- query?: {
704
- include_detached?: components["parameters"]["IncludeDetached"];
705
- page?: components["parameters"]["Page"];
706
- page_size?: components["parameters"]["PageSize"];
707
- };
708
- header?: never;
709
- path: {
710
- diskId: components["parameters"]["DiskID"];
711
- };
712
- cookie?: never;
713
- };
714
- requestBody?: never;
715
- responses: {
716
- /** @description OK */
717
- 200: {
718
- headers: {
719
- [name: string]: unknown;
720
- };
721
- content: {
722
- "application/json": components["schemas"]["AttachmentList"];
723
- };
724
- };
725
- default: components["responses"]["Error"];
726
- };
727
- };
728
- "get-attachment": {
729
- parameters: {
730
- query?: never;
731
- header?: never;
732
- path: {
733
- attachmentId: components["parameters"]["AttachmentID"];
734
- };
735
- cookie?: never;
736
- };
737
- requestBody?: never;
738
- responses: {
739
- /** @description OK */
740
- 200: {
741
- headers: {
742
- [name: string]: unknown;
743
- };
744
- content: {
745
- "application/json": components["schemas"]["Attachment"];
746
- };
747
- };
748
- default: components["responses"]["Error"];
749
- };
750
- };
751
- }