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