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