@cloudfleet/sdk 0.0.1-d4c7bbc → 0.0.1-d5822b9
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +26 -2
- package/dist/@tanstack/react-query.gen.d.ts +1159 -0
- package/dist/@tanstack/react-query.gen.d.ts.map +1 -0
- package/dist/@tanstack/react-query.gen.js +1175 -0
- package/dist/@tanstack/react-query.gen.js.map +1 -0
- package/dist/client/client.gen.d.ts.map +1 -1
- package/dist/client/client.gen.js +104 -123
- package/dist/client/client.gen.js.map +1 -1
- package/dist/client/types.gen.d.ts +6 -3
- package/dist/client/types.gen.d.ts.map +1 -1
- package/dist/client/utils.gen.d.ts +7 -3
- package/dist/client/utils.gen.d.ts.map +1 -1
- package/dist/client/utils.gen.js +3 -3
- package/dist/client/utils.gen.js.map +1 -1
- package/dist/core/params.gen.js +4 -4
- package/dist/core/params.gen.js.map +1 -1
- package/dist/core/serverSentEvents.gen.d.ts +1 -1
- package/dist/core/serverSentEvents.gen.d.ts.map +1 -1
- package/dist/core/serverSentEvents.gen.js +3 -4
- package/dist/core/serverSentEvents.gen.js.map +1 -1
- package/dist/schemas.gen.d.ts +1020 -136
- package/dist/schemas.gen.d.ts.map +1 -1
- package/dist/schemas.gen.js +1937 -205
- package/dist/schemas.gen.js.map +1 -1
- package/dist/sdk.gen.d.ts +250 -190
- package/dist/sdk.gen.d.ts.map +1 -1
- package/dist/sdk.gen.js +358 -265
- package/dist/sdk.gen.js.map +1 -1
- package/dist/services/kubernetes/api.d.ts +8 -8
- package/dist/types.gen.d.ts +1527 -766
- package/dist/types.gen.d.ts.map +1 -1
- package/dist/zod.gen.d.ts +3353 -1204
- package/dist/zod.gen.d.ts.map +1 -1
- package/dist/zod.gen.js +1255 -289
- package/dist/zod.gen.js.map +1 -1
- package/package.json +27 -11
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;
|
|
@@ -76,7 +82,7 @@ export declare const BillingContactSchema: {
|
|
|
76
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", ""];
|
|
77
83
|
};
|
|
78
84
|
};
|
|
79
|
-
readonly required: readonly ["email", "individual_name"];
|
|
85
|
+
readonly required: readonly ["type", "email", "individual_name"];
|
|
80
86
|
readonly additionalProperties: false;
|
|
81
87
|
};
|
|
82
88
|
export declare const BillingCreditsSchema: {
|
|
@@ -211,9 +217,8 @@ export declare const ChartSchema: {
|
|
|
211
217
|
};
|
|
212
218
|
readonly status: {
|
|
213
219
|
readonly type: "string";
|
|
214
|
-
readonly description: "Status of the chart deployment.";
|
|
215
|
-
readonly example: "
|
|
216
|
-
readonly enum: readonly ["InstallSucceeded", "InstallFailed", "UpgradeSucceeded", "UpgradeFailed", "TestSucceeded", "TestFailed", "RollbackSucceeded", "RollbackFailed", "UninstallSucceeded", "UninstallFailed", "ArtifactFailed", "DependencyNotReady", "Progressing", "SourceNotReady"];
|
|
220
|
+
readonly description: "Status of the chart deployment (Flux HelmRelease Ready condition reason, e.g. InstallSucceeded, UpgradeFailed, Progressing).";
|
|
221
|
+
readonly example: "InstallSucceeded";
|
|
217
222
|
};
|
|
218
223
|
readonly version_current: {
|
|
219
224
|
readonly type: "string";
|
|
@@ -270,15 +275,9 @@ export declare const ClusterCreateInputSchema: {
|
|
|
270
275
|
readonly tier: {
|
|
271
276
|
readonly type: "string";
|
|
272
277
|
readonly description: "Tier of the cluster.";
|
|
278
|
+
readonly default: "basic";
|
|
273
279
|
readonly example: "pro";
|
|
274
|
-
readonly enum: readonly ["basic", "pro"];
|
|
275
|
-
};
|
|
276
|
-
readonly region: {
|
|
277
|
-
readonly type: "string";
|
|
278
|
-
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.";
|
|
279
|
-
readonly default: "staging-1a";
|
|
280
|
-
readonly example: "northamerica-central-1a";
|
|
281
|
-
readonly enum: readonly ["staging-1a", "northamerica-central-1", "europe-central-1a", "northamerica-central-1a"];
|
|
280
|
+
readonly enum: readonly ["basic", "pro", "enterprise"];
|
|
282
281
|
};
|
|
283
282
|
readonly version_channel: {
|
|
284
283
|
readonly type: "string";
|
|
@@ -286,11 +285,93 @@ export declare const ClusterCreateInputSchema: {
|
|
|
286
285
|
readonly description: "Version of the kubernetes cluster.";
|
|
287
286
|
readonly default: "1.x.x-cfke.x";
|
|
288
287
|
readonly example: "1.x.x-cfke.x";
|
|
289
|
-
|
|
288
|
+
};
|
|
289
|
+
readonly release_channel: {
|
|
290
|
+
readonly type: "string";
|
|
291
|
+
readonly description: "Release channel for the cluster's control plane.";
|
|
292
|
+
readonly default: "rapid";
|
|
293
|
+
readonly example: "rapid";
|
|
294
|
+
readonly enum: readonly ["rapid", "stable", "extended"];
|
|
295
|
+
};
|
|
296
|
+
readonly features: {
|
|
297
|
+
readonly type: "object";
|
|
298
|
+
readonly properties: {
|
|
299
|
+
readonly gpu_sharing_strategy: {
|
|
300
|
+
readonly type: "string";
|
|
301
|
+
readonly description: "GPU sharing strategy.";
|
|
302
|
+
readonly default: "none";
|
|
303
|
+
readonly example: "none";
|
|
304
|
+
readonly enum: readonly ["none", "mps", "time_slicing"];
|
|
305
|
+
};
|
|
306
|
+
readonly gpu_max_shared_clients_per_gpu: {
|
|
307
|
+
readonly type: "integer";
|
|
308
|
+
readonly minimum: 2;
|
|
309
|
+
readonly maximum: 48;
|
|
310
|
+
readonly description: "Maximum number of pods that may share a single GPU.";
|
|
311
|
+
readonly default: 4;
|
|
312
|
+
readonly example: 10;
|
|
313
|
+
};
|
|
314
|
+
readonly cilium_socket_lb_host_namespace_only: {
|
|
315
|
+
readonly type: "boolean";
|
|
316
|
+
readonly description: "Restrict Cilium socket load-balancing to the host namespace. Required for the Tailscale operator and Istio.";
|
|
317
|
+
readonly example: false;
|
|
318
|
+
};
|
|
319
|
+
};
|
|
320
|
+
readonly additionalProperties: false;
|
|
321
|
+
readonly description: "Cluster feature toggles.";
|
|
322
|
+
readonly default: {
|
|
323
|
+
readonly gpu_sharing_strategy: "none";
|
|
324
|
+
readonly gpu_max_shared_clients_per_gpu: 4;
|
|
325
|
+
readonly cilium_socket_lb_host_namespace_only: false;
|
|
326
|
+
};
|
|
327
|
+
};
|
|
328
|
+
readonly region: {
|
|
329
|
+
readonly type: "string";
|
|
330
|
+
readonly description: "Cloudfleet control plane region. This field can not be updated after creation.";
|
|
331
|
+
readonly example: "europe-central-1a";
|
|
332
|
+
};
|
|
333
|
+
readonly networking: {
|
|
334
|
+
readonly type: "object";
|
|
335
|
+
readonly properties: {
|
|
336
|
+
readonly pod_cidr: {
|
|
337
|
+
readonly type: "string";
|
|
338
|
+
readonly description: "CIDR block for pod IPs.";
|
|
339
|
+
readonly default: "10.244.0.0/16";
|
|
340
|
+
};
|
|
341
|
+
readonly service_cidr: {
|
|
342
|
+
readonly type: "string";
|
|
343
|
+
readonly description: "CIDR block for service IPs.";
|
|
344
|
+
readonly default: "10.96.0.0/12";
|
|
345
|
+
};
|
|
346
|
+
readonly dual_stack: {
|
|
347
|
+
readonly type: "boolean";
|
|
348
|
+
readonly description: "Enable IPv4+IPv6 dual-stack networking.";
|
|
349
|
+
};
|
|
350
|
+
readonly pod_cidr_v6: {
|
|
351
|
+
readonly type: "string";
|
|
352
|
+
readonly description: "IPv6 pod CIDR. Requires dual_stack.";
|
|
353
|
+
readonly default: "2001:db8:1:2::/48";
|
|
354
|
+
};
|
|
355
|
+
readonly service_cidr_v6: {
|
|
356
|
+
readonly type: "string";
|
|
357
|
+
readonly description: "IPv6 service CIDR. Requires dual_stack.";
|
|
358
|
+
readonly default: "2001:db8:1:1::/112";
|
|
359
|
+
};
|
|
360
|
+
};
|
|
361
|
+
readonly additionalProperties: false;
|
|
362
|
+
readonly description: "Cluster networking configuration. Immutable after creation.";
|
|
363
|
+
readonly default: {
|
|
364
|
+
readonly pod_cidr: "10.244.0.0/16";
|
|
365
|
+
readonly service_cidr: "10.96.0.0/12";
|
|
366
|
+
readonly dual_stack: false;
|
|
367
|
+
readonly pod_cidr_v6: "2001:db8:1:2::/48";
|
|
368
|
+
readonly service_cidr_v6: "2001:db8:1:1::/112";
|
|
369
|
+
};
|
|
290
370
|
};
|
|
291
371
|
};
|
|
292
|
-
readonly required: readonly ["name", "
|
|
372
|
+
readonly required: readonly ["name", "region"];
|
|
293
373
|
readonly additionalProperties: false;
|
|
374
|
+
readonly description: "Mutable cluster configuration. Applied as a full overwrite: any omitted field is reset to its default rather than left unchanged.";
|
|
294
375
|
};
|
|
295
376
|
export declare const ClusterJoinInformationSchema: {
|
|
296
377
|
readonly type: "object";
|
|
@@ -311,6 +392,11 @@ export declare const ClusterJoinInformationSchema: {
|
|
|
311
392
|
readonly description: "Cluster DNS IP address. This is the IP address of the kube-dns service in the cluster.";
|
|
312
393
|
readonly example: "10.96.0.10";
|
|
313
394
|
};
|
|
395
|
+
readonly pod_cidr: {
|
|
396
|
+
readonly type: "string";
|
|
397
|
+
readonly description: "Pod CIDR for the cluster. Used to configure iptables rules on nodes to prevent Tailscale routing loops.";
|
|
398
|
+
readonly example: "10.244.0.0/16";
|
|
399
|
+
};
|
|
314
400
|
readonly auth_key: {
|
|
315
401
|
readonly type: "string";
|
|
316
402
|
readonly description: "Authentication key for the cluster.";
|
|
@@ -373,7 +459,7 @@ export declare const ClusterJoinInformationSchema: {
|
|
|
373
459
|
readonly description: "OIDC Information for hosts to access to third party API's.";
|
|
374
460
|
};
|
|
375
461
|
};
|
|
376
|
-
readonly required: readonly ["certificate_authority", "endpoint", "cluster_dns", "auth_key", "bootstrap_token", "versions", "third_party_api_access_config"];
|
|
462
|
+
readonly required: readonly ["certificate_authority", "endpoint", "cluster_dns", "pod_cidr", "auth_key", "bootstrap_token", "versions", "third_party_api_access_config"];
|
|
377
463
|
readonly additionalProperties: false;
|
|
378
464
|
};
|
|
379
465
|
export declare const ClusterSchema: {
|
|
@@ -390,15 +476,100 @@ export declare const ClusterSchema: {
|
|
|
390
476
|
readonly tier: {
|
|
391
477
|
readonly type: "string";
|
|
392
478
|
readonly description: "Tier of the cluster.";
|
|
479
|
+
readonly default: "basic";
|
|
393
480
|
readonly example: "pro";
|
|
394
|
-
readonly enum: readonly ["basic", "pro"];
|
|
481
|
+
readonly enum: readonly ["basic", "pro", "enterprise"];
|
|
482
|
+
};
|
|
483
|
+
readonly version_channel: {
|
|
484
|
+
readonly type: "string";
|
|
485
|
+
readonly pattern: "^(x|X|0|[1-9]\\d*)\\.(x|X|0|[1-9]\\d*)\\.(x|X|0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?$";
|
|
486
|
+
readonly description: "Version of the kubernetes cluster.";
|
|
487
|
+
readonly default: "1.x.x-cfke.x";
|
|
488
|
+
readonly example: "1.x.x-cfke.x";
|
|
489
|
+
};
|
|
490
|
+
readonly release_channel: {
|
|
491
|
+
readonly type: "string";
|
|
492
|
+
readonly description: "Release channel for the cluster's control plane.";
|
|
493
|
+
readonly default: "rapid";
|
|
494
|
+
readonly example: "rapid";
|
|
495
|
+
readonly enum: readonly ["rapid", "stable", "extended"];
|
|
496
|
+
};
|
|
497
|
+
readonly features: {
|
|
498
|
+
readonly type: "object";
|
|
499
|
+
readonly properties: {
|
|
500
|
+
readonly gpu_sharing_strategy: {
|
|
501
|
+
readonly type: "string";
|
|
502
|
+
readonly description: "GPU sharing strategy.";
|
|
503
|
+
readonly default: "none";
|
|
504
|
+
readonly example: "none";
|
|
505
|
+
readonly enum: readonly ["none", "mps", "time_slicing"];
|
|
506
|
+
};
|
|
507
|
+
readonly gpu_max_shared_clients_per_gpu: {
|
|
508
|
+
readonly type: "integer";
|
|
509
|
+
readonly minimum: 2;
|
|
510
|
+
readonly maximum: 48;
|
|
511
|
+
readonly description: "Maximum number of pods that may share a single GPU.";
|
|
512
|
+
readonly default: 4;
|
|
513
|
+
readonly example: 10;
|
|
514
|
+
};
|
|
515
|
+
readonly cilium_socket_lb_host_namespace_only: {
|
|
516
|
+
readonly type: "boolean";
|
|
517
|
+
readonly description: "Restrict Cilium socket load-balancing to the host namespace. Required for the Tailscale operator and Istio.";
|
|
518
|
+
readonly example: false;
|
|
519
|
+
};
|
|
520
|
+
};
|
|
521
|
+
readonly required: readonly ["gpu_sharing_strategy", "gpu_max_shared_clients_per_gpu", "cilium_socket_lb_host_namespace_only"];
|
|
522
|
+
readonly additionalProperties: false;
|
|
523
|
+
readonly description: "Cluster feature toggles.";
|
|
524
|
+
readonly default: {
|
|
525
|
+
readonly gpu_sharing_strategy: "none";
|
|
526
|
+
readonly gpu_max_shared_clients_per_gpu: 4;
|
|
527
|
+
readonly cilium_socket_lb_host_namespace_only: false;
|
|
528
|
+
};
|
|
395
529
|
};
|
|
396
530
|
readonly region: {
|
|
397
531
|
readonly type: "string";
|
|
398
|
-
readonly description: "Cloudfleet control plane region.
|
|
399
|
-
readonly
|
|
400
|
-
|
|
401
|
-
|
|
532
|
+
readonly description: "Cloudfleet control plane region. This field can not be updated after creation.";
|
|
533
|
+
readonly example: "europe-central-1a";
|
|
534
|
+
};
|
|
535
|
+
readonly networking: {
|
|
536
|
+
readonly type: "object";
|
|
537
|
+
readonly properties: {
|
|
538
|
+
readonly pod_cidr: {
|
|
539
|
+
readonly type: "string";
|
|
540
|
+
readonly description: "CIDR block for pod IPs.";
|
|
541
|
+
readonly default: "10.244.0.0/16";
|
|
542
|
+
};
|
|
543
|
+
readonly service_cidr: {
|
|
544
|
+
readonly type: "string";
|
|
545
|
+
readonly description: "CIDR block for service IPs.";
|
|
546
|
+
readonly default: "10.96.0.0/12";
|
|
547
|
+
};
|
|
548
|
+
readonly dual_stack: {
|
|
549
|
+
readonly type: "boolean";
|
|
550
|
+
readonly description: "Enable IPv4+IPv6 dual-stack networking.";
|
|
551
|
+
};
|
|
552
|
+
readonly pod_cidr_v6: {
|
|
553
|
+
readonly type: "string";
|
|
554
|
+
readonly description: "IPv6 pod CIDR. Requires dual_stack.";
|
|
555
|
+
readonly default: "2001:db8:1:2::/48";
|
|
556
|
+
};
|
|
557
|
+
readonly service_cidr_v6: {
|
|
558
|
+
readonly type: "string";
|
|
559
|
+
readonly description: "IPv6 service CIDR. Requires dual_stack.";
|
|
560
|
+
readonly default: "2001:db8:1:1::/112";
|
|
561
|
+
};
|
|
562
|
+
};
|
|
563
|
+
readonly required: readonly ["pod_cidr", "service_cidr", "dual_stack", "pod_cidr_v6", "service_cidr_v6"];
|
|
564
|
+
readonly additionalProperties: false;
|
|
565
|
+
readonly description: "Cluster networking configuration. Immutable after creation.";
|
|
566
|
+
readonly default: {
|
|
567
|
+
readonly pod_cidr: "10.244.0.0/16";
|
|
568
|
+
readonly service_cidr: "10.96.0.0/12";
|
|
569
|
+
readonly dual_stack: false;
|
|
570
|
+
readonly pod_cidr_v6: "2001:db8:1:2::/48";
|
|
571
|
+
readonly service_cidr_v6: "2001:db8:1:1::/112";
|
|
572
|
+
};
|
|
402
573
|
};
|
|
403
574
|
readonly id: {
|
|
404
575
|
readonly type: "string";
|
|
@@ -408,16 +579,27 @@ export declare const ClusterSchema: {
|
|
|
408
579
|
};
|
|
409
580
|
readonly status: {
|
|
410
581
|
readonly type: "string";
|
|
411
|
-
readonly description: "Status of the cluster.
|
|
412
|
-
readonly example: "
|
|
413
|
-
readonly enum: readonly ["
|
|
582
|
+
readonly description: "Status of the cluster.";
|
|
583
|
+
readonly example: "deployed";
|
|
584
|
+
readonly enum: readonly ["creating", "deployed", "updating", "disabled"];
|
|
414
585
|
};
|
|
415
586
|
readonly endpoint: {
|
|
416
587
|
readonly anyOf: readonly [{
|
|
417
588
|
readonly type: "string";
|
|
418
589
|
readonly format: "uri";
|
|
419
|
-
readonly description: "URL of the Kubernetes cluster control plane. This is the endpoint that kubectl uses to connect to the cluster.";
|
|
420
|
-
readonly example: "https://2ae6557c-c61f-49c6-b4c1-a65473470a03.staging.cfke.
|
|
590
|
+
readonly description: "URL signed by a public CA of the Kubernetes cluster control plane. This is the endpoint that kubectl uses to connect to the cluster.";
|
|
591
|
+
readonly example: "https://2ae6557c-c61f-49c6-b4c1-a65473470a03.staging.cfke.io";
|
|
592
|
+
}, {
|
|
593
|
+
readonly type: "string";
|
|
594
|
+
readonly enum: readonly [""];
|
|
595
|
+
}];
|
|
596
|
+
};
|
|
597
|
+
readonly endpoint_public: {
|
|
598
|
+
readonly anyOf: readonly [{
|
|
599
|
+
readonly type: "string";
|
|
600
|
+
readonly format: "uri";
|
|
601
|
+
readonly description: "Deprecated alias of `endpoint`; retained for backward compatibility.";
|
|
602
|
+
readonly example: "https://2ae6557c-c61f-49c6-b4c1-a65473470a03.staging.cfke.io";
|
|
421
603
|
}, {
|
|
422
604
|
readonly type: "string";
|
|
423
605
|
readonly enum: readonly [""];
|
|
@@ -448,15 +630,10 @@ export declare const ClusterSchema: {
|
|
|
448
630
|
readonly description: "Indicates if the cluster is ready to be used.";
|
|
449
631
|
readonly example: true;
|
|
450
632
|
};
|
|
451
|
-
readonly version_channel: {
|
|
452
|
-
readonly type: "string";
|
|
453
|
-
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-]+)*))?$";
|
|
454
|
-
readonly description: "Version of the kubernetes cluster.";
|
|
455
|
-
readonly example: "1.x.x-cfke.x";
|
|
456
|
-
};
|
|
457
633
|
};
|
|
458
|
-
readonly required: readonly ["name", "tier", "id", "status"];
|
|
634
|
+
readonly required: readonly ["name", "tier", "version_channel", "release_channel", "features", "region", "networking", "id", "status", "ready"];
|
|
459
635
|
readonly additionalProperties: false;
|
|
636
|
+
readonly description: "Mutable cluster configuration. Applied as a full overwrite: any omitted field is reset to its default rather than left unchanged.";
|
|
460
637
|
};
|
|
461
638
|
export declare const ClusterUpdateInputSchema: {
|
|
462
639
|
readonly type: "object";
|
|
@@ -472,18 +649,60 @@ export declare const ClusterUpdateInputSchema: {
|
|
|
472
649
|
readonly tier: {
|
|
473
650
|
readonly type: "string";
|
|
474
651
|
readonly description: "Tier of the cluster.";
|
|
652
|
+
readonly default: "basic";
|
|
475
653
|
readonly example: "pro";
|
|
476
|
-
readonly enum: readonly ["basic", "pro"];
|
|
654
|
+
readonly enum: readonly ["basic", "pro", "enterprise"];
|
|
477
655
|
};
|
|
478
656
|
readonly version_channel: {
|
|
479
657
|
readonly type: "string";
|
|
480
658
|
readonly pattern: "^(x|X|0|[1-9]\\d*)\\.(x|X|0|[1-9]\\d*)\\.(x|X|0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?$";
|
|
481
659
|
readonly description: "Version of the kubernetes cluster.";
|
|
660
|
+
readonly default: "1.x.x-cfke.x";
|
|
482
661
|
readonly example: "1.x.x-cfke.x";
|
|
483
662
|
};
|
|
663
|
+
readonly release_channel: {
|
|
664
|
+
readonly type: "string";
|
|
665
|
+
readonly description: "Release channel for the cluster's control plane.";
|
|
666
|
+
readonly default: "rapid";
|
|
667
|
+
readonly example: "rapid";
|
|
668
|
+
readonly enum: readonly ["rapid", "stable", "extended"];
|
|
669
|
+
};
|
|
670
|
+
readonly features: {
|
|
671
|
+
readonly type: "object";
|
|
672
|
+
readonly properties: {
|
|
673
|
+
readonly gpu_sharing_strategy: {
|
|
674
|
+
readonly type: "string";
|
|
675
|
+
readonly description: "GPU sharing strategy.";
|
|
676
|
+
readonly default: "none";
|
|
677
|
+
readonly example: "none";
|
|
678
|
+
readonly enum: readonly ["none", "mps", "time_slicing"];
|
|
679
|
+
};
|
|
680
|
+
readonly gpu_max_shared_clients_per_gpu: {
|
|
681
|
+
readonly type: "integer";
|
|
682
|
+
readonly minimum: 2;
|
|
683
|
+
readonly maximum: 48;
|
|
684
|
+
readonly description: "Maximum number of pods that may share a single GPU.";
|
|
685
|
+
readonly default: 4;
|
|
686
|
+
readonly example: 10;
|
|
687
|
+
};
|
|
688
|
+
readonly cilium_socket_lb_host_namespace_only: {
|
|
689
|
+
readonly type: "boolean";
|
|
690
|
+
readonly description: "Restrict Cilium socket load-balancing to the host namespace. Required for the Tailscale operator and Istio.";
|
|
691
|
+
readonly example: false;
|
|
692
|
+
};
|
|
693
|
+
};
|
|
694
|
+
readonly additionalProperties: false;
|
|
695
|
+
readonly description: "Cluster feature toggles.";
|
|
696
|
+
readonly default: {
|
|
697
|
+
readonly gpu_sharing_strategy: "none";
|
|
698
|
+
readonly gpu_max_shared_clients_per_gpu: 4;
|
|
699
|
+
readonly cilium_socket_lb_host_namespace_only: false;
|
|
700
|
+
};
|
|
701
|
+
};
|
|
484
702
|
};
|
|
485
|
-
readonly required: readonly ["
|
|
703
|
+
readonly required: readonly ["name"];
|
|
486
704
|
readonly additionalProperties: false;
|
|
705
|
+
readonly description: "Mutable cluster configuration. Applied as a full overwrite: any omitted field is reset to its default rather than left unchanged.";
|
|
487
706
|
};
|
|
488
707
|
export declare const FleetCreateInputSchema: {
|
|
489
708
|
readonly type: "object";
|
|
@@ -492,13 +711,12 @@ export declare const FleetCreateInputSchema: {
|
|
|
492
711
|
readonly type: "object";
|
|
493
712
|
readonly properties: {
|
|
494
713
|
readonly cpu: {
|
|
495
|
-
readonly type: "
|
|
496
|
-
readonly format: "float";
|
|
714
|
+
readonly type: "integer";
|
|
497
715
|
readonly minimum: 0;
|
|
498
|
-
readonly
|
|
716
|
+
readonly maximum: 100000;
|
|
717
|
+
readonly description: "CPU limit in cores. Maximum 100,000.";
|
|
499
718
|
};
|
|
500
719
|
};
|
|
501
|
-
readonly required: readonly ["cpu"];
|
|
502
720
|
readonly additionalProperties: false;
|
|
503
721
|
readonly description: "Limits define a set of bounds for provisioning capacity.";
|
|
504
722
|
};
|
|
@@ -507,14 +725,15 @@ export declare const FleetCreateInputSchema: {
|
|
|
507
725
|
readonly properties: {
|
|
508
726
|
readonly enabled: {
|
|
509
727
|
readonly type: "boolean";
|
|
510
|
-
readonly default: true;
|
|
511
728
|
};
|
|
512
729
|
readonly project: {
|
|
513
730
|
readonly type: "string";
|
|
514
|
-
readonly
|
|
731
|
+
readonly pattern: "^[a-z][a-z0-9-]{4,28}[a-z0-9]$";
|
|
732
|
+
readonly description: "GCP project ID to deploy instances into. 6-30 chars, lowercase letters/digits/hyphens, must start with a letter and not end with a hyphen. Omit when GCP is disabled.";
|
|
733
|
+
readonly example: "my-cloudfleet-project";
|
|
515
734
|
};
|
|
516
735
|
};
|
|
517
|
-
readonly required: readonly ["
|
|
736
|
+
readonly required: readonly ["enabled"];
|
|
518
737
|
readonly additionalProperties: false;
|
|
519
738
|
};
|
|
520
739
|
readonly hetzner: {
|
|
@@ -522,14 +741,16 @@ export declare const FleetCreateInputSchema: {
|
|
|
522
741
|
readonly properties: {
|
|
523
742
|
readonly enabled: {
|
|
524
743
|
readonly type: "boolean";
|
|
525
|
-
readonly default: true;
|
|
526
744
|
};
|
|
527
745
|
readonly apiKey: {
|
|
528
746
|
readonly type: "string";
|
|
529
|
-
readonly
|
|
747
|
+
readonly maxLength: 64;
|
|
748
|
+
readonly minLength: 64;
|
|
749
|
+
readonly pattern: "^([A-Za-z0-9]{64}|\\*{64})$";
|
|
750
|
+
readonly description: "Hetzner Cloud API token with read/write access (64 alphanumeric characters). Write-only: reads return a redacted placeholder, never the token. Omit the field, or send the placeholder back unchanged, to keep the existing key. Send a new value to rotate it.";
|
|
530
751
|
};
|
|
531
752
|
};
|
|
532
|
-
readonly required: readonly ["
|
|
753
|
+
readonly required: readonly ["enabled"];
|
|
533
754
|
readonly additionalProperties: false;
|
|
534
755
|
};
|
|
535
756
|
readonly aws: {
|
|
@@ -537,15 +758,74 @@ export declare const FleetCreateInputSchema: {
|
|
|
537
758
|
readonly properties: {
|
|
538
759
|
readonly enabled: {
|
|
539
760
|
readonly type: "boolean";
|
|
540
|
-
readonly default: true;
|
|
541
761
|
};
|
|
542
762
|
readonly controllerRoleArn: {
|
|
543
763
|
readonly type: "string";
|
|
544
|
-
readonly
|
|
764
|
+
readonly pattern: "^arn:aws(-[a-z]+)*:iam::\\d{12}:role\\/[\\w+=,.@/-]+$";
|
|
765
|
+
readonly description: "AWS IAM role ARN that Karpenter uses to manage resources. Omit when AWS is disabled.";
|
|
766
|
+
readonly example: "arn:aws:iam::123456789012:role/Cloudfleet";
|
|
767
|
+
};
|
|
768
|
+
};
|
|
769
|
+
readonly required: readonly ["enabled"];
|
|
770
|
+
readonly additionalProperties: false;
|
|
771
|
+
};
|
|
772
|
+
readonly constraints: {
|
|
773
|
+
readonly type: "object";
|
|
774
|
+
readonly properties: {
|
|
775
|
+
readonly 'karpenter.sh/capacity-type': {
|
|
776
|
+
readonly type: "array";
|
|
777
|
+
readonly items: {
|
|
778
|
+
readonly type: "string";
|
|
779
|
+
readonly enum: readonly ["on-demand", "spot"];
|
|
780
|
+
};
|
|
781
|
+
readonly minItems: 1;
|
|
782
|
+
readonly description: "Allowed values for `karpenter.sh/capacity-type`.";
|
|
783
|
+
readonly default: readonly ["on-demand", "spot"];
|
|
784
|
+
};
|
|
785
|
+
readonly 'kubernetes.io/arch': {
|
|
786
|
+
readonly type: "array";
|
|
787
|
+
readonly items: {
|
|
788
|
+
readonly type: "string";
|
|
789
|
+
readonly enum: readonly ["amd64", "arm64"];
|
|
790
|
+
};
|
|
791
|
+
readonly minItems: 1;
|
|
792
|
+
readonly description: "Allowed values for `kubernetes.io/arch`.";
|
|
793
|
+
readonly default: readonly ["amd64"];
|
|
794
|
+
};
|
|
795
|
+
readonly 'cfke.io/instance-family': {
|
|
796
|
+
readonly type: "array";
|
|
797
|
+
readonly items: {
|
|
798
|
+
readonly type: "string";
|
|
799
|
+
readonly enum: readonly ["a1", "a2", "a3", "a4", "c1", "c2", "c2d", "c3", "c3d", "c4", "c4a", "c4d", "c5", "c5a", "c5ad", "c5d", "c5n", "c6a", "c6g", "c6gd", "c6gn", "c6i", "c6id", "c6in", "c7a", "c7g", "c7gd", "c7gn", "c7i", "c7i-flex", "c8g", "c8gd", "cax", "ccx", "cpx", "cx", "d2", "d3", "d3en", "dl1", "dl2q", "e2", "f1", "f2", "g1", "g2", "g4ad", "g4dn", "g5", "g5g", "g6", "g6e", "gr6", "h1", "h3", "hpc6a", "hpc6id", "hpc7a", "hpc7g", "i2", "i3", "i3en", "i4g", "i4i", "i7i", "i7ie", "i8g", "im4gn", "inf1", "inf2", "is4gen", "m1", "m2", "m3", "m4", "m5", "m5a", "m5ad", "m5d", "m5dn", "m5n", "m5zn", "m6a", "m6g", "m6gd", "m6i", "m6id", "m6idn", "m6in", "m7a", "m7g", "m7gd", "m7i", "m7i-flex", "m8g", "m8gd", "n1", "n2", "n2d", "n4", "p3", "p3dn", "p4d", "p4de", "p5", "p5e", "p5en", "p6-b200", "r3", "r4", "r5", "r5a", "r5ad", "r5b", "r5d", "r5dn", "r5n", "r6a", "r6g", "r6gd", "r6i", "r6id", "r6idn", "r6in", "r7a", "r7g", "r7gd", "r7i", "r7iz", "r8g", "r8gd", "t2", "t2a", "t2d", "t3", "t3a", "t4g", "trn1", "trn1n", "u-3tb1", "u-6tb1", "u7i-12tb", "u7i-6tb", "u7i-8tb", "u7in-16tb", "u7in-24tb", "u7in-32tb", "vt1", "x1", "x1e", "x2gd", "x2idn", "x2iedn", "x2iezn", "x4", "x8g", "z1d", "z3"];
|
|
800
|
+
};
|
|
801
|
+
readonly description: "Allowed values for `cfke.io/instance-family`.";
|
|
802
|
+
readonly default: readonly [];
|
|
803
|
+
};
|
|
804
|
+
readonly 'topology.kubernetes.io/region': {
|
|
805
|
+
readonly type: "array";
|
|
806
|
+
readonly items: {
|
|
807
|
+
readonly type: "string";
|
|
808
|
+
readonly enum: readonly ["africa-south1", "ap-northeast-1", "ap-northeast-2", "ap-northeast-3", "ap-south-1", "ap-southeast-1", "ap-southeast-2", "ash", "asia-east1", "asia-east2", "asia-northeast1", "asia-northeast2", "asia-northeast3", "asia-south1", "asia-south2", "asia-southeast1", "asia-southeast2", "australia-southeast1", "australia-southeast2", "ca-central-1", "eu-central-1", "eu-central-2", "eu-north-1", "eu-west-1", "eu-west-2", "eu-west-3", "europe-central2", "europe-north1", "europe-southwest1", "europe-west1", "europe-west10", "europe-west12", "europe-west2", "europe-west3", "europe-west4", "europe-west6", "europe-west8", "europe-west9", "fsn1", "hel1", "hil", "me-central1", "me-central2", "me-west1", "nbg1", "northamerica-northeast1", "northamerica-northeast2", "sa-east-1", "sin", "southamerica-east1", "southamerica-west1", "us-central1", "us-east-1", "us-east-2", "us-east1", "us-east4", "us-east5", "us-south1", "us-west-1", "us-west-2", "us-west1", "us-west2", "us-west3", "us-west4"];
|
|
809
|
+
};
|
|
810
|
+
readonly description: "Allowed values for `topology.kubernetes.io/region`.";
|
|
811
|
+
readonly default: readonly [];
|
|
545
812
|
};
|
|
546
813
|
};
|
|
547
|
-
readonly required: readonly ["controllerRoleArn"];
|
|
548
814
|
readonly additionalProperties: false;
|
|
815
|
+
readonly description: "Constraints define scheduling and provisioning requirements for the fleet. Each field restricts the values allowed for a given Kubernetes label key. Multiple constraints are ANDed together.";
|
|
816
|
+
readonly default: {
|
|
817
|
+
readonly 'karpenter.sh/capacity-type': readonly ["on-demand", "spot"];
|
|
818
|
+
readonly 'kubernetes.io/arch': readonly ["amd64"];
|
|
819
|
+
readonly 'cfke.io/instance-family': readonly [];
|
|
820
|
+
readonly 'topology.kubernetes.io/region': readonly [];
|
|
821
|
+
};
|
|
822
|
+
};
|
|
823
|
+
readonly scalingProfile: {
|
|
824
|
+
readonly type: "string";
|
|
825
|
+
readonly description: "Controls scale-up / scale-down responsiveness. `aggressive` prioritizes cost-optimization. `conservative` prioritizes stability of the fleet. Full-overwrite: omit to reset to the default (`conservative`).";
|
|
826
|
+
readonly default: "conservative";
|
|
827
|
+
readonly example: "conservative";
|
|
828
|
+
readonly enum: readonly ["aggressive", "conservative"];
|
|
549
829
|
};
|
|
550
830
|
readonly id: {
|
|
551
831
|
readonly type: "string";
|
|
@@ -558,6 +838,7 @@ export declare const FleetCreateInputSchema: {
|
|
|
558
838
|
};
|
|
559
839
|
readonly required: readonly ["id"];
|
|
560
840
|
readonly additionalProperties: false;
|
|
841
|
+
readonly description: "Mutable fleet configuration. Applied as a full overwrite: any omitted field is reset to its default rather than left unchanged.";
|
|
561
842
|
};
|
|
562
843
|
export declare const FleetSchema: {
|
|
563
844
|
readonly type: "object";
|
|
@@ -566,13 +847,12 @@ export declare const FleetSchema: {
|
|
|
566
847
|
readonly type: "object";
|
|
567
848
|
readonly properties: {
|
|
568
849
|
readonly cpu: {
|
|
569
|
-
readonly type: "
|
|
570
|
-
readonly format: "float";
|
|
850
|
+
readonly type: "integer";
|
|
571
851
|
readonly minimum: 0;
|
|
572
|
-
readonly
|
|
852
|
+
readonly maximum: 100000;
|
|
853
|
+
readonly description: "CPU limit in cores. Maximum 100,000.";
|
|
573
854
|
};
|
|
574
855
|
};
|
|
575
|
-
readonly required: readonly ["cpu"];
|
|
576
856
|
readonly additionalProperties: false;
|
|
577
857
|
readonly description: "Limits define a set of bounds for provisioning capacity.";
|
|
578
858
|
};
|
|
@@ -581,14 +861,15 @@ export declare const FleetSchema: {
|
|
|
581
861
|
readonly properties: {
|
|
582
862
|
readonly enabled: {
|
|
583
863
|
readonly type: "boolean";
|
|
584
|
-
readonly default: true;
|
|
585
864
|
};
|
|
586
865
|
readonly project: {
|
|
587
866
|
readonly type: "string";
|
|
588
|
-
readonly
|
|
867
|
+
readonly pattern: "^[a-z][a-z0-9-]{4,28}[a-z0-9]$";
|
|
868
|
+
readonly description: "GCP project ID to deploy instances into. 6-30 chars, lowercase letters/digits/hyphens, must start with a letter and not end with a hyphen. Omit when GCP is disabled.";
|
|
869
|
+
readonly example: "my-cloudfleet-project";
|
|
589
870
|
};
|
|
590
871
|
};
|
|
591
|
-
readonly required: readonly ["
|
|
872
|
+
readonly required: readonly ["enabled"];
|
|
592
873
|
readonly additionalProperties: false;
|
|
593
874
|
};
|
|
594
875
|
readonly hetzner: {
|
|
@@ -596,14 +877,14 @@ export declare const FleetSchema: {
|
|
|
596
877
|
readonly properties: {
|
|
597
878
|
readonly enabled: {
|
|
598
879
|
readonly type: "boolean";
|
|
599
|
-
readonly default: true;
|
|
600
880
|
};
|
|
601
881
|
readonly apiKey: {
|
|
602
882
|
readonly type: "string";
|
|
603
|
-
readonly
|
|
883
|
+
readonly pattern: "^\\*{64}$";
|
|
884
|
+
readonly description: "Redacted Hetzner API token. Returned as 64 asterisks when a token is configured; omitted otherwise. The real value is never echoed by the API.";
|
|
604
885
|
};
|
|
605
886
|
};
|
|
606
|
-
readonly required: readonly ["
|
|
887
|
+
readonly required: readonly ["enabled"];
|
|
607
888
|
readonly additionalProperties: false;
|
|
608
889
|
};
|
|
609
890
|
readonly aws: {
|
|
@@ -611,16 +892,76 @@ export declare const FleetSchema: {
|
|
|
611
892
|
readonly properties: {
|
|
612
893
|
readonly enabled: {
|
|
613
894
|
readonly type: "boolean";
|
|
614
|
-
readonly default: true;
|
|
615
895
|
};
|
|
616
896
|
readonly controllerRoleArn: {
|
|
617
897
|
readonly type: "string";
|
|
618
|
-
readonly
|
|
898
|
+
readonly pattern: "^arn:aws(-[a-z]+)*:iam::\\d{12}:role\\/[\\w+=,.@/-]+$";
|
|
899
|
+
readonly description: "AWS IAM role ARN that Karpenter uses to manage resources. Omit when AWS is disabled.";
|
|
900
|
+
readonly example: "arn:aws:iam::123456789012:role/Cloudfleet";
|
|
619
901
|
};
|
|
620
902
|
};
|
|
621
|
-
readonly required: readonly ["
|
|
903
|
+
readonly required: readonly ["enabled"];
|
|
622
904
|
readonly additionalProperties: false;
|
|
623
905
|
};
|
|
906
|
+
readonly constraints: {
|
|
907
|
+
readonly type: "object";
|
|
908
|
+
readonly properties: {
|
|
909
|
+
readonly 'karpenter.sh/capacity-type': {
|
|
910
|
+
readonly type: "array";
|
|
911
|
+
readonly items: {
|
|
912
|
+
readonly type: "string";
|
|
913
|
+
readonly enum: readonly ["on-demand", "spot"];
|
|
914
|
+
};
|
|
915
|
+
readonly minItems: 1;
|
|
916
|
+
readonly description: "Allowed values for `karpenter.sh/capacity-type`.";
|
|
917
|
+
readonly default: readonly ["on-demand", "spot"];
|
|
918
|
+
};
|
|
919
|
+
readonly 'kubernetes.io/arch': {
|
|
920
|
+
readonly type: "array";
|
|
921
|
+
readonly items: {
|
|
922
|
+
readonly type: "string";
|
|
923
|
+
readonly enum: readonly ["amd64", "arm64"];
|
|
924
|
+
};
|
|
925
|
+
readonly minItems: 1;
|
|
926
|
+
readonly description: "Allowed values for `kubernetes.io/arch`.";
|
|
927
|
+
readonly default: readonly ["amd64"];
|
|
928
|
+
};
|
|
929
|
+
readonly 'cfke.io/instance-family': {
|
|
930
|
+
readonly type: "array";
|
|
931
|
+
readonly items: {
|
|
932
|
+
readonly type: "string";
|
|
933
|
+
readonly enum: readonly ["a1", "a2", "a3", "a4", "c1", "c2", "c2d", "c3", "c3d", "c4", "c4a", "c4d", "c5", "c5a", "c5ad", "c5d", "c5n", "c6a", "c6g", "c6gd", "c6gn", "c6i", "c6id", "c6in", "c7a", "c7g", "c7gd", "c7gn", "c7i", "c7i-flex", "c8g", "c8gd", "cax", "ccx", "cpx", "cx", "d2", "d3", "d3en", "dl1", "dl2q", "e2", "f1", "f2", "g1", "g2", "g4ad", "g4dn", "g5", "g5g", "g6", "g6e", "gr6", "h1", "h3", "hpc6a", "hpc6id", "hpc7a", "hpc7g", "i2", "i3", "i3en", "i4g", "i4i", "i7i", "i7ie", "i8g", "im4gn", "inf1", "inf2", "is4gen", "m1", "m2", "m3", "m4", "m5", "m5a", "m5ad", "m5d", "m5dn", "m5n", "m5zn", "m6a", "m6g", "m6gd", "m6i", "m6id", "m6idn", "m6in", "m7a", "m7g", "m7gd", "m7i", "m7i-flex", "m8g", "m8gd", "n1", "n2", "n2d", "n4", "p3", "p3dn", "p4d", "p4de", "p5", "p5e", "p5en", "p6-b200", "r3", "r4", "r5", "r5a", "r5ad", "r5b", "r5d", "r5dn", "r5n", "r6a", "r6g", "r6gd", "r6i", "r6id", "r6idn", "r6in", "r7a", "r7g", "r7gd", "r7i", "r7iz", "r8g", "r8gd", "t2", "t2a", "t2d", "t3", "t3a", "t4g", "trn1", "trn1n", "u-3tb1", "u-6tb1", "u7i-12tb", "u7i-6tb", "u7i-8tb", "u7in-16tb", "u7in-24tb", "u7in-32tb", "vt1", "x1", "x1e", "x2gd", "x2idn", "x2iedn", "x2iezn", "x4", "x8g", "z1d", "z3"];
|
|
934
|
+
};
|
|
935
|
+
readonly description: "Allowed values for `cfke.io/instance-family`.";
|
|
936
|
+
readonly default: readonly [];
|
|
937
|
+
};
|
|
938
|
+
readonly 'topology.kubernetes.io/region': {
|
|
939
|
+
readonly type: "array";
|
|
940
|
+
readonly items: {
|
|
941
|
+
readonly type: "string";
|
|
942
|
+
readonly enum: readonly ["africa-south1", "ap-northeast-1", "ap-northeast-2", "ap-northeast-3", "ap-south-1", "ap-southeast-1", "ap-southeast-2", "ash", "asia-east1", "asia-east2", "asia-northeast1", "asia-northeast2", "asia-northeast3", "asia-south1", "asia-south2", "asia-southeast1", "asia-southeast2", "australia-southeast1", "australia-southeast2", "ca-central-1", "eu-central-1", "eu-central-2", "eu-north-1", "eu-west-1", "eu-west-2", "eu-west-3", "europe-central2", "europe-north1", "europe-southwest1", "europe-west1", "europe-west10", "europe-west12", "europe-west2", "europe-west3", "europe-west4", "europe-west6", "europe-west8", "europe-west9", "fsn1", "hel1", "hil", "me-central1", "me-central2", "me-west1", "nbg1", "northamerica-northeast1", "northamerica-northeast2", "sa-east-1", "sin", "southamerica-east1", "southamerica-west1", "us-central1", "us-east-1", "us-east-2", "us-east1", "us-east4", "us-east5", "us-south1", "us-west-1", "us-west-2", "us-west1", "us-west2", "us-west3", "us-west4"];
|
|
943
|
+
};
|
|
944
|
+
readonly description: "Allowed values for `topology.kubernetes.io/region`.";
|
|
945
|
+
readonly default: readonly [];
|
|
946
|
+
};
|
|
947
|
+
};
|
|
948
|
+
readonly required: readonly ["karpenter.sh/capacity-type", "kubernetes.io/arch"];
|
|
949
|
+
readonly additionalProperties: false;
|
|
950
|
+
readonly description: "Constraints define scheduling and provisioning requirements for the fleet. Each field restricts the values allowed for a given Kubernetes label key. Multiple constraints are ANDed together.";
|
|
951
|
+
readonly default: {
|
|
952
|
+
readonly 'karpenter.sh/capacity-type': readonly ["on-demand", "spot"];
|
|
953
|
+
readonly 'kubernetes.io/arch': readonly ["amd64"];
|
|
954
|
+
readonly 'cfke.io/instance-family': readonly [];
|
|
955
|
+
readonly 'topology.kubernetes.io/region': readonly [];
|
|
956
|
+
};
|
|
957
|
+
};
|
|
958
|
+
readonly scalingProfile: {
|
|
959
|
+
readonly type: "string";
|
|
960
|
+
readonly description: "Controls scale-up / scale-down responsiveness. `aggressive` prioritizes cost-optimization. `conservative` prioritizes stability of the fleet. Full-overwrite: omit to reset to the default (`conservative`).";
|
|
961
|
+
readonly default: "conservative";
|
|
962
|
+
readonly example: "conservative";
|
|
963
|
+
readonly enum: readonly ["aggressive", "conservative"];
|
|
964
|
+
};
|
|
624
965
|
readonly id: {
|
|
625
966
|
readonly type: "string";
|
|
626
967
|
readonly maxLength: 63;
|
|
@@ -629,9 +970,30 @@ export declare const FleetSchema: {
|
|
|
629
970
|
readonly description: "Unique identifier of the kubernetes fleet.";
|
|
630
971
|
readonly example: "new-clouds-fleet";
|
|
631
972
|
};
|
|
973
|
+
readonly ready: {
|
|
974
|
+
readonly type: "boolean";
|
|
975
|
+
readonly description: "Indicates whether the fleet configuration is healthy.";
|
|
976
|
+
readonly example: true;
|
|
977
|
+
};
|
|
978
|
+
readonly status_message: {
|
|
979
|
+
readonly type: "string";
|
|
980
|
+
readonly description: "Human-readable reason the fleet is not ready. Present only when `ready` is false.";
|
|
981
|
+
readonly example: "Invalid provider permissions.";
|
|
982
|
+
};
|
|
983
|
+
readonly created_at: {
|
|
984
|
+
readonly type: "string";
|
|
985
|
+
readonly description: "Creation date and time of the fleet.";
|
|
986
|
+
readonly example: "2024-09-12T09:11:27Z";
|
|
987
|
+
};
|
|
988
|
+
readonly updated_at: {
|
|
989
|
+
readonly type: "string";
|
|
990
|
+
readonly description: "Date and time the fleet was last updated.";
|
|
991
|
+
readonly example: "2024-09-12T09:11:27Z";
|
|
992
|
+
};
|
|
632
993
|
};
|
|
633
|
-
readonly required: readonly ["id"];
|
|
994
|
+
readonly required: readonly ["constraints", "scalingProfile", "id", "ready", "created_at", "updated_at"];
|
|
634
995
|
readonly additionalProperties: false;
|
|
996
|
+
readonly description: "Mutable fleet configuration. Applied as a full overwrite: any omitted field is reset to its default rather than left unchanged.";
|
|
635
997
|
};
|
|
636
998
|
export declare const FleetUpdateInputSchema: {
|
|
637
999
|
readonly type: "object";
|
|
@@ -640,13 +1002,12 @@ export declare const FleetUpdateInputSchema: {
|
|
|
640
1002
|
readonly type: "object";
|
|
641
1003
|
readonly properties: {
|
|
642
1004
|
readonly cpu: {
|
|
643
|
-
readonly type: "
|
|
644
|
-
readonly format: "float";
|
|
1005
|
+
readonly type: "integer";
|
|
645
1006
|
readonly minimum: 0;
|
|
646
|
-
readonly
|
|
1007
|
+
readonly maximum: 100000;
|
|
1008
|
+
readonly description: "CPU limit in cores. Maximum 100,000.";
|
|
647
1009
|
};
|
|
648
1010
|
};
|
|
649
|
-
readonly required: readonly ["cpu"];
|
|
650
1011
|
readonly additionalProperties: false;
|
|
651
1012
|
readonly description: "Limits define a set of bounds for provisioning capacity.";
|
|
652
1013
|
};
|
|
@@ -655,14 +1016,15 @@ export declare const FleetUpdateInputSchema: {
|
|
|
655
1016
|
readonly properties: {
|
|
656
1017
|
readonly enabled: {
|
|
657
1018
|
readonly type: "boolean";
|
|
658
|
-
readonly default: true;
|
|
659
1019
|
};
|
|
660
1020
|
readonly project: {
|
|
661
1021
|
readonly type: "string";
|
|
662
|
-
readonly
|
|
1022
|
+
readonly pattern: "^[a-z][a-z0-9-]{4,28}[a-z0-9]$";
|
|
1023
|
+
readonly description: "GCP project ID to deploy instances into. 6-30 chars, lowercase letters/digits/hyphens, must start with a letter and not end with a hyphen. Omit when GCP is disabled.";
|
|
1024
|
+
readonly example: "my-cloudfleet-project";
|
|
663
1025
|
};
|
|
664
1026
|
};
|
|
665
|
-
readonly required: readonly ["
|
|
1027
|
+
readonly required: readonly ["enabled"];
|
|
666
1028
|
readonly additionalProperties: false;
|
|
667
1029
|
};
|
|
668
1030
|
readonly hetzner: {
|
|
@@ -670,14 +1032,16 @@ export declare const FleetUpdateInputSchema: {
|
|
|
670
1032
|
readonly properties: {
|
|
671
1033
|
readonly enabled: {
|
|
672
1034
|
readonly type: "boolean";
|
|
673
|
-
readonly default: true;
|
|
674
1035
|
};
|
|
675
1036
|
readonly apiKey: {
|
|
676
1037
|
readonly type: "string";
|
|
677
|
-
readonly
|
|
1038
|
+
readonly maxLength: 64;
|
|
1039
|
+
readonly minLength: 64;
|
|
1040
|
+
readonly pattern: "^([A-Za-z0-9]{64}|\\*{64})$";
|
|
1041
|
+
readonly description: "Hetzner Cloud API token with read/write access (64 alphanumeric characters). Write-only: reads return a redacted placeholder, never the token. Omit the field, or send the placeholder back unchanged, to keep the existing key. Send a new value to rotate it.";
|
|
678
1042
|
};
|
|
679
1043
|
};
|
|
680
|
-
readonly required: readonly ["
|
|
1044
|
+
readonly required: readonly ["enabled"];
|
|
681
1045
|
readonly additionalProperties: false;
|
|
682
1046
|
};
|
|
683
1047
|
readonly aws: {
|
|
@@ -685,18 +1049,98 @@ export declare const FleetUpdateInputSchema: {
|
|
|
685
1049
|
readonly properties: {
|
|
686
1050
|
readonly enabled: {
|
|
687
1051
|
readonly type: "boolean";
|
|
688
|
-
readonly default: true;
|
|
689
1052
|
};
|
|
690
1053
|
readonly controllerRoleArn: {
|
|
691
1054
|
readonly type: "string";
|
|
692
|
-
readonly
|
|
1055
|
+
readonly pattern: "^arn:aws(-[a-z]+)*:iam::\\d{12}:role\\/[\\w+=,.@/-]+$";
|
|
1056
|
+
readonly description: "AWS IAM role ARN that Karpenter uses to manage resources. Omit when AWS is disabled.";
|
|
1057
|
+
readonly example: "arn:aws:iam::123456789012:role/Cloudfleet";
|
|
1058
|
+
};
|
|
1059
|
+
};
|
|
1060
|
+
readonly required: readonly ["enabled"];
|
|
1061
|
+
readonly additionalProperties: false;
|
|
1062
|
+
};
|
|
1063
|
+
readonly constraints: {
|
|
1064
|
+
readonly type: "object";
|
|
1065
|
+
readonly properties: {
|
|
1066
|
+
readonly 'karpenter.sh/capacity-type': {
|
|
1067
|
+
readonly type: "array";
|
|
1068
|
+
readonly items: {
|
|
1069
|
+
readonly type: "string";
|
|
1070
|
+
readonly enum: readonly ["on-demand", "spot"];
|
|
1071
|
+
};
|
|
1072
|
+
readonly minItems: 1;
|
|
1073
|
+
readonly description: "Allowed values for `karpenter.sh/capacity-type`.";
|
|
1074
|
+
readonly default: readonly ["on-demand", "spot"];
|
|
1075
|
+
};
|
|
1076
|
+
readonly 'kubernetes.io/arch': {
|
|
1077
|
+
readonly type: "array";
|
|
1078
|
+
readonly items: {
|
|
1079
|
+
readonly type: "string";
|
|
1080
|
+
readonly enum: readonly ["amd64", "arm64"];
|
|
1081
|
+
};
|
|
1082
|
+
readonly minItems: 1;
|
|
1083
|
+
readonly description: "Allowed values for `kubernetes.io/arch`.";
|
|
1084
|
+
readonly default: readonly ["amd64"];
|
|
1085
|
+
};
|
|
1086
|
+
readonly 'cfke.io/instance-family': {
|
|
1087
|
+
readonly type: "array";
|
|
1088
|
+
readonly items: {
|
|
1089
|
+
readonly type: "string";
|
|
1090
|
+
readonly enum: readonly ["a1", "a2", "a3", "a4", "c1", "c2", "c2d", "c3", "c3d", "c4", "c4a", "c4d", "c5", "c5a", "c5ad", "c5d", "c5n", "c6a", "c6g", "c6gd", "c6gn", "c6i", "c6id", "c6in", "c7a", "c7g", "c7gd", "c7gn", "c7i", "c7i-flex", "c8g", "c8gd", "cax", "ccx", "cpx", "cx", "d2", "d3", "d3en", "dl1", "dl2q", "e2", "f1", "f2", "g1", "g2", "g4ad", "g4dn", "g5", "g5g", "g6", "g6e", "gr6", "h1", "h3", "hpc6a", "hpc6id", "hpc7a", "hpc7g", "i2", "i3", "i3en", "i4g", "i4i", "i7i", "i7ie", "i8g", "im4gn", "inf1", "inf2", "is4gen", "m1", "m2", "m3", "m4", "m5", "m5a", "m5ad", "m5d", "m5dn", "m5n", "m5zn", "m6a", "m6g", "m6gd", "m6i", "m6id", "m6idn", "m6in", "m7a", "m7g", "m7gd", "m7i", "m7i-flex", "m8g", "m8gd", "n1", "n2", "n2d", "n4", "p3", "p3dn", "p4d", "p4de", "p5", "p5e", "p5en", "p6-b200", "r3", "r4", "r5", "r5a", "r5ad", "r5b", "r5d", "r5dn", "r5n", "r6a", "r6g", "r6gd", "r6i", "r6id", "r6idn", "r6in", "r7a", "r7g", "r7gd", "r7i", "r7iz", "r8g", "r8gd", "t2", "t2a", "t2d", "t3", "t3a", "t4g", "trn1", "trn1n", "u-3tb1", "u-6tb1", "u7i-12tb", "u7i-6tb", "u7i-8tb", "u7in-16tb", "u7in-24tb", "u7in-32tb", "vt1", "x1", "x1e", "x2gd", "x2idn", "x2iedn", "x2iezn", "x4", "x8g", "z1d", "z3"];
|
|
1091
|
+
};
|
|
1092
|
+
readonly description: "Allowed values for `cfke.io/instance-family`.";
|
|
1093
|
+
readonly default: readonly [];
|
|
1094
|
+
};
|
|
1095
|
+
readonly 'topology.kubernetes.io/region': {
|
|
1096
|
+
readonly type: "array";
|
|
1097
|
+
readonly items: {
|
|
1098
|
+
readonly type: "string";
|
|
1099
|
+
readonly enum: readonly ["africa-south1", "ap-northeast-1", "ap-northeast-2", "ap-northeast-3", "ap-south-1", "ap-southeast-1", "ap-southeast-2", "ash", "asia-east1", "asia-east2", "asia-northeast1", "asia-northeast2", "asia-northeast3", "asia-south1", "asia-south2", "asia-southeast1", "asia-southeast2", "australia-southeast1", "australia-southeast2", "ca-central-1", "eu-central-1", "eu-central-2", "eu-north-1", "eu-west-1", "eu-west-2", "eu-west-3", "europe-central2", "europe-north1", "europe-southwest1", "europe-west1", "europe-west10", "europe-west12", "europe-west2", "europe-west3", "europe-west4", "europe-west6", "europe-west8", "europe-west9", "fsn1", "hel1", "hil", "me-central1", "me-central2", "me-west1", "nbg1", "northamerica-northeast1", "northamerica-northeast2", "sa-east-1", "sin", "southamerica-east1", "southamerica-west1", "us-central1", "us-east-1", "us-east-2", "us-east1", "us-east4", "us-east5", "us-south1", "us-west-1", "us-west-2", "us-west1", "us-west2", "us-west3", "us-west4"];
|
|
1100
|
+
};
|
|
1101
|
+
readonly description: "Allowed values for `topology.kubernetes.io/region`.";
|
|
1102
|
+
readonly default: readonly [];
|
|
693
1103
|
};
|
|
694
1104
|
};
|
|
695
|
-
readonly required: readonly ["controllerRoleArn"];
|
|
696
1105
|
readonly additionalProperties: false;
|
|
1106
|
+
readonly description: "Constraints define scheduling and provisioning requirements for the fleet. Each field restricts the values allowed for a given Kubernetes label key. Multiple constraints are ANDed together.";
|
|
1107
|
+
readonly default: {
|
|
1108
|
+
readonly 'karpenter.sh/capacity-type': readonly ["on-demand", "spot"];
|
|
1109
|
+
readonly 'kubernetes.io/arch': readonly ["amd64"];
|
|
1110
|
+
readonly 'cfke.io/instance-family': readonly [];
|
|
1111
|
+
readonly 'topology.kubernetes.io/region': readonly [];
|
|
1112
|
+
};
|
|
1113
|
+
};
|
|
1114
|
+
readonly scalingProfile: {
|
|
1115
|
+
readonly type: "string";
|
|
1116
|
+
readonly description: "Controls scale-up / scale-down responsiveness. `aggressive` prioritizes cost-optimization. `conservative` prioritizes stability of the fleet. Full-overwrite: omit to reset to the default (`conservative`).";
|
|
1117
|
+
readonly default: "conservative";
|
|
1118
|
+
readonly example: "conservative";
|
|
1119
|
+
readonly enum: readonly ["aggressive", "conservative"];
|
|
697
1120
|
};
|
|
698
1121
|
};
|
|
699
1122
|
readonly additionalProperties: false;
|
|
1123
|
+
readonly description: "Mutable fleet configuration. Applied as a full overwrite: any omitted field is reset to its default rather than left unchanged.";
|
|
1124
|
+
};
|
|
1125
|
+
export declare const InviteCreateInputSchema: {
|
|
1126
|
+
readonly type: "object";
|
|
1127
|
+
readonly properties: {
|
|
1128
|
+
readonly email: {
|
|
1129
|
+
readonly type: "string";
|
|
1130
|
+
readonly format: "email";
|
|
1131
|
+
readonly description: "Email address of the user to invite.";
|
|
1132
|
+
readonly example: "email@example.com";
|
|
1133
|
+
};
|
|
1134
|
+
readonly role: {
|
|
1135
|
+
readonly type: "string";
|
|
1136
|
+
readonly description: "Role the invited user will be assigned on redemption. Can be 'Administrator' or 'User'.";
|
|
1137
|
+
readonly default: "User";
|
|
1138
|
+
readonly example: "User";
|
|
1139
|
+
readonly enum: readonly ["Administrator", "User"];
|
|
1140
|
+
};
|
|
1141
|
+
};
|
|
1142
|
+
readonly required: readonly ["email"];
|
|
1143
|
+
readonly additionalProperties: false;
|
|
700
1144
|
};
|
|
701
1145
|
export declare const InviteSchema: {
|
|
702
1146
|
readonly type: "object";
|
|
@@ -729,6 +1173,13 @@ export declare const InviteSchema: {
|
|
|
729
1173
|
readonly description: "Generated unique invite code.";
|
|
730
1174
|
readonly example: "7kUZnH7nnKUFfvc4NK2KQF";
|
|
731
1175
|
};
|
|
1176
|
+
readonly role: {
|
|
1177
|
+
readonly type: "string";
|
|
1178
|
+
readonly description: "Role the invited user will be assigned on redemption. Can be 'Administrator' or 'User'.";
|
|
1179
|
+
readonly default: "User";
|
|
1180
|
+
readonly example: "User";
|
|
1181
|
+
readonly enum: readonly ["Administrator", "User"];
|
|
1182
|
+
};
|
|
732
1183
|
};
|
|
733
1184
|
readonly required: readonly ["date_created"];
|
|
734
1185
|
readonly additionalProperties: false;
|
|
@@ -926,6 +1377,12 @@ export declare const MarketplaceListingSchema: {
|
|
|
926
1377
|
export declare const OrganizationCreateInputSchema: {
|
|
927
1378
|
readonly type: "object";
|
|
928
1379
|
readonly properties: {
|
|
1380
|
+
readonly type: {
|
|
1381
|
+
readonly type: "string";
|
|
1382
|
+
readonly description: "Type of the organization. `business` for legal entities, `personal` for individuals.";
|
|
1383
|
+
readonly example: "business";
|
|
1384
|
+
readonly enum: readonly ["business", "personal"];
|
|
1385
|
+
};
|
|
929
1386
|
readonly email: {
|
|
930
1387
|
readonly type: "string";
|
|
931
1388
|
readonly format: "email";
|
|
@@ -934,11 +1391,13 @@ export declare const OrganizationCreateInputSchema: {
|
|
|
934
1391
|
};
|
|
935
1392
|
readonly first_name: {
|
|
936
1393
|
readonly type: "string";
|
|
1394
|
+
readonly minLength: 1;
|
|
937
1395
|
readonly description: "First name of the billing contact person.";
|
|
938
1396
|
readonly example: "John";
|
|
939
1397
|
};
|
|
940
1398
|
readonly last_name: {
|
|
941
1399
|
readonly type: "string";
|
|
1400
|
+
readonly minLength: 1;
|
|
942
1401
|
readonly description: "Last name of the billing contact person.";
|
|
943
1402
|
readonly example: "Doe";
|
|
944
1403
|
};
|
|
@@ -956,7 +1415,19 @@ export declare const OrganizationCreateInputSchema: {
|
|
|
956
1415
|
readonly description: "Password for the root account. Must be at least 8 characters long and contain at least one uppercase letter, one lowercase letter, one number and one special character.";
|
|
957
1416
|
};
|
|
958
1417
|
};
|
|
959
|
-
readonly required: readonly ["email", "first_name", "last_name", "company_name", "password"];
|
|
1418
|
+
readonly required: readonly ["type", "email", "first_name", "last_name", "company_name", "password"];
|
|
1419
|
+
readonly additionalProperties: false;
|
|
1420
|
+
};
|
|
1421
|
+
export declare const OrganizationCreateOutputSchema: {
|
|
1422
|
+
readonly type: "object";
|
|
1423
|
+
readonly properties: {
|
|
1424
|
+
readonly id: {
|
|
1425
|
+
readonly type: "string";
|
|
1426
|
+
readonly description: "Unique identifier of the newly created organization. Generated by the API and safe to use for client-side tracking immediately.";
|
|
1427
|
+
readonly example: "organization-id";
|
|
1428
|
+
};
|
|
1429
|
+
};
|
|
1430
|
+
readonly required: readonly ["id"];
|
|
960
1431
|
readonly additionalProperties: false;
|
|
961
1432
|
};
|
|
962
1433
|
export declare const OrganizationSchema: {
|
|
@@ -975,6 +1446,12 @@ export declare const OrganizationSchema: {
|
|
|
975
1446
|
readonly description: "Name of the legal entity. This name will be used in invoices. Use your first and last name for individual accounts.";
|
|
976
1447
|
readonly example: "ACME Corp.";
|
|
977
1448
|
};
|
|
1449
|
+
readonly type: {
|
|
1450
|
+
readonly type: "string";
|
|
1451
|
+
readonly description: "Type of the organization. `business` for legal entities, `personal` for individuals.";
|
|
1452
|
+
readonly example: "business";
|
|
1453
|
+
readonly enum: readonly ["business", "personal"];
|
|
1454
|
+
};
|
|
978
1455
|
readonly date_created: {
|
|
979
1456
|
readonly type: "string";
|
|
980
1457
|
readonly format: "date-time";
|
|
@@ -1006,6 +1483,17 @@ export declare const OrganizationSchema: {
|
|
|
1006
1483
|
readonly description: "Available number of Pro clusters that can be created.";
|
|
1007
1484
|
readonly example: 999;
|
|
1008
1485
|
};
|
|
1486
|
+
readonly enterprise_clusters_max: {
|
|
1487
|
+
readonly type: "integer";
|
|
1488
|
+
readonly minimum: 0;
|
|
1489
|
+
readonly description: "Maximum number of Enterprise clusters that can be created.";
|
|
1490
|
+
readonly example: 999;
|
|
1491
|
+
};
|
|
1492
|
+
readonly enterprise_clusters_available: {
|
|
1493
|
+
readonly type: "integer";
|
|
1494
|
+
readonly description: "Available number of Enterprise clusters that can be created.";
|
|
1495
|
+
readonly example: 999;
|
|
1496
|
+
};
|
|
1009
1497
|
readonly fleets_max: {
|
|
1010
1498
|
readonly type: "integer";
|
|
1011
1499
|
readonly minimum: 0;
|
|
@@ -1025,7 +1513,7 @@ export declare const OrganizationSchema: {
|
|
|
1025
1513
|
readonly type: "array";
|
|
1026
1514
|
readonly items: {
|
|
1027
1515
|
readonly type: "string";
|
|
1028
|
-
readonly example: "northamerica-central-
|
|
1516
|
+
readonly example: "northamerica-central-1a";
|
|
1029
1517
|
};
|
|
1030
1518
|
readonly minItems: 1;
|
|
1031
1519
|
readonly description: "List of Cloudfleet control plane regions available for the organization.";
|
|
@@ -1052,18 +1540,6 @@ export declare const OrganizationSchema: {
|
|
|
1052
1540
|
readonly minItems: 1;
|
|
1053
1541
|
readonly description: "List of CFKE control plane versions available for the organization.";
|
|
1054
1542
|
};
|
|
1055
|
-
readonly copilot_user_hourly_tokens: {
|
|
1056
|
-
readonly type: "integer";
|
|
1057
|
-
readonly minimum: 0;
|
|
1058
|
-
readonly description: "User-level maximum number of tokens Cloudfleet Copilot can process per hour.";
|
|
1059
|
-
readonly example: 42000;
|
|
1060
|
-
};
|
|
1061
|
-
readonly copilot_organization_hourly_tokens: {
|
|
1062
|
-
readonly type: "integer";
|
|
1063
|
-
readonly minimum: 0;
|
|
1064
|
-
readonly description: "Organization-level maximum number of tokens Cloudfleet Copilot can process per hour.";
|
|
1065
|
-
readonly example: 242000;
|
|
1066
|
-
};
|
|
1067
1543
|
readonly cfcr_storage_gb: {
|
|
1068
1544
|
readonly type: "integer";
|
|
1069
1545
|
readonly minimum: -1;
|
|
@@ -1071,7 +1547,7 @@ export declare const OrganizationSchema: {
|
|
|
1071
1547
|
readonly example: 500;
|
|
1072
1548
|
};
|
|
1073
1549
|
};
|
|
1074
|
-
readonly required: readonly ["basic_clusters_max", "basic_clusters_available", "pro_clusters_max", "pro_clusters_available", "
|
|
1550
|
+
readonly required: readonly ["basic_clusters_max", "basic_clusters_available", "pro_clusters_max", "pro_clusters_available", "enterprise_clusters_max", "enterprise_clusters_available", "fleets_max", "cluster_tiers", "regions", "versions", "cfcr_storage_gb"];
|
|
1075
1551
|
readonly additionalProperties: false;
|
|
1076
1552
|
readonly description: "For security reasons, platform quota is controlled by Cloudfleet and can be updated only by Cloudfleet administrators. Please open a support ticket if you need to change the platform quota.";
|
|
1077
1553
|
};
|
|
@@ -1080,8 +1556,14 @@ export declare const OrganizationSchema: {
|
|
|
1080
1556
|
readonly description: "Status of the organization. Can be `active` or `closed`, or `suspended`.";
|
|
1081
1557
|
readonly enum: readonly ["active", "closed", "suspended"];
|
|
1082
1558
|
};
|
|
1559
|
+
readonly verification: {
|
|
1560
|
+
readonly type: "string";
|
|
1561
|
+
readonly description: "Verification status of the organization, which determines the assigned quota. `none` when billing information is incomplete, `submitted` when billing information is complete but the organization is not yet verified, `verified` when the organization is verified.";
|
|
1562
|
+
readonly example: "verified";
|
|
1563
|
+
readonly enum: readonly ["none", "submitted", "verified"];
|
|
1564
|
+
};
|
|
1083
1565
|
};
|
|
1084
|
-
readonly required: readonly ["id", "date_created", "quota", "status"];
|
|
1566
|
+
readonly required: readonly ["id", "type", "date_created", "quota", "status", "verification"];
|
|
1085
1567
|
readonly additionalProperties: false;
|
|
1086
1568
|
};
|
|
1087
1569
|
export declare const PaymentMethodSchema: {
|
|
@@ -1089,26 +1571,19 @@ export declare const PaymentMethodSchema: {
|
|
|
1089
1571
|
readonly properties: {
|
|
1090
1572
|
readonly id: {
|
|
1091
1573
|
readonly type: "string";
|
|
1092
|
-
readonly
|
|
1093
|
-
readonly
|
|
1094
|
-
readonly example: "e94d30ec-a2dd-4dcb-832c-ac2be144ba91";
|
|
1095
|
-
};
|
|
1096
|
-
readonly setup: {
|
|
1097
|
-
readonly type: "boolean";
|
|
1098
|
-
readonly description: "Whether organization payment method was set up and ready to use for payments.";
|
|
1099
|
-
readonly example: true;
|
|
1574
|
+
readonly description: "Payment method identifier. Stripe payment method id for cards/SEPA; the constant `bank_transfer` for the invoice/bank-transfer method. Used to set as default or delete the payment method.";
|
|
1575
|
+
readonly example: "pm_1MtwBwLkdIwHu7ix28a3tqPa";
|
|
1100
1576
|
};
|
|
1101
1577
|
readonly type: {
|
|
1102
1578
|
readonly type: "string";
|
|
1103
|
-
readonly
|
|
1104
|
-
readonly description: "Payment method type type. Only `card` payments supported at the moment.";
|
|
1579
|
+
readonly description: "Payment method type. `card`, `sepa_debit` for SEPA Direct Debit (business accounts only), or `bank_transfer` for paying invoices by bank transfer.";
|
|
1105
1580
|
readonly example: "card";
|
|
1106
|
-
readonly enum: readonly ["card"];
|
|
1581
|
+
readonly enum: readonly ["card", "sepa_debit", "bank_transfer"];
|
|
1107
1582
|
};
|
|
1108
1583
|
readonly last4: {
|
|
1109
1584
|
readonly type: "string";
|
|
1110
1585
|
readonly nullable: true;
|
|
1111
|
-
readonly description: "Last 4 digits of the payment card number.";
|
|
1586
|
+
readonly description: "Last 4 digits of the payment card number, of the bank account (IBAN) for SEPA Direct Debit, or of the destination IBAN for bank transfer.";
|
|
1112
1587
|
readonly example: "4242";
|
|
1113
1588
|
};
|
|
1114
1589
|
readonly exp_month: {
|
|
@@ -1116,25 +1591,46 @@ export declare const PaymentMethodSchema: {
|
|
|
1116
1591
|
readonly minimum: 1;
|
|
1117
1592
|
readonly maximum: 12;
|
|
1118
1593
|
readonly nullable: true;
|
|
1119
|
-
readonly description: "Two-digit number representing the card's expiration month.";
|
|
1120
|
-
readonly example:
|
|
1594
|
+
readonly description: "Two-digit number representing the card's expiration month. Null for SEPA Direct Debit and bank transfer.";
|
|
1595
|
+
readonly example: 12;
|
|
1121
1596
|
};
|
|
1122
1597
|
readonly exp_year: {
|
|
1123
1598
|
readonly type: "integer";
|
|
1124
|
-
readonly minimum: 2024;
|
|
1125
1599
|
readonly nullable: true;
|
|
1126
|
-
readonly description: "Four-digit number representing the card's expiration year.";
|
|
1127
|
-
readonly example:
|
|
1600
|
+
readonly description: "Four-digit number representing the card's expiration year. May be in the past for an expired card still on file. Null for SEPA Direct Debit and bank transfer.";
|
|
1601
|
+
readonly example: 2028;
|
|
1128
1602
|
};
|
|
1129
1603
|
readonly brand: {
|
|
1130
1604
|
readonly type: "string";
|
|
1131
1605
|
readonly nullable: true;
|
|
1132
|
-
readonly description: "Payment card brand
|
|
1606
|
+
readonly description: "Payment card brand as reported by Stripe, e.g. `visa`, `mastercard`, `amex`, `cartes_bancaires`, or `unknown`. Null for SEPA Direct Debit and bank transfer.";
|
|
1133
1607
|
readonly example: "visa";
|
|
1134
|
-
|
|
1608
|
+
};
|
|
1609
|
+
readonly iban: {
|
|
1610
|
+
readonly type: "string";
|
|
1611
|
+
readonly nullable: true;
|
|
1612
|
+
readonly description: "Full destination IBAN to send bank transfers to. Set only for `bank_transfer`; null otherwise. This is Cloudfleet's virtual receiving account, shown in full so the customer can pay into it.";
|
|
1613
|
+
readonly example: "DE11243015658023127510";
|
|
1614
|
+
};
|
|
1615
|
+
readonly bic: {
|
|
1616
|
+
readonly type: "string";
|
|
1617
|
+
readonly nullable: true;
|
|
1618
|
+
readonly description: "BIC/SWIFT of the destination bank for bank transfers. Set only for `bank_transfer`; null otherwise.";
|
|
1619
|
+
readonly example: "SOGEDEFFXXX";
|
|
1620
|
+
};
|
|
1621
|
+
readonly account_holder_name: {
|
|
1622
|
+
readonly type: "string";
|
|
1623
|
+
readonly nullable: true;
|
|
1624
|
+
readonly description: "Account holder name of the destination bank account for bank transfers. Set only for `bank_transfer`; null otherwise.";
|
|
1625
|
+
readonly example: "Cloudfleet GmbH";
|
|
1626
|
+
};
|
|
1627
|
+
readonly is_default: {
|
|
1628
|
+
readonly type: "boolean";
|
|
1629
|
+
readonly description: "Whether this payment method is the default used for invoices and active subscriptions. Always false for `bank_transfer` (it cannot be a Stripe default payment method).";
|
|
1630
|
+
readonly example: true;
|
|
1135
1631
|
};
|
|
1136
1632
|
};
|
|
1137
|
-
readonly required: readonly ["id", "
|
|
1633
|
+
readonly required: readonly ["id", "type", "last4", "exp_month", "exp_year", "brand", "iban", "bic", "account_holder_name", "is_default"];
|
|
1138
1634
|
readonly additionalProperties: false;
|
|
1139
1635
|
};
|
|
1140
1636
|
export declare const PlatformQuotaSchema: {
|
|
@@ -1162,6 +1658,17 @@ export declare const PlatformQuotaSchema: {
|
|
|
1162
1658
|
readonly description: "Available number of Pro clusters that can be created.";
|
|
1163
1659
|
readonly example: 999;
|
|
1164
1660
|
};
|
|
1661
|
+
readonly enterprise_clusters_max: {
|
|
1662
|
+
readonly type: "integer";
|
|
1663
|
+
readonly minimum: 0;
|
|
1664
|
+
readonly description: "Maximum number of Enterprise clusters that can be created.";
|
|
1665
|
+
readonly example: 999;
|
|
1666
|
+
};
|
|
1667
|
+
readonly enterprise_clusters_available: {
|
|
1668
|
+
readonly type: "integer";
|
|
1669
|
+
readonly description: "Available number of Enterprise clusters that can be created.";
|
|
1670
|
+
readonly example: 999;
|
|
1671
|
+
};
|
|
1165
1672
|
readonly fleets_max: {
|
|
1166
1673
|
readonly type: "integer";
|
|
1167
1674
|
readonly minimum: 0;
|
|
@@ -1181,7 +1688,7 @@ export declare const PlatformQuotaSchema: {
|
|
|
1181
1688
|
readonly type: "array";
|
|
1182
1689
|
readonly items: {
|
|
1183
1690
|
readonly type: "string";
|
|
1184
|
-
readonly example: "northamerica-central-
|
|
1691
|
+
readonly example: "northamerica-central-1a";
|
|
1185
1692
|
};
|
|
1186
1693
|
readonly minItems: 1;
|
|
1187
1694
|
readonly description: "List of Cloudfleet control plane regions available for the organization.";
|
|
@@ -1208,18 +1715,6 @@ export declare const PlatformQuotaSchema: {
|
|
|
1208
1715
|
readonly minItems: 1;
|
|
1209
1716
|
readonly description: "List of CFKE control plane versions available for the organization.";
|
|
1210
1717
|
};
|
|
1211
|
-
readonly copilot_user_hourly_tokens: {
|
|
1212
|
-
readonly type: "integer";
|
|
1213
|
-
readonly minimum: 0;
|
|
1214
|
-
readonly description: "User-level maximum number of tokens Cloudfleet Copilot can process per hour.";
|
|
1215
|
-
readonly example: 42000;
|
|
1216
|
-
};
|
|
1217
|
-
readonly copilot_organization_hourly_tokens: {
|
|
1218
|
-
readonly type: "integer";
|
|
1219
|
-
readonly minimum: 0;
|
|
1220
|
-
readonly description: "Organization-level maximum number of tokens Cloudfleet Copilot can process per hour.";
|
|
1221
|
-
readonly example: 242000;
|
|
1222
|
-
};
|
|
1223
1718
|
readonly cfcr_storage_gb: {
|
|
1224
1719
|
readonly type: "integer";
|
|
1225
1720
|
readonly minimum: -1;
|
|
@@ -1227,7 +1722,7 @@ export declare const PlatformQuotaSchema: {
|
|
|
1227
1722
|
readonly example: 500;
|
|
1228
1723
|
};
|
|
1229
1724
|
};
|
|
1230
|
-
readonly required: readonly ["basic_clusters_max", "basic_clusters_available", "pro_clusters_max", "pro_clusters_available", "
|
|
1725
|
+
readonly required: readonly ["basic_clusters_max", "basic_clusters_available", "pro_clusters_max", "pro_clusters_available", "enterprise_clusters_max", "enterprise_clusters_available", "fleets_max", "cluster_tiers", "regions", "versions", "cfcr_storage_gb"];
|
|
1231
1726
|
readonly additionalProperties: false;
|
|
1232
1727
|
};
|
|
1233
1728
|
export declare const RegistryRepositorySchema: {
|
|
@@ -1461,6 +1956,407 @@ export declare const RegistryTagSchema: {
|
|
|
1461
1956
|
readonly required: readonly ["name", "digest", "size", "region", "repository", "uri"];
|
|
1462
1957
|
readonly additionalProperties: false;
|
|
1463
1958
|
};
|
|
1959
|
+
export declare const TicketAttachmentSchema: {
|
|
1960
|
+
readonly type: "object";
|
|
1961
|
+
readonly properties: {
|
|
1962
|
+
readonly id: {
|
|
1963
|
+
readonly type: "string";
|
|
1964
|
+
readonly description: "Unique identifier of the attachment (Mongo ObjectId).";
|
|
1965
|
+
readonly example: "60c72b2f9f1b2c001f8e4d3c";
|
|
1966
|
+
};
|
|
1967
|
+
readonly filename: {
|
|
1968
|
+
readonly type: "string";
|
|
1969
|
+
readonly description: "Original filename as uploaded.";
|
|
1970
|
+
readonly example: "debug.log";
|
|
1971
|
+
};
|
|
1972
|
+
readonly content_type: {
|
|
1973
|
+
readonly type: "string";
|
|
1974
|
+
readonly description: "MIME content type of the attachment.";
|
|
1975
|
+
readonly example: "text/plain";
|
|
1976
|
+
};
|
|
1977
|
+
readonly size: {
|
|
1978
|
+
readonly type: "integer";
|
|
1979
|
+
readonly description: "Size of the attachment in bytes.";
|
|
1980
|
+
readonly example: 12345;
|
|
1981
|
+
};
|
|
1982
|
+
};
|
|
1983
|
+
readonly required: readonly ["id", "filename", "content_type", "size"];
|
|
1984
|
+
readonly additionalProperties: false;
|
|
1985
|
+
};
|
|
1986
|
+
export declare const TicketCreateInputSchema: {
|
|
1987
|
+
readonly type: "object";
|
|
1988
|
+
readonly properties: {
|
|
1989
|
+
readonly category: {
|
|
1990
|
+
readonly type: "string";
|
|
1991
|
+
readonly description: "Ticket category. Drives auto-assignment and may carry a subcategory in `properties`.";
|
|
1992
|
+
readonly example: "technical";
|
|
1993
|
+
readonly enum: readonly ["billing", "technical", "general"];
|
|
1994
|
+
};
|
|
1995
|
+
readonly body: {
|
|
1996
|
+
readonly type: "string";
|
|
1997
|
+
readonly maxLength: 50000;
|
|
1998
|
+
readonly minLength: 1;
|
|
1999
|
+
readonly pattern: "\\S";
|
|
2000
|
+
readonly description: "Initial message body in markdown. There is no separate subject — the first message body is the description.";
|
|
2001
|
+
readonly example: "My cluster cannot reach the registry. Logs attached.";
|
|
2002
|
+
};
|
|
2003
|
+
readonly properties: {
|
|
2004
|
+
readonly type: "object";
|
|
2005
|
+
readonly additionalProperties: true;
|
|
2006
|
+
readonly description: "Free-form key/value bag set by the UI (e.g. `subcategory`, `cluster_id`, `cluster_name`, `region`).";
|
|
2007
|
+
readonly example: {
|
|
2008
|
+
readonly subcategory: "cluster-question";
|
|
2009
|
+
readonly cluster_id: "60c72b2f9f1b2c001f8e4d3a";
|
|
2010
|
+
};
|
|
2011
|
+
};
|
|
2012
|
+
};
|
|
2013
|
+
readonly required: readonly ["category", "body"];
|
|
2014
|
+
readonly additionalProperties: false;
|
|
2015
|
+
};
|
|
2016
|
+
export declare const TicketListResponseSchema: {
|
|
2017
|
+
readonly type: "object";
|
|
2018
|
+
readonly properties: {
|
|
2019
|
+
readonly items: {
|
|
2020
|
+
readonly type: "array";
|
|
2021
|
+
readonly items: {
|
|
2022
|
+
readonly type: "object";
|
|
2023
|
+
readonly properties: {
|
|
2024
|
+
readonly id: {
|
|
2025
|
+
readonly type: "string";
|
|
2026
|
+
readonly description: "Unique identifier of the ticket (Mongo ObjectId).";
|
|
2027
|
+
readonly example: "60c72b2f9f1b2c001f8e4d3a";
|
|
2028
|
+
};
|
|
2029
|
+
readonly status: {
|
|
2030
|
+
readonly type: "string";
|
|
2031
|
+
readonly description: "Current state of the ticket.";
|
|
2032
|
+
readonly example: "waiting_on_us";
|
|
2033
|
+
readonly enum: readonly ["waiting_on_us", "waiting_on_user", "closed"];
|
|
2034
|
+
};
|
|
2035
|
+
readonly category: {
|
|
2036
|
+
readonly type: "string";
|
|
2037
|
+
readonly description: "Ticket category.";
|
|
2038
|
+
readonly example: "technical";
|
|
2039
|
+
readonly enum: readonly ["billing", "technical", "general"];
|
|
2040
|
+
};
|
|
2041
|
+
readonly summary: {
|
|
2042
|
+
readonly type: "string";
|
|
2043
|
+
readonly description: "First 128 characters of the initial message body, with markdown formatting and newlines stripped. Used for ticket list previews.";
|
|
2044
|
+
readonly example: "My cluster cannot reach the registry. Logs attached.";
|
|
2045
|
+
};
|
|
2046
|
+
readonly closed_at: {
|
|
2047
|
+
readonly type: "string";
|
|
2048
|
+
readonly format: "date-time";
|
|
2049
|
+
readonly nullable: true;
|
|
2050
|
+
readonly description: "Closure timestamp. Null while the ticket is open.";
|
|
2051
|
+
readonly example: "2026-05-18T16:08:14.338Z";
|
|
2052
|
+
};
|
|
2053
|
+
readonly date_created: {
|
|
2054
|
+
readonly type: "string";
|
|
2055
|
+
readonly format: "date-time";
|
|
2056
|
+
readonly description: "Creation date of the ticket. ISO 8601 UTC.";
|
|
2057
|
+
readonly example: "2026-05-11T16:08:14.338Z";
|
|
2058
|
+
};
|
|
2059
|
+
readonly date_updated: {
|
|
2060
|
+
readonly type: "string";
|
|
2061
|
+
readonly format: "date-time";
|
|
2062
|
+
readonly description: "Last update date of the ticket. ISO 8601 UTC.";
|
|
2063
|
+
readonly example: "2026-05-11T16:08:14.338Z";
|
|
2064
|
+
};
|
|
2065
|
+
readonly messages: {
|
|
2066
|
+
readonly type: "array";
|
|
2067
|
+
readonly items: {
|
|
2068
|
+
readonly type: "object";
|
|
2069
|
+
readonly properties: {
|
|
2070
|
+
readonly id: {
|
|
2071
|
+
readonly type: "string";
|
|
2072
|
+
readonly description: "Unique identifier of the message (Mongo ObjectId).";
|
|
2073
|
+
readonly example: "60c72b2f9f1b2c001f8e4d3b";
|
|
2074
|
+
};
|
|
2075
|
+
readonly type: {
|
|
2076
|
+
readonly type: "string";
|
|
2077
|
+
readonly description: "Message type. Internal notes are filtered out of customer-facing responses.";
|
|
2078
|
+
readonly example: "customer_reply";
|
|
2079
|
+
readonly enum: readonly ["customer_reply", "agent_reply"];
|
|
2080
|
+
};
|
|
2081
|
+
readonly body: {
|
|
2082
|
+
readonly type: "string";
|
|
2083
|
+
readonly description: "Message body in markdown.";
|
|
2084
|
+
readonly example: "Thanks — that resolved it on my side.";
|
|
2085
|
+
};
|
|
2086
|
+
readonly author_first_name: {
|
|
2087
|
+
readonly type: "string";
|
|
2088
|
+
readonly nullable: true;
|
|
2089
|
+
readonly description: "First name of the author. Null when not provided.";
|
|
2090
|
+
readonly example: "Jane";
|
|
2091
|
+
};
|
|
2092
|
+
readonly author_last_name: {
|
|
2093
|
+
readonly type: "string";
|
|
2094
|
+
readonly nullable: true;
|
|
2095
|
+
readonly description: "Last name of the author. Null when not provided.";
|
|
2096
|
+
readonly example: "Doe";
|
|
2097
|
+
};
|
|
2098
|
+
readonly attachments: {
|
|
2099
|
+
readonly type: "array";
|
|
2100
|
+
readonly items: {
|
|
2101
|
+
readonly type: "object";
|
|
2102
|
+
readonly properties: {
|
|
2103
|
+
readonly id: {
|
|
2104
|
+
readonly type: "string";
|
|
2105
|
+
readonly description: "Unique identifier of the attachment (Mongo ObjectId).";
|
|
2106
|
+
readonly example: "60c72b2f9f1b2c001f8e4d3c";
|
|
2107
|
+
};
|
|
2108
|
+
readonly filename: {
|
|
2109
|
+
readonly type: "string";
|
|
2110
|
+
readonly description: "Original filename as uploaded.";
|
|
2111
|
+
readonly example: "debug.log";
|
|
2112
|
+
};
|
|
2113
|
+
readonly content_type: {
|
|
2114
|
+
readonly type: "string";
|
|
2115
|
+
readonly description: "MIME content type of the attachment.";
|
|
2116
|
+
readonly example: "text/plain";
|
|
2117
|
+
};
|
|
2118
|
+
readonly size: {
|
|
2119
|
+
readonly type: "integer";
|
|
2120
|
+
readonly description: "Size of the attachment in bytes.";
|
|
2121
|
+
readonly example: 12345;
|
|
2122
|
+
};
|
|
2123
|
+
};
|
|
2124
|
+
readonly required: readonly ["id", "filename", "content_type", "size"];
|
|
2125
|
+
readonly additionalProperties: false;
|
|
2126
|
+
};
|
|
2127
|
+
readonly description: "Attachments associated with this message.";
|
|
2128
|
+
readonly example: readonly [];
|
|
2129
|
+
};
|
|
2130
|
+
readonly date_created: {
|
|
2131
|
+
readonly type: "string";
|
|
2132
|
+
readonly format: "date-time";
|
|
2133
|
+
readonly description: "Creation date of the message. ISO 8601 UTC.";
|
|
2134
|
+
readonly example: "2026-05-11T16:08:14.338Z";
|
|
2135
|
+
};
|
|
2136
|
+
};
|
|
2137
|
+
readonly required: readonly ["id", "type", "body", "date_created"];
|
|
2138
|
+
readonly additionalProperties: false;
|
|
2139
|
+
};
|
|
2140
|
+
readonly description: "Messages on the ticket in chronological order. Internal notes are excluded. Returned by the detail endpoint only.";
|
|
2141
|
+
};
|
|
2142
|
+
};
|
|
2143
|
+
readonly required: readonly ["id", "status", "category", "summary", "date_created", "date_updated"];
|
|
2144
|
+
readonly additionalProperties: false;
|
|
2145
|
+
};
|
|
2146
|
+
readonly description: "Tickets for the organization, ordered newest first. Messages are omitted from list responses.";
|
|
2147
|
+
};
|
|
2148
|
+
};
|
|
2149
|
+
readonly required: readonly ["items"];
|
|
2150
|
+
readonly additionalProperties: false;
|
|
2151
|
+
};
|
|
2152
|
+
export declare const TicketMessageInputSchema: {
|
|
2153
|
+
readonly type: "object";
|
|
2154
|
+
readonly properties: {
|
|
2155
|
+
readonly body: {
|
|
2156
|
+
readonly type: "string";
|
|
2157
|
+
readonly maxLength: 50000;
|
|
2158
|
+
readonly minLength: 1;
|
|
2159
|
+
readonly pattern: "\\S";
|
|
2160
|
+
readonly description: "Reply body in markdown.";
|
|
2161
|
+
readonly example: "Thanks — that resolved it on my side.";
|
|
2162
|
+
};
|
|
2163
|
+
};
|
|
2164
|
+
readonly required: readonly ["body"];
|
|
2165
|
+
readonly additionalProperties: false;
|
|
2166
|
+
};
|
|
2167
|
+
export declare const TicketMessageSchema: {
|
|
2168
|
+
readonly type: "object";
|
|
2169
|
+
readonly properties: {
|
|
2170
|
+
readonly id: {
|
|
2171
|
+
readonly type: "string";
|
|
2172
|
+
readonly description: "Unique identifier of the message (Mongo ObjectId).";
|
|
2173
|
+
readonly example: "60c72b2f9f1b2c001f8e4d3b";
|
|
2174
|
+
};
|
|
2175
|
+
readonly type: {
|
|
2176
|
+
readonly type: "string";
|
|
2177
|
+
readonly description: "Message type. Internal notes are filtered out of customer-facing responses.";
|
|
2178
|
+
readonly example: "customer_reply";
|
|
2179
|
+
readonly enum: readonly ["customer_reply", "agent_reply"];
|
|
2180
|
+
};
|
|
2181
|
+
readonly body: {
|
|
2182
|
+
readonly type: "string";
|
|
2183
|
+
readonly description: "Message body in markdown.";
|
|
2184
|
+
readonly example: "Thanks — that resolved it on my side.";
|
|
2185
|
+
};
|
|
2186
|
+
readonly author_first_name: {
|
|
2187
|
+
readonly type: "string";
|
|
2188
|
+
readonly description: "First name of the author. Null when not provided.";
|
|
2189
|
+
readonly example: "Jane";
|
|
2190
|
+
};
|
|
2191
|
+
readonly author_last_name: {
|
|
2192
|
+
readonly type: "string";
|
|
2193
|
+
readonly description: "Last name of the author. Null when not provided.";
|
|
2194
|
+
readonly example: "Doe";
|
|
2195
|
+
};
|
|
2196
|
+
readonly attachments: {
|
|
2197
|
+
readonly type: "array";
|
|
2198
|
+
readonly items: {
|
|
2199
|
+
readonly type: "object";
|
|
2200
|
+
readonly properties: {
|
|
2201
|
+
readonly id: {
|
|
2202
|
+
readonly type: "string";
|
|
2203
|
+
readonly description: "Unique identifier of the attachment (Mongo ObjectId).";
|
|
2204
|
+
readonly example: "60c72b2f9f1b2c001f8e4d3c";
|
|
2205
|
+
};
|
|
2206
|
+
readonly filename: {
|
|
2207
|
+
readonly type: "string";
|
|
2208
|
+
readonly description: "Original filename as uploaded.";
|
|
2209
|
+
readonly example: "debug.log";
|
|
2210
|
+
};
|
|
2211
|
+
readonly content_type: {
|
|
2212
|
+
readonly type: "string";
|
|
2213
|
+
readonly description: "MIME content type of the attachment.";
|
|
2214
|
+
readonly example: "text/plain";
|
|
2215
|
+
};
|
|
2216
|
+
readonly size: {
|
|
2217
|
+
readonly type: "integer";
|
|
2218
|
+
readonly description: "Size of the attachment in bytes.";
|
|
2219
|
+
readonly example: 12345;
|
|
2220
|
+
};
|
|
2221
|
+
};
|
|
2222
|
+
readonly required: readonly ["id", "filename", "content_type", "size"];
|
|
2223
|
+
readonly additionalProperties: false;
|
|
2224
|
+
};
|
|
2225
|
+
readonly description: "Attachments associated with this message.";
|
|
2226
|
+
readonly example: readonly [];
|
|
2227
|
+
};
|
|
2228
|
+
readonly date_created: {
|
|
2229
|
+
readonly type: "string";
|
|
2230
|
+
readonly format: "date-time";
|
|
2231
|
+
readonly description: "Creation date of the message. ISO 8601 UTC.";
|
|
2232
|
+
readonly example: "2026-05-11T16:08:14.338Z";
|
|
2233
|
+
};
|
|
2234
|
+
};
|
|
2235
|
+
readonly required: readonly ["id", "type", "body", "date_created"];
|
|
2236
|
+
readonly additionalProperties: false;
|
|
2237
|
+
};
|
|
2238
|
+
export declare const TicketSchema: {
|
|
2239
|
+
readonly type: "object";
|
|
2240
|
+
readonly properties: {
|
|
2241
|
+
readonly id: {
|
|
2242
|
+
readonly type: "string";
|
|
2243
|
+
readonly description: "Unique identifier of the ticket (Mongo ObjectId).";
|
|
2244
|
+
readonly example: "60c72b2f9f1b2c001f8e4d3a";
|
|
2245
|
+
};
|
|
2246
|
+
readonly status: {
|
|
2247
|
+
readonly type: "string";
|
|
2248
|
+
readonly description: "Current state of the ticket.";
|
|
2249
|
+
readonly example: "waiting_on_us";
|
|
2250
|
+
readonly enum: readonly ["waiting_on_us", "waiting_on_user", "closed"];
|
|
2251
|
+
};
|
|
2252
|
+
readonly category: {
|
|
2253
|
+
readonly type: "string";
|
|
2254
|
+
readonly description: "Ticket category.";
|
|
2255
|
+
readonly example: "technical";
|
|
2256
|
+
readonly enum: readonly ["billing", "technical", "general"];
|
|
2257
|
+
};
|
|
2258
|
+
readonly summary: {
|
|
2259
|
+
readonly type: "string";
|
|
2260
|
+
readonly description: "First 128 characters of the initial message body, with markdown formatting and newlines stripped. Used for ticket list previews.";
|
|
2261
|
+
readonly example: "My cluster cannot reach the registry. Logs attached.";
|
|
2262
|
+
};
|
|
2263
|
+
readonly closed_at: {
|
|
2264
|
+
readonly type: "string";
|
|
2265
|
+
readonly format: "date-time";
|
|
2266
|
+
readonly description: "Closure timestamp. Null while the ticket is open.";
|
|
2267
|
+
readonly example: "2026-05-18T16:08:14.338Z";
|
|
2268
|
+
};
|
|
2269
|
+
readonly date_created: {
|
|
2270
|
+
readonly type: "string";
|
|
2271
|
+
readonly format: "date-time";
|
|
2272
|
+
readonly description: "Creation date of the ticket. ISO 8601 UTC.";
|
|
2273
|
+
readonly example: "2026-05-11T16:08:14.338Z";
|
|
2274
|
+
};
|
|
2275
|
+
readonly date_updated: {
|
|
2276
|
+
readonly type: "string";
|
|
2277
|
+
readonly format: "date-time";
|
|
2278
|
+
readonly description: "Last update date of the ticket. ISO 8601 UTC.";
|
|
2279
|
+
readonly example: "2026-05-11T16:08:14.338Z";
|
|
2280
|
+
};
|
|
2281
|
+
readonly messages: {
|
|
2282
|
+
readonly type: "array";
|
|
2283
|
+
readonly items: {
|
|
2284
|
+
readonly type: "object";
|
|
2285
|
+
readonly properties: {
|
|
2286
|
+
readonly id: {
|
|
2287
|
+
readonly type: "string";
|
|
2288
|
+
readonly description: "Unique identifier of the message (Mongo ObjectId).";
|
|
2289
|
+
readonly example: "60c72b2f9f1b2c001f8e4d3b";
|
|
2290
|
+
};
|
|
2291
|
+
readonly type: {
|
|
2292
|
+
readonly type: "string";
|
|
2293
|
+
readonly description: "Message type. Internal notes are filtered out of customer-facing responses.";
|
|
2294
|
+
readonly example: "customer_reply";
|
|
2295
|
+
readonly enum: readonly ["customer_reply", "agent_reply"];
|
|
2296
|
+
};
|
|
2297
|
+
readonly body: {
|
|
2298
|
+
readonly type: "string";
|
|
2299
|
+
readonly description: "Message body in markdown.";
|
|
2300
|
+
readonly example: "Thanks — that resolved it on my side.";
|
|
2301
|
+
};
|
|
2302
|
+
readonly author_first_name: {
|
|
2303
|
+
readonly type: "string";
|
|
2304
|
+
readonly description: "First name of the author. Null when not provided.";
|
|
2305
|
+
readonly example: "Jane";
|
|
2306
|
+
};
|
|
2307
|
+
readonly author_last_name: {
|
|
2308
|
+
readonly type: "string";
|
|
2309
|
+
readonly description: "Last name of the author. Null when not provided.";
|
|
2310
|
+
readonly example: "Doe";
|
|
2311
|
+
};
|
|
2312
|
+
readonly attachments: {
|
|
2313
|
+
readonly type: "array";
|
|
2314
|
+
readonly items: {
|
|
2315
|
+
readonly type: "object";
|
|
2316
|
+
readonly properties: {
|
|
2317
|
+
readonly id: {
|
|
2318
|
+
readonly type: "string";
|
|
2319
|
+
readonly description: "Unique identifier of the attachment (Mongo ObjectId).";
|
|
2320
|
+
readonly example: "60c72b2f9f1b2c001f8e4d3c";
|
|
2321
|
+
};
|
|
2322
|
+
readonly filename: {
|
|
2323
|
+
readonly type: "string";
|
|
2324
|
+
readonly description: "Original filename as uploaded.";
|
|
2325
|
+
readonly example: "debug.log";
|
|
2326
|
+
};
|
|
2327
|
+
readonly content_type: {
|
|
2328
|
+
readonly type: "string";
|
|
2329
|
+
readonly description: "MIME content type of the attachment.";
|
|
2330
|
+
readonly example: "text/plain";
|
|
2331
|
+
};
|
|
2332
|
+
readonly size: {
|
|
2333
|
+
readonly type: "integer";
|
|
2334
|
+
readonly description: "Size of the attachment in bytes.";
|
|
2335
|
+
readonly example: 12345;
|
|
2336
|
+
};
|
|
2337
|
+
};
|
|
2338
|
+
readonly required: readonly ["id", "filename", "content_type", "size"];
|
|
2339
|
+
readonly additionalProperties: false;
|
|
2340
|
+
};
|
|
2341
|
+
readonly description: "Attachments associated with this message.";
|
|
2342
|
+
readonly example: readonly [];
|
|
2343
|
+
};
|
|
2344
|
+
readonly date_created: {
|
|
2345
|
+
readonly type: "string";
|
|
2346
|
+
readonly format: "date-time";
|
|
2347
|
+
readonly description: "Creation date of the message. ISO 8601 UTC.";
|
|
2348
|
+
readonly example: "2026-05-11T16:08:14.338Z";
|
|
2349
|
+
};
|
|
2350
|
+
};
|
|
2351
|
+
readonly required: readonly ["id", "type", "body", "date_created"];
|
|
2352
|
+
readonly additionalProperties: false;
|
|
2353
|
+
};
|
|
2354
|
+
readonly description: "Messages on the ticket in chronological order. Internal notes are excluded. Returned by the detail endpoint only.";
|
|
2355
|
+
};
|
|
2356
|
+
};
|
|
2357
|
+
readonly required: readonly ["id", "status", "category", "summary", "date_created", "date_updated"];
|
|
2358
|
+
readonly additionalProperties: false;
|
|
2359
|
+
};
|
|
1464
2360
|
export declare const TokenCreateInputSchema: {
|
|
1465
2361
|
readonly type: "object";
|
|
1466
2362
|
readonly properties: {
|
|
@@ -1707,18 +2603,6 @@ export declare const UserCreateInputSchema: {
|
|
|
1707
2603
|
readonly minLength: 8;
|
|
1708
2604
|
readonly description: "User password. Must be at least 8 characters long.";
|
|
1709
2605
|
};
|
|
1710
|
-
readonly status: {
|
|
1711
|
-
readonly type: "string";
|
|
1712
|
-
readonly description: "Status of the user. Can be `active` or `inactive`. Inactive users cannot log in or manage organization resources.";
|
|
1713
|
-
readonly example: "active";
|
|
1714
|
-
readonly enum: readonly ["active", "inactive"];
|
|
1715
|
-
};
|
|
1716
|
-
readonly role: {
|
|
1717
|
-
readonly type: "string";
|
|
1718
|
-
readonly description: "User role. Can be 'Administrator', 'User'.";
|
|
1719
|
-
readonly example: "User";
|
|
1720
|
-
readonly enum: readonly ["Administrator", "User"];
|
|
1721
|
-
};
|
|
1722
2606
|
};
|
|
1723
2607
|
readonly required: readonly ["email", "first_name", "last_name", "code", "password"];
|
|
1724
2608
|
readonly additionalProperties: false;
|