@cloudfleet/sdk 0.0.1-91321da → 0.0.1-958f27d
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 +47 -23
- package/dist/@tanstack/react-query.gen.d.ts.map +1 -1
- package/dist/@tanstack/react-query.gen.js +54 -18
- package/dist/@tanstack/react-query.gen.js.map +1 -1
- package/dist/schemas.gen.d.ts +313 -92
- package/dist/schemas.gen.d.ts.map +1 -1
- package/dist/schemas.gen.js +1067 -151
- package/dist/schemas.gen.js.map +1 -1
- package/dist/sdk.gen.d.ts +28 -16
- package/dist/sdk.gen.d.ts.map +1 -1
- package/dist/sdk.gen.js +32 -16
- package/dist/sdk.gen.js.map +1 -1
- package/dist/types.gen.d.ts +292 -89
- package/dist/types.gen.d.ts.map +1 -1
- package/dist/zod.gen.d.ts +1858 -201
- package/dist/zod.gen.d.ts.map +1 -1
- package/dist/zod.gen.js +783 -88
- package/dist/zod.gen.js.map +1 -1
- package/package.json +1 -1
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";
|
|
@@ -275,10 +280,8 @@ export declare const ClusterCreateInputSchema: {
|
|
|
275
280
|
};
|
|
276
281
|
readonly region: {
|
|
277
282
|
readonly type: "string";
|
|
278
|
-
readonly description: "Cloudfleet control plane region.
|
|
279
|
-
readonly
|
|
280
|
-
readonly example: "northamerica-central-1a";
|
|
281
|
-
readonly enum: readonly ["staging-1a", "northamerica-central-1", "europe-central-1a", "northamerica-central-1a"];
|
|
283
|
+
readonly description: "Cloudfleet control plane region. This field can not be updated after creation.";
|
|
284
|
+
readonly example: "europe-central-1a";
|
|
282
285
|
};
|
|
283
286
|
readonly version_channel: {
|
|
284
287
|
readonly type: "string";
|
|
@@ -286,10 +289,9 @@ export declare const ClusterCreateInputSchema: {
|
|
|
286
289
|
readonly description: "Version of the kubernetes cluster.";
|
|
287
290
|
readonly default: "1.x.x-cfke.x";
|
|
288
291
|
readonly example: "1.x.x-cfke.x";
|
|
289
|
-
readonly enum: readonly ["1.x.x-cfke.x", "1.31.x-cfke.x", "1.32.x-cfke.x", "1.33.x-cfke.x"];
|
|
290
292
|
};
|
|
291
293
|
};
|
|
292
|
-
readonly required: readonly ["name", "tier"];
|
|
294
|
+
readonly required: readonly ["name", "tier", "region"];
|
|
293
295
|
readonly additionalProperties: false;
|
|
294
296
|
};
|
|
295
297
|
export declare const ClusterJoinInformationSchema: {
|
|
@@ -311,6 +313,11 @@ export declare const ClusterJoinInformationSchema: {
|
|
|
311
313
|
readonly description: "Cluster DNS IP address. This is the IP address of the kube-dns service in the cluster.";
|
|
312
314
|
readonly example: "10.96.0.10";
|
|
313
315
|
};
|
|
316
|
+
readonly pod_cidr: {
|
|
317
|
+
readonly type: "string";
|
|
318
|
+
readonly description: "Pod CIDR for the cluster. Used to configure iptables rules on nodes to prevent Tailscale routing loops.";
|
|
319
|
+
readonly example: "10.244.0.0/16";
|
|
320
|
+
};
|
|
314
321
|
readonly auth_key: {
|
|
315
322
|
readonly type: "string";
|
|
316
323
|
readonly description: "Authentication key for the cluster.";
|
|
@@ -373,7 +380,7 @@ export declare const ClusterJoinInformationSchema: {
|
|
|
373
380
|
readonly description: "OIDC Information for hosts to access to third party API's.";
|
|
374
381
|
};
|
|
375
382
|
};
|
|
376
|
-
readonly required: readonly ["certificate_authority", "endpoint", "cluster_dns", "auth_key", "bootstrap_token", "versions", "third_party_api_access_config"];
|
|
383
|
+
readonly required: readonly ["certificate_authority", "endpoint", "cluster_dns", "pod_cidr", "auth_key", "bootstrap_token", "versions", "third_party_api_access_config"];
|
|
377
384
|
readonly additionalProperties: false;
|
|
378
385
|
};
|
|
379
386
|
export declare const ClusterSchema: {
|
|
@@ -395,10 +402,8 @@ export declare const ClusterSchema: {
|
|
|
395
402
|
};
|
|
396
403
|
readonly region: {
|
|
397
404
|
readonly type: "string";
|
|
398
|
-
readonly description: "Cloudfleet control plane region.
|
|
399
|
-
readonly
|
|
400
|
-
readonly example: "northamerica-central-1a";
|
|
401
|
-
readonly enum: readonly ["staging-1a", "northamerica-central-1", "europe-central-1a", "northamerica-central-1a"];
|
|
405
|
+
readonly description: "Cloudfleet control plane region. This field can not be updated after creation.";
|
|
406
|
+
readonly example: "europe-central-1a";
|
|
402
407
|
};
|
|
403
408
|
readonly id: {
|
|
404
409
|
readonly type: "string";
|
|
@@ -466,7 +471,7 @@ export declare const ClusterSchema: {
|
|
|
466
471
|
readonly example: "1.x.x-cfke.x";
|
|
467
472
|
};
|
|
468
473
|
};
|
|
469
|
-
readonly required: readonly ["name", "tier", "id", "status"];
|
|
474
|
+
readonly required: readonly ["name", "tier", "region", "id", "status"];
|
|
470
475
|
readonly additionalProperties: false;
|
|
471
476
|
};
|
|
472
477
|
export declare const ClusterUpdateInputSchema: {
|
|
@@ -503,13 +508,12 @@ export declare const FleetCreateInputSchema: {
|
|
|
503
508
|
readonly type: "object";
|
|
504
509
|
readonly properties: {
|
|
505
510
|
readonly cpu: {
|
|
506
|
-
readonly type: "
|
|
507
|
-
readonly format: "float";
|
|
511
|
+
readonly type: "integer";
|
|
508
512
|
readonly minimum: 0;
|
|
509
|
-
readonly
|
|
513
|
+
readonly maximum: 100000;
|
|
514
|
+
readonly description: "CPU limit in cores. Maximum 100,000.";
|
|
510
515
|
};
|
|
511
516
|
};
|
|
512
|
-
readonly required: readonly ["cpu"];
|
|
513
517
|
readonly additionalProperties: false;
|
|
514
518
|
readonly description: "Limits define a set of bounds for provisioning capacity.";
|
|
515
519
|
};
|
|
@@ -518,14 +522,15 @@ export declare const FleetCreateInputSchema: {
|
|
|
518
522
|
readonly properties: {
|
|
519
523
|
readonly enabled: {
|
|
520
524
|
readonly type: "boolean";
|
|
521
|
-
readonly default: true;
|
|
522
525
|
};
|
|
523
526
|
readonly project: {
|
|
524
527
|
readonly type: "string";
|
|
525
|
-
readonly
|
|
528
|
+
readonly pattern: "^[a-z][a-z0-9-]{4,28}[a-z0-9]$";
|
|
529
|
+
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.";
|
|
530
|
+
readonly example: "my-cloudfleet-project";
|
|
526
531
|
};
|
|
527
532
|
};
|
|
528
|
-
readonly required: readonly ["
|
|
533
|
+
readonly required: readonly ["enabled"];
|
|
529
534
|
readonly additionalProperties: false;
|
|
530
535
|
};
|
|
531
536
|
readonly hetzner: {
|
|
@@ -533,14 +538,16 @@ export declare const FleetCreateInputSchema: {
|
|
|
533
538
|
readonly properties: {
|
|
534
539
|
readonly enabled: {
|
|
535
540
|
readonly type: "boolean";
|
|
536
|
-
readonly default: true;
|
|
537
541
|
};
|
|
538
542
|
readonly apiKey: {
|
|
539
543
|
readonly type: "string";
|
|
540
|
-
readonly
|
|
544
|
+
readonly maxLength: 64;
|
|
545
|
+
readonly minLength: 64;
|
|
546
|
+
readonly pattern: "^[A-Za-z0-9]+$";
|
|
547
|
+
readonly description: "Hetzner Cloud API token with read / write access (64 alphanumeric characters). Omit this field to keep the existing value.";
|
|
541
548
|
};
|
|
542
549
|
};
|
|
543
|
-
readonly required: readonly ["
|
|
550
|
+
readonly required: readonly ["enabled"];
|
|
544
551
|
readonly additionalProperties: false;
|
|
545
552
|
};
|
|
546
553
|
readonly aws: {
|
|
@@ -548,16 +555,67 @@ export declare const FleetCreateInputSchema: {
|
|
|
548
555
|
readonly properties: {
|
|
549
556
|
readonly enabled: {
|
|
550
557
|
readonly type: "boolean";
|
|
551
|
-
readonly default: true;
|
|
552
558
|
};
|
|
553
559
|
readonly controllerRoleArn: {
|
|
554
560
|
readonly type: "string";
|
|
555
|
-
readonly
|
|
561
|
+
readonly pattern: "^arn:aws(-[a-z]+)*:iam::\\d{12}:role\\/[\\w+=,.@/-]+$";
|
|
562
|
+
readonly description: "AWS IAM role ARN that Karpenter uses to manage resources. Omit when AWS is disabled.";
|
|
563
|
+
readonly example: "arn:aws:iam::123456789012:role/Cloudfleet";
|
|
556
564
|
};
|
|
557
565
|
};
|
|
558
|
-
readonly required: readonly ["
|
|
566
|
+
readonly required: readonly ["enabled"];
|
|
559
567
|
readonly additionalProperties: false;
|
|
560
568
|
};
|
|
569
|
+
readonly constraints: {
|
|
570
|
+
readonly type: "object";
|
|
571
|
+
readonly properties: {
|
|
572
|
+
readonly 'karpenter.sh/capacity-type': {
|
|
573
|
+
readonly type: "array";
|
|
574
|
+
readonly items: {
|
|
575
|
+
readonly type: "string";
|
|
576
|
+
readonly enum: readonly ["on-demand", "spot"];
|
|
577
|
+
};
|
|
578
|
+
readonly minItems: 1;
|
|
579
|
+
readonly description: "Allowed values for `karpenter.sh/capacity-type`.";
|
|
580
|
+
readonly default: readonly ["on-demand", "spot"];
|
|
581
|
+
};
|
|
582
|
+
readonly 'kubernetes.io/arch': {
|
|
583
|
+
readonly type: "array";
|
|
584
|
+
readonly items: {
|
|
585
|
+
readonly type: "string";
|
|
586
|
+
readonly enum: readonly ["amd64", "arm64"];
|
|
587
|
+
};
|
|
588
|
+
readonly minItems: 1;
|
|
589
|
+
readonly description: "Allowed values for `kubernetes.io/arch`.";
|
|
590
|
+
readonly default: readonly ["amd64"];
|
|
591
|
+
};
|
|
592
|
+
readonly 'cfke.io/instance-family': {
|
|
593
|
+
readonly type: "array";
|
|
594
|
+
readonly items: {
|
|
595
|
+
readonly type: "string";
|
|
596
|
+
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"];
|
|
597
|
+
};
|
|
598
|
+
readonly description: "Allowed values for `cfke.io/instance-family`.";
|
|
599
|
+
};
|
|
600
|
+
readonly 'topology.kubernetes.io/region': {
|
|
601
|
+
readonly type: "array";
|
|
602
|
+
readonly items: {
|
|
603
|
+
readonly type: "string";
|
|
604
|
+
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"];
|
|
605
|
+
};
|
|
606
|
+
readonly description: "Allowed values for `topology.kubernetes.io/region`.";
|
|
607
|
+
};
|
|
608
|
+
};
|
|
609
|
+
readonly additionalProperties: false;
|
|
610
|
+
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.";
|
|
611
|
+
};
|
|
612
|
+
readonly scalingProfile: {
|
|
613
|
+
readonly type: "string";
|
|
614
|
+
readonly description: "Controls scale-up / scale-down responsiveness. `aggressive` prioritizes cost-optimization. `conservative` prioritizes stability of the fleet.";
|
|
615
|
+
readonly default: "conservative";
|
|
616
|
+
readonly example: "conservative";
|
|
617
|
+
readonly enum: readonly ["aggressive", "conservative"];
|
|
618
|
+
};
|
|
561
619
|
readonly id: {
|
|
562
620
|
readonly type: "string";
|
|
563
621
|
readonly maxLength: 63;
|
|
@@ -577,13 +635,12 @@ export declare const FleetSchema: {
|
|
|
577
635
|
readonly type: "object";
|
|
578
636
|
readonly properties: {
|
|
579
637
|
readonly cpu: {
|
|
580
|
-
readonly type: "
|
|
581
|
-
readonly format: "float";
|
|
638
|
+
readonly type: "integer";
|
|
582
639
|
readonly minimum: 0;
|
|
583
|
-
readonly
|
|
640
|
+
readonly maximum: 100000;
|
|
641
|
+
readonly description: "CPU limit in cores. Maximum 100,000.";
|
|
584
642
|
};
|
|
585
643
|
};
|
|
586
|
-
readonly required: readonly ["cpu"];
|
|
587
644
|
readonly additionalProperties: false;
|
|
588
645
|
readonly description: "Limits define a set of bounds for provisioning capacity.";
|
|
589
646
|
};
|
|
@@ -592,14 +649,15 @@ export declare const FleetSchema: {
|
|
|
592
649
|
readonly properties: {
|
|
593
650
|
readonly enabled: {
|
|
594
651
|
readonly type: "boolean";
|
|
595
|
-
readonly default: true;
|
|
596
652
|
};
|
|
597
653
|
readonly project: {
|
|
598
654
|
readonly type: "string";
|
|
599
|
-
readonly
|
|
655
|
+
readonly pattern: "^[a-z][a-z0-9-]{4,28}[a-z0-9]$";
|
|
656
|
+
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.";
|
|
657
|
+
readonly example: "my-cloudfleet-project";
|
|
600
658
|
};
|
|
601
659
|
};
|
|
602
|
-
readonly required: readonly ["
|
|
660
|
+
readonly required: readonly ["enabled"];
|
|
603
661
|
readonly additionalProperties: false;
|
|
604
662
|
};
|
|
605
663
|
readonly hetzner: {
|
|
@@ -607,14 +665,14 @@ export declare const FleetSchema: {
|
|
|
607
665
|
readonly properties: {
|
|
608
666
|
readonly enabled: {
|
|
609
667
|
readonly type: "boolean";
|
|
610
|
-
readonly default: true;
|
|
611
668
|
};
|
|
612
669
|
readonly apiKey: {
|
|
613
670
|
readonly type: "string";
|
|
614
|
-
readonly
|
|
671
|
+
readonly pattern: "^\\*{64}$";
|
|
672
|
+
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.";
|
|
615
673
|
};
|
|
616
674
|
};
|
|
617
|
-
readonly required: readonly ["
|
|
675
|
+
readonly required: readonly ["enabled"];
|
|
618
676
|
readonly additionalProperties: false;
|
|
619
677
|
};
|
|
620
678
|
readonly aws: {
|
|
@@ -622,15 +680,66 @@ export declare const FleetSchema: {
|
|
|
622
680
|
readonly properties: {
|
|
623
681
|
readonly enabled: {
|
|
624
682
|
readonly type: "boolean";
|
|
625
|
-
readonly default: true;
|
|
626
683
|
};
|
|
627
684
|
readonly controllerRoleArn: {
|
|
628
685
|
readonly type: "string";
|
|
629
|
-
readonly
|
|
686
|
+
readonly pattern: "^arn:aws(-[a-z]+)*:iam::\\d{12}:role\\/[\\w+=,.@/-]+$";
|
|
687
|
+
readonly description: "AWS IAM role ARN that Karpenter uses to manage resources. Omit when AWS is disabled.";
|
|
688
|
+
readonly example: "arn:aws:iam::123456789012:role/Cloudfleet";
|
|
689
|
+
};
|
|
690
|
+
};
|
|
691
|
+
readonly required: readonly ["enabled"];
|
|
692
|
+
readonly additionalProperties: false;
|
|
693
|
+
};
|
|
694
|
+
readonly constraints: {
|
|
695
|
+
readonly type: "object";
|
|
696
|
+
readonly properties: {
|
|
697
|
+
readonly 'karpenter.sh/capacity-type': {
|
|
698
|
+
readonly type: "array";
|
|
699
|
+
readonly items: {
|
|
700
|
+
readonly type: "string";
|
|
701
|
+
readonly enum: readonly ["on-demand", "spot"];
|
|
702
|
+
};
|
|
703
|
+
readonly minItems: 1;
|
|
704
|
+
readonly description: "Allowed values for `karpenter.sh/capacity-type`.";
|
|
705
|
+
readonly default: readonly ["on-demand", "spot"];
|
|
706
|
+
};
|
|
707
|
+
readonly 'kubernetes.io/arch': {
|
|
708
|
+
readonly type: "array";
|
|
709
|
+
readonly items: {
|
|
710
|
+
readonly type: "string";
|
|
711
|
+
readonly enum: readonly ["amd64", "arm64"];
|
|
712
|
+
};
|
|
713
|
+
readonly minItems: 1;
|
|
714
|
+
readonly description: "Allowed values for `kubernetes.io/arch`.";
|
|
715
|
+
readonly default: readonly ["amd64"];
|
|
716
|
+
};
|
|
717
|
+
readonly 'cfke.io/instance-family': {
|
|
718
|
+
readonly type: "array";
|
|
719
|
+
readonly items: {
|
|
720
|
+
readonly type: "string";
|
|
721
|
+
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"];
|
|
722
|
+
};
|
|
723
|
+
readonly description: "Allowed values for `cfke.io/instance-family`.";
|
|
724
|
+
};
|
|
725
|
+
readonly 'topology.kubernetes.io/region': {
|
|
726
|
+
readonly type: "array";
|
|
727
|
+
readonly items: {
|
|
728
|
+
readonly type: "string";
|
|
729
|
+
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"];
|
|
730
|
+
};
|
|
731
|
+
readonly description: "Allowed values for `topology.kubernetes.io/region`.";
|
|
630
732
|
};
|
|
631
733
|
};
|
|
632
|
-
readonly required: readonly ["controllerRoleArn"];
|
|
633
734
|
readonly additionalProperties: false;
|
|
735
|
+
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.";
|
|
736
|
+
};
|
|
737
|
+
readonly scalingProfile: {
|
|
738
|
+
readonly type: "string";
|
|
739
|
+
readonly description: "Controls scale-up / scale-down responsiveness. `aggressive` prioritizes cost-optimization. `conservative` prioritizes stability of the fleet.";
|
|
740
|
+
readonly default: "conservative";
|
|
741
|
+
readonly example: "conservative";
|
|
742
|
+
readonly enum: readonly ["aggressive", "conservative"];
|
|
634
743
|
};
|
|
635
744
|
readonly id: {
|
|
636
745
|
readonly type: "string";
|
|
@@ -641,7 +750,7 @@ export declare const FleetSchema: {
|
|
|
641
750
|
readonly example: "new-clouds-fleet";
|
|
642
751
|
};
|
|
643
752
|
};
|
|
644
|
-
readonly required: readonly ["id"];
|
|
753
|
+
readonly required: readonly ["scalingProfile", "id"];
|
|
645
754
|
readonly additionalProperties: false;
|
|
646
755
|
};
|
|
647
756
|
export declare const FleetUpdateInputSchema: {
|
|
@@ -651,13 +760,12 @@ export declare const FleetUpdateInputSchema: {
|
|
|
651
760
|
readonly type: "object";
|
|
652
761
|
readonly properties: {
|
|
653
762
|
readonly cpu: {
|
|
654
|
-
readonly type: "
|
|
655
|
-
readonly format: "float";
|
|
763
|
+
readonly type: "integer";
|
|
656
764
|
readonly minimum: 0;
|
|
657
|
-
readonly
|
|
765
|
+
readonly maximum: 100000;
|
|
766
|
+
readonly description: "CPU limit in cores. Maximum 100,000.";
|
|
658
767
|
};
|
|
659
768
|
};
|
|
660
|
-
readonly required: readonly ["cpu"];
|
|
661
769
|
readonly additionalProperties: false;
|
|
662
770
|
readonly description: "Limits define a set of bounds for provisioning capacity.";
|
|
663
771
|
};
|
|
@@ -666,14 +774,15 @@ export declare const FleetUpdateInputSchema: {
|
|
|
666
774
|
readonly properties: {
|
|
667
775
|
readonly enabled: {
|
|
668
776
|
readonly type: "boolean";
|
|
669
|
-
readonly default: true;
|
|
670
777
|
};
|
|
671
778
|
readonly project: {
|
|
672
779
|
readonly type: "string";
|
|
673
|
-
readonly
|
|
780
|
+
readonly pattern: "^[a-z][a-z0-9-]{4,28}[a-z0-9]$";
|
|
781
|
+
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.";
|
|
782
|
+
readonly example: "my-cloudfleet-project";
|
|
674
783
|
};
|
|
675
784
|
};
|
|
676
|
-
readonly required: readonly ["
|
|
785
|
+
readonly required: readonly ["enabled"];
|
|
677
786
|
readonly additionalProperties: false;
|
|
678
787
|
};
|
|
679
788
|
readonly hetzner: {
|
|
@@ -681,14 +790,16 @@ export declare const FleetUpdateInputSchema: {
|
|
|
681
790
|
readonly properties: {
|
|
682
791
|
readonly enabled: {
|
|
683
792
|
readonly type: "boolean";
|
|
684
|
-
readonly default: true;
|
|
685
793
|
};
|
|
686
794
|
readonly apiKey: {
|
|
687
795
|
readonly type: "string";
|
|
688
|
-
readonly
|
|
796
|
+
readonly maxLength: 64;
|
|
797
|
+
readonly minLength: 64;
|
|
798
|
+
readonly pattern: "^[A-Za-z0-9]+$";
|
|
799
|
+
readonly description: "Hetzner Cloud API token with read / write access (64 alphanumeric characters). Omit this field to keep the existing value.";
|
|
689
800
|
};
|
|
690
801
|
};
|
|
691
|
-
readonly required: readonly ["
|
|
802
|
+
readonly required: readonly ["enabled"];
|
|
692
803
|
readonly additionalProperties: false;
|
|
693
804
|
};
|
|
694
805
|
readonly aws: {
|
|
@@ -696,17 +807,86 @@ export declare const FleetUpdateInputSchema: {
|
|
|
696
807
|
readonly properties: {
|
|
697
808
|
readonly enabled: {
|
|
698
809
|
readonly type: "boolean";
|
|
699
|
-
readonly default: true;
|
|
700
810
|
};
|
|
701
811
|
readonly controllerRoleArn: {
|
|
702
812
|
readonly type: "string";
|
|
703
|
-
readonly
|
|
813
|
+
readonly pattern: "^arn:aws(-[a-z]+)*:iam::\\d{12}:role\\/[\\w+=,.@/-]+$";
|
|
814
|
+
readonly description: "AWS IAM role ARN that Karpenter uses to manage resources. Omit when AWS is disabled.";
|
|
815
|
+
readonly example: "arn:aws:iam::123456789012:role/Cloudfleet";
|
|
816
|
+
};
|
|
817
|
+
};
|
|
818
|
+
readonly required: readonly ["enabled"];
|
|
819
|
+
readonly additionalProperties: false;
|
|
820
|
+
};
|
|
821
|
+
readonly constraints: {
|
|
822
|
+
readonly type: "object";
|
|
823
|
+
readonly properties: {
|
|
824
|
+
readonly 'karpenter.sh/capacity-type': {
|
|
825
|
+
readonly type: "array";
|
|
826
|
+
readonly items: {
|
|
827
|
+
readonly type: "string";
|
|
828
|
+
readonly enum: readonly ["on-demand", "spot"];
|
|
829
|
+
};
|
|
830
|
+
readonly minItems: 1;
|
|
831
|
+
readonly description: "Allowed values for `karpenter.sh/capacity-type`.";
|
|
832
|
+
};
|
|
833
|
+
readonly 'kubernetes.io/arch': {
|
|
834
|
+
readonly type: "array";
|
|
835
|
+
readonly items: {
|
|
836
|
+
readonly type: "string";
|
|
837
|
+
readonly enum: readonly ["amd64", "arm64"];
|
|
838
|
+
};
|
|
839
|
+
readonly minItems: 1;
|
|
840
|
+
readonly description: "Allowed values for `kubernetes.io/arch`.";
|
|
841
|
+
};
|
|
842
|
+
readonly 'cfke.io/instance-family': {
|
|
843
|
+
readonly type: "array";
|
|
844
|
+
readonly items: {
|
|
845
|
+
readonly type: "string";
|
|
846
|
+
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"];
|
|
847
|
+
};
|
|
848
|
+
readonly description: "Allowed values for `cfke.io/instance-family`.";
|
|
849
|
+
};
|
|
850
|
+
readonly 'topology.kubernetes.io/region': {
|
|
851
|
+
readonly type: "array";
|
|
852
|
+
readonly items: {
|
|
853
|
+
readonly type: "string";
|
|
854
|
+
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"];
|
|
855
|
+
};
|
|
856
|
+
readonly description: "Allowed values for `topology.kubernetes.io/region`.";
|
|
704
857
|
};
|
|
705
858
|
};
|
|
706
|
-
readonly required: readonly ["controllerRoleArn"];
|
|
707
859
|
readonly additionalProperties: false;
|
|
860
|
+
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.";
|
|
861
|
+
};
|
|
862
|
+
readonly scalingProfile: {
|
|
863
|
+
readonly type: "string";
|
|
864
|
+
readonly description: "Controls scale-up / scale-down responsiveness. `aggressive` prioritizes cost-optimization. `conservative` prioritizes stability of the fleet.";
|
|
865
|
+
readonly example: "conservative";
|
|
866
|
+
readonly enum: readonly ["aggressive", "conservative"];
|
|
708
867
|
};
|
|
709
868
|
};
|
|
869
|
+
readonly required: readonly ["scalingProfile"];
|
|
870
|
+
readonly additionalProperties: false;
|
|
871
|
+
};
|
|
872
|
+
export declare const InviteCreateInputSchema: {
|
|
873
|
+
readonly type: "object";
|
|
874
|
+
readonly properties: {
|
|
875
|
+
readonly email: {
|
|
876
|
+
readonly type: "string";
|
|
877
|
+
readonly format: "email";
|
|
878
|
+
readonly description: "Email address of the user to invite.";
|
|
879
|
+
readonly example: "email@example.com";
|
|
880
|
+
};
|
|
881
|
+
readonly role: {
|
|
882
|
+
readonly type: "string";
|
|
883
|
+
readonly description: "Role the invited user will be assigned on redemption. Can be 'Administrator' or 'User'.";
|
|
884
|
+
readonly default: "User";
|
|
885
|
+
readonly example: "User";
|
|
886
|
+
readonly enum: readonly ["Administrator", "User"];
|
|
887
|
+
};
|
|
888
|
+
};
|
|
889
|
+
readonly required: readonly ["email"];
|
|
710
890
|
readonly additionalProperties: false;
|
|
711
891
|
};
|
|
712
892
|
export declare const InviteSchema: {
|
|
@@ -740,6 +920,13 @@ export declare const InviteSchema: {
|
|
|
740
920
|
readonly description: "Generated unique invite code.";
|
|
741
921
|
readonly example: "7kUZnH7nnKUFfvc4NK2KQF";
|
|
742
922
|
};
|
|
923
|
+
readonly role: {
|
|
924
|
+
readonly type: "string";
|
|
925
|
+
readonly description: "Role the invited user will be assigned on redemption. Can be 'Administrator' or 'User'.";
|
|
926
|
+
readonly default: "User";
|
|
927
|
+
readonly example: "User";
|
|
928
|
+
readonly enum: readonly ["Administrator", "User"];
|
|
929
|
+
};
|
|
743
930
|
};
|
|
744
931
|
readonly required: readonly ["date_created"];
|
|
745
932
|
readonly additionalProperties: false;
|
|
@@ -937,6 +1124,12 @@ export declare const MarketplaceListingSchema: {
|
|
|
937
1124
|
export declare const OrganizationCreateInputSchema: {
|
|
938
1125
|
readonly type: "object";
|
|
939
1126
|
readonly properties: {
|
|
1127
|
+
readonly type: {
|
|
1128
|
+
readonly type: "string";
|
|
1129
|
+
readonly description: "Type of the organization. `business` for legal entities, `personal` for individuals.";
|
|
1130
|
+
readonly example: "business";
|
|
1131
|
+
readonly enum: readonly ["business", "personal"];
|
|
1132
|
+
};
|
|
940
1133
|
readonly email: {
|
|
941
1134
|
readonly type: "string";
|
|
942
1135
|
readonly format: "email";
|
|
@@ -945,11 +1138,13 @@ export declare const OrganizationCreateInputSchema: {
|
|
|
945
1138
|
};
|
|
946
1139
|
readonly first_name: {
|
|
947
1140
|
readonly type: "string";
|
|
1141
|
+
readonly minLength: 1;
|
|
948
1142
|
readonly description: "First name of the billing contact person.";
|
|
949
1143
|
readonly example: "John";
|
|
950
1144
|
};
|
|
951
1145
|
readonly last_name: {
|
|
952
1146
|
readonly type: "string";
|
|
1147
|
+
readonly minLength: 1;
|
|
953
1148
|
readonly description: "Last name of the billing contact person.";
|
|
954
1149
|
readonly example: "Doe";
|
|
955
1150
|
};
|
|
@@ -967,7 +1162,19 @@ export declare const OrganizationCreateInputSchema: {
|
|
|
967
1162
|
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.";
|
|
968
1163
|
};
|
|
969
1164
|
};
|
|
970
|
-
readonly required: readonly ["email", "first_name", "last_name", "company_name", "password"];
|
|
1165
|
+
readonly required: readonly ["type", "email", "first_name", "last_name", "company_name", "password"];
|
|
1166
|
+
readonly additionalProperties: false;
|
|
1167
|
+
};
|
|
1168
|
+
export declare const OrganizationCreateOutputSchema: {
|
|
1169
|
+
readonly type: "object";
|
|
1170
|
+
readonly properties: {
|
|
1171
|
+
readonly id: {
|
|
1172
|
+
readonly type: "string";
|
|
1173
|
+
readonly description: "Unique identifier of the newly created organization. Generated by the API and safe to use for client-side tracking immediately.";
|
|
1174
|
+
readonly example: "organization-id";
|
|
1175
|
+
};
|
|
1176
|
+
};
|
|
1177
|
+
readonly required: readonly ["id"];
|
|
971
1178
|
readonly additionalProperties: false;
|
|
972
1179
|
};
|
|
973
1180
|
export declare const OrganizationSchema: {
|
|
@@ -986,6 +1193,12 @@ export declare const OrganizationSchema: {
|
|
|
986
1193
|
readonly description: "Name of the legal entity. This name will be used in invoices. Use your first and last name for individual accounts.";
|
|
987
1194
|
readonly example: "ACME Corp.";
|
|
988
1195
|
};
|
|
1196
|
+
readonly type: {
|
|
1197
|
+
readonly type: "string";
|
|
1198
|
+
readonly description: "Type of the organization. `business` for legal entities, `personal` for individuals.";
|
|
1199
|
+
readonly example: "business";
|
|
1200
|
+
readonly enum: readonly ["business", "personal"];
|
|
1201
|
+
};
|
|
989
1202
|
readonly date_created: {
|
|
990
1203
|
readonly type: "string";
|
|
991
1204
|
readonly format: "date-time";
|
|
@@ -1036,7 +1249,7 @@ export declare const OrganizationSchema: {
|
|
|
1036
1249
|
readonly type: "array";
|
|
1037
1250
|
readonly items: {
|
|
1038
1251
|
readonly type: "string";
|
|
1039
|
-
readonly example: "northamerica-central-
|
|
1252
|
+
readonly example: "northamerica-central-1a";
|
|
1040
1253
|
};
|
|
1041
1254
|
readonly minItems: 1;
|
|
1042
1255
|
readonly description: "List of Cloudfleet control plane regions available for the organization.";
|
|
@@ -1079,8 +1292,14 @@ export declare const OrganizationSchema: {
|
|
|
1079
1292
|
readonly description: "Status of the organization. Can be `active` or `closed`, or `suspended`.";
|
|
1080
1293
|
readonly enum: readonly ["active", "closed", "suspended"];
|
|
1081
1294
|
};
|
|
1295
|
+
readonly verification: {
|
|
1296
|
+
readonly type: "string";
|
|
1297
|
+
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.";
|
|
1298
|
+
readonly example: "verified";
|
|
1299
|
+
readonly enum: readonly ["none", "submitted", "verified"];
|
|
1300
|
+
};
|
|
1082
1301
|
};
|
|
1083
|
-
readonly required: readonly ["id", "date_created", "quota", "status"];
|
|
1302
|
+
readonly required: readonly ["id", "type", "date_created", "quota", "status", "verification"];
|
|
1084
1303
|
readonly additionalProperties: false;
|
|
1085
1304
|
};
|
|
1086
1305
|
export declare const PaymentMethodSchema: {
|
|
@@ -1088,26 +1307,19 @@ export declare const PaymentMethodSchema: {
|
|
|
1088
1307
|
readonly properties: {
|
|
1089
1308
|
readonly id: {
|
|
1090
1309
|
readonly type: "string";
|
|
1091
|
-
readonly
|
|
1092
|
-
readonly
|
|
1093
|
-
readonly example: "e94d30ec-a2dd-4dcb-832c-ac2be144ba91";
|
|
1094
|
-
};
|
|
1095
|
-
readonly setup: {
|
|
1096
|
-
readonly type: "boolean";
|
|
1097
|
-
readonly description: "Whether organization payment method was set up and ready to use for payments.";
|
|
1098
|
-
readonly example: true;
|
|
1310
|
+
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.";
|
|
1311
|
+
readonly example: "pm_1MtwBwLkdIwHu7ix28a3tqPa";
|
|
1099
1312
|
};
|
|
1100
1313
|
readonly type: {
|
|
1101
1314
|
readonly type: "string";
|
|
1102
|
-
readonly
|
|
1103
|
-
readonly description: "Payment method type type. Only `card` payments supported at the moment.";
|
|
1315
|
+
readonly description: "Payment method type. `card`, `sepa_debit` for SEPA Direct Debit (business accounts only), or `bank_transfer` for paying invoices by bank transfer.";
|
|
1104
1316
|
readonly example: "card";
|
|
1105
|
-
readonly enum: readonly ["card"];
|
|
1317
|
+
readonly enum: readonly ["card", "sepa_debit", "bank_transfer"];
|
|
1106
1318
|
};
|
|
1107
1319
|
readonly last4: {
|
|
1108
1320
|
readonly type: "string";
|
|
1109
1321
|
readonly nullable: true;
|
|
1110
|
-
readonly description: "Last 4 digits of the payment card number.";
|
|
1322
|
+
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.";
|
|
1111
1323
|
readonly example: "4242";
|
|
1112
1324
|
};
|
|
1113
1325
|
readonly exp_month: {
|
|
@@ -1115,25 +1327,46 @@ export declare const PaymentMethodSchema: {
|
|
|
1115
1327
|
readonly minimum: 1;
|
|
1116
1328
|
readonly maximum: 12;
|
|
1117
1329
|
readonly nullable: true;
|
|
1118
|
-
readonly description: "Two-digit number representing the card's expiration month.";
|
|
1119
|
-
readonly example:
|
|
1330
|
+
readonly description: "Two-digit number representing the card's expiration month. Null for SEPA Direct Debit and bank transfer.";
|
|
1331
|
+
readonly example: 12;
|
|
1120
1332
|
};
|
|
1121
1333
|
readonly exp_year: {
|
|
1122
1334
|
readonly type: "integer";
|
|
1123
|
-
readonly minimum: 2024;
|
|
1124
1335
|
readonly nullable: true;
|
|
1125
|
-
readonly description: "Four-digit number representing the card's expiration year.";
|
|
1126
|
-
readonly example:
|
|
1336
|
+
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.";
|
|
1337
|
+
readonly example: 2028;
|
|
1127
1338
|
};
|
|
1128
1339
|
readonly brand: {
|
|
1129
1340
|
readonly type: "string";
|
|
1130
1341
|
readonly nullable: true;
|
|
1131
|
-
readonly description: "Payment card brand
|
|
1342
|
+
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.";
|
|
1132
1343
|
readonly example: "visa";
|
|
1133
|
-
|
|
1344
|
+
};
|
|
1345
|
+
readonly iban: {
|
|
1346
|
+
readonly type: "string";
|
|
1347
|
+
readonly nullable: true;
|
|
1348
|
+
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.";
|
|
1349
|
+
readonly example: "DE11243015658023127510";
|
|
1350
|
+
};
|
|
1351
|
+
readonly bic: {
|
|
1352
|
+
readonly type: "string";
|
|
1353
|
+
readonly nullable: true;
|
|
1354
|
+
readonly description: "BIC/SWIFT of the destination bank for bank transfers. Set only for `bank_transfer`; null otherwise.";
|
|
1355
|
+
readonly example: "SOGEDEFFXXX";
|
|
1356
|
+
};
|
|
1357
|
+
readonly account_holder_name: {
|
|
1358
|
+
readonly type: "string";
|
|
1359
|
+
readonly nullable: true;
|
|
1360
|
+
readonly description: "Account holder name of the destination bank account for bank transfers. Set only for `bank_transfer`; null otherwise.";
|
|
1361
|
+
readonly example: "Cloudfleet GmbH";
|
|
1362
|
+
};
|
|
1363
|
+
readonly is_default: {
|
|
1364
|
+
readonly type: "boolean";
|
|
1365
|
+
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).";
|
|
1366
|
+
readonly example: true;
|
|
1134
1367
|
};
|
|
1135
1368
|
};
|
|
1136
|
-
readonly required: readonly ["id", "
|
|
1369
|
+
readonly required: readonly ["id", "type", "last4", "exp_month", "exp_year", "brand", "iban", "bic", "account_holder_name", "is_default"];
|
|
1137
1370
|
readonly additionalProperties: false;
|
|
1138
1371
|
};
|
|
1139
1372
|
export declare const PlatformQuotaSchema: {
|
|
@@ -1180,7 +1413,7 @@ export declare const PlatformQuotaSchema: {
|
|
|
1180
1413
|
readonly type: "array";
|
|
1181
1414
|
readonly items: {
|
|
1182
1415
|
readonly type: "string";
|
|
1183
|
-
readonly example: "northamerica-central-
|
|
1416
|
+
readonly example: "northamerica-central-1a";
|
|
1184
1417
|
};
|
|
1185
1418
|
readonly minItems: 1;
|
|
1186
1419
|
readonly description: "List of Cloudfleet control plane regions available for the organization.";
|
|
@@ -2095,18 +2328,6 @@ export declare const UserCreateInputSchema: {
|
|
|
2095
2328
|
readonly minLength: 8;
|
|
2096
2329
|
readonly description: "User password. Must be at least 8 characters long.";
|
|
2097
2330
|
};
|
|
2098
|
-
readonly status: {
|
|
2099
|
-
readonly type: "string";
|
|
2100
|
-
readonly description: "Status of the user. Can be `active` or `inactive`. Inactive users cannot log in or manage organization resources.";
|
|
2101
|
-
readonly example: "active";
|
|
2102
|
-
readonly enum: readonly ["active", "inactive"];
|
|
2103
|
-
};
|
|
2104
|
-
readonly role: {
|
|
2105
|
-
readonly type: "string";
|
|
2106
|
-
readonly description: "User role. Can be 'Administrator', 'User'.";
|
|
2107
|
-
readonly example: "User";
|
|
2108
|
-
readonly enum: readonly ["Administrator", "User"];
|
|
2109
|
-
};
|
|
2110
2331
|
};
|
|
2111
2332
|
readonly required: readonly ["email", "first_name", "last_name", "code", "password"];
|
|
2112
2333
|
readonly additionalProperties: false;
|