@cloudfleet/sdk 0.0.1-c144916 → 0.0.1-c21ba6a
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 +489 -588
- package/dist/@tanstack/react-query.gen.d.ts.map +1 -1
- package/dist/@tanstack/react-query.gen.js +447 -382
- 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 +576 -225
- package/dist/schemas.gen.d.ts.map +1 -1
- package/dist/schemas.gen.js +781 -321
- package/dist/schemas.gen.js.map +1 -1
- package/dist/sdk.gen.d.ts +243 -214
- package/dist/sdk.gen.d.ts.map +1 -1
- package/dist/sdk.gen.js +347 -312
- package/dist/sdk.gen.js.map +1 -1
- package/dist/types.gen.d.ts +1164 -789
- package/dist/types.gen.d.ts.map +1 -1
- package/dist/zod.gen.d.ts +1722 -1475
- package/dist/zod.gen.d.ts.map +1 -1
- package/dist/zod.gen.js +533 -355
- package/dist/zod.gen.js.map +1 -1
- package/package.json +10 -13
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,22 +440,12 @@ 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
|
-
'pro'
|
|
453
|
-
|
|
454
|
-
},
|
|
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'
|
|
447
|
+
'pro',
|
|
448
|
+
'enterprise'
|
|
465
449
|
]
|
|
466
450
|
},
|
|
467
451
|
version_channel: {
|
|
@@ -469,20 +453,105 @@ export const ClusterCreateInputSchema = {
|
|
|
469
453
|
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
454
|
description: 'Version of the kubernetes cluster.',
|
|
471
455
|
default: '1.x.x-cfke.x',
|
|
472
|
-
example: '1.x.x-cfke.x'
|
|
456
|
+
example: '1.x.x-cfke.x'
|
|
457
|
+
},
|
|
458
|
+
release_channel: {
|
|
459
|
+
type: 'string',
|
|
460
|
+
description: 'Release channel for the cluster\'s control plane.',
|
|
461
|
+
default: 'rapid',
|
|
462
|
+
example: 'rapid',
|
|
473
463
|
enum: [
|
|
474
|
-
'
|
|
475
|
-
'
|
|
476
|
-
'
|
|
477
|
-
'1.33.x-cfke.x'
|
|
464
|
+
'rapid',
|
|
465
|
+
'stable',
|
|
466
|
+
'extended'
|
|
478
467
|
]
|
|
468
|
+
},
|
|
469
|
+
features: {
|
|
470
|
+
type: 'object',
|
|
471
|
+
properties: {
|
|
472
|
+
gpu_sharing_strategy: {
|
|
473
|
+
type: 'string',
|
|
474
|
+
description: 'GPU sharing strategy.',
|
|
475
|
+
default: 'none',
|
|
476
|
+
example: 'none',
|
|
477
|
+
enum: [
|
|
478
|
+
'none',
|
|
479
|
+
'mps',
|
|
480
|
+
'time_slicing'
|
|
481
|
+
]
|
|
482
|
+
},
|
|
483
|
+
gpu_max_shared_clients_per_gpu: {
|
|
484
|
+
type: 'integer',
|
|
485
|
+
minimum: 2,
|
|
486
|
+
maximum: 48,
|
|
487
|
+
description: 'Maximum number of pods that may share a single GPU.',
|
|
488
|
+
default: 4,
|
|
489
|
+
example: 10
|
|
490
|
+
},
|
|
491
|
+
cilium_socket_lb_host_namespace_only: {
|
|
492
|
+
type: 'boolean',
|
|
493
|
+
description: 'Restrict Cilium socket load-balancing to the host namespace. Required for the Tailscale operator and Istio.',
|
|
494
|
+
example: false
|
|
495
|
+
}
|
|
496
|
+
},
|
|
497
|
+
additionalProperties: false,
|
|
498
|
+
description: 'Cluster feature toggles.',
|
|
499
|
+
default: {
|
|
500
|
+
gpu_sharing_strategy: 'none',
|
|
501
|
+
gpu_max_shared_clients_per_gpu: 4,
|
|
502
|
+
cilium_socket_lb_host_namespace_only: false
|
|
503
|
+
}
|
|
504
|
+
},
|
|
505
|
+
region: {
|
|
506
|
+
type: 'string',
|
|
507
|
+
description: 'Cloudfleet control plane region. This field can not be updated after creation.',
|
|
508
|
+
example: 'europe-central-1a'
|
|
509
|
+
},
|
|
510
|
+
networking: {
|
|
511
|
+
type: 'object',
|
|
512
|
+
properties: {
|
|
513
|
+
pod_cidr: {
|
|
514
|
+
type: 'string',
|
|
515
|
+
description: 'CIDR block for pod IPs.',
|
|
516
|
+
default: '10.244.0.0/16'
|
|
517
|
+
},
|
|
518
|
+
service_cidr: {
|
|
519
|
+
type: 'string',
|
|
520
|
+
description: 'CIDR block for service IPs.',
|
|
521
|
+
default: '10.96.0.0/12'
|
|
522
|
+
},
|
|
523
|
+
dual_stack: {
|
|
524
|
+
type: 'boolean',
|
|
525
|
+
description: 'Enable IPv4+IPv6 dual-stack networking.'
|
|
526
|
+
},
|
|
527
|
+
pod_cidr_v6: {
|
|
528
|
+
type: 'string',
|
|
529
|
+
description: 'IPv6 pod CIDR. Requires dual_stack.',
|
|
530
|
+
default: '2001:db8:1:2::/48'
|
|
531
|
+
},
|
|
532
|
+
service_cidr_v6: {
|
|
533
|
+
type: 'string',
|
|
534
|
+
description: 'IPv6 service CIDR. Requires dual_stack.',
|
|
535
|
+
default: '2001:db8:1:1::/112'
|
|
536
|
+
}
|
|
537
|
+
},
|
|
538
|
+
additionalProperties: false,
|
|
539
|
+
description: 'Cluster networking configuration. Immutable after creation.',
|
|
540
|
+
default: {
|
|
541
|
+
pod_cidr: '10.244.0.0/16',
|
|
542
|
+
service_cidr: '10.96.0.0/12',
|
|
543
|
+
dual_stack: false,
|
|
544
|
+
pod_cidr_v6: '2001:db8:1:2::/48',
|
|
545
|
+
service_cidr_v6: '2001:db8:1:1::/112'
|
|
546
|
+
}
|
|
479
547
|
}
|
|
480
548
|
},
|
|
481
549
|
required: [
|
|
482
550
|
'name',
|
|
483
|
-
'
|
|
551
|
+
'region'
|
|
484
552
|
],
|
|
485
|
-
additionalProperties: false
|
|
553
|
+
additionalProperties: false,
|
|
554
|
+
description: 'Mutable cluster configuration. Applied as a full overwrite: any omitted field is reset to its default rather than left unchanged.'
|
|
486
555
|
};
|
|
487
556
|
export const ClusterJoinInformationSchema = {
|
|
488
557
|
type: 'object',
|
|
@@ -503,11 +572,21 @@ export const ClusterJoinInformationSchema = {
|
|
|
503
572
|
description: 'Cluster DNS IP address. This is the IP address of the kube-dns service in the cluster.',
|
|
504
573
|
example: '10.96.0.10'
|
|
505
574
|
},
|
|
575
|
+
pod_cidr: {
|
|
576
|
+
type: 'string',
|
|
577
|
+
description: 'Pod CIDR for the cluster. Used to configure iptables rules on nodes to prevent Tailscale routing loops.',
|
|
578
|
+
example: '10.244.0.0/16'
|
|
579
|
+
},
|
|
506
580
|
auth_key: {
|
|
507
581
|
type: 'string',
|
|
508
582
|
description: 'Authentication key for the cluster.',
|
|
509
583
|
example: 'tskey-auth-kBV8wr1dk911CNTRL-...'
|
|
510
584
|
},
|
|
585
|
+
login_server: {
|
|
586
|
+
type: 'string',
|
|
587
|
+
description: 'Coordination server the node registers against. Empty on data plane v1 clusters, where the node advertises its own tag instead. A non-empty value requires a client that declares the dataplane-v2 capability.',
|
|
588
|
+
example: 'https://415026b6-f00f-44f8-968d-fc6ef4d0fc6d.fabric.europe-central-1a.cfke.io'
|
|
589
|
+
},
|
|
511
590
|
bootstrap_token: {
|
|
512
591
|
type: 'string',
|
|
513
592
|
description: 'Bootstrap token for the cluster.',
|
|
@@ -578,7 +657,9 @@ export const ClusterJoinInformationSchema = {
|
|
|
578
657
|
'certificate_authority',
|
|
579
658
|
'endpoint',
|
|
580
659
|
'cluster_dns',
|
|
660
|
+
'pod_cidr',
|
|
581
661
|
'auth_key',
|
|
662
|
+
'login_server',
|
|
582
663
|
'bootstrap_token',
|
|
583
664
|
'versions',
|
|
584
665
|
'third_party_api_access_config'
|
|
@@ -599,24 +680,123 @@ export const ClusterSchema = {
|
|
|
599
680
|
tier: {
|
|
600
681
|
type: 'string',
|
|
601
682
|
description: 'Tier of the cluster.',
|
|
683
|
+
default: 'basic',
|
|
602
684
|
example: 'pro',
|
|
603
685
|
enum: [
|
|
604
686
|
'basic',
|
|
605
|
-
'pro'
|
|
687
|
+
'pro',
|
|
688
|
+
'enterprise'
|
|
606
689
|
]
|
|
607
690
|
},
|
|
608
|
-
|
|
691
|
+
version_channel: {
|
|
692
|
+
type: 'string',
|
|
693
|
+
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-]+)*))?$',
|
|
694
|
+
description: 'Version of the kubernetes cluster.',
|
|
695
|
+
default: '1.x.x-cfke.x',
|
|
696
|
+
example: '1.x.x-cfke.x'
|
|
697
|
+
},
|
|
698
|
+
release_channel: {
|
|
609
699
|
type: 'string',
|
|
610
|
-
description: '
|
|
611
|
-
default: '
|
|
612
|
-
example: '
|
|
700
|
+
description: 'Release channel for the cluster\'s control plane.',
|
|
701
|
+
default: 'rapid',
|
|
702
|
+
example: 'rapid',
|
|
613
703
|
enum: [
|
|
614
|
-
'
|
|
615
|
-
'
|
|
616
|
-
'
|
|
617
|
-
'northamerica-central-1a'
|
|
704
|
+
'rapid',
|
|
705
|
+
'stable',
|
|
706
|
+
'extended'
|
|
618
707
|
]
|
|
619
708
|
},
|
|
709
|
+
features: {
|
|
710
|
+
type: 'object',
|
|
711
|
+
properties: {
|
|
712
|
+
gpu_sharing_strategy: {
|
|
713
|
+
type: 'string',
|
|
714
|
+
description: 'GPU sharing strategy.',
|
|
715
|
+
default: 'none',
|
|
716
|
+
example: 'none',
|
|
717
|
+
enum: [
|
|
718
|
+
'none',
|
|
719
|
+
'mps',
|
|
720
|
+
'time_slicing'
|
|
721
|
+
]
|
|
722
|
+
},
|
|
723
|
+
gpu_max_shared_clients_per_gpu: {
|
|
724
|
+
type: 'integer',
|
|
725
|
+
minimum: 2,
|
|
726
|
+
maximum: 48,
|
|
727
|
+
description: 'Maximum number of pods that may share a single GPU.',
|
|
728
|
+
default: 4,
|
|
729
|
+
example: 10
|
|
730
|
+
},
|
|
731
|
+
cilium_socket_lb_host_namespace_only: {
|
|
732
|
+
type: 'boolean',
|
|
733
|
+
description: 'Restrict Cilium socket load-balancing to the host namespace. Required for the Tailscale operator and Istio.',
|
|
734
|
+
example: false
|
|
735
|
+
}
|
|
736
|
+
},
|
|
737
|
+
required: [
|
|
738
|
+
'gpu_sharing_strategy',
|
|
739
|
+
'gpu_max_shared_clients_per_gpu',
|
|
740
|
+
'cilium_socket_lb_host_namespace_only'
|
|
741
|
+
],
|
|
742
|
+
additionalProperties: false,
|
|
743
|
+
description: 'Cluster feature toggles.',
|
|
744
|
+
default: {
|
|
745
|
+
gpu_sharing_strategy: 'none',
|
|
746
|
+
gpu_max_shared_clients_per_gpu: 4,
|
|
747
|
+
cilium_socket_lb_host_namespace_only: false
|
|
748
|
+
}
|
|
749
|
+
},
|
|
750
|
+
region: {
|
|
751
|
+
type: 'string',
|
|
752
|
+
description: 'Cloudfleet control plane region. This field can not be updated after creation.',
|
|
753
|
+
example: 'europe-central-1a'
|
|
754
|
+
},
|
|
755
|
+
networking: {
|
|
756
|
+
type: 'object',
|
|
757
|
+
properties: {
|
|
758
|
+
pod_cidr: {
|
|
759
|
+
type: 'string',
|
|
760
|
+
description: 'CIDR block for pod IPs.',
|
|
761
|
+
default: '10.244.0.0/16'
|
|
762
|
+
},
|
|
763
|
+
service_cidr: {
|
|
764
|
+
type: 'string',
|
|
765
|
+
description: 'CIDR block for service IPs.',
|
|
766
|
+
default: '10.96.0.0/12'
|
|
767
|
+
},
|
|
768
|
+
dual_stack: {
|
|
769
|
+
type: 'boolean',
|
|
770
|
+
description: 'Enable IPv4+IPv6 dual-stack networking.'
|
|
771
|
+
},
|
|
772
|
+
pod_cidr_v6: {
|
|
773
|
+
type: 'string',
|
|
774
|
+
description: 'IPv6 pod CIDR. Requires dual_stack.',
|
|
775
|
+
default: '2001:db8:1:2::/48'
|
|
776
|
+
},
|
|
777
|
+
service_cidr_v6: {
|
|
778
|
+
type: 'string',
|
|
779
|
+
description: 'IPv6 service CIDR. Requires dual_stack.',
|
|
780
|
+
default: '2001:db8:1:1::/112'
|
|
781
|
+
}
|
|
782
|
+
},
|
|
783
|
+
required: [
|
|
784
|
+
'pod_cidr',
|
|
785
|
+
'service_cidr',
|
|
786
|
+
'dual_stack',
|
|
787
|
+
'pod_cidr_v6',
|
|
788
|
+
'service_cidr_v6'
|
|
789
|
+
],
|
|
790
|
+
additionalProperties: false,
|
|
791
|
+
description: 'Cluster networking configuration. Immutable after creation.',
|
|
792
|
+
default: {
|
|
793
|
+
pod_cidr: '10.244.0.0/16',
|
|
794
|
+
service_cidr: '10.96.0.0/12',
|
|
795
|
+
dual_stack: false,
|
|
796
|
+
pod_cidr_v6: '2001:db8:1:2::/48',
|
|
797
|
+
service_cidr_v6: '2001:db8:1:1::/112'
|
|
798
|
+
}
|
|
799
|
+
},
|
|
620
800
|
id: {
|
|
621
801
|
type: 'string',
|
|
622
802
|
format: 'uuid',
|
|
@@ -625,16 +805,13 @@ export const ClusterSchema = {
|
|
|
625
805
|
},
|
|
626
806
|
status: {
|
|
627
807
|
type: 'string',
|
|
628
|
-
description: 'Status of the cluster.
|
|
629
|
-
example: '
|
|
808
|
+
description: 'Status of the cluster.',
|
|
809
|
+
example: 'deployed',
|
|
630
810
|
enum: [
|
|
631
|
-
'active',
|
|
632
|
-
'disabled',
|
|
633
|
-
'deleted',
|
|
634
811
|
'creating',
|
|
635
812
|
'deployed',
|
|
636
|
-
'
|
|
637
|
-
'
|
|
813
|
+
'updating',
|
|
814
|
+
'disabled'
|
|
638
815
|
]
|
|
639
816
|
},
|
|
640
817
|
endpoint: {
|
|
@@ -642,8 +819,8 @@ export const ClusterSchema = {
|
|
|
642
819
|
{
|
|
643
820
|
type: 'string',
|
|
644
821
|
format: 'uri',
|
|
645
|
-
description: 'URL signed by
|
|
646
|
-
example: 'https://2ae6557c-c61f-49c6-b4c1-a65473470a03.staging.cfke.
|
|
822
|
+
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.',
|
|
823
|
+
example: 'https://2ae6557c-c61f-49c6-b4c1-a65473470a03.staging.cfke.io'
|
|
647
824
|
},
|
|
648
825
|
{
|
|
649
826
|
type: 'string',
|
|
@@ -658,7 +835,7 @@ export const ClusterSchema = {
|
|
|
658
835
|
{
|
|
659
836
|
type: 'string',
|
|
660
837
|
format: 'uri',
|
|
661
|
-
description: '
|
|
838
|
+
description: 'Deprecated alias of `endpoint`; retained for backward compatibility.',
|
|
662
839
|
example: 'https://2ae6557c-c61f-49c6-b4c1-a65473470a03.staging.cfke.io'
|
|
663
840
|
},
|
|
664
841
|
{
|
|
@@ -693,21 +870,22 @@ export const ClusterSchema = {
|
|
|
693
870
|
type: 'boolean',
|
|
694
871
|
description: 'Indicates if the cluster is ready to be used.',
|
|
695
872
|
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
873
|
}
|
|
703
874
|
},
|
|
704
875
|
required: [
|
|
705
876
|
'name',
|
|
706
877
|
'tier',
|
|
878
|
+
'version_channel',
|
|
879
|
+
'release_channel',
|
|
880
|
+
'features',
|
|
881
|
+
'region',
|
|
882
|
+
'networking',
|
|
707
883
|
'id',
|
|
708
|
-
'status'
|
|
884
|
+
'status',
|
|
885
|
+
'ready'
|
|
709
886
|
],
|
|
710
|
-
additionalProperties: false
|
|
887
|
+
additionalProperties: false,
|
|
888
|
+
description: 'Mutable cluster configuration. Applied as a full overwrite: any omitted field is reset to its default rather than left unchanged.'
|
|
711
889
|
};
|
|
712
890
|
export const ClusterUpdateInputSchema = {
|
|
713
891
|
type: 'object',
|
|
@@ -723,23 +901,74 @@ export const ClusterUpdateInputSchema = {
|
|
|
723
901
|
tier: {
|
|
724
902
|
type: 'string',
|
|
725
903
|
description: 'Tier of the cluster.',
|
|
904
|
+
default: 'basic',
|
|
726
905
|
example: 'pro',
|
|
727
906
|
enum: [
|
|
728
907
|
'basic',
|
|
729
|
-
'pro'
|
|
908
|
+
'pro',
|
|
909
|
+
'enterprise'
|
|
730
910
|
]
|
|
731
911
|
},
|
|
732
912
|
version_channel: {
|
|
733
913
|
type: 'string',
|
|
734
914
|
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
915
|
description: 'Version of the kubernetes cluster.',
|
|
916
|
+
default: '1.x.x-cfke.x',
|
|
736
917
|
example: '1.x.x-cfke.x'
|
|
918
|
+
},
|
|
919
|
+
release_channel: {
|
|
920
|
+
type: 'string',
|
|
921
|
+
description: 'Release channel for the cluster\'s control plane.',
|
|
922
|
+
default: 'rapid',
|
|
923
|
+
example: 'rapid',
|
|
924
|
+
enum: [
|
|
925
|
+
'rapid',
|
|
926
|
+
'stable',
|
|
927
|
+
'extended'
|
|
928
|
+
]
|
|
929
|
+
},
|
|
930
|
+
features: {
|
|
931
|
+
type: 'object',
|
|
932
|
+
properties: {
|
|
933
|
+
gpu_sharing_strategy: {
|
|
934
|
+
type: 'string',
|
|
935
|
+
description: 'GPU sharing strategy.',
|
|
936
|
+
default: 'none',
|
|
937
|
+
example: 'none',
|
|
938
|
+
enum: [
|
|
939
|
+
'none',
|
|
940
|
+
'mps',
|
|
941
|
+
'time_slicing'
|
|
942
|
+
]
|
|
943
|
+
},
|
|
944
|
+
gpu_max_shared_clients_per_gpu: {
|
|
945
|
+
type: 'integer',
|
|
946
|
+
minimum: 2,
|
|
947
|
+
maximum: 48,
|
|
948
|
+
description: 'Maximum number of pods that may share a single GPU.',
|
|
949
|
+
default: 4,
|
|
950
|
+
example: 10
|
|
951
|
+
},
|
|
952
|
+
cilium_socket_lb_host_namespace_only: {
|
|
953
|
+
type: 'boolean',
|
|
954
|
+
description: 'Restrict Cilium socket load-balancing to the host namespace. Required for the Tailscale operator and Istio.',
|
|
955
|
+
example: false
|
|
956
|
+
}
|
|
957
|
+
},
|
|
958
|
+
additionalProperties: false,
|
|
959
|
+
description: 'Cluster feature toggles.',
|
|
960
|
+
default: {
|
|
961
|
+
gpu_sharing_strategy: 'none',
|
|
962
|
+
gpu_max_shared_clients_per_gpu: 4,
|
|
963
|
+
cilium_socket_lb_host_namespace_only: false
|
|
964
|
+
}
|
|
737
965
|
}
|
|
738
966
|
},
|
|
739
967
|
required: [
|
|
740
|
-
'
|
|
968
|
+
'name'
|
|
741
969
|
],
|
|
742
|
-
additionalProperties: false
|
|
970
|
+
additionalProperties: false,
|
|
971
|
+
description: 'Mutable cluster configuration. Applied as a full overwrite: any omitted field is reset to its default rather than left unchanged.'
|
|
743
972
|
};
|
|
744
973
|
export const FleetCreateInputSchema = {
|
|
745
974
|
type: 'object',
|
|
@@ -785,8 +1014,8 @@ export const FleetCreateInputSchema = {
|
|
|
785
1014
|
type: 'string',
|
|
786
1015
|
maxLength: 64,
|
|
787
1016
|
minLength: 64,
|
|
788
|
-
pattern: '^[A-Za-z0-9]
|
|
789
|
-
description: 'Hetzner Cloud API token with read
|
|
1017
|
+
pattern: '^([A-Za-z0-9]{64}|\\*{64})$',
|
|
1018
|
+
description: 'Hetzner Cloud API token with read/write access (64 alphanumeric characters). Write-only: reads return a redacted placeholder, never the token. Omit the field, or send the placeholder back unchanged, to keep the existing key. Send a new value to rotate it.'
|
|
790
1019
|
}
|
|
791
1020
|
},
|
|
792
1021
|
required: [
|
|
@@ -824,7 +1053,12 @@ export const FleetCreateInputSchema = {
|
|
|
824
1053
|
'spot'
|
|
825
1054
|
]
|
|
826
1055
|
},
|
|
827
|
-
|
|
1056
|
+
minItems: 1,
|
|
1057
|
+
description: 'Allowed values for `karpenter.sh/capacity-type`.',
|
|
1058
|
+
default: [
|
|
1059
|
+
'on-demand',
|
|
1060
|
+
'spot'
|
|
1061
|
+
]
|
|
828
1062
|
},
|
|
829
1063
|
'kubernetes.io/arch': {
|
|
830
1064
|
type: 'array',
|
|
@@ -835,7 +1069,11 @@ export const FleetCreateInputSchema = {
|
|
|
835
1069
|
'arm64'
|
|
836
1070
|
]
|
|
837
1071
|
},
|
|
838
|
-
|
|
1072
|
+
minItems: 1,
|
|
1073
|
+
description: 'Allowed values for `kubernetes.io/arch`.',
|
|
1074
|
+
default: [
|
|
1075
|
+
'amd64'
|
|
1076
|
+
]
|
|
839
1077
|
},
|
|
840
1078
|
'cfke.io/instance-family': {
|
|
841
1079
|
type: 'array',
|
|
@@ -1002,7 +1240,8 @@ export const FleetCreateInputSchema = {
|
|
|
1002
1240
|
'z3'
|
|
1003
1241
|
]
|
|
1004
1242
|
},
|
|
1005
|
-
description: 'Allowed values for `cfke.io/instance-family`.'
|
|
1243
|
+
description: 'Allowed values for `cfke.io/instance-family`.',
|
|
1244
|
+
default: []
|
|
1006
1245
|
},
|
|
1007
1246
|
'topology.kubernetes.io/region': {
|
|
1008
1247
|
type: 'array',
|
|
@@ -1075,15 +1314,27 @@ export const FleetCreateInputSchema = {
|
|
|
1075
1314
|
'us-west4'
|
|
1076
1315
|
]
|
|
1077
1316
|
},
|
|
1078
|
-
description: 'Allowed values for `topology.kubernetes.io/region`.'
|
|
1317
|
+
description: 'Allowed values for `topology.kubernetes.io/region`.',
|
|
1318
|
+
default: []
|
|
1079
1319
|
}
|
|
1080
1320
|
},
|
|
1081
1321
|
additionalProperties: false,
|
|
1082
|
-
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.
|
|
1322
|
+
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.',
|
|
1323
|
+
default: {
|
|
1324
|
+
'karpenter.sh/capacity-type': [
|
|
1325
|
+
'on-demand',
|
|
1326
|
+
'spot'
|
|
1327
|
+
],
|
|
1328
|
+
'kubernetes.io/arch': [
|
|
1329
|
+
'amd64'
|
|
1330
|
+
],
|
|
1331
|
+
'cfke.io/instance-family': [],
|
|
1332
|
+
'topology.kubernetes.io/region': []
|
|
1333
|
+
}
|
|
1083
1334
|
},
|
|
1084
1335
|
scalingProfile: {
|
|
1085
1336
|
type: 'string',
|
|
1086
|
-
description: 'Controls scale-up / scale-down responsiveness. `aggressive` prioritizes cost-optimization. `conservative` prioritizes stability of the fleet.',
|
|
1337
|
+
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`).',
|
|
1087
1338
|
default: 'conservative',
|
|
1088
1339
|
example: 'conservative',
|
|
1089
1340
|
enum: [
|
|
@@ -1103,7 +1354,8 @@ export const FleetCreateInputSchema = {
|
|
|
1103
1354
|
required: [
|
|
1104
1355
|
'id'
|
|
1105
1356
|
],
|
|
1106
|
-
additionalProperties: false
|
|
1357
|
+
additionalProperties: false,
|
|
1358
|
+
description: 'Mutable fleet configuration. Applied as a full overwrite: any omitted field is reset to its default rather than left unchanged.'
|
|
1107
1359
|
};
|
|
1108
1360
|
export const FleetSchema = {
|
|
1109
1361
|
type: 'object',
|
|
@@ -1186,7 +1438,12 @@ export const FleetSchema = {
|
|
|
1186
1438
|
'spot'
|
|
1187
1439
|
]
|
|
1188
1440
|
},
|
|
1189
|
-
|
|
1441
|
+
minItems: 1,
|
|
1442
|
+
description: 'Allowed values for `karpenter.sh/capacity-type`.',
|
|
1443
|
+
default: [
|
|
1444
|
+
'on-demand',
|
|
1445
|
+
'spot'
|
|
1446
|
+
]
|
|
1190
1447
|
},
|
|
1191
1448
|
'kubernetes.io/arch': {
|
|
1192
1449
|
type: 'array',
|
|
@@ -1197,7 +1454,11 @@ export const FleetSchema = {
|
|
|
1197
1454
|
'arm64'
|
|
1198
1455
|
]
|
|
1199
1456
|
},
|
|
1200
|
-
|
|
1457
|
+
minItems: 1,
|
|
1458
|
+
description: 'Allowed values for `kubernetes.io/arch`.',
|
|
1459
|
+
default: [
|
|
1460
|
+
'amd64'
|
|
1461
|
+
]
|
|
1201
1462
|
},
|
|
1202
1463
|
'cfke.io/instance-family': {
|
|
1203
1464
|
type: 'array',
|
|
@@ -1364,7 +1625,8 @@ export const FleetSchema = {
|
|
|
1364
1625
|
'z3'
|
|
1365
1626
|
]
|
|
1366
1627
|
},
|
|
1367
|
-
description: 'Allowed values for `cfke.io/instance-family`.'
|
|
1628
|
+
description: 'Allowed values for `cfke.io/instance-family`.',
|
|
1629
|
+
default: []
|
|
1368
1630
|
},
|
|
1369
1631
|
'topology.kubernetes.io/region': {
|
|
1370
1632
|
type: 'array',
|
|
@@ -1437,15 +1699,31 @@ export const FleetSchema = {
|
|
|
1437
1699
|
'us-west4'
|
|
1438
1700
|
]
|
|
1439
1701
|
},
|
|
1440
|
-
description: 'Allowed values for `topology.kubernetes.io/region`.'
|
|
1702
|
+
description: 'Allowed values for `topology.kubernetes.io/region`.',
|
|
1703
|
+
default: []
|
|
1441
1704
|
}
|
|
1442
1705
|
},
|
|
1706
|
+
required: [
|
|
1707
|
+
'karpenter.sh/capacity-type',
|
|
1708
|
+
'kubernetes.io/arch'
|
|
1709
|
+
],
|
|
1443
1710
|
additionalProperties: false,
|
|
1444
|
-
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.
|
|
1711
|
+
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.',
|
|
1712
|
+
default: {
|
|
1713
|
+
'karpenter.sh/capacity-type': [
|
|
1714
|
+
'on-demand',
|
|
1715
|
+
'spot'
|
|
1716
|
+
],
|
|
1717
|
+
'kubernetes.io/arch': [
|
|
1718
|
+
'amd64'
|
|
1719
|
+
],
|
|
1720
|
+
'cfke.io/instance-family': [],
|
|
1721
|
+
'topology.kubernetes.io/region': []
|
|
1722
|
+
}
|
|
1445
1723
|
},
|
|
1446
1724
|
scalingProfile: {
|
|
1447
1725
|
type: 'string',
|
|
1448
|
-
description: 'Controls scale-up / scale-down responsiveness. `aggressive` prioritizes cost-optimization. `conservative` prioritizes stability of the fleet.',
|
|
1726
|
+
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`).',
|
|
1449
1727
|
default: 'conservative',
|
|
1450
1728
|
example: 'conservative',
|
|
1451
1729
|
enum: [
|
|
@@ -1460,13 +1738,38 @@ export const FleetSchema = {
|
|
|
1460
1738
|
pattern: '^[a-z0-9]([-a-z0-9]*[a-z0-9])?$',
|
|
1461
1739
|
description: 'Unique identifier of the kubernetes fleet.',
|
|
1462
1740
|
example: 'new-clouds-fleet'
|
|
1741
|
+
},
|
|
1742
|
+
ready: {
|
|
1743
|
+
type: 'boolean',
|
|
1744
|
+
description: 'Indicates whether the fleet configuration is healthy.',
|
|
1745
|
+
example: true
|
|
1746
|
+
},
|
|
1747
|
+
status_message: {
|
|
1748
|
+
type: 'string',
|
|
1749
|
+
description: 'Human-readable reason the fleet is not ready. Present only when `ready` is false.',
|
|
1750
|
+
example: 'Invalid provider permissions.'
|
|
1751
|
+
},
|
|
1752
|
+
created_at: {
|
|
1753
|
+
type: 'string',
|
|
1754
|
+
description: 'Creation date and time of the fleet.',
|
|
1755
|
+
example: '2024-09-12T09:11:27Z'
|
|
1756
|
+
},
|
|
1757
|
+
updated_at: {
|
|
1758
|
+
type: 'string',
|
|
1759
|
+
description: 'Date and time the fleet was last updated.',
|
|
1760
|
+
example: '2024-09-12T09:11:27Z'
|
|
1463
1761
|
}
|
|
1464
1762
|
},
|
|
1465
1763
|
required: [
|
|
1764
|
+
'constraints',
|
|
1466
1765
|
'scalingProfile',
|
|
1467
|
-
'id'
|
|
1766
|
+
'id',
|
|
1767
|
+
'ready',
|
|
1768
|
+
'created_at',
|
|
1769
|
+
'updated_at'
|
|
1468
1770
|
],
|
|
1469
|
-
additionalProperties: false
|
|
1771
|
+
additionalProperties: false,
|
|
1772
|
+
description: 'Mutable fleet configuration. Applied as a full overwrite: any omitted field is reset to its default rather than left unchanged.'
|
|
1470
1773
|
};
|
|
1471
1774
|
export const FleetUpdateInputSchema = {
|
|
1472
1775
|
type: 'object',
|
|
@@ -1512,8 +1815,8 @@ export const FleetUpdateInputSchema = {
|
|
|
1512
1815
|
type: 'string',
|
|
1513
1816
|
maxLength: 64,
|
|
1514
1817
|
minLength: 64,
|
|
1515
|
-
pattern: '^[A-Za-z0-9]
|
|
1516
|
-
description: 'Hetzner Cloud API token with read
|
|
1818
|
+
pattern: '^([A-Za-z0-9]{64}|\\*{64})$',
|
|
1819
|
+
description: 'Hetzner Cloud API token with read/write access (64 alphanumeric characters). Write-only: reads return a redacted placeholder, never the token. Omit the field, or send the placeholder back unchanged, to keep the existing key. Send a new value to rotate it.'
|
|
1517
1820
|
}
|
|
1518
1821
|
},
|
|
1519
1822
|
required: [
|
|
@@ -1551,7 +1854,12 @@ export const FleetUpdateInputSchema = {
|
|
|
1551
1854
|
'spot'
|
|
1552
1855
|
]
|
|
1553
1856
|
},
|
|
1554
|
-
|
|
1857
|
+
minItems: 1,
|
|
1858
|
+
description: 'Allowed values for `karpenter.sh/capacity-type`.',
|
|
1859
|
+
default: [
|
|
1860
|
+
'on-demand',
|
|
1861
|
+
'spot'
|
|
1862
|
+
]
|
|
1555
1863
|
},
|
|
1556
1864
|
'kubernetes.io/arch': {
|
|
1557
1865
|
type: 'array',
|
|
@@ -1562,7 +1870,11 @@ export const FleetUpdateInputSchema = {
|
|
|
1562
1870
|
'arm64'
|
|
1563
1871
|
]
|
|
1564
1872
|
},
|
|
1565
|
-
|
|
1873
|
+
minItems: 1,
|
|
1874
|
+
description: 'Allowed values for `kubernetes.io/arch`.',
|
|
1875
|
+
default: [
|
|
1876
|
+
'amd64'
|
|
1877
|
+
]
|
|
1566
1878
|
},
|
|
1567
1879
|
'cfke.io/instance-family': {
|
|
1568
1880
|
type: 'array',
|
|
@@ -1729,7 +2041,8 @@ export const FleetUpdateInputSchema = {
|
|
|
1729
2041
|
'z3'
|
|
1730
2042
|
]
|
|
1731
2043
|
},
|
|
1732
|
-
description: 'Allowed values for `cfke.io/instance-family`.'
|
|
2044
|
+
description: 'Allowed values for `cfke.io/instance-family`.',
|
|
2045
|
+
default: []
|
|
1733
2046
|
},
|
|
1734
2047
|
'topology.kubernetes.io/region': {
|
|
1735
2048
|
type: 'array',
|
|
@@ -1802,15 +2115,28 @@ export const FleetUpdateInputSchema = {
|
|
|
1802
2115
|
'us-west4'
|
|
1803
2116
|
]
|
|
1804
2117
|
},
|
|
1805
|
-
description: 'Allowed values for `topology.kubernetes.io/region`.'
|
|
2118
|
+
description: 'Allowed values for `topology.kubernetes.io/region`.',
|
|
2119
|
+
default: []
|
|
1806
2120
|
}
|
|
1807
2121
|
},
|
|
1808
2122
|
additionalProperties: false,
|
|
1809
|
-
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.
|
|
2123
|
+
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.',
|
|
2124
|
+
default: {
|
|
2125
|
+
'karpenter.sh/capacity-type': [
|
|
2126
|
+
'on-demand',
|
|
2127
|
+
'spot'
|
|
2128
|
+
],
|
|
2129
|
+
'kubernetes.io/arch': [
|
|
2130
|
+
'amd64'
|
|
2131
|
+
],
|
|
2132
|
+
'cfke.io/instance-family': [],
|
|
2133
|
+
'topology.kubernetes.io/region': []
|
|
2134
|
+
}
|
|
1810
2135
|
},
|
|
1811
2136
|
scalingProfile: {
|
|
1812
2137
|
type: 'string',
|
|
1813
|
-
description: 'Controls scale-up / scale-down responsiveness. `aggressive` prioritizes cost-optimization. `conservative` prioritizes stability of the fleet.',
|
|
2138
|
+
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`).',
|
|
2139
|
+
default: 'conservative',
|
|
1814
2140
|
example: 'conservative',
|
|
1815
2141
|
enum: [
|
|
1816
2142
|
'aggressive',
|
|
@@ -1818,8 +2144,31 @@ export const FleetUpdateInputSchema = {
|
|
|
1818
2144
|
]
|
|
1819
2145
|
}
|
|
1820
2146
|
},
|
|
2147
|
+
additionalProperties: false,
|
|
2148
|
+
description: 'Mutable fleet configuration. Applied as a full overwrite: any omitted field is reset to its default rather than left unchanged.'
|
|
2149
|
+
};
|
|
2150
|
+
export const InviteCreateInputSchema = {
|
|
2151
|
+
type: 'object',
|
|
2152
|
+
properties: {
|
|
2153
|
+
email: {
|
|
2154
|
+
type: 'string',
|
|
2155
|
+
format: 'email',
|
|
2156
|
+
description: 'Email address of the user to invite.',
|
|
2157
|
+
example: 'email@example.com'
|
|
2158
|
+
},
|
|
2159
|
+
role: {
|
|
2160
|
+
type: 'string',
|
|
2161
|
+
description: 'Role the invited user will be assigned on redemption. Can be \'Administrator\' or \'User\'.',
|
|
2162
|
+
default: 'User',
|
|
2163
|
+
example: 'User',
|
|
2164
|
+
enum: [
|
|
2165
|
+
'Administrator',
|
|
2166
|
+
'User'
|
|
2167
|
+
]
|
|
2168
|
+
}
|
|
2169
|
+
},
|
|
1821
2170
|
required: [
|
|
1822
|
-
'
|
|
2171
|
+
'email'
|
|
1823
2172
|
],
|
|
1824
2173
|
additionalProperties: false
|
|
1825
2174
|
};
|
|
@@ -1853,6 +2202,16 @@ export const InviteSchema = {
|
|
|
1853
2202
|
type: 'string',
|
|
1854
2203
|
description: 'Generated unique invite code.',
|
|
1855
2204
|
example: '7kUZnH7nnKUFfvc4NK2KQF'
|
|
2205
|
+
},
|
|
2206
|
+
role: {
|
|
2207
|
+
type: 'string',
|
|
2208
|
+
description: 'Role the invited user will be assigned on redemption. Can be \'Administrator\' or \'User\'.',
|
|
2209
|
+
default: 'User',
|
|
2210
|
+
example: 'User',
|
|
2211
|
+
enum: [
|
|
2212
|
+
'Administrator',
|
|
2213
|
+
'User'
|
|
2214
|
+
]
|
|
1856
2215
|
}
|
|
1857
2216
|
},
|
|
1858
2217
|
required: [
|
|
@@ -1860,6 +2219,170 @@ export const InviteSchema = {
|
|
|
1860
2219
|
],
|
|
1861
2220
|
additionalProperties: false
|
|
1862
2221
|
};
|
|
2222
|
+
export const InvoicePaymentAttemptSchema = {
|
|
2223
|
+
type: 'object',
|
|
2224
|
+
properties: {
|
|
2225
|
+
invoice_id: {
|
|
2226
|
+
type: 'string',
|
|
2227
|
+
description: 'Identifier of the invoice.',
|
|
2228
|
+
example: 'in_1234567890xCrwxghOTj1234'
|
|
2229
|
+
},
|
|
2230
|
+
number: {
|
|
2231
|
+
type: 'string',
|
|
2232
|
+
nullable: true,
|
|
2233
|
+
description: 'Invoice number. Null if the invoice has no number.',
|
|
2234
|
+
example: 'CF-0042'
|
|
2235
|
+
},
|
|
2236
|
+
amount: {
|
|
2237
|
+
type: 'number',
|
|
2238
|
+
format: 'float',
|
|
2239
|
+
description: 'Amount outstanding when the charge was attempted, in the smallest currency unit.',
|
|
2240
|
+
example: 4200
|
|
2241
|
+
},
|
|
2242
|
+
currency: {
|
|
2243
|
+
type: 'string',
|
|
2244
|
+
description: 'Currency of the invoice.',
|
|
2245
|
+
example: 'eur'
|
|
2246
|
+
},
|
|
2247
|
+
status: {
|
|
2248
|
+
type: 'string',
|
|
2249
|
+
description: 'Outcome for this invoice: `paid`, `processing` (accepted, not yet settled), `requires_action` (awaiting customer authentication), or `failed` (declined).',
|
|
2250
|
+
example: 'paid',
|
|
2251
|
+
enum: [
|
|
2252
|
+
'paid',
|
|
2253
|
+
'processing',
|
|
2254
|
+
'requires_action',
|
|
2255
|
+
'failed'
|
|
2256
|
+
]
|
|
2257
|
+
},
|
|
2258
|
+
client_secret: {
|
|
2259
|
+
type: 'string',
|
|
2260
|
+
nullable: true,
|
|
2261
|
+
description: 'Client secret used to complete customer authentication. Set only when `status` is `requires_action`.',
|
|
2262
|
+
example: 'pi_3MtwBwLkdIwHu7ix28a3tqPa_secret_YrKJUKribcBjcG8HVhfZluoGH'
|
|
2263
|
+
},
|
|
2264
|
+
failure_code: {
|
|
2265
|
+
type: 'string',
|
|
2266
|
+
nullable: true,
|
|
2267
|
+
description: 'Decline code. Set only when `status` is `failed`.',
|
|
2268
|
+
example: 'insufficient_funds'
|
|
2269
|
+
},
|
|
2270
|
+
failure_message: {
|
|
2271
|
+
type: 'string',
|
|
2272
|
+
nullable: true,
|
|
2273
|
+
description: 'Explanation of the decline, suitable for display. Set only when `status` is `failed`.',
|
|
2274
|
+
example: 'Your card has insufficient funds.'
|
|
2275
|
+
}
|
|
2276
|
+
},
|
|
2277
|
+
required: [
|
|
2278
|
+
'invoice_id',
|
|
2279
|
+
'number',
|
|
2280
|
+
'amount',
|
|
2281
|
+
'currency',
|
|
2282
|
+
'status',
|
|
2283
|
+
'client_secret',
|
|
2284
|
+
'failure_code',
|
|
2285
|
+
'failure_message'
|
|
2286
|
+
],
|
|
2287
|
+
additionalProperties: false
|
|
2288
|
+
};
|
|
2289
|
+
export const InvoicePaymentResultSchema = {
|
|
2290
|
+
type: 'object',
|
|
2291
|
+
properties: {
|
|
2292
|
+
code: {
|
|
2293
|
+
type: 'string',
|
|
2294
|
+
description: 'Overall outcome: `paid` (nothing outstanding), `processing` (all accepted, not yet settled), `action_required` (one or more await customer authentication), `partially_paid`, `failed`, `nothing_due`, or `bank_transfer_due` (the organization pays by bank transfer; nothing was charged).',
|
|
2295
|
+
example: 'partially_paid',
|
|
2296
|
+
enum: [
|
|
2297
|
+
'paid',
|
|
2298
|
+
'processing',
|
|
2299
|
+
'action_required',
|
|
2300
|
+
'partially_paid',
|
|
2301
|
+
'failed',
|
|
2302
|
+
'nothing_due',
|
|
2303
|
+
'bank_transfer_due'
|
|
2304
|
+
]
|
|
2305
|
+
},
|
|
2306
|
+
message: {
|
|
2307
|
+
type: 'string',
|
|
2308
|
+
description: 'Summary of the outcome, suitable for display.',
|
|
2309
|
+
example: '1 of 2 open invoices was paid. Invoice CF-0043 was declined: Your card has insufficient funds.'
|
|
2310
|
+
},
|
|
2311
|
+
results: {
|
|
2312
|
+
type: 'array',
|
|
2313
|
+
items: {
|
|
2314
|
+
type: 'object',
|
|
2315
|
+
properties: {
|
|
2316
|
+
invoice_id: {
|
|
2317
|
+
type: 'string',
|
|
2318
|
+
description: 'Identifier of the invoice.',
|
|
2319
|
+
example: 'in_1234567890xCrwxghOTj1234'
|
|
2320
|
+
},
|
|
2321
|
+
number: {
|
|
2322
|
+
type: 'string',
|
|
2323
|
+
description: 'Invoice number. Null if the invoice has no number.',
|
|
2324
|
+
example: 'CF-0042'
|
|
2325
|
+
},
|
|
2326
|
+
amount: {
|
|
2327
|
+
type: 'number',
|
|
2328
|
+
format: 'float',
|
|
2329
|
+
description: 'Amount outstanding when the charge was attempted, in the smallest currency unit.',
|
|
2330
|
+
example: 4200
|
|
2331
|
+
},
|
|
2332
|
+
currency: {
|
|
2333
|
+
type: 'string',
|
|
2334
|
+
description: 'Currency of the invoice.',
|
|
2335
|
+
example: 'eur'
|
|
2336
|
+
},
|
|
2337
|
+
status: {
|
|
2338
|
+
type: 'string',
|
|
2339
|
+
description: 'Outcome for this invoice: `paid`, `processing` (accepted, not yet settled), `requires_action` (awaiting customer authentication), or `failed` (declined).',
|
|
2340
|
+
example: 'paid',
|
|
2341
|
+
enum: [
|
|
2342
|
+
'paid',
|
|
2343
|
+
'processing',
|
|
2344
|
+
'requires_action',
|
|
2345
|
+
'failed'
|
|
2346
|
+
]
|
|
2347
|
+
},
|
|
2348
|
+
client_secret: {
|
|
2349
|
+
type: 'string',
|
|
2350
|
+
description: 'Client secret used to complete customer authentication. Set only when `status` is `requires_action`.',
|
|
2351
|
+
example: 'pi_3MtwBwLkdIwHu7ix28a3tqPa_secret_YrKJUKribcBjcG8HVhfZluoGH'
|
|
2352
|
+
},
|
|
2353
|
+
failure_code: {
|
|
2354
|
+
type: 'string',
|
|
2355
|
+
description: 'Decline code. Set only when `status` is `failed`.',
|
|
2356
|
+
example: 'insufficient_funds'
|
|
2357
|
+
},
|
|
2358
|
+
failure_message: {
|
|
2359
|
+
type: 'string',
|
|
2360
|
+
description: 'Explanation of the decline, suitable for display. Set only when `status` is `failed`.',
|
|
2361
|
+
example: 'Your card has insufficient funds.'
|
|
2362
|
+
}
|
|
2363
|
+
},
|
|
2364
|
+
required: [
|
|
2365
|
+
'invoice_id',
|
|
2366
|
+
'number',
|
|
2367
|
+
'amount',
|
|
2368
|
+
'currency',
|
|
2369
|
+
'status',
|
|
2370
|
+
'client_secret',
|
|
2371
|
+
'failure_code',
|
|
2372
|
+
'failure_message'
|
|
2373
|
+
],
|
|
2374
|
+
additionalProperties: false
|
|
2375
|
+
},
|
|
2376
|
+
description: 'One entry per invoice charged, oldest first.'
|
|
2377
|
+
}
|
|
2378
|
+
},
|
|
2379
|
+
required: [
|
|
2380
|
+
'code',
|
|
2381
|
+
'message',
|
|
2382
|
+
'results'
|
|
2383
|
+
],
|
|
2384
|
+
additionalProperties: false
|
|
2385
|
+
};
|
|
1863
2386
|
export const InvoiceSchema = {
|
|
1864
2387
|
type: 'object',
|
|
1865
2388
|
properties: {
|
|
@@ -2073,6 +2596,15 @@ export const MarketplaceListingSchema = {
|
|
|
2073
2596
|
export const OrganizationCreateInputSchema = {
|
|
2074
2597
|
type: 'object',
|
|
2075
2598
|
properties: {
|
|
2599
|
+
type: {
|
|
2600
|
+
type: 'string',
|
|
2601
|
+
description: 'Type of the organization. `business` for legal entities, `personal` for individuals.',
|
|
2602
|
+
example: 'business',
|
|
2603
|
+
enum: [
|
|
2604
|
+
'business',
|
|
2605
|
+
'personal'
|
|
2606
|
+
]
|
|
2607
|
+
},
|
|
2076
2608
|
email: {
|
|
2077
2609
|
type: 'string',
|
|
2078
2610
|
format: 'email',
|
|
@@ -2081,11 +2613,13 @@ export const OrganizationCreateInputSchema = {
|
|
|
2081
2613
|
},
|
|
2082
2614
|
first_name: {
|
|
2083
2615
|
type: 'string',
|
|
2616
|
+
minLength: 1,
|
|
2084
2617
|
description: 'First name of the billing contact person.',
|
|
2085
2618
|
example: 'John'
|
|
2086
2619
|
},
|
|
2087
2620
|
last_name: {
|
|
2088
2621
|
type: 'string',
|
|
2622
|
+
minLength: 1,
|
|
2089
2623
|
description: 'Last name of the billing contact person.',
|
|
2090
2624
|
example: 'Doe'
|
|
2091
2625
|
},
|
|
@@ -2104,6 +2638,7 @@ export const OrganizationCreateInputSchema = {
|
|
|
2104
2638
|
}
|
|
2105
2639
|
},
|
|
2106
2640
|
required: [
|
|
2641
|
+
'type',
|
|
2107
2642
|
'email',
|
|
2108
2643
|
'first_name',
|
|
2109
2644
|
'last_name',
|
|
@@ -2112,6 +2647,20 @@ export const OrganizationCreateInputSchema = {
|
|
|
2112
2647
|
],
|
|
2113
2648
|
additionalProperties: false
|
|
2114
2649
|
};
|
|
2650
|
+
export const OrganizationCreateOutputSchema = {
|
|
2651
|
+
type: 'object',
|
|
2652
|
+
properties: {
|
|
2653
|
+
id: {
|
|
2654
|
+
type: 'string',
|
|
2655
|
+
description: 'Unique identifier of the newly created organization. Generated by the API and safe to use for client-side tracking immediately.',
|
|
2656
|
+
example: 'organization-id'
|
|
2657
|
+
}
|
|
2658
|
+
},
|
|
2659
|
+
required: [
|
|
2660
|
+
'id'
|
|
2661
|
+
],
|
|
2662
|
+
additionalProperties: false
|
|
2663
|
+
};
|
|
2115
2664
|
export const OrganizationSchema = {
|
|
2116
2665
|
type: 'object',
|
|
2117
2666
|
properties: {
|
|
@@ -2128,6 +2677,15 @@ export const OrganizationSchema = {
|
|
|
2128
2677
|
description: 'Name of the legal entity. This name will be used in invoices. Use your first and last name for individual accounts.',
|
|
2129
2678
|
example: 'ACME Corp.'
|
|
2130
2679
|
},
|
|
2680
|
+
type: {
|
|
2681
|
+
type: 'string',
|
|
2682
|
+
description: 'Type of the organization. `business` for legal entities, `personal` for individuals.',
|
|
2683
|
+
example: 'business',
|
|
2684
|
+
enum: [
|
|
2685
|
+
'business',
|
|
2686
|
+
'personal'
|
|
2687
|
+
]
|
|
2688
|
+
},
|
|
2131
2689
|
date_created: {
|
|
2132
2690
|
type: 'string',
|
|
2133
2691
|
format: 'date-time',
|
|
@@ -2159,6 +2717,17 @@ export const OrganizationSchema = {
|
|
|
2159
2717
|
description: 'Available number of Pro clusters that can be created.',
|
|
2160
2718
|
example: 999
|
|
2161
2719
|
},
|
|
2720
|
+
enterprise_clusters_max: {
|
|
2721
|
+
type: 'integer',
|
|
2722
|
+
minimum: 0,
|
|
2723
|
+
description: 'Maximum number of Enterprise clusters that can be created.',
|
|
2724
|
+
example: 999
|
|
2725
|
+
},
|
|
2726
|
+
enterprise_clusters_available: {
|
|
2727
|
+
type: 'integer',
|
|
2728
|
+
description: 'Available number of Enterprise clusters that can be created.',
|
|
2729
|
+
example: 999
|
|
2730
|
+
},
|
|
2162
2731
|
fleets_max: {
|
|
2163
2732
|
type: 'integer',
|
|
2164
2733
|
minimum: 0,
|
|
@@ -2178,7 +2747,7 @@ export const OrganizationSchema = {
|
|
|
2178
2747
|
type: 'array',
|
|
2179
2748
|
items: {
|
|
2180
2749
|
type: 'string',
|
|
2181
|
-
example: 'northamerica-central-
|
|
2750
|
+
example: 'northamerica-central-1a'
|
|
2182
2751
|
},
|
|
2183
2752
|
minItems: 1,
|
|
2184
2753
|
description: 'List of Cloudfleet control plane regions available for the organization.'
|
|
@@ -2220,6 +2789,8 @@ export const OrganizationSchema = {
|
|
|
2220
2789
|
'basic_clusters_available',
|
|
2221
2790
|
'pro_clusters_max',
|
|
2222
2791
|
'pro_clusters_available',
|
|
2792
|
+
'enterprise_clusters_max',
|
|
2793
|
+
'enterprise_clusters_available',
|
|
2223
2794
|
'fleets_max',
|
|
2224
2795
|
'cluster_tiers',
|
|
2225
2796
|
'regions',
|
|
@@ -2237,13 +2808,25 @@ export const OrganizationSchema = {
|
|
|
2237
2808
|
'closed',
|
|
2238
2809
|
'suspended'
|
|
2239
2810
|
]
|
|
2811
|
+
},
|
|
2812
|
+
verification: {
|
|
2813
|
+
type: 'string',
|
|
2814
|
+
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.',
|
|
2815
|
+
example: 'verified',
|
|
2816
|
+
enum: [
|
|
2817
|
+
'none',
|
|
2818
|
+
'submitted',
|
|
2819
|
+
'verified'
|
|
2820
|
+
]
|
|
2240
2821
|
}
|
|
2241
2822
|
},
|
|
2242
2823
|
required: [
|
|
2243
2824
|
'id',
|
|
2825
|
+
'type',
|
|
2244
2826
|
'date_created',
|
|
2245
2827
|
'quota',
|
|
2246
|
-
'status'
|
|
2828
|
+
'status',
|
|
2829
|
+
'verification'
|
|
2247
2830
|
],
|
|
2248
2831
|
additionalProperties: false
|
|
2249
2832
|
};
|
|
@@ -2252,28 +2835,23 @@ export const PaymentMethodSchema = {
|
|
|
2252
2835
|
properties: {
|
|
2253
2836
|
id: {
|
|
2254
2837
|
type: 'string',
|
|
2255
|
-
|
|
2256
|
-
|
|
2257
|
-
example: 'e94d30ec-a2dd-4dcb-832c-ac2be144ba91'
|
|
2258
|
-
},
|
|
2259
|
-
setup: {
|
|
2260
|
-
type: 'boolean',
|
|
2261
|
-
description: 'Whether organization payment method was set up and ready to use for payments.',
|
|
2262
|
-
example: true
|
|
2838
|
+
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.',
|
|
2839
|
+
example: 'pm_1MtwBwLkdIwHu7ix28a3tqPa'
|
|
2263
2840
|
},
|
|
2264
2841
|
type: {
|
|
2265
2842
|
type: 'string',
|
|
2266
|
-
|
|
2267
|
-
description: 'Payment method type type. Only `card` payments supported at the moment.',
|
|
2843
|
+
description: 'Payment method type. `card`, `sepa_debit` for SEPA Direct Debit (business accounts only), or `bank_transfer` for paying invoices by bank transfer.',
|
|
2268
2844
|
example: 'card',
|
|
2269
2845
|
enum: [
|
|
2270
|
-
'card'
|
|
2846
|
+
'card',
|
|
2847
|
+
'sepa_debit',
|
|
2848
|
+
'bank_transfer'
|
|
2271
2849
|
]
|
|
2272
2850
|
},
|
|
2273
2851
|
last4: {
|
|
2274
2852
|
type: 'string',
|
|
2275
2853
|
nullable: true,
|
|
2276
|
-
description: 'Last 4 digits of the payment card number.',
|
|
2854
|
+
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.',
|
|
2277
2855
|
example: '4242'
|
|
2278
2856
|
},
|
|
2279
2857
|
exp_month: {
|
|
@@ -2281,42 +2859,56 @@ export const PaymentMethodSchema = {
|
|
|
2281
2859
|
minimum: 1,
|
|
2282
2860
|
maximum: 12,
|
|
2283
2861
|
nullable: true,
|
|
2284
|
-
description: 'Two-digit number representing the card\'s expiration month.',
|
|
2285
|
-
example:
|
|
2862
|
+
description: 'Two-digit number representing the card\'s expiration month. Null for SEPA Direct Debit and bank transfer.',
|
|
2863
|
+
example: 12
|
|
2286
2864
|
},
|
|
2287
2865
|
exp_year: {
|
|
2288
2866
|
type: 'integer',
|
|
2289
|
-
minimum: 2024,
|
|
2290
2867
|
nullable: true,
|
|
2291
|
-
description: 'Four-digit number representing the card\'s expiration year.',
|
|
2292
|
-
example:
|
|
2868
|
+
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.',
|
|
2869
|
+
example: 2028
|
|
2293
2870
|
},
|
|
2294
2871
|
brand: {
|
|
2295
2872
|
type: 'string',
|
|
2296
2873
|
nullable: true,
|
|
2297
|
-
description: 'Payment card brand
|
|
2298
|
-
example: 'visa'
|
|
2299
|
-
|
|
2300
|
-
|
|
2301
|
-
|
|
2302
|
-
|
|
2303
|
-
|
|
2304
|
-
|
|
2305
|
-
|
|
2306
|
-
|
|
2307
|
-
|
|
2308
|
-
|
|
2309
|
-
|
|
2874
|
+
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.',
|
|
2875
|
+
example: 'visa'
|
|
2876
|
+
},
|
|
2877
|
+
iban: {
|
|
2878
|
+
type: 'string',
|
|
2879
|
+
nullable: true,
|
|
2880
|
+
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.',
|
|
2881
|
+
example: 'DE11243015658023127510'
|
|
2882
|
+
},
|
|
2883
|
+
bic: {
|
|
2884
|
+
type: 'string',
|
|
2885
|
+
nullable: true,
|
|
2886
|
+
description: 'BIC/SWIFT of the destination bank for bank transfers. Set only for `bank_transfer`; null otherwise.',
|
|
2887
|
+
example: 'SOGEDEFFXXX'
|
|
2888
|
+
},
|
|
2889
|
+
account_holder_name: {
|
|
2890
|
+
type: 'string',
|
|
2891
|
+
nullable: true,
|
|
2892
|
+
description: 'Account holder name of the destination bank account for bank transfers. Set only for `bank_transfer`; null otherwise.',
|
|
2893
|
+
example: 'Cloudfleet GmbH'
|
|
2894
|
+
},
|
|
2895
|
+
is_default: {
|
|
2896
|
+
type: 'boolean',
|
|
2897
|
+
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).',
|
|
2898
|
+
example: true
|
|
2310
2899
|
}
|
|
2311
2900
|
},
|
|
2312
2901
|
required: [
|
|
2313
2902
|
'id',
|
|
2314
|
-
'setup',
|
|
2315
2903
|
'type',
|
|
2316
2904
|
'last4',
|
|
2317
2905
|
'exp_month',
|
|
2318
2906
|
'exp_year',
|
|
2319
|
-
'brand'
|
|
2907
|
+
'brand',
|
|
2908
|
+
'iban',
|
|
2909
|
+
'bic',
|
|
2910
|
+
'account_holder_name',
|
|
2911
|
+
'is_default'
|
|
2320
2912
|
],
|
|
2321
2913
|
additionalProperties: false
|
|
2322
2914
|
};
|
|
@@ -2345,6 +2937,17 @@ export const PlatformQuotaSchema = {
|
|
|
2345
2937
|
description: 'Available number of Pro clusters that can be created.',
|
|
2346
2938
|
example: 999
|
|
2347
2939
|
},
|
|
2940
|
+
enterprise_clusters_max: {
|
|
2941
|
+
type: 'integer',
|
|
2942
|
+
minimum: 0,
|
|
2943
|
+
description: 'Maximum number of Enterprise clusters that can be created.',
|
|
2944
|
+
example: 999
|
|
2945
|
+
},
|
|
2946
|
+
enterprise_clusters_available: {
|
|
2947
|
+
type: 'integer',
|
|
2948
|
+
description: 'Available number of Enterprise clusters that can be created.',
|
|
2949
|
+
example: 999
|
|
2950
|
+
},
|
|
2348
2951
|
fleets_max: {
|
|
2349
2952
|
type: 'integer',
|
|
2350
2953
|
minimum: 0,
|
|
@@ -2364,7 +2967,7 @@ export const PlatformQuotaSchema = {
|
|
|
2364
2967
|
type: 'array',
|
|
2365
2968
|
items: {
|
|
2366
2969
|
type: 'string',
|
|
2367
|
-
example: 'northamerica-central-
|
|
2970
|
+
example: 'northamerica-central-1a'
|
|
2368
2971
|
},
|
|
2369
2972
|
minItems: 1,
|
|
2370
2973
|
description: 'List of Cloudfleet control plane regions available for the organization.'
|
|
@@ -2406,6 +3009,8 @@ export const PlatformQuotaSchema = {
|
|
|
2406
3009
|
'basic_clusters_available',
|
|
2407
3010
|
'pro_clusters_max',
|
|
2408
3011
|
'pro_clusters_available',
|
|
3012
|
+
'enterprise_clusters_max',
|
|
3013
|
+
'enterprise_clusters_available',
|
|
2409
3014
|
'fleets_max',
|
|
2410
3015
|
'cluster_tiers',
|
|
2411
3016
|
'regions',
|
|
@@ -2748,172 +3353,6 @@ export const TicketCreateInputSchema = {
|
|
|
2748
3353
|
],
|
|
2749
3354
|
additionalProperties: false
|
|
2750
3355
|
};
|
|
2751
|
-
export const TicketListResponseSchema = {
|
|
2752
|
-
type: 'object',
|
|
2753
|
-
properties: {
|
|
2754
|
-
items: {
|
|
2755
|
-
type: 'array',
|
|
2756
|
-
items: {
|
|
2757
|
-
type: 'object',
|
|
2758
|
-
properties: {
|
|
2759
|
-
id: {
|
|
2760
|
-
type: 'string',
|
|
2761
|
-
description: 'Unique identifier of the ticket (Mongo ObjectId).',
|
|
2762
|
-
example: '60c72b2f9f1b2c001f8e4d3a'
|
|
2763
|
-
},
|
|
2764
|
-
status: {
|
|
2765
|
-
type: 'string',
|
|
2766
|
-
description: 'Current state of the ticket.',
|
|
2767
|
-
example: 'waiting_on_us',
|
|
2768
|
-
enum: [
|
|
2769
|
-
'waiting_on_us',
|
|
2770
|
-
'waiting_on_user',
|
|
2771
|
-
'closed'
|
|
2772
|
-
]
|
|
2773
|
-
},
|
|
2774
|
-
category: {
|
|
2775
|
-
type: 'string',
|
|
2776
|
-
description: 'Ticket category.',
|
|
2777
|
-
example: 'technical',
|
|
2778
|
-
enum: [
|
|
2779
|
-
'billing',
|
|
2780
|
-
'technical',
|
|
2781
|
-
'general'
|
|
2782
|
-
]
|
|
2783
|
-
},
|
|
2784
|
-
summary: {
|
|
2785
|
-
type: 'string',
|
|
2786
|
-
description: 'First 128 characters of the initial message body, with markdown formatting and newlines stripped. Used for ticket list previews.',
|
|
2787
|
-
example: 'My cluster cannot reach the registry. Logs attached.'
|
|
2788
|
-
},
|
|
2789
|
-
closed_at: {
|
|
2790
|
-
type: 'string',
|
|
2791
|
-
format: 'date-time',
|
|
2792
|
-
nullable: true,
|
|
2793
|
-
description: 'Closure timestamp. Null while the ticket is open.',
|
|
2794
|
-
example: '2026-05-18T16:08:14.338Z'
|
|
2795
|
-
},
|
|
2796
|
-
date_created: {
|
|
2797
|
-
type: 'string',
|
|
2798
|
-
format: 'date-time',
|
|
2799
|
-
description: 'Creation date of the ticket. ISO 8601 UTC.',
|
|
2800
|
-
example: '2026-05-11T16:08:14.338Z'
|
|
2801
|
-
},
|
|
2802
|
-
date_updated: {
|
|
2803
|
-
type: 'string',
|
|
2804
|
-
format: 'date-time',
|
|
2805
|
-
description: 'Last update date of the ticket. ISO 8601 UTC.',
|
|
2806
|
-
example: '2026-05-11T16:08:14.338Z'
|
|
2807
|
-
},
|
|
2808
|
-
messages: {
|
|
2809
|
-
type: 'array',
|
|
2810
|
-
items: {
|
|
2811
|
-
type: 'object',
|
|
2812
|
-
properties: {
|
|
2813
|
-
id: {
|
|
2814
|
-
type: 'string',
|
|
2815
|
-
description: 'Unique identifier of the message (Mongo ObjectId).',
|
|
2816
|
-
example: '60c72b2f9f1b2c001f8e4d3b'
|
|
2817
|
-
},
|
|
2818
|
-
type: {
|
|
2819
|
-
type: 'string',
|
|
2820
|
-
description: 'Message type. Internal notes are filtered out of customer-facing responses.',
|
|
2821
|
-
example: 'customer_reply',
|
|
2822
|
-
enum: [
|
|
2823
|
-
'customer_reply',
|
|
2824
|
-
'agent_reply'
|
|
2825
|
-
]
|
|
2826
|
-
},
|
|
2827
|
-
body: {
|
|
2828
|
-
type: 'string',
|
|
2829
|
-
description: 'Message body in markdown.',
|
|
2830
|
-
example: 'Thanks — that resolved it on my side.'
|
|
2831
|
-
},
|
|
2832
|
-
author_first_name: {
|
|
2833
|
-
type: 'string',
|
|
2834
|
-
nullable: true,
|
|
2835
|
-
description: 'First name of the author. Null when not provided.',
|
|
2836
|
-
example: 'Jane'
|
|
2837
|
-
},
|
|
2838
|
-
author_last_name: {
|
|
2839
|
-
type: 'string',
|
|
2840
|
-
nullable: true,
|
|
2841
|
-
description: 'Last name of the author. Null when not provided.',
|
|
2842
|
-
example: 'Doe'
|
|
2843
|
-
},
|
|
2844
|
-
attachments: {
|
|
2845
|
-
type: 'array',
|
|
2846
|
-
items: {
|
|
2847
|
-
type: 'object',
|
|
2848
|
-
properties: {
|
|
2849
|
-
id: {
|
|
2850
|
-
type: 'string',
|
|
2851
|
-
description: 'Unique identifier of the attachment (Mongo ObjectId).',
|
|
2852
|
-
example: '60c72b2f9f1b2c001f8e4d3c'
|
|
2853
|
-
},
|
|
2854
|
-
filename: {
|
|
2855
|
-
type: 'string',
|
|
2856
|
-
description: 'Original filename as uploaded.',
|
|
2857
|
-
example: 'debug.log'
|
|
2858
|
-
},
|
|
2859
|
-
content_type: {
|
|
2860
|
-
type: 'string',
|
|
2861
|
-
description: 'MIME content type of the attachment.',
|
|
2862
|
-
example: 'text/plain'
|
|
2863
|
-
},
|
|
2864
|
-
size: {
|
|
2865
|
-
type: 'integer',
|
|
2866
|
-
description: 'Size of the attachment in bytes.',
|
|
2867
|
-
example: 12345
|
|
2868
|
-
}
|
|
2869
|
-
},
|
|
2870
|
-
required: [
|
|
2871
|
-
'id',
|
|
2872
|
-
'filename',
|
|
2873
|
-
'content_type',
|
|
2874
|
-
'size'
|
|
2875
|
-
],
|
|
2876
|
-
additionalProperties: false
|
|
2877
|
-
},
|
|
2878
|
-
description: 'Attachments associated with this message.',
|
|
2879
|
-
example: []
|
|
2880
|
-
},
|
|
2881
|
-
date_created: {
|
|
2882
|
-
type: 'string',
|
|
2883
|
-
format: 'date-time',
|
|
2884
|
-
description: 'Creation date of the message. ISO 8601 UTC.',
|
|
2885
|
-
example: '2026-05-11T16:08:14.338Z'
|
|
2886
|
-
}
|
|
2887
|
-
},
|
|
2888
|
-
required: [
|
|
2889
|
-
'id',
|
|
2890
|
-
'type',
|
|
2891
|
-
'body',
|
|
2892
|
-
'date_created'
|
|
2893
|
-
],
|
|
2894
|
-
additionalProperties: false
|
|
2895
|
-
},
|
|
2896
|
-
description: 'Messages on the ticket in chronological order. Internal notes are excluded. Returned by the detail endpoint only.'
|
|
2897
|
-
}
|
|
2898
|
-
},
|
|
2899
|
-
required: [
|
|
2900
|
-
'id',
|
|
2901
|
-
'status',
|
|
2902
|
-
'category',
|
|
2903
|
-
'summary',
|
|
2904
|
-
'date_created',
|
|
2905
|
-
'date_updated'
|
|
2906
|
-
],
|
|
2907
|
-
additionalProperties: false
|
|
2908
|
-
},
|
|
2909
|
-
description: 'Tickets for the organization, ordered newest first. Messages are omitted from list responses.'
|
|
2910
|
-
}
|
|
2911
|
-
},
|
|
2912
|
-
required: [
|
|
2913
|
-
'items'
|
|
2914
|
-
],
|
|
2915
|
-
additionalProperties: false
|
|
2916
|
-
};
|
|
2917
3356
|
export const TicketMessageInputSchema = {
|
|
2918
3357
|
type: 'object',
|
|
2919
3358
|
properties: {
|
|
@@ -2955,11 +3394,13 @@ export const TicketMessageSchema = {
|
|
|
2955
3394
|
},
|
|
2956
3395
|
author_first_name: {
|
|
2957
3396
|
type: 'string',
|
|
3397
|
+
nullable: true,
|
|
2958
3398
|
description: 'First name of the author. Null when not provided.',
|
|
2959
3399
|
example: 'Jane'
|
|
2960
3400
|
},
|
|
2961
3401
|
author_last_name: {
|
|
2962
3402
|
type: 'string',
|
|
3403
|
+
nullable: true,
|
|
2963
3404
|
description: 'Last name of the author. Null when not provided.',
|
|
2964
3405
|
example: 'Doe'
|
|
2965
3406
|
},
|
|
@@ -3051,6 +3492,7 @@ export const TicketSchema = {
|
|
|
3051
3492
|
closed_at: {
|
|
3052
3493
|
type: 'string',
|
|
3053
3494
|
format: 'date-time',
|
|
3495
|
+
nullable: true,
|
|
3054
3496
|
description: 'Closure timestamp. Null while the ticket is open.',
|
|
3055
3497
|
example: '2026-05-18T16:08:14.338Z'
|
|
3056
3498
|
},
|
|
@@ -3275,12 +3717,21 @@ export const UsageFacetsSchema = {
|
|
|
3275
3717
|
product: {
|
|
3276
3718
|
type: 'array',
|
|
3277
3719
|
items: {
|
|
3278
|
-
type: 'string'
|
|
3720
|
+
type: 'string',
|
|
3721
|
+
enum: [
|
|
3722
|
+
'cfke_controlplane_basic',
|
|
3723
|
+
'cfke_controlplane_pro',
|
|
3724
|
+
'cfke_controlplane_enterprise',
|
|
3725
|
+
'cfke_connected_nodes_basic',
|
|
3726
|
+
'cfke_connected_nodes_pro',
|
|
3727
|
+
'cfke_connected_nodes_enterprise',
|
|
3728
|
+
'cfcr_storage'
|
|
3729
|
+
]
|
|
3279
3730
|
},
|
|
3280
3731
|
description: 'List of unique products',
|
|
3281
3732
|
example: [
|
|
3282
|
-
'
|
|
3283
|
-
'
|
|
3733
|
+
'cfke_controlplane_pro',
|
|
3734
|
+
'cfke_connected_nodes_pro'
|
|
3284
3735
|
]
|
|
3285
3736
|
}
|
|
3286
3737
|
},
|
|
@@ -3307,7 +3758,16 @@ export const UsageResponseSchema = {
|
|
|
3307
3758
|
product: {
|
|
3308
3759
|
type: 'string',
|
|
3309
3760
|
description: 'The product the usage is associated with',
|
|
3310
|
-
example: '
|
|
3761
|
+
example: 'cfke_controlplane_pro',
|
|
3762
|
+
enum: [
|
|
3763
|
+
'cfke_controlplane_basic',
|
|
3764
|
+
'cfke_controlplane_pro',
|
|
3765
|
+
'cfke_controlplane_enterprise',
|
|
3766
|
+
'cfke_connected_nodes_basic',
|
|
3767
|
+
'cfke_connected_nodes_pro',
|
|
3768
|
+
'cfke_connected_nodes_enterprise',
|
|
3769
|
+
'cfcr_storage'
|
|
3770
|
+
]
|
|
3311
3771
|
},
|
|
3312
3772
|
value: {
|
|
3313
3773
|
type: 'number',
|
|
@@ -3355,12 +3815,21 @@ export const UsageResponseSchema = {
|
|
|
3355
3815
|
product: {
|
|
3356
3816
|
type: 'array',
|
|
3357
3817
|
items: {
|
|
3358
|
-
type: 'string'
|
|
3818
|
+
type: 'string',
|
|
3819
|
+
enum: [
|
|
3820
|
+
'cfke_controlplane_basic',
|
|
3821
|
+
'cfke_controlplane_pro',
|
|
3822
|
+
'cfke_controlplane_enterprise',
|
|
3823
|
+
'cfke_connected_nodes_basic',
|
|
3824
|
+
'cfke_connected_nodes_pro',
|
|
3825
|
+
'cfke_connected_nodes_enterprise',
|
|
3826
|
+
'cfcr_storage'
|
|
3827
|
+
]
|
|
3359
3828
|
},
|
|
3360
3829
|
description: 'List of unique products',
|
|
3361
3830
|
example: [
|
|
3362
|
-
'
|
|
3363
|
-
'
|
|
3831
|
+
'cfke_controlplane_pro',
|
|
3832
|
+
'cfke_connected_nodes_pro'
|
|
3364
3833
|
]
|
|
3365
3834
|
}
|
|
3366
3835
|
},
|
|
@@ -3390,7 +3859,16 @@ export const UsageSchema = {
|
|
|
3390
3859
|
product: {
|
|
3391
3860
|
type: 'string',
|
|
3392
3861
|
description: 'The product the usage is associated with',
|
|
3393
|
-
example: '
|
|
3862
|
+
example: 'cfke_controlplane_pro',
|
|
3863
|
+
enum: [
|
|
3864
|
+
'cfke_controlplane_basic',
|
|
3865
|
+
'cfke_controlplane_pro',
|
|
3866
|
+
'cfke_controlplane_enterprise',
|
|
3867
|
+
'cfke_connected_nodes_basic',
|
|
3868
|
+
'cfke_connected_nodes_pro',
|
|
3869
|
+
'cfke_connected_nodes_enterprise',
|
|
3870
|
+
'cfcr_storage'
|
|
3871
|
+
]
|
|
3394
3872
|
},
|
|
3395
3873
|
value: {
|
|
3396
3874
|
type: 'number',
|
|
@@ -3453,24 +3931,6 @@ export const UserCreateInputSchema = {
|
|
|
3453
3931
|
type: 'string',
|
|
3454
3932
|
minLength: 8,
|
|
3455
3933
|
description: 'User password. Must be at least 8 characters long.'
|
|
3456
|
-
},
|
|
3457
|
-
status: {
|
|
3458
|
-
type: 'string',
|
|
3459
|
-
description: 'Status of the user. Can be `active` or `inactive`. Inactive users cannot log in or manage organization resources.',
|
|
3460
|
-
example: 'active',
|
|
3461
|
-
enum: [
|
|
3462
|
-
'active',
|
|
3463
|
-
'inactive'
|
|
3464
|
-
]
|
|
3465
|
-
},
|
|
3466
|
-
role: {
|
|
3467
|
-
type: 'string',
|
|
3468
|
-
description: 'User role. Can be \'Administrator\', \'User\'.',
|
|
3469
|
-
example: 'User',
|
|
3470
|
-
enum: [
|
|
3471
|
-
'Administrator',
|
|
3472
|
-
'User'
|
|
3473
|
-
]
|
|
3474
3934
|
}
|
|
3475
3935
|
},
|
|
3476
3936
|
required: [
|