@cloudfleet/sdk 0.0.1-f1d40ff → 0.0.1-f231d8a
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 +1159 -0
- package/dist/@tanstack/react-query.gen.d.ts.map +1 -0
- package/dist/@tanstack/react-query.gen.js +1175 -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 +1473 -570
- package/dist/schemas.gen.d.ts.map +1 -1
- package/dist/schemas.gen.js +2897 -711
- package/dist/schemas.gen.js.map +1 -1
- package/dist/sdk.gen.d.ts +296 -164
- package/dist/sdk.gen.d.ts.map +1 -1
- package/dist/sdk.gen.js +415 -336
- package/dist/sdk.gen.js.map +1 -1
- package/dist/services/kubernetes/api.d.ts +20 -20
- package/dist/types.gen.d.ts +1742 -811
- package/dist/types.gen.d.ts.map +1 -1
- package/dist/zod.gen.d.ts +3812 -3753
- package/dist/zod.gen.d.ts.map +1 -1
- package/dist/zod.gen.js +1406 -1153
- 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/schemas.gen.d.ts
CHANGED
|
@@ -1,6 +1,12 @@
|
|
|
1
1
|
export declare const BillingContactSchema: {
|
|
2
2
|
readonly type: "object";
|
|
3
3
|
readonly properties: {
|
|
4
|
+
readonly type: {
|
|
5
|
+
readonly type: "string";
|
|
6
|
+
readonly description: "Type of the organization. `business` for legal entities, `personal` for individuals.";
|
|
7
|
+
readonly example: "business";
|
|
8
|
+
readonly enum: readonly ["business", "personal"];
|
|
9
|
+
};
|
|
4
10
|
readonly company: {
|
|
5
11
|
readonly type: "string";
|
|
6
12
|
readonly maxLength: 120;
|
|
@@ -57,15 +63,10 @@ export declare const BillingContactSchema: {
|
|
|
57
63
|
readonly description: "Email address used for billing as a string.";
|
|
58
64
|
readonly example: "email@example.com";
|
|
59
65
|
};
|
|
60
|
-
readonly
|
|
61
|
-
readonly type: "string";
|
|
62
|
-
readonly description: "First name of the billing contact person.";
|
|
63
|
-
readonly example: "John";
|
|
64
|
-
};
|
|
65
|
-
readonly last_name: {
|
|
66
|
+
readonly individual_name: {
|
|
66
67
|
readonly type: "string";
|
|
67
|
-
readonly description: "
|
|
68
|
-
readonly example: "Doe";
|
|
68
|
+
readonly description: "Name of the billing contact person.";
|
|
69
|
+
readonly example: "John Doe";
|
|
69
70
|
};
|
|
70
71
|
readonly tax_id: {
|
|
71
72
|
readonly type: "string";
|
|
@@ -81,7 +82,7 @@ export declare const BillingContactSchema: {
|
|
|
81
82
|
readonly enum: readonly ["ad_nrt", "ae_trn", "al_tin", "am_tin", "ao_tin", "ar_cuit", "at_vat", "au_abn", "au_arn", "ba_tin", "bb_tin", "be_vat", "bg_uic", "bg_vat", "bh_vat", "bo_tin", "br_cnpj", "br_cpf", "bs_tin", "by_tin", "ca_bn", "ca_gst_hst", "ca_pst_bc", "ca_pst_mb", "ca_pst_sk", "ca_qst", "cd_nif", "ch_uid", "ch_vat", "cl_tin", "cn_tin", "co_nit", "cr_tin", "cy_vat", "cz_vat", "de_stn", "de_vat", "dk_vat", "do_rcn", "ec_ruc", "ee_vat", "eg_tin", "es_cif", "es_vat", "eu_oss_vat", "fi_vat", "fr_vat", "gb_vat", "ge_vat", "gn_nif", "gr_vat", "hk_br", "hr_oib", "hr_vat", "hu_tin", "hu_vat", "id_npwp", "ie_vat", "il_vat", "in_gst", "is_vat", "it_vat", "jp_cn", "jp_rn", "jp_trn", "ke_pin", "kh_tin", "kr_brn", "kz_bin", "li_uid", "li_vat", "lt_vat", "lu_vat", "lv_vat", "ma_vat", "md_vat", "me_pib", "mk_vat", "mr_nif", "mt_vat", "mx_rfc", "my_frp", "my_itn", "my_sst", "ng_tin", "nl_vat", "no_vat", "no_voec", "np_pan", "nz_gst", "om_vat", "pe_ruc", "ph_tin", "pl_vat", "pt_vat", "ro_tin", "ro_vat", "rs_pib", "ru_inn", "ru_kpp", "sa_vat", "se_vat", "sg_gst", "sg_uen", "si_tin", "si_vat", "sk_vat", "sn_ninea", "sr_fin", "sv_nit", "th_vat", "tj_tin", "tr_tin", "tw_vat", "tz_vat", "ua_vat", "ug_tin", "us_ein", "uy_ruc", "uz_tin", "uz_vat", "ve_rif", "vn_tin", "xi_vat", "za_vat", "zm_tin", "zw_tin", ""];
|
|
82
83
|
};
|
|
83
84
|
};
|
|
84
|
-
readonly required: readonly ["
|
|
85
|
+
readonly required: readonly ["type", "email", "individual_name"];
|
|
85
86
|
readonly additionalProperties: false;
|
|
86
87
|
};
|
|
87
88
|
export declare const BillingCreditsSchema: {
|
|
@@ -92,10 +93,22 @@ export declare const BillingCreditsSchema: {
|
|
|
92
93
|
readonly description: "Generated unique identifier of the promotional code.";
|
|
93
94
|
readonly example: "7kUZnH7nnKUFfvc4NK2KQF";
|
|
94
95
|
};
|
|
95
|
-
readonly
|
|
96
|
+
readonly type: {
|
|
97
|
+
readonly type: "string";
|
|
98
|
+
readonly description: "Type of the promotional code.";
|
|
99
|
+
readonly example: "credit";
|
|
100
|
+
readonly enum: readonly ["credit", "discount"];
|
|
101
|
+
};
|
|
102
|
+
readonly date_start: {
|
|
103
|
+
readonly type: "string";
|
|
104
|
+
readonly format: "date-time";
|
|
105
|
+
readonly description: "Timestamp when the credit becomes active. ISO 8601 date string in the UTC timezone.";
|
|
106
|
+
readonly example: "2023-12-20T13:53:32.000Z";
|
|
107
|
+
};
|
|
108
|
+
readonly date_end: {
|
|
96
109
|
readonly type: "string";
|
|
97
110
|
readonly format: "date-time";
|
|
98
|
-
readonly description: "
|
|
111
|
+
readonly description: "Timestamp when the credit expires or becomes inactive. ISO 8601 date string in the UTC timezone.";
|
|
99
112
|
readonly example: "2023-12-20T13:53:32.000Z";
|
|
100
113
|
};
|
|
101
114
|
readonly code: {
|
|
@@ -108,40 +121,20 @@ export declare const BillingCreditsSchema: {
|
|
|
108
121
|
readonly description: "Description of the promotional code.";
|
|
109
122
|
readonly example: "10% off on all products";
|
|
110
123
|
};
|
|
111
|
-
readonly
|
|
112
|
-
readonly type: "array";
|
|
113
|
-
readonly items: {
|
|
114
|
-
readonly type: "string";
|
|
115
|
-
};
|
|
116
|
-
readonly description: "List of product SKUs that the promotional code can be used on.";
|
|
117
|
-
readonly example: readonly ["cfke_controlplane", "cfke_connected_nodes", "infra_compute", "infra_storage", "infra_loadbalancing", "infra_traffic", "cfcr_storage"];
|
|
118
|
-
};
|
|
119
|
-
readonly type: {
|
|
120
|
-
readonly type: "string";
|
|
121
|
-
readonly description: "Type of the promotional code.";
|
|
122
|
-
readonly example: "credit";
|
|
123
|
-
readonly enum: readonly ["credit", "discount"];
|
|
124
|
-
};
|
|
125
|
-
readonly value: {
|
|
124
|
+
readonly value_total: {
|
|
126
125
|
readonly type: "number";
|
|
127
126
|
readonly format: "float";
|
|
128
|
-
readonly description: "
|
|
127
|
+
readonly description: "Total value of the promotional code.";
|
|
129
128
|
readonly example: 10;
|
|
130
129
|
};
|
|
131
|
-
readonly billing_period: {
|
|
132
|
-
readonly type: "string";
|
|
133
|
-
readonly format: "date-time";
|
|
134
|
-
readonly description: "Date of the billing cycle. An ISO 8601 date string in the UTC timezone.";
|
|
135
|
-
readonly example: "2023-12-20T13:53:32.000Z";
|
|
136
|
-
};
|
|
137
130
|
readonly value_remaining: {
|
|
138
131
|
readonly type: "number";
|
|
139
132
|
readonly format: "float";
|
|
140
|
-
readonly description: "
|
|
141
|
-
readonly example:
|
|
133
|
+
readonly description: "Remaining value of the promotional code.";
|
|
134
|
+
readonly example: 8;
|
|
142
135
|
};
|
|
143
136
|
};
|
|
144
|
-
readonly required: readonly ["
|
|
137
|
+
readonly required: readonly ["type", "date_start", "code", "value_total"];
|
|
145
138
|
readonly additionalProperties: false;
|
|
146
139
|
};
|
|
147
140
|
export declare const ChartCreateInputSchema: {
|
|
@@ -224,9 +217,8 @@ export declare const ChartSchema: {
|
|
|
224
217
|
};
|
|
225
218
|
readonly status: {
|
|
226
219
|
readonly type: "string";
|
|
227
|
-
readonly description: "Status of the chart deployment.";
|
|
228
|
-
readonly example: "
|
|
229
|
-
readonly enum: readonly ["InstallSucceeded", "InstallFailed", "UpgradeSucceeded", "UpgradeFailed", "TestSucceeded", "TestFailed", "RollbackSucceeded", "RollbackFailed", "UninstallSucceeded", "UninstallFailed", "ArtifactFailed", "DependencyNotReady", "Progressing", "SourceNotReady"];
|
|
220
|
+
readonly description: "Status of the chart deployment (Flux HelmRelease Ready condition reason, e.g. InstallSucceeded, UpgradeFailed, Progressing).";
|
|
221
|
+
readonly example: "InstallSucceeded";
|
|
230
222
|
};
|
|
231
223
|
readonly version_current: {
|
|
232
224
|
readonly type: "string";
|
|
@@ -283,26 +275,103 @@ export declare const ClusterCreateInputSchema: {
|
|
|
283
275
|
readonly tier: {
|
|
284
276
|
readonly type: "string";
|
|
285
277
|
readonly description: "Tier of the cluster.";
|
|
278
|
+
readonly default: "basic";
|
|
286
279
|
readonly example: "pro";
|
|
287
|
-
readonly enum: readonly ["basic", "pro"];
|
|
288
|
-
};
|
|
289
|
-
readonly region: {
|
|
290
|
-
readonly type: "string";
|
|
291
|
-
readonly description: "Cloudfleet control plane region. One of \"staging\", \"northamerica-central-1\", \"europe-central-1a\". This field can not be updated after creation.";
|
|
292
|
-
readonly default: "staging";
|
|
293
|
-
readonly example: "northamerica-central-1";
|
|
294
|
-
readonly enum: readonly ["staging", "northamerica-central-1", "europe-central-1a"];
|
|
280
|
+
readonly enum: readonly ["basic", "pro", "enterprise"];
|
|
295
281
|
};
|
|
296
282
|
readonly version_channel: {
|
|
297
283
|
readonly type: "string";
|
|
298
284
|
readonly pattern: "^(x|X|0|[1-9]\\d*)\\.(x|X|0|[1-9]\\d*)\\.(x|X|0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?$";
|
|
299
285
|
readonly description: "Version of the kubernetes cluster.";
|
|
300
286
|
readonly default: "1.x.x-cfke.x";
|
|
301
|
-
readonly example: "1.
|
|
287
|
+
readonly example: "1.x.x-cfke.x";
|
|
288
|
+
};
|
|
289
|
+
readonly release_channel: {
|
|
290
|
+
readonly type: "string";
|
|
291
|
+
readonly description: "Release channel for the cluster's control plane.";
|
|
292
|
+
readonly default: "rapid";
|
|
293
|
+
readonly example: "rapid";
|
|
294
|
+
readonly enum: readonly ["rapid", "stable", "extended"];
|
|
295
|
+
};
|
|
296
|
+
readonly features: {
|
|
297
|
+
readonly type: "object";
|
|
298
|
+
readonly properties: {
|
|
299
|
+
readonly gpu_sharing_strategy: {
|
|
300
|
+
readonly type: "string";
|
|
301
|
+
readonly description: "GPU sharing strategy.";
|
|
302
|
+
readonly default: "none";
|
|
303
|
+
readonly example: "none";
|
|
304
|
+
readonly enum: readonly ["none", "mps", "time_slicing"];
|
|
305
|
+
};
|
|
306
|
+
readonly gpu_max_shared_clients_per_gpu: {
|
|
307
|
+
readonly type: "integer";
|
|
308
|
+
readonly minimum: 2;
|
|
309
|
+
readonly maximum: 48;
|
|
310
|
+
readonly description: "Maximum number of pods that may share a single GPU.";
|
|
311
|
+
readonly default: 4;
|
|
312
|
+
readonly example: 10;
|
|
313
|
+
};
|
|
314
|
+
readonly cilium_socket_lb_host_namespace_only: {
|
|
315
|
+
readonly type: "boolean";
|
|
316
|
+
readonly description: "Restrict Cilium socket load-balancing to the host namespace. Required for the Tailscale operator and Istio.";
|
|
317
|
+
readonly example: false;
|
|
318
|
+
};
|
|
319
|
+
};
|
|
320
|
+
readonly additionalProperties: false;
|
|
321
|
+
readonly description: "Cluster feature toggles.";
|
|
322
|
+
readonly default: {
|
|
323
|
+
readonly gpu_sharing_strategy: "none";
|
|
324
|
+
readonly gpu_max_shared_clients_per_gpu: 4;
|
|
325
|
+
readonly cilium_socket_lb_host_namespace_only: false;
|
|
326
|
+
};
|
|
327
|
+
};
|
|
328
|
+
readonly region: {
|
|
329
|
+
readonly type: "string";
|
|
330
|
+
readonly description: "Cloudfleet control plane region. This field can not be updated after creation.";
|
|
331
|
+
readonly example: "europe-central-1a";
|
|
332
|
+
};
|
|
333
|
+
readonly networking: {
|
|
334
|
+
readonly type: "object";
|
|
335
|
+
readonly properties: {
|
|
336
|
+
readonly pod_cidr: {
|
|
337
|
+
readonly type: "string";
|
|
338
|
+
readonly description: "CIDR block for pod IPs.";
|
|
339
|
+
readonly default: "10.244.0.0/16";
|
|
340
|
+
};
|
|
341
|
+
readonly service_cidr: {
|
|
342
|
+
readonly type: "string";
|
|
343
|
+
readonly description: "CIDR block for service IPs.";
|
|
344
|
+
readonly default: "10.96.0.0/12";
|
|
345
|
+
};
|
|
346
|
+
readonly dual_stack: {
|
|
347
|
+
readonly type: "boolean";
|
|
348
|
+
readonly description: "Enable IPv4+IPv6 dual-stack networking.";
|
|
349
|
+
};
|
|
350
|
+
readonly pod_cidr_v6: {
|
|
351
|
+
readonly type: "string";
|
|
352
|
+
readonly description: "IPv6 pod CIDR. Requires dual_stack.";
|
|
353
|
+
readonly default: "2001:db8:1:2::/48";
|
|
354
|
+
};
|
|
355
|
+
readonly service_cidr_v6: {
|
|
356
|
+
readonly type: "string";
|
|
357
|
+
readonly description: "IPv6 service CIDR. Requires dual_stack.";
|
|
358
|
+
readonly default: "2001:db8:1:1::/112";
|
|
359
|
+
};
|
|
360
|
+
};
|
|
361
|
+
readonly additionalProperties: false;
|
|
362
|
+
readonly description: "Cluster networking configuration. Immutable after creation.";
|
|
363
|
+
readonly default: {
|
|
364
|
+
readonly pod_cidr: "10.244.0.0/16";
|
|
365
|
+
readonly service_cidr: "10.96.0.0/12";
|
|
366
|
+
readonly dual_stack: false;
|
|
367
|
+
readonly pod_cidr_v6: "2001:db8:1:2::/48";
|
|
368
|
+
readonly service_cidr_v6: "2001:db8:1:1::/112";
|
|
369
|
+
};
|
|
302
370
|
};
|
|
303
371
|
};
|
|
304
|
-
readonly required: readonly ["name", "
|
|
372
|
+
readonly required: readonly ["name", "region"];
|
|
305
373
|
readonly additionalProperties: false;
|
|
374
|
+
readonly description: "Mutable cluster configuration. Applied as a full overwrite: any omitted field is reset to its default rather than left unchanged.";
|
|
306
375
|
};
|
|
307
376
|
export declare const ClusterJoinInformationSchema: {
|
|
308
377
|
readonly type: "object";
|
|
@@ -318,6 +387,16 @@ export declare const ClusterJoinInformationSchema: {
|
|
|
318
387
|
readonly description: "Internal URL of the Kubernetes cluster control plane. This is the endpoint that kubelet uses to connect to the cluster.";
|
|
319
388
|
readonly example: "https://10.31.64.7:6443";
|
|
320
389
|
};
|
|
390
|
+
readonly cluster_dns: {
|
|
391
|
+
readonly type: "string";
|
|
392
|
+
readonly description: "Cluster DNS IP address. This is the IP address of the kube-dns service in the cluster.";
|
|
393
|
+
readonly example: "10.96.0.10";
|
|
394
|
+
};
|
|
395
|
+
readonly pod_cidr: {
|
|
396
|
+
readonly type: "string";
|
|
397
|
+
readonly description: "Pod CIDR for the cluster. Used to configure iptables rules on nodes to prevent Tailscale routing loops.";
|
|
398
|
+
readonly example: "10.244.0.0/16";
|
|
399
|
+
};
|
|
321
400
|
readonly auth_key: {
|
|
322
401
|
readonly type: "string";
|
|
323
402
|
readonly description: "Authentication key for the cluster.";
|
|
@@ -334,7 +413,7 @@ export declare const ClusterJoinInformationSchema: {
|
|
|
334
413
|
readonly kubernetes: {
|
|
335
414
|
readonly type: "string";
|
|
336
415
|
readonly description: "Kubernetes version of the cluster.";
|
|
337
|
-
readonly example: "1.
|
|
416
|
+
readonly example: "1.33.7";
|
|
338
417
|
};
|
|
339
418
|
readonly tailscale: {
|
|
340
419
|
readonly type: "string";
|
|
@@ -380,7 +459,7 @@ export declare const ClusterJoinInformationSchema: {
|
|
|
380
459
|
readonly description: "OIDC Information for hosts to access to third party API's.";
|
|
381
460
|
};
|
|
382
461
|
};
|
|
383
|
-
readonly required: readonly ["certificate_authority", "endpoint", "auth_key", "bootstrap_token", "versions", "third_party_api_access_config"];
|
|
462
|
+
readonly required: readonly ["certificate_authority", "endpoint", "cluster_dns", "pod_cidr", "auth_key", "bootstrap_token", "versions", "third_party_api_access_config"];
|
|
384
463
|
readonly additionalProperties: false;
|
|
385
464
|
};
|
|
386
465
|
export declare const ClusterSchema: {
|
|
@@ -397,22 +476,100 @@ export declare const ClusterSchema: {
|
|
|
397
476
|
readonly tier: {
|
|
398
477
|
readonly type: "string";
|
|
399
478
|
readonly description: "Tier of the cluster.";
|
|
479
|
+
readonly default: "basic";
|
|
400
480
|
readonly example: "pro";
|
|
401
|
-
readonly enum: readonly ["basic", "pro"];
|
|
402
|
-
};
|
|
403
|
-
readonly region: {
|
|
404
|
-
readonly type: "string";
|
|
405
|
-
readonly description: "Cloudfleet control plane region. One of \"staging\", \"northamerica-central-1\", \"europe-central-1a\". This field can not be updated after creation.";
|
|
406
|
-
readonly default: "staging";
|
|
407
|
-
readonly example: "northamerica-central-1";
|
|
408
|
-
readonly enum: readonly ["staging", "northamerica-central-1", "europe-central-1a"];
|
|
481
|
+
readonly enum: readonly ["basic", "pro", "enterprise"];
|
|
409
482
|
};
|
|
410
483
|
readonly version_channel: {
|
|
411
484
|
readonly type: "string";
|
|
412
485
|
readonly pattern: "^(x|X|0|[1-9]\\d*)\\.(x|X|0|[1-9]\\d*)\\.(x|X|0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?$";
|
|
413
486
|
readonly description: "Version of the kubernetes cluster.";
|
|
414
487
|
readonly default: "1.x.x-cfke.x";
|
|
415
|
-
readonly example: "1.
|
|
488
|
+
readonly example: "1.x.x-cfke.x";
|
|
489
|
+
};
|
|
490
|
+
readonly release_channel: {
|
|
491
|
+
readonly type: "string";
|
|
492
|
+
readonly description: "Release channel for the cluster's control plane.";
|
|
493
|
+
readonly default: "rapid";
|
|
494
|
+
readonly example: "rapid";
|
|
495
|
+
readonly enum: readonly ["rapid", "stable", "extended"];
|
|
496
|
+
};
|
|
497
|
+
readonly features: {
|
|
498
|
+
readonly type: "object";
|
|
499
|
+
readonly properties: {
|
|
500
|
+
readonly gpu_sharing_strategy: {
|
|
501
|
+
readonly type: "string";
|
|
502
|
+
readonly description: "GPU sharing strategy.";
|
|
503
|
+
readonly default: "none";
|
|
504
|
+
readonly example: "none";
|
|
505
|
+
readonly enum: readonly ["none", "mps", "time_slicing"];
|
|
506
|
+
};
|
|
507
|
+
readonly gpu_max_shared_clients_per_gpu: {
|
|
508
|
+
readonly type: "integer";
|
|
509
|
+
readonly minimum: 2;
|
|
510
|
+
readonly maximum: 48;
|
|
511
|
+
readonly description: "Maximum number of pods that may share a single GPU.";
|
|
512
|
+
readonly default: 4;
|
|
513
|
+
readonly example: 10;
|
|
514
|
+
};
|
|
515
|
+
readonly cilium_socket_lb_host_namespace_only: {
|
|
516
|
+
readonly type: "boolean";
|
|
517
|
+
readonly description: "Restrict Cilium socket load-balancing to the host namespace. Required for the Tailscale operator and Istio.";
|
|
518
|
+
readonly example: false;
|
|
519
|
+
};
|
|
520
|
+
};
|
|
521
|
+
readonly required: readonly ["gpu_sharing_strategy", "gpu_max_shared_clients_per_gpu", "cilium_socket_lb_host_namespace_only"];
|
|
522
|
+
readonly additionalProperties: false;
|
|
523
|
+
readonly description: "Cluster feature toggles.";
|
|
524
|
+
readonly default: {
|
|
525
|
+
readonly gpu_sharing_strategy: "none";
|
|
526
|
+
readonly gpu_max_shared_clients_per_gpu: 4;
|
|
527
|
+
readonly cilium_socket_lb_host_namespace_only: false;
|
|
528
|
+
};
|
|
529
|
+
};
|
|
530
|
+
readonly region: {
|
|
531
|
+
readonly type: "string";
|
|
532
|
+
readonly description: "Cloudfleet control plane region. This field can not be updated after creation.";
|
|
533
|
+
readonly example: "europe-central-1a";
|
|
534
|
+
};
|
|
535
|
+
readonly networking: {
|
|
536
|
+
readonly type: "object";
|
|
537
|
+
readonly properties: {
|
|
538
|
+
readonly pod_cidr: {
|
|
539
|
+
readonly type: "string";
|
|
540
|
+
readonly description: "CIDR block for pod IPs.";
|
|
541
|
+
readonly default: "10.244.0.0/16";
|
|
542
|
+
};
|
|
543
|
+
readonly service_cidr: {
|
|
544
|
+
readonly type: "string";
|
|
545
|
+
readonly description: "CIDR block for service IPs.";
|
|
546
|
+
readonly default: "10.96.0.0/12";
|
|
547
|
+
};
|
|
548
|
+
readonly dual_stack: {
|
|
549
|
+
readonly type: "boolean";
|
|
550
|
+
readonly description: "Enable IPv4+IPv6 dual-stack networking.";
|
|
551
|
+
};
|
|
552
|
+
readonly pod_cidr_v6: {
|
|
553
|
+
readonly type: "string";
|
|
554
|
+
readonly description: "IPv6 pod CIDR. Requires dual_stack.";
|
|
555
|
+
readonly default: "2001:db8:1:2::/48";
|
|
556
|
+
};
|
|
557
|
+
readonly service_cidr_v6: {
|
|
558
|
+
readonly type: "string";
|
|
559
|
+
readonly description: "IPv6 service CIDR. Requires dual_stack.";
|
|
560
|
+
readonly default: "2001:db8:1:1::/112";
|
|
561
|
+
};
|
|
562
|
+
};
|
|
563
|
+
readonly required: readonly ["pod_cidr", "service_cidr", "dual_stack", "pod_cidr_v6", "service_cidr_v6"];
|
|
564
|
+
readonly additionalProperties: false;
|
|
565
|
+
readonly description: "Cluster networking configuration. Immutable after creation.";
|
|
566
|
+
readonly default: {
|
|
567
|
+
readonly pod_cidr: "10.244.0.0/16";
|
|
568
|
+
readonly service_cidr: "10.96.0.0/12";
|
|
569
|
+
readonly dual_stack: false;
|
|
570
|
+
readonly pod_cidr_v6: "2001:db8:1:2::/48";
|
|
571
|
+
readonly service_cidr_v6: "2001:db8:1:1::/112";
|
|
572
|
+
};
|
|
416
573
|
};
|
|
417
574
|
readonly id: {
|
|
418
575
|
readonly type: "string";
|
|
@@ -422,16 +579,27 @@ export declare const ClusterSchema: {
|
|
|
422
579
|
};
|
|
423
580
|
readonly status: {
|
|
424
581
|
readonly type: "string";
|
|
425
|
-
readonly description: "Status of the cluster.
|
|
426
|
-
readonly example: "
|
|
427
|
-
readonly enum: readonly ["
|
|
582
|
+
readonly description: "Status of the cluster.";
|
|
583
|
+
readonly example: "deployed";
|
|
584
|
+
readonly enum: readonly ["creating", "deployed", "updating", "disabled"];
|
|
428
585
|
};
|
|
429
586
|
readonly endpoint: {
|
|
430
587
|
readonly anyOf: readonly [{
|
|
431
588
|
readonly type: "string";
|
|
432
589
|
readonly format: "uri";
|
|
433
|
-
readonly description: "URL of the Kubernetes cluster control plane. This is the endpoint that kubectl uses to connect to the cluster.";
|
|
434
|
-
readonly example: "https://2ae6557c-c61f-49c6-b4c1-a65473470a03.staging.cfke.
|
|
590
|
+
readonly description: "URL signed by a public CA of the Kubernetes cluster control plane. This is the endpoint that kubectl uses to connect to the cluster.";
|
|
591
|
+
readonly example: "https://2ae6557c-c61f-49c6-b4c1-a65473470a03.staging.cfke.io";
|
|
592
|
+
}, {
|
|
593
|
+
readonly type: "string";
|
|
594
|
+
readonly enum: readonly [""];
|
|
595
|
+
}];
|
|
596
|
+
};
|
|
597
|
+
readonly endpoint_public: {
|
|
598
|
+
readonly anyOf: readonly [{
|
|
599
|
+
readonly type: "string";
|
|
600
|
+
readonly format: "uri";
|
|
601
|
+
readonly description: "Deprecated alias of `endpoint`; retained for backward compatibility.";
|
|
602
|
+
readonly example: "https://2ae6557c-c61f-49c6-b4c1-a65473470a03.staging.cfke.io";
|
|
435
603
|
}, {
|
|
436
604
|
readonly type: "string";
|
|
437
605
|
readonly enum: readonly [""];
|
|
@@ -445,7 +613,7 @@ export declare const ClusterSchema: {
|
|
|
445
613
|
readonly version_current: {
|
|
446
614
|
readonly type: "string";
|
|
447
615
|
readonly description: "Current version of the cluster.";
|
|
448
|
-
readonly example: "1.
|
|
616
|
+
readonly example: "1.33.7-cfke.264";
|
|
449
617
|
};
|
|
450
618
|
readonly created_at: {
|
|
451
619
|
readonly type: "string";
|
|
@@ -463,8 +631,9 @@ export declare const ClusterSchema: {
|
|
|
463
631
|
readonly example: true;
|
|
464
632
|
};
|
|
465
633
|
};
|
|
466
|
-
readonly required: readonly ["name", "tier", "id", "status"];
|
|
634
|
+
readonly required: readonly ["name", "tier", "version_channel", "release_channel", "features", "region", "networking", "id", "status", "ready"];
|
|
467
635
|
readonly additionalProperties: false;
|
|
636
|
+
readonly description: "Mutable cluster configuration. Applied as a full overwrite: any omitted field is reset to its default rather than left unchanged.";
|
|
468
637
|
};
|
|
469
638
|
export declare const ClusterUpdateInputSchema: {
|
|
470
639
|
readonly type: "object";
|
|
@@ -480,18 +649,60 @@ export declare const ClusterUpdateInputSchema: {
|
|
|
480
649
|
readonly tier: {
|
|
481
650
|
readonly type: "string";
|
|
482
651
|
readonly description: "Tier of the cluster.";
|
|
652
|
+
readonly default: "basic";
|
|
483
653
|
readonly example: "pro";
|
|
484
|
-
readonly enum: readonly ["basic", "pro"];
|
|
654
|
+
readonly enum: readonly ["basic", "pro", "enterprise"];
|
|
485
655
|
};
|
|
486
656
|
readonly version_channel: {
|
|
487
657
|
readonly type: "string";
|
|
488
658
|
readonly pattern: "^(x|X|0|[1-9]\\d*)\\.(x|X|0|[1-9]\\d*)\\.(x|X|0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?$";
|
|
489
659
|
readonly description: "Version of the kubernetes cluster.";
|
|
490
|
-
readonly
|
|
660
|
+
readonly default: "1.x.x-cfke.x";
|
|
661
|
+
readonly example: "1.x.x-cfke.x";
|
|
662
|
+
};
|
|
663
|
+
readonly release_channel: {
|
|
664
|
+
readonly type: "string";
|
|
665
|
+
readonly description: "Release channel for the cluster's control plane.";
|
|
666
|
+
readonly default: "rapid";
|
|
667
|
+
readonly example: "rapid";
|
|
668
|
+
readonly enum: readonly ["rapid", "stable", "extended"];
|
|
669
|
+
};
|
|
670
|
+
readonly features: {
|
|
671
|
+
readonly type: "object";
|
|
672
|
+
readonly properties: {
|
|
673
|
+
readonly gpu_sharing_strategy: {
|
|
674
|
+
readonly type: "string";
|
|
675
|
+
readonly description: "GPU sharing strategy.";
|
|
676
|
+
readonly default: "none";
|
|
677
|
+
readonly example: "none";
|
|
678
|
+
readonly enum: readonly ["none", "mps", "time_slicing"];
|
|
679
|
+
};
|
|
680
|
+
readonly gpu_max_shared_clients_per_gpu: {
|
|
681
|
+
readonly type: "integer";
|
|
682
|
+
readonly minimum: 2;
|
|
683
|
+
readonly maximum: 48;
|
|
684
|
+
readonly description: "Maximum number of pods that may share a single GPU.";
|
|
685
|
+
readonly default: 4;
|
|
686
|
+
readonly example: 10;
|
|
687
|
+
};
|
|
688
|
+
readonly cilium_socket_lb_host_namespace_only: {
|
|
689
|
+
readonly type: "boolean";
|
|
690
|
+
readonly description: "Restrict Cilium socket load-balancing to the host namespace. Required for the Tailscale operator and Istio.";
|
|
691
|
+
readonly example: false;
|
|
692
|
+
};
|
|
693
|
+
};
|
|
694
|
+
readonly additionalProperties: false;
|
|
695
|
+
readonly description: "Cluster feature toggles.";
|
|
696
|
+
readonly default: {
|
|
697
|
+
readonly gpu_sharing_strategy: "none";
|
|
698
|
+
readonly gpu_max_shared_clients_per_gpu: 4;
|
|
699
|
+
readonly cilium_socket_lb_host_namespace_only: false;
|
|
700
|
+
};
|
|
491
701
|
};
|
|
492
702
|
};
|
|
493
|
-
readonly required: readonly ["
|
|
703
|
+
readonly required: readonly ["name"];
|
|
494
704
|
readonly additionalProperties: false;
|
|
705
|
+
readonly description: "Mutable cluster configuration. Applied as a full overwrite: any omitted field is reset to its default rather than left unchanged.";
|
|
495
706
|
};
|
|
496
707
|
export declare const FleetCreateInputSchema: {
|
|
497
708
|
readonly type: "object";
|
|
@@ -500,13 +711,12 @@ export declare const FleetCreateInputSchema: {
|
|
|
500
711
|
readonly type: "object";
|
|
501
712
|
readonly properties: {
|
|
502
713
|
readonly cpu: {
|
|
503
|
-
readonly type: "
|
|
504
|
-
readonly format: "float";
|
|
714
|
+
readonly type: "integer";
|
|
505
715
|
readonly minimum: 0;
|
|
506
|
-
readonly
|
|
716
|
+
readonly maximum: 100000;
|
|
717
|
+
readonly description: "CPU limit in cores. Maximum 100,000.";
|
|
507
718
|
};
|
|
508
719
|
};
|
|
509
|
-
readonly required: readonly ["cpu"];
|
|
510
720
|
readonly additionalProperties: false;
|
|
511
721
|
readonly description: "Limits define a set of bounds for provisioning capacity.";
|
|
512
722
|
};
|
|
@@ -515,14 +725,15 @@ export declare const FleetCreateInputSchema: {
|
|
|
515
725
|
readonly properties: {
|
|
516
726
|
readonly enabled: {
|
|
517
727
|
readonly type: "boolean";
|
|
518
|
-
readonly default: true;
|
|
519
728
|
};
|
|
520
729
|
readonly project: {
|
|
521
730
|
readonly type: "string";
|
|
522
|
-
readonly
|
|
731
|
+
readonly pattern: "^[a-z][a-z0-9-]{4,28}[a-z0-9]$";
|
|
732
|
+
readonly description: "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.";
|
|
733
|
+
readonly example: "my-cloudfleet-project";
|
|
523
734
|
};
|
|
524
735
|
};
|
|
525
|
-
readonly required: readonly ["
|
|
736
|
+
readonly required: readonly ["enabled"];
|
|
526
737
|
readonly additionalProperties: false;
|
|
527
738
|
};
|
|
528
739
|
readonly hetzner: {
|
|
@@ -530,14 +741,16 @@ export declare const FleetCreateInputSchema: {
|
|
|
530
741
|
readonly properties: {
|
|
531
742
|
readonly enabled: {
|
|
532
743
|
readonly type: "boolean";
|
|
533
|
-
readonly default: true;
|
|
534
744
|
};
|
|
535
745
|
readonly apiKey: {
|
|
536
746
|
readonly type: "string";
|
|
537
|
-
readonly
|
|
747
|
+
readonly maxLength: 64;
|
|
748
|
+
readonly minLength: 64;
|
|
749
|
+
readonly pattern: "^([A-Za-z0-9]{64}|\\*{64})$";
|
|
750
|
+
readonly description: "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.";
|
|
538
751
|
};
|
|
539
752
|
};
|
|
540
|
-
readonly required: readonly ["
|
|
753
|
+
readonly required: readonly ["enabled"];
|
|
541
754
|
readonly additionalProperties: false;
|
|
542
755
|
};
|
|
543
756
|
readonly aws: {
|
|
@@ -545,15 +758,74 @@ export declare const FleetCreateInputSchema: {
|
|
|
545
758
|
readonly properties: {
|
|
546
759
|
readonly enabled: {
|
|
547
760
|
readonly type: "boolean";
|
|
548
|
-
readonly default: true;
|
|
549
761
|
};
|
|
550
762
|
readonly controllerRoleArn: {
|
|
551
763
|
readonly type: "string";
|
|
552
|
-
readonly
|
|
764
|
+
readonly pattern: "^arn:aws(-[a-z]+)*:iam::\\d{12}:role\\/[\\w+=,.@/-]+$";
|
|
765
|
+
readonly description: "AWS IAM role ARN that Karpenter uses to manage resources. Omit when AWS is disabled.";
|
|
766
|
+
readonly example: "arn:aws:iam::123456789012:role/Cloudfleet";
|
|
767
|
+
};
|
|
768
|
+
};
|
|
769
|
+
readonly required: readonly ["enabled"];
|
|
770
|
+
readonly additionalProperties: false;
|
|
771
|
+
};
|
|
772
|
+
readonly constraints: {
|
|
773
|
+
readonly type: "object";
|
|
774
|
+
readonly properties: {
|
|
775
|
+
readonly 'karpenter.sh/capacity-type': {
|
|
776
|
+
readonly type: "array";
|
|
777
|
+
readonly items: {
|
|
778
|
+
readonly type: "string";
|
|
779
|
+
readonly enum: readonly ["on-demand", "spot"];
|
|
780
|
+
};
|
|
781
|
+
readonly minItems: 1;
|
|
782
|
+
readonly description: "Allowed values for `karpenter.sh/capacity-type`.";
|
|
783
|
+
readonly default: readonly ["on-demand", "spot"];
|
|
784
|
+
};
|
|
785
|
+
readonly 'kubernetes.io/arch': {
|
|
786
|
+
readonly type: "array";
|
|
787
|
+
readonly items: {
|
|
788
|
+
readonly type: "string";
|
|
789
|
+
readonly enum: readonly ["amd64", "arm64"];
|
|
790
|
+
};
|
|
791
|
+
readonly minItems: 1;
|
|
792
|
+
readonly description: "Allowed values for `kubernetes.io/arch`.";
|
|
793
|
+
readonly default: readonly ["amd64"];
|
|
794
|
+
};
|
|
795
|
+
readonly 'cfke.io/instance-family': {
|
|
796
|
+
readonly type: "array";
|
|
797
|
+
readonly items: {
|
|
798
|
+
readonly type: "string";
|
|
799
|
+
readonly enum: readonly ["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"];
|
|
800
|
+
};
|
|
801
|
+
readonly description: "Allowed values for `cfke.io/instance-family`.";
|
|
802
|
+
readonly default: readonly [];
|
|
803
|
+
};
|
|
804
|
+
readonly 'topology.kubernetes.io/region': {
|
|
805
|
+
readonly type: "array";
|
|
806
|
+
readonly items: {
|
|
807
|
+
readonly type: "string";
|
|
808
|
+
readonly enum: readonly ["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"];
|
|
809
|
+
};
|
|
810
|
+
readonly description: "Allowed values for `topology.kubernetes.io/region`.";
|
|
811
|
+
readonly default: readonly [];
|
|
553
812
|
};
|
|
554
813
|
};
|
|
555
|
-
readonly required: readonly ["controllerRoleArn"];
|
|
556
814
|
readonly additionalProperties: false;
|
|
815
|
+
readonly description: "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.";
|
|
816
|
+
readonly default: {
|
|
817
|
+
readonly 'karpenter.sh/capacity-type': readonly ["on-demand", "spot"];
|
|
818
|
+
readonly 'kubernetes.io/arch': readonly ["amd64"];
|
|
819
|
+
readonly 'cfke.io/instance-family': readonly [];
|
|
820
|
+
readonly 'topology.kubernetes.io/region': readonly [];
|
|
821
|
+
};
|
|
822
|
+
};
|
|
823
|
+
readonly scalingProfile: {
|
|
824
|
+
readonly type: "string";
|
|
825
|
+
readonly description: "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`).";
|
|
826
|
+
readonly default: "conservative";
|
|
827
|
+
readonly example: "conservative";
|
|
828
|
+
readonly enum: readonly ["aggressive", "conservative"];
|
|
557
829
|
};
|
|
558
830
|
readonly id: {
|
|
559
831
|
readonly type: "string";
|
|
@@ -566,6 +838,7 @@ export declare const FleetCreateInputSchema: {
|
|
|
566
838
|
};
|
|
567
839
|
readonly required: readonly ["id"];
|
|
568
840
|
readonly additionalProperties: false;
|
|
841
|
+
readonly description: "Mutable fleet configuration. Applied as a full overwrite: any omitted field is reset to its default rather than left unchanged.";
|
|
569
842
|
};
|
|
570
843
|
export declare const FleetSchema: {
|
|
571
844
|
readonly type: "object";
|
|
@@ -574,13 +847,12 @@ export declare const FleetSchema: {
|
|
|
574
847
|
readonly type: "object";
|
|
575
848
|
readonly properties: {
|
|
576
849
|
readonly cpu: {
|
|
577
|
-
readonly type: "
|
|
578
|
-
readonly format: "float";
|
|
850
|
+
readonly type: "integer";
|
|
579
851
|
readonly minimum: 0;
|
|
580
|
-
readonly
|
|
852
|
+
readonly maximum: 100000;
|
|
853
|
+
readonly description: "CPU limit in cores. Maximum 100,000.";
|
|
581
854
|
};
|
|
582
855
|
};
|
|
583
|
-
readonly required: readonly ["cpu"];
|
|
584
856
|
readonly additionalProperties: false;
|
|
585
857
|
readonly description: "Limits define a set of bounds for provisioning capacity.";
|
|
586
858
|
};
|
|
@@ -589,14 +861,15 @@ export declare const FleetSchema: {
|
|
|
589
861
|
readonly properties: {
|
|
590
862
|
readonly enabled: {
|
|
591
863
|
readonly type: "boolean";
|
|
592
|
-
readonly default: true;
|
|
593
864
|
};
|
|
594
865
|
readonly project: {
|
|
595
866
|
readonly type: "string";
|
|
596
|
-
readonly
|
|
867
|
+
readonly pattern: "^[a-z][a-z0-9-]{4,28}[a-z0-9]$";
|
|
868
|
+
readonly description: "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.";
|
|
869
|
+
readonly example: "my-cloudfleet-project";
|
|
597
870
|
};
|
|
598
871
|
};
|
|
599
|
-
readonly required: readonly ["
|
|
872
|
+
readonly required: readonly ["enabled"];
|
|
600
873
|
readonly additionalProperties: false;
|
|
601
874
|
};
|
|
602
875
|
readonly hetzner: {
|
|
@@ -604,14 +877,14 @@ export declare const FleetSchema: {
|
|
|
604
877
|
readonly properties: {
|
|
605
878
|
readonly enabled: {
|
|
606
879
|
readonly type: "boolean";
|
|
607
|
-
readonly default: true;
|
|
608
880
|
};
|
|
609
881
|
readonly apiKey: {
|
|
610
882
|
readonly type: "string";
|
|
611
|
-
readonly
|
|
883
|
+
readonly pattern: "^\\*{64}$";
|
|
884
|
+
readonly description: "Redacted Hetzner API token. Returned as 64 asterisks when a token is configured; omitted otherwise. The real value is never echoed by the API.";
|
|
612
885
|
};
|
|
613
886
|
};
|
|
614
|
-
readonly required: readonly ["
|
|
887
|
+
readonly required: readonly ["enabled"];
|
|
615
888
|
readonly additionalProperties: false;
|
|
616
889
|
};
|
|
617
890
|
readonly aws: {
|
|
@@ -619,15 +892,75 @@ export declare const FleetSchema: {
|
|
|
619
892
|
readonly properties: {
|
|
620
893
|
readonly enabled: {
|
|
621
894
|
readonly type: "boolean";
|
|
622
|
-
readonly default: true;
|
|
623
895
|
};
|
|
624
896
|
readonly controllerRoleArn: {
|
|
625
897
|
readonly type: "string";
|
|
626
|
-
readonly
|
|
898
|
+
readonly pattern: "^arn:aws(-[a-z]+)*:iam::\\d{12}:role\\/[\\w+=,.@/-]+$";
|
|
899
|
+
readonly description: "AWS IAM role ARN that Karpenter uses to manage resources. Omit when AWS is disabled.";
|
|
900
|
+
readonly example: "arn:aws:iam::123456789012:role/Cloudfleet";
|
|
901
|
+
};
|
|
902
|
+
};
|
|
903
|
+
readonly required: readonly ["enabled"];
|
|
904
|
+
readonly additionalProperties: false;
|
|
905
|
+
};
|
|
906
|
+
readonly constraints: {
|
|
907
|
+
readonly type: "object";
|
|
908
|
+
readonly properties: {
|
|
909
|
+
readonly 'karpenter.sh/capacity-type': {
|
|
910
|
+
readonly type: "array";
|
|
911
|
+
readonly items: {
|
|
912
|
+
readonly type: "string";
|
|
913
|
+
readonly enum: readonly ["on-demand", "spot"];
|
|
914
|
+
};
|
|
915
|
+
readonly minItems: 1;
|
|
916
|
+
readonly description: "Allowed values for `karpenter.sh/capacity-type`.";
|
|
917
|
+
readonly default: readonly ["on-demand", "spot"];
|
|
918
|
+
};
|
|
919
|
+
readonly 'kubernetes.io/arch': {
|
|
920
|
+
readonly type: "array";
|
|
921
|
+
readonly items: {
|
|
922
|
+
readonly type: "string";
|
|
923
|
+
readonly enum: readonly ["amd64", "arm64"];
|
|
924
|
+
};
|
|
925
|
+
readonly minItems: 1;
|
|
926
|
+
readonly description: "Allowed values for `kubernetes.io/arch`.";
|
|
927
|
+
readonly default: readonly ["amd64"];
|
|
928
|
+
};
|
|
929
|
+
readonly 'cfke.io/instance-family': {
|
|
930
|
+
readonly type: "array";
|
|
931
|
+
readonly items: {
|
|
932
|
+
readonly type: "string";
|
|
933
|
+
readonly enum: readonly ["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"];
|
|
934
|
+
};
|
|
935
|
+
readonly description: "Allowed values for `cfke.io/instance-family`.";
|
|
936
|
+
readonly default: readonly [];
|
|
937
|
+
};
|
|
938
|
+
readonly 'topology.kubernetes.io/region': {
|
|
939
|
+
readonly type: "array";
|
|
940
|
+
readonly items: {
|
|
941
|
+
readonly type: "string";
|
|
942
|
+
readonly enum: readonly ["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"];
|
|
943
|
+
};
|
|
944
|
+
readonly description: "Allowed values for `topology.kubernetes.io/region`.";
|
|
945
|
+
readonly default: readonly [];
|
|
627
946
|
};
|
|
628
947
|
};
|
|
629
|
-
readonly required: readonly ["
|
|
948
|
+
readonly required: readonly ["karpenter.sh/capacity-type", "kubernetes.io/arch"];
|
|
630
949
|
readonly additionalProperties: false;
|
|
950
|
+
readonly description: "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.";
|
|
951
|
+
readonly default: {
|
|
952
|
+
readonly 'karpenter.sh/capacity-type': readonly ["on-demand", "spot"];
|
|
953
|
+
readonly 'kubernetes.io/arch': readonly ["amd64"];
|
|
954
|
+
readonly 'cfke.io/instance-family': readonly [];
|
|
955
|
+
readonly 'topology.kubernetes.io/region': readonly [];
|
|
956
|
+
};
|
|
957
|
+
};
|
|
958
|
+
readonly scalingProfile: {
|
|
959
|
+
readonly type: "string";
|
|
960
|
+
readonly description: "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`).";
|
|
961
|
+
readonly default: "conservative";
|
|
962
|
+
readonly example: "conservative";
|
|
963
|
+
readonly enum: readonly ["aggressive", "conservative"];
|
|
631
964
|
};
|
|
632
965
|
readonly id: {
|
|
633
966
|
readonly type: "string";
|
|
@@ -637,9 +970,30 @@ export declare const FleetSchema: {
|
|
|
637
970
|
readonly description: "Unique identifier of the kubernetes fleet.";
|
|
638
971
|
readonly example: "new-clouds-fleet";
|
|
639
972
|
};
|
|
973
|
+
readonly ready: {
|
|
974
|
+
readonly type: "boolean";
|
|
975
|
+
readonly description: "Indicates whether the fleet configuration is healthy.";
|
|
976
|
+
readonly example: true;
|
|
977
|
+
};
|
|
978
|
+
readonly status_message: {
|
|
979
|
+
readonly type: "string";
|
|
980
|
+
readonly description: "Human-readable reason the fleet is not ready. Present only when `ready` is false.";
|
|
981
|
+
readonly example: "Invalid provider permissions.";
|
|
982
|
+
};
|
|
983
|
+
readonly created_at: {
|
|
984
|
+
readonly type: "string";
|
|
985
|
+
readonly description: "Creation date and time of the fleet.";
|
|
986
|
+
readonly example: "2024-09-12T09:11:27Z";
|
|
987
|
+
};
|
|
988
|
+
readonly updated_at: {
|
|
989
|
+
readonly type: "string";
|
|
990
|
+
readonly description: "Date and time the fleet was last updated.";
|
|
991
|
+
readonly example: "2024-09-12T09:11:27Z";
|
|
992
|
+
};
|
|
640
993
|
};
|
|
641
|
-
readonly required: readonly ["id"];
|
|
994
|
+
readonly required: readonly ["constraints", "scalingProfile", "id", "ready", "created_at", "updated_at"];
|
|
642
995
|
readonly additionalProperties: false;
|
|
996
|
+
readonly description: "Mutable fleet configuration. Applied as a full overwrite: any omitted field is reset to its default rather than left unchanged.";
|
|
643
997
|
};
|
|
644
998
|
export declare const FleetUpdateInputSchema: {
|
|
645
999
|
readonly type: "object";
|
|
@@ -648,13 +1002,12 @@ export declare const FleetUpdateInputSchema: {
|
|
|
648
1002
|
readonly type: "object";
|
|
649
1003
|
readonly properties: {
|
|
650
1004
|
readonly cpu: {
|
|
651
|
-
readonly type: "
|
|
652
|
-
readonly format: "float";
|
|
1005
|
+
readonly type: "integer";
|
|
653
1006
|
readonly minimum: 0;
|
|
654
|
-
readonly
|
|
1007
|
+
readonly maximum: 100000;
|
|
1008
|
+
readonly description: "CPU limit in cores. Maximum 100,000.";
|
|
655
1009
|
};
|
|
656
1010
|
};
|
|
657
|
-
readonly required: readonly ["cpu"];
|
|
658
1011
|
readonly additionalProperties: false;
|
|
659
1012
|
readonly description: "Limits define a set of bounds for provisioning capacity.";
|
|
660
1013
|
};
|
|
@@ -663,14 +1016,15 @@ export declare const FleetUpdateInputSchema: {
|
|
|
663
1016
|
readonly properties: {
|
|
664
1017
|
readonly enabled: {
|
|
665
1018
|
readonly type: "boolean";
|
|
666
|
-
readonly default: true;
|
|
667
1019
|
};
|
|
668
1020
|
readonly project: {
|
|
669
1021
|
readonly type: "string";
|
|
670
|
-
readonly
|
|
1022
|
+
readonly pattern: "^[a-z][a-z0-9-]{4,28}[a-z0-9]$";
|
|
1023
|
+
readonly description: "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.";
|
|
1024
|
+
readonly example: "my-cloudfleet-project";
|
|
671
1025
|
};
|
|
672
1026
|
};
|
|
673
|
-
readonly required: readonly ["
|
|
1027
|
+
readonly required: readonly ["enabled"];
|
|
674
1028
|
readonly additionalProperties: false;
|
|
675
1029
|
};
|
|
676
1030
|
readonly hetzner: {
|
|
@@ -678,14 +1032,16 @@ export declare const FleetUpdateInputSchema: {
|
|
|
678
1032
|
readonly properties: {
|
|
679
1033
|
readonly enabled: {
|
|
680
1034
|
readonly type: "boolean";
|
|
681
|
-
readonly default: true;
|
|
682
1035
|
};
|
|
683
1036
|
readonly apiKey: {
|
|
684
1037
|
readonly type: "string";
|
|
685
|
-
readonly
|
|
1038
|
+
readonly maxLength: 64;
|
|
1039
|
+
readonly minLength: 64;
|
|
1040
|
+
readonly pattern: "^([A-Za-z0-9]{64}|\\*{64})$";
|
|
1041
|
+
readonly description: "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.";
|
|
686
1042
|
};
|
|
687
1043
|
};
|
|
688
|
-
readonly required: readonly ["
|
|
1044
|
+
readonly required: readonly ["enabled"];
|
|
689
1045
|
readonly additionalProperties: false;
|
|
690
1046
|
};
|
|
691
1047
|
readonly aws: {
|
|
@@ -693,23 +1049,103 @@ export declare const FleetUpdateInputSchema: {
|
|
|
693
1049
|
readonly properties: {
|
|
694
1050
|
readonly enabled: {
|
|
695
1051
|
readonly type: "boolean";
|
|
696
|
-
readonly default: true;
|
|
697
1052
|
};
|
|
698
1053
|
readonly controllerRoleArn: {
|
|
699
1054
|
readonly type: "string";
|
|
700
|
-
readonly
|
|
1055
|
+
readonly pattern: "^arn:aws(-[a-z]+)*:iam::\\d{12}:role\\/[\\w+=,.@/-]+$";
|
|
1056
|
+
readonly description: "AWS IAM role ARN that Karpenter uses to manage resources. Omit when AWS is disabled.";
|
|
1057
|
+
readonly example: "arn:aws:iam::123456789012:role/Cloudfleet";
|
|
701
1058
|
};
|
|
702
1059
|
};
|
|
703
|
-
readonly required: readonly ["
|
|
1060
|
+
readonly required: readonly ["enabled"];
|
|
704
1061
|
readonly additionalProperties: false;
|
|
705
1062
|
};
|
|
1063
|
+
readonly constraints: {
|
|
1064
|
+
readonly type: "object";
|
|
1065
|
+
readonly properties: {
|
|
1066
|
+
readonly 'karpenter.sh/capacity-type': {
|
|
1067
|
+
readonly type: "array";
|
|
1068
|
+
readonly items: {
|
|
1069
|
+
readonly type: "string";
|
|
1070
|
+
readonly enum: readonly ["on-demand", "spot"];
|
|
1071
|
+
};
|
|
1072
|
+
readonly minItems: 1;
|
|
1073
|
+
readonly description: "Allowed values for `karpenter.sh/capacity-type`.";
|
|
1074
|
+
readonly default: readonly ["on-demand", "spot"];
|
|
1075
|
+
};
|
|
1076
|
+
readonly 'kubernetes.io/arch': {
|
|
1077
|
+
readonly type: "array";
|
|
1078
|
+
readonly items: {
|
|
1079
|
+
readonly type: "string";
|
|
1080
|
+
readonly enum: readonly ["amd64", "arm64"];
|
|
1081
|
+
};
|
|
1082
|
+
readonly minItems: 1;
|
|
1083
|
+
readonly description: "Allowed values for `kubernetes.io/arch`.";
|
|
1084
|
+
readonly default: readonly ["amd64"];
|
|
1085
|
+
};
|
|
1086
|
+
readonly 'cfke.io/instance-family': {
|
|
1087
|
+
readonly type: "array";
|
|
1088
|
+
readonly items: {
|
|
1089
|
+
readonly type: "string";
|
|
1090
|
+
readonly enum: readonly ["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"];
|
|
1091
|
+
};
|
|
1092
|
+
readonly description: "Allowed values for `cfke.io/instance-family`.";
|
|
1093
|
+
readonly default: readonly [];
|
|
1094
|
+
};
|
|
1095
|
+
readonly 'topology.kubernetes.io/region': {
|
|
1096
|
+
readonly type: "array";
|
|
1097
|
+
readonly items: {
|
|
1098
|
+
readonly type: "string";
|
|
1099
|
+
readonly enum: readonly ["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"];
|
|
1100
|
+
};
|
|
1101
|
+
readonly description: "Allowed values for `topology.kubernetes.io/region`.";
|
|
1102
|
+
readonly default: readonly [];
|
|
1103
|
+
};
|
|
1104
|
+
};
|
|
1105
|
+
readonly additionalProperties: false;
|
|
1106
|
+
readonly description: "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.";
|
|
1107
|
+
readonly default: {
|
|
1108
|
+
readonly 'karpenter.sh/capacity-type': readonly ["on-demand", "spot"];
|
|
1109
|
+
readonly 'kubernetes.io/arch': readonly ["amd64"];
|
|
1110
|
+
readonly 'cfke.io/instance-family': readonly [];
|
|
1111
|
+
readonly 'topology.kubernetes.io/region': readonly [];
|
|
1112
|
+
};
|
|
1113
|
+
};
|
|
1114
|
+
readonly scalingProfile: {
|
|
1115
|
+
readonly type: "string";
|
|
1116
|
+
readonly description: "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`).";
|
|
1117
|
+
readonly default: "conservative";
|
|
1118
|
+
readonly example: "conservative";
|
|
1119
|
+
readonly enum: readonly ["aggressive", "conservative"];
|
|
1120
|
+
};
|
|
706
1121
|
};
|
|
707
1122
|
readonly additionalProperties: false;
|
|
1123
|
+
readonly description: "Mutable fleet configuration. Applied as a full overwrite: any omitted field is reset to its default rather than left unchanged.";
|
|
708
1124
|
};
|
|
709
|
-
export declare const
|
|
1125
|
+
export declare const InviteCreateInputSchema: {
|
|
710
1126
|
readonly type: "object";
|
|
711
1127
|
readonly properties: {
|
|
712
|
-
readonly
|
|
1128
|
+
readonly email: {
|
|
1129
|
+
readonly type: "string";
|
|
1130
|
+
readonly format: "email";
|
|
1131
|
+
readonly description: "Email address of the user to invite.";
|
|
1132
|
+
readonly example: "email@example.com";
|
|
1133
|
+
};
|
|
1134
|
+
readonly role: {
|
|
1135
|
+
readonly type: "string";
|
|
1136
|
+
readonly description: "Role the invited user will be assigned on redemption. Can be 'Administrator' or 'User'.";
|
|
1137
|
+
readonly default: "User";
|
|
1138
|
+
readonly example: "User";
|
|
1139
|
+
readonly enum: readonly ["Administrator", "User"];
|
|
1140
|
+
};
|
|
1141
|
+
};
|
|
1142
|
+
readonly required: readonly ["email"];
|
|
1143
|
+
readonly additionalProperties: false;
|
|
1144
|
+
};
|
|
1145
|
+
export declare const InviteSchema: {
|
|
1146
|
+
readonly type: "object";
|
|
1147
|
+
readonly properties: {
|
|
1148
|
+
readonly id: {
|
|
713
1149
|
readonly type: "string";
|
|
714
1150
|
readonly description: "Unique identifier of the invitation.";
|
|
715
1151
|
readonly example: "65831dd20d20165489cbb868";
|
|
@@ -737,6 +1173,13 @@ export declare const InviteSchema: {
|
|
|
737
1173
|
readonly description: "Generated unique invite code.";
|
|
738
1174
|
readonly example: "7kUZnH7nnKUFfvc4NK2KQF";
|
|
739
1175
|
};
|
|
1176
|
+
readonly role: {
|
|
1177
|
+
readonly type: "string";
|
|
1178
|
+
readonly description: "Role the invited user will be assigned on redemption. Can be 'Administrator' or 'User'.";
|
|
1179
|
+
readonly default: "User";
|
|
1180
|
+
readonly example: "User";
|
|
1181
|
+
readonly enum: readonly ["Administrator", "User"];
|
|
1182
|
+
};
|
|
740
1183
|
};
|
|
741
1184
|
readonly required: readonly ["date_created"];
|
|
742
1185
|
readonly additionalProperties: false;
|
|
@@ -746,23 +1189,18 @@ export declare const InvoiceSchema: {
|
|
|
746
1189
|
readonly properties: {
|
|
747
1190
|
readonly id: {
|
|
748
1191
|
readonly type: "string";
|
|
749
|
-
readonly
|
|
750
|
-
readonly
|
|
751
|
-
readonly example: "415026b6-f00f-44f8-968d-fc6ef4d0fc6d";
|
|
1192
|
+
readonly description: "Unique identifier of the invoice.";
|
|
1193
|
+
readonly example: "in_1234567890xCrwxghOTj1234";
|
|
752
1194
|
};
|
|
753
|
-
readonly
|
|
1195
|
+
readonly number: {
|
|
754
1196
|
readonly type: "string";
|
|
755
|
-
readonly format: "uuid";
|
|
756
|
-
readonly description: "Unique identifier of the organization. UUID v4 string in canonical form";
|
|
757
|
-
readonly example: "415026b6-f00f-44f8-968d-fc6ef4d0fc6d";
|
|
758
1197
|
};
|
|
759
1198
|
readonly status: {
|
|
760
1199
|
readonly type: "string";
|
|
761
1200
|
readonly description: "Status of the invoice";
|
|
762
|
-
readonly example: "
|
|
763
|
-
readonly enum: readonly ["DRAFT", "COMMITTED", "VOID"];
|
|
1201
|
+
readonly example: "paid";
|
|
764
1202
|
};
|
|
765
|
-
readonly
|
|
1203
|
+
readonly total: {
|
|
766
1204
|
readonly type: "number";
|
|
767
1205
|
readonly format: "float";
|
|
768
1206
|
readonly description: "Total amount of the invoice";
|
|
@@ -771,405 +1209,180 @@ export declare const InvoiceSchema: {
|
|
|
771
1209
|
readonly currency: {
|
|
772
1210
|
readonly type: "string";
|
|
773
1211
|
readonly description: "Currency of the invoice";
|
|
774
|
-
readonly example: "
|
|
775
|
-
readonly enum: readonly ["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"];
|
|
776
|
-
};
|
|
777
|
-
readonly creditAdj: {
|
|
778
|
-
readonly type: "number";
|
|
779
|
-
readonly format: "float";
|
|
780
|
-
readonly description: "Total amount of credit adjustments";
|
|
781
|
-
readonly example: 0;
|
|
782
|
-
};
|
|
783
|
-
readonly refundAdj: {
|
|
784
|
-
readonly type: "number";
|
|
785
|
-
readonly format: "float";
|
|
786
|
-
readonly description: "Total amount of refund adjustments";
|
|
787
|
-
readonly example: 0;
|
|
1212
|
+
readonly example: "usd";
|
|
788
1213
|
};
|
|
789
|
-
readonly
|
|
1214
|
+
readonly created: {
|
|
790
1215
|
readonly type: "string";
|
|
791
|
-
readonly
|
|
792
|
-
readonly
|
|
1216
|
+
readonly format: "date-time";
|
|
1217
|
+
readonly description: "Timestamp when the invoice was issued. ISO 8601 date string in the UTC timezone.";
|
|
1218
|
+
readonly example: "2023-12-20T13:53:32.000Z";
|
|
793
1219
|
};
|
|
794
|
-
readonly
|
|
1220
|
+
readonly period_start: {
|
|
795
1221
|
readonly type: "string";
|
|
796
|
-
readonly
|
|
797
|
-
readonly
|
|
1222
|
+
readonly format: "date-time";
|
|
1223
|
+
readonly description: "Billing period start timestamp. ISO 8601 date string in the UTC timezone.";
|
|
1224
|
+
readonly example: "2023-12-20T13:53:32.000Z";
|
|
798
1225
|
};
|
|
799
|
-
readonly
|
|
1226
|
+
readonly period_end: {
|
|
800
1227
|
readonly type: "string";
|
|
801
|
-
readonly
|
|
802
|
-
readonly
|
|
803
|
-
|
|
804
|
-
readonly balance: {
|
|
805
|
-
readonly type: "number";
|
|
806
|
-
readonly format: "float";
|
|
807
|
-
readonly description: "Balance of the invoice";
|
|
808
|
-
readonly example: 100;
|
|
1228
|
+
readonly format: "date-time";
|
|
1229
|
+
readonly description: "Billing period end timestamp. ISO 8601 date string in the UTC timezone.";
|
|
1230
|
+
readonly example: "2023-12-20T13:53:32.000Z";
|
|
809
1231
|
};
|
|
810
|
-
readonly
|
|
1232
|
+
readonly invoice_pdf: {
|
|
811
1233
|
readonly type: "string";
|
|
812
|
-
readonly description: "Bundle keys of the invoice";
|
|
813
|
-
readonly example: "bundleKey1,bundleKey2";
|
|
814
|
-
};
|
|
815
|
-
readonly credits: {
|
|
816
|
-
readonly type: "array";
|
|
817
|
-
readonly items: {
|
|
818
|
-
readonly type: "object";
|
|
819
|
-
readonly properties: {
|
|
820
|
-
readonly id: {
|
|
821
|
-
readonly type: "string";
|
|
822
|
-
readonly format: "uuid";
|
|
823
|
-
readonly description: "Unique identifier of the invoice item. UUID v4 string in canonical form";
|
|
824
|
-
readonly example: "415026b6-f00f-44f8-968d-fc6ef4d0fc6d";
|
|
825
|
-
};
|
|
826
|
-
readonly linkedInvoiceItemId: {
|
|
827
|
-
readonly type: "string";
|
|
828
|
-
readonly format: "uuid";
|
|
829
|
-
readonly description: "Unique identifier of the linked invoice item. UUID v4 string in canonical form";
|
|
830
|
-
readonly example: "415026b6-f00f-44f8-968d-fc6ef4d0fc6d";
|
|
831
|
-
};
|
|
832
|
-
readonly productName: {
|
|
833
|
-
readonly type: "string";
|
|
834
|
-
readonly description: "Name of the product";
|
|
835
|
-
readonly example: "Research team";
|
|
836
|
-
};
|
|
837
|
-
readonly planName: {
|
|
838
|
-
readonly type: "string";
|
|
839
|
-
readonly description: "Name of the plan";
|
|
840
|
-
readonly example: "Plan A";
|
|
841
|
-
};
|
|
842
|
-
readonly phaseName: {
|
|
843
|
-
readonly type: "string";
|
|
844
|
-
readonly description: "Name of the phase";
|
|
845
|
-
readonly example: "Phase A";
|
|
846
|
-
};
|
|
847
|
-
readonly usageName: {
|
|
848
|
-
readonly type: "string";
|
|
849
|
-
readonly description: "Name of the usage";
|
|
850
|
-
readonly example: "Usage A";
|
|
851
|
-
};
|
|
852
|
-
readonly prettyProductName: {
|
|
853
|
-
readonly type: "string";
|
|
854
|
-
readonly description: "Pretty name of the product";
|
|
855
|
-
readonly example: "Research team";
|
|
856
|
-
};
|
|
857
|
-
readonly prettyPlanName: {
|
|
858
|
-
readonly type: "string";
|
|
859
|
-
readonly description: "Pretty name of the plan";
|
|
860
|
-
readonly example: "Plan A";
|
|
861
|
-
};
|
|
862
|
-
readonly prettyPhaseName: {
|
|
863
|
-
readonly type: "string";
|
|
864
|
-
readonly description: "Pretty name of the phase";
|
|
865
|
-
readonly example: "Phase A";
|
|
866
|
-
};
|
|
867
|
-
readonly prettyUsageName: {
|
|
868
|
-
readonly type: "string";
|
|
869
|
-
readonly description: "Pretty name of the usage";
|
|
870
|
-
readonly example: "Usage A";
|
|
871
|
-
};
|
|
872
|
-
readonly itemType: {
|
|
873
|
-
readonly type: "string";
|
|
874
|
-
readonly description: "Type of the invoice item";
|
|
875
|
-
readonly example: "EXTERNAL_CHARGE";
|
|
876
|
-
readonly enum: readonly ["EXTERNAL_CHARGE", "FIXED", "RECURRING", "REPAIR_ADJ", "CBA_ADJ", "CREDIT_ADJ", "ITEM_ADJ", "USAGE", "TAX", "PARENT_SUMMARY"];
|
|
877
|
-
};
|
|
878
|
-
readonly description: {
|
|
879
|
-
readonly type: "string";
|
|
880
|
-
readonly description: "Description of the invoice item";
|
|
881
|
-
readonly example: "Description of the invoice item";
|
|
882
|
-
};
|
|
883
|
-
readonly startDate: {
|
|
884
|
-
readonly type: "string";
|
|
885
|
-
readonly description: "Start date of the invoice item";
|
|
886
|
-
readonly example: "2019-01-01T00:00:00.000Z";
|
|
887
|
-
};
|
|
888
|
-
readonly endDate: {
|
|
889
|
-
readonly type: "string";
|
|
890
|
-
readonly description: "End date of the invoice item";
|
|
891
|
-
readonly example: "2019-01-01T00:00:00.000Z";
|
|
892
|
-
};
|
|
893
|
-
readonly amount: {
|
|
894
|
-
readonly type: "number";
|
|
895
|
-
readonly format: "float";
|
|
896
|
-
readonly description: "Amount of the invoice item";
|
|
897
|
-
readonly example: 100;
|
|
898
|
-
};
|
|
899
|
-
readonly rate: {
|
|
900
|
-
readonly type: "number";
|
|
901
|
-
readonly format: "float";
|
|
902
|
-
readonly description: "Rate of the invoice item";
|
|
903
|
-
readonly example: 100;
|
|
904
|
-
};
|
|
905
|
-
readonly currency: {
|
|
906
|
-
readonly type: "string";
|
|
907
|
-
readonly description: "Currency of the invoice item";
|
|
908
|
-
readonly example: "USD";
|
|
909
|
-
readonly enum: readonly ["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"];
|
|
910
|
-
};
|
|
911
|
-
readonly quantity: {
|
|
912
|
-
readonly type: "number";
|
|
913
|
-
readonly format: "float";
|
|
914
|
-
readonly description: "Quantity of the invoice item";
|
|
915
|
-
readonly example: 1;
|
|
916
|
-
};
|
|
917
|
-
readonly itemDetails: {
|
|
918
|
-
readonly type: "string";
|
|
919
|
-
readonly description: "Details of the invoice item";
|
|
920
|
-
readonly example: "Details of the invoice item";
|
|
921
|
-
};
|
|
922
|
-
readonly catalogEffectiveDate: {
|
|
923
|
-
readonly type: "string";
|
|
924
|
-
readonly description: "Effective date of the catalog";
|
|
925
|
-
readonly example: "2019-01-01T00:00:00.000Z";
|
|
926
|
-
};
|
|
927
|
-
readonly childItems: {
|
|
928
|
-
readonly type: "array";
|
|
929
|
-
readonly items: {
|
|
930
|
-
readonly oneOf: readonly [{
|
|
931
|
-
readonly type: "array";
|
|
932
|
-
}, {
|
|
933
|
-
readonly type: "boolean";
|
|
934
|
-
}, {
|
|
935
|
-
readonly type: "number";
|
|
936
|
-
}, {
|
|
937
|
-
readonly type: "object";
|
|
938
|
-
readonly additionalProperties: true;
|
|
939
|
-
}, {
|
|
940
|
-
readonly type: "string";
|
|
941
|
-
}];
|
|
942
|
-
};
|
|
943
|
-
readonly description: "Child items of the invoice item";
|
|
944
|
-
};
|
|
945
|
-
};
|
|
946
|
-
readonly additionalProperties: false;
|
|
947
|
-
};
|
|
948
|
-
readonly description: "Credits of the invoice";
|
|
949
|
-
};
|
|
950
|
-
readonly items: {
|
|
951
|
-
readonly type: "array";
|
|
952
|
-
readonly items: {
|
|
953
|
-
readonly type: "object";
|
|
954
|
-
readonly properties: {
|
|
955
|
-
readonly id: {
|
|
956
|
-
readonly type: "string";
|
|
957
|
-
readonly format: "uuid";
|
|
958
|
-
readonly description: "Unique identifier of the invoice item. UUID v4 string in canonical form";
|
|
959
|
-
readonly example: "415026b6-f00f-44f8-968d-fc6ef4d0fc6d";
|
|
960
|
-
};
|
|
961
|
-
readonly linkedInvoiceItemId: {
|
|
962
|
-
readonly type: "string";
|
|
963
|
-
readonly format: "uuid";
|
|
964
|
-
readonly description: "Unique identifier of the linked invoice item. UUID v4 string in canonical form";
|
|
965
|
-
readonly example: "415026b6-f00f-44f8-968d-fc6ef4d0fc6d";
|
|
966
|
-
};
|
|
967
|
-
readonly productName: {
|
|
968
|
-
readonly type: "string";
|
|
969
|
-
readonly description: "Name of the product";
|
|
970
|
-
readonly example: "Research team";
|
|
971
|
-
};
|
|
972
|
-
readonly planName: {
|
|
973
|
-
readonly type: "string";
|
|
974
|
-
readonly description: "Name of the plan";
|
|
975
|
-
readonly example: "Plan A";
|
|
976
|
-
};
|
|
977
|
-
readonly phaseName: {
|
|
978
|
-
readonly type: "string";
|
|
979
|
-
readonly description: "Name of the phase";
|
|
980
|
-
readonly example: "Phase A";
|
|
981
|
-
};
|
|
982
|
-
readonly usageName: {
|
|
983
|
-
readonly type: "string";
|
|
984
|
-
readonly description: "Name of the usage";
|
|
985
|
-
readonly example: "Usage A";
|
|
986
|
-
};
|
|
987
|
-
readonly prettyProductName: {
|
|
988
|
-
readonly type: "string";
|
|
989
|
-
readonly description: "Pretty name of the product";
|
|
990
|
-
readonly example: "Research team";
|
|
991
|
-
};
|
|
992
|
-
readonly prettyPlanName: {
|
|
993
|
-
readonly type: "string";
|
|
994
|
-
readonly description: "Pretty name of the plan";
|
|
995
|
-
readonly example: "Plan A";
|
|
996
|
-
};
|
|
997
|
-
readonly prettyPhaseName: {
|
|
998
|
-
readonly type: "string";
|
|
999
|
-
readonly description: "Pretty name of the phase";
|
|
1000
|
-
readonly example: "Phase A";
|
|
1001
|
-
};
|
|
1002
|
-
readonly prettyUsageName: {
|
|
1003
|
-
readonly type: "string";
|
|
1004
|
-
readonly description: "Pretty name of the usage";
|
|
1005
|
-
readonly example: "Usage A";
|
|
1006
|
-
};
|
|
1007
|
-
readonly itemType: {
|
|
1008
|
-
readonly type: "string";
|
|
1009
|
-
readonly description: "Type of the invoice item";
|
|
1010
|
-
readonly example: "EXTERNAL_CHARGE";
|
|
1011
|
-
readonly enum: readonly ["EXTERNAL_CHARGE", "FIXED", "RECURRING", "REPAIR_ADJ", "CBA_ADJ", "CREDIT_ADJ", "ITEM_ADJ", "USAGE", "TAX", "PARENT_SUMMARY"];
|
|
1012
|
-
};
|
|
1013
|
-
readonly description: {
|
|
1014
|
-
readonly type: "string";
|
|
1015
|
-
readonly description: "Description of the invoice item";
|
|
1016
|
-
readonly example: "Description of the invoice item";
|
|
1017
|
-
};
|
|
1018
|
-
readonly startDate: {
|
|
1019
|
-
readonly type: "string";
|
|
1020
|
-
readonly description: "Start date of the invoice item";
|
|
1021
|
-
readonly example: "2019-01-01T00:00:00.000Z";
|
|
1022
|
-
};
|
|
1023
|
-
readonly endDate: {
|
|
1024
|
-
readonly type: "string";
|
|
1025
|
-
readonly description: "End date of the invoice item";
|
|
1026
|
-
readonly example: "2019-01-01T00:00:00.000Z";
|
|
1027
|
-
};
|
|
1028
|
-
readonly amount: {
|
|
1029
|
-
readonly type: "number";
|
|
1030
|
-
readonly format: "float";
|
|
1031
|
-
readonly description: "Amount of the invoice item";
|
|
1032
|
-
readonly example: 100;
|
|
1033
|
-
};
|
|
1034
|
-
readonly rate: {
|
|
1035
|
-
readonly type: "number";
|
|
1036
|
-
readonly format: "float";
|
|
1037
|
-
readonly description: "Rate of the invoice item";
|
|
1038
|
-
readonly example: 100;
|
|
1039
|
-
};
|
|
1040
|
-
readonly currency: {
|
|
1041
|
-
readonly type: "string";
|
|
1042
|
-
readonly description: "Currency of the invoice item";
|
|
1043
|
-
readonly example: "USD";
|
|
1044
|
-
readonly enum: readonly ["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"];
|
|
1045
|
-
};
|
|
1046
|
-
readonly quantity: {
|
|
1047
|
-
readonly type: "number";
|
|
1048
|
-
readonly format: "float";
|
|
1049
|
-
readonly description: "Quantity of the invoice item";
|
|
1050
|
-
readonly example: 1;
|
|
1051
|
-
};
|
|
1052
|
-
readonly itemDetails: {
|
|
1053
|
-
readonly type: "string";
|
|
1054
|
-
readonly description: "Details of the invoice item";
|
|
1055
|
-
readonly example: "Details of the invoice item";
|
|
1056
|
-
};
|
|
1057
|
-
readonly catalogEffectiveDate: {
|
|
1058
|
-
readonly type: "string";
|
|
1059
|
-
readonly description: "Effective date of the catalog";
|
|
1060
|
-
readonly example: "2019-01-01T00:00:00.000Z";
|
|
1061
|
-
};
|
|
1062
|
-
readonly childItems: {
|
|
1063
|
-
readonly type: "array";
|
|
1064
|
-
readonly items: {
|
|
1065
|
-
readonly oneOf: readonly [{
|
|
1066
|
-
readonly type: "array";
|
|
1067
|
-
}, {
|
|
1068
|
-
readonly type: "boolean";
|
|
1069
|
-
}, {
|
|
1070
|
-
readonly type: "number";
|
|
1071
|
-
}, {
|
|
1072
|
-
readonly type: "object";
|
|
1073
|
-
readonly additionalProperties: true;
|
|
1074
|
-
}, {
|
|
1075
|
-
readonly type: "string";
|
|
1076
|
-
}];
|
|
1077
|
-
};
|
|
1078
|
-
readonly description: "Child items of the invoice item";
|
|
1079
|
-
};
|
|
1080
|
-
};
|
|
1081
|
-
readonly additionalProperties: false;
|
|
1082
|
-
};
|
|
1083
|
-
readonly description: "Items of the invoice";
|
|
1084
1234
|
};
|
|
1085
1235
|
};
|
|
1236
|
+
readonly required: readonly ["created", "period_start", "period_end"];
|
|
1086
1237
|
readonly additionalProperties: false;
|
|
1087
1238
|
};
|
|
1088
|
-
export declare const
|
|
1239
|
+
export declare const MarketplaceListingFilesSchema: {
|
|
1089
1240
|
readonly type: "object";
|
|
1090
1241
|
readonly properties: {
|
|
1091
|
-
readonly
|
|
1092
|
-
readonly type: "string";
|
|
1093
|
-
readonly maxLength: 63;
|
|
1094
|
-
readonly minLength: 1;
|
|
1095
|
-
readonly pattern: "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$";
|
|
1096
|
-
readonly description: "Id of the chart listing";
|
|
1097
|
-
readonly example: "portworx-enterprise-disaster-recovery-baremetal";
|
|
1098
|
-
};
|
|
1099
|
-
readonly name: {
|
|
1242
|
+
readonly chartYaml: {
|
|
1100
1243
|
readonly type: "string";
|
|
1101
|
-
readonly description: "
|
|
1102
|
-
readonly example: "
|
|
1103
|
-
};
|
|
1104
|
-
readonly developer: {
|
|
1105
|
-
readonly type: "string";
|
|
1106
|
-
readonly description: "Author of the chart listing";
|
|
1107
|
-
readonly example: "Portworx";
|
|
1244
|
+
readonly description: "Raw Chart.yaml content from the Helm chart";
|
|
1245
|
+
readonly example: "apiVersion: v2\nname: nginx-ingress\nversion: 1.18.2-cfke.45\nappVersion: 1.9.4";
|
|
1108
1246
|
};
|
|
1109
|
-
readonly
|
|
1247
|
+
readonly valuesYaml: {
|
|
1110
1248
|
readonly type: "string";
|
|
1111
|
-
readonly description: "
|
|
1112
|
-
readonly example: "
|
|
1249
|
+
readonly description: "Raw values.yaml content from the Helm chart";
|
|
1250
|
+
readonly example: "replicaCount: 1\nimage:\n repository: nginx\n tag: latest";
|
|
1113
1251
|
};
|
|
1114
|
-
readonly
|
|
1252
|
+
readonly valuesSchemaJson: {
|
|
1115
1253
|
readonly type: "string";
|
|
1116
|
-
readonly description: "
|
|
1117
|
-
readonly example: "
|
|
1254
|
+
readonly description: "JSON schema for values.yaml as a string";
|
|
1255
|
+
readonly example: "{\"type\":\"object\",\"properties\":{\"replicaCount\":{\"type\":\"number\"}}}";
|
|
1118
1256
|
};
|
|
1119
|
-
|
|
1257
|
+
};
|
|
1258
|
+
readonly additionalProperties: false;
|
|
1259
|
+
};
|
|
1260
|
+
export declare const MarketplaceListingSchema: {
|
|
1261
|
+
readonly type: "object";
|
|
1262
|
+
readonly properties: {
|
|
1263
|
+
readonly name: {
|
|
1120
1264
|
readonly type: "string";
|
|
1121
|
-
readonly description: "
|
|
1122
|
-
readonly example: "
|
|
1265
|
+
readonly description: "Name of the chart";
|
|
1266
|
+
readonly example: "nginx-ingress";
|
|
1123
1267
|
};
|
|
1124
|
-
readonly
|
|
1268
|
+
readonly versions: {
|
|
1125
1269
|
readonly type: "array";
|
|
1126
1270
|
readonly items: {
|
|
1127
1271
|
readonly type: "string";
|
|
1128
|
-
readonly
|
|
1272
|
+
readonly pattern: "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)\\.(0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?$";
|
|
1273
|
+
readonly description: "Specific version of the chart";
|
|
1274
|
+
readonly example: "1.18.2-cfke.45";
|
|
1129
1275
|
};
|
|
1130
|
-
readonly description: "
|
|
1276
|
+
readonly description: "Available versions of the chart";
|
|
1131
1277
|
};
|
|
1132
1278
|
readonly version_channels: {
|
|
1133
1279
|
readonly type: "array";
|
|
1134
1280
|
readonly items: {
|
|
1135
1281
|
readonly type: "string";
|
|
1136
1282
|
readonly pattern: "^(x|X|0|[1-9]\\d*)\\.(x|X|0|[1-9]\\d*)\\.(x|X|0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?$";
|
|
1137
|
-
readonly description: "Version
|
|
1138
|
-
readonly example: "
|
|
1283
|
+
readonly description: "Version channel pattern";
|
|
1284
|
+
readonly example: "1.18.x-cfke.x";
|
|
1139
1285
|
};
|
|
1286
|
+
readonly description: "Version channels for the chart";
|
|
1140
1287
|
};
|
|
1141
|
-
readonly
|
|
1142
|
-
readonly type: "
|
|
1143
|
-
readonly
|
|
1144
|
-
|
|
1145
|
-
|
|
1146
|
-
|
|
1288
|
+
readonly latestVersion: {
|
|
1289
|
+
readonly type: "string";
|
|
1290
|
+
readonly description: "Latest version of the chart";
|
|
1291
|
+
readonly example: "1.18.2-cfke.45";
|
|
1292
|
+
};
|
|
1293
|
+
readonly metadata: {
|
|
1294
|
+
readonly type: "object";
|
|
1295
|
+
readonly properties: {
|
|
1296
|
+
readonly name: {
|
|
1297
|
+
readonly type: "string";
|
|
1298
|
+
readonly description: "Chart name from metadata";
|
|
1299
|
+
readonly example: "nginx-ingress";
|
|
1300
|
+
};
|
|
1301
|
+
readonly version: {
|
|
1302
|
+
readonly type: "string";
|
|
1303
|
+
readonly description: "Chart version from metadata";
|
|
1304
|
+
readonly example: "1.18.2-cfke.45";
|
|
1305
|
+
};
|
|
1306
|
+
readonly description: {
|
|
1307
|
+
readonly type: "string";
|
|
1308
|
+
readonly description: "Chart description";
|
|
1309
|
+
readonly example: "NGINX Ingress Controller for Kubernetes";
|
|
1310
|
+
};
|
|
1311
|
+
readonly appVersion: {
|
|
1312
|
+
readonly type: "string";
|
|
1313
|
+
readonly description: "Application version";
|
|
1314
|
+
readonly example: "1.9.4";
|
|
1315
|
+
};
|
|
1316
|
+
readonly apiVersion: {
|
|
1317
|
+
readonly type: "string";
|
|
1318
|
+
readonly description: "Helm API version";
|
|
1319
|
+
readonly example: "v2";
|
|
1320
|
+
};
|
|
1321
|
+
readonly keywords: {
|
|
1322
|
+
readonly type: "array";
|
|
1323
|
+
readonly items: {
|
|
1147
1324
|
readonly type: "string";
|
|
1148
|
-
readonly pattern: "^(x|X|0|[1-9]\\d*)\\.(x|X|0|[1-9]\\d*)\\.(x|X|0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?$";
|
|
1149
|
-
readonly description: "Version of the chart.";
|
|
1150
|
-
readonly example: "2.1.1-cfke.123";
|
|
1151
1325
|
};
|
|
1152
|
-
readonly
|
|
1326
|
+
readonly description: "Chart keywords";
|
|
1327
|
+
readonly example: readonly ["ingress", "nginx", "load-balancer"];
|
|
1328
|
+
};
|
|
1329
|
+
readonly home: {
|
|
1330
|
+
readonly type: "string";
|
|
1331
|
+
readonly description: "Chart home URL";
|
|
1332
|
+
readonly example: "https://kubernetes.github.io/ingress-nginx/";
|
|
1333
|
+
};
|
|
1334
|
+
readonly icon: {
|
|
1335
|
+
readonly type: "string";
|
|
1336
|
+
readonly description: "A URL to an SVG or PNG image to be used as an icon";
|
|
1337
|
+
readonly example: "https://cloudfleet.ai/images/marketplace/icons/ingress-nginx.png";
|
|
1338
|
+
};
|
|
1339
|
+
readonly sources: {
|
|
1340
|
+
readonly type: "array";
|
|
1341
|
+
readonly items: {
|
|
1153
1342
|
readonly type: "string";
|
|
1154
|
-
readonly description: "Schema of the chart values. JSON Schema as string";
|
|
1155
1343
|
};
|
|
1156
|
-
readonly
|
|
1157
|
-
|
|
1158
|
-
|
|
1159
|
-
|
|
1344
|
+
readonly description: "Chart source URLs";
|
|
1345
|
+
readonly example: readonly ["https://github.com/kubernetes/ingress-nginx"];
|
|
1346
|
+
};
|
|
1347
|
+
readonly maintainers: {
|
|
1348
|
+
readonly type: "array";
|
|
1349
|
+
readonly items: {
|
|
1350
|
+
readonly type: "object";
|
|
1351
|
+
readonly properties: {
|
|
1352
|
+
readonly name: {
|
|
1353
|
+
readonly type: "string";
|
|
1354
|
+
readonly description: "Maintainer name";
|
|
1355
|
+
readonly example: "NGINX Team";
|
|
1356
|
+
};
|
|
1357
|
+
readonly email: {
|
|
1358
|
+
readonly type: "string";
|
|
1359
|
+
readonly description: "Maintainer email";
|
|
1360
|
+
readonly example: "support@nginx.org";
|
|
1361
|
+
};
|
|
1362
|
+
};
|
|
1363
|
+
readonly required: readonly ["name"];
|
|
1364
|
+
readonly additionalProperties: false;
|
|
1160
1365
|
};
|
|
1366
|
+
readonly description: "Chart maintainers";
|
|
1161
1367
|
};
|
|
1162
|
-
readonly required: readonly ["version", "schema", "placeholder"];
|
|
1163
|
-
readonly additionalProperties: false;
|
|
1164
1368
|
};
|
|
1369
|
+
readonly required: readonly ["name", "version"];
|
|
1370
|
+
readonly additionalProperties: false;
|
|
1371
|
+
readonly description: "Chart metadata";
|
|
1165
1372
|
};
|
|
1166
1373
|
};
|
|
1167
|
-
readonly required: readonly ["
|
|
1374
|
+
readonly required: readonly ["name", "versions", "version_channels", "latestVersion"];
|
|
1168
1375
|
readonly additionalProperties: false;
|
|
1169
1376
|
};
|
|
1170
1377
|
export declare const OrganizationCreateInputSchema: {
|
|
1171
1378
|
readonly type: "object";
|
|
1172
1379
|
readonly properties: {
|
|
1380
|
+
readonly type: {
|
|
1381
|
+
readonly type: "string";
|
|
1382
|
+
readonly description: "Type of the organization. `business` for legal entities, `personal` for individuals.";
|
|
1383
|
+
readonly example: "business";
|
|
1384
|
+
readonly enum: readonly ["business", "personal"];
|
|
1385
|
+
};
|
|
1173
1386
|
readonly email: {
|
|
1174
1387
|
readonly type: "string";
|
|
1175
1388
|
readonly format: "email";
|
|
@@ -1178,11 +1391,13 @@ export declare const OrganizationCreateInputSchema: {
|
|
|
1178
1391
|
};
|
|
1179
1392
|
readonly first_name: {
|
|
1180
1393
|
readonly type: "string";
|
|
1394
|
+
readonly minLength: 1;
|
|
1181
1395
|
readonly description: "First name of the billing contact person.";
|
|
1182
1396
|
readonly example: "John";
|
|
1183
1397
|
};
|
|
1184
1398
|
readonly last_name: {
|
|
1185
1399
|
readonly type: "string";
|
|
1400
|
+
readonly minLength: 1;
|
|
1186
1401
|
readonly description: "Last name of the billing contact person.";
|
|
1187
1402
|
readonly example: "Doe";
|
|
1188
1403
|
};
|
|
@@ -1200,7 +1415,19 @@ export declare const OrganizationCreateInputSchema: {
|
|
|
1200
1415
|
readonly description: "Password for the root account. Must be at least 8 characters long and contain at least one uppercase letter, one lowercase letter, one number and one special character.";
|
|
1201
1416
|
};
|
|
1202
1417
|
};
|
|
1203
|
-
readonly required: readonly ["email", "first_name", "last_name", "company_name", "password"];
|
|
1418
|
+
readonly required: readonly ["type", "email", "first_name", "last_name", "company_name", "password"];
|
|
1419
|
+
readonly additionalProperties: false;
|
|
1420
|
+
};
|
|
1421
|
+
export declare const OrganizationCreateOutputSchema: {
|
|
1422
|
+
readonly type: "object";
|
|
1423
|
+
readonly properties: {
|
|
1424
|
+
readonly id: {
|
|
1425
|
+
readonly type: "string";
|
|
1426
|
+
readonly description: "Unique identifier of the newly created organization. Generated by the API and safe to use for client-side tracking immediately.";
|
|
1427
|
+
readonly example: "organization-id";
|
|
1428
|
+
};
|
|
1429
|
+
};
|
|
1430
|
+
readonly required: readonly ["id"];
|
|
1204
1431
|
readonly additionalProperties: false;
|
|
1205
1432
|
};
|
|
1206
1433
|
export declare const OrganizationSchema: {
|
|
@@ -1219,6 +1446,12 @@ export declare const OrganizationSchema: {
|
|
|
1219
1446
|
readonly description: "Name of the legal entity. This name will be used in invoices. Use your first and last name for individual accounts.";
|
|
1220
1447
|
readonly example: "ACME Corp.";
|
|
1221
1448
|
};
|
|
1449
|
+
readonly type: {
|
|
1450
|
+
readonly type: "string";
|
|
1451
|
+
readonly description: "Type of the organization. `business` for legal entities, `personal` for individuals.";
|
|
1452
|
+
readonly example: "business";
|
|
1453
|
+
readonly enum: readonly ["business", "personal"];
|
|
1454
|
+
};
|
|
1222
1455
|
readonly date_created: {
|
|
1223
1456
|
readonly type: "string";
|
|
1224
1457
|
readonly format: "date-time";
|
|
@@ -1250,6 +1483,17 @@ export declare const OrganizationSchema: {
|
|
|
1250
1483
|
readonly description: "Available number of Pro clusters that can be created.";
|
|
1251
1484
|
readonly example: 999;
|
|
1252
1485
|
};
|
|
1486
|
+
readonly enterprise_clusters_max: {
|
|
1487
|
+
readonly type: "integer";
|
|
1488
|
+
readonly minimum: 0;
|
|
1489
|
+
readonly description: "Maximum number of Enterprise clusters that can be created.";
|
|
1490
|
+
readonly example: 999;
|
|
1491
|
+
};
|
|
1492
|
+
readonly enterprise_clusters_available: {
|
|
1493
|
+
readonly type: "integer";
|
|
1494
|
+
readonly description: "Available number of Enterprise clusters that can be created.";
|
|
1495
|
+
readonly example: 999;
|
|
1496
|
+
};
|
|
1253
1497
|
readonly fleets_max: {
|
|
1254
1498
|
readonly type: "integer";
|
|
1255
1499
|
readonly minimum: 0;
|
|
@@ -1269,7 +1513,7 @@ export declare const OrganizationSchema: {
|
|
|
1269
1513
|
readonly type: "array";
|
|
1270
1514
|
readonly items: {
|
|
1271
1515
|
readonly type: "string";
|
|
1272
|
-
readonly example: "northamerica-central-
|
|
1516
|
+
readonly example: "northamerica-central-1a";
|
|
1273
1517
|
};
|
|
1274
1518
|
readonly minItems: 1;
|
|
1275
1519
|
readonly description: "List of Cloudfleet control plane regions available for the organization.";
|
|
@@ -1282,12 +1526,12 @@ export declare const OrganizationSchema: {
|
|
|
1282
1526
|
readonly id: {
|
|
1283
1527
|
readonly type: "string";
|
|
1284
1528
|
readonly description: "Id of the control plane version. Used in API calls.";
|
|
1285
|
-
readonly example: "1.
|
|
1529
|
+
readonly example: "1.33.x-cfke.x";
|
|
1286
1530
|
};
|
|
1287
1531
|
readonly label: {
|
|
1288
1532
|
readonly type: "string";
|
|
1289
1533
|
readonly description: "Label of the control plane version. Used in frontent UI.";
|
|
1290
|
-
readonly example: "1.
|
|
1534
|
+
readonly example: "1.33.x (Always latest 1.33 patch version)";
|
|
1291
1535
|
};
|
|
1292
1536
|
};
|
|
1293
1537
|
readonly required: readonly ["id", "label"];
|
|
@@ -1296,8 +1540,14 @@ export declare const OrganizationSchema: {
|
|
|
1296
1540
|
readonly minItems: 1;
|
|
1297
1541
|
readonly description: "List of CFKE control plane versions available for the organization.";
|
|
1298
1542
|
};
|
|
1543
|
+
readonly cfcr_storage_gb: {
|
|
1544
|
+
readonly type: "integer";
|
|
1545
|
+
readonly minimum: -1;
|
|
1546
|
+
readonly description: "Organization-level maximum CFCR storage volume in GB. -1 means no limit.";
|
|
1547
|
+
readonly example: 500;
|
|
1548
|
+
};
|
|
1299
1549
|
};
|
|
1300
|
-
readonly required: readonly ["basic_clusters_max", "basic_clusters_available", "pro_clusters_max", "pro_clusters_available", "fleets_max", "cluster_tiers", "regions", "versions"];
|
|
1550
|
+
readonly required: readonly ["basic_clusters_max", "basic_clusters_available", "pro_clusters_max", "pro_clusters_available", "enterprise_clusters_max", "enterprise_clusters_available", "fleets_max", "cluster_tiers", "regions", "versions", "cfcr_storage_gb"];
|
|
1301
1551
|
readonly additionalProperties: false;
|
|
1302
1552
|
readonly description: "For security reasons, platform quota is controlled by Cloudfleet and can be updated only by Cloudfleet administrators. Please open a support ticket if you need to change the platform quota.";
|
|
1303
1553
|
};
|
|
@@ -1306,8 +1556,14 @@ export declare const OrganizationSchema: {
|
|
|
1306
1556
|
readonly description: "Status of the organization. Can be `active` or `closed`, or `suspended`.";
|
|
1307
1557
|
readonly enum: readonly ["active", "closed", "suspended"];
|
|
1308
1558
|
};
|
|
1559
|
+
readonly verification: {
|
|
1560
|
+
readonly type: "string";
|
|
1561
|
+
readonly description: "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.";
|
|
1562
|
+
readonly example: "verified";
|
|
1563
|
+
readonly enum: readonly ["none", "submitted", "verified"];
|
|
1564
|
+
};
|
|
1309
1565
|
};
|
|
1310
|
-
readonly required: readonly ["id", "date_created", "quota", "status"];
|
|
1566
|
+
readonly required: readonly ["id", "type", "date_created", "quota", "status", "verification"];
|
|
1311
1567
|
readonly additionalProperties: false;
|
|
1312
1568
|
};
|
|
1313
1569
|
export declare const PaymentMethodSchema: {
|
|
@@ -1315,26 +1571,19 @@ export declare const PaymentMethodSchema: {
|
|
|
1315
1571
|
readonly properties: {
|
|
1316
1572
|
readonly id: {
|
|
1317
1573
|
readonly type: "string";
|
|
1318
|
-
readonly
|
|
1319
|
-
readonly
|
|
1320
|
-
readonly example: "e94d30ec-a2dd-4dcb-832c-ac2be144ba91";
|
|
1321
|
-
};
|
|
1322
|
-
readonly setup: {
|
|
1323
|
-
readonly type: "boolean";
|
|
1324
|
-
readonly description: "Whether organization payment method was set up and ready to use for payments.";
|
|
1325
|
-
readonly example: true;
|
|
1574
|
+
readonly description: "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.";
|
|
1575
|
+
readonly example: "pm_1MtwBwLkdIwHu7ix28a3tqPa";
|
|
1326
1576
|
};
|
|
1327
1577
|
readonly type: {
|
|
1328
1578
|
readonly type: "string";
|
|
1329
|
-
readonly
|
|
1330
|
-
readonly description: "Payment method type type. Only `card` payments supported at the moment.";
|
|
1579
|
+
readonly description: "Payment method type. `card`, `sepa_debit` for SEPA Direct Debit (business accounts only), or `bank_transfer` for paying invoices by bank transfer.";
|
|
1331
1580
|
readonly example: "card";
|
|
1332
|
-
readonly enum: readonly ["card"];
|
|
1581
|
+
readonly enum: readonly ["card", "sepa_debit", "bank_transfer"];
|
|
1333
1582
|
};
|
|
1334
1583
|
readonly last4: {
|
|
1335
1584
|
readonly type: "string";
|
|
1336
1585
|
readonly nullable: true;
|
|
1337
|
-
readonly description: "Last 4 digits of the payment card number.";
|
|
1586
|
+
readonly description: "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.";
|
|
1338
1587
|
readonly example: "4242";
|
|
1339
1588
|
};
|
|
1340
1589
|
readonly exp_month: {
|
|
@@ -1342,25 +1591,637 @@ export declare const PaymentMethodSchema: {
|
|
|
1342
1591
|
readonly minimum: 1;
|
|
1343
1592
|
readonly maximum: 12;
|
|
1344
1593
|
readonly nullable: true;
|
|
1345
|
-
readonly description: "Two-digit number representing the card's expiration month.";
|
|
1346
|
-
readonly example:
|
|
1594
|
+
readonly description: "Two-digit number representing the card's expiration month. Null for SEPA Direct Debit and bank transfer.";
|
|
1595
|
+
readonly example: 12;
|
|
1347
1596
|
};
|
|
1348
1597
|
readonly exp_year: {
|
|
1349
1598
|
readonly type: "integer";
|
|
1350
|
-
readonly minimum: 2024;
|
|
1351
1599
|
readonly nullable: true;
|
|
1352
|
-
readonly description: "Four-digit number representing the card's expiration year.";
|
|
1353
|
-
readonly example:
|
|
1600
|
+
readonly description: "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.";
|
|
1601
|
+
readonly example: 2028;
|
|
1354
1602
|
};
|
|
1355
1603
|
readonly brand: {
|
|
1356
1604
|
readonly type: "string";
|
|
1357
1605
|
readonly nullable: true;
|
|
1358
|
-
readonly description: "Payment card brand
|
|
1606
|
+
readonly description: "Payment card brand as reported by Stripe, e.g. `visa`, `mastercard`, `amex`, `cartes_bancaires`, or `unknown`. Null for SEPA Direct Debit and bank transfer.";
|
|
1359
1607
|
readonly example: "visa";
|
|
1360
|
-
|
|
1608
|
+
};
|
|
1609
|
+
readonly iban: {
|
|
1610
|
+
readonly type: "string";
|
|
1611
|
+
readonly nullable: true;
|
|
1612
|
+
readonly description: "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.";
|
|
1613
|
+
readonly example: "DE11243015658023127510";
|
|
1614
|
+
};
|
|
1615
|
+
readonly bic: {
|
|
1616
|
+
readonly type: "string";
|
|
1617
|
+
readonly nullable: true;
|
|
1618
|
+
readonly description: "BIC/SWIFT of the destination bank for bank transfers. Set only for `bank_transfer`; null otherwise.";
|
|
1619
|
+
readonly example: "SOGEDEFFXXX";
|
|
1620
|
+
};
|
|
1621
|
+
readonly account_holder_name: {
|
|
1622
|
+
readonly type: "string";
|
|
1623
|
+
readonly nullable: true;
|
|
1624
|
+
readonly description: "Account holder name of the destination bank account for bank transfers. Set only for `bank_transfer`; null otherwise.";
|
|
1625
|
+
readonly example: "Cloudfleet GmbH";
|
|
1626
|
+
};
|
|
1627
|
+
readonly is_default: {
|
|
1628
|
+
readonly type: "boolean";
|
|
1629
|
+
readonly description: "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).";
|
|
1630
|
+
readonly example: true;
|
|
1631
|
+
};
|
|
1632
|
+
};
|
|
1633
|
+
readonly required: readonly ["id", "type", "last4", "exp_month", "exp_year", "brand", "iban", "bic", "account_holder_name", "is_default"];
|
|
1634
|
+
readonly additionalProperties: false;
|
|
1635
|
+
};
|
|
1636
|
+
export declare const PlatformQuotaSchema: {
|
|
1637
|
+
readonly type: "object";
|
|
1638
|
+
readonly properties: {
|
|
1639
|
+
readonly basic_clusters_max: {
|
|
1640
|
+
readonly type: "integer";
|
|
1641
|
+
readonly minimum: 0;
|
|
1642
|
+
readonly description: "Maximum number of Basic clusters that can be created.";
|
|
1643
|
+
readonly example: 999;
|
|
1644
|
+
};
|
|
1645
|
+
readonly basic_clusters_available: {
|
|
1646
|
+
readonly type: "integer";
|
|
1647
|
+
readonly description: "Available number of Basic clusters that can be created.";
|
|
1648
|
+
readonly example: 999;
|
|
1649
|
+
};
|
|
1650
|
+
readonly pro_clusters_max: {
|
|
1651
|
+
readonly type: "integer";
|
|
1652
|
+
readonly minimum: 0;
|
|
1653
|
+
readonly description: "Maximum number of Pro clusters that can be created.";
|
|
1654
|
+
readonly example: 999;
|
|
1655
|
+
};
|
|
1656
|
+
readonly pro_clusters_available: {
|
|
1657
|
+
readonly type: "integer";
|
|
1658
|
+
readonly description: "Available number of Pro clusters that can be created.";
|
|
1659
|
+
readonly example: 999;
|
|
1660
|
+
};
|
|
1661
|
+
readonly enterprise_clusters_max: {
|
|
1662
|
+
readonly type: "integer";
|
|
1663
|
+
readonly minimum: 0;
|
|
1664
|
+
readonly description: "Maximum number of Enterprise clusters that can be created.";
|
|
1665
|
+
readonly example: 999;
|
|
1666
|
+
};
|
|
1667
|
+
readonly enterprise_clusters_available: {
|
|
1668
|
+
readonly type: "integer";
|
|
1669
|
+
readonly description: "Available number of Enterprise clusters that can be created.";
|
|
1670
|
+
readonly example: 999;
|
|
1671
|
+
};
|
|
1672
|
+
readonly fleets_max: {
|
|
1673
|
+
readonly type: "integer";
|
|
1674
|
+
readonly minimum: 0;
|
|
1675
|
+
readonly description: "Maximum number of fleets that can be created per cluster.";
|
|
1676
|
+
readonly example: 999;
|
|
1677
|
+
};
|
|
1678
|
+
readonly cluster_tiers: {
|
|
1679
|
+
readonly type: "array";
|
|
1680
|
+
readonly items: {
|
|
1681
|
+
readonly type: "string";
|
|
1682
|
+
readonly example: "basic";
|
|
1683
|
+
};
|
|
1684
|
+
readonly minItems: 0;
|
|
1685
|
+
readonly description: "List of Cloudfleet cluster tiers available for the organization.";
|
|
1686
|
+
};
|
|
1687
|
+
readonly regions: {
|
|
1688
|
+
readonly type: "array";
|
|
1689
|
+
readonly items: {
|
|
1690
|
+
readonly type: "string";
|
|
1691
|
+
readonly example: "northamerica-central-1a";
|
|
1692
|
+
};
|
|
1693
|
+
readonly minItems: 1;
|
|
1694
|
+
readonly description: "List of Cloudfleet control plane regions available for the organization.";
|
|
1695
|
+
};
|
|
1696
|
+
readonly versions: {
|
|
1697
|
+
readonly type: "array";
|
|
1698
|
+
readonly items: {
|
|
1699
|
+
readonly type: "object";
|
|
1700
|
+
readonly properties: {
|
|
1701
|
+
readonly id: {
|
|
1702
|
+
readonly type: "string";
|
|
1703
|
+
readonly description: "Id of the control plane version. Used in API calls.";
|
|
1704
|
+
readonly example: "1.33.x-cfke.x";
|
|
1705
|
+
};
|
|
1706
|
+
readonly label: {
|
|
1707
|
+
readonly type: "string";
|
|
1708
|
+
readonly description: "Label of the control plane version. Used in frontent UI.";
|
|
1709
|
+
readonly example: "1.33.x (Always latest 1.33 patch version)";
|
|
1710
|
+
};
|
|
1711
|
+
};
|
|
1712
|
+
readonly required: readonly ["id", "label"];
|
|
1713
|
+
readonly additionalProperties: false;
|
|
1714
|
+
};
|
|
1715
|
+
readonly minItems: 1;
|
|
1716
|
+
readonly description: "List of CFKE control plane versions available for the organization.";
|
|
1717
|
+
};
|
|
1718
|
+
readonly cfcr_storage_gb: {
|
|
1719
|
+
readonly type: "integer";
|
|
1720
|
+
readonly minimum: -1;
|
|
1721
|
+
readonly description: "Organization-level maximum CFCR storage volume in GB. -1 means no limit.";
|
|
1722
|
+
readonly example: 500;
|
|
1723
|
+
};
|
|
1724
|
+
};
|
|
1725
|
+
readonly required: readonly ["basic_clusters_max", "basic_clusters_available", "pro_clusters_max", "pro_clusters_available", "enterprise_clusters_max", "enterprise_clusters_available", "fleets_max", "cluster_tiers", "regions", "versions", "cfcr_storage_gb"];
|
|
1726
|
+
readonly additionalProperties: false;
|
|
1727
|
+
};
|
|
1728
|
+
export declare const RegistryRepositorySchema: {
|
|
1729
|
+
readonly type: "object";
|
|
1730
|
+
readonly properties: {
|
|
1731
|
+
readonly name: {
|
|
1732
|
+
readonly type: "string";
|
|
1733
|
+
readonly description: "Repository name.";
|
|
1734
|
+
readonly example: "my-app";
|
|
1735
|
+
};
|
|
1736
|
+
readonly region: {
|
|
1737
|
+
readonly type: "string";
|
|
1738
|
+
readonly description: "Registry region.";
|
|
1739
|
+
readonly example: "northamerica";
|
|
1740
|
+
};
|
|
1741
|
+
readonly uri: {
|
|
1742
|
+
readonly type: "string";
|
|
1743
|
+
readonly description: "Full URI of the repository.";
|
|
1744
|
+
readonly example: "ssds123e-6651-4e5d-9c04-079f6532989b.northamerica.registry.cloudfleet.dev/my-app";
|
|
1745
|
+
};
|
|
1746
|
+
};
|
|
1747
|
+
readonly required: readonly ["name", "region", "uri"];
|
|
1748
|
+
readonly additionalProperties: false;
|
|
1749
|
+
};
|
|
1750
|
+
export declare const RegistryRepositoryWithTagsSchema: {
|
|
1751
|
+
readonly type: "object";
|
|
1752
|
+
readonly properties: {
|
|
1753
|
+
readonly name: {
|
|
1754
|
+
readonly type: "string";
|
|
1755
|
+
readonly description: "Repository name.";
|
|
1756
|
+
readonly example: "my-app";
|
|
1757
|
+
};
|
|
1758
|
+
readonly region: {
|
|
1759
|
+
readonly type: "string";
|
|
1760
|
+
readonly description: "Registry region.";
|
|
1761
|
+
readonly example: "northamerica";
|
|
1762
|
+
};
|
|
1763
|
+
readonly uri: {
|
|
1764
|
+
readonly type: "string";
|
|
1765
|
+
readonly description: "Full URI of the repository.";
|
|
1766
|
+
readonly example: "ssds123e-6651-4e5d-9c04-079f6532989b.northamerica.registry.cloudfleet.dev/my-app";
|
|
1767
|
+
};
|
|
1768
|
+
readonly tags: {
|
|
1769
|
+
readonly type: "array";
|
|
1770
|
+
readonly items: {
|
|
1771
|
+
readonly type: "object";
|
|
1772
|
+
readonly properties: {
|
|
1773
|
+
readonly name: {
|
|
1774
|
+
readonly type: "string";
|
|
1775
|
+
readonly description: "Tag name.";
|
|
1776
|
+
readonly example: "latest";
|
|
1777
|
+
};
|
|
1778
|
+
readonly size: {
|
|
1779
|
+
readonly type: "number";
|
|
1780
|
+
readonly format: "float";
|
|
1781
|
+
readonly description: "Size of the tag in bytes.";
|
|
1782
|
+
readonly example: 123456789;
|
|
1783
|
+
};
|
|
1784
|
+
readonly mediaType: {
|
|
1785
|
+
readonly type: "string";
|
|
1786
|
+
readonly description: "Media type of the manifest.";
|
|
1787
|
+
readonly example: "application/vnd.docker.distribution.manifest.v2+json";
|
|
1788
|
+
};
|
|
1789
|
+
readonly platforms: {
|
|
1790
|
+
readonly type: "array";
|
|
1791
|
+
readonly items: {
|
|
1792
|
+
readonly type: "string";
|
|
1793
|
+
};
|
|
1794
|
+
readonly description: "Array of platform strings for multi-arch images (e.g., linux/amd64, linux/arm64).";
|
|
1795
|
+
readonly example: readonly ["linux/amd64", "linux/arm64"];
|
|
1796
|
+
};
|
|
1797
|
+
};
|
|
1798
|
+
readonly required: readonly ["name", "size"];
|
|
1799
|
+
readonly additionalProperties: false;
|
|
1800
|
+
};
|
|
1801
|
+
readonly description: "Array of tags in the repository.";
|
|
1802
|
+
};
|
|
1803
|
+
readonly totalSize: {
|
|
1804
|
+
readonly type: "number";
|
|
1805
|
+
readonly format: "float";
|
|
1806
|
+
readonly description: "Total size of all tags in the repository in bytes.";
|
|
1807
|
+
readonly example: 987654321;
|
|
1808
|
+
};
|
|
1809
|
+
};
|
|
1810
|
+
readonly required: readonly ["name", "region", "uri", "tags", "totalSize"];
|
|
1811
|
+
readonly additionalProperties: false;
|
|
1812
|
+
};
|
|
1813
|
+
export declare const RegistryTagSchema: {
|
|
1814
|
+
readonly type: "object";
|
|
1815
|
+
readonly properties: {
|
|
1816
|
+
readonly name: {
|
|
1817
|
+
readonly type: "string";
|
|
1818
|
+
readonly description: "Tag name.";
|
|
1819
|
+
readonly example: "latest";
|
|
1820
|
+
};
|
|
1821
|
+
readonly digest: {
|
|
1822
|
+
readonly type: "string";
|
|
1823
|
+
readonly description: "Manifest digest for pulling by digest.";
|
|
1824
|
+
readonly example: "sha256:abcd1234ef567890abcd1234ef567890abcd1234ef567890abcd1234ef567890";
|
|
1825
|
+
};
|
|
1826
|
+
readonly mediaType: {
|
|
1827
|
+
readonly type: "string";
|
|
1828
|
+
readonly description: "Media type of the manifest.";
|
|
1829
|
+
readonly example: "application/vnd.docker.distribution.manifest.v2+json";
|
|
1830
|
+
};
|
|
1831
|
+
readonly config: {
|
|
1832
|
+
readonly type: "object";
|
|
1833
|
+
readonly properties: {
|
|
1834
|
+
readonly size: {
|
|
1835
|
+
readonly type: "number";
|
|
1836
|
+
readonly format: "float";
|
|
1837
|
+
readonly description: "Size of the config in bytes.";
|
|
1838
|
+
readonly example: 1234;
|
|
1839
|
+
};
|
|
1840
|
+
};
|
|
1841
|
+
readonly required: readonly ["size"];
|
|
1842
|
+
readonly additionalProperties: false;
|
|
1843
|
+
readonly description: "Manifest config metadata.";
|
|
1844
|
+
};
|
|
1845
|
+
readonly layers: {
|
|
1846
|
+
readonly type: "array";
|
|
1847
|
+
readonly items: {
|
|
1848
|
+
readonly type: "object";
|
|
1849
|
+
readonly properties: {
|
|
1850
|
+
readonly digest: {
|
|
1851
|
+
readonly type: "string";
|
|
1852
|
+
readonly description: "Digest of the layer.";
|
|
1853
|
+
readonly example: "sha256:abcd1234ef567890abcd1234ef567890abcd1234ef567890abcd1234ef567890";
|
|
1854
|
+
};
|
|
1855
|
+
readonly size: {
|
|
1856
|
+
readonly type: "number";
|
|
1857
|
+
readonly format: "float";
|
|
1858
|
+
readonly description: "Size of the layer in bytes.";
|
|
1859
|
+
readonly example: 5678;
|
|
1860
|
+
};
|
|
1861
|
+
};
|
|
1862
|
+
readonly required: readonly ["size"];
|
|
1863
|
+
readonly additionalProperties: false;
|
|
1864
|
+
};
|
|
1865
|
+
readonly description: "Array of layer metadata.";
|
|
1866
|
+
};
|
|
1867
|
+
readonly manifests: {
|
|
1868
|
+
readonly type: "array";
|
|
1869
|
+
readonly items: {
|
|
1870
|
+
readonly type: "object";
|
|
1871
|
+
readonly properties: {
|
|
1872
|
+
readonly digest: {
|
|
1873
|
+
readonly type: "string";
|
|
1874
|
+
readonly description: "Digest of the manifest.";
|
|
1875
|
+
readonly example: "sha256:abcd1234ef567890abcd1234ef567890abcd1234ef567890abcd1234ef567890";
|
|
1876
|
+
};
|
|
1877
|
+
readonly platform: {
|
|
1878
|
+
readonly type: "object";
|
|
1879
|
+
readonly properties: {
|
|
1880
|
+
readonly architecture: {
|
|
1881
|
+
readonly type: "string";
|
|
1882
|
+
readonly description: "Architecture of the platform.";
|
|
1883
|
+
readonly example: "amd64";
|
|
1884
|
+
};
|
|
1885
|
+
readonly os: {
|
|
1886
|
+
readonly type: "string";
|
|
1887
|
+
readonly description: "Operating system of the platform.";
|
|
1888
|
+
readonly example: "linux";
|
|
1889
|
+
};
|
|
1890
|
+
readonly variant: {
|
|
1891
|
+
readonly type: "string";
|
|
1892
|
+
readonly description: "Variant of the platform (e.g., v7, v8 for ARM).";
|
|
1893
|
+
readonly example: "v8";
|
|
1894
|
+
};
|
|
1895
|
+
};
|
|
1896
|
+
readonly required: readonly ["architecture", "os"];
|
|
1897
|
+
readonly additionalProperties: false;
|
|
1898
|
+
readonly description: "Platform information for the manifest.";
|
|
1899
|
+
};
|
|
1900
|
+
readonly layers: {
|
|
1901
|
+
readonly type: "array";
|
|
1902
|
+
readonly items: {
|
|
1903
|
+
readonly type: "object";
|
|
1904
|
+
readonly properties: {
|
|
1905
|
+
readonly digest: {
|
|
1906
|
+
readonly type: "string";
|
|
1907
|
+
readonly description: "Digest of the layer.";
|
|
1908
|
+
readonly example: "sha256:abcd1234ef567890abcd1234ef567890abcd1234ef567890abcd1234ef567890";
|
|
1909
|
+
};
|
|
1910
|
+
readonly size: {
|
|
1911
|
+
readonly type: "number";
|
|
1912
|
+
readonly format: "float";
|
|
1913
|
+
readonly description: "Size of the layer in bytes.";
|
|
1914
|
+
readonly example: 5678;
|
|
1915
|
+
};
|
|
1916
|
+
};
|
|
1917
|
+
readonly required: readonly ["size"];
|
|
1918
|
+
readonly additionalProperties: false;
|
|
1919
|
+
};
|
|
1920
|
+
readonly description: "Layers for this platform.";
|
|
1921
|
+
};
|
|
1922
|
+
readonly size: {
|
|
1923
|
+
readonly type: "number";
|
|
1924
|
+
readonly format: "float";
|
|
1925
|
+
readonly description: "Total size of this platform manifest in bytes.";
|
|
1926
|
+
readonly example: 12345678;
|
|
1927
|
+
};
|
|
1928
|
+
};
|
|
1929
|
+
readonly required: readonly ["digest"];
|
|
1930
|
+
readonly additionalProperties: false;
|
|
1931
|
+
};
|
|
1932
|
+
readonly description: "Array of manifests for multi-arch images.";
|
|
1933
|
+
};
|
|
1934
|
+
readonly size: {
|
|
1935
|
+
readonly type: "number";
|
|
1936
|
+
readonly format: "float";
|
|
1937
|
+
readonly description: "Total size of the tag in bytes.";
|
|
1938
|
+
readonly example: 123456789;
|
|
1939
|
+
};
|
|
1940
|
+
readonly region: {
|
|
1941
|
+
readonly type: "string";
|
|
1942
|
+
readonly description: "Registry region.";
|
|
1943
|
+
readonly example: "northamerica";
|
|
1944
|
+
};
|
|
1945
|
+
readonly repository: {
|
|
1946
|
+
readonly type: "string";
|
|
1947
|
+
readonly description: "Repository name.";
|
|
1948
|
+
readonly example: "my-app";
|
|
1949
|
+
};
|
|
1950
|
+
readonly uri: {
|
|
1951
|
+
readonly type: "string";
|
|
1952
|
+
readonly description: "Full URI of the tag.";
|
|
1953
|
+
readonly example: "ssds123e-6651-4e5d-9c04-079f6532989b.northamerica.registry.cloudfleet.dev/my-app:latest";
|
|
1954
|
+
};
|
|
1955
|
+
};
|
|
1956
|
+
readonly required: readonly ["name", "digest", "size", "region", "repository", "uri"];
|
|
1957
|
+
readonly additionalProperties: false;
|
|
1958
|
+
};
|
|
1959
|
+
export declare const TicketAttachmentSchema: {
|
|
1960
|
+
readonly type: "object";
|
|
1961
|
+
readonly properties: {
|
|
1962
|
+
readonly id: {
|
|
1963
|
+
readonly type: "string";
|
|
1964
|
+
readonly description: "Unique identifier of the attachment (Mongo ObjectId).";
|
|
1965
|
+
readonly example: "60c72b2f9f1b2c001f8e4d3c";
|
|
1966
|
+
};
|
|
1967
|
+
readonly filename: {
|
|
1968
|
+
readonly type: "string";
|
|
1969
|
+
readonly description: "Original filename as uploaded.";
|
|
1970
|
+
readonly example: "debug.log";
|
|
1971
|
+
};
|
|
1972
|
+
readonly content_type: {
|
|
1973
|
+
readonly type: "string";
|
|
1974
|
+
readonly description: "MIME content type of the attachment.";
|
|
1975
|
+
readonly example: "text/plain";
|
|
1976
|
+
};
|
|
1977
|
+
readonly size: {
|
|
1978
|
+
readonly type: "integer";
|
|
1979
|
+
readonly description: "Size of the attachment in bytes.";
|
|
1980
|
+
readonly example: 12345;
|
|
1981
|
+
};
|
|
1982
|
+
};
|
|
1983
|
+
readonly required: readonly ["id", "filename", "content_type", "size"];
|
|
1984
|
+
readonly additionalProperties: false;
|
|
1985
|
+
};
|
|
1986
|
+
export declare const TicketCreateInputSchema: {
|
|
1987
|
+
readonly type: "object";
|
|
1988
|
+
readonly properties: {
|
|
1989
|
+
readonly category: {
|
|
1990
|
+
readonly type: "string";
|
|
1991
|
+
readonly description: "Ticket category. Drives auto-assignment and may carry a subcategory in `properties`.";
|
|
1992
|
+
readonly example: "technical";
|
|
1993
|
+
readonly enum: readonly ["billing", "technical", "general"];
|
|
1994
|
+
};
|
|
1995
|
+
readonly body: {
|
|
1996
|
+
readonly type: "string";
|
|
1997
|
+
readonly maxLength: 50000;
|
|
1998
|
+
readonly minLength: 1;
|
|
1999
|
+
readonly pattern: "\\S";
|
|
2000
|
+
readonly description: "Initial message body in markdown. There is no separate subject — the first message body is the description.";
|
|
2001
|
+
readonly example: "My cluster cannot reach the registry. Logs attached.";
|
|
2002
|
+
};
|
|
2003
|
+
readonly properties: {
|
|
2004
|
+
readonly type: "object";
|
|
2005
|
+
readonly additionalProperties: true;
|
|
2006
|
+
readonly description: "Free-form key/value bag set by the UI (e.g. `subcategory`, `cluster_id`, `cluster_name`, `region`).";
|
|
2007
|
+
readonly example: {
|
|
2008
|
+
readonly subcategory: "cluster-question";
|
|
2009
|
+
readonly cluster_id: "60c72b2f9f1b2c001f8e4d3a";
|
|
2010
|
+
};
|
|
2011
|
+
};
|
|
2012
|
+
};
|
|
2013
|
+
readonly required: readonly ["category", "body"];
|
|
2014
|
+
readonly additionalProperties: false;
|
|
2015
|
+
};
|
|
2016
|
+
export declare const TicketMessageInputSchema: {
|
|
2017
|
+
readonly type: "object";
|
|
2018
|
+
readonly properties: {
|
|
2019
|
+
readonly body: {
|
|
2020
|
+
readonly type: "string";
|
|
2021
|
+
readonly maxLength: 50000;
|
|
2022
|
+
readonly minLength: 1;
|
|
2023
|
+
readonly pattern: "\\S";
|
|
2024
|
+
readonly description: "Reply body in markdown.";
|
|
2025
|
+
readonly example: "Thanks — that resolved it on my side.";
|
|
1361
2026
|
};
|
|
1362
2027
|
};
|
|
1363
|
-
readonly required: readonly ["
|
|
2028
|
+
readonly required: readonly ["body"];
|
|
2029
|
+
readonly additionalProperties: false;
|
|
2030
|
+
};
|
|
2031
|
+
export declare const TicketMessageSchema: {
|
|
2032
|
+
readonly type: "object";
|
|
2033
|
+
readonly properties: {
|
|
2034
|
+
readonly id: {
|
|
2035
|
+
readonly type: "string";
|
|
2036
|
+
readonly description: "Unique identifier of the message (Mongo ObjectId).";
|
|
2037
|
+
readonly example: "60c72b2f9f1b2c001f8e4d3b";
|
|
2038
|
+
};
|
|
2039
|
+
readonly type: {
|
|
2040
|
+
readonly type: "string";
|
|
2041
|
+
readonly description: "Message type. Internal notes are filtered out of customer-facing responses.";
|
|
2042
|
+
readonly example: "customer_reply";
|
|
2043
|
+
readonly enum: readonly ["customer_reply", "agent_reply"];
|
|
2044
|
+
};
|
|
2045
|
+
readonly body: {
|
|
2046
|
+
readonly type: "string";
|
|
2047
|
+
readonly description: "Message body in markdown.";
|
|
2048
|
+
readonly example: "Thanks — that resolved it on my side.";
|
|
2049
|
+
};
|
|
2050
|
+
readonly author_first_name: {
|
|
2051
|
+
readonly type: "string";
|
|
2052
|
+
readonly nullable: true;
|
|
2053
|
+
readonly description: "First name of the author. Null when not provided.";
|
|
2054
|
+
readonly example: "Jane";
|
|
2055
|
+
};
|
|
2056
|
+
readonly author_last_name: {
|
|
2057
|
+
readonly type: "string";
|
|
2058
|
+
readonly nullable: true;
|
|
2059
|
+
readonly description: "Last name of the author. Null when not provided.";
|
|
2060
|
+
readonly example: "Doe";
|
|
2061
|
+
};
|
|
2062
|
+
readonly attachments: {
|
|
2063
|
+
readonly type: "array";
|
|
2064
|
+
readonly items: {
|
|
2065
|
+
readonly type: "object";
|
|
2066
|
+
readonly properties: {
|
|
2067
|
+
readonly id: {
|
|
2068
|
+
readonly type: "string";
|
|
2069
|
+
readonly description: "Unique identifier of the attachment (Mongo ObjectId).";
|
|
2070
|
+
readonly example: "60c72b2f9f1b2c001f8e4d3c";
|
|
2071
|
+
};
|
|
2072
|
+
readonly filename: {
|
|
2073
|
+
readonly type: "string";
|
|
2074
|
+
readonly description: "Original filename as uploaded.";
|
|
2075
|
+
readonly example: "debug.log";
|
|
2076
|
+
};
|
|
2077
|
+
readonly content_type: {
|
|
2078
|
+
readonly type: "string";
|
|
2079
|
+
readonly description: "MIME content type of the attachment.";
|
|
2080
|
+
readonly example: "text/plain";
|
|
2081
|
+
};
|
|
2082
|
+
readonly size: {
|
|
2083
|
+
readonly type: "integer";
|
|
2084
|
+
readonly description: "Size of the attachment in bytes.";
|
|
2085
|
+
readonly example: 12345;
|
|
2086
|
+
};
|
|
2087
|
+
};
|
|
2088
|
+
readonly required: readonly ["id", "filename", "content_type", "size"];
|
|
2089
|
+
readonly additionalProperties: false;
|
|
2090
|
+
};
|
|
2091
|
+
readonly description: "Attachments associated with this message.";
|
|
2092
|
+
readonly example: readonly [];
|
|
2093
|
+
};
|
|
2094
|
+
readonly date_created: {
|
|
2095
|
+
readonly type: "string";
|
|
2096
|
+
readonly format: "date-time";
|
|
2097
|
+
readonly description: "Creation date of the message. ISO 8601 UTC.";
|
|
2098
|
+
readonly example: "2026-05-11T16:08:14.338Z";
|
|
2099
|
+
};
|
|
2100
|
+
};
|
|
2101
|
+
readonly required: readonly ["id", "type", "body", "date_created"];
|
|
2102
|
+
readonly additionalProperties: false;
|
|
2103
|
+
};
|
|
2104
|
+
export declare const TicketSchema: {
|
|
2105
|
+
readonly type: "object";
|
|
2106
|
+
readonly properties: {
|
|
2107
|
+
readonly id: {
|
|
2108
|
+
readonly type: "string";
|
|
2109
|
+
readonly description: "Unique identifier of the ticket (Mongo ObjectId).";
|
|
2110
|
+
readonly example: "60c72b2f9f1b2c001f8e4d3a";
|
|
2111
|
+
};
|
|
2112
|
+
readonly status: {
|
|
2113
|
+
readonly type: "string";
|
|
2114
|
+
readonly description: "Current state of the ticket.";
|
|
2115
|
+
readonly example: "waiting_on_us";
|
|
2116
|
+
readonly enum: readonly ["waiting_on_us", "waiting_on_user", "closed"];
|
|
2117
|
+
};
|
|
2118
|
+
readonly category: {
|
|
2119
|
+
readonly type: "string";
|
|
2120
|
+
readonly description: "Ticket category.";
|
|
2121
|
+
readonly example: "technical";
|
|
2122
|
+
readonly enum: readonly ["billing", "technical", "general"];
|
|
2123
|
+
};
|
|
2124
|
+
readonly summary: {
|
|
2125
|
+
readonly type: "string";
|
|
2126
|
+
readonly description: "First 128 characters of the initial message body, with markdown formatting and newlines stripped. Used for ticket list previews.";
|
|
2127
|
+
readonly example: "My cluster cannot reach the registry. Logs attached.";
|
|
2128
|
+
};
|
|
2129
|
+
readonly closed_at: {
|
|
2130
|
+
readonly type: "string";
|
|
2131
|
+
readonly format: "date-time";
|
|
2132
|
+
readonly nullable: true;
|
|
2133
|
+
readonly description: "Closure timestamp. Null while the ticket is open.";
|
|
2134
|
+
readonly example: "2026-05-18T16:08:14.338Z";
|
|
2135
|
+
};
|
|
2136
|
+
readonly date_created: {
|
|
2137
|
+
readonly type: "string";
|
|
2138
|
+
readonly format: "date-time";
|
|
2139
|
+
readonly description: "Creation date of the ticket. ISO 8601 UTC.";
|
|
2140
|
+
readonly example: "2026-05-11T16:08:14.338Z";
|
|
2141
|
+
};
|
|
2142
|
+
readonly date_updated: {
|
|
2143
|
+
readonly type: "string";
|
|
2144
|
+
readonly format: "date-time";
|
|
2145
|
+
readonly description: "Last update date of the ticket. ISO 8601 UTC.";
|
|
2146
|
+
readonly example: "2026-05-11T16:08:14.338Z";
|
|
2147
|
+
};
|
|
2148
|
+
readonly messages: {
|
|
2149
|
+
readonly type: "array";
|
|
2150
|
+
readonly items: {
|
|
2151
|
+
readonly type: "object";
|
|
2152
|
+
readonly properties: {
|
|
2153
|
+
readonly id: {
|
|
2154
|
+
readonly type: "string";
|
|
2155
|
+
readonly description: "Unique identifier of the message (Mongo ObjectId).";
|
|
2156
|
+
readonly example: "60c72b2f9f1b2c001f8e4d3b";
|
|
2157
|
+
};
|
|
2158
|
+
readonly type: {
|
|
2159
|
+
readonly type: "string";
|
|
2160
|
+
readonly description: "Message type. Internal notes are filtered out of customer-facing responses.";
|
|
2161
|
+
readonly example: "customer_reply";
|
|
2162
|
+
readonly enum: readonly ["customer_reply", "agent_reply"];
|
|
2163
|
+
};
|
|
2164
|
+
readonly body: {
|
|
2165
|
+
readonly type: "string";
|
|
2166
|
+
readonly description: "Message body in markdown.";
|
|
2167
|
+
readonly example: "Thanks — that resolved it on my side.";
|
|
2168
|
+
};
|
|
2169
|
+
readonly author_first_name: {
|
|
2170
|
+
readonly type: "string";
|
|
2171
|
+
readonly description: "First name of the author. Null when not provided.";
|
|
2172
|
+
readonly example: "Jane";
|
|
2173
|
+
};
|
|
2174
|
+
readonly author_last_name: {
|
|
2175
|
+
readonly type: "string";
|
|
2176
|
+
readonly description: "Last name of the author. Null when not provided.";
|
|
2177
|
+
readonly example: "Doe";
|
|
2178
|
+
};
|
|
2179
|
+
readonly attachments: {
|
|
2180
|
+
readonly type: "array";
|
|
2181
|
+
readonly items: {
|
|
2182
|
+
readonly type: "object";
|
|
2183
|
+
readonly properties: {
|
|
2184
|
+
readonly id: {
|
|
2185
|
+
readonly type: "string";
|
|
2186
|
+
readonly description: "Unique identifier of the attachment (Mongo ObjectId).";
|
|
2187
|
+
readonly example: "60c72b2f9f1b2c001f8e4d3c";
|
|
2188
|
+
};
|
|
2189
|
+
readonly filename: {
|
|
2190
|
+
readonly type: "string";
|
|
2191
|
+
readonly description: "Original filename as uploaded.";
|
|
2192
|
+
readonly example: "debug.log";
|
|
2193
|
+
};
|
|
2194
|
+
readonly content_type: {
|
|
2195
|
+
readonly type: "string";
|
|
2196
|
+
readonly description: "MIME content type of the attachment.";
|
|
2197
|
+
readonly example: "text/plain";
|
|
2198
|
+
};
|
|
2199
|
+
readonly size: {
|
|
2200
|
+
readonly type: "integer";
|
|
2201
|
+
readonly description: "Size of the attachment in bytes.";
|
|
2202
|
+
readonly example: 12345;
|
|
2203
|
+
};
|
|
2204
|
+
};
|
|
2205
|
+
readonly required: readonly ["id", "filename", "content_type", "size"];
|
|
2206
|
+
readonly additionalProperties: false;
|
|
2207
|
+
};
|
|
2208
|
+
readonly description: "Attachments associated with this message.";
|
|
2209
|
+
readonly example: readonly [];
|
|
2210
|
+
};
|
|
2211
|
+
readonly date_created: {
|
|
2212
|
+
readonly type: "string";
|
|
2213
|
+
readonly format: "date-time";
|
|
2214
|
+
readonly description: "Creation date of the message. ISO 8601 UTC.";
|
|
2215
|
+
readonly example: "2026-05-11T16:08:14.338Z";
|
|
2216
|
+
};
|
|
2217
|
+
};
|
|
2218
|
+
readonly required: readonly ["id", "type", "body", "date_created"];
|
|
2219
|
+
readonly additionalProperties: false;
|
|
2220
|
+
};
|
|
2221
|
+
readonly description: "Messages on the ticket in chronological order. Internal notes are excluded. Returned by the detail endpoint only.";
|
|
2222
|
+
};
|
|
2223
|
+
};
|
|
2224
|
+
readonly required: readonly ["id", "status", "category", "summary", "date_created", "date_updated"];
|
|
1364
2225
|
readonly additionalProperties: false;
|
|
1365
2226
|
};
|
|
1366
2227
|
export declare const TokenCreateInputSchema: {
|
|
@@ -1441,6 +2302,104 @@ export declare const TokenUpdateInputSchema: {
|
|
|
1441
2302
|
};
|
|
1442
2303
|
readonly additionalProperties: false;
|
|
1443
2304
|
};
|
|
2305
|
+
export declare const UsageFacetsSchema: {
|
|
2306
|
+
readonly type: "object";
|
|
2307
|
+
readonly properties: {
|
|
2308
|
+
readonly cluster_id: {
|
|
2309
|
+
readonly type: "array";
|
|
2310
|
+
readonly items: {
|
|
2311
|
+
readonly type: "string";
|
|
2312
|
+
};
|
|
2313
|
+
readonly description: "List of unique cluster IDs";
|
|
2314
|
+
readonly example: readonly ["6b5439b1-923a-4f2b-a371-d554e5ea23fa"];
|
|
2315
|
+
};
|
|
2316
|
+
readonly product: {
|
|
2317
|
+
readonly type: "array";
|
|
2318
|
+
readonly items: {
|
|
2319
|
+
readonly type: "string";
|
|
2320
|
+
readonly enum: readonly ["cfke_controlplane_basic", "cfke_controlplane_pro", "cfke_controlplane_enterprise", "cfke_connected_nodes_basic", "cfke_connected_nodes_pro", "cfke_connected_nodes_enterprise", "cfcr_storage"];
|
|
2321
|
+
};
|
|
2322
|
+
readonly description: "List of unique products";
|
|
2323
|
+
readonly example: readonly ["cfke_controlplane_pro", "cfke_connected_nodes_pro"];
|
|
2324
|
+
};
|
|
2325
|
+
};
|
|
2326
|
+
readonly additionalProperties: false;
|
|
2327
|
+
};
|
|
2328
|
+
export declare const UsageResponseSchema: {
|
|
2329
|
+
readonly type: "object";
|
|
2330
|
+
readonly properties: {
|
|
2331
|
+
readonly data: {
|
|
2332
|
+
readonly type: "array";
|
|
2333
|
+
readonly items: {
|
|
2334
|
+
readonly type: "object";
|
|
2335
|
+
readonly properties: {
|
|
2336
|
+
readonly hour: {
|
|
2337
|
+
readonly type: "string";
|
|
2338
|
+
readonly description: "Hour of the usage";
|
|
2339
|
+
readonly example: "2019-01-01T00:00:00.000Z";
|
|
2340
|
+
};
|
|
2341
|
+
readonly cluster_id: {
|
|
2342
|
+
readonly type: "string";
|
|
2343
|
+
readonly description: "Unique identifier of the kubernetes cluster. UUID v4 string in canonical form";
|
|
2344
|
+
readonly example: "6b5439b1-923a-4f2b-a371-d554e5ea23fa";
|
|
2345
|
+
};
|
|
2346
|
+
readonly product: {
|
|
2347
|
+
readonly type: "string";
|
|
2348
|
+
readonly description: "The product the usage is associated with";
|
|
2349
|
+
readonly example: "cfke_controlplane_pro";
|
|
2350
|
+
readonly enum: readonly ["cfke_controlplane_basic", "cfke_controlplane_pro", "cfke_controlplane_enterprise", "cfke_connected_nodes_basic", "cfke_connected_nodes_pro", "cfke_connected_nodes_enterprise", "cfcr_storage"];
|
|
2351
|
+
};
|
|
2352
|
+
readonly value: {
|
|
2353
|
+
readonly type: "number";
|
|
2354
|
+
readonly format: "float";
|
|
2355
|
+
readonly description: "Consumption";
|
|
2356
|
+
readonly example: 4;
|
|
2357
|
+
};
|
|
2358
|
+
readonly price: {
|
|
2359
|
+
readonly type: "number";
|
|
2360
|
+
readonly format: "float";
|
|
2361
|
+
readonly description: "Price per unit";
|
|
2362
|
+
readonly example: 0.01;
|
|
2363
|
+
};
|
|
2364
|
+
readonly total: {
|
|
2365
|
+
readonly type: "number";
|
|
2366
|
+
readonly format: "float";
|
|
2367
|
+
readonly description: "Total cost";
|
|
2368
|
+
};
|
|
2369
|
+
};
|
|
2370
|
+
readonly required: readonly ["hour", "cluster_id", "product", "value", "price", "total"];
|
|
2371
|
+
readonly additionalProperties: false;
|
|
2372
|
+
};
|
|
2373
|
+
readonly description: "Usage data";
|
|
2374
|
+
};
|
|
2375
|
+
readonly facets: {
|
|
2376
|
+
readonly type: "object";
|
|
2377
|
+
readonly properties: {
|
|
2378
|
+
readonly cluster_id: {
|
|
2379
|
+
readonly type: "array";
|
|
2380
|
+
readonly items: {
|
|
2381
|
+
readonly type: "string";
|
|
2382
|
+
};
|
|
2383
|
+
readonly description: "List of unique cluster IDs";
|
|
2384
|
+
readonly example: readonly ["6b5439b1-923a-4f2b-a371-d554e5ea23fa"];
|
|
2385
|
+
};
|
|
2386
|
+
readonly product: {
|
|
2387
|
+
readonly type: "array";
|
|
2388
|
+
readonly items: {
|
|
2389
|
+
readonly type: "string";
|
|
2390
|
+
readonly enum: readonly ["cfke_controlplane_basic", "cfke_controlplane_pro", "cfke_controlplane_enterprise", "cfke_connected_nodes_basic", "cfke_connected_nodes_pro", "cfke_connected_nodes_enterprise", "cfcr_storage"];
|
|
2391
|
+
};
|
|
2392
|
+
readonly description: "List of unique products";
|
|
2393
|
+
readonly example: readonly ["cfke_controlplane_pro", "cfke_connected_nodes_pro"];
|
|
2394
|
+
};
|
|
2395
|
+
};
|
|
2396
|
+
readonly additionalProperties: false;
|
|
2397
|
+
readonly description: "Facets for filtering";
|
|
2398
|
+
};
|
|
2399
|
+
};
|
|
2400
|
+
readonly required: readonly ["data", "facets"];
|
|
2401
|
+
readonly additionalProperties: false;
|
|
2402
|
+
};
|
|
1444
2403
|
export declare const UsageSchema: {
|
|
1445
2404
|
readonly type: "object";
|
|
1446
2405
|
readonly properties: {
|
|
@@ -1451,78 +2410,34 @@ export declare const UsageSchema: {
|
|
|
1451
2410
|
};
|
|
1452
2411
|
readonly cluster_id: {
|
|
1453
2412
|
readonly type: "string";
|
|
1454
|
-
readonly format: "uuid";
|
|
1455
2413
|
readonly description: "Unique identifier of the kubernetes cluster. UUID v4 string in canonical form";
|
|
1456
2414
|
readonly example: "6b5439b1-923a-4f2b-a371-d554e5ea23fa";
|
|
1457
2415
|
};
|
|
1458
|
-
readonly cluster_tier: {
|
|
1459
|
-
readonly type: "string";
|
|
1460
|
-
readonly description: "Tier of the cluster.";
|
|
1461
|
-
readonly example: "pro";
|
|
1462
|
-
readonly enum: readonly ["basic", "pro", ""];
|
|
1463
|
-
};
|
|
1464
2416
|
readonly product: {
|
|
1465
2417
|
readonly type: "string";
|
|
1466
2418
|
readonly description: "The product the usage is associated with";
|
|
1467
|
-
readonly example: "
|
|
1468
|
-
readonly enum: readonly ["
|
|
2419
|
+
readonly example: "cfke_controlplane_pro";
|
|
2420
|
+
readonly enum: readonly ["cfke_controlplane_basic", "cfke_controlplane_pro", "cfke_controlplane_enterprise", "cfke_connected_nodes_basic", "cfke_connected_nodes_pro", "cfke_connected_nodes_enterprise", "cfcr_storage"];
|
|
1469
2421
|
};
|
|
1470
|
-
readonly
|
|
1471
|
-
readonly type: "
|
|
1472
|
-
readonly
|
|
1473
|
-
readonly
|
|
1474
|
-
|
|
1475
|
-
readonly sku: {
|
|
1476
|
-
readonly type: "string";
|
|
1477
|
-
readonly description: "SKU of the Kubernetes node";
|
|
1478
|
-
readonly example: "GCP-NORTHAMERICA-NORTHEAST1-A-G1-SMALL-SPOT";
|
|
1479
|
-
};
|
|
1480
|
-
readonly cpu: {
|
|
1481
|
-
readonly anyOf: readonly [{
|
|
1482
|
-
readonly type: "number";
|
|
1483
|
-
readonly format: "float";
|
|
1484
|
-
readonly description: "CPU core count of the node";
|
|
1485
|
-
readonly example: 4;
|
|
1486
|
-
}, {
|
|
1487
|
-
readonly type: "string";
|
|
1488
|
-
readonly enum: readonly [""];
|
|
1489
|
-
}];
|
|
2422
|
+
readonly value: {
|
|
2423
|
+
readonly type: "number";
|
|
2424
|
+
readonly format: "float";
|
|
2425
|
+
readonly description: "Consumption";
|
|
2426
|
+
readonly example: 4;
|
|
1490
2427
|
};
|
|
1491
2428
|
readonly price: {
|
|
1492
|
-
readonly
|
|
1493
|
-
|
|
1494
|
-
|
|
1495
|
-
|
|
1496
|
-
readonly example: 4;
|
|
1497
|
-
}, {
|
|
1498
|
-
readonly type: "string";
|
|
1499
|
-
readonly enum: readonly [""];
|
|
1500
|
-
}];
|
|
1501
|
-
};
|
|
1502
|
-
readonly value: {
|
|
1503
|
-
readonly anyOf: readonly [{
|
|
1504
|
-
readonly type: "number";
|
|
1505
|
-
readonly format: "float";
|
|
1506
|
-
readonly description: "Value";
|
|
1507
|
-
readonly example: 4;
|
|
1508
|
-
}, {
|
|
1509
|
-
readonly type: "string";
|
|
1510
|
-
readonly enum: readonly [""];
|
|
1511
|
-
}];
|
|
2429
|
+
readonly type: "number";
|
|
2430
|
+
readonly format: "float";
|
|
2431
|
+
readonly description: "Price per unit";
|
|
2432
|
+
readonly example: 0.01;
|
|
1512
2433
|
};
|
|
1513
2434
|
readonly total: {
|
|
1514
|
-
readonly
|
|
1515
|
-
|
|
1516
|
-
|
|
1517
|
-
readonly description: "Total";
|
|
1518
|
-
readonly example: 4;
|
|
1519
|
-
}, {
|
|
1520
|
-
readonly type: "string";
|
|
1521
|
-
readonly enum: readonly [""];
|
|
1522
|
-
}];
|
|
2435
|
+
readonly type: "number";
|
|
2436
|
+
readonly format: "float";
|
|
2437
|
+
readonly description: "Total cost";
|
|
1523
2438
|
};
|
|
1524
2439
|
};
|
|
1525
|
-
readonly required: readonly ["
|
|
2440
|
+
readonly required: readonly ["hour", "cluster_id", "product", "value", "price", "total"];
|
|
1526
2441
|
readonly additionalProperties: false;
|
|
1527
2442
|
};
|
|
1528
2443
|
export declare const UserCreateInputSchema: {
|
|
@@ -1559,18 +2474,6 @@ export declare const UserCreateInputSchema: {
|
|
|
1559
2474
|
readonly minLength: 8;
|
|
1560
2475
|
readonly description: "User password. Must be at least 8 characters long.";
|
|
1561
2476
|
};
|
|
1562
|
-
readonly status: {
|
|
1563
|
-
readonly type: "string";
|
|
1564
|
-
readonly description: "Status of the user. Can be `active` or `inactive`. Inactive users cannot log in or manage organization resources.";
|
|
1565
|
-
readonly example: "active";
|
|
1566
|
-
readonly enum: readonly ["active", "inactive"];
|
|
1567
|
-
};
|
|
1568
|
-
readonly role: {
|
|
1569
|
-
readonly type: "string";
|
|
1570
|
-
readonly description: "User role. Can be 'Administrator', 'User'.";
|
|
1571
|
-
readonly example: "User";
|
|
1572
|
-
readonly enum: readonly ["Administrator", "User"];
|
|
1573
|
-
};
|
|
1574
2477
|
};
|
|
1575
2478
|
readonly required: readonly ["email", "first_name", "last_name", "code", "password"];
|
|
1576
2479
|
readonly additionalProperties: false;
|