@cloudfleet/sdk 0.0.1-830b4e3 → 0.0.1-8608ef2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +26 -2
- package/dist/@tanstack/react-query.gen.d.ts +1026 -0
- package/dist/@tanstack/react-query.gen.d.ts.map +1 -0
- package/dist/@tanstack/react-query.gen.js +1194 -0
- package/dist/@tanstack/react-query.gen.js.map +1 -0
- package/dist/client/client.gen.d.ts +3 -0
- package/dist/client/client.gen.d.ts.map +1 -0
- package/dist/client/client.gen.js +217 -0
- package/dist/client/client.gen.js.map +1 -0
- package/dist/client/index.d.ts +8 -7
- package/dist/client/index.d.ts.map +1 -1
- package/dist/client/index.js +6 -4
- package/dist/client/index.js.map +1 -1
- package/dist/client/{types.d.ts → types.gen.d.ts} +23 -22
- package/dist/client/types.gen.d.ts.map +1 -0
- package/dist/client/types.gen.js +3 -0
- package/dist/client/types.gen.js.map +1 -0
- package/dist/client/{utils.d.ts → utils.gen.d.ts} +17 -25
- package/dist/client/utils.gen.d.ts.map +1 -0
- package/dist/client/{utils.js → utils.gen.js} +66 -122
- package/dist/client/utils.gen.js.map +1 -0
- package/dist/client.gen.d.ts +3 -3
- package/dist/client.gen.d.ts.map +1 -1
- package/dist/client.gen.js +1 -3
- package/dist/client.gen.js.map +1 -1
- package/dist/core/{auth.d.ts → auth.gen.d.ts} +1 -1
- package/dist/core/auth.gen.d.ts.map +1 -0
- package/dist/core/{auth.js → auth.gen.js} +2 -1
- package/dist/core/auth.gen.js.map +1 -0
- package/dist/core/bodySerializer.gen.d.ts +26 -0
- package/dist/core/bodySerializer.gen.d.ts.map +1 -0
- package/dist/core/{bodySerializer.js → bodySerializer.gen.js} +6 -2
- package/dist/core/bodySerializer.gen.js.map +1 -0
- package/dist/core/{params.d.ts → params.gen.d.ts} +21 -1
- package/dist/core/params.gen.d.ts.map +1 -0
- package/dist/core/{params.js → params.gen.js} +24 -11
- package/dist/core/params.gen.js.map +1 -0
- package/dist/core/{pathSerializer.d.ts → pathSerializer.gen.d.ts} +1 -1
- package/dist/core/pathSerializer.gen.d.ts.map +1 -0
- package/dist/core/{pathSerializer.js → pathSerializer.gen.js} +5 -12
- package/dist/core/pathSerializer.gen.js.map +1 -0
- package/dist/core/queryKeySerializer.gen.d.ts +19 -0
- package/dist/core/queryKeySerializer.gen.d.ts.map +1 -0
- package/dist/core/queryKeySerializer.gen.js +93 -0
- package/dist/core/queryKeySerializer.gen.js.map +1 -0
- package/dist/core/serverSentEvents.gen.d.ts +72 -0
- package/dist/core/serverSentEvents.gen.d.ts.map +1 -0
- package/dist/core/serverSentEvents.gen.js +133 -0
- package/dist/core/serverSentEvents.gen.js.map +1 -0
- package/dist/core/{types.d.ts → types.gen.d.ts} +21 -16
- package/dist/core/types.gen.d.ts.map +1 -0
- package/dist/core/types.gen.js +3 -0
- package/dist/core/types.gen.js.map +1 -0
- package/dist/core/utils.gen.d.ts +20 -0
- package/dist/core/utils.gen.d.ts.map +1 -0
- package/dist/core/utils.gen.js +88 -0
- package/dist/core/utils.gen.js.map +1 -0
- package/dist/schemas.gen.d.ts +1764 -639
- package/dist/schemas.gen.d.ts.map +1 -1
- package/dist/schemas.gen.js +3159 -688
- package/dist/schemas.gen.js.map +1 -1
- package/dist/sdk.gen.d.ts +300 -161
- package/dist/sdk.gen.d.ts.map +1 -1
- package/dist/sdk.gen.js +423 -335
- package/dist/sdk.gen.js.map +1 -1
- package/dist/services/kubernetes/api.d.ts +20 -20
- package/dist/types.gen.d.ts +1939 -841
- package/dist/types.gen.d.ts.map +1 -1
- package/dist/zod.gen.d.ts +3947 -3751
- package/dist/zod.gen.d.ts.map +1 -1
- package/dist/zod.gen.js +1478 -1151
- package/dist/zod.gen.js.map +1 -1
- package/package.json +28 -8
- package/dist/client/client.d.ts +0 -3
- package/dist/client/client.d.ts.map +0 -1
- package/dist/client/client.js +0 -144
- package/dist/client/client.js.map +0 -1
- package/dist/client/types.d.ts.map +0 -1
- package/dist/client/types.js +0 -2
- package/dist/client/types.js.map +0 -1
- package/dist/client/utils.d.ts.map +0 -1
- package/dist/client/utils.js.map +0 -1
- package/dist/core/auth.d.ts.map +0 -1
- package/dist/core/auth.js.map +0 -1
- package/dist/core/bodySerializer.d.ts +0 -18
- package/dist/core/bodySerializer.d.ts.map +0 -1
- package/dist/core/bodySerializer.js.map +0 -1
- package/dist/core/params.d.ts.map +0 -1
- package/dist/core/params.js.map +0 -1
- package/dist/core/pathSerializer.d.ts.map +0 -1
- package/dist/core/pathSerializer.js.map +0 -1
- package/dist/core/types.d.ts.map +0 -1
- package/dist/core/types.js +0 -2
- package/dist/core/types.js.map +0 -1
package/dist/types.gen.d.ts
CHANGED
|
@@ -1,4 +1,11 @@
|
|
|
1
|
+
export type ClientOptions = {
|
|
2
|
+
baseUrl: 'https://api.cloudfleet.ai/v1' | (string & {});
|
|
3
|
+
};
|
|
1
4
|
export type BillingContact = {
|
|
5
|
+
/**
|
|
6
|
+
* Type of the organization. `business` for legal entities, `personal` for individuals.
|
|
7
|
+
*/
|
|
8
|
+
type: 'business' | 'personal';
|
|
2
9
|
/**
|
|
3
10
|
* Name of the legal entity. This name will be used in invoices. Use your first and last name for individual accounts.
|
|
4
11
|
*/
|
|
@@ -36,13 +43,9 @@ export type BillingContact = {
|
|
|
36
43
|
*/
|
|
37
44
|
email: string;
|
|
38
45
|
/**
|
|
39
|
-
*
|
|
40
|
-
*/
|
|
41
|
-
first_name: string;
|
|
42
|
-
/**
|
|
43
|
-
* Last name of the billing contact person.
|
|
46
|
+
* Name of the billing contact person.
|
|
44
47
|
*/
|
|
45
|
-
|
|
48
|
+
individual_name: string;
|
|
46
49
|
/**
|
|
47
50
|
* Tax ID of the organization.
|
|
48
51
|
*/
|
|
@@ -58,35 +61,31 @@ export type BillingCredits = {
|
|
|
58
61
|
*/
|
|
59
62
|
id?: string;
|
|
60
63
|
/**
|
|
61
|
-
*
|
|
62
|
-
*/
|
|
63
|
-
date_created: string;
|
|
64
|
-
/**
|
|
65
|
-
* Promotional code used by the customer.
|
|
64
|
+
* Type of the promotional code.
|
|
66
65
|
*/
|
|
67
|
-
|
|
66
|
+
type: 'credit' | 'discount';
|
|
68
67
|
/**
|
|
69
|
-
*
|
|
68
|
+
* Timestamp when the credit becomes active. ISO 8601 date string in the UTC timezone.
|
|
70
69
|
*/
|
|
71
|
-
|
|
70
|
+
date_start: string;
|
|
72
71
|
/**
|
|
73
|
-
*
|
|
72
|
+
* Timestamp when the credit expires or becomes inactive. ISO 8601 date string in the UTC timezone.
|
|
74
73
|
*/
|
|
75
|
-
|
|
74
|
+
date_end?: string;
|
|
76
75
|
/**
|
|
77
|
-
*
|
|
76
|
+
* Promotional code used by the customer.
|
|
78
77
|
*/
|
|
79
|
-
|
|
78
|
+
code: string;
|
|
80
79
|
/**
|
|
81
|
-
*
|
|
80
|
+
* Description of the promotional code.
|
|
82
81
|
*/
|
|
83
|
-
|
|
82
|
+
description?: string;
|
|
84
83
|
/**
|
|
85
|
-
*
|
|
84
|
+
* Total value of the promotional code.
|
|
86
85
|
*/
|
|
87
|
-
|
|
86
|
+
value_total: number;
|
|
88
87
|
/**
|
|
89
|
-
*
|
|
88
|
+
* Remaining value of the promotional code.
|
|
90
89
|
*/
|
|
91
90
|
value_remaining?: number;
|
|
92
91
|
};
|
|
@@ -134,9 +133,9 @@ export type Chart = {
|
|
|
134
133
|
*/
|
|
135
134
|
chart: string;
|
|
136
135
|
/**
|
|
137
|
-
* Status of the chart deployment.
|
|
136
|
+
* Status of the chart deployment (Flux HelmRelease Ready condition reason, e.g. InstallSucceeded, UpgradeFailed, Progressing).
|
|
138
137
|
*/
|
|
139
|
-
status:
|
|
138
|
+
status: string;
|
|
140
139
|
/**
|
|
141
140
|
* Current version of the chart deployment.
|
|
142
141
|
*/
|
|
@@ -164,6 +163,9 @@ export type ChartUpdateInput = {
|
|
|
164
163
|
*/
|
|
165
164
|
version_channel: string;
|
|
166
165
|
};
|
|
166
|
+
/**
|
|
167
|
+
* Mutable cluster configuration. Applied as a full overwrite: any omitted field is reset to its default rather than left unchanged.
|
|
168
|
+
*/
|
|
167
169
|
export type ClusterCreateInput = {
|
|
168
170
|
/**
|
|
169
171
|
* Name of the cluster.
|
|
@@ -172,15 +174,61 @@ export type ClusterCreateInput = {
|
|
|
172
174
|
/**
|
|
173
175
|
* Tier of the cluster.
|
|
174
176
|
*/
|
|
175
|
-
tier
|
|
176
|
-
/**
|
|
177
|
-
* Cloudfleet control plane region. One of "staging", "northamerica-central-1", "europe-central-1a". This field can not be updated after creation.
|
|
178
|
-
*/
|
|
179
|
-
region?: 'staging' | 'northamerica-central-1' | 'europe-central-1a';
|
|
177
|
+
tier?: 'basic' | 'pro' | 'enterprise';
|
|
180
178
|
/**
|
|
181
179
|
* Version of the kubernetes cluster.
|
|
182
180
|
*/
|
|
183
181
|
version_channel?: string;
|
|
182
|
+
/**
|
|
183
|
+
* Release channel for the cluster's control plane.
|
|
184
|
+
*/
|
|
185
|
+
release_channel?: 'rapid' | 'stable' | 'extended';
|
|
186
|
+
/**
|
|
187
|
+
* Cluster feature toggles.
|
|
188
|
+
*/
|
|
189
|
+
features?: {
|
|
190
|
+
/**
|
|
191
|
+
* GPU sharing strategy.
|
|
192
|
+
*/
|
|
193
|
+
gpu_sharing_strategy?: 'none' | 'mps' | 'time_slicing';
|
|
194
|
+
/**
|
|
195
|
+
* Maximum number of pods that may share a single GPU.
|
|
196
|
+
*/
|
|
197
|
+
gpu_max_shared_clients_per_gpu?: number;
|
|
198
|
+
/**
|
|
199
|
+
* Restrict Cilium socket load-balancing to the host namespace. Required for the Tailscale operator and Istio.
|
|
200
|
+
*/
|
|
201
|
+
cilium_socket_lb_host_namespace_only?: boolean;
|
|
202
|
+
};
|
|
203
|
+
/**
|
|
204
|
+
* Cloudfleet control plane region. This field can not be updated after creation.
|
|
205
|
+
*/
|
|
206
|
+
region: string;
|
|
207
|
+
/**
|
|
208
|
+
* Cluster networking configuration. Immutable after creation.
|
|
209
|
+
*/
|
|
210
|
+
networking?: {
|
|
211
|
+
/**
|
|
212
|
+
* CIDR block for pod IPs.
|
|
213
|
+
*/
|
|
214
|
+
pod_cidr?: string;
|
|
215
|
+
/**
|
|
216
|
+
* CIDR block for service IPs.
|
|
217
|
+
*/
|
|
218
|
+
service_cidr?: string;
|
|
219
|
+
/**
|
|
220
|
+
* Enable IPv4+IPv6 dual-stack networking.
|
|
221
|
+
*/
|
|
222
|
+
dual_stack?: boolean;
|
|
223
|
+
/**
|
|
224
|
+
* IPv6 pod CIDR. Requires dual_stack.
|
|
225
|
+
*/
|
|
226
|
+
pod_cidr_v6?: string;
|
|
227
|
+
/**
|
|
228
|
+
* IPv6 service CIDR. Requires dual_stack.
|
|
229
|
+
*/
|
|
230
|
+
service_cidr_v6?: string;
|
|
231
|
+
};
|
|
184
232
|
};
|
|
185
233
|
export type ClusterJoinInformation = {
|
|
186
234
|
/**
|
|
@@ -191,10 +239,22 @@ export type ClusterJoinInformation = {
|
|
|
191
239
|
* Internal URL of the Kubernetes cluster control plane. This is the endpoint that kubelet uses to connect to the cluster.
|
|
192
240
|
*/
|
|
193
241
|
endpoint: string;
|
|
242
|
+
/**
|
|
243
|
+
* Cluster DNS IP address. This is the IP address of the kube-dns service in the cluster.
|
|
244
|
+
*/
|
|
245
|
+
cluster_dns: string;
|
|
246
|
+
/**
|
|
247
|
+
* Pod CIDR for the cluster. Used to configure iptables rules on nodes to prevent Tailscale routing loops.
|
|
248
|
+
*/
|
|
249
|
+
pod_cidr: string;
|
|
194
250
|
/**
|
|
195
251
|
* Authentication key for the cluster.
|
|
196
252
|
*/
|
|
197
253
|
auth_key: string;
|
|
254
|
+
/**
|
|
255
|
+
* Coordination server the node registers against. Empty on data plane v1 clusters, where the node advertises its own tag instead. A non-empty value requires a client that declares the dataplane-v2 capability.
|
|
256
|
+
*/
|
|
257
|
+
login_server: string;
|
|
198
258
|
/**
|
|
199
259
|
* Bootstrap token for the cluster.
|
|
200
260
|
*/
|
|
@@ -238,6 +298,9 @@ export type ClusterJoinInformation = {
|
|
|
238
298
|
gcp_workload_identity_provider: string;
|
|
239
299
|
};
|
|
240
300
|
};
|
|
301
|
+
/**
|
|
302
|
+
* Mutable cluster configuration. Applied as a full overwrite: any omitted field is reset to its default rather than left unchanged.
|
|
303
|
+
*/
|
|
241
304
|
export type Cluster = {
|
|
242
305
|
/**
|
|
243
306
|
* Name of the cluster.
|
|
@@ -246,24 +309,71 @@ export type Cluster = {
|
|
|
246
309
|
/**
|
|
247
310
|
* Tier of the cluster.
|
|
248
311
|
*/
|
|
249
|
-
tier: 'basic' | 'pro';
|
|
312
|
+
tier: 'basic' | 'pro' | 'enterprise';
|
|
250
313
|
/**
|
|
251
|
-
*
|
|
314
|
+
* Version of the kubernetes cluster.
|
|
252
315
|
*/
|
|
253
|
-
|
|
316
|
+
version_channel: string;
|
|
254
317
|
/**
|
|
255
|
-
*
|
|
318
|
+
* Release channel for the cluster's control plane.
|
|
256
319
|
*/
|
|
257
|
-
|
|
320
|
+
release_channel: 'rapid' | 'stable' | 'extended';
|
|
321
|
+
/**
|
|
322
|
+
* Cluster feature toggles.
|
|
323
|
+
*/
|
|
324
|
+
features: {
|
|
325
|
+
/**
|
|
326
|
+
* GPU sharing strategy.
|
|
327
|
+
*/
|
|
328
|
+
gpu_sharing_strategy: 'none' | 'mps' | 'time_slicing';
|
|
329
|
+
/**
|
|
330
|
+
* Maximum number of pods that may share a single GPU.
|
|
331
|
+
*/
|
|
332
|
+
gpu_max_shared_clients_per_gpu: number;
|
|
333
|
+
/**
|
|
334
|
+
* Restrict Cilium socket load-balancing to the host namespace. Required for the Tailscale operator and Istio.
|
|
335
|
+
*/
|
|
336
|
+
cilium_socket_lb_host_namespace_only: boolean;
|
|
337
|
+
};
|
|
338
|
+
/**
|
|
339
|
+
* Cloudfleet control plane region. This field can not be updated after creation.
|
|
340
|
+
*/
|
|
341
|
+
region: string;
|
|
342
|
+
/**
|
|
343
|
+
* Cluster networking configuration. Immutable after creation.
|
|
344
|
+
*/
|
|
345
|
+
networking: {
|
|
346
|
+
/**
|
|
347
|
+
* CIDR block for pod IPs.
|
|
348
|
+
*/
|
|
349
|
+
pod_cidr: string;
|
|
350
|
+
/**
|
|
351
|
+
* CIDR block for service IPs.
|
|
352
|
+
*/
|
|
353
|
+
service_cidr: string;
|
|
354
|
+
/**
|
|
355
|
+
* Enable IPv4+IPv6 dual-stack networking.
|
|
356
|
+
*/
|
|
357
|
+
dual_stack: boolean;
|
|
358
|
+
/**
|
|
359
|
+
* IPv6 pod CIDR. Requires dual_stack.
|
|
360
|
+
*/
|
|
361
|
+
pod_cidr_v6: string;
|
|
362
|
+
/**
|
|
363
|
+
* IPv6 service CIDR. Requires dual_stack.
|
|
364
|
+
*/
|
|
365
|
+
service_cidr_v6: string;
|
|
366
|
+
};
|
|
258
367
|
/**
|
|
259
368
|
* Unique identifier of the kubernetes cluster. UUID v4 string in canonical form
|
|
260
369
|
*/
|
|
261
370
|
id: string;
|
|
262
371
|
/**
|
|
263
|
-
* Status of the cluster.
|
|
372
|
+
* Status of the cluster.
|
|
264
373
|
*/
|
|
265
|
-
status: '
|
|
374
|
+
status: 'creating' | 'deployed' | 'updating' | 'disabled';
|
|
266
375
|
endpoint?: string | '';
|
|
376
|
+
endpoint_public?: string | '';
|
|
267
377
|
/**
|
|
268
378
|
* Certificate authority data for the kubernetes cluster. This is the root certificate authority for the cluster.
|
|
269
379
|
*/
|
|
@@ -283,125 +393,310 @@ export type Cluster = {
|
|
|
283
393
|
/**
|
|
284
394
|
* Indicates if the cluster is ready to be used.
|
|
285
395
|
*/
|
|
286
|
-
ready
|
|
396
|
+
ready: boolean;
|
|
287
397
|
};
|
|
398
|
+
/**
|
|
399
|
+
* Mutable cluster configuration. Applied as a full overwrite: any omitted field is reset to its default rather than left unchanged.
|
|
400
|
+
*/
|
|
288
401
|
export type ClusterUpdateInput = {
|
|
289
402
|
/**
|
|
290
403
|
* Name of the cluster.
|
|
291
404
|
*/
|
|
292
|
-
name
|
|
405
|
+
name: string;
|
|
293
406
|
/**
|
|
294
407
|
* Tier of the cluster.
|
|
295
408
|
*/
|
|
296
|
-
tier
|
|
409
|
+
tier?: 'basic' | 'pro' | 'enterprise';
|
|
297
410
|
/**
|
|
298
411
|
* Version of the kubernetes cluster.
|
|
299
412
|
*/
|
|
300
413
|
version_channel?: string;
|
|
414
|
+
/**
|
|
415
|
+
* Release channel for the cluster's control plane.
|
|
416
|
+
*/
|
|
417
|
+
release_channel?: 'rapid' | 'stable' | 'extended';
|
|
418
|
+
/**
|
|
419
|
+
* Cluster feature toggles.
|
|
420
|
+
*/
|
|
421
|
+
features?: {
|
|
422
|
+
/**
|
|
423
|
+
* GPU sharing strategy.
|
|
424
|
+
*/
|
|
425
|
+
gpu_sharing_strategy?: 'none' | 'mps' | 'time_slicing';
|
|
426
|
+
/**
|
|
427
|
+
* Maximum number of pods that may share a single GPU.
|
|
428
|
+
*/
|
|
429
|
+
gpu_max_shared_clients_per_gpu?: number;
|
|
430
|
+
/**
|
|
431
|
+
* Restrict Cilium socket load-balancing to the host namespace. Required for the Tailscale operator and Istio.
|
|
432
|
+
*/
|
|
433
|
+
cilium_socket_lb_host_namespace_only?: boolean;
|
|
434
|
+
};
|
|
301
435
|
};
|
|
436
|
+
/**
|
|
437
|
+
* Mutable fleet configuration. Applied as a full overwrite: any omitted field is reset to its default rather than left unchanged.
|
|
438
|
+
*/
|
|
302
439
|
export type FleetCreateInput = {
|
|
303
440
|
/**
|
|
304
441
|
* Limits define a set of bounds for provisioning capacity.
|
|
305
442
|
*/
|
|
306
443
|
limits?: {
|
|
307
444
|
/**
|
|
308
|
-
* CPU limit in cores.
|
|
445
|
+
* CPU limit in cores. Maximum 100,000.
|
|
309
446
|
*/
|
|
310
|
-
cpu
|
|
447
|
+
cpu?: number;
|
|
311
448
|
};
|
|
312
449
|
gcp?: {
|
|
313
|
-
enabled
|
|
450
|
+
enabled: boolean;
|
|
314
451
|
/**
|
|
315
|
-
*
|
|
452
|
+
* GCP project ID to deploy instances into. 6-30 chars, lowercase letters/digits/hyphens, must start with a letter and not end with a hyphen. Omit when GCP is disabled.
|
|
316
453
|
*/
|
|
317
|
-
project
|
|
454
|
+
project?: string;
|
|
318
455
|
};
|
|
319
456
|
hetzner?: {
|
|
320
|
-
enabled
|
|
457
|
+
enabled: boolean;
|
|
321
458
|
/**
|
|
322
|
-
* Hetzner Cloud API
|
|
459
|
+
* Hetzner Cloud API token with read/write access (64 alphanumeric characters). Write-only: reads return a redacted placeholder, never the token. Omit the field, or send the placeholder back unchanged, to keep the existing key. Send a new value to rotate it.
|
|
323
460
|
*/
|
|
324
|
-
apiKey
|
|
461
|
+
apiKey?: string;
|
|
325
462
|
};
|
|
326
463
|
aws?: {
|
|
327
|
-
enabled
|
|
464
|
+
enabled: boolean;
|
|
465
|
+
/**
|
|
466
|
+
* AWS IAM role ARN that Karpenter uses to manage resources. Omit when AWS is disabled.
|
|
467
|
+
*/
|
|
468
|
+
controllerRoleArn?: string;
|
|
469
|
+
};
|
|
470
|
+
/**
|
|
471
|
+
* Constraints define scheduling and provisioning requirements for the fleet. Each field restricts the values allowed for a given Kubernetes label key. Multiple constraints are ANDed together.
|
|
472
|
+
*/
|
|
473
|
+
constraints?: {
|
|
474
|
+
/**
|
|
475
|
+
* Allowed values for `karpenter.sh/capacity-type`.
|
|
476
|
+
*/
|
|
477
|
+
'karpenter.sh/capacity-type'?: Array<'on-demand' | 'spot'>;
|
|
478
|
+
/**
|
|
479
|
+
* Allowed values for `kubernetes.io/arch`.
|
|
480
|
+
*/
|
|
481
|
+
'kubernetes.io/arch'?: Array<'amd64' | 'arm64'>;
|
|
328
482
|
/**
|
|
329
|
-
*
|
|
483
|
+
* Allowed values for `cfke.io/instance-family`.
|
|
330
484
|
*/
|
|
331
|
-
|
|
485
|
+
'cfke.io/instance-family'?: Array<'a1' | 'a2' | 'a3' | 'a4' | 'c1' | 'c2' | 'c2d' | 'c3' | 'c3d' | 'c4' | 'c4a' | 'c4d' | 'c5' | 'c5a' | 'c5ad' | 'c5d' | 'c5n' | 'c6a' | 'c6g' | 'c6gd' | 'c6gn' | 'c6i' | 'c6id' | 'c6in' | 'c7a' | 'c7g' | 'c7gd' | 'c7gn' | 'c7i' | 'c7i-flex' | 'c8g' | 'c8gd' | 'cax' | 'ccx' | 'cpx' | 'cx' | 'd2' | 'd3' | 'd3en' | 'dl1' | 'dl2q' | 'e2' | 'f1' | 'f2' | 'g1' | 'g2' | 'g4ad' | 'g4dn' | 'g5' | 'g5g' | 'g6' | 'g6e' | 'gr6' | 'h1' | 'h3' | 'hpc6a' | 'hpc6id' | 'hpc7a' | 'hpc7g' | 'i2' | 'i3' | 'i3en' | 'i4g' | 'i4i' | 'i7i' | 'i7ie' | 'i8g' | 'im4gn' | 'inf1' | 'inf2' | 'is4gen' | 'm1' | 'm2' | 'm3' | 'm4' | 'm5' | 'm5a' | 'm5ad' | 'm5d' | 'm5dn' | 'm5n' | 'm5zn' | 'm6a' | 'm6g' | 'm6gd' | 'm6i' | 'm6id' | 'm6idn' | 'm6in' | 'm7a' | 'm7g' | 'm7gd' | 'm7i' | 'm7i-flex' | 'm8g' | 'm8gd' | 'n1' | 'n2' | 'n2d' | 'n4' | 'p3' | 'p3dn' | 'p4d' | 'p4de' | 'p5' | 'p5e' | 'p5en' | 'p6-b200' | 'r3' | 'r4' | 'r5' | 'r5a' | 'r5ad' | 'r5b' | 'r5d' | 'r5dn' | 'r5n' | 'r6a' | 'r6g' | 'r6gd' | 'r6i' | 'r6id' | 'r6idn' | 'r6in' | 'r7a' | 'r7g' | 'r7gd' | 'r7i' | 'r7iz' | 'r8g' | 'r8gd' | 't2' | 't2a' | 't2d' | 't3' | 't3a' | 't4g' | 'trn1' | 'trn1n' | 'u-3tb1' | 'u-6tb1' | 'u7i-12tb' | 'u7i-6tb' | 'u7i-8tb' | 'u7in-16tb' | 'u7in-24tb' | 'u7in-32tb' | 'vt1' | 'x1' | 'x1e' | 'x2gd' | 'x2idn' | 'x2iedn' | 'x2iezn' | 'x4' | 'x8g' | 'z1d' | 'z3'>;
|
|
486
|
+
/**
|
|
487
|
+
* Allowed values for `topology.kubernetes.io/region`.
|
|
488
|
+
*/
|
|
489
|
+
'topology.kubernetes.io/region'?: Array<'africa-south1' | 'ap-northeast-1' | 'ap-northeast-2' | 'ap-northeast-3' | 'ap-south-1' | 'ap-southeast-1' | 'ap-southeast-2' | 'ash' | 'asia-east1' | 'asia-east2' | 'asia-northeast1' | 'asia-northeast2' | 'asia-northeast3' | 'asia-south1' | 'asia-south2' | 'asia-southeast1' | 'asia-southeast2' | 'australia-southeast1' | 'australia-southeast2' | 'ca-central-1' | 'eu-central-1' | 'eu-central-2' | 'eu-north-1' | 'eu-west-1' | 'eu-west-2' | 'eu-west-3' | 'europe-central2' | 'europe-north1' | 'europe-southwest1' | 'europe-west1' | 'europe-west10' | 'europe-west12' | 'europe-west2' | 'europe-west3' | 'europe-west4' | 'europe-west6' | 'europe-west8' | 'europe-west9' | 'fsn1' | 'hel1' | 'hil' | 'me-central1' | 'me-central2' | 'me-west1' | 'nbg1' | 'northamerica-northeast1' | 'northamerica-northeast2' | 'sa-east-1' | 'sin' | 'southamerica-east1' | 'southamerica-west1' | 'us-central1' | 'us-east-1' | 'us-east-2' | 'us-east1' | 'us-east4' | 'us-east5' | 'us-south1' | 'us-west-1' | 'us-west-2' | 'us-west1' | 'us-west2' | 'us-west3' | 'us-west4'>;
|
|
332
490
|
};
|
|
491
|
+
/**
|
|
492
|
+
* Controls scale-up / scale-down responsiveness. `aggressive` prioritizes cost-optimization. `conservative` prioritizes stability of the fleet. Full-overwrite: omit to reset to the default (`conservative`).
|
|
493
|
+
*/
|
|
494
|
+
scalingProfile?: 'aggressive' | 'conservative';
|
|
495
|
+
/**
|
|
496
|
+
* Taints applied to every node the fleet provisions, so only pods that tolerate them schedule there. Each key and effect pair may appear once. Full-overwrite: omit to remove all taints.
|
|
497
|
+
*/
|
|
498
|
+
taints?: Array<{
|
|
499
|
+
/**
|
|
500
|
+
* Taint key: a Kubernetes qualified name with an optional DNS subdomain prefix. Keys under `node.kubernetes.io`, `node.cloudprovider.kubernetes.io`, `node.cilium.io`, `karpenter.sh` and `cfke.io` (and their subdomains) are reserved.
|
|
501
|
+
*/
|
|
502
|
+
key: string;
|
|
503
|
+
/**
|
|
504
|
+
* Taint value. Optional.
|
|
505
|
+
*/
|
|
506
|
+
value?: string;
|
|
507
|
+
/**
|
|
508
|
+
* Taint effect.
|
|
509
|
+
*/
|
|
510
|
+
effect: 'NoSchedule' | 'PreferNoSchedule' | 'NoExecute';
|
|
511
|
+
}>;
|
|
333
512
|
/**
|
|
334
513
|
* Unique identifier of the kubernetes fleet.
|
|
335
514
|
*/
|
|
336
515
|
id: string;
|
|
337
516
|
};
|
|
517
|
+
/**
|
|
518
|
+
* Mutable fleet configuration. Applied as a full overwrite: any omitted field is reset to its default rather than left unchanged.
|
|
519
|
+
*/
|
|
338
520
|
export type Fleet = {
|
|
339
521
|
/**
|
|
340
522
|
* Limits define a set of bounds for provisioning capacity.
|
|
341
523
|
*/
|
|
342
524
|
limits?: {
|
|
343
525
|
/**
|
|
344
|
-
* CPU limit in cores.
|
|
526
|
+
* CPU limit in cores. Maximum 100,000.
|
|
345
527
|
*/
|
|
346
|
-
cpu
|
|
528
|
+
cpu?: number;
|
|
347
529
|
};
|
|
348
530
|
gcp?: {
|
|
349
|
-
enabled
|
|
531
|
+
enabled: boolean;
|
|
350
532
|
/**
|
|
351
|
-
*
|
|
533
|
+
* GCP project ID to deploy instances into. 6-30 chars, lowercase letters/digits/hyphens, must start with a letter and not end with a hyphen. Omit when GCP is disabled.
|
|
352
534
|
*/
|
|
353
|
-
project
|
|
535
|
+
project?: string;
|
|
354
536
|
};
|
|
355
537
|
hetzner?: {
|
|
356
|
-
enabled
|
|
538
|
+
enabled: boolean;
|
|
357
539
|
/**
|
|
358
|
-
* Hetzner
|
|
540
|
+
* Redacted Hetzner API token. Returned as 64 asterisks when a token is configured; omitted otherwise. The real value is never echoed by the API.
|
|
359
541
|
*/
|
|
360
|
-
apiKey
|
|
542
|
+
apiKey?: string;
|
|
361
543
|
};
|
|
362
544
|
aws?: {
|
|
363
|
-
enabled
|
|
545
|
+
enabled: boolean;
|
|
546
|
+
/**
|
|
547
|
+
* AWS IAM role ARN that Karpenter uses to manage resources. Omit when AWS is disabled.
|
|
548
|
+
*/
|
|
549
|
+
controllerRoleArn?: string;
|
|
550
|
+
};
|
|
551
|
+
/**
|
|
552
|
+
* Constraints define scheduling and provisioning requirements for the fleet. Each field restricts the values allowed for a given Kubernetes label key. Multiple constraints are ANDed together.
|
|
553
|
+
*/
|
|
554
|
+
constraints: {
|
|
555
|
+
/**
|
|
556
|
+
* Allowed values for `karpenter.sh/capacity-type`.
|
|
557
|
+
*/
|
|
558
|
+
'karpenter.sh/capacity-type': Array<'on-demand' | 'spot'>;
|
|
559
|
+
/**
|
|
560
|
+
* Allowed values for `kubernetes.io/arch`.
|
|
561
|
+
*/
|
|
562
|
+
'kubernetes.io/arch': Array<'amd64' | 'arm64'>;
|
|
563
|
+
/**
|
|
564
|
+
* Allowed values for `cfke.io/instance-family`.
|
|
565
|
+
*/
|
|
566
|
+
'cfke.io/instance-family'?: Array<'a1' | 'a2' | 'a3' | 'a4' | 'c1' | 'c2' | 'c2d' | 'c3' | 'c3d' | 'c4' | 'c4a' | 'c4d' | 'c5' | 'c5a' | 'c5ad' | 'c5d' | 'c5n' | 'c6a' | 'c6g' | 'c6gd' | 'c6gn' | 'c6i' | 'c6id' | 'c6in' | 'c7a' | 'c7g' | 'c7gd' | 'c7gn' | 'c7i' | 'c7i-flex' | 'c8g' | 'c8gd' | 'cax' | 'ccx' | 'cpx' | 'cx' | 'd2' | 'd3' | 'd3en' | 'dl1' | 'dl2q' | 'e2' | 'f1' | 'f2' | 'g1' | 'g2' | 'g4ad' | 'g4dn' | 'g5' | 'g5g' | 'g6' | 'g6e' | 'gr6' | 'h1' | 'h3' | 'hpc6a' | 'hpc6id' | 'hpc7a' | 'hpc7g' | 'i2' | 'i3' | 'i3en' | 'i4g' | 'i4i' | 'i7i' | 'i7ie' | 'i8g' | 'im4gn' | 'inf1' | 'inf2' | 'is4gen' | 'm1' | 'm2' | 'm3' | 'm4' | 'm5' | 'm5a' | 'm5ad' | 'm5d' | 'm5dn' | 'm5n' | 'm5zn' | 'm6a' | 'm6g' | 'm6gd' | 'm6i' | 'm6id' | 'm6idn' | 'm6in' | 'm7a' | 'm7g' | 'm7gd' | 'm7i' | 'm7i-flex' | 'm8g' | 'm8gd' | 'n1' | 'n2' | 'n2d' | 'n4' | 'p3' | 'p3dn' | 'p4d' | 'p4de' | 'p5' | 'p5e' | 'p5en' | 'p6-b200' | 'r3' | 'r4' | 'r5' | 'r5a' | 'r5ad' | 'r5b' | 'r5d' | 'r5dn' | 'r5n' | 'r6a' | 'r6g' | 'r6gd' | 'r6i' | 'r6id' | 'r6idn' | 'r6in' | 'r7a' | 'r7g' | 'r7gd' | 'r7i' | 'r7iz' | 'r8g' | 'r8gd' | 't2' | 't2a' | 't2d' | 't3' | 't3a' | 't4g' | 'trn1' | 'trn1n' | 'u-3tb1' | 'u-6tb1' | 'u7i-12tb' | 'u7i-6tb' | 'u7i-8tb' | 'u7in-16tb' | 'u7in-24tb' | 'u7in-32tb' | 'vt1' | 'x1' | 'x1e' | 'x2gd' | 'x2idn' | 'x2iedn' | 'x2iezn' | 'x4' | 'x8g' | 'z1d' | 'z3'>;
|
|
364
567
|
/**
|
|
365
|
-
*
|
|
568
|
+
* Allowed values for `topology.kubernetes.io/region`.
|
|
366
569
|
*/
|
|
367
|
-
|
|
570
|
+
'topology.kubernetes.io/region'?: Array<'africa-south1' | 'ap-northeast-1' | 'ap-northeast-2' | 'ap-northeast-3' | 'ap-south-1' | 'ap-southeast-1' | 'ap-southeast-2' | 'ash' | 'asia-east1' | 'asia-east2' | 'asia-northeast1' | 'asia-northeast2' | 'asia-northeast3' | 'asia-south1' | 'asia-south2' | 'asia-southeast1' | 'asia-southeast2' | 'australia-southeast1' | 'australia-southeast2' | 'ca-central-1' | 'eu-central-1' | 'eu-central-2' | 'eu-north-1' | 'eu-west-1' | 'eu-west-2' | 'eu-west-3' | 'europe-central2' | 'europe-north1' | 'europe-southwest1' | 'europe-west1' | 'europe-west10' | 'europe-west12' | 'europe-west2' | 'europe-west3' | 'europe-west4' | 'europe-west6' | 'europe-west8' | 'europe-west9' | 'fsn1' | 'hel1' | 'hil' | 'me-central1' | 'me-central2' | 'me-west1' | 'nbg1' | 'northamerica-northeast1' | 'northamerica-northeast2' | 'sa-east-1' | 'sin' | 'southamerica-east1' | 'southamerica-west1' | 'us-central1' | 'us-east-1' | 'us-east-2' | 'us-east1' | 'us-east4' | 'us-east5' | 'us-south1' | 'us-west-1' | 'us-west-2' | 'us-west1' | 'us-west2' | 'us-west3' | 'us-west4'>;
|
|
368
571
|
};
|
|
572
|
+
/**
|
|
573
|
+
* Controls scale-up / scale-down responsiveness. `aggressive` prioritizes cost-optimization. `conservative` prioritizes stability of the fleet. Full-overwrite: omit to reset to the default (`conservative`).
|
|
574
|
+
*/
|
|
575
|
+
scalingProfile: 'aggressive' | 'conservative';
|
|
576
|
+
/**
|
|
577
|
+
* Taints applied to every node the fleet provisions, so only pods that tolerate them schedule there. Each key and effect pair may appear once. Full-overwrite: omit to remove all taints.
|
|
578
|
+
*/
|
|
579
|
+
taints: Array<{
|
|
580
|
+
/**
|
|
581
|
+
* Taint key: a Kubernetes qualified name with an optional DNS subdomain prefix. Keys under `node.kubernetes.io`, `node.cloudprovider.kubernetes.io`, `node.cilium.io`, `karpenter.sh` and `cfke.io` (and their subdomains) are reserved.
|
|
582
|
+
*/
|
|
583
|
+
key: string;
|
|
584
|
+
/**
|
|
585
|
+
* Taint value. Optional.
|
|
586
|
+
*/
|
|
587
|
+
value?: string;
|
|
588
|
+
/**
|
|
589
|
+
* Taint effect.
|
|
590
|
+
*/
|
|
591
|
+
effect: 'NoSchedule' | 'PreferNoSchedule' | 'NoExecute';
|
|
592
|
+
}>;
|
|
369
593
|
/**
|
|
370
594
|
* Unique identifier of the kubernetes fleet.
|
|
371
595
|
*/
|
|
372
596
|
id: string;
|
|
597
|
+
/**
|
|
598
|
+
* Indicates whether the fleet configuration is healthy.
|
|
599
|
+
*/
|
|
600
|
+
ready: boolean;
|
|
601
|
+
/**
|
|
602
|
+
* Human-readable reason the fleet is not ready. Present only when `ready` is false.
|
|
603
|
+
*/
|
|
604
|
+
status_message?: string;
|
|
605
|
+
/**
|
|
606
|
+
* Creation date and time of the fleet.
|
|
607
|
+
*/
|
|
608
|
+
created_at: string;
|
|
609
|
+
/**
|
|
610
|
+
* Date and time the fleet was last updated.
|
|
611
|
+
*/
|
|
612
|
+
updated_at: string;
|
|
373
613
|
};
|
|
614
|
+
/**
|
|
615
|
+
* Mutable fleet configuration. Applied as a full overwrite: any omitted field is reset to its default rather than left unchanged.
|
|
616
|
+
*/
|
|
374
617
|
export type FleetUpdateInput = {
|
|
375
618
|
/**
|
|
376
619
|
* Limits define a set of bounds for provisioning capacity.
|
|
377
620
|
*/
|
|
378
621
|
limits?: {
|
|
379
622
|
/**
|
|
380
|
-
* CPU limit in cores.
|
|
623
|
+
* CPU limit in cores. Maximum 100,000.
|
|
381
624
|
*/
|
|
382
|
-
cpu
|
|
625
|
+
cpu?: number;
|
|
383
626
|
};
|
|
384
627
|
gcp?: {
|
|
385
|
-
enabled
|
|
628
|
+
enabled: boolean;
|
|
386
629
|
/**
|
|
387
|
-
*
|
|
630
|
+
* GCP project ID to deploy instances into. 6-30 chars, lowercase letters/digits/hyphens, must start with a letter and not end with a hyphen. Omit when GCP is disabled.
|
|
388
631
|
*/
|
|
389
|
-
project
|
|
632
|
+
project?: string;
|
|
390
633
|
};
|
|
391
634
|
hetzner?: {
|
|
392
|
-
enabled
|
|
635
|
+
enabled: boolean;
|
|
393
636
|
/**
|
|
394
|
-
* Hetzner Cloud API
|
|
637
|
+
* Hetzner Cloud API token with read/write access (64 alphanumeric characters). Write-only: reads return a redacted placeholder, never the token. Omit the field, or send the placeholder back unchanged, to keep the existing key. Send a new value to rotate it.
|
|
395
638
|
*/
|
|
396
|
-
apiKey
|
|
639
|
+
apiKey?: string;
|
|
397
640
|
};
|
|
398
641
|
aws?: {
|
|
399
|
-
enabled
|
|
642
|
+
enabled: boolean;
|
|
643
|
+
/**
|
|
644
|
+
* AWS IAM role ARN that Karpenter uses to manage resources. Omit when AWS is disabled.
|
|
645
|
+
*/
|
|
646
|
+
controllerRoleArn?: string;
|
|
647
|
+
};
|
|
648
|
+
/**
|
|
649
|
+
* Constraints define scheduling and provisioning requirements for the fleet. Each field restricts the values allowed for a given Kubernetes label key. Multiple constraints are ANDed together.
|
|
650
|
+
*/
|
|
651
|
+
constraints?: {
|
|
652
|
+
/**
|
|
653
|
+
* Allowed values for `karpenter.sh/capacity-type`.
|
|
654
|
+
*/
|
|
655
|
+
'karpenter.sh/capacity-type'?: Array<'on-demand' | 'spot'>;
|
|
656
|
+
/**
|
|
657
|
+
* Allowed values for `kubernetes.io/arch`.
|
|
658
|
+
*/
|
|
659
|
+
'kubernetes.io/arch'?: Array<'amd64' | 'arm64'>;
|
|
660
|
+
/**
|
|
661
|
+
* Allowed values for `cfke.io/instance-family`.
|
|
662
|
+
*/
|
|
663
|
+
'cfke.io/instance-family'?: Array<'a1' | 'a2' | 'a3' | 'a4' | 'c1' | 'c2' | 'c2d' | 'c3' | 'c3d' | 'c4' | 'c4a' | 'c4d' | 'c5' | 'c5a' | 'c5ad' | 'c5d' | 'c5n' | 'c6a' | 'c6g' | 'c6gd' | 'c6gn' | 'c6i' | 'c6id' | 'c6in' | 'c7a' | 'c7g' | 'c7gd' | 'c7gn' | 'c7i' | 'c7i-flex' | 'c8g' | 'c8gd' | 'cax' | 'ccx' | 'cpx' | 'cx' | 'd2' | 'd3' | 'd3en' | 'dl1' | 'dl2q' | 'e2' | 'f1' | 'f2' | 'g1' | 'g2' | 'g4ad' | 'g4dn' | 'g5' | 'g5g' | 'g6' | 'g6e' | 'gr6' | 'h1' | 'h3' | 'hpc6a' | 'hpc6id' | 'hpc7a' | 'hpc7g' | 'i2' | 'i3' | 'i3en' | 'i4g' | 'i4i' | 'i7i' | 'i7ie' | 'i8g' | 'im4gn' | 'inf1' | 'inf2' | 'is4gen' | 'm1' | 'm2' | 'm3' | 'm4' | 'm5' | 'm5a' | 'm5ad' | 'm5d' | 'm5dn' | 'm5n' | 'm5zn' | 'm6a' | 'm6g' | 'm6gd' | 'm6i' | 'm6id' | 'm6idn' | 'm6in' | 'm7a' | 'm7g' | 'm7gd' | 'm7i' | 'm7i-flex' | 'm8g' | 'm8gd' | 'n1' | 'n2' | 'n2d' | 'n4' | 'p3' | 'p3dn' | 'p4d' | 'p4de' | 'p5' | 'p5e' | 'p5en' | 'p6-b200' | 'r3' | 'r4' | 'r5' | 'r5a' | 'r5ad' | 'r5b' | 'r5d' | 'r5dn' | 'r5n' | 'r6a' | 'r6g' | 'r6gd' | 'r6i' | 'r6id' | 'r6idn' | 'r6in' | 'r7a' | 'r7g' | 'r7gd' | 'r7i' | 'r7iz' | 'r8g' | 'r8gd' | 't2' | 't2a' | 't2d' | 't3' | 't3a' | 't4g' | 'trn1' | 'trn1n' | 'u-3tb1' | 'u-6tb1' | 'u7i-12tb' | 'u7i-6tb' | 'u7i-8tb' | 'u7in-16tb' | 'u7in-24tb' | 'u7in-32tb' | 'vt1' | 'x1' | 'x1e' | 'x2gd' | 'x2idn' | 'x2iedn' | 'x2iezn' | 'x4' | 'x8g' | 'z1d' | 'z3'>;
|
|
400
664
|
/**
|
|
401
|
-
*
|
|
665
|
+
* Allowed values for `topology.kubernetes.io/region`.
|
|
402
666
|
*/
|
|
403
|
-
|
|
667
|
+
'topology.kubernetes.io/region'?: Array<'africa-south1' | 'ap-northeast-1' | 'ap-northeast-2' | 'ap-northeast-3' | 'ap-south-1' | 'ap-southeast-1' | 'ap-southeast-2' | 'ash' | 'asia-east1' | 'asia-east2' | 'asia-northeast1' | 'asia-northeast2' | 'asia-northeast3' | 'asia-south1' | 'asia-south2' | 'asia-southeast1' | 'asia-southeast2' | 'australia-southeast1' | 'australia-southeast2' | 'ca-central-1' | 'eu-central-1' | 'eu-central-2' | 'eu-north-1' | 'eu-west-1' | 'eu-west-2' | 'eu-west-3' | 'europe-central2' | 'europe-north1' | 'europe-southwest1' | 'europe-west1' | 'europe-west10' | 'europe-west12' | 'europe-west2' | 'europe-west3' | 'europe-west4' | 'europe-west6' | 'europe-west8' | 'europe-west9' | 'fsn1' | 'hel1' | 'hil' | 'me-central1' | 'me-central2' | 'me-west1' | 'nbg1' | 'northamerica-northeast1' | 'northamerica-northeast2' | 'sa-east-1' | 'sin' | 'southamerica-east1' | 'southamerica-west1' | 'us-central1' | 'us-east-1' | 'us-east-2' | 'us-east1' | 'us-east4' | 'us-east5' | 'us-south1' | 'us-west-1' | 'us-west-2' | 'us-west1' | 'us-west2' | 'us-west3' | 'us-west4'>;
|
|
404
668
|
};
|
|
669
|
+
/**
|
|
670
|
+
* Controls scale-up / scale-down responsiveness. `aggressive` prioritizes cost-optimization. `conservative` prioritizes stability of the fleet. Full-overwrite: omit to reset to the default (`conservative`).
|
|
671
|
+
*/
|
|
672
|
+
scalingProfile?: 'aggressive' | 'conservative';
|
|
673
|
+
/**
|
|
674
|
+
* Taints applied to every node the fleet provisions, so only pods that tolerate them schedule there. Each key and effect pair may appear once. Full-overwrite: omit to remove all taints.
|
|
675
|
+
*/
|
|
676
|
+
taints?: Array<{
|
|
677
|
+
/**
|
|
678
|
+
* Taint key: a Kubernetes qualified name with an optional DNS subdomain prefix. Keys under `node.kubernetes.io`, `node.cloudprovider.kubernetes.io`, `node.cilium.io`, `karpenter.sh` and `cfke.io` (and their subdomains) are reserved.
|
|
679
|
+
*/
|
|
680
|
+
key: string;
|
|
681
|
+
/**
|
|
682
|
+
* Taint value. Optional.
|
|
683
|
+
*/
|
|
684
|
+
value?: string;
|
|
685
|
+
/**
|
|
686
|
+
* Taint effect.
|
|
687
|
+
*/
|
|
688
|
+
effect: 'NoSchedule' | 'PreferNoSchedule' | 'NoExecute';
|
|
689
|
+
}>;
|
|
690
|
+
};
|
|
691
|
+
export type InviteCreateInput = {
|
|
692
|
+
/**
|
|
693
|
+
* Email address of the user to invite.
|
|
694
|
+
*/
|
|
695
|
+
email: string;
|
|
696
|
+
/**
|
|
697
|
+
* Role the invited user will be assigned on redemption. Can be 'Administrator' or 'User'.
|
|
698
|
+
*/
|
|
699
|
+
role?: 'Administrator' | 'User';
|
|
405
700
|
};
|
|
406
701
|
export type Invite = {
|
|
407
702
|
/**
|
|
@@ -424,285 +719,215 @@ export type Invite = {
|
|
|
424
719
|
* Generated unique invite code.
|
|
425
720
|
*/
|
|
426
721
|
code?: string;
|
|
427
|
-
};
|
|
428
|
-
export type Invoice = {
|
|
429
|
-
/**
|
|
430
|
-
* Unique identifier of the invoice. UUID v4 string in canonical form
|
|
431
|
-
*/
|
|
432
|
-
id?: string;
|
|
433
722
|
/**
|
|
434
|
-
*
|
|
723
|
+
* Role the invited user will be assigned on redemption. Can be 'Administrator' or 'User'.
|
|
435
724
|
*/
|
|
436
|
-
|
|
725
|
+
role?: 'Administrator' | 'User';
|
|
726
|
+
};
|
|
727
|
+
export type InvoicePaymentAttempt = {
|
|
437
728
|
/**
|
|
438
|
-
*
|
|
729
|
+
* Identifier of the invoice.
|
|
439
730
|
*/
|
|
440
|
-
|
|
731
|
+
invoice_id: string;
|
|
441
732
|
/**
|
|
442
|
-
*
|
|
733
|
+
* Invoice number. Null if the invoice has no number.
|
|
443
734
|
*/
|
|
444
|
-
|
|
735
|
+
number: string;
|
|
445
736
|
/**
|
|
446
|
-
*
|
|
737
|
+
* Amount outstanding when the charge was attempted, in the smallest currency unit.
|
|
447
738
|
*/
|
|
448
|
-
|
|
739
|
+
amount: number;
|
|
449
740
|
/**
|
|
450
|
-
*
|
|
741
|
+
* Currency of the invoice.
|
|
451
742
|
*/
|
|
452
|
-
|
|
743
|
+
currency: string;
|
|
453
744
|
/**
|
|
454
|
-
*
|
|
745
|
+
* Outcome for this invoice: `paid`, `processing` (accepted, not yet settled), `requires_action` (awaiting customer authentication), or `failed` (declined).
|
|
455
746
|
*/
|
|
456
|
-
|
|
747
|
+
status: 'paid' | 'processing' | 'requires_action' | 'failed';
|
|
457
748
|
/**
|
|
458
|
-
*
|
|
749
|
+
* Client secret used to complete customer authentication. Set only when `status` is `requires_action`.
|
|
459
750
|
*/
|
|
460
|
-
|
|
751
|
+
client_secret: string;
|
|
461
752
|
/**
|
|
462
|
-
*
|
|
753
|
+
* Decline code. Set only when `status` is `failed`.
|
|
463
754
|
*/
|
|
464
|
-
|
|
755
|
+
failure_code: string;
|
|
465
756
|
/**
|
|
466
|
-
*
|
|
757
|
+
* Explanation of the decline, suitable for display. Set only when `status` is `failed`.
|
|
467
758
|
*/
|
|
468
|
-
|
|
759
|
+
failure_message: string;
|
|
760
|
+
};
|
|
761
|
+
export type InvoicePaymentResult = {
|
|
469
762
|
/**
|
|
470
|
-
*
|
|
763
|
+
* Overall outcome: `paid` (nothing outstanding), `processing` (all accepted, not yet settled), `action_required` (one or more await customer authentication), `partially_paid`, `failed`, `nothing_due`, or `bank_transfer_due` (the organization pays by bank transfer; nothing was charged).
|
|
471
764
|
*/
|
|
472
|
-
|
|
765
|
+
code: 'paid' | 'processing' | 'action_required' | 'partially_paid' | 'failed' | 'nothing_due' | 'bank_transfer_due';
|
|
473
766
|
/**
|
|
474
|
-
*
|
|
767
|
+
* Summary of the outcome, suitable for display.
|
|
475
768
|
*/
|
|
476
|
-
|
|
769
|
+
message: string;
|
|
477
770
|
/**
|
|
478
|
-
*
|
|
771
|
+
* One entry per invoice charged, oldest first.
|
|
479
772
|
*/
|
|
480
|
-
|
|
481
|
-
/**
|
|
482
|
-
* Unique identifier of the invoice item. UUID v4 string in canonical form
|
|
483
|
-
*/
|
|
484
|
-
id?: string;
|
|
773
|
+
results: Array<{
|
|
485
774
|
/**
|
|
486
|
-
*
|
|
775
|
+
* Identifier of the invoice.
|
|
487
776
|
*/
|
|
488
|
-
|
|
777
|
+
invoice_id: string;
|
|
489
778
|
/**
|
|
490
|
-
*
|
|
779
|
+
* Invoice number. Null if the invoice has no number.
|
|
491
780
|
*/
|
|
492
|
-
|
|
781
|
+
number: string;
|
|
493
782
|
/**
|
|
494
|
-
*
|
|
783
|
+
* Amount outstanding when the charge was attempted, in the smallest currency unit.
|
|
495
784
|
*/
|
|
496
|
-
|
|
785
|
+
amount: number;
|
|
497
786
|
/**
|
|
498
|
-
*
|
|
787
|
+
* Currency of the invoice.
|
|
499
788
|
*/
|
|
500
|
-
|
|
789
|
+
currency: string;
|
|
501
790
|
/**
|
|
502
|
-
*
|
|
791
|
+
* Outcome for this invoice: `paid`, `processing` (accepted, not yet settled), `requires_action` (awaiting customer authentication), or `failed` (declined).
|
|
503
792
|
*/
|
|
504
|
-
|
|
793
|
+
status: 'paid' | 'processing' | 'requires_action' | 'failed';
|
|
505
794
|
/**
|
|
506
|
-
*
|
|
795
|
+
* Client secret used to complete customer authentication. Set only when `status` is `requires_action`.
|
|
507
796
|
*/
|
|
508
|
-
|
|
797
|
+
client_secret: string;
|
|
509
798
|
/**
|
|
510
|
-
*
|
|
799
|
+
* Decline code. Set only when `status` is `failed`.
|
|
511
800
|
*/
|
|
512
|
-
|
|
801
|
+
failure_code: string;
|
|
513
802
|
/**
|
|
514
|
-
*
|
|
803
|
+
* Explanation of the decline, suitable for display. Set only when `status` is `failed`.
|
|
515
804
|
*/
|
|
516
|
-
|
|
805
|
+
failure_message: string;
|
|
806
|
+
}>;
|
|
807
|
+
};
|
|
808
|
+
export type Invoice = {
|
|
809
|
+
/**
|
|
810
|
+
* Unique identifier of the invoice.
|
|
811
|
+
*/
|
|
812
|
+
id?: string;
|
|
813
|
+
number?: string;
|
|
814
|
+
/**
|
|
815
|
+
* Status of the invoice
|
|
816
|
+
*/
|
|
817
|
+
status?: string;
|
|
818
|
+
/**
|
|
819
|
+
* Total amount of the invoice
|
|
820
|
+
*/
|
|
821
|
+
total?: number;
|
|
822
|
+
/**
|
|
823
|
+
* Currency of the invoice
|
|
824
|
+
*/
|
|
825
|
+
currency?: string;
|
|
826
|
+
/**
|
|
827
|
+
* Timestamp when the invoice was issued. ISO 8601 date string in the UTC timezone.
|
|
828
|
+
*/
|
|
829
|
+
created: string;
|
|
830
|
+
/**
|
|
831
|
+
* Billing period start timestamp. ISO 8601 date string in the UTC timezone.
|
|
832
|
+
*/
|
|
833
|
+
period_start: string;
|
|
834
|
+
/**
|
|
835
|
+
* Billing period end timestamp. ISO 8601 date string in the UTC timezone.
|
|
836
|
+
*/
|
|
837
|
+
period_end: string;
|
|
838
|
+
invoice_pdf?: string;
|
|
839
|
+
};
|
|
840
|
+
export type MarketplaceListingFiles = {
|
|
841
|
+
/**
|
|
842
|
+
* Raw Chart.yaml content from the Helm chart
|
|
843
|
+
*/
|
|
844
|
+
chartYaml?: string;
|
|
845
|
+
/**
|
|
846
|
+
* Raw values.yaml content from the Helm chart
|
|
847
|
+
*/
|
|
848
|
+
valuesYaml?: string;
|
|
849
|
+
/**
|
|
850
|
+
* JSON schema for values.yaml as a string
|
|
851
|
+
*/
|
|
852
|
+
valuesSchemaJson?: string;
|
|
853
|
+
};
|
|
854
|
+
export type MarketplaceListing = {
|
|
855
|
+
/**
|
|
856
|
+
* Name of the chart
|
|
857
|
+
*/
|
|
858
|
+
name: string;
|
|
859
|
+
/**
|
|
860
|
+
* Available versions of the chart
|
|
861
|
+
*/
|
|
862
|
+
versions: Array<string>;
|
|
863
|
+
/**
|
|
864
|
+
* Version channels for the chart
|
|
865
|
+
*/
|
|
866
|
+
version_channels: Array<string>;
|
|
867
|
+
/**
|
|
868
|
+
* Latest version of the chart
|
|
869
|
+
*/
|
|
870
|
+
latestVersion: string;
|
|
871
|
+
/**
|
|
872
|
+
* Chart metadata
|
|
873
|
+
*/
|
|
874
|
+
metadata?: {
|
|
517
875
|
/**
|
|
518
|
-
*
|
|
876
|
+
* Chart name from metadata
|
|
519
877
|
*/
|
|
520
|
-
|
|
878
|
+
name: string;
|
|
521
879
|
/**
|
|
522
|
-
*
|
|
880
|
+
* Chart version from metadata
|
|
523
881
|
*/
|
|
524
|
-
|
|
882
|
+
version: string;
|
|
525
883
|
/**
|
|
526
|
-
*
|
|
884
|
+
* Chart description
|
|
527
885
|
*/
|
|
528
886
|
description?: string;
|
|
529
887
|
/**
|
|
530
|
-
*
|
|
531
|
-
*/
|
|
532
|
-
startDate?: string;
|
|
533
|
-
/**
|
|
534
|
-
* End date of the invoice item
|
|
535
|
-
*/
|
|
536
|
-
endDate?: string;
|
|
537
|
-
/**
|
|
538
|
-
* Amount of the invoice item
|
|
539
|
-
*/
|
|
540
|
-
amount?: number;
|
|
541
|
-
/**
|
|
542
|
-
* Rate of the invoice item
|
|
888
|
+
* Application version
|
|
543
889
|
*/
|
|
544
|
-
|
|
890
|
+
appVersion?: string;
|
|
545
891
|
/**
|
|
546
|
-
*
|
|
892
|
+
* Helm API version
|
|
547
893
|
*/
|
|
548
|
-
|
|
894
|
+
apiVersion?: string;
|
|
549
895
|
/**
|
|
550
|
-
*
|
|
896
|
+
* Chart keywords
|
|
551
897
|
*/
|
|
552
|
-
|
|
898
|
+
keywords?: Array<string>;
|
|
553
899
|
/**
|
|
554
|
-
*
|
|
900
|
+
* Chart home URL
|
|
555
901
|
*/
|
|
556
|
-
|
|
902
|
+
home?: string;
|
|
557
903
|
/**
|
|
558
|
-
*
|
|
904
|
+
* A URL to an SVG or PNG image to be used as an icon
|
|
559
905
|
*/
|
|
560
|
-
|
|
906
|
+
icon?: string;
|
|
561
907
|
/**
|
|
562
|
-
*
|
|
908
|
+
* Chart source URLs
|
|
563
909
|
*/
|
|
564
|
-
|
|
565
|
-
[key: string]: unknown;
|
|
566
|
-
} | string>;
|
|
567
|
-
}>;
|
|
568
|
-
/**
|
|
569
|
-
* Items of the invoice
|
|
570
|
-
*/
|
|
571
|
-
items?: Array<{
|
|
910
|
+
sources?: Array<string>;
|
|
572
911
|
/**
|
|
573
|
-
*
|
|
912
|
+
* Chart maintainers
|
|
574
913
|
*/
|
|
575
|
-
|
|
576
|
-
|
|
577
|
-
|
|
578
|
-
|
|
579
|
-
|
|
580
|
-
|
|
581
|
-
|
|
582
|
-
|
|
583
|
-
|
|
584
|
-
|
|
585
|
-
|
|
586
|
-
*/
|
|
587
|
-
planName?: string;
|
|
588
|
-
/**
|
|
589
|
-
* Name of the phase
|
|
590
|
-
*/
|
|
591
|
-
phaseName?: string;
|
|
592
|
-
/**
|
|
593
|
-
* Name of the usage
|
|
594
|
-
*/
|
|
595
|
-
usageName?: string;
|
|
596
|
-
/**
|
|
597
|
-
* Pretty name of the product
|
|
598
|
-
*/
|
|
599
|
-
prettyProductName?: string;
|
|
600
|
-
/**
|
|
601
|
-
* Pretty name of the plan
|
|
602
|
-
*/
|
|
603
|
-
prettyPlanName?: string;
|
|
604
|
-
/**
|
|
605
|
-
* Pretty name of the phase
|
|
606
|
-
*/
|
|
607
|
-
prettyPhaseName?: string;
|
|
608
|
-
/**
|
|
609
|
-
* Pretty name of the usage
|
|
610
|
-
*/
|
|
611
|
-
prettyUsageName?: string;
|
|
612
|
-
/**
|
|
613
|
-
* Type of the invoice item
|
|
614
|
-
*/
|
|
615
|
-
itemType?: 'EXTERNAL_CHARGE' | 'FIXED' | 'RECURRING' | 'REPAIR_ADJ' | 'CBA_ADJ' | 'CREDIT_ADJ' | 'ITEM_ADJ' | 'USAGE' | 'TAX' | 'PARENT_SUMMARY';
|
|
616
|
-
/**
|
|
617
|
-
* Description of the invoice item
|
|
618
|
-
*/
|
|
619
|
-
description?: string;
|
|
620
|
-
/**
|
|
621
|
-
* Start date of the invoice item
|
|
622
|
-
*/
|
|
623
|
-
startDate?: string;
|
|
624
|
-
/**
|
|
625
|
-
* End date of the invoice item
|
|
626
|
-
*/
|
|
627
|
-
endDate?: string;
|
|
628
|
-
/**
|
|
629
|
-
* Amount of the invoice item
|
|
630
|
-
*/
|
|
631
|
-
amount?: number;
|
|
632
|
-
/**
|
|
633
|
-
* Rate of the invoice item
|
|
634
|
-
*/
|
|
635
|
-
rate?: number;
|
|
636
|
-
/**
|
|
637
|
-
* Currency of the invoice item
|
|
638
|
-
*/
|
|
639
|
-
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';
|
|
640
|
-
/**
|
|
641
|
-
* Quantity of the invoice item
|
|
642
|
-
*/
|
|
643
|
-
quantity?: number;
|
|
644
|
-
/**
|
|
645
|
-
* Details of the invoice item
|
|
646
|
-
*/
|
|
647
|
-
itemDetails?: string;
|
|
648
|
-
/**
|
|
649
|
-
* Effective date of the catalog
|
|
650
|
-
*/
|
|
651
|
-
catalogEffectiveDate?: string;
|
|
652
|
-
/**
|
|
653
|
-
* Child items of the invoice item
|
|
654
|
-
*/
|
|
655
|
-
childItems?: Array<Array<unknown> | boolean | number | {
|
|
656
|
-
[key: string]: unknown;
|
|
657
|
-
} | string>;
|
|
658
|
-
}>;
|
|
914
|
+
maintainers?: Array<{
|
|
915
|
+
/**
|
|
916
|
+
* Maintainer name
|
|
917
|
+
*/
|
|
918
|
+
name: string;
|
|
919
|
+
/**
|
|
920
|
+
* Maintainer email
|
|
921
|
+
*/
|
|
922
|
+
email?: string;
|
|
923
|
+
}>;
|
|
924
|
+
};
|
|
659
925
|
};
|
|
660
|
-
export type
|
|
661
|
-
/**
|
|
662
|
-
* Id of the chart listing
|
|
663
|
-
*/
|
|
664
|
-
id: string;
|
|
665
|
-
/**
|
|
666
|
-
* Name of the chart listing
|
|
667
|
-
*/
|
|
668
|
-
name: string;
|
|
669
|
-
/**
|
|
670
|
-
* Author of the chart listing
|
|
671
|
-
*/
|
|
672
|
-
developer: string;
|
|
673
|
-
/**
|
|
674
|
-
* Short description of the chart listing
|
|
675
|
-
*/
|
|
676
|
-
description: string;
|
|
677
|
-
/**
|
|
678
|
-
* Logo of the chart listing
|
|
679
|
-
*/
|
|
680
|
-
logoUrl: string;
|
|
681
|
-
/**
|
|
682
|
-
* Long description of the chart listing
|
|
683
|
-
*/
|
|
684
|
-
longDescription: string;
|
|
926
|
+
export type OrganizationCreateInput = {
|
|
685
927
|
/**
|
|
686
|
-
*
|
|
928
|
+
* Type of the organization. `business` for legal entities, `personal` for individuals.
|
|
687
929
|
*/
|
|
688
|
-
|
|
689
|
-
version_channels: Array<string>;
|
|
690
|
-
value_schemas: Array<{
|
|
691
|
-
/**
|
|
692
|
-
* Version of the chart.
|
|
693
|
-
*/
|
|
694
|
-
version: string;
|
|
695
|
-
/**
|
|
696
|
-
* Schema of the chart values. JSON Schema as string
|
|
697
|
-
*/
|
|
698
|
-
schema: string;
|
|
699
|
-
/**
|
|
700
|
-
* Schema of the chart values
|
|
701
|
-
*/
|
|
702
|
-
placeholder: string;
|
|
703
|
-
}>;
|
|
704
|
-
};
|
|
705
|
-
export type OrganizationCreateInput = {
|
|
930
|
+
type: 'business' | 'personal';
|
|
706
931
|
/**
|
|
707
932
|
* Email address used for billing as a string.
|
|
708
933
|
*/
|
|
@@ -724,6 +949,12 @@ export type OrganizationCreateInput = {
|
|
|
724
949
|
*/
|
|
725
950
|
password: string;
|
|
726
951
|
};
|
|
952
|
+
export type OrganizationCreateOutput = {
|
|
953
|
+
/**
|
|
954
|
+
* Unique identifier of the newly created organization. Generated by the API and safe to use for client-side tracking immediately.
|
|
955
|
+
*/
|
|
956
|
+
id: string;
|
|
957
|
+
};
|
|
727
958
|
export type Organization = {
|
|
728
959
|
/**
|
|
729
960
|
* Unique identifier of the organization. UUID v4 string in canonical form
|
|
@@ -733,6 +964,10 @@ export type Organization = {
|
|
|
733
964
|
* Name of the legal entity. This name will be used in invoices. Use your first and last name for individual accounts.
|
|
734
965
|
*/
|
|
735
966
|
name?: string;
|
|
967
|
+
/**
|
|
968
|
+
* Type of the organization. `business` for legal entities, `personal` for individuals.
|
|
969
|
+
*/
|
|
970
|
+
type: 'business' | 'personal';
|
|
736
971
|
/**
|
|
737
972
|
* Creation date of the organization. ISO 8601 date string in UTC timezone
|
|
738
973
|
*/
|
|
@@ -757,6 +992,14 @@ export type Organization = {
|
|
|
757
992
|
* Available number of Pro clusters that can be created.
|
|
758
993
|
*/
|
|
759
994
|
pro_clusters_available: number;
|
|
995
|
+
/**
|
|
996
|
+
* Maximum number of Enterprise clusters that can be created.
|
|
997
|
+
*/
|
|
998
|
+
enterprise_clusters_max: number;
|
|
999
|
+
/**
|
|
1000
|
+
* Available number of Enterprise clusters that can be created.
|
|
1001
|
+
*/
|
|
1002
|
+
enterprise_clusters_available: number;
|
|
760
1003
|
/**
|
|
761
1004
|
* Maximum number of fleets that can be created per cluster.
|
|
762
1005
|
*/
|
|
@@ -782,490 +1025,1342 @@ export type Organization = {
|
|
|
782
1025
|
*/
|
|
783
1026
|
label: string;
|
|
784
1027
|
}>;
|
|
1028
|
+
/**
|
|
1029
|
+
* Organization-level maximum CFCR storage volume in GB. -1 means no limit.
|
|
1030
|
+
*/
|
|
1031
|
+
cfcr_storage_gb: number;
|
|
785
1032
|
};
|
|
786
1033
|
/**
|
|
787
1034
|
* Status of the organization. Can be `active` or `closed`, or `suspended`.
|
|
788
1035
|
*/
|
|
789
1036
|
status: 'active' | 'closed' | 'suspended';
|
|
1037
|
+
/**
|
|
1038
|
+
* Verification status of the organization, which determines the assigned quota. `none` when billing information is incomplete, `submitted` when billing information is complete but the organization is not yet verified, `verified` when the organization is verified.
|
|
1039
|
+
*/
|
|
1040
|
+
verification: 'none' | 'submitted' | 'verified';
|
|
790
1041
|
};
|
|
791
1042
|
export type PaymentMethod = {
|
|
792
1043
|
/**
|
|
793
|
-
*
|
|
1044
|
+
* Payment method identifier. Stripe payment method id for cards/SEPA; the constant `bank_transfer` for the invoice/bank-transfer method. Used to set as default or delete the payment method.
|
|
794
1045
|
*/
|
|
795
1046
|
id: string;
|
|
796
1047
|
/**
|
|
797
|
-
*
|
|
798
|
-
*/
|
|
799
|
-
setup: boolean;
|
|
800
|
-
/**
|
|
801
|
-
* Payment method type type. Only `card` payments supported at the moment.
|
|
1048
|
+
* Payment method type. `card`, `sepa_debit` for SEPA Direct Debit (business accounts only), or `bank_transfer` for paying invoices by bank transfer.
|
|
802
1049
|
*/
|
|
803
|
-
type: 'card';
|
|
1050
|
+
type: 'card' | 'sepa_debit' | 'bank_transfer';
|
|
804
1051
|
/**
|
|
805
|
-
* Last 4 digits of the payment card number.
|
|
1052
|
+
* Last 4 digits of the payment card number, of the bank account (IBAN) for SEPA Direct Debit, or of the destination IBAN for bank transfer.
|
|
806
1053
|
*/
|
|
807
1054
|
last4: string;
|
|
808
1055
|
/**
|
|
809
|
-
* Two-digit number representing the card's expiration month.
|
|
1056
|
+
* Two-digit number representing the card's expiration month. Null for SEPA Direct Debit and bank transfer.
|
|
810
1057
|
*/
|
|
811
1058
|
exp_month: number;
|
|
812
1059
|
/**
|
|
813
|
-
* Four-digit number representing the card's expiration year.
|
|
1060
|
+
* Four-digit number representing the card's expiration year. May be in the past for an expired card still on file. Null for SEPA Direct Debit and bank transfer.
|
|
814
1061
|
*/
|
|
815
1062
|
exp_year: number;
|
|
816
1063
|
/**
|
|
817
|
-
* Payment card brand
|
|
1064
|
+
* Payment card brand as reported by Stripe, e.g. `visa`, `mastercard`, `amex`, `cartes_bancaires`, or `unknown`. Null for SEPA Direct Debit and bank transfer.
|
|
818
1065
|
*/
|
|
819
|
-
brand:
|
|
820
|
-
};
|
|
821
|
-
export type TokenCreateInput = {
|
|
1066
|
+
brand: string;
|
|
822
1067
|
/**
|
|
823
|
-
*
|
|
1068
|
+
* Full destination IBAN to send bank transfers to. Set only for `bank_transfer`; null otherwise. This is Cloudfleet's virtual receiving account, shown in full so the customer can pay into it.
|
|
824
1069
|
*/
|
|
825
|
-
|
|
1070
|
+
iban: string;
|
|
826
1071
|
/**
|
|
827
|
-
*
|
|
1072
|
+
* BIC/SWIFT of the destination bank for bank transfers. Set only for `bank_transfer`; null otherwise.
|
|
828
1073
|
*/
|
|
829
|
-
|
|
830
|
-
};
|
|
831
|
-
export type Token = {
|
|
1074
|
+
bic: string;
|
|
832
1075
|
/**
|
|
833
|
-
*
|
|
1076
|
+
* Account holder name of the destination bank account for bank transfers. Set only for `bank_transfer`; null otherwise.
|
|
834
1077
|
*/
|
|
835
|
-
|
|
1078
|
+
account_holder_name: string;
|
|
836
1079
|
/**
|
|
837
|
-
*
|
|
1080
|
+
* Whether this payment method is the default used for invoices and active subscriptions. Always false for `bank_transfer` (it cannot be a Stripe default payment method).
|
|
838
1081
|
*/
|
|
839
|
-
|
|
1082
|
+
is_default: boolean;
|
|
1083
|
+
};
|
|
1084
|
+
export type PlatformQuota = {
|
|
840
1085
|
/**
|
|
841
|
-
*
|
|
1086
|
+
* Maximum number of Basic clusters that can be created.
|
|
842
1087
|
*/
|
|
843
|
-
|
|
1088
|
+
basic_clusters_max: number;
|
|
844
1089
|
/**
|
|
845
|
-
*
|
|
1090
|
+
* Available number of Basic clusters that can be created.
|
|
846
1091
|
*/
|
|
847
|
-
|
|
1092
|
+
basic_clusters_available: number;
|
|
848
1093
|
/**
|
|
849
|
-
*
|
|
1094
|
+
* Maximum number of Pro clusters that can be created.
|
|
850
1095
|
*/
|
|
851
|
-
|
|
852
|
-
};
|
|
853
|
-
export type TokenUpdateInput = {
|
|
1096
|
+
pro_clusters_max: number;
|
|
854
1097
|
/**
|
|
855
|
-
*
|
|
1098
|
+
* Available number of Pro clusters that can be created.
|
|
856
1099
|
*/
|
|
857
|
-
|
|
1100
|
+
pro_clusters_available: number;
|
|
858
1101
|
/**
|
|
859
|
-
*
|
|
1102
|
+
* Maximum number of Enterprise clusters that can be created.
|
|
860
1103
|
*/
|
|
861
|
-
|
|
862
|
-
};
|
|
863
|
-
export type Usage = {
|
|
1104
|
+
enterprise_clusters_max: number;
|
|
864
1105
|
/**
|
|
865
|
-
*
|
|
1106
|
+
* Available number of Enterprise clusters that can be created.
|
|
866
1107
|
*/
|
|
867
|
-
|
|
1108
|
+
enterprise_clusters_available: number;
|
|
868
1109
|
/**
|
|
869
|
-
*
|
|
1110
|
+
* Maximum number of fleets that can be created per cluster.
|
|
870
1111
|
*/
|
|
871
|
-
|
|
1112
|
+
fleets_max: number;
|
|
872
1113
|
/**
|
|
873
|
-
*
|
|
1114
|
+
* List of Cloudfleet cluster tiers available for the organization.
|
|
874
1115
|
*/
|
|
875
|
-
|
|
1116
|
+
cluster_tiers: Array<string>;
|
|
876
1117
|
/**
|
|
877
|
-
*
|
|
1118
|
+
* List of Cloudfleet control plane regions available for the organization.
|
|
878
1119
|
*/
|
|
879
|
-
|
|
1120
|
+
regions: Array<string>;
|
|
880
1121
|
/**
|
|
881
|
-
*
|
|
1122
|
+
* List of CFKE control plane versions available for the organization.
|
|
882
1123
|
*/
|
|
883
|
-
|
|
1124
|
+
versions: Array<{
|
|
1125
|
+
/**
|
|
1126
|
+
* Id of the control plane version. Used in API calls.
|
|
1127
|
+
*/
|
|
1128
|
+
id: string;
|
|
1129
|
+
/**
|
|
1130
|
+
* Label of the control plane version. Used in frontent UI.
|
|
1131
|
+
*/
|
|
1132
|
+
label: string;
|
|
1133
|
+
}>;
|
|
884
1134
|
/**
|
|
885
|
-
*
|
|
1135
|
+
* Organization-level maximum CFCR storage volume in GB. -1 means no limit.
|
|
886
1136
|
*/
|
|
887
|
-
|
|
888
|
-
cpu: number | '';
|
|
889
|
-
price: number | '';
|
|
890
|
-
value: number | '';
|
|
891
|
-
total: number | '';
|
|
1137
|
+
cfcr_storage_gb: number;
|
|
892
1138
|
};
|
|
893
|
-
export type
|
|
1139
|
+
export type RegistryRepository = {
|
|
894
1140
|
/**
|
|
895
|
-
*
|
|
1141
|
+
* Repository name.
|
|
896
1142
|
*/
|
|
897
|
-
|
|
1143
|
+
name: string;
|
|
898
1144
|
/**
|
|
899
|
-
*
|
|
1145
|
+
* Registry region.
|
|
900
1146
|
*/
|
|
901
|
-
|
|
1147
|
+
region: string;
|
|
902
1148
|
/**
|
|
903
|
-
*
|
|
1149
|
+
* Full URI of the repository.
|
|
904
1150
|
*/
|
|
905
|
-
|
|
1151
|
+
uri: string;
|
|
1152
|
+
};
|
|
1153
|
+
export type RegistryRepositoryWithTags = {
|
|
906
1154
|
/**
|
|
907
|
-
*
|
|
1155
|
+
* Repository name.
|
|
908
1156
|
*/
|
|
909
|
-
|
|
1157
|
+
name: string;
|
|
910
1158
|
/**
|
|
911
|
-
*
|
|
1159
|
+
* Registry region.
|
|
912
1160
|
*/
|
|
913
|
-
|
|
1161
|
+
region: string;
|
|
914
1162
|
/**
|
|
915
|
-
*
|
|
1163
|
+
* Full URI of the repository.
|
|
916
1164
|
*/
|
|
917
|
-
|
|
1165
|
+
uri: string;
|
|
918
1166
|
/**
|
|
919
|
-
*
|
|
1167
|
+
* Array of tags in the repository.
|
|
920
1168
|
*/
|
|
921
|
-
|
|
1169
|
+
tags: Array<{
|
|
1170
|
+
/**
|
|
1171
|
+
* Tag name.
|
|
1172
|
+
*/
|
|
1173
|
+
name: string;
|
|
1174
|
+
/**
|
|
1175
|
+
* Size of the tag in bytes.
|
|
1176
|
+
*/
|
|
1177
|
+
size: number;
|
|
1178
|
+
/**
|
|
1179
|
+
* Media type of the manifest.
|
|
1180
|
+
*/
|
|
1181
|
+
mediaType?: string;
|
|
1182
|
+
/**
|
|
1183
|
+
* Array of platform strings for multi-arch images (e.g., linux/amd64, linux/arm64).
|
|
1184
|
+
*/
|
|
1185
|
+
platforms?: Array<string>;
|
|
1186
|
+
}>;
|
|
1187
|
+
/**
|
|
1188
|
+
* Total size of all tags in the repository in bytes.
|
|
1189
|
+
*/
|
|
1190
|
+
totalSize: number;
|
|
922
1191
|
};
|
|
923
|
-
export type
|
|
1192
|
+
export type RegistryTag = {
|
|
924
1193
|
/**
|
|
925
|
-
*
|
|
1194
|
+
* Tag name.
|
|
926
1195
|
*/
|
|
927
|
-
|
|
1196
|
+
name: string;
|
|
928
1197
|
/**
|
|
929
|
-
*
|
|
1198
|
+
* Manifest digest for pulling by digest.
|
|
930
1199
|
*/
|
|
931
|
-
|
|
1200
|
+
digest: string;
|
|
932
1201
|
/**
|
|
933
|
-
*
|
|
1202
|
+
* Media type of the manifest.
|
|
934
1203
|
*/
|
|
935
|
-
|
|
1204
|
+
mediaType?: string;
|
|
936
1205
|
/**
|
|
937
|
-
*
|
|
1206
|
+
* Manifest config metadata.
|
|
938
1207
|
*/
|
|
939
|
-
|
|
1208
|
+
config?: {
|
|
1209
|
+
/**
|
|
1210
|
+
* Size of the config in bytes.
|
|
1211
|
+
*/
|
|
1212
|
+
size: number;
|
|
1213
|
+
};
|
|
940
1214
|
/**
|
|
941
|
-
*
|
|
1215
|
+
* Array of layer metadata.
|
|
942
1216
|
*/
|
|
943
|
-
|
|
1217
|
+
layers?: Array<{
|
|
1218
|
+
/**
|
|
1219
|
+
* Digest of the layer.
|
|
1220
|
+
*/
|
|
1221
|
+
digest?: string;
|
|
1222
|
+
/**
|
|
1223
|
+
* Size of the layer in bytes.
|
|
1224
|
+
*/
|
|
1225
|
+
size: number;
|
|
1226
|
+
}>;
|
|
944
1227
|
/**
|
|
945
|
-
*
|
|
1228
|
+
* Array of manifests for multi-arch images.
|
|
946
1229
|
*/
|
|
947
|
-
|
|
1230
|
+
manifests?: Array<{
|
|
1231
|
+
/**
|
|
1232
|
+
* Digest of the manifest.
|
|
1233
|
+
*/
|
|
1234
|
+
digest: string;
|
|
1235
|
+
/**
|
|
1236
|
+
* Platform information for the manifest.
|
|
1237
|
+
*/
|
|
1238
|
+
platform?: {
|
|
1239
|
+
/**
|
|
1240
|
+
* Architecture of the platform.
|
|
1241
|
+
*/
|
|
1242
|
+
architecture: string;
|
|
1243
|
+
/**
|
|
1244
|
+
* Operating system of the platform.
|
|
1245
|
+
*/
|
|
1246
|
+
os: string;
|
|
1247
|
+
/**
|
|
1248
|
+
* Variant of the platform (e.g., v7, v8 for ARM).
|
|
1249
|
+
*/
|
|
1250
|
+
variant?: string;
|
|
1251
|
+
};
|
|
1252
|
+
/**
|
|
1253
|
+
* Layers for this platform.
|
|
1254
|
+
*/
|
|
1255
|
+
layers?: Array<{
|
|
1256
|
+
/**
|
|
1257
|
+
* Digest of the layer.
|
|
1258
|
+
*/
|
|
1259
|
+
digest?: string;
|
|
1260
|
+
/**
|
|
1261
|
+
* Size of the layer in bytes.
|
|
1262
|
+
*/
|
|
1263
|
+
size: number;
|
|
1264
|
+
}>;
|
|
1265
|
+
/**
|
|
1266
|
+
* Total size of this platform manifest in bytes.
|
|
1267
|
+
*/
|
|
1268
|
+
size?: number;
|
|
1269
|
+
}>;
|
|
948
1270
|
/**
|
|
949
|
-
*
|
|
1271
|
+
* Total size of the tag in bytes.
|
|
950
1272
|
*/
|
|
951
|
-
|
|
952
|
-
};
|
|
953
|
-
export type UserUpdateInput = {
|
|
1273
|
+
size: number;
|
|
954
1274
|
/**
|
|
955
|
-
*
|
|
1275
|
+
* Registry region.
|
|
956
1276
|
*/
|
|
957
|
-
|
|
1277
|
+
region: string;
|
|
958
1278
|
/**
|
|
959
|
-
*
|
|
1279
|
+
* Repository name.
|
|
960
1280
|
*/
|
|
961
|
-
|
|
1281
|
+
repository: string;
|
|
962
1282
|
/**
|
|
963
|
-
*
|
|
1283
|
+
* Full URI of the tag.
|
|
964
1284
|
*/
|
|
965
|
-
|
|
1285
|
+
uri: string;
|
|
1286
|
+
};
|
|
1287
|
+
export type TicketAttachment = {
|
|
966
1288
|
/**
|
|
967
|
-
*
|
|
1289
|
+
* Unique identifier of the attachment (Mongo ObjectId).
|
|
968
1290
|
*/
|
|
969
|
-
|
|
1291
|
+
id: string;
|
|
970
1292
|
/**
|
|
971
|
-
*
|
|
1293
|
+
* Original filename as uploaded.
|
|
972
1294
|
*/
|
|
973
|
-
|
|
974
|
-
};
|
|
975
|
-
export type GetUsageData = {
|
|
976
|
-
body?: never;
|
|
977
|
-
path?: never;
|
|
978
|
-
query?: never;
|
|
979
|
-
url: '/billing/usage';
|
|
980
|
-
};
|
|
981
|
-
export type GetUsageErrors = {
|
|
1295
|
+
filename: string;
|
|
982
1296
|
/**
|
|
983
|
-
*
|
|
1297
|
+
* MIME content type of the attachment.
|
|
984
1298
|
*/
|
|
985
|
-
|
|
986
|
-
};
|
|
987
|
-
export type GetUsageResponses = {
|
|
1299
|
+
content_type: string;
|
|
988
1300
|
/**
|
|
989
|
-
*
|
|
1301
|
+
* Size of the attachment in bytes.
|
|
990
1302
|
*/
|
|
991
|
-
|
|
992
|
-
};
|
|
993
|
-
export type GetUsageResponse = GetUsageResponses[keyof GetUsageResponses];
|
|
994
|
-
export type GetBalanceData = {
|
|
995
|
-
body?: never;
|
|
996
|
-
path?: never;
|
|
997
|
-
query?: never;
|
|
998
|
-
url: '/billing/balance';
|
|
1303
|
+
size: number;
|
|
999
1304
|
};
|
|
1000
|
-
export type
|
|
1305
|
+
export type TicketCreateInput = {
|
|
1001
1306
|
/**
|
|
1002
|
-
*
|
|
1307
|
+
* Ticket category. Drives auto-assignment and may carry a subcategory in `properties`.
|
|
1003
1308
|
*/
|
|
1004
|
-
|
|
1005
|
-
};
|
|
1006
|
-
export type GetBalanceResponse = GetBalanceResponses[keyof GetBalanceResponses];
|
|
1007
|
-
export type GetPaymentMethodData = {
|
|
1008
|
-
body?: never;
|
|
1009
|
-
path?: never;
|
|
1010
|
-
query?: never;
|
|
1011
|
-
url: '/billing/payment-method';
|
|
1012
|
-
};
|
|
1013
|
-
export type GetPaymentMethodErrors = {
|
|
1309
|
+
category: 'billing' | 'technical' | 'general';
|
|
1014
1310
|
/**
|
|
1015
|
-
*
|
|
1311
|
+
* Initial message body in markdown. There is no separate subject — the first message body is the description.
|
|
1016
1312
|
*/
|
|
1017
|
-
|
|
1018
|
-
};
|
|
1019
|
-
export type GetPaymentMethodResponses = {
|
|
1313
|
+
body: string;
|
|
1020
1314
|
/**
|
|
1021
|
-
*
|
|
1315
|
+
* Free-form key/value bag set by the UI (e.g. `subcategory`, `cluster_id`, `cluster_name`, `region`).
|
|
1022
1316
|
*/
|
|
1023
|
-
|
|
1317
|
+
properties?: {
|
|
1318
|
+
[key: string]: unknown;
|
|
1319
|
+
};
|
|
1024
1320
|
};
|
|
1025
|
-
export type
|
|
1026
|
-
|
|
1027
|
-
|
|
1028
|
-
|
|
1029
|
-
|
|
1030
|
-
url: '/billing/payment-method';
|
|
1321
|
+
export type TicketMessageInput = {
|
|
1322
|
+
/**
|
|
1323
|
+
* Reply body in markdown.
|
|
1324
|
+
*/
|
|
1325
|
+
body: string;
|
|
1031
1326
|
};
|
|
1032
|
-
export type
|
|
1327
|
+
export type TicketMessage = {
|
|
1033
1328
|
/**
|
|
1034
|
-
*
|
|
1035
|
-
*
|
|
1329
|
+
* Unique identifier of the message (Mongo ObjectId).
|
|
1036
1330
|
*/
|
|
1037
|
-
|
|
1331
|
+
id: string;
|
|
1332
|
+
/**
|
|
1333
|
+
* Message type. Internal notes are filtered out of customer-facing responses.
|
|
1334
|
+
*/
|
|
1335
|
+
type: 'customer_reply' | 'agent_reply';
|
|
1336
|
+
/**
|
|
1337
|
+
* Message body in markdown.
|
|
1338
|
+
*/
|
|
1339
|
+
body: string;
|
|
1340
|
+
/**
|
|
1341
|
+
* First name of the author. Null when not provided.
|
|
1342
|
+
*/
|
|
1343
|
+
author_first_name?: string;
|
|
1344
|
+
/**
|
|
1345
|
+
* Last name of the author. Null when not provided.
|
|
1346
|
+
*/
|
|
1347
|
+
author_last_name?: string;
|
|
1348
|
+
/**
|
|
1349
|
+
* Attachments associated with this message.
|
|
1350
|
+
*/
|
|
1351
|
+
attachments?: Array<{
|
|
1352
|
+
/**
|
|
1353
|
+
* Unique identifier of the attachment (Mongo ObjectId).
|
|
1354
|
+
*/
|
|
1355
|
+
id: string;
|
|
1356
|
+
/**
|
|
1357
|
+
* Original filename as uploaded.
|
|
1358
|
+
*/
|
|
1359
|
+
filename: string;
|
|
1360
|
+
/**
|
|
1361
|
+
* MIME content type of the attachment.
|
|
1362
|
+
*/
|
|
1363
|
+
content_type: string;
|
|
1364
|
+
/**
|
|
1365
|
+
* Size of the attachment in bytes.
|
|
1366
|
+
*/
|
|
1367
|
+
size: number;
|
|
1368
|
+
}>;
|
|
1369
|
+
/**
|
|
1370
|
+
* Creation date of the message. ISO 8601 UTC.
|
|
1371
|
+
*/
|
|
1372
|
+
date_created: string;
|
|
1373
|
+
};
|
|
1374
|
+
export type Ticket = {
|
|
1375
|
+
/**
|
|
1376
|
+
* Unique identifier of the ticket (Mongo ObjectId).
|
|
1377
|
+
*/
|
|
1378
|
+
id: string;
|
|
1379
|
+
/**
|
|
1380
|
+
* Current state of the ticket.
|
|
1381
|
+
*/
|
|
1382
|
+
status: 'waiting_on_us' | 'waiting_on_user' | 'closed';
|
|
1383
|
+
/**
|
|
1384
|
+
* Ticket category.
|
|
1385
|
+
*/
|
|
1386
|
+
category: 'billing' | 'technical' | 'general';
|
|
1387
|
+
/**
|
|
1388
|
+
* First 128 characters of the initial message body, with markdown formatting and newlines stripped. Used for ticket list previews.
|
|
1389
|
+
*/
|
|
1390
|
+
summary: string;
|
|
1391
|
+
/**
|
|
1392
|
+
* Closure timestamp. Null while the ticket is open.
|
|
1393
|
+
*/
|
|
1394
|
+
closed_at?: string;
|
|
1395
|
+
/**
|
|
1396
|
+
* Creation date of the ticket. ISO 8601 UTC.
|
|
1397
|
+
*/
|
|
1398
|
+
date_created: string;
|
|
1399
|
+
/**
|
|
1400
|
+
* Last update date of the ticket. ISO 8601 UTC.
|
|
1401
|
+
*/
|
|
1402
|
+
date_updated: string;
|
|
1403
|
+
/**
|
|
1404
|
+
* Messages on the ticket in chronological order. Internal notes are excluded. Returned by the detail endpoint only.
|
|
1405
|
+
*/
|
|
1406
|
+
messages?: Array<{
|
|
1407
|
+
/**
|
|
1408
|
+
* Unique identifier of the message (Mongo ObjectId).
|
|
1409
|
+
*/
|
|
1410
|
+
id: string;
|
|
1411
|
+
/**
|
|
1412
|
+
* Message type. Internal notes are filtered out of customer-facing responses.
|
|
1413
|
+
*/
|
|
1414
|
+
type: 'customer_reply' | 'agent_reply';
|
|
1415
|
+
/**
|
|
1416
|
+
* Message body in markdown.
|
|
1417
|
+
*/
|
|
1418
|
+
body: string;
|
|
1419
|
+
/**
|
|
1420
|
+
* First name of the author. Null when not provided.
|
|
1421
|
+
*/
|
|
1422
|
+
author_first_name?: string;
|
|
1423
|
+
/**
|
|
1424
|
+
* Last name of the author. Null when not provided.
|
|
1425
|
+
*/
|
|
1426
|
+
author_last_name?: string;
|
|
1427
|
+
/**
|
|
1428
|
+
* Attachments associated with this message.
|
|
1429
|
+
*/
|
|
1430
|
+
attachments?: Array<{
|
|
1431
|
+
/**
|
|
1432
|
+
* Unique identifier of the attachment (Mongo ObjectId).
|
|
1433
|
+
*/
|
|
1434
|
+
id: string;
|
|
1435
|
+
/**
|
|
1436
|
+
* Original filename as uploaded.
|
|
1437
|
+
*/
|
|
1438
|
+
filename: string;
|
|
1439
|
+
/**
|
|
1440
|
+
* MIME content type of the attachment.
|
|
1441
|
+
*/
|
|
1442
|
+
content_type: string;
|
|
1443
|
+
/**
|
|
1444
|
+
* Size of the attachment in bytes.
|
|
1445
|
+
*/
|
|
1446
|
+
size: number;
|
|
1447
|
+
}>;
|
|
1448
|
+
/**
|
|
1449
|
+
* Creation date of the message. ISO 8601 UTC.
|
|
1450
|
+
*/
|
|
1451
|
+
date_created: string;
|
|
1452
|
+
}>;
|
|
1453
|
+
};
|
|
1454
|
+
export type TokenCreateInput = {
|
|
1455
|
+
/**
|
|
1456
|
+
* Human readable access token name.
|
|
1457
|
+
*/
|
|
1458
|
+
name: string;
|
|
1459
|
+
/**
|
|
1460
|
+
* Role assumed by the token.
|
|
1461
|
+
*/
|
|
1462
|
+
role: 'Administrator' | 'User';
|
|
1463
|
+
};
|
|
1464
|
+
export type Token = {
|
|
1465
|
+
/**
|
|
1466
|
+
* Human readable access token name.
|
|
1467
|
+
*/
|
|
1468
|
+
name: string;
|
|
1469
|
+
/**
|
|
1470
|
+
* Role assumed by the token.
|
|
1471
|
+
*/
|
|
1472
|
+
role: 'Administrator' | 'User';
|
|
1473
|
+
/**
|
|
1474
|
+
* Generated unique identifier of the access token.
|
|
1475
|
+
*/
|
|
1476
|
+
id?: string;
|
|
1477
|
+
/**
|
|
1478
|
+
* Access token secret. Unmasked only during creation.
|
|
1479
|
+
*/
|
|
1480
|
+
secret?: string;
|
|
1481
|
+
/**
|
|
1482
|
+
* Creation date of the access token. ISO 8601 date string in UTC timezone
|
|
1483
|
+
*/
|
|
1484
|
+
date_created: string;
|
|
1485
|
+
};
|
|
1486
|
+
export type TokenUpdateInput = {
|
|
1487
|
+
/**
|
|
1488
|
+
* Human readable access token name.
|
|
1489
|
+
*/
|
|
1490
|
+
name?: string;
|
|
1491
|
+
/**
|
|
1492
|
+
* Role assumed by the token.
|
|
1493
|
+
*/
|
|
1494
|
+
role?: 'Administrator' | 'User';
|
|
1495
|
+
};
|
|
1496
|
+
export type UsageFacets = {
|
|
1497
|
+
/**
|
|
1498
|
+
* List of unique cluster IDs
|
|
1499
|
+
*/
|
|
1500
|
+
cluster_id?: Array<string>;
|
|
1501
|
+
/**
|
|
1502
|
+
* List of unique products
|
|
1503
|
+
*/
|
|
1504
|
+
product?: Array<'cfke_controlplane_basic' | 'cfke_controlplane_pro' | 'cfke_controlplane_enterprise' | 'cfke_connected_nodes_basic' | 'cfke_connected_nodes_pro' | 'cfke_connected_nodes_enterprise' | 'cfcr_storage'>;
|
|
1505
|
+
};
|
|
1506
|
+
export type UsageResponse = {
|
|
1507
|
+
/**
|
|
1508
|
+
* Usage data
|
|
1509
|
+
*/
|
|
1510
|
+
data: Array<{
|
|
1511
|
+
/**
|
|
1512
|
+
* Hour of the usage
|
|
1513
|
+
*/
|
|
1514
|
+
hour: string;
|
|
1515
|
+
/**
|
|
1516
|
+
* Unique identifier of the kubernetes cluster. UUID v4 string in canonical form
|
|
1517
|
+
*/
|
|
1518
|
+
cluster_id: string;
|
|
1519
|
+
/**
|
|
1520
|
+
* The product the usage is associated with
|
|
1521
|
+
*/
|
|
1522
|
+
product: 'cfke_controlplane_basic' | 'cfke_controlplane_pro' | 'cfke_controlplane_enterprise' | 'cfke_connected_nodes_basic' | 'cfke_connected_nodes_pro' | 'cfke_connected_nodes_enterprise' | 'cfcr_storage';
|
|
1523
|
+
/**
|
|
1524
|
+
* Consumption
|
|
1525
|
+
*/
|
|
1526
|
+
value: number;
|
|
1527
|
+
/**
|
|
1528
|
+
* Price per unit
|
|
1529
|
+
*/
|
|
1530
|
+
price: number;
|
|
1531
|
+
/**
|
|
1532
|
+
* Total cost
|
|
1533
|
+
*/
|
|
1534
|
+
total: number;
|
|
1535
|
+
}>;
|
|
1536
|
+
/**
|
|
1537
|
+
* Facets for filtering
|
|
1538
|
+
*/
|
|
1539
|
+
facets: {
|
|
1540
|
+
/**
|
|
1541
|
+
* List of unique cluster IDs
|
|
1542
|
+
*/
|
|
1543
|
+
cluster_id?: Array<string>;
|
|
1544
|
+
/**
|
|
1545
|
+
* List of unique products
|
|
1546
|
+
*/
|
|
1547
|
+
product?: Array<'cfke_controlplane_basic' | 'cfke_controlplane_pro' | 'cfke_controlplane_enterprise' | 'cfke_connected_nodes_basic' | 'cfke_connected_nodes_pro' | 'cfke_connected_nodes_enterprise' | 'cfcr_storage'>;
|
|
1548
|
+
};
|
|
1549
|
+
};
|
|
1550
|
+
export type Usage = {
|
|
1551
|
+
/**
|
|
1552
|
+
* Hour of the usage
|
|
1553
|
+
*/
|
|
1554
|
+
hour: string;
|
|
1555
|
+
/**
|
|
1556
|
+
* Unique identifier of the kubernetes cluster. UUID v4 string in canonical form
|
|
1557
|
+
*/
|
|
1558
|
+
cluster_id: string;
|
|
1559
|
+
/**
|
|
1560
|
+
* The product the usage is associated with
|
|
1561
|
+
*/
|
|
1562
|
+
product: 'cfke_controlplane_basic' | 'cfke_controlplane_pro' | 'cfke_controlplane_enterprise' | 'cfke_connected_nodes_basic' | 'cfke_connected_nodes_pro' | 'cfke_connected_nodes_enterprise' | 'cfcr_storage';
|
|
1563
|
+
/**
|
|
1564
|
+
* Consumption
|
|
1565
|
+
*/
|
|
1566
|
+
value: number;
|
|
1567
|
+
/**
|
|
1568
|
+
* Price per unit
|
|
1569
|
+
*/
|
|
1570
|
+
price: number;
|
|
1571
|
+
/**
|
|
1572
|
+
* Total cost
|
|
1573
|
+
*/
|
|
1574
|
+
total: number;
|
|
1575
|
+
};
|
|
1576
|
+
export type UserCreateInput = {
|
|
1577
|
+
/**
|
|
1578
|
+
* User email address.
|
|
1579
|
+
*/
|
|
1580
|
+
email: string;
|
|
1581
|
+
/**
|
|
1582
|
+
* User first name.
|
|
1583
|
+
*/
|
|
1584
|
+
first_name: string;
|
|
1585
|
+
/**
|
|
1586
|
+
* User last name.
|
|
1587
|
+
*/
|
|
1588
|
+
last_name: string;
|
|
1589
|
+
/**
|
|
1590
|
+
* Generated unique invite code.
|
|
1591
|
+
*/
|
|
1592
|
+
code: string;
|
|
1593
|
+
/**
|
|
1594
|
+
* User password. Must be at least 8 characters long.
|
|
1595
|
+
*/
|
|
1596
|
+
password: string;
|
|
1597
|
+
};
|
|
1598
|
+
export type User = {
|
|
1599
|
+
/**
|
|
1600
|
+
* User email address.
|
|
1601
|
+
*/
|
|
1602
|
+
email: string;
|
|
1603
|
+
/**
|
|
1604
|
+
* User first name.
|
|
1605
|
+
*/
|
|
1606
|
+
first_name: string;
|
|
1607
|
+
/**
|
|
1608
|
+
* User last name.
|
|
1609
|
+
*/
|
|
1610
|
+
last_name: string;
|
|
1611
|
+
/**
|
|
1612
|
+
* User role. Can be 'Administrator', 'User'.
|
|
1613
|
+
*/
|
|
1614
|
+
role: 'Administrator' | 'User';
|
|
1615
|
+
/**
|
|
1616
|
+
* Status of the user. Can be `active` or `inactive`. Inactive users cannot log in or manage organization resources.
|
|
1617
|
+
*/
|
|
1618
|
+
status: 'active' | 'inactive';
|
|
1619
|
+
/**
|
|
1620
|
+
* Unique identifier of the user. UUID v4 string in canonical form
|
|
1621
|
+
*/
|
|
1622
|
+
id: string;
|
|
1623
|
+
/**
|
|
1624
|
+
* Creation date of the user. ISO 8601 date string in UTC timezone
|
|
1625
|
+
*/
|
|
1626
|
+
date_created: string;
|
|
1627
|
+
};
|
|
1628
|
+
export type UserUpdateInput = {
|
|
1629
|
+
/**
|
|
1630
|
+
* User email address.
|
|
1631
|
+
*/
|
|
1632
|
+
email?: string;
|
|
1633
|
+
/**
|
|
1634
|
+
* User first name.
|
|
1635
|
+
*/
|
|
1636
|
+
first_name?: string;
|
|
1637
|
+
/**
|
|
1638
|
+
* User last name.
|
|
1639
|
+
*/
|
|
1640
|
+
last_name?: string;
|
|
1641
|
+
/**
|
|
1642
|
+
* User role. Can be 'Administrator', 'User'.
|
|
1643
|
+
*/
|
|
1644
|
+
role?: 'Administrator' | 'User';
|
|
1645
|
+
/**
|
|
1646
|
+
* Status of the user. Can be `active` or `inactive`. Inactive users cannot log in or manage organization resources.
|
|
1647
|
+
*/
|
|
1648
|
+
status?: 'active' | 'inactive';
|
|
1649
|
+
};
|
|
1650
|
+
export type ListUserOrganizationsData = {
|
|
1651
|
+
body?: never;
|
|
1652
|
+
path: {
|
|
1653
|
+
/**
|
|
1654
|
+
* User email address.
|
|
1655
|
+
*/
|
|
1656
|
+
email: string;
|
|
1657
|
+
};
|
|
1658
|
+
query?: never;
|
|
1659
|
+
url: '/users/organizations/{email}';
|
|
1660
|
+
};
|
|
1661
|
+
export type ListUserOrganizationsResponses = {
|
|
1662
|
+
/**
|
|
1663
|
+
* An array of organizations the user belongs to.
|
|
1664
|
+
*/
|
|
1665
|
+
200: Array<{
|
|
1666
|
+
/**
|
|
1667
|
+
* Unique identifier of the organization. UUID v4 string in canonical form
|
|
1668
|
+
*/
|
|
1669
|
+
realm?: string;
|
|
1670
|
+
/**
|
|
1671
|
+
* Human-readable name of the organization
|
|
1672
|
+
*/
|
|
1673
|
+
displayName?: string;
|
|
1674
|
+
}>;
|
|
1675
|
+
};
|
|
1676
|
+
export type ListUserOrganizationsResponse = ListUserOrganizationsResponses[keyof ListUserOrganizationsResponses];
|
|
1677
|
+
export type ListUsersData = {
|
|
1678
|
+
body?: never;
|
|
1679
|
+
path?: never;
|
|
1680
|
+
query?: never;
|
|
1681
|
+
url: '/users';
|
|
1682
|
+
};
|
|
1683
|
+
export type ListUsersErrors = {
|
|
1684
|
+
/**
|
|
1685
|
+
* Not authenticated
|
|
1686
|
+
*/
|
|
1687
|
+
401: unknown;
|
|
1688
|
+
};
|
|
1689
|
+
export type ListUsersResponses = {
|
|
1690
|
+
/**
|
|
1691
|
+
* An array of users
|
|
1692
|
+
*/
|
|
1693
|
+
200: Array<User>;
|
|
1694
|
+
};
|
|
1695
|
+
export type ListUsersResponse = ListUsersResponses[keyof ListUsersResponses];
|
|
1696
|
+
export type CreateUserData = {
|
|
1697
|
+
body: UserCreateInput;
|
|
1698
|
+
path?: never;
|
|
1699
|
+
query?: never;
|
|
1700
|
+
url: '/users';
|
|
1701
|
+
};
|
|
1702
|
+
export type CreateUserResponses = {
|
|
1703
|
+
/**
|
|
1704
|
+
* Successfully created. Returns created user details.
|
|
1705
|
+
*/
|
|
1706
|
+
200: User;
|
|
1707
|
+
};
|
|
1708
|
+
export type CreateUserResponse = CreateUserResponses[keyof CreateUserResponses];
|
|
1709
|
+
export type DeleteUserData = {
|
|
1710
|
+
body?: never;
|
|
1711
|
+
path: {
|
|
1712
|
+
/**
|
|
1713
|
+
* Unique user identifier. UUID v4 string in canonical form
|
|
1714
|
+
*/
|
|
1715
|
+
user_id: string;
|
|
1716
|
+
};
|
|
1717
|
+
query?: never;
|
|
1718
|
+
url: '/users/{user_id}';
|
|
1719
|
+
};
|
|
1720
|
+
export type DeleteUserErrors = {
|
|
1721
|
+
/**
|
|
1722
|
+
* Deleting own user is not allowed. Delete your organization instead.
|
|
1723
|
+
*/
|
|
1724
|
+
400: unknown;
|
|
1725
|
+
/**
|
|
1726
|
+
* Not authenticated
|
|
1727
|
+
*/
|
|
1728
|
+
401: unknown;
|
|
1729
|
+
};
|
|
1730
|
+
export type DeleteUserResponses = {
|
|
1731
|
+
/**
|
|
1732
|
+
* User profile information
|
|
1733
|
+
*/
|
|
1734
|
+
200: User;
|
|
1735
|
+
};
|
|
1736
|
+
export type DeleteUserResponse = DeleteUserResponses[keyof DeleteUserResponses];
|
|
1737
|
+
export type GetUserData = {
|
|
1738
|
+
body?: never;
|
|
1739
|
+
path: {
|
|
1740
|
+
/**
|
|
1741
|
+
* Unique user identifier. UUID v4 string in canonical form
|
|
1742
|
+
*/
|
|
1743
|
+
user_id: string;
|
|
1744
|
+
};
|
|
1745
|
+
query?: never;
|
|
1746
|
+
url: '/users/{user_id}';
|
|
1747
|
+
};
|
|
1748
|
+
export type GetUserErrors = {
|
|
1749
|
+
/**
|
|
1750
|
+
* Not authenticated
|
|
1751
|
+
*/
|
|
1752
|
+
401: unknown;
|
|
1753
|
+
};
|
|
1754
|
+
export type GetUserResponses = {
|
|
1755
|
+
/**
|
|
1756
|
+
* User profile information
|
|
1757
|
+
*/
|
|
1758
|
+
200: User;
|
|
1759
|
+
};
|
|
1760
|
+
export type GetUserResponse = GetUserResponses[keyof GetUserResponses];
|
|
1761
|
+
export type UpdateUserData = {
|
|
1762
|
+
body: UserUpdateInput;
|
|
1763
|
+
path: {
|
|
1764
|
+
/**
|
|
1765
|
+
* Unique user identifier. UUID v4 string in canonical form
|
|
1766
|
+
*/
|
|
1767
|
+
user_id: string;
|
|
1768
|
+
};
|
|
1769
|
+
query?: never;
|
|
1770
|
+
url: '/users/{user_id}';
|
|
1771
|
+
};
|
|
1772
|
+
export type UpdateUserResponses = {
|
|
1773
|
+
/**
|
|
1774
|
+
* Successfully created. Returns created user details.
|
|
1775
|
+
*/
|
|
1776
|
+
200: User;
|
|
1777
|
+
};
|
|
1778
|
+
export type UpdateUserResponse = UpdateUserResponses[keyof UpdateUserResponses];
|
|
1779
|
+
export type ListTokensData = {
|
|
1780
|
+
body?: never;
|
|
1781
|
+
path?: never;
|
|
1782
|
+
query?: never;
|
|
1783
|
+
url: '/tokens';
|
|
1784
|
+
};
|
|
1785
|
+
export type ListTokensErrors = {
|
|
1786
|
+
/**
|
|
1787
|
+
* Not authenticated
|
|
1788
|
+
*/
|
|
1789
|
+
401: unknown;
|
|
1790
|
+
};
|
|
1791
|
+
export type ListTokensResponses = {
|
|
1792
|
+
/**
|
|
1793
|
+
* Returns a list of access token details with masked secrets.
|
|
1794
|
+
*/
|
|
1795
|
+
200: Array<Token>;
|
|
1796
|
+
};
|
|
1797
|
+
export type ListTokensResponse = ListTokensResponses[keyof ListTokensResponses];
|
|
1798
|
+
export type CreateTokenData = {
|
|
1799
|
+
body: TokenCreateInput;
|
|
1800
|
+
path?: never;
|
|
1801
|
+
query?: never;
|
|
1802
|
+
url: '/tokens';
|
|
1803
|
+
};
|
|
1804
|
+
export type CreateTokenErrors = {
|
|
1805
|
+
/**
|
|
1806
|
+
* Not authenticated
|
|
1807
|
+
*/
|
|
1808
|
+
401: unknown;
|
|
1809
|
+
};
|
|
1810
|
+
export type CreateTokenResponses = {
|
|
1811
|
+
/**
|
|
1812
|
+
* Successfully created. Returns created token details with unmasked/raw secret.
|
|
1813
|
+
*/
|
|
1814
|
+
200: Token;
|
|
1815
|
+
};
|
|
1816
|
+
export type CreateTokenResponse = CreateTokenResponses[keyof CreateTokenResponses];
|
|
1817
|
+
export type DeleteTokenData = {
|
|
1818
|
+
body?: never;
|
|
1819
|
+
path: {
|
|
1820
|
+
/**
|
|
1821
|
+
* Generated unique identifier of the access token.
|
|
1822
|
+
*/
|
|
1823
|
+
token_id: string;
|
|
1824
|
+
};
|
|
1825
|
+
query?: never;
|
|
1826
|
+
url: '/tokens/{token_id}';
|
|
1827
|
+
};
|
|
1828
|
+
export type DeleteTokenResponses = {
|
|
1829
|
+
/**
|
|
1830
|
+
* Successfully deleted.
|
|
1831
|
+
*/
|
|
1832
|
+
200: unknown;
|
|
1833
|
+
};
|
|
1834
|
+
export type GetTokenData = {
|
|
1835
|
+
body?: never;
|
|
1836
|
+
path: {
|
|
1837
|
+
/**
|
|
1838
|
+
* Generated unique identifier of the access token.
|
|
1839
|
+
*/
|
|
1840
|
+
token_id: string;
|
|
1841
|
+
};
|
|
1842
|
+
query?: never;
|
|
1843
|
+
url: '/tokens/{token_id}';
|
|
1844
|
+
};
|
|
1845
|
+
export type GetTokenErrors = {
|
|
1846
|
+
/**
|
|
1847
|
+
* Not authenticated
|
|
1848
|
+
*/
|
|
1849
|
+
401: unknown;
|
|
1850
|
+
};
|
|
1851
|
+
export type GetTokenResponses = {
|
|
1852
|
+
/**
|
|
1853
|
+
* Returns access token details with masked secret.
|
|
1854
|
+
*/
|
|
1855
|
+
200: Token;
|
|
1856
|
+
};
|
|
1857
|
+
export type GetTokenResponse = GetTokenResponses[keyof GetTokenResponses];
|
|
1858
|
+
export type UpdateTokenData = {
|
|
1859
|
+
body: TokenUpdateInput;
|
|
1860
|
+
path: {
|
|
1861
|
+
/**
|
|
1862
|
+
* Generated unique identifier of the access token.
|
|
1863
|
+
*/
|
|
1864
|
+
token_id: string;
|
|
1865
|
+
};
|
|
1866
|
+
query?: never;
|
|
1867
|
+
url: '/tokens/{token_id}';
|
|
1868
|
+
};
|
|
1869
|
+
export type UpdateTokenErrors = {
|
|
1870
|
+
/**
|
|
1871
|
+
* Not authenticated
|
|
1872
|
+
*/
|
|
1873
|
+
401: unknown;
|
|
1874
|
+
};
|
|
1875
|
+
export type UpdateTokenResponses = {
|
|
1876
|
+
/**
|
|
1877
|
+
* Successfully updated. Returns updated token details with masked secret.
|
|
1878
|
+
*/
|
|
1879
|
+
200: Token;
|
|
1880
|
+
};
|
|
1881
|
+
export type UpdateTokenResponse = UpdateTokenResponses[keyof UpdateTokenResponses];
|
|
1882
|
+
export type RegenerateTokenData = {
|
|
1883
|
+
body?: never;
|
|
1884
|
+
path: {
|
|
1885
|
+
/**
|
|
1886
|
+
* Generated unique identifier of the access token.
|
|
1887
|
+
*/
|
|
1888
|
+
token_id: string;
|
|
1889
|
+
};
|
|
1890
|
+
query?: never;
|
|
1891
|
+
url: '/tokens/{token_id}/secret';
|
|
1892
|
+
};
|
|
1893
|
+
export type RegenerateTokenErrors = {
|
|
1894
|
+
/**
|
|
1895
|
+
* Not authenticated
|
|
1896
|
+
*/
|
|
1897
|
+
401: unknown;
|
|
1898
|
+
};
|
|
1899
|
+
export type RegenerateTokenResponses = {
|
|
1900
|
+
/**
|
|
1901
|
+
* Successfully updated. Returns updated token details with unmasked / raw secret.
|
|
1902
|
+
*/
|
|
1903
|
+
200: Token;
|
|
1904
|
+
};
|
|
1905
|
+
export type RegenerateTokenResponse = RegenerateTokenResponses[keyof RegenerateTokenResponses];
|
|
1906
|
+
export type ListTicketsData = {
|
|
1907
|
+
body?: never;
|
|
1908
|
+
path?: never;
|
|
1909
|
+
query?: never;
|
|
1910
|
+
url: '/tickets';
|
|
1911
|
+
};
|
|
1912
|
+
export type ListTicketsResponses = {
|
|
1913
|
+
/**
|
|
1914
|
+
* An array of tickets for the organization, newest first.
|
|
1915
|
+
*/
|
|
1916
|
+
200: Array<Ticket>;
|
|
1917
|
+
};
|
|
1918
|
+
export type ListTicketsResponse = ListTicketsResponses[keyof ListTicketsResponses];
|
|
1919
|
+
export type CreateTicketData = {
|
|
1920
|
+
body: {
|
|
1921
|
+
/**
|
|
1922
|
+
* JSON-encoded TicketCreateInput.
|
|
1923
|
+
*/
|
|
1924
|
+
payload?: string;
|
|
1925
|
+
attachments?: Array<Blob | File>;
|
|
1926
|
+
};
|
|
1927
|
+
path?: never;
|
|
1928
|
+
query?: never;
|
|
1929
|
+
url: '/tickets';
|
|
1930
|
+
};
|
|
1931
|
+
export type CreateTicketResponses = {
|
|
1932
|
+
/**
|
|
1933
|
+
* Ticket created.
|
|
1934
|
+
*/
|
|
1935
|
+
200: Ticket;
|
|
1936
|
+
};
|
|
1937
|
+
export type CreateTicketResponse = CreateTicketResponses[keyof CreateTicketResponses];
|
|
1938
|
+
export type CloseTicketData = {
|
|
1939
|
+
body?: never;
|
|
1940
|
+
path: {
|
|
1941
|
+
ticket_id: string;
|
|
1942
|
+
};
|
|
1943
|
+
query?: never;
|
|
1944
|
+
url: '/tickets/{ticket_id}';
|
|
1945
|
+
};
|
|
1946
|
+
export type CloseTicketResponses = {
|
|
1947
|
+
/**
|
|
1948
|
+
* Ticket closed.
|
|
1949
|
+
*/
|
|
1950
|
+
200: Ticket;
|
|
1951
|
+
};
|
|
1952
|
+
export type CloseTicketResponse = CloseTicketResponses[keyof CloseTicketResponses];
|
|
1953
|
+
export type GetTicketData = {
|
|
1954
|
+
body?: never;
|
|
1955
|
+
path: {
|
|
1956
|
+
ticket_id: string;
|
|
1957
|
+
};
|
|
1958
|
+
query?: never;
|
|
1959
|
+
url: '/tickets/{ticket_id}';
|
|
1960
|
+
};
|
|
1961
|
+
export type GetTicketResponses = {
|
|
1962
|
+
/**
|
|
1963
|
+
* Ticket with messages (internal notes excluded).
|
|
1964
|
+
*/
|
|
1965
|
+
200: Ticket;
|
|
1966
|
+
};
|
|
1967
|
+
export type GetTicketResponse = GetTicketResponses[keyof GetTicketResponses];
|
|
1968
|
+
export type ReplyTicketData = {
|
|
1969
|
+
body: {
|
|
1038
1970
|
/**
|
|
1039
|
-
*
|
|
1971
|
+
* JSON-encoded TicketMessageInput.
|
|
1040
1972
|
*/
|
|
1041
|
-
|
|
1973
|
+
payload?: string;
|
|
1974
|
+
attachments?: Array<Blob | File>;
|
|
1975
|
+
};
|
|
1976
|
+
path: {
|
|
1977
|
+
ticket_id: string;
|
|
1042
1978
|
};
|
|
1979
|
+
query?: never;
|
|
1980
|
+
url: '/tickets/{ticket_id}/messages';
|
|
1043
1981
|
};
|
|
1044
|
-
export type
|
|
1045
|
-
|
|
1982
|
+
export type ReplyTicketErrors = {
|
|
1983
|
+
/**
|
|
1984
|
+
* Ticket is closed. Open a new ticket instead.
|
|
1985
|
+
*/
|
|
1986
|
+
409: unknown;
|
|
1987
|
+
};
|
|
1988
|
+
export type ReplyTicketResponses = {
|
|
1989
|
+
/**
|
|
1990
|
+
* Reply appended.
|
|
1991
|
+
*/
|
|
1992
|
+
200: TicketMessage;
|
|
1993
|
+
};
|
|
1994
|
+
export type ReplyTicketResponse = ReplyTicketResponses[keyof ReplyTicketResponses];
|
|
1995
|
+
export type GetTicketAttachmentData = {
|
|
1996
|
+
body?: never;
|
|
1997
|
+
path: {
|
|
1998
|
+
ticket_id: string;
|
|
1999
|
+
attachment_id: string;
|
|
2000
|
+
};
|
|
2001
|
+
query?: never;
|
|
2002
|
+
url: '/tickets/{ticket_id}/attachments/{attachment_id}';
|
|
2003
|
+
};
|
|
2004
|
+
export type GetTicketAttachmentResponses = {
|
|
2005
|
+
/**
|
|
2006
|
+
* Attachment binary stream.
|
|
2007
|
+
*/
|
|
2008
|
+
200: Blob | File;
|
|
2009
|
+
};
|
|
2010
|
+
export type GetTicketAttachmentResponse = GetTicketAttachmentResponses[keyof GetTicketAttachmentResponses];
|
|
2011
|
+
export type ListRepositoriesData = {
|
|
1046
2012
|
body?: never;
|
|
1047
2013
|
path?: never;
|
|
1048
|
-
query
|
|
2014
|
+
query?: never;
|
|
2015
|
+
url: '/registry';
|
|
2016
|
+
};
|
|
2017
|
+
export type ListRepositoriesErrors = {
|
|
2018
|
+
/**
|
|
2019
|
+
* Not authenticated
|
|
2020
|
+
*/
|
|
2021
|
+
401: unknown;
|
|
2022
|
+
/**
|
|
2023
|
+
* Internal server error
|
|
2024
|
+
*/
|
|
2025
|
+
500: unknown;
|
|
2026
|
+
};
|
|
2027
|
+
export type ListRepositoriesResponses = {
|
|
2028
|
+
/**
|
|
2029
|
+
* List of repositories
|
|
2030
|
+
*/
|
|
2031
|
+
200: Array<RegistryRepository>;
|
|
2032
|
+
};
|
|
2033
|
+
export type ListRepositoriesResponse = ListRepositoriesResponses[keyof ListRepositoriesResponses];
|
|
2034
|
+
export type ListTagsData = {
|
|
2035
|
+
body?: never;
|
|
2036
|
+
path: {
|
|
1049
2037
|
/**
|
|
1050
|
-
*
|
|
2038
|
+
* Region where the repository is located
|
|
1051
2039
|
*/
|
|
1052
|
-
|
|
2040
|
+
region: string;
|
|
1053
2041
|
/**
|
|
1054
|
-
*
|
|
2042
|
+
* Name of the repository
|
|
1055
2043
|
*/
|
|
1056
|
-
|
|
2044
|
+
repository: string;
|
|
1057
2045
|
};
|
|
1058
|
-
|
|
2046
|
+
query?: never;
|
|
2047
|
+
url: '/registry/{region}/{repository}';
|
|
1059
2048
|
};
|
|
1060
|
-
export type
|
|
2049
|
+
export type ListTagsErrors = {
|
|
1061
2050
|
/**
|
|
1062
2051
|
* Not authenticated
|
|
1063
2052
|
*/
|
|
1064
2053
|
401: unknown;
|
|
2054
|
+
/**
|
|
2055
|
+
* Repository not found
|
|
2056
|
+
*/
|
|
2057
|
+
404: unknown;
|
|
2058
|
+
/**
|
|
2059
|
+
* Internal server error
|
|
2060
|
+
*/
|
|
2061
|
+
500: unknown;
|
|
1065
2062
|
};
|
|
1066
|
-
export type
|
|
2063
|
+
export type ListTagsResponses = {
|
|
1067
2064
|
/**
|
|
1068
|
-
*
|
|
2065
|
+
* Repository with tags
|
|
1069
2066
|
*/
|
|
1070
|
-
200:
|
|
2067
|
+
200: RegistryRepositoryWithTags;
|
|
1071
2068
|
};
|
|
1072
|
-
export type
|
|
1073
|
-
export type
|
|
2069
|
+
export type ListTagsResponse = ListTagsResponses[keyof ListTagsResponses];
|
|
2070
|
+
export type DeleteTagData = {
|
|
1074
2071
|
body?: never;
|
|
1075
2072
|
path: {
|
|
1076
2073
|
/**
|
|
1077
|
-
*
|
|
2074
|
+
* Region where the repository is located
|
|
1078
2075
|
*/
|
|
1079
|
-
|
|
2076
|
+
region: string;
|
|
2077
|
+
/**
|
|
2078
|
+
* Name of the repository
|
|
2079
|
+
*/
|
|
2080
|
+
repository: string;
|
|
2081
|
+
/**
|
|
2082
|
+
* Name of the tag
|
|
2083
|
+
*/
|
|
2084
|
+
tag: string;
|
|
1080
2085
|
};
|
|
1081
2086
|
query?: never;
|
|
1082
|
-
url: '/
|
|
2087
|
+
url: '/registry/{region}/{repository}/{tag}';
|
|
1083
2088
|
};
|
|
1084
|
-
export type
|
|
2089
|
+
export type DeleteTagErrors = {
|
|
2090
|
+
/**
|
|
2091
|
+
* Not authenticated
|
|
2092
|
+
*/
|
|
2093
|
+
401: unknown;
|
|
1085
2094
|
/**
|
|
1086
|
-
*
|
|
2095
|
+
* Tag not found
|
|
1087
2096
|
*/
|
|
1088
|
-
|
|
1089
|
-
|
|
2097
|
+
404: unknown;
|
|
2098
|
+
/**
|
|
2099
|
+
* Internal server error
|
|
2100
|
+
*/
|
|
2101
|
+
500: unknown;
|
|
2102
|
+
};
|
|
2103
|
+
export type DeleteTagResponses = {
|
|
2104
|
+
/**
|
|
2105
|
+
* Tag successfully deleted
|
|
2106
|
+
*/
|
|
2107
|
+
200: unknown;
|
|
2108
|
+
};
|
|
2109
|
+
export type GetTagData = {
|
|
2110
|
+
body?: never;
|
|
2111
|
+
path: {
|
|
2112
|
+
/**
|
|
2113
|
+
* Region where the repository is located
|
|
2114
|
+
*/
|
|
2115
|
+
region: string;
|
|
2116
|
+
/**
|
|
2117
|
+
* Name of the repository
|
|
2118
|
+
*/
|
|
2119
|
+
repository: string;
|
|
2120
|
+
/**
|
|
2121
|
+
* Name of the tag
|
|
2122
|
+
*/
|
|
2123
|
+
tag: string;
|
|
1090
2124
|
};
|
|
2125
|
+
query?: never;
|
|
2126
|
+
url: '/registry/{region}/{repository}/{tag}';
|
|
1091
2127
|
};
|
|
1092
|
-
export type
|
|
1093
|
-
|
|
2128
|
+
export type GetTagErrors = {
|
|
2129
|
+
/**
|
|
2130
|
+
* Not authenticated
|
|
2131
|
+
*/
|
|
2132
|
+
401: unknown;
|
|
2133
|
+
/**
|
|
2134
|
+
* Tag not found
|
|
2135
|
+
*/
|
|
2136
|
+
404: unknown;
|
|
2137
|
+
/**
|
|
2138
|
+
* Internal server error
|
|
2139
|
+
*/
|
|
2140
|
+
500: unknown;
|
|
2141
|
+
};
|
|
2142
|
+
export type GetTagResponses = {
|
|
2143
|
+
/**
|
|
2144
|
+
* Tag details
|
|
2145
|
+
*/
|
|
2146
|
+
200: RegistryTag;
|
|
2147
|
+
};
|
|
2148
|
+
export type GetTagResponse = GetTagResponses[keyof GetTagResponses];
|
|
2149
|
+
export type GetOrganizationData = {
|
|
1094
2150
|
body?: never;
|
|
1095
2151
|
path?: never;
|
|
1096
2152
|
query?: never;
|
|
1097
|
-
url: '/
|
|
2153
|
+
url: '/organization';
|
|
1098
2154
|
};
|
|
1099
|
-
export type
|
|
2155
|
+
export type GetOrganizationResponses = {
|
|
1100
2156
|
/**
|
|
1101
|
-
* Returns a single object containing organization
|
|
2157
|
+
* Returns a single object containing organization details.
|
|
1102
2158
|
*/
|
|
1103
|
-
200:
|
|
2159
|
+
200: Organization;
|
|
1104
2160
|
};
|
|
1105
|
-
export type
|
|
1106
|
-
export type
|
|
1107
|
-
body:
|
|
2161
|
+
export type GetOrganizationResponse = GetOrganizationResponses[keyof GetOrganizationResponses];
|
|
2162
|
+
export type CreateOrganizationData = {
|
|
2163
|
+
body: OrganizationCreateInput;
|
|
1108
2164
|
path?: never;
|
|
1109
2165
|
query?: never;
|
|
1110
|
-
url: '/
|
|
2166
|
+
url: '/organization';
|
|
1111
2167
|
};
|
|
1112
|
-
export type
|
|
2168
|
+
export type CreateOrganizationResponses = {
|
|
1113
2169
|
/**
|
|
1114
|
-
*
|
|
2170
|
+
* Organization signup accepted. Returns the generated organization id immediately; provisioning (billing, Keycloak realm, user) continues asynchronously in the background.
|
|
2171
|
+
*
|
|
1115
2172
|
*/
|
|
1116
|
-
200:
|
|
2173
|
+
200: OrganizationCreateOutput;
|
|
1117
2174
|
};
|
|
1118
|
-
export type
|
|
1119
|
-
export type
|
|
1120
|
-
|
|
2175
|
+
export type CreateOrganizationResponse = CreateOrganizationResponses[keyof CreateOrganizationResponses];
|
|
2176
|
+
export type PostMcpData = {
|
|
2177
|
+
/**
|
|
2178
|
+
* JSON-RPC 2.0 request payload
|
|
2179
|
+
*/
|
|
2180
|
+
body: {
|
|
2181
|
+
jsonrpc?: string;
|
|
2182
|
+
method?: string;
|
|
2183
|
+
id?: string | number;
|
|
2184
|
+
/**
|
|
2185
|
+
* Method-specific parameters
|
|
2186
|
+
*/
|
|
2187
|
+
params?: {
|
|
2188
|
+
[key: string]: unknown;
|
|
2189
|
+
};
|
|
2190
|
+
};
|
|
1121
2191
|
path?: never;
|
|
1122
2192
|
query?: never;
|
|
1123
|
-
url: '/
|
|
2193
|
+
url: '/mcp';
|
|
1124
2194
|
};
|
|
1125
|
-
export type
|
|
2195
|
+
export type PostMcpErrors = {
|
|
1126
2196
|
/**
|
|
1127
2197
|
* Not authenticated
|
|
1128
2198
|
*/
|
|
1129
2199
|
401: unknown;
|
|
1130
2200
|
};
|
|
1131
|
-
export type
|
|
2201
|
+
export type PostMcpResponses = {
|
|
1132
2202
|
/**
|
|
1133
|
-
*
|
|
2203
|
+
* JSON-RPC 2.0 success or error response
|
|
1134
2204
|
*/
|
|
1135
|
-
200:
|
|
1136
|
-
|
|
1137
|
-
|
|
1138
|
-
|
|
1139
|
-
|
|
1140
|
-
|
|
1141
|
-
|
|
1142
|
-
|
|
1143
|
-
|
|
2205
|
+
200: {
|
|
2206
|
+
jsonrpc?: string;
|
|
2207
|
+
id?: string | number;
|
|
2208
|
+
result?: {
|
|
2209
|
+
[key: string]: unknown;
|
|
2210
|
+
};
|
|
2211
|
+
error?: {
|
|
2212
|
+
code?: number;
|
|
2213
|
+
message?: string;
|
|
2214
|
+
};
|
|
1144
2215
|
};
|
|
2216
|
+
};
|
|
2217
|
+
export type PostMcpResponse = PostMcpResponses[keyof PostMcpResponses];
|
|
2218
|
+
export type ListMarketplaceChartsData = {
|
|
2219
|
+
body?: never;
|
|
1145
2220
|
path?: never;
|
|
1146
2221
|
query?: never;
|
|
1147
|
-
url: '/
|
|
2222
|
+
url: '/marketplace';
|
|
1148
2223
|
};
|
|
1149
|
-
export type
|
|
2224
|
+
export type ListMarketplaceChartsErrors = {
|
|
1150
2225
|
/**
|
|
1151
2226
|
* Not authenticated
|
|
1152
2227
|
*/
|
|
1153
2228
|
401: unknown;
|
|
1154
2229
|
};
|
|
1155
|
-
export type
|
|
2230
|
+
export type ListMarketplaceChartsResponses = {
|
|
1156
2231
|
/**
|
|
1157
|
-
*
|
|
2232
|
+
* An array of chart listings in the marketplace.
|
|
1158
2233
|
*/
|
|
1159
|
-
200:
|
|
2234
|
+
200: Array<MarketplaceListing>;
|
|
1160
2235
|
};
|
|
1161
|
-
export type
|
|
2236
|
+
export type ListMarketplaceChartsResponse = ListMarketplaceChartsResponses[keyof ListMarketplaceChartsResponses];
|
|
2237
|
+
export type GetMarketplaceChartFilesData = {
|
|
1162
2238
|
body?: never;
|
|
1163
2239
|
path: {
|
|
1164
2240
|
/**
|
|
1165
|
-
*
|
|
2241
|
+
* Name of the chart in the marketplace.
|
|
1166
2242
|
*/
|
|
1167
|
-
|
|
2243
|
+
chart_name: string;
|
|
2244
|
+
/**
|
|
2245
|
+
* Version channel pattern to match (e.g., "1.31.x-cfke.x" for latest 1.31 patch, "1.x.x-cfke.x" for latest 1.x minor).
|
|
2246
|
+
*/
|
|
2247
|
+
version_channel: string;
|
|
1168
2248
|
};
|
|
1169
2249
|
query?: never;
|
|
1170
|
-
url: '/
|
|
2250
|
+
url: '/marketplace/{chart_name}/files/{version_channel}';
|
|
1171
2251
|
};
|
|
1172
|
-
export type
|
|
2252
|
+
export type GetMarketplaceChartFilesErrors = {
|
|
2253
|
+
/**
|
|
2254
|
+
* Chart not found or no version matches the channel
|
|
2255
|
+
*/
|
|
2256
|
+
404: unknown;
|
|
2257
|
+
};
|
|
2258
|
+
export type GetMarketplaceChartFilesResponses = {
|
|
2259
|
+
/**
|
|
2260
|
+
* Returns an object containing the chart files for the latest matching version.
|
|
2261
|
+
*/
|
|
2262
|
+
200: MarketplaceListingFiles;
|
|
2263
|
+
};
|
|
2264
|
+
export type GetMarketplaceChartFilesResponse = GetMarketplaceChartFilesResponses[keyof GetMarketplaceChartFilesResponses];
|
|
2265
|
+
export type ListInvitesData = {
|
|
2266
|
+
body?: never;
|
|
2267
|
+
path?: never;
|
|
2268
|
+
query?: never;
|
|
2269
|
+
url: '/invites';
|
|
2270
|
+
};
|
|
2271
|
+
export type ListInvitesErrors = {
|
|
1173
2272
|
/**
|
|
1174
2273
|
* Not authenticated
|
|
1175
2274
|
*/
|
|
1176
2275
|
401: unknown;
|
|
1177
2276
|
};
|
|
1178
|
-
export type
|
|
2277
|
+
export type ListInvitesResponses = {
|
|
1179
2278
|
/**
|
|
1180
|
-
* An array of
|
|
2279
|
+
* An array of invites
|
|
1181
2280
|
*/
|
|
1182
|
-
200: Array<
|
|
2281
|
+
200: Array<Invite>;
|
|
1183
2282
|
};
|
|
1184
|
-
export type
|
|
1185
|
-
export type
|
|
1186
|
-
body:
|
|
1187
|
-
path
|
|
1188
|
-
/**
|
|
1189
|
-
* Unique identifier of the cluster. UUID v4 string in canonical form
|
|
1190
|
-
*/
|
|
1191
|
-
cluster_id: string;
|
|
1192
|
-
};
|
|
2283
|
+
export type ListInvitesResponse = ListInvitesResponses[keyof ListInvitesResponses];
|
|
2284
|
+
export type CreateInviteData = {
|
|
2285
|
+
body: InviteCreateInput;
|
|
2286
|
+
path?: never;
|
|
1193
2287
|
query?: never;
|
|
1194
|
-
url: '/
|
|
2288
|
+
url: '/invites';
|
|
1195
2289
|
};
|
|
1196
|
-
export type
|
|
2290
|
+
export type CreateInviteResponses = {
|
|
1197
2291
|
/**
|
|
1198
|
-
* Successfully created. Returns created
|
|
2292
|
+
* Successfully created. Returns created invite details.
|
|
1199
2293
|
*/
|
|
1200
|
-
200:
|
|
2294
|
+
200: Invite;
|
|
1201
2295
|
};
|
|
1202
|
-
export type
|
|
1203
|
-
export type
|
|
2296
|
+
export type CreateInviteResponse = CreateInviteResponses[keyof CreateInviteResponses];
|
|
2297
|
+
export type GetInviteData = {
|
|
1204
2298
|
body?: never;
|
|
1205
2299
|
path: {
|
|
1206
2300
|
/**
|
|
1207
|
-
*
|
|
1208
|
-
*/
|
|
1209
|
-
cluster_id: string;
|
|
1210
|
-
/**
|
|
1211
|
-
* Chart deployment name as the unique identifier of the chart.
|
|
2301
|
+
* Invitation code
|
|
1212
2302
|
*/
|
|
1213
|
-
|
|
2303
|
+
code: string;
|
|
1214
2304
|
};
|
|
1215
2305
|
query?: never;
|
|
1216
|
-
url: '/
|
|
2306
|
+
url: '/invites/{code}';
|
|
1217
2307
|
};
|
|
1218
|
-
export type
|
|
2308
|
+
export type GetInviteResponses = {
|
|
1219
2309
|
/**
|
|
1220
|
-
*
|
|
2310
|
+
* The invitation code is valid. Returns the invited email and organization.
|
|
1221
2311
|
*/
|
|
1222
|
-
200:
|
|
2312
|
+
200: {
|
|
2313
|
+
/**
|
|
2314
|
+
* Email address the invite was issued to.
|
|
2315
|
+
*/
|
|
2316
|
+
email?: string;
|
|
2317
|
+
/**
|
|
2318
|
+
* Identifier of the organization the invite grants access to.
|
|
2319
|
+
*/
|
|
2320
|
+
organization_id?: string;
|
|
2321
|
+
};
|
|
1223
2322
|
};
|
|
1224
|
-
export type
|
|
1225
|
-
export type
|
|
2323
|
+
export type GetInviteResponse = GetInviteResponses[keyof GetInviteResponses];
|
|
2324
|
+
export type DeleteInviteData = {
|
|
1226
2325
|
body?: never;
|
|
1227
2326
|
path: {
|
|
1228
2327
|
/**
|
|
1229
|
-
*
|
|
1230
|
-
*/
|
|
1231
|
-
cluster_id: string;
|
|
1232
|
-
/**
|
|
1233
|
-
* Chart deployment name as the unique identifier of the chart.
|
|
2328
|
+
* User email address
|
|
1234
2329
|
*/
|
|
1235
|
-
|
|
2330
|
+
email: string;
|
|
1236
2331
|
};
|
|
1237
2332
|
query?: never;
|
|
1238
|
-
url: '/
|
|
2333
|
+
url: '/invites/{email}';
|
|
1239
2334
|
};
|
|
1240
|
-
export type
|
|
2335
|
+
export type DeleteInviteResponses = {
|
|
1241
2336
|
/**
|
|
1242
|
-
*
|
|
2337
|
+
* Successfully deleted.
|
|
1243
2338
|
*/
|
|
1244
|
-
200:
|
|
2339
|
+
200: unknown;
|
|
1245
2340
|
};
|
|
1246
|
-
export type
|
|
1247
|
-
|
|
1248
|
-
body: ChartUpdateInput;
|
|
2341
|
+
export type QueryClusterData = {
|
|
2342
|
+
body?: never;
|
|
1249
2343
|
path: {
|
|
1250
2344
|
/**
|
|
1251
2345
|
* Unique identifier of the cluster. UUID v4 string in canonical form
|
|
1252
2346
|
*/
|
|
1253
2347
|
cluster_id: string;
|
|
1254
|
-
/**
|
|
1255
|
-
* Chart deployment name as the unique identifier of the chart.
|
|
1256
|
-
*/
|
|
1257
|
-
chart_name: string;
|
|
1258
2348
|
};
|
|
1259
2349
|
query?: never;
|
|
1260
|
-
url: '/clusters/{cluster_id}/
|
|
2350
|
+
url: '/clusters/{cluster_id}/query';
|
|
1261
2351
|
};
|
|
1262
|
-
export type
|
|
2352
|
+
export type QueryClusterErrors = {
|
|
1263
2353
|
/**
|
|
1264
|
-
*
|
|
2354
|
+
* Not authenticated
|
|
1265
2355
|
*/
|
|
1266
|
-
|
|
2356
|
+
401: unknown;
|
|
2357
|
+
};
|
|
2358
|
+
export type QueryClusterResponses = {
|
|
2359
|
+
/**
|
|
2360
|
+
* Kubernetes API response
|
|
2361
|
+
*/
|
|
2362
|
+
200: unknown;
|
|
1267
2363
|
};
|
|
1268
|
-
export type UpdateChartResponse = UpdateChartResponses[keyof UpdateChartResponses];
|
|
1269
2364
|
export type ListFleetsData = {
|
|
1270
2365
|
body?: never;
|
|
1271
2366
|
path: {
|
|
@@ -1306,6 +2401,10 @@ export type CreateFleetErrors = {
|
|
|
1306
2401
|
* Cluster quota exceeded. Maximum number of fleets per cluster allowed in this organization is reached.
|
|
1307
2402
|
*/
|
|
1308
2403
|
402: string;
|
|
2404
|
+
/**
|
|
2405
|
+
* The cluster cannot service this operation: it is still being created, or it is suspended. Retry once it is ready, or resume the cluster first.
|
|
2406
|
+
*/
|
|
2407
|
+
409: string;
|
|
1309
2408
|
};
|
|
1310
2409
|
export type CreateFleetError = CreateFleetErrors[keyof CreateFleetErrors];
|
|
1311
2410
|
export type CreateFleetResponses = {
|
|
@@ -1330,6 +2429,13 @@ export type DeleteFleetData = {
|
|
|
1330
2429
|
query?: never;
|
|
1331
2430
|
url: '/clusters/{cluster_id}/fleets/{fleet_name}';
|
|
1332
2431
|
};
|
|
2432
|
+
export type DeleteFleetErrors = {
|
|
2433
|
+
/**
|
|
2434
|
+
* The cluster cannot service this operation: it is still being created, or it is suspended. Retry once it is ready, or resume the cluster first.
|
|
2435
|
+
*/
|
|
2436
|
+
409: string;
|
|
2437
|
+
};
|
|
2438
|
+
export type DeleteFleetError = DeleteFleetErrors[keyof DeleteFleetErrors];
|
|
1333
2439
|
export type DeleteFleetResponses = {
|
|
1334
2440
|
/**
|
|
1335
2441
|
* Successfully deleted.
|
|
@@ -1379,6 +2485,10 @@ export type UpdateFleetErrors = {
|
|
|
1379
2485
|
* Organization must have a valid payment method configured to access this endpoint.
|
|
1380
2486
|
*/
|
|
1381
2487
|
402: string;
|
|
2488
|
+
/**
|
|
2489
|
+
* The cluster cannot service this operation: it is still being created, or it is suspended. Retry once it is ready, or resume the cluster first.
|
|
2490
|
+
*/
|
|
2491
|
+
409: string;
|
|
1382
2492
|
};
|
|
1383
2493
|
export type UpdateFleetError = UpdateFleetErrors[keyof UpdateFleetErrors];
|
|
1384
2494
|
export type UpdateFleetResponses = {
|
|
@@ -1388,7 +2498,7 @@ export type UpdateFleetResponses = {
|
|
|
1388
2498
|
200: string;
|
|
1389
2499
|
};
|
|
1390
2500
|
export type UpdateFleetResponse = UpdateFleetResponses[keyof UpdateFleetResponses];
|
|
1391
|
-
export type
|
|
2501
|
+
export type ListChartsData = {
|
|
1392
2502
|
body?: never;
|
|
1393
2503
|
path: {
|
|
1394
2504
|
/**
|
|
@@ -1397,528 +2507,516 @@ export type QueryClusterData = {
|
|
|
1397
2507
|
cluster_id: string;
|
|
1398
2508
|
};
|
|
1399
2509
|
query?: never;
|
|
1400
|
-
url: '/clusters/{cluster_id}/
|
|
1401
|
-
};
|
|
1402
|
-
export type QueryClusterErrors = {
|
|
1403
|
-
/**
|
|
1404
|
-
* Not authenticated
|
|
1405
|
-
*/
|
|
1406
|
-
401: unknown;
|
|
1407
|
-
};
|
|
1408
|
-
export type QueryClusterResponses = {
|
|
1409
|
-
/**
|
|
1410
|
-
* Kubernetes API response
|
|
1411
|
-
*/
|
|
1412
|
-
200: unknown;
|
|
1413
|
-
};
|
|
1414
|
-
export type ListClustersData = {
|
|
1415
|
-
body?: never;
|
|
1416
|
-
path?: never;
|
|
1417
|
-
query?: never;
|
|
1418
|
-
url: '/clusters';
|
|
2510
|
+
url: '/clusters/{cluster_id}/charts';
|
|
1419
2511
|
};
|
|
1420
|
-
export type
|
|
2512
|
+
export type ListChartsErrors = {
|
|
1421
2513
|
/**
|
|
1422
2514
|
* Not authenticated
|
|
1423
2515
|
*/
|
|
1424
2516
|
401: unknown;
|
|
1425
2517
|
};
|
|
1426
|
-
export type
|
|
2518
|
+
export type ListChartsResponses = {
|
|
1427
2519
|
/**
|
|
1428
|
-
* An array of
|
|
2520
|
+
* An array of charts
|
|
1429
2521
|
*/
|
|
1430
|
-
200: Array<
|
|
2522
|
+
200: Array<Chart>;
|
|
1431
2523
|
};
|
|
1432
|
-
export type
|
|
1433
|
-
export type
|
|
1434
|
-
body:
|
|
1435
|
-
path
|
|
2524
|
+
export type ListChartsResponse = ListChartsResponses[keyof ListChartsResponses];
|
|
2525
|
+
export type CreateChartData = {
|
|
2526
|
+
body: ChartCreateInput;
|
|
2527
|
+
path: {
|
|
2528
|
+
/**
|
|
2529
|
+
* Unique identifier of the cluster. UUID v4 string in canonical form
|
|
2530
|
+
*/
|
|
2531
|
+
cluster_id: string;
|
|
2532
|
+
};
|
|
1436
2533
|
query?: never;
|
|
1437
|
-
url: '/clusters';
|
|
2534
|
+
url: '/clusters/{cluster_id}/charts';
|
|
1438
2535
|
};
|
|
1439
|
-
export type
|
|
2536
|
+
export type CreateChartErrors = {
|
|
1440
2537
|
/**
|
|
1441
|
-
*
|
|
2538
|
+
* The cluster cannot service this operation: it is still being created, or it is suspended. Retry once it is ready, or resume the cluster first.
|
|
1442
2539
|
*/
|
|
1443
|
-
|
|
2540
|
+
409: string;
|
|
1444
2541
|
};
|
|
1445
|
-
export type
|
|
1446
|
-
export type
|
|
2542
|
+
export type CreateChartError = CreateChartErrors[keyof CreateChartErrors];
|
|
2543
|
+
export type CreateChartResponses = {
|
|
1447
2544
|
/**
|
|
1448
|
-
* Successfully created. Returns created
|
|
2545
|
+
* Successfully created. Returns created Chart ID.
|
|
1449
2546
|
*/
|
|
1450
2547
|
200: string;
|
|
1451
2548
|
};
|
|
1452
|
-
export type
|
|
1453
|
-
export type
|
|
2549
|
+
export type CreateChartResponse = CreateChartResponses[keyof CreateChartResponses];
|
|
2550
|
+
export type DeleteChartData = {
|
|
1454
2551
|
body?: never;
|
|
1455
2552
|
path: {
|
|
1456
2553
|
/**
|
|
1457
2554
|
* Unique identifier of the cluster. UUID v4 string in canonical form
|
|
1458
2555
|
*/
|
|
1459
2556
|
cluster_id: string;
|
|
2557
|
+
/**
|
|
2558
|
+
* Chart deployment name as the unique identifier of the chart.
|
|
2559
|
+
*/
|
|
2560
|
+
chart_name: string;
|
|
1460
2561
|
};
|
|
1461
2562
|
query?: never;
|
|
1462
|
-
url: '/clusters/{cluster_id}';
|
|
2563
|
+
url: '/clusters/{cluster_id}/charts/{chart_name}';
|
|
1463
2564
|
};
|
|
1464
|
-
export type
|
|
2565
|
+
export type DeleteChartErrors = {
|
|
2566
|
+
/**
|
|
2567
|
+
* The cluster cannot service this operation: it is still being created, or it is suspended. Retry once it is ready, or resume the cluster first.
|
|
2568
|
+
*/
|
|
2569
|
+
409: string;
|
|
2570
|
+
};
|
|
2571
|
+
export type DeleteChartError = DeleteChartErrors[keyof DeleteChartErrors];
|
|
2572
|
+
export type DeleteChartResponses = {
|
|
1465
2573
|
/**
|
|
1466
2574
|
* Successfully deleted.
|
|
1467
2575
|
*/
|
|
1468
2576
|
200: string;
|
|
1469
2577
|
};
|
|
1470
|
-
export type
|
|
1471
|
-
export type
|
|
2578
|
+
export type DeleteChartResponse = DeleteChartResponses[keyof DeleteChartResponses];
|
|
2579
|
+
export type GetChartData = {
|
|
1472
2580
|
body?: never;
|
|
1473
2581
|
path: {
|
|
1474
2582
|
/**
|
|
1475
2583
|
* Unique identifier of the cluster. UUID v4 string in canonical form
|
|
1476
2584
|
*/
|
|
1477
2585
|
cluster_id: string;
|
|
1478
|
-
};
|
|
1479
|
-
query?: never;
|
|
1480
|
-
url: '/clusters/{cluster_id}';
|
|
1481
|
-
};
|
|
1482
|
-
export type GetClusterResponses = {
|
|
1483
|
-
/**
|
|
1484
|
-
* Returns a single object containing cluster details.
|
|
1485
|
-
*/
|
|
1486
|
-
200: Cluster;
|
|
1487
|
-
};
|
|
1488
|
-
export type GetClusterResponse = GetClusterResponses[keyof GetClusterResponses];
|
|
1489
|
-
export type UpdateClusterData = {
|
|
1490
|
-
body: ClusterUpdateInput;
|
|
1491
|
-
path: {
|
|
1492
2586
|
/**
|
|
1493
|
-
*
|
|
2587
|
+
* Chart deployment name as the unique identifier of the chart.
|
|
1494
2588
|
*/
|
|
1495
|
-
|
|
2589
|
+
chart_name: string;
|
|
1496
2590
|
};
|
|
1497
2591
|
query?: never;
|
|
1498
|
-
url: '/clusters/{cluster_id}';
|
|
2592
|
+
url: '/clusters/{cluster_id}/charts/{chart_name}';
|
|
1499
2593
|
};
|
|
1500
|
-
export type
|
|
2594
|
+
export type GetChartResponses = {
|
|
1501
2595
|
/**
|
|
1502
|
-
*
|
|
2596
|
+
* Returns a single object containing chart details.
|
|
1503
2597
|
*/
|
|
1504
|
-
200:
|
|
2598
|
+
200: Chart;
|
|
1505
2599
|
};
|
|
1506
|
-
export type
|
|
1507
|
-
export type
|
|
1508
|
-
body
|
|
2600
|
+
export type GetChartResponse = GetChartResponses[keyof GetChartResponses];
|
|
2601
|
+
export type UpdateChartData = {
|
|
2602
|
+
body: ChartUpdateInput;
|
|
1509
2603
|
path: {
|
|
1510
2604
|
/**
|
|
1511
2605
|
* Unique identifier of the cluster. UUID v4 string in canonical form
|
|
1512
2606
|
*/
|
|
1513
2607
|
cluster_id: string;
|
|
2608
|
+
/**
|
|
2609
|
+
* Chart deployment name as the unique identifier of the chart.
|
|
2610
|
+
*/
|
|
2611
|
+
chart_name: string;
|
|
1514
2612
|
};
|
|
1515
2613
|
query?: never;
|
|
1516
|
-
url: '/clusters/{cluster_id}/
|
|
2614
|
+
url: '/clusters/{cluster_id}/charts/{chart_name}';
|
|
1517
2615
|
};
|
|
1518
|
-
export type
|
|
2616
|
+
export type UpdateChartErrors = {
|
|
1519
2617
|
/**
|
|
1520
|
-
*
|
|
2618
|
+
* The cluster cannot service this operation: it is still being created, or it is suspended. Retry once it is ready, or resume the cluster first.
|
|
1521
2619
|
*/
|
|
1522
|
-
|
|
2620
|
+
409: string;
|
|
1523
2621
|
};
|
|
1524
|
-
export type
|
|
2622
|
+
export type UpdateChartError = UpdateChartErrors[keyof UpdateChartErrors];
|
|
2623
|
+
export type UpdateChartResponses = {
|
|
1525
2624
|
/**
|
|
1526
|
-
*
|
|
2625
|
+
* Successfully updated.
|
|
1527
2626
|
*/
|
|
1528
|
-
200:
|
|
2627
|
+
200: string;
|
|
1529
2628
|
};
|
|
1530
|
-
export type
|
|
1531
|
-
export type
|
|
2629
|
+
export type UpdateChartResponse = UpdateChartResponses[keyof UpdateChartResponses];
|
|
2630
|
+
export type ListClustersData = {
|
|
1532
2631
|
body?: never;
|
|
1533
2632
|
path?: never;
|
|
1534
2633
|
query?: never;
|
|
1535
|
-
url: '/
|
|
2634
|
+
url: '/clusters';
|
|
1536
2635
|
};
|
|
1537
|
-
export type
|
|
2636
|
+
export type ListClustersErrors = {
|
|
1538
2637
|
/**
|
|
1539
2638
|
* Not authenticated
|
|
1540
2639
|
*/
|
|
1541
2640
|
401: unknown;
|
|
1542
2641
|
};
|
|
1543
|
-
export type
|
|
2642
|
+
export type ListClustersResponses = {
|
|
1544
2643
|
/**
|
|
1545
|
-
* An array of
|
|
2644
|
+
* An array of clusters
|
|
1546
2645
|
*/
|
|
1547
|
-
200: Array<
|
|
2646
|
+
200: Array<Cluster>;
|
|
1548
2647
|
};
|
|
1549
|
-
export type
|
|
1550
|
-
export type
|
|
1551
|
-
body:
|
|
1552
|
-
/**
|
|
1553
|
-
* User email address
|
|
1554
|
-
*/
|
|
1555
|
-
email?: string;
|
|
1556
|
-
};
|
|
2648
|
+
export type ListClustersResponse = ListClustersResponses[keyof ListClustersResponses];
|
|
2649
|
+
export type CreateClusterData = {
|
|
2650
|
+
body: ClusterCreateInput;
|
|
1557
2651
|
path?: never;
|
|
1558
2652
|
query?: never;
|
|
1559
|
-
url: '/
|
|
2653
|
+
url: '/clusters';
|
|
1560
2654
|
};
|
|
1561
|
-
export type
|
|
2655
|
+
export type CreateClusterErrors = {
|
|
1562
2656
|
/**
|
|
1563
|
-
*
|
|
2657
|
+
* Cluster quota exceeded. Maximum number of clusters allowed in this organization is reached.
|
|
1564
2658
|
*/
|
|
1565
|
-
|
|
1566
|
-
};
|
|
1567
|
-
export type CreateInviteResponse = CreateInviteResponses[keyof CreateInviteResponses];
|
|
1568
|
-
export type GetInviteData = {
|
|
1569
|
-
body?: never;
|
|
1570
|
-
path: {
|
|
1571
|
-
/**
|
|
1572
|
-
* Invitation code
|
|
1573
|
-
*/
|
|
1574
|
-
code: string;
|
|
1575
|
-
};
|
|
1576
|
-
query?: never;
|
|
1577
|
-
url: '/invites/{code}';
|
|
2659
|
+
402: string;
|
|
1578
2660
|
};
|
|
1579
|
-
export type
|
|
2661
|
+
export type CreateClusterError = CreateClusterErrors[keyof CreateClusterErrors];
|
|
2662
|
+
export type CreateClusterResponses = {
|
|
1580
2663
|
/**
|
|
1581
|
-
*
|
|
2664
|
+
* Successfully created. Returns created Cluster ID.
|
|
1582
2665
|
*/
|
|
1583
|
-
200:
|
|
2666
|
+
200: string;
|
|
1584
2667
|
};
|
|
1585
|
-
export type
|
|
1586
|
-
export type
|
|
2668
|
+
export type CreateClusterResponse = CreateClusterResponses[keyof CreateClusterResponses];
|
|
2669
|
+
export type DeleteClusterData = {
|
|
1587
2670
|
body?: never;
|
|
1588
2671
|
path: {
|
|
1589
2672
|
/**
|
|
1590
|
-
*
|
|
2673
|
+
* Unique identifier of the cluster. UUID v4 string in canonical form
|
|
1591
2674
|
*/
|
|
1592
|
-
|
|
2675
|
+
cluster_id: string;
|
|
1593
2676
|
};
|
|
1594
2677
|
query?: never;
|
|
1595
|
-
url: '/
|
|
2678
|
+
url: '/clusters/{cluster_id}';
|
|
1596
2679
|
};
|
|
1597
|
-
export type
|
|
2680
|
+
export type DeleteClusterErrors = {
|
|
1598
2681
|
/**
|
|
1599
|
-
*
|
|
2682
|
+
* Cluster not found; it does not exist or has already been deleted.
|
|
1600
2683
|
*/
|
|
1601
|
-
|
|
1602
|
-
};
|
|
1603
|
-
export type ListMarketplaceChartsData = {
|
|
1604
|
-
body?: never;
|
|
1605
|
-
path?: never;
|
|
1606
|
-
query?: never;
|
|
1607
|
-
url: '/marketplace';
|
|
1608
|
-
};
|
|
1609
|
-
export type ListMarketplaceChartsErrors = {
|
|
2684
|
+
404: unknown;
|
|
1610
2685
|
/**
|
|
1611
|
-
*
|
|
2686
|
+
* The cluster cannot service this operation: it is still being created, or it is suspended. Retry once it is ready, or resume the cluster first.
|
|
1612
2687
|
*/
|
|
1613
|
-
|
|
2688
|
+
409: string;
|
|
2689
|
+
/**
|
|
2690
|
+
* Transient failure tearing down the cluster; retry the request.
|
|
2691
|
+
*/
|
|
2692
|
+
503: unknown;
|
|
1614
2693
|
};
|
|
1615
|
-
export type
|
|
2694
|
+
export type DeleteClusterError = DeleteClusterErrors[keyof DeleteClusterErrors];
|
|
2695
|
+
export type DeleteClusterResponses = {
|
|
1616
2696
|
/**
|
|
1617
|
-
*
|
|
2697
|
+
* Successfully deleted. The cluster has been torn down.
|
|
1618
2698
|
*/
|
|
1619
|
-
200:
|
|
2699
|
+
200: string;
|
|
1620
2700
|
};
|
|
1621
|
-
export type
|
|
1622
|
-
export type
|
|
2701
|
+
export type DeleteClusterResponse = DeleteClusterResponses[keyof DeleteClusterResponses];
|
|
2702
|
+
export type GetClusterData = {
|
|
1623
2703
|
body?: never;
|
|
1624
2704
|
path: {
|
|
1625
2705
|
/**
|
|
1626
|
-
* Unique identifier of the
|
|
2706
|
+
* Unique identifier of the cluster. UUID v4 string in canonical form
|
|
1627
2707
|
*/
|
|
1628
|
-
|
|
2708
|
+
cluster_id: string;
|
|
1629
2709
|
};
|
|
1630
2710
|
query?: never;
|
|
1631
|
-
url: '/
|
|
2711
|
+
url: '/clusters/{cluster_id}';
|
|
1632
2712
|
};
|
|
1633
|
-
export type
|
|
2713
|
+
export type GetClusterResponses = {
|
|
1634
2714
|
/**
|
|
1635
|
-
* Returns
|
|
2715
|
+
* Returns a single object containing cluster details.
|
|
1636
2716
|
*/
|
|
1637
|
-
200:
|
|
2717
|
+
200: Cluster;
|
|
1638
2718
|
};
|
|
1639
|
-
export type
|
|
1640
|
-
export type
|
|
1641
|
-
body
|
|
1642
|
-
path
|
|
2719
|
+
export type GetClusterResponse = GetClusterResponses[keyof GetClusterResponses];
|
|
2720
|
+
export type UpdateClusterData = {
|
|
2721
|
+
body: ClusterUpdateInput;
|
|
2722
|
+
path: {
|
|
2723
|
+
/**
|
|
2724
|
+
* Unique identifier of the cluster. UUID v4 string in canonical form
|
|
2725
|
+
*/
|
|
2726
|
+
cluster_id: string;
|
|
2727
|
+
};
|
|
1643
2728
|
query?: never;
|
|
1644
|
-
url: '/
|
|
2729
|
+
url: '/clusters/{cluster_id}';
|
|
1645
2730
|
};
|
|
1646
|
-
export type
|
|
2731
|
+
export type UpdateClusterErrors = {
|
|
1647
2732
|
/**
|
|
1648
|
-
*
|
|
2733
|
+
* The cluster cannot service this operation: it is still being created, or it is suspended. Retry once it is ready, or resume the cluster first.
|
|
1649
2734
|
*/
|
|
1650
|
-
|
|
1651
|
-
};
|
|
1652
|
-
export type GetOrganizationResponse = GetOrganizationResponses[keyof GetOrganizationResponses];
|
|
1653
|
-
export type CreateOrganizationData = {
|
|
1654
|
-
body: OrganizationCreateInput;
|
|
1655
|
-
path?: never;
|
|
1656
|
-
query?: never;
|
|
1657
|
-
url: '/organization';
|
|
2735
|
+
409: string;
|
|
1658
2736
|
};
|
|
1659
|
-
export type
|
|
2737
|
+
export type UpdateClusterError = UpdateClusterErrors[keyof UpdateClusterErrors];
|
|
2738
|
+
export type UpdateClusterResponses = {
|
|
1660
2739
|
/**
|
|
1661
|
-
* Successfully
|
|
2740
|
+
* Successfully updated. Returns updated cluster details.
|
|
1662
2741
|
*/
|
|
1663
|
-
200:
|
|
2742
|
+
200: Cluster;
|
|
1664
2743
|
};
|
|
1665
|
-
export type
|
|
2744
|
+
export type UpdateClusterResponse = UpdateClusterResponses[keyof UpdateClusterResponses];
|
|
2745
|
+
export type GetJoinInformationData = {
|
|
1666
2746
|
body?: never;
|
|
1667
|
-
path
|
|
2747
|
+
path: {
|
|
2748
|
+
/**
|
|
2749
|
+
* Unique identifier of the cluster. UUID v4 string in canonical form
|
|
2750
|
+
*/
|
|
2751
|
+
cluster_id: string;
|
|
2752
|
+
};
|
|
1668
2753
|
query?: never;
|
|
1669
|
-
url: '/
|
|
2754
|
+
url: '/clusters/{cluster_id}/join_information';
|
|
1670
2755
|
};
|
|
1671
|
-
export type
|
|
2756
|
+
export type GetJoinInformationErrors = {
|
|
1672
2757
|
/**
|
|
1673
2758
|
* Not authenticated
|
|
1674
2759
|
*/
|
|
1675
2760
|
401: unknown;
|
|
2761
|
+
/**
|
|
2762
|
+
* The cluster cannot service this operation: it is still being created, or it is suspended. Retry once it is ready, or resume the cluster first.
|
|
2763
|
+
*/
|
|
2764
|
+
409: string;
|
|
2765
|
+
/**
|
|
2766
|
+
* The cluster runs on Cloudfleet data plane v2 and the calling client did not declare the dataplane-v2 capability, so it cannot provision a node for it. Upgrade the Cloudfleet CLI or Terraform provider.
|
|
2767
|
+
*/
|
|
2768
|
+
426: string;
|
|
1676
2769
|
};
|
|
1677
|
-
export type
|
|
2770
|
+
export type GetJoinInformationError = GetJoinInformationErrors[keyof GetJoinInformationErrors];
|
|
2771
|
+
export type GetJoinInformationResponses = {
|
|
1678
2772
|
/**
|
|
1679
|
-
*
|
|
2773
|
+
* An object of cluster join information
|
|
1680
2774
|
*/
|
|
1681
|
-
200:
|
|
2775
|
+
200: ClusterJoinInformation;
|
|
1682
2776
|
};
|
|
1683
|
-
export type
|
|
1684
|
-
export type
|
|
1685
|
-
body
|
|
2777
|
+
export type GetJoinInformationResponse = GetJoinInformationResponses[keyof GetJoinInformationResponses];
|
|
2778
|
+
export type GetUsageData = {
|
|
2779
|
+
body?: never;
|
|
1686
2780
|
path?: never;
|
|
1687
|
-
query?:
|
|
1688
|
-
|
|
2781
|
+
query?: {
|
|
2782
|
+
/**
|
|
2783
|
+
* Time granularity for usage aggregation - hourly (Past 48 hours aggregated by hour), daily (Past 30 days aggregated by day), monthly (Past 12 months aggregated by month)
|
|
2784
|
+
*/
|
|
2785
|
+
granularity?: 'hourly' | 'daily' | 'monthly';
|
|
2786
|
+
};
|
|
2787
|
+
url: '/billing/usage';
|
|
1689
2788
|
};
|
|
1690
|
-
export type
|
|
2789
|
+
export type GetUsageErrors = {
|
|
1691
2790
|
/**
|
|
1692
2791
|
* Not authenticated
|
|
1693
2792
|
*/
|
|
1694
2793
|
401: unknown;
|
|
1695
2794
|
};
|
|
1696
|
-
export type
|
|
2795
|
+
export type GetUsageResponses = {
|
|
1697
2796
|
/**
|
|
1698
|
-
*
|
|
2797
|
+
* Usage data with facets for filtering
|
|
1699
2798
|
*/
|
|
1700
|
-
200:
|
|
2799
|
+
200: UsageResponse;
|
|
1701
2800
|
};
|
|
1702
|
-
export type
|
|
1703
|
-
export type
|
|
2801
|
+
export type GetUsageResponse = GetUsageResponses[keyof GetUsageResponses];
|
|
2802
|
+
export type GetPaymentMethodSecretData = {
|
|
1704
2803
|
body?: never;
|
|
1705
|
-
path
|
|
1706
|
-
/**
|
|
1707
|
-
* Generated unique identifier of the access token.
|
|
1708
|
-
*/
|
|
1709
|
-
token_id: string;
|
|
1710
|
-
};
|
|
2804
|
+
path?: never;
|
|
1711
2805
|
query?: never;
|
|
1712
|
-
url: '/
|
|
2806
|
+
url: '/billing/payment-method';
|
|
1713
2807
|
};
|
|
1714
|
-
export type
|
|
2808
|
+
export type GetPaymentMethodSecretResponses = {
|
|
1715
2809
|
/**
|
|
1716
|
-
*
|
|
2810
|
+
* 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.
|
|
2811
|
+
*
|
|
1717
2812
|
*/
|
|
1718
|
-
200:
|
|
1719
|
-
};
|
|
1720
|
-
export type GetTokenData = {
|
|
1721
|
-
body?: never;
|
|
1722
|
-
path: {
|
|
2813
|
+
200: {
|
|
1723
2814
|
/**
|
|
1724
|
-
*
|
|
2815
|
+
* The client secret.
|
|
1725
2816
|
*/
|
|
1726
|
-
|
|
2817
|
+
id?: string;
|
|
1727
2818
|
};
|
|
2819
|
+
};
|
|
2820
|
+
export type GetPaymentMethodSecretResponse = GetPaymentMethodSecretResponses[keyof GetPaymentMethodSecretResponses];
|
|
2821
|
+
export type ListPaymentMethodsData = {
|
|
2822
|
+
body?: never;
|
|
2823
|
+
path?: never;
|
|
1728
2824
|
query?: never;
|
|
1729
|
-
url: '/
|
|
2825
|
+
url: '/billing/payment-methods';
|
|
1730
2826
|
};
|
|
1731
|
-
export type
|
|
2827
|
+
export type ListPaymentMethodsErrors = {
|
|
1732
2828
|
/**
|
|
1733
2829
|
* Not authenticated
|
|
1734
2830
|
*/
|
|
1735
2831
|
401: unknown;
|
|
1736
2832
|
};
|
|
1737
|
-
export type
|
|
2833
|
+
export type ListPaymentMethodsResponses = {
|
|
1738
2834
|
/**
|
|
1739
|
-
*
|
|
2835
|
+
* An array of payment methods.
|
|
1740
2836
|
*/
|
|
1741
|
-
200:
|
|
2837
|
+
200: Array<PaymentMethod>;
|
|
1742
2838
|
};
|
|
1743
|
-
export type
|
|
1744
|
-
export type
|
|
1745
|
-
body
|
|
2839
|
+
export type ListPaymentMethodsResponse = ListPaymentMethodsResponses[keyof ListPaymentMethodsResponses];
|
|
2840
|
+
export type SetDefaultPaymentMethodData = {
|
|
2841
|
+
body?: never;
|
|
1746
2842
|
path: {
|
|
1747
2843
|
/**
|
|
1748
|
-
*
|
|
2844
|
+
* Stripe payment method identifier.
|
|
1749
2845
|
*/
|
|
1750
|
-
|
|
2846
|
+
paymentMethodId: string;
|
|
1751
2847
|
};
|
|
1752
2848
|
query?: never;
|
|
1753
|
-
url: '/
|
|
2849
|
+
url: '/billing/payment-methods/{paymentMethodId}/default';
|
|
1754
2850
|
};
|
|
1755
|
-
export type
|
|
2851
|
+
export type SetDefaultPaymentMethodErrors = {
|
|
2852
|
+
/**
|
|
2853
|
+
* The bank transfer payment method cannot be set as the default.
|
|
2854
|
+
*/
|
|
2855
|
+
400: unknown;
|
|
1756
2856
|
/**
|
|
1757
2857
|
* Not authenticated
|
|
1758
2858
|
*/
|
|
1759
2859
|
401: unknown;
|
|
2860
|
+
/**
|
|
2861
|
+
* Payment method not found.
|
|
2862
|
+
*/
|
|
2863
|
+
404: unknown;
|
|
1760
2864
|
};
|
|
1761
|
-
export type
|
|
2865
|
+
export type SetDefaultPaymentMethodResponses = {
|
|
1762
2866
|
/**
|
|
1763
|
-
*
|
|
2867
|
+
* Default payment method updated.
|
|
1764
2868
|
*/
|
|
1765
|
-
|
|
2869
|
+
204: void;
|
|
1766
2870
|
};
|
|
1767
|
-
export type
|
|
1768
|
-
export type
|
|
2871
|
+
export type SetDefaultPaymentMethodResponse = SetDefaultPaymentMethodResponses[keyof SetDefaultPaymentMethodResponses];
|
|
2872
|
+
export type DeletePaymentMethodData = {
|
|
1769
2873
|
body?: never;
|
|
1770
2874
|
path: {
|
|
1771
2875
|
/**
|
|
1772
|
-
*
|
|
2876
|
+
* Stripe payment method identifier.
|
|
1773
2877
|
*/
|
|
1774
|
-
|
|
2878
|
+
paymentMethodId: string;
|
|
1775
2879
|
};
|
|
1776
2880
|
query?: never;
|
|
1777
|
-
url: '/
|
|
2881
|
+
url: '/billing/payment-methods/{paymentMethodId}';
|
|
1778
2882
|
};
|
|
1779
|
-
export type
|
|
2883
|
+
export type DeletePaymentMethodErrors = {
|
|
2884
|
+
/**
|
|
2885
|
+
* The bank transfer payment method cannot be removed.
|
|
2886
|
+
*/
|
|
2887
|
+
400: unknown;
|
|
1780
2888
|
/**
|
|
1781
2889
|
* Not authenticated
|
|
1782
2890
|
*/
|
|
1783
2891
|
401: unknown;
|
|
1784
|
-
};
|
|
1785
|
-
export type RegenerateTokenResponses = {
|
|
1786
2892
|
/**
|
|
1787
|
-
*
|
|
2893
|
+
* Payment method not found.
|
|
1788
2894
|
*/
|
|
1789
|
-
|
|
1790
|
-
|
|
1791
|
-
|
|
1792
|
-
|
|
1793
|
-
|
|
1794
|
-
path: {
|
|
1795
|
-
/**
|
|
1796
|
-
* User email address.
|
|
1797
|
-
*/
|
|
1798
|
-
email: string;
|
|
1799
|
-
};
|
|
1800
|
-
query?: never;
|
|
1801
|
-
url: '/users/organizations/{email}';
|
|
2895
|
+
404: unknown;
|
|
2896
|
+
/**
|
|
2897
|
+
* Cannot delete the only remaining payment method.
|
|
2898
|
+
*/
|
|
2899
|
+
409: unknown;
|
|
1802
2900
|
};
|
|
1803
|
-
export type
|
|
2901
|
+
export type DeletePaymentMethodResponses = {
|
|
1804
2902
|
/**
|
|
1805
|
-
*
|
|
2903
|
+
* Payment method deleted.
|
|
1806
2904
|
*/
|
|
1807
|
-
|
|
1808
|
-
/**
|
|
1809
|
-
* Unique identifier of the organization. UUID v4 string in canonical form
|
|
1810
|
-
*/
|
|
1811
|
-
realm?: string;
|
|
1812
|
-
/**
|
|
1813
|
-
* Human-readable name of the organization
|
|
1814
|
-
*/
|
|
1815
|
-
displayName?: string;
|
|
1816
|
-
}>;
|
|
2905
|
+
204: void;
|
|
1817
2906
|
};
|
|
1818
|
-
export type
|
|
1819
|
-
export type
|
|
2907
|
+
export type DeletePaymentMethodResponse = DeletePaymentMethodResponses[keyof DeletePaymentMethodResponses];
|
|
2908
|
+
export type ListInvoicesData = {
|
|
1820
2909
|
body?: never;
|
|
1821
2910
|
path?: never;
|
|
1822
2911
|
query?: never;
|
|
1823
|
-
url: '/
|
|
2912
|
+
url: '/billing/invoices';
|
|
1824
2913
|
};
|
|
1825
|
-
export type
|
|
2914
|
+
export type ListInvoicesErrors = {
|
|
1826
2915
|
/**
|
|
1827
2916
|
* Not authenticated
|
|
1828
2917
|
*/
|
|
1829
2918
|
401: unknown;
|
|
1830
2919
|
};
|
|
1831
|
-
export type
|
|
2920
|
+
export type ListInvoicesResponses = {
|
|
1832
2921
|
/**
|
|
1833
|
-
* An array of
|
|
2922
|
+
* An array of usage records.
|
|
1834
2923
|
*/
|
|
1835
|
-
200: Array<
|
|
2924
|
+
200: Array<Invoice>;
|
|
1836
2925
|
};
|
|
1837
|
-
export type
|
|
1838
|
-
export type
|
|
1839
|
-
body
|
|
2926
|
+
export type ListInvoicesResponse = ListInvoicesResponses[keyof ListInvoicesResponses];
|
|
2927
|
+
export type PayOpenInvoicesData = {
|
|
2928
|
+
body?: never;
|
|
1840
2929
|
path?: never;
|
|
1841
2930
|
query?: never;
|
|
1842
|
-
url: '/
|
|
2931
|
+
url: '/billing/invoices/pay';
|
|
1843
2932
|
};
|
|
1844
|
-
export type
|
|
2933
|
+
export type PayOpenInvoicesErrors = {
|
|
1845
2934
|
/**
|
|
1846
|
-
*
|
|
2935
|
+
* The organization has no payment method that can be charged.
|
|
1847
2936
|
*/
|
|
1848
|
-
|
|
2937
|
+
400: unknown;
|
|
2938
|
+
/**
|
|
2939
|
+
* Not authenticated
|
|
2940
|
+
*/
|
|
2941
|
+
401: unknown;
|
|
2942
|
+
/**
|
|
2943
|
+
* Too many payment attempts for this organization.
|
|
2944
|
+
*/
|
|
2945
|
+
429: unknown;
|
|
1849
2946
|
};
|
|
1850
|
-
export type
|
|
1851
|
-
|
|
2947
|
+
export type PayOpenInvoicesResponses = {
|
|
2948
|
+
/**
|
|
2949
|
+
* The outcome of the attempt.
|
|
2950
|
+
*/
|
|
2951
|
+
200: InvoicePaymentResult;
|
|
2952
|
+
};
|
|
2953
|
+
export type PayOpenInvoicesResponse = PayOpenInvoicesResponses[keyof PayOpenInvoicesResponses];
|
|
2954
|
+
export type GetContactData = {
|
|
1852
2955
|
body?: never;
|
|
1853
|
-
path
|
|
1854
|
-
/**
|
|
1855
|
-
* Unique user identifier. UUID v4 string in canonical form
|
|
1856
|
-
*/
|
|
1857
|
-
user_id: string;
|
|
1858
|
-
};
|
|
2956
|
+
path?: never;
|
|
1859
2957
|
query?: never;
|
|
1860
|
-
url: '/
|
|
2958
|
+
url: '/billing/contact';
|
|
1861
2959
|
};
|
|
1862
|
-
export type
|
|
1863
|
-
/**
|
|
1864
|
-
* Deleting own user is not allowed. Delete your organization instead.
|
|
1865
|
-
*/
|
|
1866
|
-
400: unknown;
|
|
2960
|
+
export type GetContactResponses = {
|
|
1867
2961
|
/**
|
|
1868
|
-
*
|
|
2962
|
+
* Returns a single object containing organization contact and billing address details.
|
|
1869
2963
|
*/
|
|
1870
|
-
|
|
2964
|
+
200: BillingContact;
|
|
1871
2965
|
};
|
|
1872
|
-
export type
|
|
2966
|
+
export type GetContactResponse = GetContactResponses[keyof GetContactResponses];
|
|
2967
|
+
export type UpdateContactData = {
|
|
2968
|
+
body: BillingContact;
|
|
2969
|
+
path?: never;
|
|
2970
|
+
query?: never;
|
|
2971
|
+
url: '/billing/contact';
|
|
2972
|
+
};
|
|
2973
|
+
export type UpdateContactResponses = {
|
|
1873
2974
|
/**
|
|
1874
|
-
*
|
|
2975
|
+
* Successfully updated. Returns updated organization details.
|
|
1875
2976
|
*/
|
|
1876
|
-
200:
|
|
2977
|
+
200: BillingContact;
|
|
1877
2978
|
};
|
|
1878
|
-
export type
|
|
1879
|
-
export type
|
|
2979
|
+
export type UpdateContactResponse = UpdateContactResponses[keyof UpdateContactResponses];
|
|
2980
|
+
export type GetCreditsData = {
|
|
1880
2981
|
body?: never;
|
|
1881
|
-
path
|
|
1882
|
-
/**
|
|
1883
|
-
* Unique user identifier. UUID v4 string in canonical form
|
|
1884
|
-
*/
|
|
1885
|
-
user_id: string;
|
|
1886
|
-
};
|
|
2982
|
+
path?: never;
|
|
1887
2983
|
query?: never;
|
|
1888
|
-
url: '/
|
|
2984
|
+
url: '/billing/credits';
|
|
1889
2985
|
};
|
|
1890
|
-
export type
|
|
2986
|
+
export type GetCreditsErrors = {
|
|
1891
2987
|
/**
|
|
1892
2988
|
* Not authenticated
|
|
1893
2989
|
*/
|
|
1894
2990
|
401: unknown;
|
|
1895
2991
|
};
|
|
1896
|
-
export type
|
|
2992
|
+
export type GetCreditsResponses = {
|
|
1897
2993
|
/**
|
|
1898
|
-
*
|
|
2994
|
+
* An array of the applied promotional credits records.
|
|
1899
2995
|
*/
|
|
1900
|
-
200:
|
|
2996
|
+
200: Array<BillingCredits>;
|
|
1901
2997
|
};
|
|
1902
|
-
export type
|
|
1903
|
-
export type
|
|
1904
|
-
body:
|
|
1905
|
-
path: {
|
|
2998
|
+
export type GetCreditsResponse = GetCreditsResponses[keyof GetCreditsResponses];
|
|
2999
|
+
export type RedeemCreditsData = {
|
|
3000
|
+
body: {
|
|
1906
3001
|
/**
|
|
1907
|
-
*
|
|
3002
|
+
* Promotional code to redeem
|
|
1908
3003
|
*/
|
|
1909
|
-
|
|
3004
|
+
code?: string;
|
|
1910
3005
|
};
|
|
3006
|
+
path?: never;
|
|
1911
3007
|
query?: never;
|
|
1912
|
-
url: '/
|
|
3008
|
+
url: '/billing/credits';
|
|
1913
3009
|
};
|
|
1914
|
-
export type
|
|
3010
|
+
export type RedeemCreditsErrors = {
|
|
1915
3011
|
/**
|
|
1916
|
-
*
|
|
3012
|
+
* Not authenticated
|
|
1917
3013
|
*/
|
|
1918
|
-
|
|
3014
|
+
401: unknown;
|
|
1919
3015
|
};
|
|
1920
|
-
export type
|
|
1921
|
-
|
|
1922
|
-
|
|
3016
|
+
export type RedeemCreditsResponses = {
|
|
3017
|
+
/**
|
|
3018
|
+
* Successfully created a new organization.
|
|
3019
|
+
*/
|
|
3020
|
+
200: unknown;
|
|
1923
3021
|
};
|
|
1924
3022
|
//# sourceMappingURL=types.gen.d.ts.map
|