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