@cloudfleet/sdk 0.0.1-4ee2c6f → 0.0.1-5175d16
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 +54 -30
- 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 +393 -94
- package/dist/schemas.gen.d.ts.map +1 -1
- package/dist/schemas.gen.js +497 -152
- package/dist/schemas.gen.js.map +1 -1
- package/dist/sdk.gen.d.ts +33 -21
- 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 +406 -87
- package/dist/types.gen.d.ts.map +1 -1
- package/dist/zod.gen.d.ts +384 -235
- package/dist/zod.gen.d.ts.map +1 -1
- package/dist/zod.gen.js +172 -103
- package/dist/zod.gen.js.map +1 -1
- package/package.json +5 -5
package/dist/schemas.gen.js
CHANGED
|
@@ -2,6 +2,15 @@
|
|
|
2
2
|
export const BillingContactSchema = {
|
|
3
3
|
type: 'object',
|
|
4
4
|
properties: {
|
|
5
|
+
type: {
|
|
6
|
+
type: 'string',
|
|
7
|
+
description: 'Type of the organization. `business` for legal entities, `personal` for individuals.',
|
|
8
|
+
example: 'business',
|
|
9
|
+
enum: [
|
|
10
|
+
'business',
|
|
11
|
+
'personal'
|
|
12
|
+
]
|
|
13
|
+
},
|
|
5
14
|
company: {
|
|
6
15
|
type: 'string',
|
|
7
16
|
maxLength: 120,
|
|
@@ -207,6 +216,7 @@ export const BillingContactSchema = {
|
|
|
207
216
|
}
|
|
208
217
|
},
|
|
209
218
|
required: [
|
|
219
|
+
'type',
|
|
210
220
|
'email',
|
|
211
221
|
'individual_name'
|
|
212
222
|
],
|
|
@@ -358,24 +368,8 @@ export const ChartSchema = {
|
|
|
358
368
|
},
|
|
359
369
|
status: {
|
|
360
370
|
type: 'string',
|
|
361
|
-
description: 'Status of the chart deployment.',
|
|
362
|
-
example: '
|
|
363
|
-
enum: [
|
|
364
|
-
'InstallSucceeded',
|
|
365
|
-
'InstallFailed',
|
|
366
|
-
'UpgradeSucceeded',
|
|
367
|
-
'UpgradeFailed',
|
|
368
|
-
'TestSucceeded',
|
|
369
|
-
'TestFailed',
|
|
370
|
-
'RollbackSucceeded',
|
|
371
|
-
'RollbackFailed',
|
|
372
|
-
'UninstallSucceeded',
|
|
373
|
-
'UninstallFailed',
|
|
374
|
-
'ArtifactFailed',
|
|
375
|
-
'DependencyNotReady',
|
|
376
|
-
'Progressing',
|
|
377
|
-
'SourceNotReady'
|
|
378
|
-
]
|
|
371
|
+
description: 'Status of the chart deployment (Flux HelmRelease Ready condition reason, e.g. InstallSucceeded, UpgradeFailed, Progressing).',
|
|
372
|
+
example: 'InstallSucceeded'
|
|
379
373
|
},
|
|
380
374
|
version_current: {
|
|
381
375
|
type: 'string',
|
|
@@ -454,33 +448,107 @@ export const ClusterCreateInputSchema = {
|
|
|
454
448
|
},
|
|
455
449
|
region: {
|
|
456
450
|
type: 'string',
|
|
457
|
-
description: 'Cloudfleet control plane region.
|
|
458
|
-
|
|
459
|
-
example: 'northamerica-central-1a',
|
|
460
|
-
enum: [
|
|
461
|
-
'staging-1a',
|
|
462
|
-
'northamerica-central-1',
|
|
463
|
-
'europe-central-1a',
|
|
464
|
-
'northamerica-central-1a'
|
|
465
|
-
]
|
|
451
|
+
description: 'Cloudfleet control plane region. This field can not be updated after creation.',
|
|
452
|
+
example: 'europe-central-1a'
|
|
466
453
|
},
|
|
467
454
|
version_channel: {
|
|
468
455
|
type: 'string',
|
|
469
456
|
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-]+)*))?$',
|
|
470
457
|
description: 'Version of the kubernetes cluster.',
|
|
471
458
|
default: '1.x.x-cfke.x',
|
|
472
|
-
example: '1.x.x-cfke.x'
|
|
459
|
+
example: '1.x.x-cfke.x'
|
|
460
|
+
},
|
|
461
|
+
release_channel: {
|
|
462
|
+
type: 'string',
|
|
463
|
+
description: 'Release channel for the cluster\'s control plane.',
|
|
464
|
+
default: 'rapid',
|
|
465
|
+
example: 'rapid',
|
|
473
466
|
enum: [
|
|
474
|
-
'
|
|
475
|
-
'
|
|
476
|
-
'
|
|
477
|
-
'1.33.x-cfke.x'
|
|
467
|
+
'rapid',
|
|
468
|
+
'stable',
|
|
469
|
+
'extended'
|
|
478
470
|
]
|
|
471
|
+
},
|
|
472
|
+
features: {
|
|
473
|
+
type: 'object',
|
|
474
|
+
properties: {
|
|
475
|
+
gpu_sharing_strategy: {
|
|
476
|
+
type: 'string',
|
|
477
|
+
description: 'GPU sharing strategy.',
|
|
478
|
+
example: 'none',
|
|
479
|
+
enum: [
|
|
480
|
+
'none',
|
|
481
|
+
'mps',
|
|
482
|
+
'time_slicing'
|
|
483
|
+
]
|
|
484
|
+
},
|
|
485
|
+
gpu_max_shared_clients_per_gpu: {
|
|
486
|
+
type: 'integer',
|
|
487
|
+
minimum: 1,
|
|
488
|
+
maximum: 48,
|
|
489
|
+
description: 'Maximum number of pods that may share a single GPU.',
|
|
490
|
+
example: 10
|
|
491
|
+
},
|
|
492
|
+
cilium_socket_lb_host_namespace_only: {
|
|
493
|
+
type: 'boolean',
|
|
494
|
+
description: 'Restrict Cilium socket load-balancing to the host namespace. Required for the Tailscale operator and Istio.',
|
|
495
|
+
example: false
|
|
496
|
+
}
|
|
497
|
+
},
|
|
498
|
+
required: [
|
|
499
|
+
'gpu_sharing_strategy',
|
|
500
|
+
'gpu_max_shared_clients_per_gpu'
|
|
501
|
+
],
|
|
502
|
+
additionalProperties: false,
|
|
503
|
+
description: 'Cluster feature toggles.',
|
|
504
|
+
default: {
|
|
505
|
+
gpu_sharing_strategy: 'none',
|
|
506
|
+
gpu_max_shared_clients_per_gpu: 10,
|
|
507
|
+
cilium_socket_lb_host_namespace_only: false
|
|
508
|
+
}
|
|
509
|
+
},
|
|
510
|
+
networking: {
|
|
511
|
+
type: 'object',
|
|
512
|
+
properties: {
|
|
513
|
+
pod_cidr: {
|
|
514
|
+
type: 'string',
|
|
515
|
+
description: 'CIDR block for pod IPs.',
|
|
516
|
+
example: '10.244.0.0/16'
|
|
517
|
+
},
|
|
518
|
+
service_cidr: {
|
|
519
|
+
type: 'string',
|
|
520
|
+
description: 'CIDR block for service IPs.',
|
|
521
|
+
example: '10.96.0.0/12'
|
|
522
|
+
},
|
|
523
|
+
cluster_dns: {
|
|
524
|
+
type: 'string',
|
|
525
|
+
description: 'CoreDNS service IP.',
|
|
526
|
+
example: '10.96.0.10'
|
|
527
|
+
},
|
|
528
|
+
dual_stack: {
|
|
529
|
+
type: 'boolean',
|
|
530
|
+
description: 'Enable IPv4+IPv6 dual-stack networking.',
|
|
531
|
+
example: false
|
|
532
|
+
},
|
|
533
|
+
pod_cidr_v6: {
|
|
534
|
+
type: 'string',
|
|
535
|
+
description: 'IPv6 pod CIDR. Requires dual_stack.',
|
|
536
|
+
example: 'fd00:10:244::/56'
|
|
537
|
+
},
|
|
538
|
+
service_cidr_v6: {
|
|
539
|
+
type: 'string',
|
|
540
|
+
description: 'IPv6 service CIDR. Requires dual_stack.',
|
|
541
|
+
example: 'fd00:10:96::/112'
|
|
542
|
+
}
|
|
543
|
+
},
|
|
544
|
+
additionalProperties: false,
|
|
545
|
+
description: 'Cluster networking configuration. Immutable after creation.'
|
|
479
546
|
}
|
|
480
547
|
},
|
|
481
548
|
required: [
|
|
482
549
|
'name',
|
|
483
|
-
'tier'
|
|
550
|
+
'tier',
|
|
551
|
+
'region'
|
|
484
552
|
],
|
|
485
553
|
additionalProperties: false
|
|
486
554
|
};
|
|
@@ -503,6 +571,11 @@ export const ClusterJoinInformationSchema = {
|
|
|
503
571
|
description: 'Cluster DNS IP address. This is the IP address of the kube-dns service in the cluster.',
|
|
504
572
|
example: '10.96.0.10'
|
|
505
573
|
},
|
|
574
|
+
pod_cidr: {
|
|
575
|
+
type: 'string',
|
|
576
|
+
description: 'Pod CIDR for the cluster. Used to configure iptables rules on nodes to prevent Tailscale routing loops.',
|
|
577
|
+
example: '10.244.0.0/16'
|
|
578
|
+
},
|
|
506
579
|
auth_key: {
|
|
507
580
|
type: 'string',
|
|
508
581
|
description: 'Authentication key for the cluster.',
|
|
@@ -578,6 +651,7 @@ export const ClusterJoinInformationSchema = {
|
|
|
578
651
|
'certificate_authority',
|
|
579
652
|
'endpoint',
|
|
580
653
|
'cluster_dns',
|
|
654
|
+
'pod_cidr',
|
|
581
655
|
'auth_key',
|
|
582
656
|
'bootstrap_token',
|
|
583
657
|
'versions',
|
|
@@ -607,16 +681,89 @@ export const ClusterSchema = {
|
|
|
607
681
|
},
|
|
608
682
|
region: {
|
|
609
683
|
type: 'string',
|
|
610
|
-
description: 'Cloudfleet control plane region.
|
|
611
|
-
|
|
612
|
-
|
|
684
|
+
description: 'Cloudfleet control plane region. This field can not be updated after creation.',
|
|
685
|
+
example: 'europe-central-1a'
|
|
686
|
+
},
|
|
687
|
+
networking: {
|
|
688
|
+
type: 'object',
|
|
689
|
+
properties: {
|
|
690
|
+
pod_cidr: {
|
|
691
|
+
type: 'string',
|
|
692
|
+
description: 'CIDR block for pod IPs.',
|
|
693
|
+
example: '10.244.0.0/16'
|
|
694
|
+
},
|
|
695
|
+
service_cidr: {
|
|
696
|
+
type: 'string',
|
|
697
|
+
description: 'CIDR block for service IPs.',
|
|
698
|
+
example: '10.96.0.0/12'
|
|
699
|
+
},
|
|
700
|
+
cluster_dns: {
|
|
701
|
+
type: 'string',
|
|
702
|
+
description: 'CoreDNS service IP.',
|
|
703
|
+
example: '10.96.0.10'
|
|
704
|
+
},
|
|
705
|
+
dual_stack: {
|
|
706
|
+
type: 'boolean',
|
|
707
|
+
description: 'Enable IPv4+IPv6 dual-stack networking.',
|
|
708
|
+
example: false
|
|
709
|
+
},
|
|
710
|
+
pod_cidr_v6: {
|
|
711
|
+
type: 'string',
|
|
712
|
+
description: 'IPv6 pod CIDR. Requires dual_stack.',
|
|
713
|
+
example: 'fd00:10:244::/56'
|
|
714
|
+
},
|
|
715
|
+
service_cidr_v6: {
|
|
716
|
+
type: 'string',
|
|
717
|
+
description: 'IPv6 service CIDR. Requires dual_stack.',
|
|
718
|
+
example: 'fd00:10:96::/112'
|
|
719
|
+
}
|
|
720
|
+
},
|
|
721
|
+
additionalProperties: false,
|
|
722
|
+
description: 'Cluster networking configuration. Immutable after creation.'
|
|
723
|
+
},
|
|
724
|
+
release_channel: {
|
|
725
|
+
type: 'string',
|
|
726
|
+
description: 'Release channel for the cluster\'s control plane.',
|
|
727
|
+
example: 'rapid',
|
|
613
728
|
enum: [
|
|
614
|
-
'
|
|
615
|
-
'
|
|
616
|
-
'
|
|
617
|
-
'northamerica-central-1a'
|
|
729
|
+
'rapid',
|
|
730
|
+
'stable',
|
|
731
|
+
'extended'
|
|
618
732
|
]
|
|
619
733
|
},
|
|
734
|
+
features: {
|
|
735
|
+
type: 'object',
|
|
736
|
+
properties: {
|
|
737
|
+
gpu_sharing_strategy: {
|
|
738
|
+
type: 'string',
|
|
739
|
+
description: 'GPU sharing strategy.',
|
|
740
|
+
example: 'none',
|
|
741
|
+
enum: [
|
|
742
|
+
'none',
|
|
743
|
+
'mps',
|
|
744
|
+
'time_slicing'
|
|
745
|
+
]
|
|
746
|
+
},
|
|
747
|
+
gpu_max_shared_clients_per_gpu: {
|
|
748
|
+
type: 'integer',
|
|
749
|
+
minimum: 1,
|
|
750
|
+
maximum: 48,
|
|
751
|
+
description: 'Maximum number of pods that may share a single GPU.',
|
|
752
|
+
example: 10
|
|
753
|
+
},
|
|
754
|
+
cilium_socket_lb_host_namespace_only: {
|
|
755
|
+
type: 'boolean',
|
|
756
|
+
description: 'Restrict Cilium socket load-balancing to the host namespace. Required for the Tailscale operator and Istio.',
|
|
757
|
+
example: false
|
|
758
|
+
}
|
|
759
|
+
},
|
|
760
|
+
required: [
|
|
761
|
+
'gpu_sharing_strategy',
|
|
762
|
+
'gpu_max_shared_clients_per_gpu'
|
|
763
|
+
],
|
|
764
|
+
additionalProperties: false,
|
|
765
|
+
description: 'Cluster feature toggles.'
|
|
766
|
+
},
|
|
620
767
|
id: {
|
|
621
768
|
type: 'string',
|
|
622
769
|
format: 'uuid',
|
|
@@ -625,16 +772,13 @@ export const ClusterSchema = {
|
|
|
625
772
|
},
|
|
626
773
|
status: {
|
|
627
774
|
type: 'string',
|
|
628
|
-
description: 'Status of the cluster.
|
|
629
|
-
example: '
|
|
775
|
+
description: 'Status of the cluster.',
|
|
776
|
+
example: 'deployed',
|
|
630
777
|
enum: [
|
|
631
|
-
'active',
|
|
632
|
-
'disabled',
|
|
633
|
-
'deleted',
|
|
634
778
|
'creating',
|
|
635
779
|
'deployed',
|
|
636
|
-
'
|
|
637
|
-
'
|
|
780
|
+
'updating',
|
|
781
|
+
'disabled'
|
|
638
782
|
]
|
|
639
783
|
},
|
|
640
784
|
endpoint: {
|
|
@@ -642,8 +786,24 @@ export const ClusterSchema = {
|
|
|
642
786
|
{
|
|
643
787
|
type: 'string',
|
|
644
788
|
format: 'uri',
|
|
645
|
-
description: 'URL of the Kubernetes cluster control plane. This is the endpoint that kubectl uses to connect to the cluster.',
|
|
646
|
-
example: 'https://2ae6557c-c61f-49c6-b4c1-a65473470a03.staging.cfke.
|
|
789
|
+
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.',
|
|
790
|
+
example: 'https://2ae6557c-c61f-49c6-b4c1-a65473470a03.staging.cfke.io'
|
|
791
|
+
},
|
|
792
|
+
{
|
|
793
|
+
type: 'string',
|
|
794
|
+
enum: [
|
|
795
|
+
''
|
|
796
|
+
]
|
|
797
|
+
}
|
|
798
|
+
]
|
|
799
|
+
},
|
|
800
|
+
endpoint_public: {
|
|
801
|
+
anyOf: [
|
|
802
|
+
{
|
|
803
|
+
type: 'string',
|
|
804
|
+
format: 'uri',
|
|
805
|
+
description: 'Deprecated alias of `endpoint`; retained for backward compatibility.',
|
|
806
|
+
example: 'https://2ae6557c-c61f-49c6-b4c1-a65473470a03.staging.cfke.io'
|
|
647
807
|
},
|
|
648
808
|
{
|
|
649
809
|
type: 'string',
|
|
@@ -688,6 +848,7 @@ export const ClusterSchema = {
|
|
|
688
848
|
required: [
|
|
689
849
|
'name',
|
|
690
850
|
'tier',
|
|
851
|
+
'region',
|
|
691
852
|
'id',
|
|
692
853
|
'status'
|
|
693
854
|
],
|
|
@@ -718,6 +879,49 @@ export const ClusterUpdateInputSchema = {
|
|
|
718
879
|
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-]+)*))?$',
|
|
719
880
|
description: 'Version of the kubernetes cluster.',
|
|
720
881
|
example: '1.x.x-cfke.x'
|
|
882
|
+
},
|
|
883
|
+
release_channel: {
|
|
884
|
+
type: 'string',
|
|
885
|
+
description: 'Release channel for the cluster\'s control plane.',
|
|
886
|
+
example: 'rapid',
|
|
887
|
+
enum: [
|
|
888
|
+
'rapid',
|
|
889
|
+
'stable',
|
|
890
|
+
'extended'
|
|
891
|
+
]
|
|
892
|
+
},
|
|
893
|
+
features: {
|
|
894
|
+
type: 'object',
|
|
895
|
+
properties: {
|
|
896
|
+
gpu_sharing_strategy: {
|
|
897
|
+
type: 'string',
|
|
898
|
+
description: 'GPU sharing strategy.',
|
|
899
|
+
example: 'none',
|
|
900
|
+
enum: [
|
|
901
|
+
'none',
|
|
902
|
+
'mps',
|
|
903
|
+
'time_slicing'
|
|
904
|
+
]
|
|
905
|
+
},
|
|
906
|
+
gpu_max_shared_clients_per_gpu: {
|
|
907
|
+
type: 'integer',
|
|
908
|
+
minimum: 1,
|
|
909
|
+
maximum: 48,
|
|
910
|
+
description: 'Maximum number of pods that may share a single GPU.',
|
|
911
|
+
example: 10
|
|
912
|
+
},
|
|
913
|
+
cilium_socket_lb_host_namespace_only: {
|
|
914
|
+
type: 'boolean',
|
|
915
|
+
description: 'Restrict Cilium socket load-balancing to the host namespace. Required for the Tailscale operator and Istio.',
|
|
916
|
+
example: false
|
|
917
|
+
}
|
|
918
|
+
},
|
|
919
|
+
required: [
|
|
920
|
+
'gpu_sharing_strategy',
|
|
921
|
+
'gpu_max_shared_clients_per_gpu'
|
|
922
|
+
],
|
|
923
|
+
additionalProperties: false,
|
|
924
|
+
description: 'Cluster feature toggles.'
|
|
721
925
|
}
|
|
722
926
|
},
|
|
723
927
|
required: [
|
|
@@ -732,10 +936,10 @@ export const FleetCreateInputSchema = {
|
|
|
732
936
|
type: 'object',
|
|
733
937
|
properties: {
|
|
734
938
|
cpu: {
|
|
735
|
-
type: '
|
|
736
|
-
|
|
737
|
-
|
|
738
|
-
description: 'CPU limit in cores.'
|
|
939
|
+
type: 'integer',
|
|
940
|
+
minimum: 0,
|
|
941
|
+
maximum: 100000,
|
|
942
|
+
description: 'CPU limit in cores. Maximum 100,000.'
|
|
739
943
|
}
|
|
740
944
|
},
|
|
741
945
|
additionalProperties: false,
|
|
@@ -745,16 +949,17 @@ export const FleetCreateInputSchema = {
|
|
|
745
949
|
type: 'object',
|
|
746
950
|
properties: {
|
|
747
951
|
enabled: {
|
|
748
|
-
type: 'boolean'
|
|
749
|
-
default: true
|
|
952
|
+
type: 'boolean'
|
|
750
953
|
},
|
|
751
954
|
project: {
|
|
752
955
|
type: 'string',
|
|
753
|
-
|
|
956
|
+
pattern: '^[a-z][a-z0-9-]{4,28}[a-z0-9]$',
|
|
957
|
+
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.',
|
|
958
|
+
example: 'my-cloudfleet-project'
|
|
754
959
|
}
|
|
755
960
|
},
|
|
756
961
|
required: [
|
|
757
|
-
'
|
|
962
|
+
'enabled'
|
|
758
963
|
],
|
|
759
964
|
additionalProperties: false
|
|
760
965
|
},
|
|
@@ -762,30 +967,36 @@ export const FleetCreateInputSchema = {
|
|
|
762
967
|
type: 'object',
|
|
763
968
|
properties: {
|
|
764
969
|
enabled: {
|
|
765
|
-
type: 'boolean'
|
|
766
|
-
default: true
|
|
970
|
+
type: 'boolean'
|
|
767
971
|
},
|
|
768
972
|
apiKey: {
|
|
769
973
|
type: 'string',
|
|
770
|
-
|
|
974
|
+
maxLength: 64,
|
|
975
|
+
minLength: 64,
|
|
976
|
+
pattern: '^[A-Za-z0-9]+$',
|
|
977
|
+
description: 'Hetzner Cloud API token with read / write access (64 alphanumeric characters). Omit this field to keep the existing value.'
|
|
771
978
|
}
|
|
772
979
|
},
|
|
980
|
+
required: [
|
|
981
|
+
'enabled'
|
|
982
|
+
],
|
|
773
983
|
additionalProperties: false
|
|
774
984
|
},
|
|
775
985
|
aws: {
|
|
776
986
|
type: 'object',
|
|
777
987
|
properties: {
|
|
778
988
|
enabled: {
|
|
779
|
-
type: 'boolean'
|
|
780
|
-
default: true
|
|
989
|
+
type: 'boolean'
|
|
781
990
|
},
|
|
782
991
|
controllerRoleArn: {
|
|
783
992
|
type: 'string',
|
|
784
|
-
|
|
993
|
+
pattern: '^arn:aws(-[a-z]+)*:iam::\\d{12}:role\\/[\\w+=,.@/-]+$',
|
|
994
|
+
description: 'AWS IAM role ARN that Karpenter uses to manage resources. Omit when AWS is disabled.',
|
|
995
|
+
example: 'arn:aws:iam::123456789012:role/Cloudfleet'
|
|
785
996
|
}
|
|
786
997
|
},
|
|
787
998
|
required: [
|
|
788
|
-
'
|
|
999
|
+
'enabled'
|
|
789
1000
|
],
|
|
790
1001
|
additionalProperties: false
|
|
791
1002
|
},
|
|
@@ -801,7 +1012,12 @@ export const FleetCreateInputSchema = {
|
|
|
801
1012
|
'spot'
|
|
802
1013
|
]
|
|
803
1014
|
},
|
|
804
|
-
|
|
1015
|
+
minItems: 1,
|
|
1016
|
+
description: 'Allowed values for `karpenter.sh/capacity-type`.',
|
|
1017
|
+
default: [
|
|
1018
|
+
'on-demand',
|
|
1019
|
+
'spot'
|
|
1020
|
+
]
|
|
805
1021
|
},
|
|
806
1022
|
'kubernetes.io/arch': {
|
|
807
1023
|
type: 'array',
|
|
@@ -812,7 +1028,11 @@ export const FleetCreateInputSchema = {
|
|
|
812
1028
|
'arm64'
|
|
813
1029
|
]
|
|
814
1030
|
},
|
|
815
|
-
|
|
1031
|
+
minItems: 1,
|
|
1032
|
+
description: 'Allowed values for `kubernetes.io/arch`.',
|
|
1033
|
+
default: [
|
|
1034
|
+
'amd64'
|
|
1035
|
+
]
|
|
816
1036
|
},
|
|
817
1037
|
'cfke.io/instance-family': {
|
|
818
1038
|
type: 'array',
|
|
@@ -1061,6 +1281,7 @@ export const FleetCreateInputSchema = {
|
|
|
1061
1281
|
scalingProfile: {
|
|
1062
1282
|
type: 'string',
|
|
1063
1283
|
description: 'Controls scale-up / scale-down responsiveness. `aggressive` prioritizes cost-optimization. `conservative` prioritizes stability of the fleet.',
|
|
1284
|
+
default: 'conservative',
|
|
1064
1285
|
example: 'conservative',
|
|
1065
1286
|
enum: [
|
|
1066
1287
|
'aggressive',
|
|
@@ -1088,10 +1309,10 @@ export const FleetSchema = {
|
|
|
1088
1309
|
type: 'object',
|
|
1089
1310
|
properties: {
|
|
1090
1311
|
cpu: {
|
|
1091
|
-
type: '
|
|
1092
|
-
|
|
1093
|
-
|
|
1094
|
-
description: 'CPU limit in cores.'
|
|
1312
|
+
type: 'integer',
|
|
1313
|
+
minimum: 0,
|
|
1314
|
+
maximum: 100000,
|
|
1315
|
+
description: 'CPU limit in cores. Maximum 100,000.'
|
|
1095
1316
|
}
|
|
1096
1317
|
},
|
|
1097
1318
|
additionalProperties: false,
|
|
@@ -1101,16 +1322,17 @@ export const FleetSchema = {
|
|
|
1101
1322
|
type: 'object',
|
|
1102
1323
|
properties: {
|
|
1103
1324
|
enabled: {
|
|
1104
|
-
type: 'boolean'
|
|
1105
|
-
default: true
|
|
1325
|
+
type: 'boolean'
|
|
1106
1326
|
},
|
|
1107
1327
|
project: {
|
|
1108
1328
|
type: 'string',
|
|
1109
|
-
|
|
1329
|
+
pattern: '^[a-z][a-z0-9-]{4,28}[a-z0-9]$',
|
|
1330
|
+
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.',
|
|
1331
|
+
example: 'my-cloudfleet-project'
|
|
1110
1332
|
}
|
|
1111
1333
|
},
|
|
1112
1334
|
required: [
|
|
1113
|
-
'
|
|
1335
|
+
'enabled'
|
|
1114
1336
|
],
|
|
1115
1337
|
additionalProperties: false
|
|
1116
1338
|
},
|
|
@@ -1118,30 +1340,34 @@ export const FleetSchema = {
|
|
|
1118
1340
|
type: 'object',
|
|
1119
1341
|
properties: {
|
|
1120
1342
|
enabled: {
|
|
1121
|
-
type: 'boolean'
|
|
1122
|
-
default: true
|
|
1343
|
+
type: 'boolean'
|
|
1123
1344
|
},
|
|
1124
1345
|
apiKey: {
|
|
1125
1346
|
type: 'string',
|
|
1126
|
-
|
|
1347
|
+
pattern: '^\\*{64}$',
|
|
1348
|
+
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.'
|
|
1127
1349
|
}
|
|
1128
1350
|
},
|
|
1351
|
+
required: [
|
|
1352
|
+
'enabled'
|
|
1353
|
+
],
|
|
1129
1354
|
additionalProperties: false
|
|
1130
1355
|
},
|
|
1131
1356
|
aws: {
|
|
1132
1357
|
type: 'object',
|
|
1133
1358
|
properties: {
|
|
1134
1359
|
enabled: {
|
|
1135
|
-
type: 'boolean'
|
|
1136
|
-
default: true
|
|
1360
|
+
type: 'boolean'
|
|
1137
1361
|
},
|
|
1138
1362
|
controllerRoleArn: {
|
|
1139
1363
|
type: 'string',
|
|
1140
|
-
|
|
1364
|
+
pattern: '^arn:aws(-[a-z]+)*:iam::\\d{12}:role\\/[\\w+=,.@/-]+$',
|
|
1365
|
+
description: 'AWS IAM role ARN that Karpenter uses to manage resources. Omit when AWS is disabled.',
|
|
1366
|
+
example: 'arn:aws:iam::123456789012:role/Cloudfleet'
|
|
1141
1367
|
}
|
|
1142
1368
|
},
|
|
1143
1369
|
required: [
|
|
1144
|
-
'
|
|
1370
|
+
'enabled'
|
|
1145
1371
|
],
|
|
1146
1372
|
additionalProperties: false
|
|
1147
1373
|
},
|
|
@@ -1157,7 +1383,12 @@ export const FleetSchema = {
|
|
|
1157
1383
|
'spot'
|
|
1158
1384
|
]
|
|
1159
1385
|
},
|
|
1160
|
-
|
|
1386
|
+
minItems: 1,
|
|
1387
|
+
description: 'Allowed values for `karpenter.sh/capacity-type`.',
|
|
1388
|
+
default: [
|
|
1389
|
+
'on-demand',
|
|
1390
|
+
'spot'
|
|
1391
|
+
]
|
|
1161
1392
|
},
|
|
1162
1393
|
'kubernetes.io/arch': {
|
|
1163
1394
|
type: 'array',
|
|
@@ -1168,7 +1399,11 @@ export const FleetSchema = {
|
|
|
1168
1399
|
'arm64'
|
|
1169
1400
|
]
|
|
1170
1401
|
},
|
|
1171
|
-
|
|
1402
|
+
minItems: 1,
|
|
1403
|
+
description: 'Allowed values for `kubernetes.io/arch`.',
|
|
1404
|
+
default: [
|
|
1405
|
+
'amd64'
|
|
1406
|
+
]
|
|
1172
1407
|
},
|
|
1173
1408
|
'cfke.io/instance-family': {
|
|
1174
1409
|
type: 'array',
|
|
@@ -1417,6 +1652,7 @@ export const FleetSchema = {
|
|
|
1417
1652
|
scalingProfile: {
|
|
1418
1653
|
type: 'string',
|
|
1419
1654
|
description: 'Controls scale-up / scale-down responsiveness. `aggressive` prioritizes cost-optimization. `conservative` prioritizes stability of the fleet.',
|
|
1655
|
+
default: 'conservative',
|
|
1420
1656
|
example: 'conservative',
|
|
1421
1657
|
enum: [
|
|
1422
1658
|
'aggressive',
|
|
@@ -1430,10 +1666,34 @@ export const FleetSchema = {
|
|
|
1430
1666
|
pattern: '^[a-z0-9]([-a-z0-9]*[a-z0-9])?$',
|
|
1431
1667
|
description: 'Unique identifier of the kubernetes fleet.',
|
|
1432
1668
|
example: 'new-clouds-fleet'
|
|
1669
|
+
},
|
|
1670
|
+
ready: {
|
|
1671
|
+
type: 'boolean',
|
|
1672
|
+
description: 'Indicates whether the fleet configuration is healthy.',
|
|
1673
|
+
example: true
|
|
1674
|
+
},
|
|
1675
|
+
status_message: {
|
|
1676
|
+
type: 'string',
|
|
1677
|
+
description: 'Human-readable reason the fleet is not ready. Present only when `ready` is false.',
|
|
1678
|
+
example: 'Invalid provider permissions.'
|
|
1679
|
+
},
|
|
1680
|
+
created_at: {
|
|
1681
|
+
type: 'string',
|
|
1682
|
+
description: 'Creation date and time of the fleet.',
|
|
1683
|
+
example: '2024-09-12T09:11:27Z'
|
|
1684
|
+
},
|
|
1685
|
+
updated_at: {
|
|
1686
|
+
type: 'string',
|
|
1687
|
+
description: 'Date and time the fleet was last updated.',
|
|
1688
|
+
example: '2024-09-12T09:11:27Z'
|
|
1433
1689
|
}
|
|
1434
1690
|
},
|
|
1435
1691
|
required: [
|
|
1436
|
-
'
|
|
1692
|
+
'scalingProfile',
|
|
1693
|
+
'id',
|
|
1694
|
+
'ready',
|
|
1695
|
+
'created_at',
|
|
1696
|
+
'updated_at'
|
|
1437
1697
|
],
|
|
1438
1698
|
additionalProperties: false
|
|
1439
1699
|
};
|
|
@@ -1444,10 +1704,10 @@ export const FleetUpdateInputSchema = {
|
|
|
1444
1704
|
type: 'object',
|
|
1445
1705
|
properties: {
|
|
1446
1706
|
cpu: {
|
|
1447
|
-
type: '
|
|
1448
|
-
|
|
1449
|
-
|
|
1450
|
-
description: 'CPU limit in cores.'
|
|
1707
|
+
type: 'integer',
|
|
1708
|
+
minimum: 0,
|
|
1709
|
+
maximum: 100000,
|
|
1710
|
+
description: 'CPU limit in cores. Maximum 100,000.'
|
|
1451
1711
|
}
|
|
1452
1712
|
},
|
|
1453
1713
|
additionalProperties: false,
|
|
@@ -1457,16 +1717,17 @@ export const FleetUpdateInputSchema = {
|
|
|
1457
1717
|
type: 'object',
|
|
1458
1718
|
properties: {
|
|
1459
1719
|
enabled: {
|
|
1460
|
-
type: 'boolean'
|
|
1461
|
-
default: true
|
|
1720
|
+
type: 'boolean'
|
|
1462
1721
|
},
|
|
1463
1722
|
project: {
|
|
1464
1723
|
type: 'string',
|
|
1465
|
-
|
|
1724
|
+
pattern: '^[a-z][a-z0-9-]{4,28}[a-z0-9]$',
|
|
1725
|
+
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.',
|
|
1726
|
+
example: 'my-cloudfleet-project'
|
|
1466
1727
|
}
|
|
1467
1728
|
},
|
|
1468
1729
|
required: [
|
|
1469
|
-
'
|
|
1730
|
+
'enabled'
|
|
1470
1731
|
],
|
|
1471
1732
|
additionalProperties: false
|
|
1472
1733
|
},
|
|
@@ -1474,30 +1735,36 @@ export const FleetUpdateInputSchema = {
|
|
|
1474
1735
|
type: 'object',
|
|
1475
1736
|
properties: {
|
|
1476
1737
|
enabled: {
|
|
1477
|
-
type: 'boolean'
|
|
1478
|
-
default: true
|
|
1738
|
+
type: 'boolean'
|
|
1479
1739
|
},
|
|
1480
1740
|
apiKey: {
|
|
1481
1741
|
type: 'string',
|
|
1482
|
-
|
|
1742
|
+
maxLength: 64,
|
|
1743
|
+
minLength: 64,
|
|
1744
|
+
pattern: '^[A-Za-z0-9]+$',
|
|
1745
|
+
description: 'Hetzner Cloud API token with read / write access (64 alphanumeric characters). Omit this field to keep the existing value.'
|
|
1483
1746
|
}
|
|
1484
1747
|
},
|
|
1748
|
+
required: [
|
|
1749
|
+
'enabled'
|
|
1750
|
+
],
|
|
1485
1751
|
additionalProperties: false
|
|
1486
1752
|
},
|
|
1487
1753
|
aws: {
|
|
1488
1754
|
type: 'object',
|
|
1489
1755
|
properties: {
|
|
1490
1756
|
enabled: {
|
|
1491
|
-
type: 'boolean'
|
|
1492
|
-
default: true
|
|
1757
|
+
type: 'boolean'
|
|
1493
1758
|
},
|
|
1494
1759
|
controllerRoleArn: {
|
|
1495
1760
|
type: 'string',
|
|
1496
|
-
|
|
1761
|
+
pattern: '^arn:aws(-[a-z]+)*:iam::\\d{12}:role\\/[\\w+=,.@/-]+$',
|
|
1762
|
+
description: 'AWS IAM role ARN that Karpenter uses to manage resources. Omit when AWS is disabled.',
|
|
1763
|
+
example: 'arn:aws:iam::123456789012:role/Cloudfleet'
|
|
1497
1764
|
}
|
|
1498
1765
|
},
|
|
1499
1766
|
required: [
|
|
1500
|
-
'
|
|
1767
|
+
'enabled'
|
|
1501
1768
|
],
|
|
1502
1769
|
additionalProperties: false
|
|
1503
1770
|
},
|
|
@@ -1513,6 +1780,7 @@ export const FleetUpdateInputSchema = {
|
|
|
1513
1780
|
'spot'
|
|
1514
1781
|
]
|
|
1515
1782
|
},
|
|
1783
|
+
minItems: 1,
|
|
1516
1784
|
description: 'Allowed values for `karpenter.sh/capacity-type`.'
|
|
1517
1785
|
},
|
|
1518
1786
|
'kubernetes.io/arch': {
|
|
@@ -1524,6 +1792,7 @@ export const FleetUpdateInputSchema = {
|
|
|
1524
1792
|
'arm64'
|
|
1525
1793
|
]
|
|
1526
1794
|
},
|
|
1795
|
+
minItems: 1,
|
|
1527
1796
|
description: 'Allowed values for `kubernetes.io/arch`.'
|
|
1528
1797
|
},
|
|
1529
1798
|
'cfke.io/instance-family': {
|
|
@@ -1780,6 +2049,34 @@ export const FleetUpdateInputSchema = {
|
|
|
1780
2049
|
]
|
|
1781
2050
|
}
|
|
1782
2051
|
},
|
|
2052
|
+
required: [
|
|
2053
|
+
'scalingProfile'
|
|
2054
|
+
],
|
|
2055
|
+
additionalProperties: false
|
|
2056
|
+
};
|
|
2057
|
+
export const InviteCreateInputSchema = {
|
|
2058
|
+
type: 'object',
|
|
2059
|
+
properties: {
|
|
2060
|
+
email: {
|
|
2061
|
+
type: 'string',
|
|
2062
|
+
format: 'email',
|
|
2063
|
+
description: 'Email address of the user to invite.',
|
|
2064
|
+
example: 'email@example.com'
|
|
2065
|
+
},
|
|
2066
|
+
role: {
|
|
2067
|
+
type: 'string',
|
|
2068
|
+
description: 'Role the invited user will be assigned on redemption. Can be \'Administrator\' or \'User\'.',
|
|
2069
|
+
default: 'User',
|
|
2070
|
+
example: 'User',
|
|
2071
|
+
enum: [
|
|
2072
|
+
'Administrator',
|
|
2073
|
+
'User'
|
|
2074
|
+
]
|
|
2075
|
+
}
|
|
2076
|
+
},
|
|
2077
|
+
required: [
|
|
2078
|
+
'email'
|
|
2079
|
+
],
|
|
1783
2080
|
additionalProperties: false
|
|
1784
2081
|
};
|
|
1785
2082
|
export const InviteSchema = {
|
|
@@ -1812,6 +2109,16 @@ export const InviteSchema = {
|
|
|
1812
2109
|
type: 'string',
|
|
1813
2110
|
description: 'Generated unique invite code.',
|
|
1814
2111
|
example: '7kUZnH7nnKUFfvc4NK2KQF'
|
|
2112
|
+
},
|
|
2113
|
+
role: {
|
|
2114
|
+
type: 'string',
|
|
2115
|
+
description: 'Role the invited user will be assigned on redemption. Can be \'Administrator\' or \'User\'.',
|
|
2116
|
+
default: 'User',
|
|
2117
|
+
example: 'User',
|
|
2118
|
+
enum: [
|
|
2119
|
+
'Administrator',
|
|
2120
|
+
'User'
|
|
2121
|
+
]
|
|
1815
2122
|
}
|
|
1816
2123
|
},
|
|
1817
2124
|
required: [
|
|
@@ -2032,6 +2339,15 @@ export const MarketplaceListingSchema = {
|
|
|
2032
2339
|
export const OrganizationCreateInputSchema = {
|
|
2033
2340
|
type: 'object',
|
|
2034
2341
|
properties: {
|
|
2342
|
+
type: {
|
|
2343
|
+
type: 'string',
|
|
2344
|
+
description: 'Type of the organization. `business` for legal entities, `personal` for individuals.',
|
|
2345
|
+
example: 'business',
|
|
2346
|
+
enum: [
|
|
2347
|
+
'business',
|
|
2348
|
+
'personal'
|
|
2349
|
+
]
|
|
2350
|
+
},
|
|
2035
2351
|
email: {
|
|
2036
2352
|
type: 'string',
|
|
2037
2353
|
format: 'email',
|
|
@@ -2040,11 +2356,13 @@ export const OrganizationCreateInputSchema = {
|
|
|
2040
2356
|
},
|
|
2041
2357
|
first_name: {
|
|
2042
2358
|
type: 'string',
|
|
2359
|
+
minLength: 1,
|
|
2043
2360
|
description: 'First name of the billing contact person.',
|
|
2044
2361
|
example: 'John'
|
|
2045
2362
|
},
|
|
2046
2363
|
last_name: {
|
|
2047
2364
|
type: 'string',
|
|
2365
|
+
minLength: 1,
|
|
2048
2366
|
description: 'Last name of the billing contact person.',
|
|
2049
2367
|
example: 'Doe'
|
|
2050
2368
|
},
|
|
@@ -2063,6 +2381,7 @@ export const OrganizationCreateInputSchema = {
|
|
|
2063
2381
|
}
|
|
2064
2382
|
},
|
|
2065
2383
|
required: [
|
|
2384
|
+
'type',
|
|
2066
2385
|
'email',
|
|
2067
2386
|
'first_name',
|
|
2068
2387
|
'last_name',
|
|
@@ -2071,6 +2390,20 @@ export const OrganizationCreateInputSchema = {
|
|
|
2071
2390
|
],
|
|
2072
2391
|
additionalProperties: false
|
|
2073
2392
|
};
|
|
2393
|
+
export const OrganizationCreateOutputSchema = {
|
|
2394
|
+
type: 'object',
|
|
2395
|
+
properties: {
|
|
2396
|
+
id: {
|
|
2397
|
+
type: 'string',
|
|
2398
|
+
description: 'Unique identifier of the newly created organization. Generated by the API and safe to use for client-side tracking immediately.',
|
|
2399
|
+
example: 'organization-id'
|
|
2400
|
+
}
|
|
2401
|
+
},
|
|
2402
|
+
required: [
|
|
2403
|
+
'id'
|
|
2404
|
+
],
|
|
2405
|
+
additionalProperties: false
|
|
2406
|
+
};
|
|
2074
2407
|
export const OrganizationSchema = {
|
|
2075
2408
|
type: 'object',
|
|
2076
2409
|
properties: {
|
|
@@ -2087,6 +2420,15 @@ export const OrganizationSchema = {
|
|
|
2087
2420
|
description: 'Name of the legal entity. This name will be used in invoices. Use your first and last name for individual accounts.',
|
|
2088
2421
|
example: 'ACME Corp.'
|
|
2089
2422
|
},
|
|
2423
|
+
type: {
|
|
2424
|
+
type: 'string',
|
|
2425
|
+
description: 'Type of the organization. `business` for legal entities, `personal` for individuals.',
|
|
2426
|
+
example: 'business',
|
|
2427
|
+
enum: [
|
|
2428
|
+
'business',
|
|
2429
|
+
'personal'
|
|
2430
|
+
]
|
|
2431
|
+
},
|
|
2090
2432
|
date_created: {
|
|
2091
2433
|
type: 'string',
|
|
2092
2434
|
format: 'date-time',
|
|
@@ -2137,7 +2479,7 @@ export const OrganizationSchema = {
|
|
|
2137
2479
|
type: 'array',
|
|
2138
2480
|
items: {
|
|
2139
2481
|
type: 'string',
|
|
2140
|
-
example: 'northamerica-central-
|
|
2482
|
+
example: 'northamerica-central-1a'
|
|
2141
2483
|
},
|
|
2142
2484
|
minItems: 1,
|
|
2143
2485
|
description: 'List of Cloudfleet control plane regions available for the organization.'
|
|
@@ -2196,13 +2538,25 @@ export const OrganizationSchema = {
|
|
|
2196
2538
|
'closed',
|
|
2197
2539
|
'suspended'
|
|
2198
2540
|
]
|
|
2541
|
+
},
|
|
2542
|
+
verification: {
|
|
2543
|
+
type: 'string',
|
|
2544
|
+
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.',
|
|
2545
|
+
example: 'verified',
|
|
2546
|
+
enum: [
|
|
2547
|
+
'none',
|
|
2548
|
+
'submitted',
|
|
2549
|
+
'verified'
|
|
2550
|
+
]
|
|
2199
2551
|
}
|
|
2200
2552
|
},
|
|
2201
2553
|
required: [
|
|
2202
2554
|
'id',
|
|
2555
|
+
'type',
|
|
2203
2556
|
'date_created',
|
|
2204
2557
|
'quota',
|
|
2205
|
-
'status'
|
|
2558
|
+
'status',
|
|
2559
|
+
'verification'
|
|
2206
2560
|
],
|
|
2207
2561
|
additionalProperties: false
|
|
2208
2562
|
};
|
|
@@ -2211,28 +2565,23 @@ export const PaymentMethodSchema = {
|
|
|
2211
2565
|
properties: {
|
|
2212
2566
|
id: {
|
|
2213
2567
|
type: 'string',
|
|
2214
|
-
|
|
2215
|
-
|
|
2216
|
-
example: 'e94d30ec-a2dd-4dcb-832c-ac2be144ba91'
|
|
2217
|
-
},
|
|
2218
|
-
setup: {
|
|
2219
|
-
type: 'boolean',
|
|
2220
|
-
description: 'Whether organization payment method was set up and ready to use for payments.',
|
|
2221
|
-
example: true
|
|
2568
|
+
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.',
|
|
2569
|
+
example: 'pm_1MtwBwLkdIwHu7ix28a3tqPa'
|
|
2222
2570
|
},
|
|
2223
2571
|
type: {
|
|
2224
2572
|
type: 'string',
|
|
2225
|
-
|
|
2226
|
-
description: 'Payment method type type. Only `card` payments supported at the moment.',
|
|
2573
|
+
description: 'Payment method type. `card`, `sepa_debit` for SEPA Direct Debit (business accounts only), or `bank_transfer` for paying invoices by bank transfer.',
|
|
2227
2574
|
example: 'card',
|
|
2228
2575
|
enum: [
|
|
2229
|
-
'card'
|
|
2576
|
+
'card',
|
|
2577
|
+
'sepa_debit',
|
|
2578
|
+
'bank_transfer'
|
|
2230
2579
|
]
|
|
2231
2580
|
},
|
|
2232
2581
|
last4: {
|
|
2233
2582
|
type: 'string',
|
|
2234
2583
|
nullable: true,
|
|
2235
|
-
description: 'Last 4 digits of the payment card number.',
|
|
2584
|
+
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.',
|
|
2236
2585
|
example: '4242'
|
|
2237
2586
|
},
|
|
2238
2587
|
exp_month: {
|
|
@@ -2240,42 +2589,56 @@ export const PaymentMethodSchema = {
|
|
|
2240
2589
|
minimum: 1,
|
|
2241
2590
|
maximum: 12,
|
|
2242
2591
|
nullable: true,
|
|
2243
|
-
description: 'Two-digit number representing the card\'s expiration month.',
|
|
2244
|
-
example:
|
|
2592
|
+
description: 'Two-digit number representing the card\'s expiration month. Null for SEPA Direct Debit and bank transfer.',
|
|
2593
|
+
example: 12
|
|
2245
2594
|
},
|
|
2246
2595
|
exp_year: {
|
|
2247
2596
|
type: 'integer',
|
|
2248
|
-
minimum: 2024,
|
|
2249
2597
|
nullable: true,
|
|
2250
|
-
description: 'Four-digit number representing the card\'s expiration year.',
|
|
2251
|
-
example:
|
|
2598
|
+
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.',
|
|
2599
|
+
example: 2028
|
|
2252
2600
|
},
|
|
2253
2601
|
brand: {
|
|
2254
2602
|
type: 'string',
|
|
2255
2603
|
nullable: true,
|
|
2256
|
-
description: 'Payment card brand
|
|
2257
|
-
example: 'visa'
|
|
2258
|
-
|
|
2259
|
-
|
|
2260
|
-
|
|
2261
|
-
|
|
2262
|
-
|
|
2263
|
-
|
|
2264
|
-
|
|
2265
|
-
|
|
2266
|
-
|
|
2267
|
-
|
|
2268
|
-
|
|
2604
|
+
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.',
|
|
2605
|
+
example: 'visa'
|
|
2606
|
+
},
|
|
2607
|
+
iban: {
|
|
2608
|
+
type: 'string',
|
|
2609
|
+
nullable: true,
|
|
2610
|
+
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.',
|
|
2611
|
+
example: 'DE11243015658023127510'
|
|
2612
|
+
},
|
|
2613
|
+
bic: {
|
|
2614
|
+
type: 'string',
|
|
2615
|
+
nullable: true,
|
|
2616
|
+
description: 'BIC/SWIFT of the destination bank for bank transfers. Set only for `bank_transfer`; null otherwise.',
|
|
2617
|
+
example: 'SOGEDEFFXXX'
|
|
2618
|
+
},
|
|
2619
|
+
account_holder_name: {
|
|
2620
|
+
type: 'string',
|
|
2621
|
+
nullable: true,
|
|
2622
|
+
description: 'Account holder name of the destination bank account for bank transfers. Set only for `bank_transfer`; null otherwise.',
|
|
2623
|
+
example: 'Cloudfleet GmbH'
|
|
2624
|
+
},
|
|
2625
|
+
is_default: {
|
|
2626
|
+
type: 'boolean',
|
|
2627
|
+
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).',
|
|
2628
|
+
example: true
|
|
2269
2629
|
}
|
|
2270
2630
|
},
|
|
2271
2631
|
required: [
|
|
2272
2632
|
'id',
|
|
2273
|
-
'setup',
|
|
2274
2633
|
'type',
|
|
2275
2634
|
'last4',
|
|
2276
2635
|
'exp_month',
|
|
2277
2636
|
'exp_year',
|
|
2278
|
-
'brand'
|
|
2637
|
+
'brand',
|
|
2638
|
+
'iban',
|
|
2639
|
+
'bic',
|
|
2640
|
+
'account_holder_name',
|
|
2641
|
+
'is_default'
|
|
2279
2642
|
],
|
|
2280
2643
|
additionalProperties: false
|
|
2281
2644
|
};
|
|
@@ -2323,7 +2686,7 @@ export const PlatformQuotaSchema = {
|
|
|
2323
2686
|
type: 'array',
|
|
2324
2687
|
items: {
|
|
2325
2688
|
type: 'string',
|
|
2326
|
-
example: 'northamerica-central-
|
|
2689
|
+
example: 'northamerica-central-1a'
|
|
2327
2690
|
},
|
|
2328
2691
|
minItems: 1,
|
|
2329
2692
|
description: 'List of Cloudfleet control plane regions available for the organization.'
|
|
@@ -3412,24 +3775,6 @@ export const UserCreateInputSchema = {
|
|
|
3412
3775
|
type: 'string',
|
|
3413
3776
|
minLength: 8,
|
|
3414
3777
|
description: 'User password. Must be at least 8 characters long.'
|
|
3415
|
-
},
|
|
3416
|
-
status: {
|
|
3417
|
-
type: 'string',
|
|
3418
|
-
description: 'Status of the user. Can be `active` or `inactive`. Inactive users cannot log in or manage organization resources.',
|
|
3419
|
-
example: 'active',
|
|
3420
|
-
enum: [
|
|
3421
|
-
'active',
|
|
3422
|
-
'inactive'
|
|
3423
|
-
]
|
|
3424
|
-
},
|
|
3425
|
-
role: {
|
|
3426
|
-
type: 'string',
|
|
3427
|
-
description: 'User role. Can be \'Administrator\', \'User\'.',
|
|
3428
|
-
example: 'User',
|
|
3429
|
-
enum: [
|
|
3430
|
-
'Administrator',
|
|
3431
|
-
'User'
|
|
3432
|
-
]
|
|
3433
3778
|
}
|
|
3434
3779
|
},
|
|
3435
3780
|
required: [
|