@cloudfleet/sdk 0.0.1-3de42b3 → 0.0.1-3f11d8b
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +26 -2
- package/dist/@tanstack/react-query.gen.d.ts +1026 -0
- package/dist/@tanstack/react-query.gen.d.ts.map +1 -0
- package/dist/@tanstack/react-query.gen.js +1194 -0
- package/dist/@tanstack/react-query.gen.js.map +1 -0
- package/dist/client/client.gen.d.ts +3 -0
- package/dist/client/client.gen.d.ts.map +1 -0
- package/dist/client/client.gen.js +217 -0
- package/dist/client/client.gen.js.map +1 -0
- package/dist/client/index.d.ts +9 -0
- package/dist/client/index.d.ts.map +1 -0
- package/dist/client/index.js +7 -0
- package/dist/client/index.js.map +1 -0
- package/dist/client/types.gen.d.ts +121 -0
- 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.gen.d.ts +38 -0
- package/dist/client/utils.gen.d.ts.map +1 -0
- package/dist/client/utils.gen.js +229 -0
- package/dist/client/utils.gen.js.map +1 -0
- package/dist/client.gen.d.ts +4 -4
- package/dist/client.gen.d.ts.map +1 -1
- package/dist/client.gen.js +2 -4
- package/dist/client.gen.js.map +1 -1
- package/dist/core/auth.gen.d.ts +19 -0
- package/dist/core/auth.gen.d.ts.map +1 -0
- package/dist/core/auth.gen.js +15 -0
- 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.gen.js +58 -0
- package/dist/core/bodySerializer.gen.js.map +1 -0
- package/dist/core/params.gen.d.ts +44 -0
- package/dist/core/params.gen.d.ts.map +1 -0
- package/dist/core/params.gen.js +101 -0
- package/dist/core/params.gen.js.map +1 -0
- package/dist/core/pathSerializer.gen.d.ts +34 -0
- package/dist/core/pathSerializer.gen.d.ts.map +1 -0
- package/dist/core/pathSerializer.gen.js +107 -0
- 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.gen.d.ts +79 -0
- 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 +1719 -727
- package/dist/schemas.gen.d.ts.map +1 -1
- package/dist/schemas.gen.js +3070 -763
- package/dist/schemas.gen.js.map +1 -1
- package/dist/sdk.gen.d.ts +307 -175
- package/dist/sdk.gen.d.ts.map +1 -1
- package/dist/sdk.gen.js +438 -350
- package/dist/sdk.gen.js.map +1 -1
- package/dist/services/kubernetes/api.d.ts +20 -20
- package/dist/types.gen.d.ts +1903 -860
- package/dist/types.gen.d.ts.map +1 -1
- package/dist/zod.gen.d.ts +3971 -2328
- package/dist/zod.gen.d.ts.map +1 -1
- package/dist/zod.gen.js +1575 -854
- package/dist/zod.gen.js.map +1 -1
- package/package.json +28 -9
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";
|
|
@@ -280,29 +272,106 @@ export declare const ClusterCreateInputSchema: {
|
|
|
280
272
|
readonly description: "Name of the cluster.";
|
|
281
273
|
readonly example: "production-cluster";
|
|
282
274
|
};
|
|
283
|
-
readonly region: {
|
|
284
|
-
readonly type: "string";
|
|
285
|
-
readonly description: "Cloudfleet control plane region. One of \"staging\", \"northamerica-central-1\". This field can not be updated after creation.";
|
|
286
|
-
readonly default: "staging";
|
|
287
|
-
readonly example: "northamerica-central-1";
|
|
288
|
-
readonly enum: readonly ["staging", "northamerica-central-1"];
|
|
289
|
-
};
|
|
290
275
|
readonly tier: {
|
|
291
276
|
readonly type: "string";
|
|
292
277
|
readonly description: "Tier of the cluster.";
|
|
278
|
+
readonly default: "basic";
|
|
293
279
|
readonly example: "pro";
|
|
294
|
-
readonly enum: readonly ["basic", "pro"];
|
|
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,11 +387,26 @@ 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.";
|
|
324
403
|
readonly example: "tskey-auth-kBV8wr1dk911CNTRL-...";
|
|
325
404
|
};
|
|
405
|
+
readonly login_server: {
|
|
406
|
+
readonly type: "string";
|
|
407
|
+
readonly description: "Coordination server the node registers against. Empty on data plane v1 clusters, where the node advertises its own tag instead. A non-empty value requires a client that declares the dataplane-v2 capability.";
|
|
408
|
+
readonly example: "https://415026b6-f00f-44f8-968d-fc6ef4d0fc6d.fabric.europe-central-1a.cfke.io";
|
|
409
|
+
};
|
|
326
410
|
readonly bootstrap_token: {
|
|
327
411
|
readonly type: "string";
|
|
328
412
|
readonly description: "Bootstrap token for the cluster.";
|
|
@@ -334,7 +418,7 @@ export declare const ClusterJoinInformationSchema: {
|
|
|
334
418
|
readonly kubernetes: {
|
|
335
419
|
readonly type: "string";
|
|
336
420
|
readonly description: "Kubernetes version of the cluster.";
|
|
337
|
-
readonly example: "1.
|
|
421
|
+
readonly example: "1.33.7";
|
|
338
422
|
};
|
|
339
423
|
readonly tailscale: {
|
|
340
424
|
readonly type: "string";
|
|
@@ -346,8 +430,13 @@ export declare const ClusterJoinInformationSchema: {
|
|
|
346
430
|
readonly description: "Containerd version of the cluster.";
|
|
347
431
|
readonly example: "1.7.19";
|
|
348
432
|
};
|
|
433
|
+
readonly nvidia_driver: {
|
|
434
|
+
readonly type: "string";
|
|
435
|
+
readonly description: "NVIDIA driver version of the cluster.";
|
|
436
|
+
readonly example: "565.0.0";
|
|
437
|
+
};
|
|
349
438
|
};
|
|
350
|
-
readonly required: readonly ["kubernetes", "tailscale", "containerd"];
|
|
439
|
+
readonly required: readonly ["kubernetes", "tailscale", "containerd", "nvidia_driver"];
|
|
351
440
|
readonly additionalProperties: false;
|
|
352
441
|
readonly description: "Versions of the different components of the cluster.";
|
|
353
442
|
};
|
|
@@ -375,7 +464,7 @@ export declare const ClusterJoinInformationSchema: {
|
|
|
375
464
|
readonly description: "OIDC Information for hosts to access to third party API's.";
|
|
376
465
|
};
|
|
377
466
|
};
|
|
378
|
-
readonly required: readonly ["certificate_authority", "endpoint", "auth_key", "bootstrap_token", "versions", "third_party_api_access_config"];
|
|
467
|
+
readonly required: readonly ["certificate_authority", "endpoint", "cluster_dns", "pod_cidr", "auth_key", "login_server", "bootstrap_token", "versions", "third_party_api_access_config"];
|
|
379
468
|
readonly additionalProperties: false;
|
|
380
469
|
};
|
|
381
470
|
export declare const ClusterSchema: {
|
|
@@ -389,25 +478,103 @@ export declare const ClusterSchema: {
|
|
|
389
478
|
readonly description: "Name of the cluster.";
|
|
390
479
|
readonly example: "production-cluster";
|
|
391
480
|
};
|
|
392
|
-
readonly region: {
|
|
393
|
-
readonly type: "string";
|
|
394
|
-
readonly description: "Cloudfleet control plane region. One of \"staging\", \"northamerica-central-1\". This field can not be updated after creation.";
|
|
395
|
-
readonly default: "staging";
|
|
396
|
-
readonly example: "northamerica-central-1";
|
|
397
|
-
readonly enum: readonly ["staging", "northamerica-central-1"];
|
|
398
|
-
};
|
|
399
481
|
readonly tier: {
|
|
400
482
|
readonly type: "string";
|
|
401
483
|
readonly description: "Tier of the cluster.";
|
|
484
|
+
readonly default: "basic";
|
|
402
485
|
readonly example: "pro";
|
|
403
|
-
readonly enum: readonly ["basic", "pro"];
|
|
486
|
+
readonly enum: readonly ["basic", "pro", "enterprise"];
|
|
404
487
|
};
|
|
405
488
|
readonly version_channel: {
|
|
406
489
|
readonly type: "string";
|
|
407
490
|
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-]+)*))?$";
|
|
408
491
|
readonly description: "Version of the kubernetes cluster.";
|
|
409
492
|
readonly default: "1.x.x-cfke.x";
|
|
410
|
-
readonly example: "1.
|
|
493
|
+
readonly example: "1.x.x-cfke.x";
|
|
494
|
+
};
|
|
495
|
+
readonly release_channel: {
|
|
496
|
+
readonly type: "string";
|
|
497
|
+
readonly description: "Release channel for the cluster's control plane.";
|
|
498
|
+
readonly default: "rapid";
|
|
499
|
+
readonly example: "rapid";
|
|
500
|
+
readonly enum: readonly ["rapid", "stable", "extended"];
|
|
501
|
+
};
|
|
502
|
+
readonly features: {
|
|
503
|
+
readonly type: "object";
|
|
504
|
+
readonly properties: {
|
|
505
|
+
readonly gpu_sharing_strategy: {
|
|
506
|
+
readonly type: "string";
|
|
507
|
+
readonly description: "GPU sharing strategy.";
|
|
508
|
+
readonly default: "none";
|
|
509
|
+
readonly example: "none";
|
|
510
|
+
readonly enum: readonly ["none", "mps", "time_slicing"];
|
|
511
|
+
};
|
|
512
|
+
readonly gpu_max_shared_clients_per_gpu: {
|
|
513
|
+
readonly type: "integer";
|
|
514
|
+
readonly minimum: 2;
|
|
515
|
+
readonly maximum: 48;
|
|
516
|
+
readonly description: "Maximum number of pods that may share a single GPU.";
|
|
517
|
+
readonly default: 4;
|
|
518
|
+
readonly example: 10;
|
|
519
|
+
};
|
|
520
|
+
readonly cilium_socket_lb_host_namespace_only: {
|
|
521
|
+
readonly type: "boolean";
|
|
522
|
+
readonly description: "Restrict Cilium socket load-balancing to the host namespace. Required for the Tailscale operator and Istio.";
|
|
523
|
+
readonly example: false;
|
|
524
|
+
};
|
|
525
|
+
};
|
|
526
|
+
readonly required: readonly ["gpu_sharing_strategy", "gpu_max_shared_clients_per_gpu", "cilium_socket_lb_host_namespace_only"];
|
|
527
|
+
readonly additionalProperties: false;
|
|
528
|
+
readonly description: "Cluster feature toggles.";
|
|
529
|
+
readonly default: {
|
|
530
|
+
readonly gpu_sharing_strategy: "none";
|
|
531
|
+
readonly gpu_max_shared_clients_per_gpu: 4;
|
|
532
|
+
readonly cilium_socket_lb_host_namespace_only: false;
|
|
533
|
+
};
|
|
534
|
+
};
|
|
535
|
+
readonly region: {
|
|
536
|
+
readonly type: "string";
|
|
537
|
+
readonly description: "Cloudfleet control plane region. This field can not be updated after creation.";
|
|
538
|
+
readonly example: "europe-central-1a";
|
|
539
|
+
};
|
|
540
|
+
readonly networking: {
|
|
541
|
+
readonly type: "object";
|
|
542
|
+
readonly properties: {
|
|
543
|
+
readonly pod_cidr: {
|
|
544
|
+
readonly type: "string";
|
|
545
|
+
readonly description: "CIDR block for pod IPs.";
|
|
546
|
+
readonly default: "10.244.0.0/16";
|
|
547
|
+
};
|
|
548
|
+
readonly service_cidr: {
|
|
549
|
+
readonly type: "string";
|
|
550
|
+
readonly description: "CIDR block for service IPs.";
|
|
551
|
+
readonly default: "10.96.0.0/12";
|
|
552
|
+
};
|
|
553
|
+
readonly dual_stack: {
|
|
554
|
+
readonly type: "boolean";
|
|
555
|
+
readonly description: "Enable IPv4+IPv6 dual-stack networking.";
|
|
556
|
+
};
|
|
557
|
+
readonly pod_cidr_v6: {
|
|
558
|
+
readonly type: "string";
|
|
559
|
+
readonly description: "IPv6 pod CIDR. Requires dual_stack.";
|
|
560
|
+
readonly default: "2001:db8:1:2::/48";
|
|
561
|
+
};
|
|
562
|
+
readonly service_cidr_v6: {
|
|
563
|
+
readonly type: "string";
|
|
564
|
+
readonly description: "IPv6 service CIDR. Requires dual_stack.";
|
|
565
|
+
readonly default: "2001:db8:1:1::/112";
|
|
566
|
+
};
|
|
567
|
+
};
|
|
568
|
+
readonly required: readonly ["pod_cidr", "service_cidr", "dual_stack", "pod_cidr_v6", "service_cidr_v6"];
|
|
569
|
+
readonly additionalProperties: false;
|
|
570
|
+
readonly description: "Cluster networking configuration. Immutable after creation.";
|
|
571
|
+
readonly default: {
|
|
572
|
+
readonly pod_cidr: "10.244.0.0/16";
|
|
573
|
+
readonly service_cidr: "10.96.0.0/12";
|
|
574
|
+
readonly dual_stack: false;
|
|
575
|
+
readonly pod_cidr_v6: "2001:db8:1:2::/48";
|
|
576
|
+
readonly service_cidr_v6: "2001:db8:1:1::/112";
|
|
577
|
+
};
|
|
411
578
|
};
|
|
412
579
|
readonly id: {
|
|
413
580
|
readonly type: "string";
|
|
@@ -417,16 +584,27 @@ export declare const ClusterSchema: {
|
|
|
417
584
|
};
|
|
418
585
|
readonly status: {
|
|
419
586
|
readonly type: "string";
|
|
420
|
-
readonly description: "Status of the cluster.
|
|
421
|
-
readonly example: "
|
|
422
|
-
readonly enum: readonly ["
|
|
587
|
+
readonly description: "Status of the cluster.";
|
|
588
|
+
readonly example: "deployed";
|
|
589
|
+
readonly enum: readonly ["creating", "deployed", "updating", "disabled"];
|
|
423
590
|
};
|
|
424
591
|
readonly endpoint: {
|
|
425
592
|
readonly anyOf: readonly [{
|
|
426
593
|
readonly type: "string";
|
|
427
594
|
readonly format: "uri";
|
|
428
|
-
readonly description: "URL of the Kubernetes cluster control plane. This is the endpoint that kubectl uses to connect to the cluster.";
|
|
429
|
-
readonly example: "https://2ae6557c-c61f-49c6-b4c1-a65473470a03.staging.cfke.
|
|
595
|
+
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.";
|
|
596
|
+
readonly example: "https://2ae6557c-c61f-49c6-b4c1-a65473470a03.staging.cfke.io";
|
|
597
|
+
}, {
|
|
598
|
+
readonly type: "string";
|
|
599
|
+
readonly enum: readonly [""];
|
|
600
|
+
}];
|
|
601
|
+
};
|
|
602
|
+
readonly endpoint_public: {
|
|
603
|
+
readonly anyOf: readonly [{
|
|
604
|
+
readonly type: "string";
|
|
605
|
+
readonly format: "uri";
|
|
606
|
+
readonly description: "Deprecated alias of `endpoint`; retained for backward compatibility.";
|
|
607
|
+
readonly example: "https://2ae6557c-c61f-49c6-b4c1-a65473470a03.staging.cfke.io";
|
|
430
608
|
}, {
|
|
431
609
|
readonly type: "string";
|
|
432
610
|
readonly enum: readonly [""];
|
|
@@ -440,7 +618,7 @@ export declare const ClusterSchema: {
|
|
|
440
618
|
readonly version_current: {
|
|
441
619
|
readonly type: "string";
|
|
442
620
|
readonly description: "Current version of the cluster.";
|
|
443
|
-
readonly example: "1.
|
|
621
|
+
readonly example: "1.33.7-cfke.264";
|
|
444
622
|
};
|
|
445
623
|
readonly created_at: {
|
|
446
624
|
readonly type: "string";
|
|
@@ -458,8 +636,9 @@ export declare const ClusterSchema: {
|
|
|
458
636
|
readonly example: true;
|
|
459
637
|
};
|
|
460
638
|
};
|
|
461
|
-
readonly required: readonly ["name", "tier", "id", "status"];
|
|
639
|
+
readonly required: readonly ["name", "tier", "version_channel", "release_channel", "features", "region", "networking", "id", "status", "ready"];
|
|
462
640
|
readonly additionalProperties: false;
|
|
641
|
+
readonly description: "Mutable cluster configuration. Applied as a full overwrite: any omitted field is reset to its default rather than left unchanged.";
|
|
463
642
|
};
|
|
464
643
|
export declare const ClusterUpdateInputSchema: {
|
|
465
644
|
readonly type: "object";
|
|
@@ -472,14 +651,63 @@ export declare const ClusterUpdateInputSchema: {
|
|
|
472
651
|
readonly description: "Name of the cluster.";
|
|
473
652
|
readonly example: "production-cluster";
|
|
474
653
|
};
|
|
654
|
+
readonly tier: {
|
|
655
|
+
readonly type: "string";
|
|
656
|
+
readonly description: "Tier of the cluster.";
|
|
657
|
+
readonly default: "basic";
|
|
658
|
+
readonly example: "pro";
|
|
659
|
+
readonly enum: readonly ["basic", "pro", "enterprise"];
|
|
660
|
+
};
|
|
475
661
|
readonly version_channel: {
|
|
476
662
|
readonly type: "string";
|
|
477
663
|
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-]+)*))?$";
|
|
478
664
|
readonly description: "Version of the kubernetes cluster.";
|
|
479
|
-
readonly
|
|
665
|
+
readonly default: "1.x.x-cfke.x";
|
|
666
|
+
readonly example: "1.x.x-cfke.x";
|
|
667
|
+
};
|
|
668
|
+
readonly release_channel: {
|
|
669
|
+
readonly type: "string";
|
|
670
|
+
readonly description: "Release channel for the cluster's control plane.";
|
|
671
|
+
readonly default: "rapid";
|
|
672
|
+
readonly example: "rapid";
|
|
673
|
+
readonly enum: readonly ["rapid", "stable", "extended"];
|
|
674
|
+
};
|
|
675
|
+
readonly features: {
|
|
676
|
+
readonly type: "object";
|
|
677
|
+
readonly properties: {
|
|
678
|
+
readonly gpu_sharing_strategy: {
|
|
679
|
+
readonly type: "string";
|
|
680
|
+
readonly description: "GPU sharing strategy.";
|
|
681
|
+
readonly default: "none";
|
|
682
|
+
readonly example: "none";
|
|
683
|
+
readonly enum: readonly ["none", "mps", "time_slicing"];
|
|
684
|
+
};
|
|
685
|
+
readonly gpu_max_shared_clients_per_gpu: {
|
|
686
|
+
readonly type: "integer";
|
|
687
|
+
readonly minimum: 2;
|
|
688
|
+
readonly maximum: 48;
|
|
689
|
+
readonly description: "Maximum number of pods that may share a single GPU.";
|
|
690
|
+
readonly default: 4;
|
|
691
|
+
readonly example: 10;
|
|
692
|
+
};
|
|
693
|
+
readonly cilium_socket_lb_host_namespace_only: {
|
|
694
|
+
readonly type: "boolean";
|
|
695
|
+
readonly description: "Restrict Cilium socket load-balancing to the host namespace. Required for the Tailscale operator and Istio.";
|
|
696
|
+
readonly example: false;
|
|
697
|
+
};
|
|
698
|
+
};
|
|
699
|
+
readonly additionalProperties: false;
|
|
700
|
+
readonly description: "Cluster feature toggles.";
|
|
701
|
+
readonly default: {
|
|
702
|
+
readonly gpu_sharing_strategy: "none";
|
|
703
|
+
readonly gpu_max_shared_clients_per_gpu: 4;
|
|
704
|
+
readonly cilium_socket_lb_host_namespace_only: false;
|
|
705
|
+
};
|
|
480
706
|
};
|
|
481
707
|
};
|
|
708
|
+
readonly required: readonly ["name"];
|
|
482
709
|
readonly additionalProperties: false;
|
|
710
|
+
readonly description: "Mutable cluster configuration. Applied as a full overwrite: any omitted field is reset to its default rather than left unchanged.";
|
|
483
711
|
};
|
|
484
712
|
export declare const FleetCreateInputSchema: {
|
|
485
713
|
readonly type: "object";
|
|
@@ -488,13 +716,12 @@ export declare const FleetCreateInputSchema: {
|
|
|
488
716
|
readonly type: "object";
|
|
489
717
|
readonly properties: {
|
|
490
718
|
readonly cpu: {
|
|
491
|
-
readonly type: "
|
|
492
|
-
readonly format: "float";
|
|
719
|
+
readonly type: "integer";
|
|
493
720
|
readonly minimum: 0;
|
|
494
|
-
readonly
|
|
721
|
+
readonly maximum: 100000;
|
|
722
|
+
readonly description: "CPU limit in cores. Maximum 100,000.";
|
|
495
723
|
};
|
|
496
724
|
};
|
|
497
|
-
readonly required: readonly ["cpu"];
|
|
498
725
|
readonly additionalProperties: false;
|
|
499
726
|
readonly description: "Limits define a set of bounds for provisioning capacity.";
|
|
500
727
|
};
|
|
@@ -503,57 +730,107 @@ export declare const FleetCreateInputSchema: {
|
|
|
503
730
|
readonly properties: {
|
|
504
731
|
readonly enabled: {
|
|
505
732
|
readonly type: "boolean";
|
|
506
|
-
readonly default: true;
|
|
507
733
|
};
|
|
508
734
|
readonly project: {
|
|
509
735
|
readonly type: "string";
|
|
510
|
-
readonly
|
|
736
|
+
readonly pattern: "^[a-z][a-z0-9-]{4,28}[a-z0-9]$";
|
|
737
|
+
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.";
|
|
738
|
+
readonly example: "my-cloudfleet-project";
|
|
511
739
|
};
|
|
512
740
|
};
|
|
513
|
-
readonly required: readonly ["
|
|
741
|
+
readonly required: readonly ["enabled"];
|
|
514
742
|
readonly additionalProperties: false;
|
|
515
743
|
};
|
|
516
744
|
readonly hetzner: {
|
|
517
|
-
readonly
|
|
518
|
-
|
|
519
|
-
readonly
|
|
520
|
-
readonly
|
|
521
|
-
readonly type: "boolean";
|
|
522
|
-
readonly default: true;
|
|
523
|
-
};
|
|
524
|
-
readonly apiKey: {
|
|
525
|
-
readonly type: "string";
|
|
526
|
-
};
|
|
745
|
+
readonly type: "object";
|
|
746
|
+
readonly properties: {
|
|
747
|
+
readonly enabled: {
|
|
748
|
+
readonly type: "boolean";
|
|
527
749
|
};
|
|
528
|
-
readonly
|
|
529
|
-
|
|
530
|
-
|
|
531
|
-
|
|
532
|
-
readonly
|
|
533
|
-
|
|
534
|
-
};
|
|
535
|
-
readonly enabled: {
|
|
536
|
-
readonly type: "boolean";
|
|
537
|
-
readonly default: true;
|
|
538
|
-
};
|
|
750
|
+
readonly apiKey: {
|
|
751
|
+
readonly type: "string";
|
|
752
|
+
readonly maxLength: 64;
|
|
753
|
+
readonly minLength: 64;
|
|
754
|
+
readonly pattern: "^([A-Za-z0-9]{64}|\\*{64})$";
|
|
755
|
+
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.";
|
|
539
756
|
};
|
|
540
|
-
|
|
541
|
-
|
|
757
|
+
};
|
|
758
|
+
readonly required: readonly ["enabled"];
|
|
759
|
+
readonly additionalProperties: false;
|
|
542
760
|
};
|
|
543
761
|
readonly aws: {
|
|
544
762
|
readonly type: "object";
|
|
545
763
|
readonly properties: {
|
|
546
764
|
readonly enabled: {
|
|
547
765
|
readonly type: "boolean";
|
|
548
|
-
readonly default: true;
|
|
549
766
|
};
|
|
550
767
|
readonly controllerRoleArn: {
|
|
551
768
|
readonly type: "string";
|
|
552
|
-
readonly
|
|
769
|
+
readonly pattern: "^arn:aws(-[a-z]+)*:iam::\\d{12}:role\\/[\\w+=,.@/-]+$";
|
|
770
|
+
readonly description: "AWS IAM role ARN that Karpenter uses to manage resources. Omit when AWS is disabled.";
|
|
771
|
+
readonly example: "arn:aws:iam::123456789012:role/Cloudfleet";
|
|
772
|
+
};
|
|
773
|
+
};
|
|
774
|
+
readonly required: readonly ["enabled"];
|
|
775
|
+
readonly additionalProperties: false;
|
|
776
|
+
};
|
|
777
|
+
readonly constraints: {
|
|
778
|
+
readonly type: "object";
|
|
779
|
+
readonly properties: {
|
|
780
|
+
readonly 'karpenter.sh/capacity-type': {
|
|
781
|
+
readonly type: "array";
|
|
782
|
+
readonly items: {
|
|
783
|
+
readonly type: "string";
|
|
784
|
+
readonly enum: readonly ["on-demand", "spot"];
|
|
785
|
+
};
|
|
786
|
+
readonly minItems: 1;
|
|
787
|
+
readonly description: "Allowed values for `karpenter.sh/capacity-type`.";
|
|
788
|
+
readonly default: readonly ["on-demand", "spot"];
|
|
789
|
+
};
|
|
790
|
+
readonly 'kubernetes.io/arch': {
|
|
791
|
+
readonly type: "array";
|
|
792
|
+
readonly items: {
|
|
793
|
+
readonly type: "string";
|
|
794
|
+
readonly enum: readonly ["amd64", "arm64"];
|
|
795
|
+
};
|
|
796
|
+
readonly minItems: 1;
|
|
797
|
+
readonly description: "Allowed values for `kubernetes.io/arch`.";
|
|
798
|
+
readonly default: readonly ["amd64"];
|
|
799
|
+
};
|
|
800
|
+
readonly 'cfke.io/instance-family': {
|
|
801
|
+
readonly type: "array";
|
|
802
|
+
readonly items: {
|
|
803
|
+
readonly type: "string";
|
|
804
|
+
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"];
|
|
805
|
+
};
|
|
806
|
+
readonly description: "Allowed values for `cfke.io/instance-family`.";
|
|
807
|
+
readonly default: readonly [];
|
|
808
|
+
};
|
|
809
|
+
readonly 'topology.kubernetes.io/region': {
|
|
810
|
+
readonly type: "array";
|
|
811
|
+
readonly items: {
|
|
812
|
+
readonly type: "string";
|
|
813
|
+
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"];
|
|
814
|
+
};
|
|
815
|
+
readonly description: "Allowed values for `topology.kubernetes.io/region`.";
|
|
816
|
+
readonly default: readonly [];
|
|
553
817
|
};
|
|
554
818
|
};
|
|
555
|
-
readonly required: readonly ["controllerRoleArn"];
|
|
556
819
|
readonly additionalProperties: false;
|
|
820
|
+
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.";
|
|
821
|
+
readonly default: {
|
|
822
|
+
readonly 'karpenter.sh/capacity-type': readonly ["on-demand", "spot"];
|
|
823
|
+
readonly 'kubernetes.io/arch': readonly ["amd64"];
|
|
824
|
+
readonly 'cfke.io/instance-family': readonly [];
|
|
825
|
+
readonly 'topology.kubernetes.io/region': readonly [];
|
|
826
|
+
};
|
|
827
|
+
};
|
|
828
|
+
readonly scalingProfile: {
|
|
829
|
+
readonly type: "string";
|
|
830
|
+
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`).";
|
|
831
|
+
readonly default: "conservative";
|
|
832
|
+
readonly example: "conservative";
|
|
833
|
+
readonly enum: readonly ["aggressive", "conservative"];
|
|
557
834
|
};
|
|
558
835
|
readonly id: {
|
|
559
836
|
readonly type: "string";
|
|
@@ -563,14 +840,10 @@ export declare const FleetCreateInputSchema: {
|
|
|
563
840
|
readonly description: "Unique identifier of the kubernetes fleet.";
|
|
564
841
|
readonly example: "new-clouds-fleet";
|
|
565
842
|
};
|
|
566
|
-
readonly type: {
|
|
567
|
-
readonly type: "string";
|
|
568
|
-
readonly description: "Specifies the fleet type: infrastructure managed by Cloudfleet or Connected Fleets.";
|
|
569
|
-
readonly enum: readonly ["managed", "connected"];
|
|
570
|
-
};
|
|
571
843
|
};
|
|
572
|
-
readonly required: readonly ["id"
|
|
844
|
+
readonly required: readonly ["id"];
|
|
573
845
|
readonly additionalProperties: false;
|
|
846
|
+
readonly description: "Mutable fleet configuration. Applied as a full overwrite: any omitted field is reset to its default rather than left unchanged.";
|
|
574
847
|
};
|
|
575
848
|
export declare const FleetSchema: {
|
|
576
849
|
readonly type: "object";
|
|
@@ -579,13 +852,12 @@ export declare const FleetSchema: {
|
|
|
579
852
|
readonly type: "object";
|
|
580
853
|
readonly properties: {
|
|
581
854
|
readonly cpu: {
|
|
582
|
-
readonly type: "
|
|
583
|
-
readonly format: "float";
|
|
855
|
+
readonly type: "integer";
|
|
584
856
|
readonly minimum: 0;
|
|
585
|
-
readonly
|
|
857
|
+
readonly maximum: 100000;
|
|
858
|
+
readonly description: "CPU limit in cores. Maximum 100,000.";
|
|
586
859
|
};
|
|
587
860
|
};
|
|
588
|
-
readonly required: readonly ["cpu"];
|
|
589
861
|
readonly additionalProperties: false;
|
|
590
862
|
readonly description: "Limits define a set of bounds for provisioning capacity.";
|
|
591
863
|
};
|
|
@@ -594,150 +866,285 @@ export declare const FleetSchema: {
|
|
|
594
866
|
readonly properties: {
|
|
595
867
|
readonly enabled: {
|
|
596
868
|
readonly type: "boolean";
|
|
597
|
-
readonly default: true;
|
|
598
869
|
};
|
|
599
870
|
readonly project: {
|
|
600
871
|
readonly type: "string";
|
|
601
|
-
readonly
|
|
872
|
+
readonly pattern: "^[a-z][a-z0-9-]{4,28}[a-z0-9]$";
|
|
873
|
+
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.";
|
|
874
|
+
readonly example: "my-cloudfleet-project";
|
|
602
875
|
};
|
|
603
876
|
};
|
|
604
|
-
readonly required: readonly ["
|
|
877
|
+
readonly required: readonly ["enabled"];
|
|
605
878
|
readonly additionalProperties: false;
|
|
606
879
|
};
|
|
607
880
|
readonly hetzner: {
|
|
608
|
-
readonly
|
|
609
|
-
|
|
610
|
-
readonly
|
|
611
|
-
readonly
|
|
612
|
-
readonly type: "boolean";
|
|
613
|
-
readonly default: true;
|
|
614
|
-
};
|
|
615
|
-
readonly apiKey: {
|
|
616
|
-
readonly type: "string";
|
|
617
|
-
};
|
|
881
|
+
readonly type: "object";
|
|
882
|
+
readonly properties: {
|
|
883
|
+
readonly enabled: {
|
|
884
|
+
readonly type: "boolean";
|
|
618
885
|
};
|
|
619
|
-
readonly
|
|
620
|
-
|
|
621
|
-
|
|
622
|
-
|
|
623
|
-
readonly apiKey: {
|
|
624
|
-
readonly type: "string";
|
|
625
|
-
};
|
|
626
|
-
readonly enabled: {
|
|
627
|
-
readonly type: "boolean";
|
|
628
|
-
readonly default: true;
|
|
629
|
-
};
|
|
886
|
+
readonly apiKey: {
|
|
887
|
+
readonly type: "string";
|
|
888
|
+
readonly pattern: "^\\*{64}$";
|
|
889
|
+
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.";
|
|
630
890
|
};
|
|
631
|
-
|
|
632
|
-
|
|
891
|
+
};
|
|
892
|
+
readonly required: readonly ["enabled"];
|
|
893
|
+
readonly additionalProperties: false;
|
|
633
894
|
};
|
|
634
895
|
readonly aws: {
|
|
635
896
|
readonly type: "object";
|
|
636
897
|
readonly properties: {
|
|
637
898
|
readonly enabled: {
|
|
638
899
|
readonly type: "boolean";
|
|
639
|
-
readonly default: true;
|
|
640
900
|
};
|
|
641
901
|
readonly controllerRoleArn: {
|
|
642
902
|
readonly type: "string";
|
|
643
|
-
readonly
|
|
903
|
+
readonly pattern: "^arn:aws(-[a-z]+)*:iam::\\d{12}:role\\/[\\w+=,.@/-]+$";
|
|
904
|
+
readonly description: "AWS IAM role ARN that Karpenter uses to manage resources. Omit when AWS is disabled.";
|
|
905
|
+
readonly example: "arn:aws:iam::123456789012:role/Cloudfleet";
|
|
644
906
|
};
|
|
645
907
|
};
|
|
646
|
-
readonly required: readonly ["
|
|
908
|
+
readonly required: readonly ["enabled"];
|
|
647
909
|
readonly additionalProperties: false;
|
|
648
910
|
};
|
|
649
|
-
readonly
|
|
650
|
-
readonly type: "string";
|
|
651
|
-
readonly maxLength: 63;
|
|
652
|
-
readonly minLength: 1;
|
|
653
|
-
readonly pattern: "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$";
|
|
654
|
-
readonly description: "Unique identifier of the kubernetes fleet.";
|
|
655
|
-
readonly example: "new-clouds-fleet";
|
|
656
|
-
};
|
|
657
|
-
readonly type: {
|
|
658
|
-
readonly type: "string";
|
|
659
|
-
readonly description: "Specifies the fleet type: infrastructure managed by Cloudfleet or Connected Fleets.";
|
|
660
|
-
readonly enum: readonly ["managed", "connected"];
|
|
661
|
-
};
|
|
662
|
-
};
|
|
663
|
-
readonly required: readonly ["id", "type"];
|
|
664
|
-
readonly additionalProperties: false;
|
|
665
|
-
};
|
|
666
|
-
export declare const FleetUpdateInputSchema: {
|
|
667
|
-
readonly type: "object";
|
|
668
|
-
readonly properties: {
|
|
669
|
-
readonly limits: {
|
|
911
|
+
readonly constraints: {
|
|
670
912
|
readonly type: "object";
|
|
671
913
|
readonly properties: {
|
|
672
|
-
readonly
|
|
673
|
-
readonly type: "
|
|
674
|
-
readonly
|
|
675
|
-
|
|
676
|
-
|
|
677
|
-
|
|
678
|
-
|
|
679
|
-
|
|
680
|
-
|
|
681
|
-
|
|
914
|
+
readonly 'karpenter.sh/capacity-type': {
|
|
915
|
+
readonly type: "array";
|
|
916
|
+
readonly items: {
|
|
917
|
+
readonly type: "string";
|
|
918
|
+
readonly enum: readonly ["on-demand", "spot"];
|
|
919
|
+
};
|
|
920
|
+
readonly minItems: 1;
|
|
921
|
+
readonly description: "Allowed values for `karpenter.sh/capacity-type`.";
|
|
922
|
+
readonly default: readonly ["on-demand", "spot"];
|
|
923
|
+
};
|
|
924
|
+
readonly 'kubernetes.io/arch': {
|
|
925
|
+
readonly type: "array";
|
|
926
|
+
readonly items: {
|
|
927
|
+
readonly type: "string";
|
|
928
|
+
readonly enum: readonly ["amd64", "arm64"];
|
|
929
|
+
};
|
|
930
|
+
readonly minItems: 1;
|
|
931
|
+
readonly description: "Allowed values for `kubernetes.io/arch`.";
|
|
932
|
+
readonly default: readonly ["amd64"];
|
|
933
|
+
};
|
|
934
|
+
readonly 'cfke.io/instance-family': {
|
|
935
|
+
readonly type: "array";
|
|
936
|
+
readonly items: {
|
|
937
|
+
readonly type: "string";
|
|
938
|
+
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"];
|
|
939
|
+
};
|
|
940
|
+
readonly description: "Allowed values for `cfke.io/instance-family`.";
|
|
941
|
+
readonly default: readonly [];
|
|
942
|
+
};
|
|
943
|
+
readonly 'topology.kubernetes.io/region': {
|
|
944
|
+
readonly type: "array";
|
|
945
|
+
readonly items: {
|
|
946
|
+
readonly type: "string";
|
|
947
|
+
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"];
|
|
948
|
+
};
|
|
949
|
+
readonly description: "Allowed values for `topology.kubernetes.io/region`.";
|
|
950
|
+
readonly default: readonly [];
|
|
951
|
+
};
|
|
952
|
+
};
|
|
953
|
+
readonly required: readonly ["karpenter.sh/capacity-type", "kubernetes.io/arch"];
|
|
954
|
+
readonly additionalProperties: false;
|
|
955
|
+
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.";
|
|
956
|
+
readonly default: {
|
|
957
|
+
readonly 'karpenter.sh/capacity-type': readonly ["on-demand", "spot"];
|
|
958
|
+
readonly 'kubernetes.io/arch': readonly ["amd64"];
|
|
959
|
+
readonly 'cfke.io/instance-family': readonly [];
|
|
960
|
+
readonly 'topology.kubernetes.io/region': readonly [];
|
|
961
|
+
};
|
|
962
|
+
};
|
|
963
|
+
readonly scalingProfile: {
|
|
964
|
+
readonly type: "string";
|
|
965
|
+
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`).";
|
|
966
|
+
readonly default: "conservative";
|
|
967
|
+
readonly example: "conservative";
|
|
968
|
+
readonly enum: readonly ["aggressive", "conservative"];
|
|
969
|
+
};
|
|
970
|
+
readonly id: {
|
|
971
|
+
readonly type: "string";
|
|
972
|
+
readonly maxLength: 63;
|
|
973
|
+
readonly minLength: 1;
|
|
974
|
+
readonly pattern: "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$";
|
|
975
|
+
readonly description: "Unique identifier of the kubernetes fleet.";
|
|
976
|
+
readonly example: "new-clouds-fleet";
|
|
977
|
+
};
|
|
978
|
+
readonly ready: {
|
|
979
|
+
readonly type: "boolean";
|
|
980
|
+
readonly description: "Indicates whether the fleet configuration is healthy.";
|
|
981
|
+
readonly example: true;
|
|
982
|
+
};
|
|
983
|
+
readonly status_message: {
|
|
984
|
+
readonly type: "string";
|
|
985
|
+
readonly description: "Human-readable reason the fleet is not ready. Present only when `ready` is false.";
|
|
986
|
+
readonly example: "Invalid provider permissions.";
|
|
987
|
+
};
|
|
988
|
+
readonly created_at: {
|
|
989
|
+
readonly type: "string";
|
|
990
|
+
readonly description: "Creation date and time of the fleet.";
|
|
991
|
+
readonly example: "2024-09-12T09:11:27Z";
|
|
992
|
+
};
|
|
993
|
+
readonly updated_at: {
|
|
994
|
+
readonly type: "string";
|
|
995
|
+
readonly description: "Date and time the fleet was last updated.";
|
|
996
|
+
readonly example: "2024-09-12T09:11:27Z";
|
|
997
|
+
};
|
|
998
|
+
};
|
|
999
|
+
readonly required: readonly ["constraints", "scalingProfile", "id", "ready", "created_at", "updated_at"];
|
|
1000
|
+
readonly additionalProperties: false;
|
|
1001
|
+
readonly description: "Mutable fleet configuration. Applied as a full overwrite: any omitted field is reset to its default rather than left unchanged.";
|
|
1002
|
+
};
|
|
1003
|
+
export declare const FleetUpdateInputSchema: {
|
|
1004
|
+
readonly type: "object";
|
|
1005
|
+
readonly properties: {
|
|
1006
|
+
readonly limits: {
|
|
1007
|
+
readonly type: "object";
|
|
1008
|
+
readonly properties: {
|
|
1009
|
+
readonly cpu: {
|
|
1010
|
+
readonly type: "integer";
|
|
1011
|
+
readonly minimum: 0;
|
|
1012
|
+
readonly maximum: 100000;
|
|
1013
|
+
readonly description: "CPU limit in cores. Maximum 100,000.";
|
|
1014
|
+
};
|
|
1015
|
+
};
|
|
1016
|
+
readonly additionalProperties: false;
|
|
1017
|
+
readonly description: "Limits define a set of bounds for provisioning capacity.";
|
|
682
1018
|
};
|
|
683
1019
|
readonly gcp: {
|
|
684
1020
|
readonly type: "object";
|
|
685
1021
|
readonly properties: {
|
|
686
1022
|
readonly enabled: {
|
|
687
1023
|
readonly type: "boolean";
|
|
688
|
-
readonly default: true;
|
|
689
1024
|
};
|
|
690
1025
|
readonly project: {
|
|
691
1026
|
readonly type: "string";
|
|
692
|
-
readonly
|
|
1027
|
+
readonly pattern: "^[a-z][a-z0-9-]{4,28}[a-z0-9]$";
|
|
1028
|
+
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.";
|
|
1029
|
+
readonly example: "my-cloudfleet-project";
|
|
693
1030
|
};
|
|
694
1031
|
};
|
|
695
|
-
readonly required: readonly ["
|
|
1032
|
+
readonly required: readonly ["enabled"];
|
|
696
1033
|
readonly additionalProperties: false;
|
|
697
1034
|
};
|
|
698
1035
|
readonly hetzner: {
|
|
699
|
-
readonly
|
|
700
|
-
|
|
701
|
-
readonly
|
|
702
|
-
readonly
|
|
703
|
-
readonly type: "boolean";
|
|
704
|
-
readonly default: true;
|
|
705
|
-
};
|
|
706
|
-
readonly apiKey: {
|
|
707
|
-
readonly type: "string";
|
|
708
|
-
};
|
|
1036
|
+
readonly type: "object";
|
|
1037
|
+
readonly properties: {
|
|
1038
|
+
readonly enabled: {
|
|
1039
|
+
readonly type: "boolean";
|
|
709
1040
|
};
|
|
710
|
-
readonly
|
|
711
|
-
|
|
712
|
-
|
|
713
|
-
|
|
714
|
-
readonly
|
|
715
|
-
|
|
716
|
-
};
|
|
717
|
-
readonly enabled: {
|
|
718
|
-
readonly type: "boolean";
|
|
719
|
-
readonly default: true;
|
|
720
|
-
};
|
|
1041
|
+
readonly apiKey: {
|
|
1042
|
+
readonly type: "string";
|
|
1043
|
+
readonly maxLength: 64;
|
|
1044
|
+
readonly minLength: 64;
|
|
1045
|
+
readonly pattern: "^([A-Za-z0-9]{64}|\\*{64})$";
|
|
1046
|
+
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.";
|
|
721
1047
|
};
|
|
722
|
-
|
|
723
|
-
|
|
1048
|
+
};
|
|
1049
|
+
readonly required: readonly ["enabled"];
|
|
1050
|
+
readonly additionalProperties: false;
|
|
724
1051
|
};
|
|
725
1052
|
readonly aws: {
|
|
726
1053
|
readonly type: "object";
|
|
727
1054
|
readonly properties: {
|
|
728
1055
|
readonly enabled: {
|
|
729
1056
|
readonly type: "boolean";
|
|
730
|
-
readonly default: true;
|
|
731
1057
|
};
|
|
732
1058
|
readonly controllerRoleArn: {
|
|
733
1059
|
readonly type: "string";
|
|
734
|
-
readonly
|
|
1060
|
+
readonly pattern: "^arn:aws(-[a-z]+)*:iam::\\d{12}:role\\/[\\w+=,.@/-]+$";
|
|
1061
|
+
readonly description: "AWS IAM role ARN that Karpenter uses to manage resources. Omit when AWS is disabled.";
|
|
1062
|
+
readonly example: "arn:aws:iam::123456789012:role/Cloudfleet";
|
|
1063
|
+
};
|
|
1064
|
+
};
|
|
1065
|
+
readonly required: readonly ["enabled"];
|
|
1066
|
+
readonly additionalProperties: false;
|
|
1067
|
+
};
|
|
1068
|
+
readonly constraints: {
|
|
1069
|
+
readonly type: "object";
|
|
1070
|
+
readonly properties: {
|
|
1071
|
+
readonly 'karpenter.sh/capacity-type': {
|
|
1072
|
+
readonly type: "array";
|
|
1073
|
+
readonly items: {
|
|
1074
|
+
readonly type: "string";
|
|
1075
|
+
readonly enum: readonly ["on-demand", "spot"];
|
|
1076
|
+
};
|
|
1077
|
+
readonly minItems: 1;
|
|
1078
|
+
readonly description: "Allowed values for `karpenter.sh/capacity-type`.";
|
|
1079
|
+
readonly default: readonly ["on-demand", "spot"];
|
|
1080
|
+
};
|
|
1081
|
+
readonly 'kubernetes.io/arch': {
|
|
1082
|
+
readonly type: "array";
|
|
1083
|
+
readonly items: {
|
|
1084
|
+
readonly type: "string";
|
|
1085
|
+
readonly enum: readonly ["amd64", "arm64"];
|
|
1086
|
+
};
|
|
1087
|
+
readonly minItems: 1;
|
|
1088
|
+
readonly description: "Allowed values for `kubernetes.io/arch`.";
|
|
1089
|
+
readonly default: readonly ["amd64"];
|
|
1090
|
+
};
|
|
1091
|
+
readonly 'cfke.io/instance-family': {
|
|
1092
|
+
readonly type: "array";
|
|
1093
|
+
readonly items: {
|
|
1094
|
+
readonly type: "string";
|
|
1095
|
+
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"];
|
|
1096
|
+
};
|
|
1097
|
+
readonly description: "Allowed values for `cfke.io/instance-family`.";
|
|
1098
|
+
readonly default: readonly [];
|
|
1099
|
+
};
|
|
1100
|
+
readonly 'topology.kubernetes.io/region': {
|
|
1101
|
+
readonly type: "array";
|
|
1102
|
+
readonly items: {
|
|
1103
|
+
readonly type: "string";
|
|
1104
|
+
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"];
|
|
1105
|
+
};
|
|
1106
|
+
readonly description: "Allowed values for `topology.kubernetes.io/region`.";
|
|
1107
|
+
readonly default: readonly [];
|
|
735
1108
|
};
|
|
736
1109
|
};
|
|
737
|
-
readonly required: readonly ["controllerRoleArn"];
|
|
738
1110
|
readonly additionalProperties: false;
|
|
1111
|
+
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.";
|
|
1112
|
+
readonly default: {
|
|
1113
|
+
readonly 'karpenter.sh/capacity-type': readonly ["on-demand", "spot"];
|
|
1114
|
+
readonly 'kubernetes.io/arch': readonly ["amd64"];
|
|
1115
|
+
readonly 'cfke.io/instance-family': readonly [];
|
|
1116
|
+
readonly 'topology.kubernetes.io/region': readonly [];
|
|
1117
|
+
};
|
|
1118
|
+
};
|
|
1119
|
+
readonly scalingProfile: {
|
|
1120
|
+
readonly type: "string";
|
|
1121
|
+
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`).";
|
|
1122
|
+
readonly default: "conservative";
|
|
1123
|
+
readonly example: "conservative";
|
|
1124
|
+
readonly enum: readonly ["aggressive", "conservative"];
|
|
1125
|
+
};
|
|
1126
|
+
};
|
|
1127
|
+
readonly additionalProperties: false;
|
|
1128
|
+
readonly description: "Mutable fleet configuration. Applied as a full overwrite: any omitted field is reset to its default rather than left unchanged.";
|
|
1129
|
+
};
|
|
1130
|
+
export declare const InviteCreateInputSchema: {
|
|
1131
|
+
readonly type: "object";
|
|
1132
|
+
readonly properties: {
|
|
1133
|
+
readonly email: {
|
|
1134
|
+
readonly type: "string";
|
|
1135
|
+
readonly format: "email";
|
|
1136
|
+
readonly description: "Email address of the user to invite.";
|
|
1137
|
+
readonly example: "email@example.com";
|
|
1138
|
+
};
|
|
1139
|
+
readonly role: {
|
|
1140
|
+
readonly type: "string";
|
|
1141
|
+
readonly description: "Role the invited user will be assigned on redemption. Can be 'Administrator' or 'User'.";
|
|
1142
|
+
readonly default: "User";
|
|
1143
|
+
readonly example: "User";
|
|
1144
|
+
readonly enum: readonly ["Administrator", "User"];
|
|
739
1145
|
};
|
|
740
1146
|
};
|
|
1147
|
+
readonly required: readonly ["email"];
|
|
741
1148
|
readonly additionalProperties: false;
|
|
742
1149
|
};
|
|
743
1150
|
export declare const InviteSchema: {
|
|
@@ -771,439 +1178,340 @@ export declare const InviteSchema: {
|
|
|
771
1178
|
readonly description: "Generated unique invite code.";
|
|
772
1179
|
readonly example: "7kUZnH7nnKUFfvc4NK2KQF";
|
|
773
1180
|
};
|
|
1181
|
+
readonly role: {
|
|
1182
|
+
readonly type: "string";
|
|
1183
|
+
readonly description: "Role the invited user will be assigned on redemption. Can be 'Administrator' or 'User'.";
|
|
1184
|
+
readonly default: "User";
|
|
1185
|
+
readonly example: "User";
|
|
1186
|
+
readonly enum: readonly ["Administrator", "User"];
|
|
1187
|
+
};
|
|
774
1188
|
};
|
|
775
1189
|
readonly required: readonly ["date_created"];
|
|
776
1190
|
readonly additionalProperties: false;
|
|
777
1191
|
};
|
|
778
|
-
export declare const
|
|
1192
|
+
export declare const InvoicePaymentAttemptSchema: {
|
|
779
1193
|
readonly type: "object";
|
|
780
1194
|
readonly properties: {
|
|
781
|
-
readonly
|
|
782
|
-
readonly type: "string";
|
|
783
|
-
readonly format: "uuid";
|
|
784
|
-
readonly description: "Unique identifier of the invoice. UUID v4 string in canonical form";
|
|
785
|
-
readonly example: "415026b6-f00f-44f8-968d-fc6ef4d0fc6d";
|
|
786
|
-
};
|
|
787
|
-
readonly organizationId: {
|
|
1195
|
+
readonly invoice_id: {
|
|
788
1196
|
readonly type: "string";
|
|
789
|
-
readonly
|
|
790
|
-
readonly
|
|
791
|
-
readonly example: "415026b6-f00f-44f8-968d-fc6ef4d0fc6d";
|
|
1197
|
+
readonly description: "Identifier of the invoice.";
|
|
1198
|
+
readonly example: "in_1234567890xCrwxghOTj1234";
|
|
792
1199
|
};
|
|
793
|
-
readonly
|
|
1200
|
+
readonly number: {
|
|
794
1201
|
readonly type: "string";
|
|
795
|
-
readonly
|
|
796
|
-
readonly
|
|
797
|
-
readonly
|
|
1202
|
+
readonly nullable: true;
|
|
1203
|
+
readonly description: "Invoice number. Null if the invoice has no number.";
|
|
1204
|
+
readonly example: "CF-0042";
|
|
798
1205
|
};
|
|
799
1206
|
readonly amount: {
|
|
800
1207
|
readonly type: "number";
|
|
801
1208
|
readonly format: "float";
|
|
802
|
-
readonly description: "
|
|
803
|
-
readonly example:
|
|
1209
|
+
readonly description: "Amount outstanding when the charge was attempted, in the smallest currency unit.";
|
|
1210
|
+
readonly example: 4200;
|
|
804
1211
|
};
|
|
805
1212
|
readonly currency: {
|
|
806
1213
|
readonly type: "string";
|
|
807
|
-
readonly description: "Currency of the invoice";
|
|
808
|
-
readonly example: "
|
|
809
|
-
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"];
|
|
810
|
-
};
|
|
811
|
-
readonly creditAdj: {
|
|
812
|
-
readonly type: "number";
|
|
813
|
-
readonly format: "float";
|
|
814
|
-
readonly description: "Total amount of credit adjustments";
|
|
815
|
-
readonly example: 0;
|
|
1214
|
+
readonly description: "Currency of the invoice.";
|
|
1215
|
+
readonly example: "eur";
|
|
816
1216
|
};
|
|
817
|
-
readonly
|
|
818
|
-
readonly type: "
|
|
819
|
-
readonly
|
|
820
|
-
readonly
|
|
821
|
-
readonly
|
|
1217
|
+
readonly status: {
|
|
1218
|
+
readonly type: "string";
|
|
1219
|
+
readonly description: "Outcome for this invoice: `paid`, `processing` (accepted, not yet settled), `requires_action` (awaiting customer authentication), or `failed` (declined).";
|
|
1220
|
+
readonly example: "paid";
|
|
1221
|
+
readonly enum: readonly ["paid", "processing", "requires_action", "failed"];
|
|
822
1222
|
};
|
|
823
|
-
readonly
|
|
1223
|
+
readonly client_secret: {
|
|
824
1224
|
readonly type: "string";
|
|
825
|
-
readonly
|
|
826
|
-
readonly
|
|
1225
|
+
readonly nullable: true;
|
|
1226
|
+
readonly description: "Client secret used to complete customer authentication. Set only when `status` is `requires_action`.";
|
|
1227
|
+
readonly example: "pi_3MtwBwLkdIwHu7ix28a3tqPa_secret_YrKJUKribcBjcG8HVhfZluoGH";
|
|
827
1228
|
};
|
|
828
|
-
readonly
|
|
1229
|
+
readonly failure_code: {
|
|
829
1230
|
readonly type: "string";
|
|
830
|
-
readonly
|
|
831
|
-
readonly
|
|
1231
|
+
readonly nullable: true;
|
|
1232
|
+
readonly description: "Decline code. Set only when `status` is `failed`.";
|
|
1233
|
+
readonly example: "insufficient_funds";
|
|
832
1234
|
};
|
|
833
|
-
readonly
|
|
1235
|
+
readonly failure_message: {
|
|
834
1236
|
readonly type: "string";
|
|
835
|
-
readonly
|
|
836
|
-
readonly
|
|
1237
|
+
readonly nullable: true;
|
|
1238
|
+
readonly description: "Explanation of the decline, suitable for display. Set only when `status` is `failed`.";
|
|
1239
|
+
readonly example: "Your card has insufficient funds.";
|
|
837
1240
|
};
|
|
838
|
-
|
|
839
|
-
|
|
840
|
-
|
|
841
|
-
|
|
842
|
-
|
|
1241
|
+
};
|
|
1242
|
+
readonly required: readonly ["invoice_id", "number", "amount", "currency", "status", "client_secret", "failure_code", "failure_message"];
|
|
1243
|
+
readonly additionalProperties: false;
|
|
1244
|
+
};
|
|
1245
|
+
export declare const InvoicePaymentResultSchema: {
|
|
1246
|
+
readonly type: "object";
|
|
1247
|
+
readonly properties: {
|
|
1248
|
+
readonly code: {
|
|
1249
|
+
readonly type: "string";
|
|
1250
|
+
readonly description: "Overall outcome: `paid` (nothing outstanding), `processing` (all accepted, not yet settled), `action_required` (one or more await customer authentication), `partially_paid`, `failed`, `nothing_due`, or `bank_transfer_due` (the organization pays by bank transfer; nothing was charged).";
|
|
1251
|
+
readonly example: "partially_paid";
|
|
1252
|
+
readonly enum: readonly ["paid", "processing", "action_required", "partially_paid", "failed", "nothing_due", "bank_transfer_due"];
|
|
843
1253
|
};
|
|
844
|
-
readonly
|
|
1254
|
+
readonly message: {
|
|
845
1255
|
readonly type: "string";
|
|
846
|
-
readonly description: "
|
|
847
|
-
readonly example: "
|
|
1256
|
+
readonly description: "Summary of the outcome, suitable for display.";
|
|
1257
|
+
readonly example: "1 of 2 open invoices was paid. Invoice CF-0043 was declined: Your card has insufficient funds.";
|
|
848
1258
|
};
|
|
849
|
-
readonly
|
|
1259
|
+
readonly results: {
|
|
850
1260
|
readonly type: "array";
|
|
851
1261
|
readonly items: {
|
|
852
1262
|
readonly type: "object";
|
|
853
1263
|
readonly properties: {
|
|
854
|
-
readonly
|
|
855
|
-
readonly type: "string";
|
|
856
|
-
readonly format: "uuid";
|
|
857
|
-
readonly description: "Unique identifier of the invoice item. UUID v4 string in canonical form";
|
|
858
|
-
readonly example: "415026b6-f00f-44f8-968d-fc6ef4d0fc6d";
|
|
859
|
-
};
|
|
860
|
-
readonly linkedInvoiceItemId: {
|
|
861
|
-
readonly type: "string";
|
|
862
|
-
readonly format: "uuid";
|
|
863
|
-
readonly description: "Unique identifier of the linked invoice item. UUID v4 string in canonical form";
|
|
864
|
-
readonly example: "415026b6-f00f-44f8-968d-fc6ef4d0fc6d";
|
|
865
|
-
};
|
|
866
|
-
readonly productName: {
|
|
867
|
-
readonly type: "string";
|
|
868
|
-
readonly description: "Name of the product";
|
|
869
|
-
readonly example: "Research team";
|
|
870
|
-
};
|
|
871
|
-
readonly planName: {
|
|
872
|
-
readonly type: "string";
|
|
873
|
-
readonly description: "Name of the plan";
|
|
874
|
-
readonly example: "Plan A";
|
|
875
|
-
};
|
|
876
|
-
readonly phaseName: {
|
|
877
|
-
readonly type: "string";
|
|
878
|
-
readonly description: "Name of the phase";
|
|
879
|
-
readonly example: "Phase A";
|
|
880
|
-
};
|
|
881
|
-
readonly usageName: {
|
|
882
|
-
readonly type: "string";
|
|
883
|
-
readonly description: "Name of the usage";
|
|
884
|
-
readonly example: "Usage A";
|
|
885
|
-
};
|
|
886
|
-
readonly prettyProductName: {
|
|
887
|
-
readonly type: "string";
|
|
888
|
-
readonly description: "Pretty name of the product";
|
|
889
|
-
readonly example: "Research team";
|
|
890
|
-
};
|
|
891
|
-
readonly prettyPlanName: {
|
|
892
|
-
readonly type: "string";
|
|
893
|
-
readonly description: "Pretty name of the plan";
|
|
894
|
-
readonly example: "Plan A";
|
|
895
|
-
};
|
|
896
|
-
readonly prettyPhaseName: {
|
|
897
|
-
readonly type: "string";
|
|
898
|
-
readonly description: "Pretty name of the phase";
|
|
899
|
-
readonly example: "Phase A";
|
|
900
|
-
};
|
|
901
|
-
readonly prettyUsageName: {
|
|
902
|
-
readonly type: "string";
|
|
903
|
-
readonly description: "Pretty name of the usage";
|
|
904
|
-
readonly example: "Usage A";
|
|
905
|
-
};
|
|
906
|
-
readonly itemType: {
|
|
907
|
-
readonly type: "string";
|
|
908
|
-
readonly description: "Type of the invoice item";
|
|
909
|
-
readonly example: "EXTERNAL_CHARGE";
|
|
910
|
-
readonly enum: readonly ["EXTERNAL_CHARGE", "FIXED", "RECURRING", "REPAIR_ADJ", "CBA_ADJ", "CREDIT_ADJ", "ITEM_ADJ", "USAGE", "TAX", "PARENT_SUMMARY"];
|
|
911
|
-
};
|
|
912
|
-
readonly description: {
|
|
913
|
-
readonly type: "string";
|
|
914
|
-
readonly description: "Description of the invoice item";
|
|
915
|
-
readonly example: "Description of the invoice item";
|
|
916
|
-
};
|
|
917
|
-
readonly startDate: {
|
|
1264
|
+
readonly invoice_id: {
|
|
918
1265
|
readonly type: "string";
|
|
919
|
-
readonly description: "
|
|
920
|
-
readonly example: "
|
|
1266
|
+
readonly description: "Identifier of the invoice.";
|
|
1267
|
+
readonly example: "in_1234567890xCrwxghOTj1234";
|
|
921
1268
|
};
|
|
922
|
-
readonly
|
|
1269
|
+
readonly number: {
|
|
923
1270
|
readonly type: "string";
|
|
924
|
-
readonly description: "
|
|
925
|
-
readonly example: "
|
|
1271
|
+
readonly description: "Invoice number. Null if the invoice has no number.";
|
|
1272
|
+
readonly example: "CF-0042";
|
|
926
1273
|
};
|
|
927
1274
|
readonly amount: {
|
|
928
1275
|
readonly type: "number";
|
|
929
1276
|
readonly format: "float";
|
|
930
|
-
readonly description: "Amount
|
|
931
|
-
readonly example:
|
|
932
|
-
};
|
|
933
|
-
readonly rate: {
|
|
934
|
-
readonly type: "number";
|
|
935
|
-
readonly format: "float";
|
|
936
|
-
readonly description: "Rate of the invoice item";
|
|
937
|
-
readonly example: 100;
|
|
1277
|
+
readonly description: "Amount outstanding when the charge was attempted, in the smallest currency unit.";
|
|
1278
|
+
readonly example: 4200;
|
|
938
1279
|
};
|
|
939
1280
|
readonly currency: {
|
|
940
1281
|
readonly type: "string";
|
|
941
|
-
readonly description: "Currency of the invoice
|
|
942
|
-
readonly example: "
|
|
943
|
-
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"];
|
|
1282
|
+
readonly description: "Currency of the invoice.";
|
|
1283
|
+
readonly example: "eur";
|
|
944
1284
|
};
|
|
945
|
-
readonly
|
|
946
|
-
readonly type: "
|
|
947
|
-
readonly
|
|
948
|
-
readonly
|
|
949
|
-
readonly
|
|
1285
|
+
readonly status: {
|
|
1286
|
+
readonly type: "string";
|
|
1287
|
+
readonly description: "Outcome for this invoice: `paid`, `processing` (accepted, not yet settled), `requires_action` (awaiting customer authentication), or `failed` (declined).";
|
|
1288
|
+
readonly example: "paid";
|
|
1289
|
+
readonly enum: readonly ["paid", "processing", "requires_action", "failed"];
|
|
950
1290
|
};
|
|
951
|
-
readonly
|
|
1291
|
+
readonly client_secret: {
|
|
952
1292
|
readonly type: "string";
|
|
953
|
-
readonly description: "
|
|
954
|
-
readonly example: "
|
|
1293
|
+
readonly description: "Client secret used to complete customer authentication. Set only when `status` is `requires_action`.";
|
|
1294
|
+
readonly example: "pi_3MtwBwLkdIwHu7ix28a3tqPa_secret_YrKJUKribcBjcG8HVhfZluoGH";
|
|
955
1295
|
};
|
|
956
|
-
readonly
|
|
1296
|
+
readonly failure_code: {
|
|
957
1297
|
readonly type: "string";
|
|
958
|
-
readonly description: "
|
|
959
|
-
readonly example: "
|
|
1298
|
+
readonly description: "Decline code. Set only when `status` is `failed`.";
|
|
1299
|
+
readonly example: "insufficient_funds";
|
|
960
1300
|
};
|
|
961
|
-
readonly
|
|
962
|
-
readonly type: "
|
|
963
|
-
readonly
|
|
964
|
-
|
|
965
|
-
readonly type: "array";
|
|
966
|
-
}, {
|
|
967
|
-
readonly type: "boolean";
|
|
968
|
-
}, {
|
|
969
|
-
readonly type: "number";
|
|
970
|
-
}, {
|
|
971
|
-
readonly type: "object";
|
|
972
|
-
readonly additionalProperties: true;
|
|
973
|
-
}, {
|
|
974
|
-
readonly type: "string";
|
|
975
|
-
}];
|
|
976
|
-
};
|
|
977
|
-
readonly description: "Child items of the invoice item";
|
|
1301
|
+
readonly failure_message: {
|
|
1302
|
+
readonly type: "string";
|
|
1303
|
+
readonly description: "Explanation of the decline, suitable for display. Set only when `status` is `failed`.";
|
|
1304
|
+
readonly example: "Your card has insufficient funds.";
|
|
978
1305
|
};
|
|
979
1306
|
};
|
|
1307
|
+
readonly required: readonly ["invoice_id", "number", "amount", "currency", "status", "client_secret", "failure_code", "failure_message"];
|
|
980
1308
|
readonly additionalProperties: false;
|
|
981
1309
|
};
|
|
982
|
-
readonly description: "
|
|
983
|
-
};
|
|
984
|
-
readonly items: {
|
|
985
|
-
readonly type: "array";
|
|
986
|
-
readonly items: {
|
|
987
|
-
readonly type: "object";
|
|
988
|
-
readonly properties: {
|
|
989
|
-
readonly id: {
|
|
990
|
-
readonly type: "string";
|
|
991
|
-
readonly format: "uuid";
|
|
992
|
-
readonly description: "Unique identifier of the invoice item. UUID v4 string in canonical form";
|
|
993
|
-
readonly example: "415026b6-f00f-44f8-968d-fc6ef4d0fc6d";
|
|
994
|
-
};
|
|
995
|
-
readonly linkedInvoiceItemId: {
|
|
996
|
-
readonly type: "string";
|
|
997
|
-
readonly format: "uuid";
|
|
998
|
-
readonly description: "Unique identifier of the linked invoice item. UUID v4 string in canonical form";
|
|
999
|
-
readonly example: "415026b6-f00f-44f8-968d-fc6ef4d0fc6d";
|
|
1000
|
-
};
|
|
1001
|
-
readonly productName: {
|
|
1002
|
-
readonly type: "string";
|
|
1003
|
-
readonly description: "Name of the product";
|
|
1004
|
-
readonly example: "Research team";
|
|
1005
|
-
};
|
|
1006
|
-
readonly planName: {
|
|
1007
|
-
readonly type: "string";
|
|
1008
|
-
readonly description: "Name of the plan";
|
|
1009
|
-
readonly example: "Plan A";
|
|
1010
|
-
};
|
|
1011
|
-
readonly phaseName: {
|
|
1012
|
-
readonly type: "string";
|
|
1013
|
-
readonly description: "Name of the phase";
|
|
1014
|
-
readonly example: "Phase A";
|
|
1015
|
-
};
|
|
1016
|
-
readonly usageName: {
|
|
1017
|
-
readonly type: "string";
|
|
1018
|
-
readonly description: "Name of the usage";
|
|
1019
|
-
readonly example: "Usage A";
|
|
1020
|
-
};
|
|
1021
|
-
readonly prettyProductName: {
|
|
1022
|
-
readonly type: "string";
|
|
1023
|
-
readonly description: "Pretty name of the product";
|
|
1024
|
-
readonly example: "Research team";
|
|
1025
|
-
};
|
|
1026
|
-
readonly prettyPlanName: {
|
|
1027
|
-
readonly type: "string";
|
|
1028
|
-
readonly description: "Pretty name of the plan";
|
|
1029
|
-
readonly example: "Plan A";
|
|
1030
|
-
};
|
|
1031
|
-
readonly prettyPhaseName: {
|
|
1032
|
-
readonly type: "string";
|
|
1033
|
-
readonly description: "Pretty name of the phase";
|
|
1034
|
-
readonly example: "Phase A";
|
|
1035
|
-
};
|
|
1036
|
-
readonly prettyUsageName: {
|
|
1037
|
-
readonly type: "string";
|
|
1038
|
-
readonly description: "Pretty name of the usage";
|
|
1039
|
-
readonly example: "Usage A";
|
|
1040
|
-
};
|
|
1041
|
-
readonly itemType: {
|
|
1042
|
-
readonly type: "string";
|
|
1043
|
-
readonly description: "Type of the invoice item";
|
|
1044
|
-
readonly example: "EXTERNAL_CHARGE";
|
|
1045
|
-
readonly enum: readonly ["EXTERNAL_CHARGE", "FIXED", "RECURRING", "REPAIR_ADJ", "CBA_ADJ", "CREDIT_ADJ", "ITEM_ADJ", "USAGE", "TAX", "PARENT_SUMMARY"];
|
|
1046
|
-
};
|
|
1047
|
-
readonly description: {
|
|
1048
|
-
readonly type: "string";
|
|
1049
|
-
readonly description: "Description of the invoice item";
|
|
1050
|
-
readonly example: "Description of the invoice item";
|
|
1051
|
-
};
|
|
1052
|
-
readonly startDate: {
|
|
1053
|
-
readonly type: "string";
|
|
1054
|
-
readonly description: "Start date of the invoice item";
|
|
1055
|
-
readonly example: "2019-01-01T00:00:00.000Z";
|
|
1056
|
-
};
|
|
1057
|
-
readonly endDate: {
|
|
1058
|
-
readonly type: "string";
|
|
1059
|
-
readonly description: "End date of the invoice item";
|
|
1060
|
-
readonly example: "2019-01-01T00:00:00.000Z";
|
|
1061
|
-
};
|
|
1062
|
-
readonly amount: {
|
|
1063
|
-
readonly type: "number";
|
|
1064
|
-
readonly format: "float";
|
|
1065
|
-
readonly description: "Amount of the invoice item";
|
|
1066
|
-
readonly example: 100;
|
|
1067
|
-
};
|
|
1068
|
-
readonly rate: {
|
|
1069
|
-
readonly type: "number";
|
|
1070
|
-
readonly format: "float";
|
|
1071
|
-
readonly description: "Rate of the invoice item";
|
|
1072
|
-
readonly example: 100;
|
|
1073
|
-
};
|
|
1074
|
-
readonly currency: {
|
|
1075
|
-
readonly type: "string";
|
|
1076
|
-
readonly description: "Currency of the invoice item";
|
|
1077
|
-
readonly example: "USD";
|
|
1078
|
-
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"];
|
|
1079
|
-
};
|
|
1080
|
-
readonly quantity: {
|
|
1081
|
-
readonly type: "number";
|
|
1082
|
-
readonly format: "float";
|
|
1083
|
-
readonly description: "Quantity of the invoice item";
|
|
1084
|
-
readonly example: 1;
|
|
1085
|
-
};
|
|
1086
|
-
readonly itemDetails: {
|
|
1087
|
-
readonly type: "string";
|
|
1088
|
-
readonly description: "Details of the invoice item";
|
|
1089
|
-
readonly example: "Details of the invoice item";
|
|
1090
|
-
};
|
|
1091
|
-
readonly catalogEffectiveDate: {
|
|
1092
|
-
readonly type: "string";
|
|
1093
|
-
readonly description: "Effective date of the catalog";
|
|
1094
|
-
readonly example: "2019-01-01T00:00:00.000Z";
|
|
1095
|
-
};
|
|
1096
|
-
readonly childItems: {
|
|
1097
|
-
readonly type: "array";
|
|
1098
|
-
readonly items: {
|
|
1099
|
-
readonly oneOf: readonly [{
|
|
1100
|
-
readonly type: "array";
|
|
1101
|
-
}, {
|
|
1102
|
-
readonly type: "boolean";
|
|
1103
|
-
}, {
|
|
1104
|
-
readonly type: "number";
|
|
1105
|
-
}, {
|
|
1106
|
-
readonly type: "object";
|
|
1107
|
-
readonly additionalProperties: true;
|
|
1108
|
-
}, {
|
|
1109
|
-
readonly type: "string";
|
|
1110
|
-
}];
|
|
1111
|
-
};
|
|
1112
|
-
readonly description: "Child items of the invoice item";
|
|
1113
|
-
};
|
|
1114
|
-
};
|
|
1115
|
-
readonly additionalProperties: false;
|
|
1116
|
-
};
|
|
1117
|
-
readonly description: "Items of the invoice";
|
|
1310
|
+
readonly description: "One entry per invoice charged, oldest first.";
|
|
1118
1311
|
};
|
|
1119
1312
|
};
|
|
1313
|
+
readonly required: readonly ["code", "message", "results"];
|
|
1120
1314
|
readonly additionalProperties: false;
|
|
1121
1315
|
};
|
|
1122
|
-
export declare const
|
|
1316
|
+
export declare const InvoiceSchema: {
|
|
1123
1317
|
readonly type: "object";
|
|
1124
1318
|
readonly properties: {
|
|
1125
1319
|
readonly id: {
|
|
1126
1320
|
readonly type: "string";
|
|
1127
|
-
readonly
|
|
1128
|
-
readonly
|
|
1129
|
-
readonly pattern: "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$";
|
|
1130
|
-
readonly description: "Id of the chart listing";
|
|
1131
|
-
readonly example: "portworx-enterprise-disaster-recovery-baremetal";
|
|
1321
|
+
readonly description: "Unique identifier of the invoice.";
|
|
1322
|
+
readonly example: "in_1234567890xCrwxghOTj1234";
|
|
1132
1323
|
};
|
|
1133
|
-
readonly
|
|
1324
|
+
readonly number: {
|
|
1134
1325
|
readonly type: "string";
|
|
1135
|
-
readonly description: "Name of the chart listing";
|
|
1136
|
-
readonly example: "Portworx Enterprise + Disaster Recovery - Baremetal";
|
|
1137
1326
|
};
|
|
1138
|
-
readonly
|
|
1327
|
+
readonly status: {
|
|
1139
1328
|
readonly type: "string";
|
|
1140
|
-
readonly description: "
|
|
1141
|
-
readonly example: "
|
|
1329
|
+
readonly description: "Status of the invoice";
|
|
1330
|
+
readonly example: "paid";
|
|
1142
1331
|
};
|
|
1143
|
-
readonly
|
|
1332
|
+
readonly total: {
|
|
1333
|
+
readonly type: "number";
|
|
1334
|
+
readonly format: "float";
|
|
1335
|
+
readonly description: "Total amount of the invoice";
|
|
1336
|
+
readonly example: 100;
|
|
1337
|
+
};
|
|
1338
|
+
readonly currency: {
|
|
1339
|
+
readonly type: "string";
|
|
1340
|
+
readonly description: "Currency of the invoice";
|
|
1341
|
+
readonly example: "usd";
|
|
1342
|
+
};
|
|
1343
|
+
readonly created: {
|
|
1344
|
+
readonly type: "string";
|
|
1345
|
+
readonly format: "date-time";
|
|
1346
|
+
readonly description: "Timestamp when the invoice was issued. ISO 8601 date string in the UTC timezone.";
|
|
1347
|
+
readonly example: "2023-12-20T13:53:32.000Z";
|
|
1348
|
+
};
|
|
1349
|
+
readonly period_start: {
|
|
1350
|
+
readonly type: "string";
|
|
1351
|
+
readonly format: "date-time";
|
|
1352
|
+
readonly description: "Billing period start timestamp. ISO 8601 date string in the UTC timezone.";
|
|
1353
|
+
readonly example: "2023-12-20T13:53:32.000Z";
|
|
1354
|
+
};
|
|
1355
|
+
readonly period_end: {
|
|
1144
1356
|
readonly type: "string";
|
|
1145
|
-
readonly
|
|
1146
|
-
readonly
|
|
1357
|
+
readonly format: "date-time";
|
|
1358
|
+
readonly description: "Billing period end timestamp. ISO 8601 date string in the UTC timezone.";
|
|
1359
|
+
readonly example: "2023-12-20T13:53:32.000Z";
|
|
1147
1360
|
};
|
|
1148
|
-
readonly
|
|
1361
|
+
readonly invoice_pdf: {
|
|
1149
1362
|
readonly type: "string";
|
|
1150
|
-
readonly description: "Logo of the chart listing";
|
|
1151
|
-
readonly example: "https://portworx.com/wp-content/themes/portworx/assets/images/header/portworx-logo.png";
|
|
1152
1363
|
};
|
|
1153
|
-
|
|
1364
|
+
};
|
|
1365
|
+
readonly required: readonly ["created", "period_start", "period_end"];
|
|
1366
|
+
readonly additionalProperties: false;
|
|
1367
|
+
};
|
|
1368
|
+
export declare const MarketplaceListingFilesSchema: {
|
|
1369
|
+
readonly type: "object";
|
|
1370
|
+
readonly properties: {
|
|
1371
|
+
readonly chartYaml: {
|
|
1154
1372
|
readonly type: "string";
|
|
1155
|
-
readonly description: "
|
|
1156
|
-
readonly example: "
|
|
1373
|
+
readonly description: "Raw Chart.yaml content from the Helm chart";
|
|
1374
|
+
readonly example: "apiVersion: v2\nname: nginx-ingress\nversion: 1.18.2-cfke.45\nappVersion: 1.9.4";
|
|
1157
1375
|
};
|
|
1158
|
-
readonly
|
|
1376
|
+
readonly valuesYaml: {
|
|
1377
|
+
readonly type: "string";
|
|
1378
|
+
readonly description: "Raw values.yaml content from the Helm chart";
|
|
1379
|
+
readonly example: "replicaCount: 1\nimage:\n repository: nginx\n tag: latest";
|
|
1380
|
+
};
|
|
1381
|
+
readonly valuesSchemaJson: {
|
|
1382
|
+
readonly type: "string";
|
|
1383
|
+
readonly description: "JSON schema for values.yaml as a string";
|
|
1384
|
+
readonly example: "{\"type\":\"object\",\"properties\":{\"replicaCount\":{\"type\":\"number\"}}}";
|
|
1385
|
+
};
|
|
1386
|
+
};
|
|
1387
|
+
readonly additionalProperties: false;
|
|
1388
|
+
};
|
|
1389
|
+
export declare const MarketplaceListingSchema: {
|
|
1390
|
+
readonly type: "object";
|
|
1391
|
+
readonly properties: {
|
|
1392
|
+
readonly name: {
|
|
1393
|
+
readonly type: "string";
|
|
1394
|
+
readonly description: "Name of the chart";
|
|
1395
|
+
readonly example: "nginx-ingress";
|
|
1396
|
+
};
|
|
1397
|
+
readonly versions: {
|
|
1159
1398
|
readonly type: "array";
|
|
1160
1399
|
readonly items: {
|
|
1161
1400
|
readonly type: "string";
|
|
1162
|
-
readonly
|
|
1401
|
+
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-]+)*))?$";
|
|
1402
|
+
readonly description: "Specific version of the chart";
|
|
1403
|
+
readonly example: "1.18.2-cfke.45";
|
|
1163
1404
|
};
|
|
1164
|
-
readonly description: "
|
|
1405
|
+
readonly description: "Available versions of the chart";
|
|
1165
1406
|
};
|
|
1166
1407
|
readonly version_channels: {
|
|
1167
1408
|
readonly type: "array";
|
|
1168
1409
|
readonly items: {
|
|
1169
1410
|
readonly type: "string";
|
|
1170
1411
|
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-]+)*))?$";
|
|
1171
|
-
readonly description: "Version
|
|
1172
|
-
readonly example: "
|
|
1412
|
+
readonly description: "Version channel pattern";
|
|
1413
|
+
readonly example: "1.18.x-cfke.x";
|
|
1173
1414
|
};
|
|
1415
|
+
readonly description: "Version channels for the chart";
|
|
1174
1416
|
};
|
|
1175
|
-
readonly
|
|
1176
|
-
readonly type: "
|
|
1177
|
-
readonly
|
|
1178
|
-
|
|
1179
|
-
|
|
1180
|
-
|
|
1417
|
+
readonly latestVersion: {
|
|
1418
|
+
readonly type: "string";
|
|
1419
|
+
readonly description: "Latest version of the chart";
|
|
1420
|
+
readonly example: "1.18.2-cfke.45";
|
|
1421
|
+
};
|
|
1422
|
+
readonly metadata: {
|
|
1423
|
+
readonly type: "object";
|
|
1424
|
+
readonly properties: {
|
|
1425
|
+
readonly name: {
|
|
1426
|
+
readonly type: "string";
|
|
1427
|
+
readonly description: "Chart name from metadata";
|
|
1428
|
+
readonly example: "nginx-ingress";
|
|
1429
|
+
};
|
|
1430
|
+
readonly version: {
|
|
1431
|
+
readonly type: "string";
|
|
1432
|
+
readonly description: "Chart version from metadata";
|
|
1433
|
+
readonly example: "1.18.2-cfke.45";
|
|
1434
|
+
};
|
|
1435
|
+
readonly description: {
|
|
1436
|
+
readonly type: "string";
|
|
1437
|
+
readonly description: "Chart description";
|
|
1438
|
+
readonly example: "NGINX Ingress Controller for Kubernetes";
|
|
1439
|
+
};
|
|
1440
|
+
readonly appVersion: {
|
|
1441
|
+
readonly type: "string";
|
|
1442
|
+
readonly description: "Application version";
|
|
1443
|
+
readonly example: "1.9.4";
|
|
1444
|
+
};
|
|
1445
|
+
readonly apiVersion: {
|
|
1446
|
+
readonly type: "string";
|
|
1447
|
+
readonly description: "Helm API version";
|
|
1448
|
+
readonly example: "v2";
|
|
1449
|
+
};
|
|
1450
|
+
readonly keywords: {
|
|
1451
|
+
readonly type: "array";
|
|
1452
|
+
readonly items: {
|
|
1181
1453
|
readonly type: "string";
|
|
1182
|
-
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-]+)*))?$";
|
|
1183
|
-
readonly description: "Version of the chart.";
|
|
1184
|
-
readonly example: "2.1.1-cfke.123";
|
|
1185
1454
|
};
|
|
1186
|
-
readonly
|
|
1455
|
+
readonly description: "Chart keywords";
|
|
1456
|
+
readonly example: readonly ["ingress", "nginx", "load-balancer"];
|
|
1457
|
+
};
|
|
1458
|
+
readonly home: {
|
|
1459
|
+
readonly type: "string";
|
|
1460
|
+
readonly description: "Chart home URL";
|
|
1461
|
+
readonly example: "https://kubernetes.github.io/ingress-nginx/";
|
|
1462
|
+
};
|
|
1463
|
+
readonly icon: {
|
|
1464
|
+
readonly type: "string";
|
|
1465
|
+
readonly description: "A URL to an SVG or PNG image to be used as an icon";
|
|
1466
|
+
readonly example: "https://cloudfleet.ai/images/marketplace/icons/ingress-nginx.png";
|
|
1467
|
+
};
|
|
1468
|
+
readonly sources: {
|
|
1469
|
+
readonly type: "array";
|
|
1470
|
+
readonly items: {
|
|
1187
1471
|
readonly type: "string";
|
|
1188
|
-
readonly description: "Schema of the chart values. JSON Schema as string";
|
|
1189
1472
|
};
|
|
1190
|
-
readonly
|
|
1191
|
-
|
|
1192
|
-
|
|
1193
|
-
|
|
1473
|
+
readonly description: "Chart source URLs";
|
|
1474
|
+
readonly example: readonly ["https://github.com/kubernetes/ingress-nginx"];
|
|
1475
|
+
};
|
|
1476
|
+
readonly maintainers: {
|
|
1477
|
+
readonly type: "array";
|
|
1478
|
+
readonly items: {
|
|
1479
|
+
readonly type: "object";
|
|
1480
|
+
readonly properties: {
|
|
1481
|
+
readonly name: {
|
|
1482
|
+
readonly type: "string";
|
|
1483
|
+
readonly description: "Maintainer name";
|
|
1484
|
+
readonly example: "NGINX Team";
|
|
1485
|
+
};
|
|
1486
|
+
readonly email: {
|
|
1487
|
+
readonly type: "string";
|
|
1488
|
+
readonly description: "Maintainer email";
|
|
1489
|
+
readonly example: "support@nginx.org";
|
|
1490
|
+
};
|
|
1491
|
+
};
|
|
1492
|
+
readonly required: readonly ["name"];
|
|
1493
|
+
readonly additionalProperties: false;
|
|
1194
1494
|
};
|
|
1495
|
+
readonly description: "Chart maintainers";
|
|
1195
1496
|
};
|
|
1196
|
-
readonly required: readonly ["version", "schema", "placeholder"];
|
|
1197
|
-
readonly additionalProperties: false;
|
|
1198
1497
|
};
|
|
1498
|
+
readonly required: readonly ["name", "version"];
|
|
1499
|
+
readonly additionalProperties: false;
|
|
1500
|
+
readonly description: "Chart metadata";
|
|
1199
1501
|
};
|
|
1200
1502
|
};
|
|
1201
|
-
readonly required: readonly ["
|
|
1503
|
+
readonly required: readonly ["name", "versions", "version_channels", "latestVersion"];
|
|
1202
1504
|
readonly additionalProperties: false;
|
|
1203
1505
|
};
|
|
1204
1506
|
export declare const OrganizationCreateInputSchema: {
|
|
1205
1507
|
readonly type: "object";
|
|
1206
1508
|
readonly properties: {
|
|
1509
|
+
readonly type: {
|
|
1510
|
+
readonly type: "string";
|
|
1511
|
+
readonly description: "Type of the organization. `business` for legal entities, `personal` for individuals.";
|
|
1512
|
+
readonly example: "business";
|
|
1513
|
+
readonly enum: readonly ["business", "personal"];
|
|
1514
|
+
};
|
|
1207
1515
|
readonly email: {
|
|
1208
1516
|
readonly type: "string";
|
|
1209
1517
|
readonly format: "email";
|
|
@@ -1212,11 +1520,13 @@ export declare const OrganizationCreateInputSchema: {
|
|
|
1212
1520
|
};
|
|
1213
1521
|
readonly first_name: {
|
|
1214
1522
|
readonly type: "string";
|
|
1523
|
+
readonly minLength: 1;
|
|
1215
1524
|
readonly description: "First name of the billing contact person.";
|
|
1216
1525
|
readonly example: "John";
|
|
1217
1526
|
};
|
|
1218
1527
|
readonly last_name: {
|
|
1219
1528
|
readonly type: "string";
|
|
1529
|
+
readonly minLength: 1;
|
|
1220
1530
|
readonly description: "Last name of the billing contact person.";
|
|
1221
1531
|
readonly example: "Doe";
|
|
1222
1532
|
};
|
|
@@ -1234,7 +1544,19 @@ export declare const OrganizationCreateInputSchema: {
|
|
|
1234
1544
|
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.";
|
|
1235
1545
|
};
|
|
1236
1546
|
};
|
|
1237
|
-
readonly required: readonly ["email", "first_name", "last_name", "company_name", "password"];
|
|
1547
|
+
readonly required: readonly ["type", "email", "first_name", "last_name", "company_name", "password"];
|
|
1548
|
+
readonly additionalProperties: false;
|
|
1549
|
+
};
|
|
1550
|
+
export declare const OrganizationCreateOutputSchema: {
|
|
1551
|
+
readonly type: "object";
|
|
1552
|
+
readonly properties: {
|
|
1553
|
+
readonly id: {
|
|
1554
|
+
readonly type: "string";
|
|
1555
|
+
readonly description: "Unique identifier of the newly created organization. Generated by the API and safe to use for client-side tracking immediately.";
|
|
1556
|
+
readonly example: "organization-id";
|
|
1557
|
+
};
|
|
1558
|
+
};
|
|
1559
|
+
readonly required: readonly ["id"];
|
|
1238
1560
|
readonly additionalProperties: false;
|
|
1239
1561
|
};
|
|
1240
1562
|
export declare const OrganizationSchema: {
|
|
@@ -1253,154 +1575,782 @@ export declare const OrganizationSchema: {
|
|
|
1253
1575
|
readonly description: "Name of the legal entity. This name will be used in invoices. Use your first and last name for individual accounts.";
|
|
1254
1576
|
readonly example: "ACME Corp.";
|
|
1255
1577
|
};
|
|
1256
|
-
readonly
|
|
1578
|
+
readonly type: {
|
|
1579
|
+
readonly type: "string";
|
|
1580
|
+
readonly description: "Type of the organization. `business` for legal entities, `personal` for individuals.";
|
|
1581
|
+
readonly example: "business";
|
|
1582
|
+
readonly enum: readonly ["business", "personal"];
|
|
1583
|
+
};
|
|
1584
|
+
readonly date_created: {
|
|
1585
|
+
readonly type: "string";
|
|
1586
|
+
readonly format: "date-time";
|
|
1587
|
+
readonly description: "Creation date of the organization. ISO 8601 date string in UTC timezone";
|
|
1588
|
+
readonly example: "2023-11-02T16:08:14.338Z";
|
|
1589
|
+
};
|
|
1590
|
+
readonly quota: {
|
|
1591
|
+
readonly type: "object";
|
|
1592
|
+
readonly properties: {
|
|
1593
|
+
readonly basic_clusters_max: {
|
|
1594
|
+
readonly type: "integer";
|
|
1595
|
+
readonly minimum: 0;
|
|
1596
|
+
readonly description: "Maximum number of Basic clusters that can be created.";
|
|
1597
|
+
readonly example: 999;
|
|
1598
|
+
};
|
|
1599
|
+
readonly basic_clusters_available: {
|
|
1600
|
+
readonly type: "integer";
|
|
1601
|
+
readonly description: "Available number of Basic clusters that can be created.";
|
|
1602
|
+
readonly example: 999;
|
|
1603
|
+
};
|
|
1604
|
+
readonly pro_clusters_max: {
|
|
1605
|
+
readonly type: "integer";
|
|
1606
|
+
readonly minimum: 0;
|
|
1607
|
+
readonly description: "Maximum number of Pro clusters that can be created.";
|
|
1608
|
+
readonly example: 999;
|
|
1609
|
+
};
|
|
1610
|
+
readonly pro_clusters_available: {
|
|
1611
|
+
readonly type: "integer";
|
|
1612
|
+
readonly description: "Available number of Pro clusters that can be created.";
|
|
1613
|
+
readonly example: 999;
|
|
1614
|
+
};
|
|
1615
|
+
readonly enterprise_clusters_max: {
|
|
1616
|
+
readonly type: "integer";
|
|
1617
|
+
readonly minimum: 0;
|
|
1618
|
+
readonly description: "Maximum number of Enterprise clusters that can be created.";
|
|
1619
|
+
readonly example: 999;
|
|
1620
|
+
};
|
|
1621
|
+
readonly enterprise_clusters_available: {
|
|
1622
|
+
readonly type: "integer";
|
|
1623
|
+
readonly description: "Available number of Enterprise clusters that can be created.";
|
|
1624
|
+
readonly example: 999;
|
|
1625
|
+
};
|
|
1626
|
+
readonly fleets_max: {
|
|
1627
|
+
readonly type: "integer";
|
|
1628
|
+
readonly minimum: 0;
|
|
1629
|
+
readonly description: "Maximum number of fleets that can be created per cluster.";
|
|
1630
|
+
readonly example: 999;
|
|
1631
|
+
};
|
|
1632
|
+
readonly cluster_tiers: {
|
|
1633
|
+
readonly type: "array";
|
|
1634
|
+
readonly items: {
|
|
1635
|
+
readonly type: "string";
|
|
1636
|
+
readonly example: "basic";
|
|
1637
|
+
};
|
|
1638
|
+
readonly minItems: 0;
|
|
1639
|
+
readonly description: "List of Cloudfleet cluster tiers available for the organization.";
|
|
1640
|
+
};
|
|
1641
|
+
readonly regions: {
|
|
1642
|
+
readonly type: "array";
|
|
1643
|
+
readonly items: {
|
|
1644
|
+
readonly type: "string";
|
|
1645
|
+
readonly example: "northamerica-central-1a";
|
|
1646
|
+
};
|
|
1647
|
+
readonly minItems: 1;
|
|
1648
|
+
readonly description: "List of Cloudfleet control plane regions available for the organization.";
|
|
1649
|
+
};
|
|
1650
|
+
readonly versions: {
|
|
1651
|
+
readonly type: "array";
|
|
1652
|
+
readonly items: {
|
|
1653
|
+
readonly type: "object";
|
|
1654
|
+
readonly properties: {
|
|
1655
|
+
readonly id: {
|
|
1656
|
+
readonly type: "string";
|
|
1657
|
+
readonly description: "Id of the control plane version. Used in API calls.";
|
|
1658
|
+
readonly example: "1.33.x-cfke.x";
|
|
1659
|
+
};
|
|
1660
|
+
readonly label: {
|
|
1661
|
+
readonly type: "string";
|
|
1662
|
+
readonly description: "Label of the control plane version. Used in frontent UI.";
|
|
1663
|
+
readonly example: "1.33.x (Always latest 1.33 patch version)";
|
|
1664
|
+
};
|
|
1665
|
+
};
|
|
1666
|
+
readonly required: readonly ["id", "label"];
|
|
1667
|
+
readonly additionalProperties: false;
|
|
1668
|
+
};
|
|
1669
|
+
readonly minItems: 1;
|
|
1670
|
+
readonly description: "List of CFKE control plane versions available for the organization.";
|
|
1671
|
+
};
|
|
1672
|
+
readonly cfcr_storage_gb: {
|
|
1673
|
+
readonly type: "integer";
|
|
1674
|
+
readonly minimum: -1;
|
|
1675
|
+
readonly description: "Organization-level maximum CFCR storage volume in GB. -1 means no limit.";
|
|
1676
|
+
readonly example: 500;
|
|
1677
|
+
};
|
|
1678
|
+
};
|
|
1679
|
+
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"];
|
|
1680
|
+
readonly additionalProperties: false;
|
|
1681
|
+
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.";
|
|
1682
|
+
};
|
|
1683
|
+
readonly status: {
|
|
1684
|
+
readonly type: "string";
|
|
1685
|
+
readonly description: "Status of the organization. Can be `active` or `closed`, or `suspended`.";
|
|
1686
|
+
readonly enum: readonly ["active", "closed", "suspended"];
|
|
1687
|
+
};
|
|
1688
|
+
readonly verification: {
|
|
1689
|
+
readonly type: "string";
|
|
1690
|
+
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.";
|
|
1691
|
+
readonly example: "verified";
|
|
1692
|
+
readonly enum: readonly ["none", "submitted", "verified"];
|
|
1693
|
+
};
|
|
1694
|
+
};
|
|
1695
|
+
readonly required: readonly ["id", "type", "date_created", "quota", "status", "verification"];
|
|
1696
|
+
readonly additionalProperties: false;
|
|
1697
|
+
};
|
|
1698
|
+
export declare const PaymentMethodSchema: {
|
|
1699
|
+
readonly type: "object";
|
|
1700
|
+
readonly properties: {
|
|
1701
|
+
readonly id: {
|
|
1702
|
+
readonly type: "string";
|
|
1703
|
+
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.";
|
|
1704
|
+
readonly example: "pm_1MtwBwLkdIwHu7ix28a3tqPa";
|
|
1705
|
+
};
|
|
1706
|
+
readonly type: {
|
|
1707
|
+
readonly type: "string";
|
|
1708
|
+
readonly description: "Payment method type. `card`, `sepa_debit` for SEPA Direct Debit (business accounts only), or `bank_transfer` for paying invoices by bank transfer.";
|
|
1709
|
+
readonly example: "card";
|
|
1710
|
+
readonly enum: readonly ["card", "sepa_debit", "bank_transfer"];
|
|
1711
|
+
};
|
|
1712
|
+
readonly last4: {
|
|
1713
|
+
readonly type: "string";
|
|
1714
|
+
readonly nullable: true;
|
|
1715
|
+
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.";
|
|
1716
|
+
readonly example: "4242";
|
|
1717
|
+
};
|
|
1718
|
+
readonly exp_month: {
|
|
1719
|
+
readonly type: "integer";
|
|
1720
|
+
readonly minimum: 1;
|
|
1721
|
+
readonly maximum: 12;
|
|
1722
|
+
readonly nullable: true;
|
|
1723
|
+
readonly description: "Two-digit number representing the card's expiration month. Null for SEPA Direct Debit and bank transfer.";
|
|
1724
|
+
readonly example: 12;
|
|
1725
|
+
};
|
|
1726
|
+
readonly exp_year: {
|
|
1727
|
+
readonly type: "integer";
|
|
1728
|
+
readonly nullable: true;
|
|
1729
|
+
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.";
|
|
1730
|
+
readonly example: 2028;
|
|
1731
|
+
};
|
|
1732
|
+
readonly brand: {
|
|
1733
|
+
readonly type: "string";
|
|
1734
|
+
readonly nullable: true;
|
|
1735
|
+
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.";
|
|
1736
|
+
readonly example: "visa";
|
|
1737
|
+
};
|
|
1738
|
+
readonly iban: {
|
|
1739
|
+
readonly type: "string";
|
|
1740
|
+
readonly nullable: true;
|
|
1741
|
+
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.";
|
|
1742
|
+
readonly example: "DE11243015658023127510";
|
|
1743
|
+
};
|
|
1744
|
+
readonly bic: {
|
|
1745
|
+
readonly type: "string";
|
|
1746
|
+
readonly nullable: true;
|
|
1747
|
+
readonly description: "BIC/SWIFT of the destination bank for bank transfers. Set only for `bank_transfer`; null otherwise.";
|
|
1748
|
+
readonly example: "SOGEDEFFXXX";
|
|
1749
|
+
};
|
|
1750
|
+
readonly account_holder_name: {
|
|
1751
|
+
readonly type: "string";
|
|
1752
|
+
readonly nullable: true;
|
|
1753
|
+
readonly description: "Account holder name of the destination bank account for bank transfers. Set only for `bank_transfer`; null otherwise.";
|
|
1754
|
+
readonly example: "Cloudfleet GmbH";
|
|
1755
|
+
};
|
|
1756
|
+
readonly is_default: {
|
|
1757
|
+
readonly type: "boolean";
|
|
1758
|
+
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).";
|
|
1759
|
+
readonly example: true;
|
|
1760
|
+
};
|
|
1761
|
+
};
|
|
1762
|
+
readonly required: readonly ["id", "type", "last4", "exp_month", "exp_year", "brand", "iban", "bic", "account_holder_name", "is_default"];
|
|
1763
|
+
readonly additionalProperties: false;
|
|
1764
|
+
};
|
|
1765
|
+
export declare const PlatformQuotaSchema: {
|
|
1766
|
+
readonly type: "object";
|
|
1767
|
+
readonly properties: {
|
|
1768
|
+
readonly basic_clusters_max: {
|
|
1769
|
+
readonly type: "integer";
|
|
1770
|
+
readonly minimum: 0;
|
|
1771
|
+
readonly description: "Maximum number of Basic clusters that can be created.";
|
|
1772
|
+
readonly example: 999;
|
|
1773
|
+
};
|
|
1774
|
+
readonly basic_clusters_available: {
|
|
1775
|
+
readonly type: "integer";
|
|
1776
|
+
readonly description: "Available number of Basic clusters that can be created.";
|
|
1777
|
+
readonly example: 999;
|
|
1778
|
+
};
|
|
1779
|
+
readonly pro_clusters_max: {
|
|
1780
|
+
readonly type: "integer";
|
|
1781
|
+
readonly minimum: 0;
|
|
1782
|
+
readonly description: "Maximum number of Pro clusters that can be created.";
|
|
1783
|
+
readonly example: 999;
|
|
1784
|
+
};
|
|
1785
|
+
readonly pro_clusters_available: {
|
|
1786
|
+
readonly type: "integer";
|
|
1787
|
+
readonly description: "Available number of Pro clusters that can be created.";
|
|
1788
|
+
readonly example: 999;
|
|
1789
|
+
};
|
|
1790
|
+
readonly enterprise_clusters_max: {
|
|
1791
|
+
readonly type: "integer";
|
|
1792
|
+
readonly minimum: 0;
|
|
1793
|
+
readonly description: "Maximum number of Enterprise clusters that can be created.";
|
|
1794
|
+
readonly example: 999;
|
|
1795
|
+
};
|
|
1796
|
+
readonly enterprise_clusters_available: {
|
|
1797
|
+
readonly type: "integer";
|
|
1798
|
+
readonly description: "Available number of Enterprise clusters that can be created.";
|
|
1799
|
+
readonly example: 999;
|
|
1800
|
+
};
|
|
1801
|
+
readonly fleets_max: {
|
|
1802
|
+
readonly type: "integer";
|
|
1803
|
+
readonly minimum: 0;
|
|
1804
|
+
readonly description: "Maximum number of fleets that can be created per cluster.";
|
|
1805
|
+
readonly example: 999;
|
|
1806
|
+
};
|
|
1807
|
+
readonly cluster_tiers: {
|
|
1808
|
+
readonly type: "array";
|
|
1809
|
+
readonly items: {
|
|
1810
|
+
readonly type: "string";
|
|
1811
|
+
readonly example: "basic";
|
|
1812
|
+
};
|
|
1813
|
+
readonly minItems: 0;
|
|
1814
|
+
readonly description: "List of Cloudfleet cluster tiers available for the organization.";
|
|
1815
|
+
};
|
|
1816
|
+
readonly regions: {
|
|
1817
|
+
readonly type: "array";
|
|
1818
|
+
readonly items: {
|
|
1819
|
+
readonly type: "string";
|
|
1820
|
+
readonly example: "northamerica-central-1a";
|
|
1821
|
+
};
|
|
1822
|
+
readonly minItems: 1;
|
|
1823
|
+
readonly description: "List of Cloudfleet control plane regions available for the organization.";
|
|
1824
|
+
};
|
|
1825
|
+
readonly versions: {
|
|
1826
|
+
readonly type: "array";
|
|
1827
|
+
readonly items: {
|
|
1828
|
+
readonly type: "object";
|
|
1829
|
+
readonly properties: {
|
|
1830
|
+
readonly id: {
|
|
1831
|
+
readonly type: "string";
|
|
1832
|
+
readonly description: "Id of the control plane version. Used in API calls.";
|
|
1833
|
+
readonly example: "1.33.x-cfke.x";
|
|
1834
|
+
};
|
|
1835
|
+
readonly label: {
|
|
1836
|
+
readonly type: "string";
|
|
1837
|
+
readonly description: "Label of the control plane version. Used in frontent UI.";
|
|
1838
|
+
readonly example: "1.33.x (Always latest 1.33 patch version)";
|
|
1839
|
+
};
|
|
1840
|
+
};
|
|
1841
|
+
readonly required: readonly ["id", "label"];
|
|
1842
|
+
readonly additionalProperties: false;
|
|
1843
|
+
};
|
|
1844
|
+
readonly minItems: 1;
|
|
1845
|
+
readonly description: "List of CFKE control plane versions available for the organization.";
|
|
1846
|
+
};
|
|
1847
|
+
readonly cfcr_storage_gb: {
|
|
1848
|
+
readonly type: "integer";
|
|
1849
|
+
readonly minimum: -1;
|
|
1850
|
+
readonly description: "Organization-level maximum CFCR storage volume in GB. -1 means no limit.";
|
|
1851
|
+
readonly example: 500;
|
|
1852
|
+
};
|
|
1853
|
+
};
|
|
1854
|
+
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"];
|
|
1855
|
+
readonly additionalProperties: false;
|
|
1856
|
+
};
|
|
1857
|
+
export declare const RegistryRepositorySchema: {
|
|
1858
|
+
readonly type: "object";
|
|
1859
|
+
readonly properties: {
|
|
1860
|
+
readonly name: {
|
|
1861
|
+
readonly type: "string";
|
|
1862
|
+
readonly description: "Repository name.";
|
|
1863
|
+
readonly example: "my-app";
|
|
1864
|
+
};
|
|
1865
|
+
readonly region: {
|
|
1866
|
+
readonly type: "string";
|
|
1867
|
+
readonly description: "Registry region.";
|
|
1868
|
+
readonly example: "northamerica";
|
|
1869
|
+
};
|
|
1870
|
+
readonly uri: {
|
|
1871
|
+
readonly type: "string";
|
|
1872
|
+
readonly description: "Full URI of the repository.";
|
|
1873
|
+
readonly example: "ssds123e-6651-4e5d-9c04-079f6532989b.northamerica.registry.cloudfleet.dev/my-app";
|
|
1874
|
+
};
|
|
1875
|
+
};
|
|
1876
|
+
readonly required: readonly ["name", "region", "uri"];
|
|
1877
|
+
readonly additionalProperties: false;
|
|
1878
|
+
};
|
|
1879
|
+
export declare const RegistryRepositoryWithTagsSchema: {
|
|
1880
|
+
readonly type: "object";
|
|
1881
|
+
readonly properties: {
|
|
1882
|
+
readonly name: {
|
|
1883
|
+
readonly type: "string";
|
|
1884
|
+
readonly description: "Repository name.";
|
|
1885
|
+
readonly example: "my-app";
|
|
1886
|
+
};
|
|
1887
|
+
readonly region: {
|
|
1888
|
+
readonly type: "string";
|
|
1889
|
+
readonly description: "Registry region.";
|
|
1890
|
+
readonly example: "northamerica";
|
|
1891
|
+
};
|
|
1892
|
+
readonly uri: {
|
|
1893
|
+
readonly type: "string";
|
|
1894
|
+
readonly description: "Full URI of the repository.";
|
|
1895
|
+
readonly example: "ssds123e-6651-4e5d-9c04-079f6532989b.northamerica.registry.cloudfleet.dev/my-app";
|
|
1896
|
+
};
|
|
1897
|
+
readonly tags: {
|
|
1898
|
+
readonly type: "array";
|
|
1899
|
+
readonly items: {
|
|
1900
|
+
readonly type: "object";
|
|
1901
|
+
readonly properties: {
|
|
1902
|
+
readonly name: {
|
|
1903
|
+
readonly type: "string";
|
|
1904
|
+
readonly description: "Tag name.";
|
|
1905
|
+
readonly example: "latest";
|
|
1906
|
+
};
|
|
1907
|
+
readonly size: {
|
|
1908
|
+
readonly type: "number";
|
|
1909
|
+
readonly format: "float";
|
|
1910
|
+
readonly description: "Size of the tag in bytes.";
|
|
1911
|
+
readonly example: 123456789;
|
|
1912
|
+
};
|
|
1913
|
+
readonly mediaType: {
|
|
1914
|
+
readonly type: "string";
|
|
1915
|
+
readonly description: "Media type of the manifest.";
|
|
1916
|
+
readonly example: "application/vnd.docker.distribution.manifest.v2+json";
|
|
1917
|
+
};
|
|
1918
|
+
readonly platforms: {
|
|
1919
|
+
readonly type: "array";
|
|
1920
|
+
readonly items: {
|
|
1921
|
+
readonly type: "string";
|
|
1922
|
+
};
|
|
1923
|
+
readonly description: "Array of platform strings for multi-arch images (e.g., linux/amd64, linux/arm64).";
|
|
1924
|
+
readonly example: readonly ["linux/amd64", "linux/arm64"];
|
|
1925
|
+
};
|
|
1926
|
+
};
|
|
1927
|
+
readonly required: readonly ["name", "size"];
|
|
1928
|
+
readonly additionalProperties: false;
|
|
1929
|
+
};
|
|
1930
|
+
readonly description: "Array of tags in the repository.";
|
|
1931
|
+
};
|
|
1932
|
+
readonly totalSize: {
|
|
1933
|
+
readonly type: "number";
|
|
1934
|
+
readonly format: "float";
|
|
1935
|
+
readonly description: "Total size of all tags in the repository in bytes.";
|
|
1936
|
+
readonly example: 987654321;
|
|
1937
|
+
};
|
|
1938
|
+
};
|
|
1939
|
+
readonly required: readonly ["name", "region", "uri", "tags", "totalSize"];
|
|
1940
|
+
readonly additionalProperties: false;
|
|
1941
|
+
};
|
|
1942
|
+
export declare const RegistryTagSchema: {
|
|
1943
|
+
readonly type: "object";
|
|
1944
|
+
readonly properties: {
|
|
1945
|
+
readonly name: {
|
|
1946
|
+
readonly type: "string";
|
|
1947
|
+
readonly description: "Tag name.";
|
|
1948
|
+
readonly example: "latest";
|
|
1949
|
+
};
|
|
1950
|
+
readonly digest: {
|
|
1951
|
+
readonly type: "string";
|
|
1952
|
+
readonly description: "Manifest digest for pulling by digest.";
|
|
1953
|
+
readonly example: "sha256:abcd1234ef567890abcd1234ef567890abcd1234ef567890abcd1234ef567890";
|
|
1954
|
+
};
|
|
1955
|
+
readonly mediaType: {
|
|
1956
|
+
readonly type: "string";
|
|
1957
|
+
readonly description: "Media type of the manifest.";
|
|
1958
|
+
readonly example: "application/vnd.docker.distribution.manifest.v2+json";
|
|
1959
|
+
};
|
|
1960
|
+
readonly config: {
|
|
1961
|
+
readonly type: "object";
|
|
1962
|
+
readonly properties: {
|
|
1963
|
+
readonly size: {
|
|
1964
|
+
readonly type: "number";
|
|
1965
|
+
readonly format: "float";
|
|
1966
|
+
readonly description: "Size of the config in bytes.";
|
|
1967
|
+
readonly example: 1234;
|
|
1968
|
+
};
|
|
1969
|
+
};
|
|
1970
|
+
readonly required: readonly ["size"];
|
|
1971
|
+
readonly additionalProperties: false;
|
|
1972
|
+
readonly description: "Manifest config metadata.";
|
|
1973
|
+
};
|
|
1974
|
+
readonly layers: {
|
|
1975
|
+
readonly type: "array";
|
|
1976
|
+
readonly items: {
|
|
1977
|
+
readonly type: "object";
|
|
1978
|
+
readonly properties: {
|
|
1979
|
+
readonly digest: {
|
|
1980
|
+
readonly type: "string";
|
|
1981
|
+
readonly description: "Digest of the layer.";
|
|
1982
|
+
readonly example: "sha256:abcd1234ef567890abcd1234ef567890abcd1234ef567890abcd1234ef567890";
|
|
1983
|
+
};
|
|
1984
|
+
readonly size: {
|
|
1985
|
+
readonly type: "number";
|
|
1986
|
+
readonly format: "float";
|
|
1987
|
+
readonly description: "Size of the layer in bytes.";
|
|
1988
|
+
readonly example: 5678;
|
|
1989
|
+
};
|
|
1990
|
+
};
|
|
1991
|
+
readonly required: readonly ["size"];
|
|
1992
|
+
readonly additionalProperties: false;
|
|
1993
|
+
};
|
|
1994
|
+
readonly description: "Array of layer metadata.";
|
|
1995
|
+
};
|
|
1996
|
+
readonly manifests: {
|
|
1997
|
+
readonly type: "array";
|
|
1998
|
+
readonly items: {
|
|
1999
|
+
readonly type: "object";
|
|
2000
|
+
readonly properties: {
|
|
2001
|
+
readonly digest: {
|
|
2002
|
+
readonly type: "string";
|
|
2003
|
+
readonly description: "Digest of the manifest.";
|
|
2004
|
+
readonly example: "sha256:abcd1234ef567890abcd1234ef567890abcd1234ef567890abcd1234ef567890";
|
|
2005
|
+
};
|
|
2006
|
+
readonly platform: {
|
|
2007
|
+
readonly type: "object";
|
|
2008
|
+
readonly properties: {
|
|
2009
|
+
readonly architecture: {
|
|
2010
|
+
readonly type: "string";
|
|
2011
|
+
readonly description: "Architecture of the platform.";
|
|
2012
|
+
readonly example: "amd64";
|
|
2013
|
+
};
|
|
2014
|
+
readonly os: {
|
|
2015
|
+
readonly type: "string";
|
|
2016
|
+
readonly description: "Operating system of the platform.";
|
|
2017
|
+
readonly example: "linux";
|
|
2018
|
+
};
|
|
2019
|
+
readonly variant: {
|
|
2020
|
+
readonly type: "string";
|
|
2021
|
+
readonly description: "Variant of the platform (e.g., v7, v8 for ARM).";
|
|
2022
|
+
readonly example: "v8";
|
|
2023
|
+
};
|
|
2024
|
+
};
|
|
2025
|
+
readonly required: readonly ["architecture", "os"];
|
|
2026
|
+
readonly additionalProperties: false;
|
|
2027
|
+
readonly description: "Platform information for the manifest.";
|
|
2028
|
+
};
|
|
2029
|
+
readonly layers: {
|
|
2030
|
+
readonly type: "array";
|
|
2031
|
+
readonly items: {
|
|
2032
|
+
readonly type: "object";
|
|
2033
|
+
readonly properties: {
|
|
2034
|
+
readonly digest: {
|
|
2035
|
+
readonly type: "string";
|
|
2036
|
+
readonly description: "Digest of the layer.";
|
|
2037
|
+
readonly example: "sha256:abcd1234ef567890abcd1234ef567890abcd1234ef567890abcd1234ef567890";
|
|
2038
|
+
};
|
|
2039
|
+
readonly size: {
|
|
2040
|
+
readonly type: "number";
|
|
2041
|
+
readonly format: "float";
|
|
2042
|
+
readonly description: "Size of the layer in bytes.";
|
|
2043
|
+
readonly example: 5678;
|
|
2044
|
+
};
|
|
2045
|
+
};
|
|
2046
|
+
readonly required: readonly ["size"];
|
|
2047
|
+
readonly additionalProperties: false;
|
|
2048
|
+
};
|
|
2049
|
+
readonly description: "Layers for this platform.";
|
|
2050
|
+
};
|
|
2051
|
+
readonly size: {
|
|
2052
|
+
readonly type: "number";
|
|
2053
|
+
readonly format: "float";
|
|
2054
|
+
readonly description: "Total size of this platform manifest in bytes.";
|
|
2055
|
+
readonly example: 12345678;
|
|
2056
|
+
};
|
|
2057
|
+
};
|
|
2058
|
+
readonly required: readonly ["digest"];
|
|
2059
|
+
readonly additionalProperties: false;
|
|
2060
|
+
};
|
|
2061
|
+
readonly description: "Array of manifests for multi-arch images.";
|
|
2062
|
+
};
|
|
2063
|
+
readonly size: {
|
|
2064
|
+
readonly type: "number";
|
|
2065
|
+
readonly format: "float";
|
|
2066
|
+
readonly description: "Total size of the tag in bytes.";
|
|
2067
|
+
readonly example: 123456789;
|
|
2068
|
+
};
|
|
2069
|
+
readonly region: {
|
|
2070
|
+
readonly type: "string";
|
|
2071
|
+
readonly description: "Registry region.";
|
|
2072
|
+
readonly example: "northamerica";
|
|
2073
|
+
};
|
|
2074
|
+
readonly repository: {
|
|
2075
|
+
readonly type: "string";
|
|
2076
|
+
readonly description: "Repository name.";
|
|
2077
|
+
readonly example: "my-app";
|
|
2078
|
+
};
|
|
2079
|
+
readonly uri: {
|
|
2080
|
+
readonly type: "string";
|
|
2081
|
+
readonly description: "Full URI of the tag.";
|
|
2082
|
+
readonly example: "ssds123e-6651-4e5d-9c04-079f6532989b.northamerica.registry.cloudfleet.dev/my-app:latest";
|
|
2083
|
+
};
|
|
2084
|
+
};
|
|
2085
|
+
readonly required: readonly ["name", "digest", "size", "region", "repository", "uri"];
|
|
2086
|
+
readonly additionalProperties: false;
|
|
2087
|
+
};
|
|
2088
|
+
export declare const TicketAttachmentSchema: {
|
|
2089
|
+
readonly type: "object";
|
|
2090
|
+
readonly properties: {
|
|
2091
|
+
readonly id: {
|
|
2092
|
+
readonly type: "string";
|
|
2093
|
+
readonly description: "Unique identifier of the attachment (Mongo ObjectId).";
|
|
2094
|
+
readonly example: "60c72b2f9f1b2c001f8e4d3c";
|
|
2095
|
+
};
|
|
2096
|
+
readonly filename: {
|
|
2097
|
+
readonly type: "string";
|
|
2098
|
+
readonly description: "Original filename as uploaded.";
|
|
2099
|
+
readonly example: "debug.log";
|
|
2100
|
+
};
|
|
2101
|
+
readonly content_type: {
|
|
2102
|
+
readonly type: "string";
|
|
2103
|
+
readonly description: "MIME content type of the attachment.";
|
|
2104
|
+
readonly example: "text/plain";
|
|
2105
|
+
};
|
|
2106
|
+
readonly size: {
|
|
2107
|
+
readonly type: "integer";
|
|
2108
|
+
readonly description: "Size of the attachment in bytes.";
|
|
2109
|
+
readonly example: 12345;
|
|
2110
|
+
};
|
|
2111
|
+
};
|
|
2112
|
+
readonly required: readonly ["id", "filename", "content_type", "size"];
|
|
2113
|
+
readonly additionalProperties: false;
|
|
2114
|
+
};
|
|
2115
|
+
export declare const TicketCreateInputSchema: {
|
|
2116
|
+
readonly type: "object";
|
|
2117
|
+
readonly properties: {
|
|
2118
|
+
readonly category: {
|
|
2119
|
+
readonly type: "string";
|
|
2120
|
+
readonly description: "Ticket category. Drives auto-assignment and may carry a subcategory in `properties`.";
|
|
2121
|
+
readonly example: "technical";
|
|
2122
|
+
readonly enum: readonly ["billing", "technical", "general"];
|
|
2123
|
+
};
|
|
2124
|
+
readonly body: {
|
|
2125
|
+
readonly type: "string";
|
|
2126
|
+
readonly maxLength: 50000;
|
|
2127
|
+
readonly minLength: 1;
|
|
2128
|
+
readonly pattern: "\\S";
|
|
2129
|
+
readonly description: "Initial message body in markdown. There is no separate subject — the first message body is the description.";
|
|
2130
|
+
readonly example: "My cluster cannot reach the registry. Logs attached.";
|
|
2131
|
+
};
|
|
2132
|
+
readonly properties: {
|
|
2133
|
+
readonly type: "object";
|
|
2134
|
+
readonly additionalProperties: true;
|
|
2135
|
+
readonly description: "Free-form key/value bag set by the UI (e.g. `subcategory`, `cluster_id`, `cluster_name`, `region`).";
|
|
2136
|
+
readonly example: {
|
|
2137
|
+
readonly subcategory: "cluster-question";
|
|
2138
|
+
readonly cluster_id: "60c72b2f9f1b2c001f8e4d3a";
|
|
2139
|
+
};
|
|
2140
|
+
};
|
|
2141
|
+
};
|
|
2142
|
+
readonly required: readonly ["category", "body"];
|
|
2143
|
+
readonly additionalProperties: false;
|
|
2144
|
+
};
|
|
2145
|
+
export declare const TicketMessageInputSchema: {
|
|
2146
|
+
readonly type: "object";
|
|
2147
|
+
readonly properties: {
|
|
2148
|
+
readonly body: {
|
|
2149
|
+
readonly type: "string";
|
|
2150
|
+
readonly maxLength: 50000;
|
|
2151
|
+
readonly minLength: 1;
|
|
2152
|
+
readonly pattern: "\\S";
|
|
2153
|
+
readonly description: "Reply body in markdown.";
|
|
2154
|
+
readonly example: "Thanks — that resolved it on my side.";
|
|
2155
|
+
};
|
|
2156
|
+
};
|
|
2157
|
+
readonly required: readonly ["body"];
|
|
2158
|
+
readonly additionalProperties: false;
|
|
2159
|
+
};
|
|
2160
|
+
export declare const TicketMessageSchema: {
|
|
2161
|
+
readonly type: "object";
|
|
2162
|
+
readonly properties: {
|
|
2163
|
+
readonly id: {
|
|
2164
|
+
readonly type: "string";
|
|
2165
|
+
readonly description: "Unique identifier of the message (Mongo ObjectId).";
|
|
2166
|
+
readonly example: "60c72b2f9f1b2c001f8e4d3b";
|
|
2167
|
+
};
|
|
2168
|
+
readonly type: {
|
|
2169
|
+
readonly type: "string";
|
|
2170
|
+
readonly description: "Message type. Internal notes are filtered out of customer-facing responses.";
|
|
2171
|
+
readonly example: "customer_reply";
|
|
2172
|
+
readonly enum: readonly ["customer_reply", "agent_reply"];
|
|
2173
|
+
};
|
|
2174
|
+
readonly body: {
|
|
2175
|
+
readonly type: "string";
|
|
2176
|
+
readonly description: "Message body in markdown.";
|
|
2177
|
+
readonly example: "Thanks — that resolved it on my side.";
|
|
2178
|
+
};
|
|
2179
|
+
readonly author_first_name: {
|
|
1257
2180
|
readonly type: "string";
|
|
1258
|
-
readonly
|
|
1259
|
-
readonly description: "
|
|
1260
|
-
readonly example: "
|
|
2181
|
+
readonly nullable: true;
|
|
2182
|
+
readonly description: "First name of the author. Null when not provided.";
|
|
2183
|
+
readonly example: "Jane";
|
|
1261
2184
|
};
|
|
1262
|
-
readonly
|
|
1263
|
-
readonly type: "
|
|
1264
|
-
readonly
|
|
1265
|
-
|
|
1266
|
-
|
|
1267
|
-
|
|
1268
|
-
|
|
1269
|
-
|
|
1270
|
-
|
|
1271
|
-
readonly
|
|
1272
|
-
|
|
1273
|
-
readonly
|
|
1274
|
-
readonly example: 999;
|
|
1275
|
-
};
|
|
1276
|
-
readonly pro_clusters_max: {
|
|
1277
|
-
readonly type: "integer";
|
|
1278
|
-
readonly minimum: 0;
|
|
1279
|
-
readonly description: "Maximum number of Pro clusters that can be created.";
|
|
1280
|
-
readonly example: 999;
|
|
1281
|
-
};
|
|
1282
|
-
readonly pro_clusters_available: {
|
|
1283
|
-
readonly type: "integer";
|
|
1284
|
-
readonly description: "Available number of Pro clusters that can be created.";
|
|
1285
|
-
readonly example: 999;
|
|
1286
|
-
};
|
|
1287
|
-
readonly fleets_max: {
|
|
1288
|
-
readonly type: "integer";
|
|
1289
|
-
readonly minimum: 0;
|
|
1290
|
-
readonly description: "Maximum number of fleets that can be created per cluster.";
|
|
1291
|
-
readonly example: 999;
|
|
1292
|
-
};
|
|
1293
|
-
readonly managed_fleets_cpu_max: {
|
|
1294
|
-
readonly type: "integer";
|
|
1295
|
-
readonly minimum: 0;
|
|
1296
|
-
readonly description: "Maximum number of CPU cores per managed fleet.";
|
|
1297
|
-
readonly example: 999;
|
|
1298
|
-
};
|
|
1299
|
-
readonly cluster_tiers: {
|
|
1300
|
-
readonly type: "array";
|
|
1301
|
-
readonly items: {
|
|
2185
|
+
readonly author_last_name: {
|
|
2186
|
+
readonly type: "string";
|
|
2187
|
+
readonly nullable: true;
|
|
2188
|
+
readonly description: "Last name of the author. Null when not provided.";
|
|
2189
|
+
readonly example: "Doe";
|
|
2190
|
+
};
|
|
2191
|
+
readonly attachments: {
|
|
2192
|
+
readonly type: "array";
|
|
2193
|
+
readonly items: {
|
|
2194
|
+
readonly type: "object";
|
|
2195
|
+
readonly properties: {
|
|
2196
|
+
readonly id: {
|
|
1302
2197
|
readonly type: "string";
|
|
1303
|
-
readonly
|
|
2198
|
+
readonly description: "Unique identifier of the attachment (Mongo ObjectId).";
|
|
2199
|
+
readonly example: "60c72b2f9f1b2c001f8e4d3c";
|
|
1304
2200
|
};
|
|
1305
|
-
readonly
|
|
1306
|
-
readonly description: "List of Cloudfleet cluster tiers available for the organization.";
|
|
1307
|
-
};
|
|
1308
|
-
readonly regions: {
|
|
1309
|
-
readonly type: "array";
|
|
1310
|
-
readonly items: {
|
|
2201
|
+
readonly filename: {
|
|
1311
2202
|
readonly type: "string";
|
|
1312
|
-
readonly
|
|
2203
|
+
readonly description: "Original filename as uploaded.";
|
|
2204
|
+
readonly example: "debug.log";
|
|
1313
2205
|
};
|
|
1314
|
-
readonly
|
|
1315
|
-
|
|
1316
|
-
|
|
1317
|
-
|
|
1318
|
-
|
|
1319
|
-
readonly
|
|
1320
|
-
readonly type: "
|
|
1321
|
-
readonly
|
|
1322
|
-
|
|
1323
|
-
readonly type: "string";
|
|
1324
|
-
readonly description: "Id of the control plane version. Used in API calls.";
|
|
1325
|
-
readonly example: "1.29.x-cfke.x";
|
|
1326
|
-
};
|
|
1327
|
-
readonly label: {
|
|
1328
|
-
readonly type: "string";
|
|
1329
|
-
readonly description: "Label of the control plane version. Used in frontent UI.";
|
|
1330
|
-
readonly example: "1.29.x (Always latest 1.29 patch version)";
|
|
1331
|
-
};
|
|
1332
|
-
};
|
|
1333
|
-
readonly required: readonly ["id", "label"];
|
|
1334
|
-
readonly additionalProperties: false;
|
|
2206
|
+
readonly content_type: {
|
|
2207
|
+
readonly type: "string";
|
|
2208
|
+
readonly description: "MIME content type of the attachment.";
|
|
2209
|
+
readonly example: "text/plain";
|
|
2210
|
+
};
|
|
2211
|
+
readonly size: {
|
|
2212
|
+
readonly type: "integer";
|
|
2213
|
+
readonly description: "Size of the attachment in bytes.";
|
|
2214
|
+
readonly example: 12345;
|
|
1335
2215
|
};
|
|
1336
|
-
readonly minItems: 1;
|
|
1337
|
-
readonly description: "List of CFKE control plane versions available for the organization.";
|
|
1338
2216
|
};
|
|
2217
|
+
readonly required: readonly ["id", "filename", "content_type", "size"];
|
|
2218
|
+
readonly additionalProperties: false;
|
|
1339
2219
|
};
|
|
1340
|
-
readonly
|
|
1341
|
-
readonly
|
|
1342
|
-
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.";
|
|
2220
|
+
readonly description: "Attachments associated with this message.";
|
|
2221
|
+
readonly example: readonly [];
|
|
1343
2222
|
};
|
|
1344
|
-
readonly
|
|
2223
|
+
readonly date_created: {
|
|
1345
2224
|
readonly type: "string";
|
|
1346
|
-
readonly
|
|
1347
|
-
readonly
|
|
2225
|
+
readonly format: "date-time";
|
|
2226
|
+
readonly description: "Creation date of the message. ISO 8601 UTC.";
|
|
2227
|
+
readonly example: "2026-05-11T16:08:14.338Z";
|
|
1348
2228
|
};
|
|
1349
2229
|
};
|
|
1350
|
-
readonly required: readonly ["id", "
|
|
2230
|
+
readonly required: readonly ["id", "type", "body", "date_created"];
|
|
1351
2231
|
readonly additionalProperties: false;
|
|
1352
2232
|
};
|
|
1353
|
-
export declare const
|
|
2233
|
+
export declare const TicketSchema: {
|
|
1354
2234
|
readonly type: "object";
|
|
1355
2235
|
readonly properties: {
|
|
1356
2236
|
readonly id: {
|
|
1357
2237
|
readonly type: "string";
|
|
1358
|
-
readonly
|
|
1359
|
-
readonly
|
|
1360
|
-
readonly example: "e94d30ec-a2dd-4dcb-832c-ac2be144ba91";
|
|
2238
|
+
readonly description: "Unique identifier of the ticket (Mongo ObjectId).";
|
|
2239
|
+
readonly example: "60c72b2f9f1b2c001f8e4d3a";
|
|
1361
2240
|
};
|
|
1362
|
-
readonly
|
|
1363
|
-
readonly type: "
|
|
1364
|
-
readonly description: "
|
|
1365
|
-
readonly example:
|
|
2241
|
+
readonly status: {
|
|
2242
|
+
readonly type: "string";
|
|
2243
|
+
readonly description: "Current state of the ticket.";
|
|
2244
|
+
readonly example: "waiting_on_us";
|
|
2245
|
+
readonly enum: readonly ["waiting_on_us", "waiting_on_user", "closed"];
|
|
1366
2246
|
};
|
|
1367
|
-
readonly
|
|
2247
|
+
readonly category: {
|
|
1368
2248
|
readonly type: "string";
|
|
1369
|
-
readonly
|
|
1370
|
-
readonly
|
|
1371
|
-
readonly
|
|
1372
|
-
readonly enum: readonly ["card"];
|
|
2249
|
+
readonly description: "Ticket category.";
|
|
2250
|
+
readonly example: "technical";
|
|
2251
|
+
readonly enum: readonly ["billing", "technical", "general"];
|
|
1373
2252
|
};
|
|
1374
|
-
readonly
|
|
2253
|
+
readonly summary: {
|
|
1375
2254
|
readonly type: "string";
|
|
1376
|
-
readonly
|
|
1377
|
-
readonly
|
|
1378
|
-
readonly example: "4242";
|
|
2255
|
+
readonly description: "First 128 characters of the initial message body, with markdown formatting and newlines stripped. Used for ticket list previews.";
|
|
2256
|
+
readonly example: "My cluster cannot reach the registry. Logs attached.";
|
|
1379
2257
|
};
|
|
1380
|
-
readonly
|
|
1381
|
-
readonly type: "
|
|
1382
|
-
readonly
|
|
1383
|
-
readonly maximum: 12;
|
|
2258
|
+
readonly closed_at: {
|
|
2259
|
+
readonly type: "string";
|
|
2260
|
+
readonly format: "date-time";
|
|
1384
2261
|
readonly nullable: true;
|
|
1385
|
-
readonly description: "
|
|
1386
|
-
readonly example: "
|
|
2262
|
+
readonly description: "Closure timestamp. Null while the ticket is open.";
|
|
2263
|
+
readonly example: "2026-05-18T16:08:14.338Z";
|
|
1387
2264
|
};
|
|
1388
|
-
readonly
|
|
1389
|
-
readonly type: "
|
|
1390
|
-
readonly
|
|
1391
|
-
readonly
|
|
1392
|
-
readonly
|
|
1393
|
-
readonly example: "2028";
|
|
2265
|
+
readonly date_created: {
|
|
2266
|
+
readonly type: "string";
|
|
2267
|
+
readonly format: "date-time";
|
|
2268
|
+
readonly description: "Creation date of the ticket. ISO 8601 UTC.";
|
|
2269
|
+
readonly example: "2026-05-11T16:08:14.338Z";
|
|
1394
2270
|
};
|
|
1395
|
-
readonly
|
|
2271
|
+
readonly date_updated: {
|
|
1396
2272
|
readonly type: "string";
|
|
1397
|
-
readonly
|
|
1398
|
-
readonly description: "
|
|
1399
|
-
readonly example: "
|
|
1400
|
-
|
|
2273
|
+
readonly format: "date-time";
|
|
2274
|
+
readonly description: "Last update date of the ticket. ISO 8601 UTC.";
|
|
2275
|
+
readonly example: "2026-05-11T16:08:14.338Z";
|
|
2276
|
+
};
|
|
2277
|
+
readonly messages: {
|
|
2278
|
+
readonly type: "array";
|
|
2279
|
+
readonly items: {
|
|
2280
|
+
readonly type: "object";
|
|
2281
|
+
readonly properties: {
|
|
2282
|
+
readonly id: {
|
|
2283
|
+
readonly type: "string";
|
|
2284
|
+
readonly description: "Unique identifier of the message (Mongo ObjectId).";
|
|
2285
|
+
readonly example: "60c72b2f9f1b2c001f8e4d3b";
|
|
2286
|
+
};
|
|
2287
|
+
readonly type: {
|
|
2288
|
+
readonly type: "string";
|
|
2289
|
+
readonly description: "Message type. Internal notes are filtered out of customer-facing responses.";
|
|
2290
|
+
readonly example: "customer_reply";
|
|
2291
|
+
readonly enum: readonly ["customer_reply", "agent_reply"];
|
|
2292
|
+
};
|
|
2293
|
+
readonly body: {
|
|
2294
|
+
readonly type: "string";
|
|
2295
|
+
readonly description: "Message body in markdown.";
|
|
2296
|
+
readonly example: "Thanks — that resolved it on my side.";
|
|
2297
|
+
};
|
|
2298
|
+
readonly author_first_name: {
|
|
2299
|
+
readonly type: "string";
|
|
2300
|
+
readonly description: "First name of the author. Null when not provided.";
|
|
2301
|
+
readonly example: "Jane";
|
|
2302
|
+
};
|
|
2303
|
+
readonly author_last_name: {
|
|
2304
|
+
readonly type: "string";
|
|
2305
|
+
readonly description: "Last name of the author. Null when not provided.";
|
|
2306
|
+
readonly example: "Doe";
|
|
2307
|
+
};
|
|
2308
|
+
readonly attachments: {
|
|
2309
|
+
readonly type: "array";
|
|
2310
|
+
readonly items: {
|
|
2311
|
+
readonly type: "object";
|
|
2312
|
+
readonly properties: {
|
|
2313
|
+
readonly id: {
|
|
2314
|
+
readonly type: "string";
|
|
2315
|
+
readonly description: "Unique identifier of the attachment (Mongo ObjectId).";
|
|
2316
|
+
readonly example: "60c72b2f9f1b2c001f8e4d3c";
|
|
2317
|
+
};
|
|
2318
|
+
readonly filename: {
|
|
2319
|
+
readonly type: "string";
|
|
2320
|
+
readonly description: "Original filename as uploaded.";
|
|
2321
|
+
readonly example: "debug.log";
|
|
2322
|
+
};
|
|
2323
|
+
readonly content_type: {
|
|
2324
|
+
readonly type: "string";
|
|
2325
|
+
readonly description: "MIME content type of the attachment.";
|
|
2326
|
+
readonly example: "text/plain";
|
|
2327
|
+
};
|
|
2328
|
+
readonly size: {
|
|
2329
|
+
readonly type: "integer";
|
|
2330
|
+
readonly description: "Size of the attachment in bytes.";
|
|
2331
|
+
readonly example: 12345;
|
|
2332
|
+
};
|
|
2333
|
+
};
|
|
2334
|
+
readonly required: readonly ["id", "filename", "content_type", "size"];
|
|
2335
|
+
readonly additionalProperties: false;
|
|
2336
|
+
};
|
|
2337
|
+
readonly description: "Attachments associated with this message.";
|
|
2338
|
+
readonly example: readonly [];
|
|
2339
|
+
};
|
|
2340
|
+
readonly date_created: {
|
|
2341
|
+
readonly type: "string";
|
|
2342
|
+
readonly format: "date-time";
|
|
2343
|
+
readonly description: "Creation date of the message. ISO 8601 UTC.";
|
|
2344
|
+
readonly example: "2026-05-11T16:08:14.338Z";
|
|
2345
|
+
};
|
|
2346
|
+
};
|
|
2347
|
+
readonly required: readonly ["id", "type", "body", "date_created"];
|
|
2348
|
+
readonly additionalProperties: false;
|
|
2349
|
+
};
|
|
2350
|
+
readonly description: "Messages on the ticket in chronological order. Internal notes are excluded. Returned by the detail endpoint only.";
|
|
1401
2351
|
};
|
|
1402
2352
|
};
|
|
1403
|
-
readonly required: readonly ["id", "
|
|
2353
|
+
readonly required: readonly ["id", "status", "category", "summary", "date_created", "date_updated"];
|
|
1404
2354
|
readonly additionalProperties: false;
|
|
1405
2355
|
};
|
|
1406
2356
|
export declare const TokenCreateInputSchema: {
|
|
@@ -1481,6 +2431,104 @@ export declare const TokenUpdateInputSchema: {
|
|
|
1481
2431
|
};
|
|
1482
2432
|
readonly additionalProperties: false;
|
|
1483
2433
|
};
|
|
2434
|
+
export declare const UsageFacetsSchema: {
|
|
2435
|
+
readonly type: "object";
|
|
2436
|
+
readonly properties: {
|
|
2437
|
+
readonly cluster_id: {
|
|
2438
|
+
readonly type: "array";
|
|
2439
|
+
readonly items: {
|
|
2440
|
+
readonly type: "string";
|
|
2441
|
+
};
|
|
2442
|
+
readonly description: "List of unique cluster IDs";
|
|
2443
|
+
readonly example: readonly ["6b5439b1-923a-4f2b-a371-d554e5ea23fa"];
|
|
2444
|
+
};
|
|
2445
|
+
readonly product: {
|
|
2446
|
+
readonly type: "array";
|
|
2447
|
+
readonly items: {
|
|
2448
|
+
readonly type: "string";
|
|
2449
|
+
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"];
|
|
2450
|
+
};
|
|
2451
|
+
readonly description: "List of unique products";
|
|
2452
|
+
readonly example: readonly ["cfke_controlplane_pro", "cfke_connected_nodes_pro"];
|
|
2453
|
+
};
|
|
2454
|
+
};
|
|
2455
|
+
readonly additionalProperties: false;
|
|
2456
|
+
};
|
|
2457
|
+
export declare const UsageResponseSchema: {
|
|
2458
|
+
readonly type: "object";
|
|
2459
|
+
readonly properties: {
|
|
2460
|
+
readonly data: {
|
|
2461
|
+
readonly type: "array";
|
|
2462
|
+
readonly items: {
|
|
2463
|
+
readonly type: "object";
|
|
2464
|
+
readonly properties: {
|
|
2465
|
+
readonly hour: {
|
|
2466
|
+
readonly type: "string";
|
|
2467
|
+
readonly description: "Hour of the usage";
|
|
2468
|
+
readonly example: "2019-01-01T00:00:00.000Z";
|
|
2469
|
+
};
|
|
2470
|
+
readonly cluster_id: {
|
|
2471
|
+
readonly type: "string";
|
|
2472
|
+
readonly description: "Unique identifier of the kubernetes cluster. UUID v4 string in canonical form";
|
|
2473
|
+
readonly example: "6b5439b1-923a-4f2b-a371-d554e5ea23fa";
|
|
2474
|
+
};
|
|
2475
|
+
readonly product: {
|
|
2476
|
+
readonly type: "string";
|
|
2477
|
+
readonly description: "The product the usage is associated with";
|
|
2478
|
+
readonly example: "cfke_controlplane_pro";
|
|
2479
|
+
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"];
|
|
2480
|
+
};
|
|
2481
|
+
readonly value: {
|
|
2482
|
+
readonly type: "number";
|
|
2483
|
+
readonly format: "float";
|
|
2484
|
+
readonly description: "Consumption";
|
|
2485
|
+
readonly example: 4;
|
|
2486
|
+
};
|
|
2487
|
+
readonly price: {
|
|
2488
|
+
readonly type: "number";
|
|
2489
|
+
readonly format: "float";
|
|
2490
|
+
readonly description: "Price per unit";
|
|
2491
|
+
readonly example: 0.01;
|
|
2492
|
+
};
|
|
2493
|
+
readonly total: {
|
|
2494
|
+
readonly type: "number";
|
|
2495
|
+
readonly format: "float";
|
|
2496
|
+
readonly description: "Total cost";
|
|
2497
|
+
};
|
|
2498
|
+
};
|
|
2499
|
+
readonly required: readonly ["hour", "cluster_id", "product", "value", "price", "total"];
|
|
2500
|
+
readonly additionalProperties: false;
|
|
2501
|
+
};
|
|
2502
|
+
readonly description: "Usage data";
|
|
2503
|
+
};
|
|
2504
|
+
readonly facets: {
|
|
2505
|
+
readonly type: "object";
|
|
2506
|
+
readonly properties: {
|
|
2507
|
+
readonly cluster_id: {
|
|
2508
|
+
readonly type: "array";
|
|
2509
|
+
readonly items: {
|
|
2510
|
+
readonly type: "string";
|
|
2511
|
+
};
|
|
2512
|
+
readonly description: "List of unique cluster IDs";
|
|
2513
|
+
readonly example: readonly ["6b5439b1-923a-4f2b-a371-d554e5ea23fa"];
|
|
2514
|
+
};
|
|
2515
|
+
readonly product: {
|
|
2516
|
+
readonly type: "array";
|
|
2517
|
+
readonly items: {
|
|
2518
|
+
readonly type: "string";
|
|
2519
|
+
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"];
|
|
2520
|
+
};
|
|
2521
|
+
readonly description: "List of unique products";
|
|
2522
|
+
readonly example: readonly ["cfke_controlplane_pro", "cfke_connected_nodes_pro"];
|
|
2523
|
+
};
|
|
2524
|
+
};
|
|
2525
|
+
readonly additionalProperties: false;
|
|
2526
|
+
readonly description: "Facets for filtering";
|
|
2527
|
+
};
|
|
2528
|
+
};
|
|
2529
|
+
readonly required: readonly ["data", "facets"];
|
|
2530
|
+
readonly additionalProperties: false;
|
|
2531
|
+
};
|
|
1484
2532
|
export declare const UsageSchema: {
|
|
1485
2533
|
readonly type: "object";
|
|
1486
2534
|
readonly properties: {
|
|
@@ -1491,78 +2539,34 @@ export declare const UsageSchema: {
|
|
|
1491
2539
|
};
|
|
1492
2540
|
readonly cluster_id: {
|
|
1493
2541
|
readonly type: "string";
|
|
1494
|
-
readonly format: "uuid";
|
|
1495
2542
|
readonly description: "Unique identifier of the kubernetes cluster. UUID v4 string in canonical form";
|
|
1496
2543
|
readonly example: "6b5439b1-923a-4f2b-a371-d554e5ea23fa";
|
|
1497
2544
|
};
|
|
1498
|
-
readonly cluster_tier: {
|
|
1499
|
-
readonly type: "string";
|
|
1500
|
-
readonly description: "Tier of the cluster.";
|
|
1501
|
-
readonly example: "pro";
|
|
1502
|
-
readonly enum: readonly ["basic", "pro", ""];
|
|
1503
|
-
};
|
|
1504
2545
|
readonly product: {
|
|
1505
2546
|
readonly type: "string";
|
|
1506
2547
|
readonly description: "The product the usage is associated with";
|
|
1507
|
-
readonly example: "
|
|
1508
|
-
readonly enum: readonly ["
|
|
1509
|
-
};
|
|
1510
|
-
readonly node_name: {
|
|
1511
|
-
readonly type: "string";
|
|
1512
|
-
readonly description: "Name of the Kubernetes node";
|
|
1513
|
-
readonly example: "flexible-moth-956037384";
|
|
1514
|
-
};
|
|
1515
|
-
readonly sku: {
|
|
1516
|
-
readonly type: "string";
|
|
1517
|
-
readonly description: "SKU of the Kubernetes node";
|
|
1518
|
-
readonly example: "GCP-NORTHAMERICA-NORTHEAST1-A-G1-SMALL-SPOT";
|
|
2548
|
+
readonly example: "cfke_controlplane_pro";
|
|
2549
|
+
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"];
|
|
1519
2550
|
};
|
|
1520
|
-
readonly
|
|
1521
|
-
readonly
|
|
1522
|
-
|
|
1523
|
-
|
|
1524
|
-
|
|
1525
|
-
readonly example: 4;
|
|
1526
|
-
}, {
|
|
1527
|
-
readonly type: "string";
|
|
1528
|
-
readonly enum: readonly [""];
|
|
1529
|
-
}];
|
|
2551
|
+
readonly value: {
|
|
2552
|
+
readonly type: "number";
|
|
2553
|
+
readonly format: "float";
|
|
2554
|
+
readonly description: "Consumption";
|
|
2555
|
+
readonly example: 4;
|
|
1530
2556
|
};
|
|
1531
2557
|
readonly price: {
|
|
1532
|
-
readonly
|
|
1533
|
-
|
|
1534
|
-
|
|
1535
|
-
|
|
1536
|
-
readonly example: 4;
|
|
1537
|
-
}, {
|
|
1538
|
-
readonly type: "string";
|
|
1539
|
-
readonly enum: readonly [""];
|
|
1540
|
-
}];
|
|
1541
|
-
};
|
|
1542
|
-
readonly value: {
|
|
1543
|
-
readonly anyOf: readonly [{
|
|
1544
|
-
readonly type: "number";
|
|
1545
|
-
readonly format: "float";
|
|
1546
|
-
readonly description: "Value";
|
|
1547
|
-
readonly example: 4;
|
|
1548
|
-
}, {
|
|
1549
|
-
readonly type: "string";
|
|
1550
|
-
readonly enum: readonly [""];
|
|
1551
|
-
}];
|
|
2558
|
+
readonly type: "number";
|
|
2559
|
+
readonly format: "float";
|
|
2560
|
+
readonly description: "Price per unit";
|
|
2561
|
+
readonly example: 0.01;
|
|
1552
2562
|
};
|
|
1553
2563
|
readonly total: {
|
|
1554
|
-
readonly
|
|
1555
|
-
|
|
1556
|
-
|
|
1557
|
-
readonly description: "Total";
|
|
1558
|
-
readonly example: 4;
|
|
1559
|
-
}, {
|
|
1560
|
-
readonly type: "string";
|
|
1561
|
-
readonly enum: readonly [""];
|
|
1562
|
-
}];
|
|
2564
|
+
readonly type: "number";
|
|
2565
|
+
readonly format: "float";
|
|
2566
|
+
readonly description: "Total cost";
|
|
1563
2567
|
};
|
|
1564
2568
|
};
|
|
1565
|
-
readonly required: readonly ["
|
|
2569
|
+
readonly required: readonly ["hour", "cluster_id", "product", "value", "price", "total"];
|
|
1566
2570
|
readonly additionalProperties: false;
|
|
1567
2571
|
};
|
|
1568
2572
|
export declare const UserCreateInputSchema: {
|
|
@@ -1599,18 +2603,6 @@ export declare const UserCreateInputSchema: {
|
|
|
1599
2603
|
readonly minLength: 8;
|
|
1600
2604
|
readonly description: "User password. Must be at least 8 characters long.";
|
|
1601
2605
|
};
|
|
1602
|
-
readonly status: {
|
|
1603
|
-
readonly type: "string";
|
|
1604
|
-
readonly description: "Status of the user. Can be `active` or `inactive`. Inactive users cannot log in or manage organization resources.";
|
|
1605
|
-
readonly example: "active";
|
|
1606
|
-
readonly enum: readonly ["active", "inactive"];
|
|
1607
|
-
};
|
|
1608
|
-
readonly role: {
|
|
1609
|
-
readonly type: "string";
|
|
1610
|
-
readonly description: "User role. Can be 'Administrator', 'User'.";
|
|
1611
|
-
readonly example: "User";
|
|
1612
|
-
readonly enum: readonly ["Administrator", "User"];
|
|
1613
|
-
};
|
|
1614
2606
|
};
|
|
1615
2607
|
readonly required: readonly ["email", "first_name", "last_name", "code", "password"];
|
|
1616
2608
|
readonly additionalProperties: false;
|