@cloudfleet/sdk 0.0.1-0f4a5ef

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.
@@ -0,0 +1,2144 @@
1
+ export type ClusterCreateInput = {
2
+ /**
3
+ * Name of the cluster.
4
+ */
5
+ name: string;
6
+ /**
7
+ * Cloudfleet control plane region. One of "staging", "northamerica-central-1". This field can not be updated after creation.
8
+ */
9
+ region?: 'staging' | 'northamerica-central-1';
10
+ /**
11
+ * Tier of the cluster.
12
+ */
13
+ tier: 'basic' | 'pro';
14
+ /**
15
+ * Version of the kubernetes cluster.
16
+ */
17
+ version_channel?: string;
18
+ };
19
+ export type ClusterJoinInformation = {
20
+ /**
21
+ * Certificate authority data for the kubernetes cluster. This is the root certificate authority for the cluster.
22
+ */
23
+ certificate_authority: string;
24
+ /**
25
+ * Internal URL of the Kubernetes cluster control plane. This is the endpoint that kubelet uses to connect to the cluster.
26
+ */
27
+ endpoint: string;
28
+ /**
29
+ * Authentication key for the cluster.
30
+ */
31
+ auth_key: string;
32
+ /**
33
+ * Bootstrap token for the cluster.
34
+ */
35
+ bootstrap_token: string;
36
+ /**
37
+ * Versions of the different components of the cluster.
38
+ */
39
+ versions: {
40
+ /**
41
+ * Kubernetes version of the cluster.
42
+ */
43
+ kubernetes: string;
44
+ /**
45
+ * Tailscale version of the cluster.
46
+ */
47
+ tailscale: string;
48
+ /**
49
+ * Containerd version of the cluster.
50
+ */
51
+ containerd: string;
52
+ };
53
+ };
54
+ export type Cluster = {
55
+ /**
56
+ * Name of the cluster.
57
+ */
58
+ name: string;
59
+ /**
60
+ * Cloudfleet control plane region. One of "staging", "northamerica-central-1". This field can not be updated after creation.
61
+ */
62
+ region?: 'staging' | 'northamerica-central-1';
63
+ /**
64
+ * Tier of the cluster.
65
+ */
66
+ tier: 'basic' | 'pro';
67
+ /**
68
+ * Version of the kubernetes cluster.
69
+ */
70
+ version_channel?: string;
71
+ /**
72
+ * Unique identifier of the kubernetes cluster. UUID v4 string in canonical form
73
+ */
74
+ id: string;
75
+ /**
76
+ * Status of the cluster. When creating a new cluster, set to `active`. When deleting a clusters, set to `deleted`.
77
+ */
78
+ status: 'active' | 'deleted' | 'creating' | 'deployed' | 'failed' | 'updating';
79
+ endpoint?: string | '';
80
+ /**
81
+ * Certificate authority data for the kubernetes cluster. This is the root certificate authority for the cluster.
82
+ */
83
+ certificate_ca?: string;
84
+ /**
85
+ * Current version of the cluster.
86
+ */
87
+ version_current?: string;
88
+ /**
89
+ * Creation date and time of the cluster.
90
+ */
91
+ created_at?: string;
92
+ /**
93
+ * Last update date and time of the cluster.
94
+ */
95
+ updated_at?: string;
96
+ /**
97
+ * Indicates if the cluster is ready to be used.
98
+ */
99
+ ready?: boolean;
100
+ };
101
+ export type ClusterUpdateInput = {
102
+ /**
103
+ * Name of the cluster.
104
+ */
105
+ name?: string;
106
+ /**
107
+ * Version of the kubernetes cluster.
108
+ */
109
+ version_channel?: string;
110
+ };
111
+ export type FleetCreateInput = {
112
+ /**
113
+ * Limits define a set of bounds for provisioning capacity.
114
+ */
115
+ limits?: {
116
+ /**
117
+ * CPU limit in cores.
118
+ */
119
+ cpu: number;
120
+ };
121
+ gcp?: {
122
+ enabled?: boolean;
123
+ /**
124
+ * Project GCP Project id to deploy instances into
125
+ */
126
+ project: string;
127
+ };
128
+ hetzner?: {
129
+ enabled?: boolean;
130
+ apiKey?: string;
131
+ } | {
132
+ apiKey?: string;
133
+ enabled?: boolean;
134
+ };
135
+ aws?: {
136
+ enabled?: boolean;
137
+ /**
138
+ * ControllerRoleArn is the AWS IAM role that Karpenter uses to manage resources.
139
+ */
140
+ controllerRoleArn: string;
141
+ };
142
+ /**
143
+ * Unique identifier of the kubernetes fleet.
144
+ */
145
+ id: string;
146
+ /**
147
+ * Specifies the fleet type: infrastructure managed by Cloudfleet or Connected Fleets.
148
+ */
149
+ type: 'managed' | 'connected';
150
+ };
151
+ export type Fleet = {
152
+ /**
153
+ * Limits define a set of bounds for provisioning capacity.
154
+ */
155
+ limits?: {
156
+ /**
157
+ * CPU limit in cores.
158
+ */
159
+ cpu: number;
160
+ };
161
+ gcp?: {
162
+ enabled?: boolean;
163
+ /**
164
+ * Project GCP Project id to deploy instances into
165
+ */
166
+ project: string;
167
+ };
168
+ hetzner?: {
169
+ enabled?: boolean;
170
+ apiKey?: string;
171
+ } | {
172
+ apiKey?: string;
173
+ enabled?: boolean;
174
+ };
175
+ aws?: {
176
+ enabled?: boolean;
177
+ /**
178
+ * ControllerRoleArn is the AWS IAM role that Karpenter uses to manage resources.
179
+ */
180
+ controllerRoleArn: string;
181
+ };
182
+ /**
183
+ * Unique identifier of the kubernetes fleet.
184
+ */
185
+ id: string;
186
+ /**
187
+ * Specifies the fleet type: infrastructure managed by Cloudfleet or Connected Fleets.
188
+ */
189
+ type: 'managed' | 'connected';
190
+ };
191
+ export type FleetUpdateInput = {
192
+ /**
193
+ * Limits define a set of bounds for provisioning capacity.
194
+ */
195
+ limits?: {
196
+ /**
197
+ * CPU limit in cores.
198
+ */
199
+ cpu: number;
200
+ };
201
+ gcp?: {
202
+ enabled?: boolean;
203
+ /**
204
+ * Project GCP Project id to deploy instances into
205
+ */
206
+ project: string;
207
+ };
208
+ hetzner?: {
209
+ enabled?: boolean;
210
+ apiKey?: string;
211
+ } | {
212
+ apiKey?: string;
213
+ enabled?: boolean;
214
+ };
215
+ aws?: {
216
+ enabled?: boolean;
217
+ /**
218
+ * ControllerRoleArn is the AWS IAM role that Karpenter uses to manage resources.
219
+ */
220
+ controllerRoleArn: string;
221
+ };
222
+ };
223
+ export type InfrastructureFilter = {
224
+ /**
225
+ * Version of the infrastructure filter definition. Currently only version 1 is supported.
226
+ */
227
+ version?: 1;
228
+ /**
229
+ * Limit selection of cloud providers to this list. For the full list of supported providers, see [Providers](https://cloudfleet.ai/docs/cloud-infrastructure/providers/)
230
+ */
231
+ provider?: Array<string>;
232
+ /**
233
+ * Limits selection of cloud regions to this list of Cloudfleet regions. For the full list of normalized regions and their mapping to CSP regions, see [Regions](https://cloudfleet.ai/docs/cloud-infrastructure/node-regions/)
234
+ */
235
+ region?: Array<string>;
236
+ /**
237
+ * Limits selection of cloud regions to this list of Cloudfleet regions. For the full list of normalized regions and their mapping to CSP regions, see [Regions](https://cloudfleet.ai/docs/cloud-infrastructure/node-regions/)
238
+ */
239
+ sub_region?: Array<string>;
240
+ /**
241
+ * Limits selection of cloud regions to this list of canonical provider regions
242
+ */
243
+ csp_region?: Array<string>;
244
+ /**
245
+ * Limits selection of instance types to this list. Instance / VM type as defined by the cloud service provider
246
+ */
247
+ instance_type?: Array<string>;
248
+ /**
249
+ * List of Normalized accelerator model names. For example, all variations of Nvidia A100 GPUs will have 'A100' as accelerator name with various memory configurations set in accelerator_memory field
250
+ */
251
+ accelerator_name?: Array<string>;
252
+ /**
253
+ * List of normalized accelerator manufacturer names. For example, all Nvidia GPUs will have 'NVIDIA' as accelerator manufacturer
254
+ */
255
+ accelerator_manufacturer?: Array<string>;
256
+ /**
257
+ * Minimum number of accelerators available on the instance. Some cloud providers support shared accelerators, so the number of accelerators may be a fraction of the number of physical accelerators.
258
+ */
259
+ accelerator_count_min?: number;
260
+ /**
261
+ * Maximum number of accelerators available on the instance. Some cloud providers support shared accelerators, so the number of accelerators may be a fraction of the number of physical accelerators.
262
+ */
263
+ accelerator_count_max?: number;
264
+ /**
265
+ * Minimum amount of accelerator memory available to each accelerator. For example, Nvidia A100 GPUs will typically have '40.0' gibibytes (GiB) of memory, while A100 GPUs with HBM2E memory will have '80.0' gibibytes (GiB) of memory
266
+ */
267
+ accelerator_memory_min?: number;
268
+ /**
269
+ * Maximum amount of accelerator memory available to each accelerator. For example, Nvidia A100 GPUs will typically have '40.0' gibibytes (GiB) of memory, while A100 GPUs with HBM2E memory will have '80.0' gibibytes (GiB) of memory
270
+ */
271
+ accelerator_memory_max?: number;
272
+ /**
273
+ * Minimum amount of RAM in gibibytes (GiB)
274
+ */
275
+ memory_min?: number;
276
+ /**
277
+ * Maximum amount of RAM in gibibytes (GiB)
278
+ */
279
+ memory_max?: number;
280
+ /**
281
+ * Minimum number of vCPUs as defined by the cloud service provider. Some cloud providers use hyperthreading, so the number of vCPUs may be twice as high as the number of physical cores.
282
+ */
283
+ vcpu_min?: number;
284
+ /**
285
+ * Maximum number of vCPUs as defined by the cloud service provider. Some cloud providers use hyperthreading, so the number of vCPUs may be twice as high as the number of physical cores.
286
+ */
287
+ vcpu_max?: number;
288
+ /**
289
+ * Minimum total storage in GiB (attached and local)
290
+ */
291
+ storage_total_min?: number;
292
+ /**
293
+ * Maximum total storage in GiB (attached and local)
294
+ */
295
+ storage_total_max?: number;
296
+ /**
297
+ * Minimum volume of directly attached, block-device local storage in gibibytes (GiB)
298
+ */
299
+ storage_local_min?: number;
300
+ /**
301
+ * Maximum volume of directly attached, block-device local storage in gibibytes (GiB)
302
+ */
303
+ storage_local_max?: number;
304
+ /**
305
+ * Minimum price of running the inctance per hour in USD as defined by the cloud service provider. The cheapest instance will be selected.
306
+ */
307
+ price_min?: number;
308
+ /**
309
+ * Maximum price of running the inctance per hour in USD as defined by the cloud service provider. The cheapest instance will be selected.
310
+ */
311
+ price_max?: number;
312
+ };
313
+ export type InfrastructureInstance = {
314
+ /**
315
+ * Cloudfleet instance SKU. Has a format of <provider>-<csp_region>-<instance_type>.
316
+ */
317
+ sku: string;
318
+ /**
319
+ * Normalized cloud service provider name. For the full list of supported providers, see [Providers](https://cloudfleet.ai/docs/cloud-infrastructure/providers/)
320
+ */
321
+ provider: string;
322
+ /**
323
+ * Normalized region. For the full list of normalized regions and their mapping to CSP regions, see [Regions](https://cloudfleet.ai/docs/cloud-infrastructure/node-regions/)
324
+ */
325
+ region: string;
326
+ /**
327
+ * Normalized sub-region. For the full list of normalized regions and their mapping to CSP regions, see [Regions](https://cloudfleet.ai/docs/cloud-infrastructure/node-regions/)
328
+ */
329
+ sub_region: string;
330
+ /**
331
+ * Region as defined by the cloud service provider
332
+ */
333
+ csp_region: string;
334
+ /**
335
+ * Availability zone as defined by the cloud service provider
336
+ */
337
+ csp_zone: string;
338
+ /**
339
+ * Instance / VM type as defined by the cloud service provider
340
+ */
341
+ instance_type: string;
342
+ /**
343
+ * Instance CPU architecture
344
+ */
345
+ architecture: string;
346
+ /**
347
+ * Instance operating system
348
+ */
349
+ os: string;
350
+ /**
351
+ * CPU count as defined by the cloud service provider. Some cloud providers use hyperthreading, so the number of vCPUs may be twice as high as the number of physical cores.
352
+ */
353
+ vcpu: number;
354
+ /**
355
+ * Total amount of RAM in gibibytes (GiB)
356
+ */
357
+ memory: number;
358
+ /**
359
+ * Volume of directly attached, block-device local storage in gibibytes (GiB)
360
+ */
361
+ local_storage: number;
362
+ /**
363
+ * Normalized model name of accelerator. For example, all variations of Nvidia A100 GPUs will have 'A100' as accelerator name with various memory configurations set in accelerator_memory field
364
+ */
365
+ accelerator_name?: string;
366
+ /**
367
+ * Normalized manufacturer name of accelerator. For example, all Nvidia GPUs will have 'NVIDIA' as accelerator manufacturer
368
+ */
369
+ accelerator_manufacturer?: string;
370
+ /**
371
+ * Number of accelerators available on the instance. Some cloud providers support shared accelerators, so the number of accelerators may be a fraction of the number of physical accelerators.
372
+ */
373
+ accelerator_count?: number;
374
+ /**
375
+ * Ammount of accelerator memory available to each accelerator. For example, Nvidia A100 GPUs will typically have '40.0' gibibytes (GiB) of memory, while A100 GPUs with HBM2E memory will have '80.0' gibibytes (GiB) of memory
376
+ */
377
+ accelerator_memory?: number;
378
+ /**
379
+ * Maximum number of pods that can be run on this instance type.
380
+ */
381
+ pods_capacity?: number;
382
+ /**
383
+ * Capacity type of the instance. E.g. `on-demand`, `spot`.
384
+ */
385
+ capacity_type?: string;
386
+ /**
387
+ * Price of running the inctance per hour in USD as defined by the cloud service provider
388
+ */
389
+ price: number;
390
+ /**
391
+ * Whether this instance type is available.
392
+ */
393
+ available?: boolean;
394
+ };
395
+ export type Invite = {
396
+ /**
397
+ * Unique identifier of the invitation.
398
+ */
399
+ id?: string;
400
+ /**
401
+ * Unique identifier of the organization the project belongs to. UUID v4 string in canonical form
402
+ */
403
+ organization_id?: string;
404
+ /**
405
+ * Creation date of the project. ISO 8601 date string in UTC timezone
406
+ */
407
+ date_created: string;
408
+ /**
409
+ * User email address.
410
+ */
411
+ email?: string;
412
+ /**
413
+ * Generated unique invite code.
414
+ */
415
+ code?: string;
416
+ };
417
+ export type Invoice = {
418
+ /**
419
+ * Unique identifier of the invoice. UUID v4 string in canonical form
420
+ */
421
+ id?: string;
422
+ /**
423
+ * Unique identifier of the organization. UUID v4 string in canonical form
424
+ */
425
+ organizationId?: string;
426
+ /**
427
+ * Status of the invoice
428
+ */
429
+ status?: 'DRAFT' | 'COMMITTED' | 'VOID';
430
+ /**
431
+ * Total amount of the invoice
432
+ */
433
+ amount?: number;
434
+ /**
435
+ * Currency of the invoice
436
+ */
437
+ currency?: 'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYR' | 'BZD' | 'CAD' | 'CDF' | 'CHF' | 'CLP' | 'CNY' | 'COP' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GGP' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'IMP' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JEP' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LTL' | 'LVL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRO' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SPL' | 'SRD' | 'STD' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TVD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'UYU' | 'UZS' | 'VEF' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XCD' | 'XDR' | 'XOF' | 'XPF' | 'YER' | 'ZAR' | 'ZMW' | 'ZWD' | 'BTC';
438
+ /**
439
+ * Total amount of credit adjustments
440
+ */
441
+ creditAdj?: number;
442
+ /**
443
+ * Total amount of refund adjustments
444
+ */
445
+ refundAdj?: number;
446
+ /**
447
+ * Date of the invoice
448
+ */
449
+ invoiceDate?: string;
450
+ /**
451
+ * Target date of the invoice
452
+ */
453
+ targetDate?: string;
454
+ /**
455
+ * Number of the invoice
456
+ */
457
+ invoiceNumber?: string;
458
+ /**
459
+ * Balance of the invoice
460
+ */
461
+ balance?: number;
462
+ /**
463
+ * Bundle keys of the invoice
464
+ */
465
+ bundleKeys?: string;
466
+ /**
467
+ * Credits of the invoice
468
+ */
469
+ credits?: Array<{
470
+ /**
471
+ * Unique identifier of the invoice item. UUID v4 string in canonical form
472
+ */
473
+ id?: string;
474
+ /**
475
+ * Unique identifier of the linked invoice item. UUID v4 string in canonical form
476
+ */
477
+ linkedInvoiceItemId?: string;
478
+ /**
479
+ * Name of the product
480
+ */
481
+ productName?: string;
482
+ /**
483
+ * Name of the plan
484
+ */
485
+ planName?: string;
486
+ /**
487
+ * Name of the phase
488
+ */
489
+ phaseName?: string;
490
+ /**
491
+ * Name of the usage
492
+ */
493
+ usageName?: string;
494
+ /**
495
+ * Pretty name of the product
496
+ */
497
+ prettyProductName?: string;
498
+ /**
499
+ * Pretty name of the plan
500
+ */
501
+ prettyPlanName?: string;
502
+ /**
503
+ * Pretty name of the phase
504
+ */
505
+ prettyPhaseName?: string;
506
+ /**
507
+ * Pretty name of the usage
508
+ */
509
+ prettyUsageName?: string;
510
+ /**
511
+ * Type of the invoice item
512
+ */
513
+ itemType?: 'EXTERNAL_CHARGE' | 'FIXED' | 'RECURRING' | 'REPAIR_ADJ' | 'CBA_ADJ' | 'CREDIT_ADJ' | 'ITEM_ADJ' | 'USAGE' | 'TAX' | 'PARENT_SUMMARY';
514
+ /**
515
+ * Description of the invoice item
516
+ */
517
+ description?: string;
518
+ /**
519
+ * Start date of the invoice item
520
+ */
521
+ startDate?: string;
522
+ /**
523
+ * End date of the invoice item
524
+ */
525
+ endDate?: string;
526
+ /**
527
+ * Amount of the invoice item
528
+ */
529
+ amount?: number;
530
+ /**
531
+ * Rate of the invoice item
532
+ */
533
+ rate?: number;
534
+ /**
535
+ * Currency of the invoice item
536
+ */
537
+ currency?: 'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYR' | 'BZD' | 'CAD' | 'CDF' | 'CHF' | 'CLP' | 'CNY' | 'COP' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GGP' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'IMP' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JEP' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LTL' | 'LVL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRO' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SPL' | 'SRD' | 'STD' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TVD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'UYU' | 'UZS' | 'VEF' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XCD' | 'XDR' | 'XOF' | 'XPF' | 'YER' | 'ZAR' | 'ZMW' | 'ZWD' | 'BTC';
538
+ /**
539
+ * Quantity of the invoice item
540
+ */
541
+ quantity?: number;
542
+ /**
543
+ * Details of the invoice item
544
+ */
545
+ itemDetails?: string;
546
+ /**
547
+ * Effective date of the catalog
548
+ */
549
+ catalogEffectiveDate?: string;
550
+ /**
551
+ * Child items of the invoice item
552
+ */
553
+ childItems?: Array<Array<unknown> | boolean | number | {
554
+ [key: string]: unknown;
555
+ } | string>;
556
+ }>;
557
+ /**
558
+ * Items of the invoice
559
+ */
560
+ items?: Array<{
561
+ /**
562
+ * Unique identifier of the invoice item. UUID v4 string in canonical form
563
+ */
564
+ id?: string;
565
+ /**
566
+ * Unique identifier of the linked invoice item. UUID v4 string in canonical form
567
+ */
568
+ linkedInvoiceItemId?: string;
569
+ /**
570
+ * Name of the product
571
+ */
572
+ productName?: string;
573
+ /**
574
+ * Name of the plan
575
+ */
576
+ planName?: string;
577
+ /**
578
+ * Name of the phase
579
+ */
580
+ phaseName?: string;
581
+ /**
582
+ * Name of the usage
583
+ */
584
+ usageName?: string;
585
+ /**
586
+ * Pretty name of the product
587
+ */
588
+ prettyProductName?: string;
589
+ /**
590
+ * Pretty name of the plan
591
+ */
592
+ prettyPlanName?: string;
593
+ /**
594
+ * Pretty name of the phase
595
+ */
596
+ prettyPhaseName?: string;
597
+ /**
598
+ * Pretty name of the usage
599
+ */
600
+ prettyUsageName?: string;
601
+ /**
602
+ * Type of the invoice item
603
+ */
604
+ itemType?: 'EXTERNAL_CHARGE' | 'FIXED' | 'RECURRING' | 'REPAIR_ADJ' | 'CBA_ADJ' | 'CREDIT_ADJ' | 'ITEM_ADJ' | 'USAGE' | 'TAX' | 'PARENT_SUMMARY';
605
+ /**
606
+ * Description of the invoice item
607
+ */
608
+ description?: string;
609
+ /**
610
+ * Start date of the invoice item
611
+ */
612
+ startDate?: string;
613
+ /**
614
+ * End date of the invoice item
615
+ */
616
+ endDate?: string;
617
+ /**
618
+ * Amount of the invoice item
619
+ */
620
+ amount?: number;
621
+ /**
622
+ * Rate of the invoice item
623
+ */
624
+ rate?: number;
625
+ /**
626
+ * Currency of the invoice item
627
+ */
628
+ currency?: 'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYR' | 'BZD' | 'CAD' | 'CDF' | 'CHF' | 'CLP' | 'CNY' | 'COP' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GGP' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'IMP' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JEP' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LTL' | 'LVL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRO' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SPL' | 'SRD' | 'STD' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TVD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'UYU' | 'UZS' | 'VEF' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XCD' | 'XDR' | 'XOF' | 'XPF' | 'YER' | 'ZAR' | 'ZMW' | 'ZWD' | 'BTC';
629
+ /**
630
+ * Quantity of the invoice item
631
+ */
632
+ quantity?: number;
633
+ /**
634
+ * Details of the invoice item
635
+ */
636
+ itemDetails?: string;
637
+ /**
638
+ * Effective date of the catalog
639
+ */
640
+ catalogEffectiveDate?: string;
641
+ /**
642
+ * Child items of the invoice item
643
+ */
644
+ childItems?: Array<Array<unknown> | boolean | number | {
645
+ [key: string]: unknown;
646
+ } | string>;
647
+ }>;
648
+ };
649
+ export type OrganizationContactInfo = {
650
+ /**
651
+ * Street address, P.O. box, c/o
652
+ */
653
+ address1?: string;
654
+ /**
655
+ * Apartment, suite, unit, building, floor, etc.
656
+ */
657
+ address2?: string;
658
+ /**
659
+ * Postal code as a string.
660
+ */
661
+ postalCode?: string;
662
+ /**
663
+ * City or town name.
664
+ */
665
+ city?: string;
666
+ /**
667
+ * State, province, or region name.
668
+ */
669
+ state?: string;
670
+ /**
671
+ * Country as a ISO 3166-1 alpha-2 country code.
672
+ */
673
+ country?: string;
674
+ /**
675
+ * Phone number as a string.
676
+ */
677
+ phone?: string;
678
+ /**
679
+ * Email address used for billing as a string.
680
+ */
681
+ email: string;
682
+ /**
683
+ * First name of the billing contact person.
684
+ */
685
+ first_name: string;
686
+ /**
687
+ * Last name of the billing contact person.
688
+ */
689
+ last_name: string;
690
+ };
691
+ export type OrganizationCreateInput = {
692
+ /**
693
+ * Name of the legal entity. This name will be used in invoices. Use your first and last name for individual accounts.
694
+ */
695
+ name: string;
696
+ /**
697
+ * Organization contact information and billing address.
698
+ */
699
+ contactInfo: {
700
+ /**
701
+ * Street address, P.O. box, c/o
702
+ */
703
+ address1?: string;
704
+ /**
705
+ * Apartment, suite, unit, building, floor, etc.
706
+ */
707
+ address2?: string;
708
+ /**
709
+ * Postal code as a string.
710
+ */
711
+ postalCode?: string;
712
+ /**
713
+ * City or town name.
714
+ */
715
+ city?: string;
716
+ /**
717
+ * State, province, or region name.
718
+ */
719
+ state?: string;
720
+ /**
721
+ * Country as a ISO 3166-1 alpha-2 country code.
722
+ */
723
+ country?: string;
724
+ /**
725
+ * Phone number as a string.
726
+ */
727
+ phone?: string;
728
+ /**
729
+ * Email address used for billing as a string.
730
+ */
731
+ email: string;
732
+ /**
733
+ * First name of the billing contact person.
734
+ */
735
+ first_name: string;
736
+ /**
737
+ * Last name of the billing contact person.
738
+ */
739
+ last_name: string;
740
+ };
741
+ /**
742
+ * Password for the root account. Must be at least 8 characters long and contain at least one uppercase letter, one lowercase letter, one number and one special character.
743
+ */
744
+ password: string;
745
+ };
746
+ export type Organization = {
747
+ /**
748
+ * Name of the legal entity. This name will be used in invoices. Use your first and last name for individual accounts.
749
+ */
750
+ name: string;
751
+ /**
752
+ * Organization contact information and billing address.
753
+ */
754
+ contactInfo: {
755
+ /**
756
+ * Street address, P.O. box, c/o
757
+ */
758
+ address1?: string;
759
+ /**
760
+ * Apartment, suite, unit, building, floor, etc.
761
+ */
762
+ address2?: string;
763
+ /**
764
+ * Postal code as a string.
765
+ */
766
+ postalCode?: string;
767
+ /**
768
+ * City or town name.
769
+ */
770
+ city?: string;
771
+ /**
772
+ * State, province, or region name.
773
+ */
774
+ state?: string;
775
+ /**
776
+ * Country as a ISO 3166-1 alpha-2 country code.
777
+ */
778
+ country?: string;
779
+ /**
780
+ * Phone number as a string.
781
+ */
782
+ phone?: string;
783
+ /**
784
+ * Email address used for billing as a string.
785
+ */
786
+ email: string;
787
+ /**
788
+ * First name of the billing contact person.
789
+ */
790
+ first_name: string;
791
+ /**
792
+ * Last name of the billing contact person.
793
+ */
794
+ last_name: string;
795
+ };
796
+ /**
797
+ * Unique identifier of the organization. UUID v4 string in canonical form
798
+ */
799
+ id: string;
800
+ /**
801
+ * Creation date of the organization. ISO 8601 date string in UTC timezone
802
+ */
803
+ date_created: string;
804
+ /**
805
+ * For security reasons, platform quota is controlled by Cloudfleet and can be updated only by Cloudfleet administrators. Please open a support ticket if you need to change the platform quota.
806
+ */
807
+ quota: {
808
+ /**
809
+ * Maximum number of Basic clusters that can be created.
810
+ */
811
+ basic_clusters_max: number;
812
+ /**
813
+ * Available number of Basic clusters that can be created.
814
+ */
815
+ basic_clusters_available: number;
816
+ /**
817
+ * Maximum number of Pro clusters that can be created.
818
+ */
819
+ pro_clusters_max: number;
820
+ /**
821
+ * Available number of Pro clusters that can be created.
822
+ */
823
+ pro_clusters_available: number;
824
+ /**
825
+ * Maximum number of fleets that can be created per cluster.
826
+ */
827
+ fleets_max: number;
828
+ /**
829
+ * Maximum number of CPU cores per managed fleet.
830
+ */
831
+ managed_fleets_cpu_max: number;
832
+ /**
833
+ * List of Cloudfleet cluster tiers available for the organization.
834
+ */
835
+ cluster_tiers: Array<string>;
836
+ /**
837
+ * List of Cloudfleet control plane regions available for the organization.
838
+ */
839
+ regions: Array<string>;
840
+ /**
841
+ * List of CFKE control plane versions available for the organization.
842
+ */
843
+ versions: Array<{
844
+ /**
845
+ * Id of the control plane version. Used in API calls.
846
+ */
847
+ id: string;
848
+ /**
849
+ * Label of the control plane version. Used in frontent UI.
850
+ */
851
+ label: string;
852
+ }>;
853
+ };
854
+ /**
855
+ * List of pending actions that the user needs to complete. Used in Cloudfleet console to guide the user through the onboarding process.
856
+ */
857
+ pending_actions: Array<'signup-billing-address' | 'signup-payment-method' | 'signup-invite-team' | 'signup-create-cluster'>;
858
+ /**
859
+ * Status of the organization. Can be `active` or `closed`, or `suspended`.
860
+ */
861
+ status: 'active' | 'closed' | 'suspended';
862
+ };
863
+ export type OrganizationUpdateInput = {
864
+ /**
865
+ * Name of the legal entity. This name will be used in invoices. Use your first and last name for individual accounts.
866
+ */
867
+ name?: string;
868
+ /**
869
+ * Organization contact information and billing address.
870
+ */
871
+ contactInfo: {
872
+ /**
873
+ * Street address, P.O. box, c/o
874
+ */
875
+ address1?: string;
876
+ /**
877
+ * Apartment, suite, unit, building, floor, etc.
878
+ */
879
+ address2?: string;
880
+ /**
881
+ * Postal code as a string.
882
+ */
883
+ postalCode?: string;
884
+ /**
885
+ * City or town name.
886
+ */
887
+ city?: string;
888
+ /**
889
+ * State, province, or region name.
890
+ */
891
+ state?: string;
892
+ /**
893
+ * Country as a ISO 3166-1 alpha-2 country code.
894
+ */
895
+ country?: string;
896
+ /**
897
+ * Phone number as a string.
898
+ */
899
+ phone?: string;
900
+ /**
901
+ * Email address used for billing as a string.
902
+ */
903
+ email: string;
904
+ /**
905
+ * First name of the billing contact person.
906
+ */
907
+ first_name: string;
908
+ /**
909
+ * Last name of the billing contact person.
910
+ */
911
+ last_name: string;
912
+ };
913
+ };
914
+ export type PaymentMethod = {
915
+ /**
916
+ * Unique identifier of the organization. UUID v4 string in canonical form.
917
+ */
918
+ id: string;
919
+ /**
920
+ * Whether organization payment method was set up and ready to use for payments.
921
+ */
922
+ setup: boolean;
923
+ /**
924
+ * Payment method type type. Only `card` payments supported at the moment.
925
+ */
926
+ type: 'card';
927
+ /**
928
+ * Last 4 digits of the payment card number.
929
+ */
930
+ last4: string;
931
+ /**
932
+ * Two-digit number representing the card's expiration month.
933
+ */
934
+ exp_month: number;
935
+ /**
936
+ * Four-digit number representing the card's expiration year.
937
+ */
938
+ exp_year: number;
939
+ /**
940
+ * Payment card brand. Can be `amex`, `diners`, `discover`, `eftpos_au`, `jcb`, `mastercard`, `unionpay`, `visa`, or `unknown`.
941
+ */
942
+ brand: 'amex' | 'diners' | 'discover' | 'eftpos_au' | 'jcb' | 'mastercard' | 'unionpay' | 'visa' | 'unknown';
943
+ };
944
+ export type TokenCreateInput = {
945
+ /**
946
+ * Human readable access token name.
947
+ */
948
+ name: string;
949
+ /**
950
+ * Role assumed by the token.
951
+ */
952
+ role: 'Administrator' | 'User';
953
+ };
954
+ export type Token = {
955
+ /**
956
+ * Human readable access token name.
957
+ */
958
+ name: string;
959
+ /**
960
+ * Role assumed by the token.
961
+ */
962
+ role: 'Administrator' | 'User';
963
+ /**
964
+ * Generated unique identifier of the access token.
965
+ */
966
+ id?: string;
967
+ /**
968
+ * Access token secret. Unmasked only during creation.
969
+ */
970
+ secret?: string;
971
+ /**
972
+ * Creation date of the access token. ISO 8601 date string in UTC timezone
973
+ */
974
+ date_created: string;
975
+ };
976
+ export type TokenUpdateInput = {
977
+ /**
978
+ * Human readable access token name.
979
+ */
980
+ name?: string;
981
+ /**
982
+ * Role assumed by the token.
983
+ */
984
+ role?: 'Administrator' | 'User';
985
+ };
986
+ export type Usage = {
987
+ /**
988
+ * Unique identifier of the Usage object, equal to subscription id of the task . UUID v4 string in canonical form
989
+ */
990
+ id: string;
991
+ /**
992
+ * Unique identifier of the project. UUID v4 string in canonical form
993
+ */
994
+ task_id: string;
995
+ /**
996
+ * Unit of measurement. E.g. GiB, seconds, etc
997
+ */
998
+ unit: string;
999
+ amount: number;
1000
+ };
1001
+ export type UserCreateInput = {
1002
+ /**
1003
+ * User email address.
1004
+ */
1005
+ email: string;
1006
+ /**
1007
+ * User first name.
1008
+ */
1009
+ first_name: string;
1010
+ /**
1011
+ * User last name.
1012
+ */
1013
+ last_name: string;
1014
+ /**
1015
+ * Generated unique invite code.
1016
+ */
1017
+ code: string;
1018
+ /**
1019
+ * User password. Must be at least 8 characters long and contain at least one uppercase letter, one lowercase letter, one number and one special character.
1020
+ */
1021
+ password: string;
1022
+ /**
1023
+ * Status of the user. Can be `active` or `inactive`. Inactive users cannot log in or manage organization resources.
1024
+ */
1025
+ status?: 'active' | 'inactive';
1026
+ /**
1027
+ * User role. Can be 'Administrator', 'User'.
1028
+ */
1029
+ role?: 'Administrator' | 'User';
1030
+ };
1031
+ export type User = {
1032
+ /**
1033
+ * User email address.
1034
+ */
1035
+ email: string;
1036
+ /**
1037
+ * User first name.
1038
+ */
1039
+ first_name: string;
1040
+ /**
1041
+ * User last name.
1042
+ */
1043
+ last_name: string;
1044
+ /**
1045
+ * User role. Can be 'Administrator', 'User'.
1046
+ */
1047
+ role: 'Administrator' | 'User';
1048
+ /**
1049
+ * Status of the user. Can be `active` or `inactive`. Inactive users cannot log in or manage organization resources.
1050
+ */
1051
+ status: 'active' | 'inactive';
1052
+ /**
1053
+ * Unique identifier of the user. UUID v4 string in canonical form
1054
+ */
1055
+ id: string;
1056
+ /**
1057
+ * Creation date of the user. ISO 8601 date string in UTC timezone
1058
+ */
1059
+ date_created: string;
1060
+ cluster_permissions?: Array<{
1061
+ /**
1062
+ * Unique identifier of the cluster. UUID v4 string in canonical form
1063
+ */
1064
+ cluster_id: string;
1065
+ /**
1066
+ * User permissions to access the cluster. Can be `readwrite` or `readonly`.
1067
+ */
1068
+ permissions: 'readwrite' | 'readonly';
1069
+ }>;
1070
+ };
1071
+ export type UserUpdateInput = {
1072
+ /**
1073
+ * User email address.
1074
+ */
1075
+ email?: string;
1076
+ /**
1077
+ * User first name.
1078
+ */
1079
+ first_name?: string;
1080
+ /**
1081
+ * User last name.
1082
+ */
1083
+ last_name?: string;
1084
+ /**
1085
+ * User role. Can be 'Administrator', 'User'.
1086
+ */
1087
+ role?: 'Administrator' | 'User';
1088
+ /**
1089
+ * Status of the user. Can be `active` or `inactive`. Inactive users cannot log in or manage organization resources.
1090
+ */
1091
+ status?: 'active' | 'inactive';
1092
+ };
1093
+ export type GetUsageData = {
1094
+ body?: never;
1095
+ path?: never;
1096
+ query: {
1097
+ /**
1098
+ * Start date for the usage. Date of oldest data point to retrieve.
1099
+ */
1100
+ start_date: string;
1101
+ /**
1102
+ * End date for the usage. Date of newest data point to retrieve.
1103
+ */
1104
+ end_date: string;
1105
+ };
1106
+ url: '/billing/usage';
1107
+ };
1108
+ export type GetUsageErrors = {
1109
+ /**
1110
+ * Not authenticated
1111
+ */
1112
+ 401: unknown;
1113
+ };
1114
+ export type GetUsageResponses = {
1115
+ /**
1116
+ * An array of usage records.
1117
+ */
1118
+ 200: Array<Usage>;
1119
+ };
1120
+ export type GetUsageResponse = GetUsageResponses[keyof GetUsageResponses];
1121
+ export type GetBalanceData = {
1122
+ body?: never;
1123
+ path?: never;
1124
+ query?: never;
1125
+ url: '/billing/balance';
1126
+ };
1127
+ export type GetBalanceResponses = {
1128
+ /**
1129
+ * Current balance of the organization in USD as a floating-point number.
1130
+ */
1131
+ 200: number;
1132
+ };
1133
+ export type GetBalanceResponse = GetBalanceResponses[keyof GetBalanceResponses];
1134
+ export type GetPaymentMethodData = {
1135
+ body?: never;
1136
+ path?: never;
1137
+ query?: never;
1138
+ url: '/billing/payment-method';
1139
+ };
1140
+ export type GetPaymentMethodErrors = {
1141
+ /**
1142
+ * Returns 404 Not Found if the organization does not have a payment method set up.
1143
+ */
1144
+ 404: unknown;
1145
+ };
1146
+ export type GetPaymentMethodResponses = {
1147
+ /**
1148
+ * Redacted payment card information.
1149
+ */
1150
+ 200: PaymentMethod;
1151
+ };
1152
+ export type GetPaymentMethodResponse = GetPaymentMethodResponses[keyof GetPaymentMethodResponses];
1153
+ export type GetPaymentMethodSecretData = {
1154
+ body?: never;
1155
+ path?: never;
1156
+ query?: never;
1157
+ url: '/billing/payment-method';
1158
+ };
1159
+ export type GetPaymentMethodSecretResponses = {
1160
+ /**
1161
+ * The client secret. Used for client-side retrieval using a publishable key. The client secret can be used to complete a payment from your frontend. It should not be stored, logged, or exposed to anyone other than the customer. Make sure that you have TLS enabled on any page that includes the client secret.
1162
+ *
1163
+ */
1164
+ 200: {
1165
+ /**
1166
+ * The client secret.
1167
+ */
1168
+ id?: string;
1169
+ };
1170
+ };
1171
+ export type GetPaymentMethodSecretResponse = GetPaymentMethodSecretResponses[keyof GetPaymentMethodSecretResponses];
1172
+ export type ListInvoicesData = {
1173
+ body?: never;
1174
+ path?: never;
1175
+ query: {
1176
+ /**
1177
+ * Start date for the usage. Date of oldest data point to retrieve.
1178
+ */
1179
+ start_date: string;
1180
+ /**
1181
+ * End date for the usage. Date of newest data point to retrieve.
1182
+ */
1183
+ end_date: string;
1184
+ };
1185
+ url: '/billing/invoices';
1186
+ };
1187
+ export type ListInvoicesErrors = {
1188
+ /**
1189
+ * Not authenticated
1190
+ */
1191
+ 401: unknown;
1192
+ };
1193
+ export type ListInvoicesResponses = {
1194
+ /**
1195
+ * An array of usage records.
1196
+ */
1197
+ 200: Array<Invoice>;
1198
+ };
1199
+ export type ListInvoicesResponse = ListInvoicesResponses[keyof ListInvoicesResponses];
1200
+ export type GetInvoiceData = {
1201
+ body?: never;
1202
+ path: {
1203
+ /**
1204
+ * Unique invoice identifier. UUID v4 string in canonical form
1205
+ */
1206
+ id: string;
1207
+ };
1208
+ query?: never;
1209
+ url: '/billing/invoices/{id}';
1210
+ };
1211
+ export type GetInvoiceResponses = {
1212
+ /**
1213
+ * Returns a single Invoice HTML representation under `html` property.
1214
+ */
1215
+ 200: {
1216
+ html?: string;
1217
+ };
1218
+ };
1219
+ export type GetInvoiceResponse = GetInvoiceResponses[keyof GetInvoiceResponses];
1220
+ export type ListFleetsData = {
1221
+ body?: never;
1222
+ path: {
1223
+ /**
1224
+ * Unique identifier of the cluster. UUID v4 string in canonical form
1225
+ */
1226
+ cluster_id: string;
1227
+ };
1228
+ query?: never;
1229
+ url: '/clusters/{cluster_id}/fleets';
1230
+ };
1231
+ export type ListFleetsErrors = {
1232
+ /**
1233
+ * Not authenticated
1234
+ */
1235
+ 401: unknown;
1236
+ };
1237
+ export type ListFleetsResponses = {
1238
+ /**
1239
+ * An array of fleets
1240
+ */
1241
+ 200: Array<Fleet>;
1242
+ };
1243
+ export type ListFleetsResponse = ListFleetsResponses[keyof ListFleetsResponses];
1244
+ export type CreateFleetData = {
1245
+ body: FleetCreateInput;
1246
+ path: {
1247
+ /**
1248
+ * Unique identifier of the cluster. UUID v4 string in canonical form
1249
+ */
1250
+ cluster_id: string;
1251
+ };
1252
+ query?: never;
1253
+ url: '/clusters/{cluster_id}/fleets';
1254
+ };
1255
+ export type CreateFleetErrors = {
1256
+ /**
1257
+ * Cluster quota exceeded. Maximum number of fleets per cluster allowed in this organization is reached.
1258
+ */
1259
+ 402: string;
1260
+ };
1261
+ export type CreateFleetError = CreateFleetErrors[keyof CreateFleetErrors];
1262
+ export type CreateFleetResponses = {
1263
+ /**
1264
+ * Successfully created. Returns created Fleet ID.
1265
+ */
1266
+ 200: string;
1267
+ };
1268
+ export type CreateFleetResponse = CreateFleetResponses[keyof CreateFleetResponses];
1269
+ export type DeleteFleetData = {
1270
+ body?: never;
1271
+ path: {
1272
+ /**
1273
+ * Unique identifier of the cluster. UUID v4 string in canonical form
1274
+ */
1275
+ cluster_id: string;
1276
+ /**
1277
+ * Unique identifier of the fleet. UUID v4 string in canonical form
1278
+ */
1279
+ fleet_name: string;
1280
+ };
1281
+ query?: never;
1282
+ url: '/clusters/{cluster_id}/fleets/{fleet_name}';
1283
+ };
1284
+ export type DeleteFleetResponses = {
1285
+ /**
1286
+ * Successfully deleted.
1287
+ */
1288
+ 200: string;
1289
+ };
1290
+ export type DeleteFleetResponse = DeleteFleetResponses[keyof DeleteFleetResponses];
1291
+ export type GetFleetData = {
1292
+ body?: never;
1293
+ path: {
1294
+ /**
1295
+ * Unique identifier of the cluster. UUID v4 string in canonical form
1296
+ */
1297
+ cluster_id: string;
1298
+ /**
1299
+ * Unique identifier of the fleet. UUID v4 string in canonical form
1300
+ */
1301
+ fleet_name: string;
1302
+ };
1303
+ query?: never;
1304
+ url: '/clusters/{cluster_id}/fleets/{fleet_name}';
1305
+ };
1306
+ export type GetFleetResponses = {
1307
+ /**
1308
+ * Returns a single object containing fleet details.
1309
+ */
1310
+ 200: Fleet;
1311
+ };
1312
+ export type GetFleetResponse = GetFleetResponses[keyof GetFleetResponses];
1313
+ export type UpdateFleetData = {
1314
+ body: FleetUpdateInput;
1315
+ path: {
1316
+ /**
1317
+ * Unique identifier of the cluster. UUID v4 string in canonical form
1318
+ */
1319
+ cluster_id: string;
1320
+ /**
1321
+ * Unique identifier of the fleet. UUID v4 string in canonical form
1322
+ */
1323
+ fleet_name: string;
1324
+ };
1325
+ query?: never;
1326
+ url: '/clusters/{cluster_id}/fleets/{fleet_name}';
1327
+ };
1328
+ export type UpdateFleetErrors = {
1329
+ /**
1330
+ * Organization must have a valid payment method configured to access this endpoint.
1331
+ */
1332
+ 402: string;
1333
+ };
1334
+ export type UpdateFleetError = UpdateFleetErrors[keyof UpdateFleetErrors];
1335
+ export type UpdateFleetResponses = {
1336
+ /**
1337
+ * Successfully updated.
1338
+ */
1339
+ 200: string;
1340
+ };
1341
+ export type UpdateFleetResponse = UpdateFleetResponses[keyof UpdateFleetResponses];
1342
+ export type QueryClusterData = {
1343
+ body?: never;
1344
+ path: {
1345
+ /**
1346
+ * Unique identifier of the cluster. UUID v4 string in canonical form
1347
+ */
1348
+ cluster_id: string;
1349
+ };
1350
+ query?: never;
1351
+ url: '/clusters/{cluster_id}/query';
1352
+ };
1353
+ export type QueryClusterErrors = {
1354
+ /**
1355
+ * Not authenticated
1356
+ */
1357
+ 401: unknown;
1358
+ };
1359
+ export type QueryClusterResponses = {
1360
+ /**
1361
+ * Kubernetes API response
1362
+ */
1363
+ 200: unknown;
1364
+ };
1365
+ export type ListClustersData = {
1366
+ body?: never;
1367
+ path?: never;
1368
+ query?: never;
1369
+ url: '/clusters';
1370
+ };
1371
+ export type ListClustersErrors = {
1372
+ /**
1373
+ * Not authenticated
1374
+ */
1375
+ 401: unknown;
1376
+ };
1377
+ export type ListClustersResponses = {
1378
+ /**
1379
+ * An array of clusters
1380
+ */
1381
+ 200: Array<Cluster>;
1382
+ };
1383
+ export type ListClustersResponse = ListClustersResponses[keyof ListClustersResponses];
1384
+ export type CreateClusterData = {
1385
+ body: ClusterCreateInput;
1386
+ path?: never;
1387
+ query?: never;
1388
+ url: '/clusters';
1389
+ };
1390
+ export type CreateClusterErrors = {
1391
+ /**
1392
+ * Cluster quota exceeded. Maximum number of clusters allowed in this organization is reached.
1393
+ */
1394
+ 402: string;
1395
+ };
1396
+ export type CreateClusterError = CreateClusterErrors[keyof CreateClusterErrors];
1397
+ export type CreateClusterResponses = {
1398
+ /**
1399
+ * Successfully created. Returns created Cluster ID.
1400
+ */
1401
+ 200: string;
1402
+ };
1403
+ export type CreateClusterResponse = CreateClusterResponses[keyof CreateClusterResponses];
1404
+ export type DeleteClusterData = {
1405
+ body?: never;
1406
+ path: {
1407
+ /**
1408
+ * Unique identifier of the cluster. UUID v4 string in canonical form
1409
+ */
1410
+ cluster_id: string;
1411
+ };
1412
+ query?: never;
1413
+ url: '/clusters/{cluster_id}';
1414
+ };
1415
+ export type DeleteClusterResponses = {
1416
+ /**
1417
+ * Successfully deleted.
1418
+ */
1419
+ 200: string;
1420
+ };
1421
+ export type DeleteClusterResponse = DeleteClusterResponses[keyof DeleteClusterResponses];
1422
+ export type GetClusterData = {
1423
+ body?: never;
1424
+ path: {
1425
+ /**
1426
+ * Unique identifier of the cluster. UUID v4 string in canonical form
1427
+ */
1428
+ cluster_id: string;
1429
+ };
1430
+ query?: never;
1431
+ url: '/clusters/{cluster_id}';
1432
+ };
1433
+ export type GetClusterResponses = {
1434
+ /**
1435
+ * Returns a single object containing cluster details.
1436
+ */
1437
+ 200: Cluster;
1438
+ };
1439
+ export type GetClusterResponse = GetClusterResponses[keyof GetClusterResponses];
1440
+ export type UpdateClusterData = {
1441
+ body: ClusterUpdateInput;
1442
+ path: {
1443
+ /**
1444
+ * Unique identifier of the cluster. UUID v4 string in canonical form
1445
+ */
1446
+ cluster_id: string;
1447
+ };
1448
+ query?: never;
1449
+ url: '/clusters/{cluster_id}';
1450
+ };
1451
+ export type UpdateClusterResponses = {
1452
+ /**
1453
+ * Successfully updated. Returns updated cluster details.
1454
+ */
1455
+ 200: Cluster;
1456
+ };
1457
+ export type UpdateClusterResponse = UpdateClusterResponses[keyof UpdateClusterResponses];
1458
+ export type GetJoinInformationData = {
1459
+ body?: never;
1460
+ path: {
1461
+ /**
1462
+ * Unique identifier of the cluster. UUID v4 string in canonical form
1463
+ */
1464
+ cluster_id: string;
1465
+ };
1466
+ query?: never;
1467
+ url: '/clusters/{cluster_id}/join_information';
1468
+ };
1469
+ export type GetJoinInformationErrors = {
1470
+ /**
1471
+ * Not authenticated
1472
+ */
1473
+ 401: unknown;
1474
+ };
1475
+ export type GetJoinInformationResponses = {
1476
+ /**
1477
+ * An object of cluster join information
1478
+ */
1479
+ 200: Cluster;
1480
+ };
1481
+ export type GetJoinInformationResponse = GetJoinInformationResponses[keyof GetJoinInformationResponses];
1482
+ export type GetInfrastructureData = {
1483
+ body?: never;
1484
+ path?: never;
1485
+ query?: {
1486
+ /**
1487
+ * Version of the task definition. Currently only version 1 is supported.
1488
+ */
1489
+ version?: 1;
1490
+ /**
1491
+ * Limit selection of cloud providers to this list. For the full list of supported providers, see [Providers](https://cloudfleet.ai/docs/cloud-infrastructure/providers/)
1492
+ */
1493
+ provider?: Array<string>;
1494
+ /**
1495
+ * Limits selection of cloud regions to this list of Cloudfleet regions. For the full list of normalized regions and their mapping to CSP regions, see [Regions](https://cloudfleet.ai/docs/cloud-infrastructure/node-regions/)
1496
+ */
1497
+ region?: Array<string>;
1498
+ /**
1499
+ * Limits selection of cloud regions to this list of Cloudfleet regions. For the full list of normalized regions and their mapping to CSP regions, see [Regions](https://cloudfleet.ai/docs/cloud-infrastructure/node-regions/)
1500
+ */
1501
+ sub_region?: Array<string>;
1502
+ /**
1503
+ * Limits selection of cloud regions to this list of canonical provider regions
1504
+ */
1505
+ csp_region?: Array<string>;
1506
+ /**
1507
+ * Limits selection of instance types to this list. Instance / VM type as defined by the cloud service provider
1508
+ */
1509
+ instance_type?: Array<string>;
1510
+ /**
1511
+ * List of Normalized accelerator model names. For example, all variations of Nvidia A100 GPUs will have 'A100' as accelerator name with various memory configurations set in accelerator_memory field
1512
+ */
1513
+ accelerator_name?: Array<string>;
1514
+ /**
1515
+ * List of normalized accelerator manufacturer names. For example, all Nvidia GPUs will have 'NVIDIA' as accelerator manufacturer
1516
+ */
1517
+ accelerator_manufacturer?: Array<string>;
1518
+ /**
1519
+ * Minimum number of accelerators available on the instance. Some cloud providers support shared accelerators, so the number of accelerators may be a fraction of the number of physical accelerators.
1520
+ */
1521
+ accelerator_count_min?: number;
1522
+ /**
1523
+ * Maximum number of accelerators available on the instance. Some cloud providers support shared accelerators, so the number of accelerators may be a fraction of the number of physical accelerators.
1524
+ */
1525
+ accelerator_count_max?: number;
1526
+ /**
1527
+ * Minimum amount of accelerator memory available to each accelerator. For example, Nvidia A100 GPUs will typically have '40.0' gibibytes (GiB) of memory, while A100 GPUs with HBM2E memory will have '80.0' gibibytes (GiB) of memory
1528
+ */
1529
+ accelerator_memory_min?: number;
1530
+ /**
1531
+ * Maximum amount of accelerator memory available to each accelerator. For example, Nvidia A100 GPUs will typically have '40.0' gibibytes (GiB) of memory, while A100 GPUs with HBM2E memory will have '80.0' gibibytes (GiB) of memory
1532
+ */
1533
+ accelerator_memory_max?: number;
1534
+ /**
1535
+ * Minimum amount of RAM in gibibytes (GiB)
1536
+ */
1537
+ memory_min?: number;
1538
+ /**
1539
+ * Maximum amount of RAM in gibibytes (GiB)
1540
+ */
1541
+ memory_max?: number;
1542
+ /**
1543
+ * Minimum number of vCPUs as defined by the cloud service provider. Some cloud providers use hyperthreading, so the number of vCPUs may be twice as high as the number of physical cores.
1544
+ */
1545
+ vcpu_min?: number;
1546
+ /**
1547
+ * Maximum number of vCPUs as defined by the cloud service provider. Some cloud providers use hyperthreading, so the number of vCPUs may be twice as high as the number of physical cores.
1548
+ */
1549
+ vcpu_max?: number;
1550
+ /**
1551
+ * Minimum total storage in GiB (attached and local)
1552
+ */
1553
+ storage_total_min?: number;
1554
+ /**
1555
+ * Maximum total storage in GiB (attached and local)
1556
+ */
1557
+ storage_total_max?: number;
1558
+ /**
1559
+ * Minimum volume of directly attached, block-device local storage in gibibytes (GiB)
1560
+ */
1561
+ storage_local_min?: number;
1562
+ /**
1563
+ * Maximum volume of directly attached, block-device local storage in gibibytes (GiB)
1564
+ */
1565
+ storage_local_max?: number;
1566
+ /**
1567
+ * Minimum price of running the inctance per hour in USD as defined by the cloud service provider. The cheapest instance will be selected.
1568
+ */
1569
+ price_min?: number;
1570
+ /**
1571
+ * Maximum price of running the inctance per hour in USD as defined by the cloud service provider. The cheapest instance will be selected.
1572
+ */
1573
+ price_max?: number;
1574
+ };
1575
+ url: '/infrastructure';
1576
+ };
1577
+ export type GetInfrastructureErrors = {
1578
+ /**
1579
+ * Returns a validation error if any of the search parameters in the request are invalid
1580
+ */
1581
+ 400: Blob | File;
1582
+ };
1583
+ export type GetInfrastructureError = GetInfrastructureErrors[keyof GetInfrastructureErrors];
1584
+ export type GetInfrastructureResponses = {
1585
+ /**
1586
+ * An array of instances returned by the search
1587
+ */
1588
+ 200: Array<InfrastructureInstance>;
1589
+ };
1590
+ export type GetInfrastructureResponse = GetInfrastructureResponses[keyof GetInfrastructureResponses];
1591
+ export type GetFacetsData = {
1592
+ body?: never;
1593
+ path?: never;
1594
+ query?: never;
1595
+ url: '/infrastructure/facets';
1596
+ };
1597
+ export type GetFacetsResponses = {
1598
+ /**
1599
+ * Calculates search facets of the infrastructure catalog
1600
+ */
1601
+ 200: Array<{
1602
+ /**
1603
+ * Limit selection of cloud providers to this list. For the full list of supported providers, see [Providers](https://cloudfleet.ai/docs/cloud-infrastructure/providers/)
1604
+ */
1605
+ provider?: Array<string>;
1606
+ /**
1607
+ * Limits selection of cloud regions to this list of Cloudfleet regions. For the full list of normalized regions and their mapping to CSP regions, see [Regions](https://cloudfleet.ai/docs/cloud-infrastructure/node-regions/)
1608
+ */
1609
+ region?: Array<string>;
1610
+ /**
1611
+ * Limits selection of cloud sub-regions to this list of Cloudfleet sub-regions. For the full list of normalized regions and their mapping to CSP regions, see [Regions](https://cloudfleet.ai/docs/cloud-infrastructure/node-regions/)
1612
+ */
1613
+ sub_region?: Array<string>;
1614
+ /**
1615
+ * Limits selection of cloud regions to this list of canonical provider regions
1616
+ */
1617
+ csp_region?: Array<string>;
1618
+ /**
1619
+ * Minimum number of vCPUs as defined by the cloud service provider. Some cloud providers use hyperthreading, so the number of vCPUs may be twice as high as the number of physical cores.
1620
+ */
1621
+ vcpu_min?: number;
1622
+ /**
1623
+ * Maximum number of vCPUs as defined by the cloud service provider. Some cloud providers use hyperthreading, so the number of vCPUs may be twice as high as the number of physical cores.
1624
+ */
1625
+ vcpu_max?: number;
1626
+ /**
1627
+ * Minimum amount of RAM in gibibytes (GiB)
1628
+ */
1629
+ memory_min?: number;
1630
+ /**
1631
+ * Maximum amount of RAM in gibibytes (GiB)
1632
+ */
1633
+ memory_max?: number;
1634
+ /**
1635
+ * Minimum volume of directly attached, block-device local storage in gibibytes (GiB)
1636
+ */
1637
+ storage_local_min?: number;
1638
+ /**
1639
+ * Maximum volume of directly attached, block-device local storage in gibibytes (GiB)
1640
+ */
1641
+ storage_local_max?: number;
1642
+ /**
1643
+ * List of Normalized accelerator model names. For example, all variations of Nvidia A100 GPUs will have 'A100' as accelerator name with various memory configurations set in accelerator_memory field
1644
+ */
1645
+ accelerator_name?: Array<string>;
1646
+ /**
1647
+ * List of normalized accelerator manufacturer names. For example, all Nvidia GPUs will have 'NVIDIA' as accelerator manufacturer
1648
+ */
1649
+ accelerator_manufacturer?: Array<string>;
1650
+ /**
1651
+ * Minimum number of accelerators available on the instance. Some cloud providers support shared accelerators, so the number of accelerators may be a fraction of the number of physical accelerators.
1652
+ */
1653
+ accelerator_count_min?: number;
1654
+ /**
1655
+ * Maximum number of accelerators available on the instance. Some cloud providers support shared accelerators, so the number of accelerators may be a fraction of the number of physical accelerators.
1656
+ */
1657
+ accelerator_count_max?: number;
1658
+ /**
1659
+ * Minimum amount of accelerator memory available to each accelerator. For example, Nvidia A100 GPUs will typically have '40.0' gibibytes (GiB) of memory, while A100 GPUs with HBM2E memory will have '80.0' gibibytes (GiB) of memory
1660
+ */
1661
+ accelerator_memory_min?: number;
1662
+ /**
1663
+ * Maximum amount of accelerator memory available to each accelerator. For example, Nvidia A100 GPUs will typically have '40.0' gibibytes (GiB) of memory, while A100 GPUs with HBM2E memory will have '80.0' gibibytes (GiB) of memory
1664
+ */
1665
+ accelerator_memory_max?: number;
1666
+ /**
1667
+ * Minimum price of running the inctance per hour in USD as defined by the cloud service provider. The cheapest instance will be selected.
1668
+ */
1669
+ price_min?: number;
1670
+ /**
1671
+ * Maximum price of running the inctance per hour in USD as defined by the cloud service provider. The cheapest instance will be selected.
1672
+ */
1673
+ price_max?: number;
1674
+ /**
1675
+ * Structured array of regions and sub-regions
1676
+ */
1677
+ regions_struct?: Array<{
1678
+ /**
1679
+ * Limits selection of cloud regions to this list of Cloudfleet regions. For the full list of normalized regions and their mapping to CSP regions, see [Regions](https://cloudfleet.ai/docs/cloud-infrastructure/node-regions/)
1680
+ */
1681
+ region?: string;
1682
+ sub_region?: Array<string>;
1683
+ }>;
1684
+ /**
1685
+ * Structured array of regions and sub-regions
1686
+ */
1687
+ accelerators_struct?: Array<{
1688
+ /**
1689
+ * List of normalized accelerator manufacturer names. For example, all Nvidia GPUs will have 'NVIDIA' as accelerator manufacturer
1690
+ */
1691
+ accelerator_manufacturer?: string;
1692
+ accelerator_name?: Array<string>;
1693
+ }>;
1694
+ /**
1695
+ * Total number of instances in the catalog
1696
+ */
1697
+ count_total?: number;
1698
+ /**
1699
+ * Total number of instances in the catalog with at least 1 accelerator
1700
+ */
1701
+ count_accelerators?: number;
1702
+ /**
1703
+ * Total number of unique instances types in the catalog
1704
+ */
1705
+ count_instance_types?: number;
1706
+ /**
1707
+ * Total number of unique instances types in the catalog with at least 1 accelerator
1708
+ */
1709
+ count_accelerators_instance_types?: number;
1710
+ }>;
1711
+ };
1712
+ export type GetFacetsResponse = GetFacetsResponses[keyof GetFacetsResponses];
1713
+ export type GetRegionsData = {
1714
+ body?: never;
1715
+ path?: never;
1716
+ query?: never;
1717
+ url: '/infrastructure/regions';
1718
+ };
1719
+ export type GetRegionsResponses = {
1720
+ /**
1721
+ * Available Cloudfleet regions and Kubernetes versions.
1722
+ */
1723
+ 200: {
1724
+ [key: string]: unknown;
1725
+ };
1726
+ };
1727
+ export type GetRegionsResponse = GetRegionsResponses[keyof GetRegionsResponses];
1728
+ export type ListInvitesData = {
1729
+ body?: never;
1730
+ path?: never;
1731
+ query?: never;
1732
+ url: '/invites';
1733
+ };
1734
+ export type ListInvitesErrors = {
1735
+ /**
1736
+ * Not authenticated
1737
+ */
1738
+ 401: unknown;
1739
+ };
1740
+ export type ListInvitesResponses = {
1741
+ /**
1742
+ * An array of invites
1743
+ */
1744
+ 200: Array<Invite>;
1745
+ };
1746
+ export type ListInvitesResponse = ListInvitesResponses[keyof ListInvitesResponses];
1747
+ export type CreateInviteData = {
1748
+ body: {
1749
+ /**
1750
+ * User email address
1751
+ */
1752
+ email?: string;
1753
+ };
1754
+ path?: never;
1755
+ query?: never;
1756
+ url: '/invites';
1757
+ };
1758
+ export type CreateInviteResponses = {
1759
+ /**
1760
+ * Successfully created. Returns created invite details.
1761
+ */
1762
+ 200: Invite;
1763
+ };
1764
+ export type CreateInviteResponse = CreateInviteResponses[keyof CreateInviteResponses];
1765
+ export type GetInviteData = {
1766
+ body?: never;
1767
+ path: {
1768
+ /**
1769
+ * Invitation code
1770
+ */
1771
+ code: string;
1772
+ };
1773
+ query?: never;
1774
+ url: '/invites/{code}';
1775
+ };
1776
+ export type GetInviteResponses = {
1777
+ /**
1778
+ * Returns a single object containing invite details.
1779
+ */
1780
+ 200: Invite;
1781
+ };
1782
+ export type GetInviteResponse = GetInviteResponses[keyof GetInviteResponses];
1783
+ export type DeleteInviteData = {
1784
+ body?: never;
1785
+ path: {
1786
+ /**
1787
+ * User email address
1788
+ */
1789
+ email: string;
1790
+ };
1791
+ query?: never;
1792
+ url: '/invites/{email}';
1793
+ };
1794
+ export type DeleteInviteResponses = {
1795
+ /**
1796
+ * Successfully deleted.
1797
+ */
1798
+ 200: unknown;
1799
+ };
1800
+ export type GetOrganizationData = {
1801
+ body?: never;
1802
+ path?: never;
1803
+ query?: never;
1804
+ url: '/organization';
1805
+ };
1806
+ export type GetOrganizationResponses = {
1807
+ /**
1808
+ * Returns a single object containing organization details.
1809
+ */
1810
+ 200: Organization;
1811
+ };
1812
+ export type GetOrganizationResponse = GetOrganizationResponses[keyof GetOrganizationResponses];
1813
+ export type CreateOrganizationData = {
1814
+ body: OrganizationCreateInput;
1815
+ path?: never;
1816
+ query?: never;
1817
+ url: '/organization';
1818
+ };
1819
+ export type CreateOrganizationResponses = {
1820
+ /**
1821
+ * Successfully created a new organization. Returns organization details.
1822
+ */
1823
+ 200: Organization;
1824
+ };
1825
+ export type CreateOrganizationResponse = CreateOrganizationResponses[keyof CreateOrganizationResponses];
1826
+ export type UpdateOrganizationData = {
1827
+ body: OrganizationUpdateInput;
1828
+ path?: never;
1829
+ query?: never;
1830
+ url: '/organization';
1831
+ };
1832
+ export type UpdateOrganizationResponses = {
1833
+ /**
1834
+ * Successfully updated. Returns updated organization details.
1835
+ */
1836
+ 200: Organization;
1837
+ };
1838
+ export type UpdateOrganizationResponse = UpdateOrganizationResponses[keyof UpdateOrganizationResponses];
1839
+ export type ListTokensData = {
1840
+ body?: never;
1841
+ path?: never;
1842
+ query?: never;
1843
+ url: '/tokens';
1844
+ };
1845
+ export type ListTokensErrors = {
1846
+ /**
1847
+ * Not authenticated
1848
+ */
1849
+ 401: unknown;
1850
+ };
1851
+ export type ListTokensResponses = {
1852
+ /**
1853
+ * Returns a list of access token details with masked secrets.
1854
+ */
1855
+ 200: Array<Token>;
1856
+ };
1857
+ export type ListTokensResponse = ListTokensResponses[keyof ListTokensResponses];
1858
+ export type CreateTokenData = {
1859
+ body: TokenCreateInput;
1860
+ path?: never;
1861
+ query?: never;
1862
+ url: '/tokens';
1863
+ };
1864
+ export type CreateTokenErrors = {
1865
+ /**
1866
+ * Not authenticated
1867
+ */
1868
+ 401: unknown;
1869
+ };
1870
+ export type CreateTokenResponses = {
1871
+ /**
1872
+ * Successfully created. Returns created token details with unmasked/raw secret.
1873
+ */
1874
+ 200: Token;
1875
+ };
1876
+ export type CreateTokenResponse = CreateTokenResponses[keyof CreateTokenResponses];
1877
+ export type DeleteTokenData = {
1878
+ body?: never;
1879
+ path: {
1880
+ /**
1881
+ * Generated unique identifier of the access token.
1882
+ */
1883
+ token_id: string;
1884
+ };
1885
+ query?: never;
1886
+ url: '/tokens/{token_id}';
1887
+ };
1888
+ export type DeleteTokenResponses = {
1889
+ /**
1890
+ * Successfully deleted.
1891
+ */
1892
+ 200: unknown;
1893
+ };
1894
+ export type GetTokenData = {
1895
+ body?: never;
1896
+ path: {
1897
+ /**
1898
+ * Generated unique identifier of the access token.
1899
+ */
1900
+ token_id: string;
1901
+ };
1902
+ query?: never;
1903
+ url: '/tokens/{token_id}';
1904
+ };
1905
+ export type GetTokenErrors = {
1906
+ /**
1907
+ * Not authenticated
1908
+ */
1909
+ 401: unknown;
1910
+ };
1911
+ export type GetTokenResponses = {
1912
+ /**
1913
+ * Returns access token details with masked secret.
1914
+ */
1915
+ 200: Token;
1916
+ };
1917
+ export type GetTokenResponse = GetTokenResponses[keyof GetTokenResponses];
1918
+ export type UpdateTokenData = {
1919
+ body: TokenUpdateInput;
1920
+ path: {
1921
+ /**
1922
+ * Generated unique identifier of the access token.
1923
+ */
1924
+ token_id: string;
1925
+ };
1926
+ query?: never;
1927
+ url: '/tokens/{token_id}';
1928
+ };
1929
+ export type UpdateTokenErrors = {
1930
+ /**
1931
+ * Not authenticated
1932
+ */
1933
+ 401: unknown;
1934
+ };
1935
+ export type UpdateTokenResponses = {
1936
+ /**
1937
+ * Successfully updated. Returns updated token details with masked secret.
1938
+ */
1939
+ 200: Token;
1940
+ };
1941
+ export type UpdateTokenResponse = UpdateTokenResponses[keyof UpdateTokenResponses];
1942
+ export type RegenerateTokenData = {
1943
+ body?: never;
1944
+ path: {
1945
+ /**
1946
+ * Generated unique identifier of the access token.
1947
+ */
1948
+ token_id: string;
1949
+ };
1950
+ query?: never;
1951
+ url: '/tokens/{token_id}/secret';
1952
+ };
1953
+ export type RegenerateTokenErrors = {
1954
+ /**
1955
+ * Not authenticated
1956
+ */
1957
+ 401: unknown;
1958
+ };
1959
+ export type RegenerateTokenResponses = {
1960
+ /**
1961
+ * Successfully updated. Returns updated token details with unmasked / raw secret.
1962
+ */
1963
+ 200: Token;
1964
+ };
1965
+ export type RegenerateTokenResponse = RegenerateTokenResponses[keyof RegenerateTokenResponses];
1966
+ export type ListUserOrganizationsData = {
1967
+ body?: never;
1968
+ path: {
1969
+ /**
1970
+ * User email address.
1971
+ */
1972
+ email: string;
1973
+ };
1974
+ query?: never;
1975
+ url: '/users/organizations/{email}';
1976
+ };
1977
+ export type ListUserOrganizationsResponses = {
1978
+ /**
1979
+ * An array of organizations the user belongs to.
1980
+ */
1981
+ 200: Array<{
1982
+ /**
1983
+ * Unique identifier of the organization. UUID v4 string in canonical form
1984
+ */
1985
+ realm?: string;
1986
+ /**
1987
+ * Human-readable name of the organization
1988
+ */
1989
+ displayName?: string;
1990
+ }>;
1991
+ };
1992
+ export type ListUserOrganizationsResponse = ListUserOrganizationsResponses[keyof ListUserOrganizationsResponses];
1993
+ export type ListUsersData = {
1994
+ body?: never;
1995
+ path?: never;
1996
+ query?: never;
1997
+ url: '/users';
1998
+ };
1999
+ export type ListUsersErrors = {
2000
+ /**
2001
+ * Not authenticated
2002
+ */
2003
+ 401: unknown;
2004
+ };
2005
+ export type ListUsersResponses = {
2006
+ /**
2007
+ * An array of users
2008
+ */
2009
+ 200: Array<User>;
2010
+ };
2011
+ export type ListUsersResponse = ListUsersResponses[keyof ListUsersResponses];
2012
+ export type CreateUserData = {
2013
+ body: UserCreateInput;
2014
+ path?: never;
2015
+ query?: never;
2016
+ url: '/users';
2017
+ };
2018
+ export type CreateUserResponses = {
2019
+ /**
2020
+ * Successfully created. Returns created user details.
2021
+ */
2022
+ 200: User;
2023
+ };
2024
+ export type CreateUserResponse = CreateUserResponses[keyof CreateUserResponses];
2025
+ export type DeleteUserData = {
2026
+ body?: never;
2027
+ path: {
2028
+ /**
2029
+ * Unique user identifier. UUID v4 string in canonical form
2030
+ */
2031
+ user_id: string;
2032
+ };
2033
+ query?: never;
2034
+ url: '/users/{user_id}';
2035
+ };
2036
+ export type DeleteUserErrors = {
2037
+ /**
2038
+ * Deleting own user is not allowed. Delete your organization instead.
2039
+ */
2040
+ 400: unknown;
2041
+ /**
2042
+ * Not authenticated
2043
+ */
2044
+ 401: unknown;
2045
+ };
2046
+ export type DeleteUserResponses = {
2047
+ /**
2048
+ * User profile information
2049
+ */
2050
+ 200: User;
2051
+ };
2052
+ export type DeleteUserResponse = DeleteUserResponses[keyof DeleteUserResponses];
2053
+ export type GetUserData = {
2054
+ body?: never;
2055
+ path: {
2056
+ /**
2057
+ * Unique user identifier. UUID v4 string in canonical form
2058
+ */
2059
+ user_id: string;
2060
+ };
2061
+ query?: never;
2062
+ url: '/users/{user_id}';
2063
+ };
2064
+ export type GetUserErrors = {
2065
+ /**
2066
+ * Not authenticated
2067
+ */
2068
+ 401: unknown;
2069
+ };
2070
+ export type GetUserResponses = {
2071
+ /**
2072
+ * User profile information
2073
+ */
2074
+ 200: User;
2075
+ };
2076
+ export type GetUserResponse = GetUserResponses[keyof GetUserResponses];
2077
+ export type UpdateUserData = {
2078
+ body: UserUpdateInput;
2079
+ path: {
2080
+ /**
2081
+ * Unique user identifier. UUID v4 string in canonical form
2082
+ */
2083
+ user_id: string;
2084
+ };
2085
+ query?: never;
2086
+ url: '/users/{user_id}';
2087
+ };
2088
+ export type UpdateUserResponses = {
2089
+ /**
2090
+ * Successfully created. Returns created user details.
2091
+ */
2092
+ 200: User;
2093
+ };
2094
+ export type UpdateUserResponse = UpdateUserResponses[keyof UpdateUserResponses];
2095
+ export type DeleteClusterPermissionsData = {
2096
+ body?: never;
2097
+ path: {
2098
+ /**
2099
+ * Unique user identifier. UUID v4 string in canonical form
2100
+ */
2101
+ user_id: string;
2102
+ /**
2103
+ * Unique cluster identifier. UUID v4 string in canonical form
2104
+ */
2105
+ cluster_id: string;
2106
+ };
2107
+ query?: never;
2108
+ url: '/users/{user_id}/clusters/{cluster_id}';
2109
+ };
2110
+ export type DeleteClusterPermissionsResponses = {
2111
+ /**
2112
+ * Successfully removed user from the cluster. Returns updated user details.
2113
+ */
2114
+ 200: User;
2115
+ };
2116
+ export type DeleteClusterPermissionsResponse = DeleteClusterPermissionsResponses[keyof DeleteClusterPermissionsResponses];
2117
+ export type SetClusterPermissionsData = {
2118
+ body: {
2119
+ /**
2120
+ * Level of permissions for the user to access the cluster
2121
+ */
2122
+ permissions?: 'readwrite' | 'readonly';
2123
+ };
2124
+ path: {
2125
+ /**
2126
+ * Unique user identifier. UUID v4 string in canonical form
2127
+ */
2128
+ user_id: string;
2129
+ /**
2130
+ * Unique cluster identifier. UUID v4 string in canonical form
2131
+ */
2132
+ cluster_id: string;
2133
+ };
2134
+ query?: never;
2135
+ url: '/users/{user_id}/clusters/{cluster_id}';
2136
+ };
2137
+ export type SetClusterPermissionsResponses = {
2138
+ /**
2139
+ * Successfully created. Returns created user details.
2140
+ */
2141
+ 200: User;
2142
+ };
2143
+ export type SetClusterPermissionsResponse = SetClusterPermissionsResponses[keyof SetClusterPermissionsResponses];
2144
+ //# sourceMappingURL=types.gen.d.ts.map