@cloudfleet/sdk 0.0.1-c034297 → 0.0.1-c3098ca
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 +410 -386
- package/dist/@tanstack/react-query.gen.d.ts.map +1 -1
- package/dist/@tanstack/react-query.gen.js +419 -383
- package/dist/@tanstack/react-query.gen.js.map +1 -1
- package/dist/client/client.gen.d.ts.map +1 -1
- package/dist/client/client.gen.js +1 -4
- package/dist/client/client.gen.js.map +1 -1
- package/dist/client/types.gen.d.ts +1 -1
- package/dist/client/types.gen.d.ts.map +1 -1
- package/dist/client/utils.gen.d.ts +2 -2
- 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/schemas.gen.d.ts +395 -76
- package/dist/schemas.gen.d.ts.map +1 -1
- package/dist/schemas.gen.js +504 -136
- package/dist/schemas.gen.js.map +1 -1
- package/dist/sdk.gen.d.ts +228 -216
- package/dist/sdk.gen.d.ts.map +1 -1
- package/dist/sdk.gen.js +328 -312
- package/dist/sdk.gen.js.map +1 -1
- package/dist/types.gen.d.ts +1045 -717
- package/dist/types.gen.d.ts.map +1 -1
- package/dist/zod.gen.d.ts +1583 -1434
- package/dist/zod.gen.d.ts.map +1 -1
- package/dist/zod.gen.js +427 -311
- package/dist/zod.gen.js.map +1 -1
- package/package.json +8 -11
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',
|
|
@@ -446,43 +440,117 @@ export const ClusterCreateInputSchema = {
|
|
|
446
440
|
tier: {
|
|
447
441
|
type: 'string',
|
|
448
442
|
description: 'Tier of the cluster.',
|
|
443
|
+
default: 'basic',
|
|
449
444
|
example: 'pro',
|
|
450
445
|
enum: [
|
|
451
446
|
'basic',
|
|
452
447
|
'pro'
|
|
453
448
|
]
|
|
454
449
|
},
|
|
455
|
-
region: {
|
|
456
|
-
type: 'string',
|
|
457
|
-
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.',
|
|
458
|
-
default: 'staging-1a',
|
|
459
|
-
example: 'northamerica-central-1a',
|
|
460
|
-
enum: [
|
|
461
|
-
'staging-1a',
|
|
462
|
-
'northamerica-central-1',
|
|
463
|
-
'europe-central-1a',
|
|
464
|
-
'northamerica-central-1a'
|
|
465
|
-
]
|
|
466
|
-
},
|
|
467
450
|
version_channel: {
|
|
468
451
|
type: 'string',
|
|
469
452
|
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
453
|
description: 'Version of the kubernetes cluster.',
|
|
471
454
|
default: '1.x.x-cfke.x',
|
|
472
|
-
example: '1.x.x-cfke.x'
|
|
455
|
+
example: '1.x.x-cfke.x'
|
|
456
|
+
},
|
|
457
|
+
release_channel: {
|
|
458
|
+
type: 'string',
|
|
459
|
+
description: 'Release channel for the cluster\'s control plane.',
|
|
460
|
+
default: 'rapid',
|
|
461
|
+
example: 'rapid',
|
|
473
462
|
enum: [
|
|
474
|
-
'
|
|
475
|
-
'
|
|
476
|
-
'
|
|
477
|
-
'1.33.x-cfke.x'
|
|
463
|
+
'rapid',
|
|
464
|
+
'stable',
|
|
465
|
+
'extended'
|
|
478
466
|
]
|
|
467
|
+
},
|
|
468
|
+
features: {
|
|
469
|
+
type: 'object',
|
|
470
|
+
properties: {
|
|
471
|
+
gpu_sharing_strategy: {
|
|
472
|
+
type: 'string',
|
|
473
|
+
description: 'GPU sharing strategy.',
|
|
474
|
+
default: 'none',
|
|
475
|
+
example: 'none',
|
|
476
|
+
enum: [
|
|
477
|
+
'none',
|
|
478
|
+
'mps',
|
|
479
|
+
'time_slicing'
|
|
480
|
+
]
|
|
481
|
+
},
|
|
482
|
+
gpu_max_shared_clients_per_gpu: {
|
|
483
|
+
type: 'integer',
|
|
484
|
+
minimum: 2,
|
|
485
|
+
maximum: 48,
|
|
486
|
+
description: 'Maximum number of pods that may share a single GPU.',
|
|
487
|
+
default: 4,
|
|
488
|
+
example: 10
|
|
489
|
+
},
|
|
490
|
+
cilium_socket_lb_host_namespace_only: {
|
|
491
|
+
type: 'boolean',
|
|
492
|
+
description: 'Restrict Cilium socket load-balancing to the host namespace. Required for the Tailscale operator and Istio.',
|
|
493
|
+
example: false
|
|
494
|
+
}
|
|
495
|
+
},
|
|
496
|
+
additionalProperties: false,
|
|
497
|
+
description: 'Cluster feature toggles.',
|
|
498
|
+
default: {
|
|
499
|
+
gpu_sharing_strategy: 'none',
|
|
500
|
+
gpu_max_shared_clients_per_gpu: 4,
|
|
501
|
+
cilium_socket_lb_host_namespace_only: false
|
|
502
|
+
}
|
|
503
|
+
},
|
|
504
|
+
region: {
|
|
505
|
+
type: 'string',
|
|
506
|
+
description: 'Cloudfleet control plane region. This field can not be updated after creation.',
|
|
507
|
+
example: 'europe-central-1a'
|
|
508
|
+
},
|
|
509
|
+
networking: {
|
|
510
|
+
type: 'object',
|
|
511
|
+
properties: {
|
|
512
|
+
pod_cidr: {
|
|
513
|
+
type: 'string',
|
|
514
|
+
description: 'CIDR block for pod IPs.',
|
|
515
|
+
default: '10.244.0.0/16'
|
|
516
|
+
},
|
|
517
|
+
service_cidr: {
|
|
518
|
+
type: 'string',
|
|
519
|
+
description: 'CIDR block for service IPs.',
|
|
520
|
+
default: '10.96.0.0/12'
|
|
521
|
+
},
|
|
522
|
+
dual_stack: {
|
|
523
|
+
type: 'boolean',
|
|
524
|
+
description: 'Enable IPv4+IPv6 dual-stack networking.'
|
|
525
|
+
},
|
|
526
|
+
pod_cidr_v6: {
|
|
527
|
+
type: 'string',
|
|
528
|
+
description: 'IPv6 pod CIDR. Requires dual_stack.',
|
|
529
|
+
default: '2001:db8:1:2::/48'
|
|
530
|
+
},
|
|
531
|
+
service_cidr_v6: {
|
|
532
|
+
type: 'string',
|
|
533
|
+
description: 'IPv6 service CIDR. Requires dual_stack.',
|
|
534
|
+
default: '2001:db8:1:1::/112'
|
|
535
|
+
}
|
|
536
|
+
},
|
|
537
|
+
additionalProperties: false,
|
|
538
|
+
description: 'Cluster networking configuration. Immutable after creation.',
|
|
539
|
+
default: {
|
|
540
|
+
pod_cidr: '10.244.0.0/16',
|
|
541
|
+
service_cidr: '10.96.0.0/12',
|
|
542
|
+
dual_stack: false,
|
|
543
|
+
pod_cidr_v6: '2001:db8:1:2::/48',
|
|
544
|
+
service_cidr_v6: '2001:db8:1:1::/112'
|
|
545
|
+
}
|
|
479
546
|
}
|
|
480
547
|
},
|
|
481
548
|
required: [
|
|
482
549
|
'name',
|
|
483
|
-
'
|
|
550
|
+
'region'
|
|
484
551
|
],
|
|
485
|
-
additionalProperties: false
|
|
552
|
+
additionalProperties: false,
|
|
553
|
+
description: 'Mutable cluster configuration. Applied as a full overwrite: any omitted field is reset to its default rather than left unchanged.'
|
|
486
554
|
};
|
|
487
555
|
export const ClusterJoinInformationSchema = {
|
|
488
556
|
type: 'object',
|
|
@@ -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',
|
|
@@ -599,24 +673,122 @@ export const ClusterSchema = {
|
|
|
599
673
|
tier: {
|
|
600
674
|
type: 'string',
|
|
601
675
|
description: 'Tier of the cluster.',
|
|
676
|
+
default: 'basic',
|
|
602
677
|
example: 'pro',
|
|
603
678
|
enum: [
|
|
604
679
|
'basic',
|
|
605
680
|
'pro'
|
|
606
681
|
]
|
|
607
682
|
},
|
|
608
|
-
|
|
683
|
+
version_channel: {
|
|
684
|
+
type: 'string',
|
|
685
|
+
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-]+)*))?$',
|
|
686
|
+
description: 'Version of the kubernetes cluster.',
|
|
687
|
+
default: '1.x.x-cfke.x',
|
|
688
|
+
example: '1.x.x-cfke.x'
|
|
689
|
+
},
|
|
690
|
+
release_channel: {
|
|
609
691
|
type: 'string',
|
|
610
|
-
description: '
|
|
611
|
-
default: '
|
|
612
|
-
example: '
|
|
692
|
+
description: 'Release channel for the cluster\'s control plane.',
|
|
693
|
+
default: 'rapid',
|
|
694
|
+
example: 'rapid',
|
|
613
695
|
enum: [
|
|
614
|
-
'
|
|
615
|
-
'
|
|
616
|
-
'
|
|
617
|
-
'northamerica-central-1a'
|
|
696
|
+
'rapid',
|
|
697
|
+
'stable',
|
|
698
|
+
'extended'
|
|
618
699
|
]
|
|
619
700
|
},
|
|
701
|
+
features: {
|
|
702
|
+
type: 'object',
|
|
703
|
+
properties: {
|
|
704
|
+
gpu_sharing_strategy: {
|
|
705
|
+
type: 'string',
|
|
706
|
+
description: 'GPU sharing strategy.',
|
|
707
|
+
default: 'none',
|
|
708
|
+
example: 'none',
|
|
709
|
+
enum: [
|
|
710
|
+
'none',
|
|
711
|
+
'mps',
|
|
712
|
+
'time_slicing'
|
|
713
|
+
]
|
|
714
|
+
},
|
|
715
|
+
gpu_max_shared_clients_per_gpu: {
|
|
716
|
+
type: 'integer',
|
|
717
|
+
minimum: 2,
|
|
718
|
+
maximum: 48,
|
|
719
|
+
description: 'Maximum number of pods that may share a single GPU.',
|
|
720
|
+
default: 4,
|
|
721
|
+
example: 10
|
|
722
|
+
},
|
|
723
|
+
cilium_socket_lb_host_namespace_only: {
|
|
724
|
+
type: 'boolean',
|
|
725
|
+
description: 'Restrict Cilium socket load-balancing to the host namespace. Required for the Tailscale operator and Istio.',
|
|
726
|
+
example: false
|
|
727
|
+
}
|
|
728
|
+
},
|
|
729
|
+
required: [
|
|
730
|
+
'gpu_sharing_strategy',
|
|
731
|
+
'gpu_max_shared_clients_per_gpu',
|
|
732
|
+
'cilium_socket_lb_host_namespace_only'
|
|
733
|
+
],
|
|
734
|
+
additionalProperties: false,
|
|
735
|
+
description: 'Cluster feature toggles.',
|
|
736
|
+
default: {
|
|
737
|
+
gpu_sharing_strategy: 'none',
|
|
738
|
+
gpu_max_shared_clients_per_gpu: 4,
|
|
739
|
+
cilium_socket_lb_host_namespace_only: false
|
|
740
|
+
}
|
|
741
|
+
},
|
|
742
|
+
region: {
|
|
743
|
+
type: 'string',
|
|
744
|
+
description: 'Cloudfleet control plane region. This field can not be updated after creation.',
|
|
745
|
+
example: 'europe-central-1a'
|
|
746
|
+
},
|
|
747
|
+
networking: {
|
|
748
|
+
type: 'object',
|
|
749
|
+
properties: {
|
|
750
|
+
pod_cidr: {
|
|
751
|
+
type: 'string',
|
|
752
|
+
description: 'CIDR block for pod IPs.',
|
|
753
|
+
default: '10.244.0.0/16'
|
|
754
|
+
},
|
|
755
|
+
service_cidr: {
|
|
756
|
+
type: 'string',
|
|
757
|
+
description: 'CIDR block for service IPs.',
|
|
758
|
+
default: '10.96.0.0/12'
|
|
759
|
+
},
|
|
760
|
+
dual_stack: {
|
|
761
|
+
type: 'boolean',
|
|
762
|
+
description: 'Enable IPv4+IPv6 dual-stack networking.'
|
|
763
|
+
},
|
|
764
|
+
pod_cidr_v6: {
|
|
765
|
+
type: 'string',
|
|
766
|
+
description: 'IPv6 pod CIDR. Requires dual_stack.',
|
|
767
|
+
default: '2001:db8:1:2::/48'
|
|
768
|
+
},
|
|
769
|
+
service_cidr_v6: {
|
|
770
|
+
type: 'string',
|
|
771
|
+
description: 'IPv6 service CIDR. Requires dual_stack.',
|
|
772
|
+
default: '2001:db8:1:1::/112'
|
|
773
|
+
}
|
|
774
|
+
},
|
|
775
|
+
required: [
|
|
776
|
+
'pod_cidr',
|
|
777
|
+
'service_cidr',
|
|
778
|
+
'dual_stack',
|
|
779
|
+
'pod_cidr_v6',
|
|
780
|
+
'service_cidr_v6'
|
|
781
|
+
],
|
|
782
|
+
additionalProperties: false,
|
|
783
|
+
description: 'Cluster networking configuration. Immutable after creation.',
|
|
784
|
+
default: {
|
|
785
|
+
pod_cidr: '10.244.0.0/16',
|
|
786
|
+
service_cidr: '10.96.0.0/12',
|
|
787
|
+
dual_stack: false,
|
|
788
|
+
pod_cidr_v6: '2001:db8:1:2::/48',
|
|
789
|
+
service_cidr_v6: '2001:db8:1:1::/112'
|
|
790
|
+
}
|
|
791
|
+
},
|
|
620
792
|
id: {
|
|
621
793
|
type: 'string',
|
|
622
794
|
format: 'uuid',
|
|
@@ -625,16 +797,13 @@ export const ClusterSchema = {
|
|
|
625
797
|
},
|
|
626
798
|
status: {
|
|
627
799
|
type: 'string',
|
|
628
|
-
description: 'Status of the cluster.
|
|
629
|
-
example: '
|
|
800
|
+
description: 'Status of the cluster.',
|
|
801
|
+
example: 'deployed',
|
|
630
802
|
enum: [
|
|
631
|
-
'active',
|
|
632
|
-
'disabled',
|
|
633
|
-
'deleted',
|
|
634
803
|
'creating',
|
|
635
804
|
'deployed',
|
|
636
|
-
'
|
|
637
|
-
'
|
|
805
|
+
'updating',
|
|
806
|
+
'disabled'
|
|
638
807
|
]
|
|
639
808
|
},
|
|
640
809
|
endpoint: {
|
|
@@ -642,8 +811,8 @@ export const ClusterSchema = {
|
|
|
642
811
|
{
|
|
643
812
|
type: 'string',
|
|
644
813
|
format: 'uri',
|
|
645
|
-
description: 'URL signed by
|
|
646
|
-
example: 'https://2ae6557c-c61f-49c6-b4c1-a65473470a03.staging.cfke.
|
|
814
|
+
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.',
|
|
815
|
+
example: 'https://2ae6557c-c61f-49c6-b4c1-a65473470a03.staging.cfke.io'
|
|
647
816
|
},
|
|
648
817
|
{
|
|
649
818
|
type: 'string',
|
|
@@ -658,7 +827,7 @@ export const ClusterSchema = {
|
|
|
658
827
|
{
|
|
659
828
|
type: 'string',
|
|
660
829
|
format: 'uri',
|
|
661
|
-
description: '
|
|
830
|
+
description: 'Deprecated alias of `endpoint`; retained for backward compatibility.',
|
|
662
831
|
example: 'https://2ae6557c-c61f-49c6-b4c1-a65473470a03.staging.cfke.io'
|
|
663
832
|
},
|
|
664
833
|
{
|
|
@@ -693,21 +862,22 @@ export const ClusterSchema = {
|
|
|
693
862
|
type: 'boolean',
|
|
694
863
|
description: 'Indicates if the cluster is ready to be used.',
|
|
695
864
|
example: true
|
|
696
|
-
},
|
|
697
|
-
version_channel: {
|
|
698
|
-
type: 'string',
|
|
699
|
-
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-]+)*))?$',
|
|
700
|
-
description: 'Version of the kubernetes cluster.',
|
|
701
|
-
example: '1.x.x-cfke.x'
|
|
702
865
|
}
|
|
703
866
|
},
|
|
704
867
|
required: [
|
|
705
868
|
'name',
|
|
706
869
|
'tier',
|
|
870
|
+
'version_channel',
|
|
871
|
+
'release_channel',
|
|
872
|
+
'features',
|
|
873
|
+
'region',
|
|
874
|
+
'networking',
|
|
707
875
|
'id',
|
|
708
|
-
'status'
|
|
876
|
+
'status',
|
|
877
|
+
'ready'
|
|
709
878
|
],
|
|
710
|
-
additionalProperties: false
|
|
879
|
+
additionalProperties: false,
|
|
880
|
+
description: 'Mutable cluster configuration. Applied as a full overwrite: any omitted field is reset to its default rather than left unchanged.'
|
|
711
881
|
};
|
|
712
882
|
export const ClusterUpdateInputSchema = {
|
|
713
883
|
type: 'object',
|
|
@@ -723,6 +893,7 @@ export const ClusterUpdateInputSchema = {
|
|
|
723
893
|
tier: {
|
|
724
894
|
type: 'string',
|
|
725
895
|
description: 'Tier of the cluster.',
|
|
896
|
+
default: 'basic',
|
|
726
897
|
example: 'pro',
|
|
727
898
|
enum: [
|
|
728
899
|
'basic',
|
|
@@ -733,13 +904,62 @@ export const ClusterUpdateInputSchema = {
|
|
|
733
904
|
type: 'string',
|
|
734
905
|
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-]+)*))?$',
|
|
735
906
|
description: 'Version of the kubernetes cluster.',
|
|
907
|
+
default: '1.x.x-cfke.x',
|
|
736
908
|
example: '1.x.x-cfke.x'
|
|
909
|
+
},
|
|
910
|
+
release_channel: {
|
|
911
|
+
type: 'string',
|
|
912
|
+
description: 'Release channel for the cluster\'s control plane.',
|
|
913
|
+
default: 'rapid',
|
|
914
|
+
example: 'rapid',
|
|
915
|
+
enum: [
|
|
916
|
+
'rapid',
|
|
917
|
+
'stable',
|
|
918
|
+
'extended'
|
|
919
|
+
]
|
|
920
|
+
},
|
|
921
|
+
features: {
|
|
922
|
+
type: 'object',
|
|
923
|
+
properties: {
|
|
924
|
+
gpu_sharing_strategy: {
|
|
925
|
+
type: 'string',
|
|
926
|
+
description: 'GPU sharing strategy.',
|
|
927
|
+
default: 'none',
|
|
928
|
+
example: 'none',
|
|
929
|
+
enum: [
|
|
930
|
+
'none',
|
|
931
|
+
'mps',
|
|
932
|
+
'time_slicing'
|
|
933
|
+
]
|
|
934
|
+
},
|
|
935
|
+
gpu_max_shared_clients_per_gpu: {
|
|
936
|
+
type: 'integer',
|
|
937
|
+
minimum: 2,
|
|
938
|
+
maximum: 48,
|
|
939
|
+
description: 'Maximum number of pods that may share a single GPU.',
|
|
940
|
+
default: 4,
|
|
941
|
+
example: 10
|
|
942
|
+
},
|
|
943
|
+
cilium_socket_lb_host_namespace_only: {
|
|
944
|
+
type: 'boolean',
|
|
945
|
+
description: 'Restrict Cilium socket load-balancing to the host namespace. Required for the Tailscale operator and Istio.',
|
|
946
|
+
example: false
|
|
947
|
+
}
|
|
948
|
+
},
|
|
949
|
+
additionalProperties: false,
|
|
950
|
+
description: 'Cluster feature toggles.',
|
|
951
|
+
default: {
|
|
952
|
+
gpu_sharing_strategy: 'none',
|
|
953
|
+
gpu_max_shared_clients_per_gpu: 4,
|
|
954
|
+
cilium_socket_lb_host_namespace_only: false
|
|
955
|
+
}
|
|
737
956
|
}
|
|
738
957
|
},
|
|
739
958
|
required: [
|
|
740
|
-
'
|
|
959
|
+
'name'
|
|
741
960
|
],
|
|
742
|
-
additionalProperties: false
|
|
961
|
+
additionalProperties: false,
|
|
962
|
+
description: 'Mutable cluster configuration. Applied as a full overwrite: any omitted field is reset to its default rather than left unchanged.'
|
|
743
963
|
};
|
|
744
964
|
export const FleetCreateInputSchema = {
|
|
745
965
|
type: 'object',
|
|
@@ -1011,7 +1231,8 @@ export const FleetCreateInputSchema = {
|
|
|
1011
1231
|
'z3'
|
|
1012
1232
|
]
|
|
1013
1233
|
},
|
|
1014
|
-
description: 'Allowed values for `cfke.io/instance-family`.'
|
|
1234
|
+
description: 'Allowed values for `cfke.io/instance-family`.',
|
|
1235
|
+
default: []
|
|
1015
1236
|
},
|
|
1016
1237
|
'topology.kubernetes.io/region': {
|
|
1017
1238
|
type: 'array',
|
|
@@ -1084,15 +1305,27 @@ export const FleetCreateInputSchema = {
|
|
|
1084
1305
|
'us-west4'
|
|
1085
1306
|
]
|
|
1086
1307
|
},
|
|
1087
|
-
description: 'Allowed values for `topology.kubernetes.io/region`.'
|
|
1308
|
+
description: 'Allowed values for `topology.kubernetes.io/region`.',
|
|
1309
|
+
default: []
|
|
1088
1310
|
}
|
|
1089
1311
|
},
|
|
1090
1312
|
additionalProperties: false,
|
|
1091
|
-
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.
|
|
1313
|
+
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.',
|
|
1314
|
+
default: {
|
|
1315
|
+
'karpenter.sh/capacity-type': [
|
|
1316
|
+
'on-demand',
|
|
1317
|
+
'spot'
|
|
1318
|
+
],
|
|
1319
|
+
'kubernetes.io/arch': [
|
|
1320
|
+
'amd64'
|
|
1321
|
+
],
|
|
1322
|
+
'cfke.io/instance-family': [],
|
|
1323
|
+
'topology.kubernetes.io/region': []
|
|
1324
|
+
}
|
|
1092
1325
|
},
|
|
1093
1326
|
scalingProfile: {
|
|
1094
1327
|
type: 'string',
|
|
1095
|
-
description: 'Controls scale-up / scale-down responsiveness. `aggressive` prioritizes cost-optimization. `conservative` prioritizes stability of the fleet.',
|
|
1328
|
+
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`).',
|
|
1096
1329
|
default: 'conservative',
|
|
1097
1330
|
example: 'conservative',
|
|
1098
1331
|
enum: [
|
|
@@ -1112,7 +1345,8 @@ export const FleetCreateInputSchema = {
|
|
|
1112
1345
|
required: [
|
|
1113
1346
|
'id'
|
|
1114
1347
|
],
|
|
1115
|
-
additionalProperties: false
|
|
1348
|
+
additionalProperties: false,
|
|
1349
|
+
description: 'Mutable fleet configuration. Applied as a full overwrite: any omitted field is reset to its default rather than left unchanged.'
|
|
1116
1350
|
};
|
|
1117
1351
|
export const FleetSchema = {
|
|
1118
1352
|
type: 'object',
|
|
@@ -1382,7 +1616,8 @@ export const FleetSchema = {
|
|
|
1382
1616
|
'z3'
|
|
1383
1617
|
]
|
|
1384
1618
|
},
|
|
1385
|
-
description: 'Allowed values for `cfke.io/instance-family`.'
|
|
1619
|
+
description: 'Allowed values for `cfke.io/instance-family`.',
|
|
1620
|
+
default: []
|
|
1386
1621
|
},
|
|
1387
1622
|
'topology.kubernetes.io/region': {
|
|
1388
1623
|
type: 'array',
|
|
@@ -1455,15 +1690,31 @@ export const FleetSchema = {
|
|
|
1455
1690
|
'us-west4'
|
|
1456
1691
|
]
|
|
1457
1692
|
},
|
|
1458
|
-
description: 'Allowed values for `topology.kubernetes.io/region`.'
|
|
1693
|
+
description: 'Allowed values for `topology.kubernetes.io/region`.',
|
|
1694
|
+
default: []
|
|
1459
1695
|
}
|
|
1460
1696
|
},
|
|
1697
|
+
required: [
|
|
1698
|
+
'karpenter.sh/capacity-type',
|
|
1699
|
+
'kubernetes.io/arch'
|
|
1700
|
+
],
|
|
1461
1701
|
additionalProperties: false,
|
|
1462
|
-
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.
|
|
1702
|
+
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.',
|
|
1703
|
+
default: {
|
|
1704
|
+
'karpenter.sh/capacity-type': [
|
|
1705
|
+
'on-demand',
|
|
1706
|
+
'spot'
|
|
1707
|
+
],
|
|
1708
|
+
'kubernetes.io/arch': [
|
|
1709
|
+
'amd64'
|
|
1710
|
+
],
|
|
1711
|
+
'cfke.io/instance-family': [],
|
|
1712
|
+
'topology.kubernetes.io/region': []
|
|
1713
|
+
}
|
|
1463
1714
|
},
|
|
1464
1715
|
scalingProfile: {
|
|
1465
1716
|
type: 'string',
|
|
1466
|
-
description: 'Controls scale-up / scale-down responsiveness. `aggressive` prioritizes cost-optimization. `conservative` prioritizes stability of the fleet.',
|
|
1717
|
+
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`).',
|
|
1467
1718
|
default: 'conservative',
|
|
1468
1719
|
example: 'conservative',
|
|
1469
1720
|
enum: [
|
|
@@ -1478,13 +1729,38 @@ export const FleetSchema = {
|
|
|
1478
1729
|
pattern: '^[a-z0-9]([-a-z0-9]*[a-z0-9])?$',
|
|
1479
1730
|
description: 'Unique identifier of the kubernetes fleet.',
|
|
1480
1731
|
example: 'new-clouds-fleet'
|
|
1732
|
+
},
|
|
1733
|
+
ready: {
|
|
1734
|
+
type: 'boolean',
|
|
1735
|
+
description: 'Indicates whether the fleet configuration is healthy.',
|
|
1736
|
+
example: true
|
|
1737
|
+
},
|
|
1738
|
+
status_message: {
|
|
1739
|
+
type: 'string',
|
|
1740
|
+
description: 'Human-readable reason the fleet is not ready. Present only when `ready` is false.',
|
|
1741
|
+
example: 'Invalid provider permissions.'
|
|
1742
|
+
},
|
|
1743
|
+
created_at: {
|
|
1744
|
+
type: 'string',
|
|
1745
|
+
description: 'Creation date and time of the fleet.',
|
|
1746
|
+
example: '2024-09-12T09:11:27Z'
|
|
1747
|
+
},
|
|
1748
|
+
updated_at: {
|
|
1749
|
+
type: 'string',
|
|
1750
|
+
description: 'Date and time the fleet was last updated.',
|
|
1751
|
+
example: '2024-09-12T09:11:27Z'
|
|
1481
1752
|
}
|
|
1482
1753
|
},
|
|
1483
1754
|
required: [
|
|
1755
|
+
'constraints',
|
|
1484
1756
|
'scalingProfile',
|
|
1485
|
-
'id'
|
|
1757
|
+
'id',
|
|
1758
|
+
'ready',
|
|
1759
|
+
'created_at',
|
|
1760
|
+
'updated_at'
|
|
1486
1761
|
],
|
|
1487
|
-
additionalProperties: false
|
|
1762
|
+
additionalProperties: false,
|
|
1763
|
+
description: 'Mutable fleet configuration. Applied as a full overwrite: any omitted field is reset to its default rather than left unchanged.'
|
|
1488
1764
|
};
|
|
1489
1765
|
export const FleetUpdateInputSchema = {
|
|
1490
1766
|
type: 'object',
|
|
@@ -1570,7 +1846,11 @@ export const FleetUpdateInputSchema = {
|
|
|
1570
1846
|
]
|
|
1571
1847
|
},
|
|
1572
1848
|
minItems: 1,
|
|
1573
|
-
description: 'Allowed values for `karpenter.sh/capacity-type`.'
|
|
1849
|
+
description: 'Allowed values for `karpenter.sh/capacity-type`.',
|
|
1850
|
+
default: [
|
|
1851
|
+
'on-demand',
|
|
1852
|
+
'spot'
|
|
1853
|
+
]
|
|
1574
1854
|
},
|
|
1575
1855
|
'kubernetes.io/arch': {
|
|
1576
1856
|
type: 'array',
|
|
@@ -1582,7 +1862,10 @@ export const FleetUpdateInputSchema = {
|
|
|
1582
1862
|
]
|
|
1583
1863
|
},
|
|
1584
1864
|
minItems: 1,
|
|
1585
|
-
description: 'Allowed values for `kubernetes.io/arch`.'
|
|
1865
|
+
description: 'Allowed values for `kubernetes.io/arch`.',
|
|
1866
|
+
default: [
|
|
1867
|
+
'amd64'
|
|
1868
|
+
]
|
|
1586
1869
|
},
|
|
1587
1870
|
'cfke.io/instance-family': {
|
|
1588
1871
|
type: 'array',
|
|
@@ -1749,7 +2032,8 @@ export const FleetUpdateInputSchema = {
|
|
|
1749
2032
|
'z3'
|
|
1750
2033
|
]
|
|
1751
2034
|
},
|
|
1752
|
-
description: 'Allowed values for `cfke.io/instance-family`.'
|
|
2035
|
+
description: 'Allowed values for `cfke.io/instance-family`.',
|
|
2036
|
+
default: []
|
|
1753
2037
|
},
|
|
1754
2038
|
'topology.kubernetes.io/region': {
|
|
1755
2039
|
type: 'array',
|
|
@@ -1822,15 +2106,28 @@ export const FleetUpdateInputSchema = {
|
|
|
1822
2106
|
'us-west4'
|
|
1823
2107
|
]
|
|
1824
2108
|
},
|
|
1825
|
-
description: 'Allowed values for `topology.kubernetes.io/region`.'
|
|
2109
|
+
description: 'Allowed values for `topology.kubernetes.io/region`.',
|
|
2110
|
+
default: []
|
|
1826
2111
|
}
|
|
1827
2112
|
},
|
|
1828
2113
|
additionalProperties: false,
|
|
1829
|
-
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.
|
|
2114
|
+
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.',
|
|
2115
|
+
default: {
|
|
2116
|
+
'karpenter.sh/capacity-type': [
|
|
2117
|
+
'on-demand',
|
|
2118
|
+
'spot'
|
|
2119
|
+
],
|
|
2120
|
+
'kubernetes.io/arch': [
|
|
2121
|
+
'amd64'
|
|
2122
|
+
],
|
|
2123
|
+
'cfke.io/instance-family': [],
|
|
2124
|
+
'topology.kubernetes.io/region': []
|
|
2125
|
+
}
|
|
1830
2126
|
},
|
|
1831
2127
|
scalingProfile: {
|
|
1832
2128
|
type: 'string',
|
|
1833
|
-
description: 'Controls scale-up / scale-down responsiveness. `aggressive` prioritizes cost-optimization. `conservative` prioritizes stability of the fleet.',
|
|
2129
|
+
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`).',
|
|
2130
|
+
default: 'conservative',
|
|
1834
2131
|
example: 'conservative',
|
|
1835
2132
|
enum: [
|
|
1836
2133
|
'aggressive',
|
|
@@ -1838,8 +2135,31 @@ export const FleetUpdateInputSchema = {
|
|
|
1838
2135
|
]
|
|
1839
2136
|
}
|
|
1840
2137
|
},
|
|
2138
|
+
additionalProperties: false,
|
|
2139
|
+
description: 'Mutable fleet configuration. Applied as a full overwrite: any omitted field is reset to its default rather than left unchanged.'
|
|
2140
|
+
};
|
|
2141
|
+
export const InviteCreateInputSchema = {
|
|
2142
|
+
type: 'object',
|
|
2143
|
+
properties: {
|
|
2144
|
+
email: {
|
|
2145
|
+
type: 'string',
|
|
2146
|
+
format: 'email',
|
|
2147
|
+
description: 'Email address of the user to invite.',
|
|
2148
|
+
example: 'email@example.com'
|
|
2149
|
+
},
|
|
2150
|
+
role: {
|
|
2151
|
+
type: 'string',
|
|
2152
|
+
description: 'Role the invited user will be assigned on redemption. Can be \'Administrator\' or \'User\'.',
|
|
2153
|
+
default: 'User',
|
|
2154
|
+
example: 'User',
|
|
2155
|
+
enum: [
|
|
2156
|
+
'Administrator',
|
|
2157
|
+
'User'
|
|
2158
|
+
]
|
|
2159
|
+
}
|
|
2160
|
+
},
|
|
1841
2161
|
required: [
|
|
1842
|
-
'
|
|
2162
|
+
'email'
|
|
1843
2163
|
],
|
|
1844
2164
|
additionalProperties: false
|
|
1845
2165
|
};
|
|
@@ -1873,6 +2193,16 @@ export const InviteSchema = {
|
|
|
1873
2193
|
type: 'string',
|
|
1874
2194
|
description: 'Generated unique invite code.',
|
|
1875
2195
|
example: '7kUZnH7nnKUFfvc4NK2KQF'
|
|
2196
|
+
},
|
|
2197
|
+
role: {
|
|
2198
|
+
type: 'string',
|
|
2199
|
+
description: 'Role the invited user will be assigned on redemption. Can be \'Administrator\' or \'User\'.',
|
|
2200
|
+
default: 'User',
|
|
2201
|
+
example: 'User',
|
|
2202
|
+
enum: [
|
|
2203
|
+
'Administrator',
|
|
2204
|
+
'User'
|
|
2205
|
+
]
|
|
1876
2206
|
}
|
|
1877
2207
|
},
|
|
1878
2208
|
required: [
|
|
@@ -2093,6 +2423,15 @@ export const MarketplaceListingSchema = {
|
|
|
2093
2423
|
export const OrganizationCreateInputSchema = {
|
|
2094
2424
|
type: 'object',
|
|
2095
2425
|
properties: {
|
|
2426
|
+
type: {
|
|
2427
|
+
type: 'string',
|
|
2428
|
+
description: 'Type of the organization. `business` for legal entities, `personal` for individuals.',
|
|
2429
|
+
example: 'business',
|
|
2430
|
+
enum: [
|
|
2431
|
+
'business',
|
|
2432
|
+
'personal'
|
|
2433
|
+
]
|
|
2434
|
+
},
|
|
2096
2435
|
email: {
|
|
2097
2436
|
type: 'string',
|
|
2098
2437
|
format: 'email',
|
|
@@ -2101,11 +2440,13 @@ export const OrganizationCreateInputSchema = {
|
|
|
2101
2440
|
},
|
|
2102
2441
|
first_name: {
|
|
2103
2442
|
type: 'string',
|
|
2443
|
+
minLength: 1,
|
|
2104
2444
|
description: 'First name of the billing contact person.',
|
|
2105
2445
|
example: 'John'
|
|
2106
2446
|
},
|
|
2107
2447
|
last_name: {
|
|
2108
2448
|
type: 'string',
|
|
2449
|
+
minLength: 1,
|
|
2109
2450
|
description: 'Last name of the billing contact person.',
|
|
2110
2451
|
example: 'Doe'
|
|
2111
2452
|
},
|
|
@@ -2124,6 +2465,7 @@ export const OrganizationCreateInputSchema = {
|
|
|
2124
2465
|
}
|
|
2125
2466
|
},
|
|
2126
2467
|
required: [
|
|
2468
|
+
'type',
|
|
2127
2469
|
'email',
|
|
2128
2470
|
'first_name',
|
|
2129
2471
|
'last_name',
|
|
@@ -2132,6 +2474,20 @@ export const OrganizationCreateInputSchema = {
|
|
|
2132
2474
|
],
|
|
2133
2475
|
additionalProperties: false
|
|
2134
2476
|
};
|
|
2477
|
+
export const OrganizationCreateOutputSchema = {
|
|
2478
|
+
type: 'object',
|
|
2479
|
+
properties: {
|
|
2480
|
+
id: {
|
|
2481
|
+
type: 'string',
|
|
2482
|
+
description: 'Unique identifier of the newly created organization. Generated by the API and safe to use for client-side tracking immediately.',
|
|
2483
|
+
example: 'organization-id'
|
|
2484
|
+
}
|
|
2485
|
+
},
|
|
2486
|
+
required: [
|
|
2487
|
+
'id'
|
|
2488
|
+
],
|
|
2489
|
+
additionalProperties: false
|
|
2490
|
+
};
|
|
2135
2491
|
export const OrganizationSchema = {
|
|
2136
2492
|
type: 'object',
|
|
2137
2493
|
properties: {
|
|
@@ -2148,6 +2504,15 @@ export const OrganizationSchema = {
|
|
|
2148
2504
|
description: 'Name of the legal entity. This name will be used in invoices. Use your first and last name for individual accounts.',
|
|
2149
2505
|
example: 'ACME Corp.'
|
|
2150
2506
|
},
|
|
2507
|
+
type: {
|
|
2508
|
+
type: 'string',
|
|
2509
|
+
description: 'Type of the organization. `business` for legal entities, `personal` for individuals.',
|
|
2510
|
+
example: 'business',
|
|
2511
|
+
enum: [
|
|
2512
|
+
'business',
|
|
2513
|
+
'personal'
|
|
2514
|
+
]
|
|
2515
|
+
},
|
|
2151
2516
|
date_created: {
|
|
2152
2517
|
type: 'string',
|
|
2153
2518
|
format: 'date-time',
|
|
@@ -2198,7 +2563,7 @@ export const OrganizationSchema = {
|
|
|
2198
2563
|
type: 'array',
|
|
2199
2564
|
items: {
|
|
2200
2565
|
type: 'string',
|
|
2201
|
-
example: 'northamerica-central-
|
|
2566
|
+
example: 'northamerica-central-1a'
|
|
2202
2567
|
},
|
|
2203
2568
|
minItems: 1,
|
|
2204
2569
|
description: 'List of Cloudfleet control plane regions available for the organization.'
|
|
@@ -2257,13 +2622,25 @@ export const OrganizationSchema = {
|
|
|
2257
2622
|
'closed',
|
|
2258
2623
|
'suspended'
|
|
2259
2624
|
]
|
|
2625
|
+
},
|
|
2626
|
+
verification: {
|
|
2627
|
+
type: 'string',
|
|
2628
|
+
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.',
|
|
2629
|
+
example: 'verified',
|
|
2630
|
+
enum: [
|
|
2631
|
+
'none',
|
|
2632
|
+
'submitted',
|
|
2633
|
+
'verified'
|
|
2634
|
+
]
|
|
2260
2635
|
}
|
|
2261
2636
|
},
|
|
2262
2637
|
required: [
|
|
2263
2638
|
'id',
|
|
2639
|
+
'type',
|
|
2264
2640
|
'date_created',
|
|
2265
2641
|
'quota',
|
|
2266
|
-
'status'
|
|
2642
|
+
'status',
|
|
2643
|
+
'verification'
|
|
2267
2644
|
],
|
|
2268
2645
|
additionalProperties: false
|
|
2269
2646
|
};
|
|
@@ -2272,28 +2649,23 @@ export const PaymentMethodSchema = {
|
|
|
2272
2649
|
properties: {
|
|
2273
2650
|
id: {
|
|
2274
2651
|
type: 'string',
|
|
2275
|
-
|
|
2276
|
-
|
|
2277
|
-
example: 'e94d30ec-a2dd-4dcb-832c-ac2be144ba91'
|
|
2278
|
-
},
|
|
2279
|
-
setup: {
|
|
2280
|
-
type: 'boolean',
|
|
2281
|
-
description: 'Whether organization payment method was set up and ready to use for payments.',
|
|
2282
|
-
example: true
|
|
2652
|
+
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.',
|
|
2653
|
+
example: 'pm_1MtwBwLkdIwHu7ix28a3tqPa'
|
|
2283
2654
|
},
|
|
2284
2655
|
type: {
|
|
2285
2656
|
type: 'string',
|
|
2286
|
-
|
|
2287
|
-
description: 'Payment method type type. Only `card` payments supported at the moment.',
|
|
2657
|
+
description: 'Payment method type. `card`, `sepa_debit` for SEPA Direct Debit (business accounts only), or `bank_transfer` for paying invoices by bank transfer.',
|
|
2288
2658
|
example: 'card',
|
|
2289
2659
|
enum: [
|
|
2290
|
-
'card'
|
|
2660
|
+
'card',
|
|
2661
|
+
'sepa_debit',
|
|
2662
|
+
'bank_transfer'
|
|
2291
2663
|
]
|
|
2292
2664
|
},
|
|
2293
2665
|
last4: {
|
|
2294
2666
|
type: 'string',
|
|
2295
2667
|
nullable: true,
|
|
2296
|
-
description: 'Last 4 digits of the payment card number.',
|
|
2668
|
+
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.',
|
|
2297
2669
|
example: '4242'
|
|
2298
2670
|
},
|
|
2299
2671
|
exp_month: {
|
|
@@ -2301,42 +2673,56 @@ export const PaymentMethodSchema = {
|
|
|
2301
2673
|
minimum: 1,
|
|
2302
2674
|
maximum: 12,
|
|
2303
2675
|
nullable: true,
|
|
2304
|
-
description: 'Two-digit number representing the card\'s expiration month.',
|
|
2305
|
-
example:
|
|
2676
|
+
description: 'Two-digit number representing the card\'s expiration month. Null for SEPA Direct Debit and bank transfer.',
|
|
2677
|
+
example: 12
|
|
2306
2678
|
},
|
|
2307
2679
|
exp_year: {
|
|
2308
2680
|
type: 'integer',
|
|
2309
|
-
minimum: 2024,
|
|
2310
2681
|
nullable: true,
|
|
2311
|
-
description: 'Four-digit number representing the card\'s expiration year.',
|
|
2312
|
-
example:
|
|
2682
|
+
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.',
|
|
2683
|
+
example: 2028
|
|
2313
2684
|
},
|
|
2314
2685
|
brand: {
|
|
2315
2686
|
type: 'string',
|
|
2316
2687
|
nullable: true,
|
|
2317
|
-
description: 'Payment card brand
|
|
2318
|
-
example: 'visa'
|
|
2319
|
-
|
|
2320
|
-
|
|
2321
|
-
|
|
2322
|
-
|
|
2323
|
-
|
|
2324
|
-
|
|
2325
|
-
|
|
2326
|
-
|
|
2327
|
-
|
|
2328
|
-
|
|
2329
|
-
|
|
2688
|
+
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.',
|
|
2689
|
+
example: 'visa'
|
|
2690
|
+
},
|
|
2691
|
+
iban: {
|
|
2692
|
+
type: 'string',
|
|
2693
|
+
nullable: true,
|
|
2694
|
+
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.',
|
|
2695
|
+
example: 'DE11243015658023127510'
|
|
2696
|
+
},
|
|
2697
|
+
bic: {
|
|
2698
|
+
type: 'string',
|
|
2699
|
+
nullable: true,
|
|
2700
|
+
description: 'BIC/SWIFT of the destination bank for bank transfers. Set only for `bank_transfer`; null otherwise.',
|
|
2701
|
+
example: 'SOGEDEFFXXX'
|
|
2702
|
+
},
|
|
2703
|
+
account_holder_name: {
|
|
2704
|
+
type: 'string',
|
|
2705
|
+
nullable: true,
|
|
2706
|
+
description: 'Account holder name of the destination bank account for bank transfers. Set only for `bank_transfer`; null otherwise.',
|
|
2707
|
+
example: 'Cloudfleet GmbH'
|
|
2708
|
+
},
|
|
2709
|
+
is_default: {
|
|
2710
|
+
type: 'boolean',
|
|
2711
|
+
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).',
|
|
2712
|
+
example: true
|
|
2330
2713
|
}
|
|
2331
2714
|
},
|
|
2332
2715
|
required: [
|
|
2333
2716
|
'id',
|
|
2334
|
-
'setup',
|
|
2335
2717
|
'type',
|
|
2336
2718
|
'last4',
|
|
2337
2719
|
'exp_month',
|
|
2338
2720
|
'exp_year',
|
|
2339
|
-
'brand'
|
|
2721
|
+
'brand',
|
|
2722
|
+
'iban',
|
|
2723
|
+
'bic',
|
|
2724
|
+
'account_holder_name',
|
|
2725
|
+
'is_default'
|
|
2340
2726
|
],
|
|
2341
2727
|
additionalProperties: false
|
|
2342
2728
|
};
|
|
@@ -2384,7 +2770,7 @@ export const PlatformQuotaSchema = {
|
|
|
2384
2770
|
type: 'array',
|
|
2385
2771
|
items: {
|
|
2386
2772
|
type: 'string',
|
|
2387
|
-
example: 'northamerica-central-
|
|
2773
|
+
example: 'northamerica-central-1a'
|
|
2388
2774
|
},
|
|
2389
2775
|
minItems: 1,
|
|
2390
2776
|
description: 'List of Cloudfleet control plane regions available for the organization.'
|
|
@@ -3473,24 +3859,6 @@ export const UserCreateInputSchema = {
|
|
|
3473
3859
|
type: 'string',
|
|
3474
3860
|
minLength: 8,
|
|
3475
3861
|
description: 'User password. Must be at least 8 characters long.'
|
|
3476
|
-
},
|
|
3477
|
-
status: {
|
|
3478
|
-
type: 'string',
|
|
3479
|
-
description: 'Status of the user. Can be `active` or `inactive`. Inactive users cannot log in or manage organization resources.',
|
|
3480
|
-
example: 'active',
|
|
3481
|
-
enum: [
|
|
3482
|
-
'active',
|
|
3483
|
-
'inactive'
|
|
3484
|
-
]
|
|
3485
|
-
},
|
|
3486
|
-
role: {
|
|
3487
|
-
type: 'string',
|
|
3488
|
-
description: 'User role. Can be \'Administrator\', \'User\'.',
|
|
3489
|
-
example: 'User',
|
|
3490
|
-
enum: [
|
|
3491
|
-
'Administrator',
|
|
3492
|
-
'User'
|
|
3493
|
-
]
|
|
3494
3862
|
}
|
|
3495
3863
|
},
|
|
3496
3864
|
required: [
|