@cloudfleet/sdk 0.0.1-c034297 → 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 +566 -225
- package/dist/schemas.gen.d.ts.map +1 -1
- package/dist/schemas.gen.js +757 -317
- 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 +1719 -1472
- package/dist/zod.gen.d.ts.map +1 -1
- package/dist/zod.gen.js +530 -352
- 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: {
|
|
609
692
|
type: 'string',
|
|
610
|
-
|
|
611
|
-
|
|
612
|
-
|
|
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: {
|
|
699
|
+
type: 'string',
|
|
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: [
|
|
@@ -1011,7 +1240,8 @@ export const FleetCreateInputSchema = {
|
|
|
1011
1240
|
'z3'
|
|
1012
1241
|
]
|
|
1013
1242
|
},
|
|
1014
|
-
description: 'Allowed values for `cfke.io/instance-family`.'
|
|
1243
|
+
description: 'Allowed values for `cfke.io/instance-family`.',
|
|
1244
|
+
default: []
|
|
1015
1245
|
},
|
|
1016
1246
|
'topology.kubernetes.io/region': {
|
|
1017
1247
|
type: 'array',
|
|
@@ -1084,15 +1314,27 @@ export const FleetCreateInputSchema = {
|
|
|
1084
1314
|
'us-west4'
|
|
1085
1315
|
]
|
|
1086
1316
|
},
|
|
1087
|
-
description: 'Allowed values for `topology.kubernetes.io/region`.'
|
|
1317
|
+
description: 'Allowed values for `topology.kubernetes.io/region`.',
|
|
1318
|
+
default: []
|
|
1088
1319
|
}
|
|
1089
1320
|
},
|
|
1090
1321
|
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.
|
|
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
|
+
}
|
|
1092
1334
|
},
|
|
1093
1335
|
scalingProfile: {
|
|
1094
1336
|
type: 'string',
|
|
1095
|
-
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`).',
|
|
1096
1338
|
default: 'conservative',
|
|
1097
1339
|
example: 'conservative',
|
|
1098
1340
|
enum: [
|
|
@@ -1112,7 +1354,8 @@ export const FleetCreateInputSchema = {
|
|
|
1112
1354
|
required: [
|
|
1113
1355
|
'id'
|
|
1114
1356
|
],
|
|
1115
|
-
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.'
|
|
1116
1359
|
};
|
|
1117
1360
|
export const FleetSchema = {
|
|
1118
1361
|
type: 'object',
|
|
@@ -1382,7 +1625,8 @@ export const FleetSchema = {
|
|
|
1382
1625
|
'z3'
|
|
1383
1626
|
]
|
|
1384
1627
|
},
|
|
1385
|
-
description: 'Allowed values for `cfke.io/instance-family`.'
|
|
1628
|
+
description: 'Allowed values for `cfke.io/instance-family`.',
|
|
1629
|
+
default: []
|
|
1386
1630
|
},
|
|
1387
1631
|
'topology.kubernetes.io/region': {
|
|
1388
1632
|
type: 'array',
|
|
@@ -1455,15 +1699,31 @@ export const FleetSchema = {
|
|
|
1455
1699
|
'us-west4'
|
|
1456
1700
|
]
|
|
1457
1701
|
},
|
|
1458
|
-
description: 'Allowed values for `topology.kubernetes.io/region`.'
|
|
1702
|
+
description: 'Allowed values for `topology.kubernetes.io/region`.',
|
|
1703
|
+
default: []
|
|
1459
1704
|
}
|
|
1460
1705
|
},
|
|
1706
|
+
required: [
|
|
1707
|
+
'karpenter.sh/capacity-type',
|
|
1708
|
+
'kubernetes.io/arch'
|
|
1709
|
+
],
|
|
1461
1710
|
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.
|
|
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
|
+
}
|
|
1463
1723
|
},
|
|
1464
1724
|
scalingProfile: {
|
|
1465
1725
|
type: 'string',
|
|
1466
|
-
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`).',
|
|
1467
1727
|
default: 'conservative',
|
|
1468
1728
|
example: 'conservative',
|
|
1469
1729
|
enum: [
|
|
@@ -1478,13 +1738,38 @@ export const FleetSchema = {
|
|
|
1478
1738
|
pattern: '^[a-z0-9]([-a-z0-9]*[a-z0-9])?$',
|
|
1479
1739
|
description: 'Unique identifier of the kubernetes fleet.',
|
|
1480
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'
|
|
1481
1761
|
}
|
|
1482
1762
|
},
|
|
1483
1763
|
required: [
|
|
1764
|
+
'constraints',
|
|
1484
1765
|
'scalingProfile',
|
|
1485
|
-
'id'
|
|
1766
|
+
'id',
|
|
1767
|
+
'ready',
|
|
1768
|
+
'created_at',
|
|
1769
|
+
'updated_at'
|
|
1486
1770
|
],
|
|
1487
|
-
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.'
|
|
1488
1773
|
};
|
|
1489
1774
|
export const FleetUpdateInputSchema = {
|
|
1490
1775
|
type: 'object',
|
|
@@ -1530,8 +1815,8 @@ export const FleetUpdateInputSchema = {
|
|
|
1530
1815
|
type: 'string',
|
|
1531
1816
|
maxLength: 64,
|
|
1532
1817
|
minLength: 64,
|
|
1533
|
-
pattern: '^[A-Za-z0-9]
|
|
1534
|
-
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.'
|
|
1535
1820
|
}
|
|
1536
1821
|
},
|
|
1537
1822
|
required: [
|
|
@@ -1570,7 +1855,11 @@ export const FleetUpdateInputSchema = {
|
|
|
1570
1855
|
]
|
|
1571
1856
|
},
|
|
1572
1857
|
minItems: 1,
|
|
1573
|
-
description: 'Allowed values for `karpenter.sh/capacity-type`.'
|
|
1858
|
+
description: 'Allowed values for `karpenter.sh/capacity-type`.',
|
|
1859
|
+
default: [
|
|
1860
|
+
'on-demand',
|
|
1861
|
+
'spot'
|
|
1862
|
+
]
|
|
1574
1863
|
},
|
|
1575
1864
|
'kubernetes.io/arch': {
|
|
1576
1865
|
type: 'array',
|
|
@@ -1582,7 +1871,10 @@ export const FleetUpdateInputSchema = {
|
|
|
1582
1871
|
]
|
|
1583
1872
|
},
|
|
1584
1873
|
minItems: 1,
|
|
1585
|
-
description: 'Allowed values for `kubernetes.io/arch`.'
|
|
1874
|
+
description: 'Allowed values for `kubernetes.io/arch`.',
|
|
1875
|
+
default: [
|
|
1876
|
+
'amd64'
|
|
1877
|
+
]
|
|
1586
1878
|
},
|
|
1587
1879
|
'cfke.io/instance-family': {
|
|
1588
1880
|
type: 'array',
|
|
@@ -1749,7 +2041,8 @@ export const FleetUpdateInputSchema = {
|
|
|
1749
2041
|
'z3'
|
|
1750
2042
|
]
|
|
1751
2043
|
},
|
|
1752
|
-
description: 'Allowed values for `cfke.io/instance-family`.'
|
|
2044
|
+
description: 'Allowed values for `cfke.io/instance-family`.',
|
|
2045
|
+
default: []
|
|
1753
2046
|
},
|
|
1754
2047
|
'topology.kubernetes.io/region': {
|
|
1755
2048
|
type: 'array',
|
|
@@ -1822,15 +2115,28 @@ export const FleetUpdateInputSchema = {
|
|
|
1822
2115
|
'us-west4'
|
|
1823
2116
|
]
|
|
1824
2117
|
},
|
|
1825
|
-
description: 'Allowed values for `topology.kubernetes.io/region`.'
|
|
2118
|
+
description: 'Allowed values for `topology.kubernetes.io/region`.',
|
|
2119
|
+
default: []
|
|
1826
2120
|
}
|
|
1827
2121
|
},
|
|
1828
2122
|
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.
|
|
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
|
+
}
|
|
1830
2135
|
},
|
|
1831
2136
|
scalingProfile: {
|
|
1832
2137
|
type: 'string',
|
|
1833
|
-
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',
|
|
1834
2140
|
example: 'conservative',
|
|
1835
2141
|
enum: [
|
|
1836
2142
|
'aggressive',
|
|
@@ -1838,8 +2144,31 @@ export const FleetUpdateInputSchema = {
|
|
|
1838
2144
|
]
|
|
1839
2145
|
}
|
|
1840
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
|
+
},
|
|
1841
2170
|
required: [
|
|
1842
|
-
'
|
|
2171
|
+
'email'
|
|
1843
2172
|
],
|
|
1844
2173
|
additionalProperties: false
|
|
1845
2174
|
};
|
|
@@ -1873,6 +2202,16 @@ export const InviteSchema = {
|
|
|
1873
2202
|
type: 'string',
|
|
1874
2203
|
description: 'Generated unique invite code.',
|
|
1875
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
|
+
]
|
|
1876
2215
|
}
|
|
1877
2216
|
},
|
|
1878
2217
|
required: [
|
|
@@ -1880,6 +2219,170 @@ export const InviteSchema = {
|
|
|
1880
2219
|
],
|
|
1881
2220
|
additionalProperties: false
|
|
1882
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
|
+
};
|
|
1883
2386
|
export const InvoiceSchema = {
|
|
1884
2387
|
type: 'object',
|
|
1885
2388
|
properties: {
|
|
@@ -2093,6 +2596,15 @@ export const MarketplaceListingSchema = {
|
|
|
2093
2596
|
export const OrganizationCreateInputSchema = {
|
|
2094
2597
|
type: 'object',
|
|
2095
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
|
+
},
|
|
2096
2608
|
email: {
|
|
2097
2609
|
type: 'string',
|
|
2098
2610
|
format: 'email',
|
|
@@ -2101,11 +2613,13 @@ export const OrganizationCreateInputSchema = {
|
|
|
2101
2613
|
},
|
|
2102
2614
|
first_name: {
|
|
2103
2615
|
type: 'string',
|
|
2616
|
+
minLength: 1,
|
|
2104
2617
|
description: 'First name of the billing contact person.',
|
|
2105
2618
|
example: 'John'
|
|
2106
2619
|
},
|
|
2107
2620
|
last_name: {
|
|
2108
2621
|
type: 'string',
|
|
2622
|
+
minLength: 1,
|
|
2109
2623
|
description: 'Last name of the billing contact person.',
|
|
2110
2624
|
example: 'Doe'
|
|
2111
2625
|
},
|
|
@@ -2124,6 +2638,7 @@ export const OrganizationCreateInputSchema = {
|
|
|
2124
2638
|
}
|
|
2125
2639
|
},
|
|
2126
2640
|
required: [
|
|
2641
|
+
'type',
|
|
2127
2642
|
'email',
|
|
2128
2643
|
'first_name',
|
|
2129
2644
|
'last_name',
|
|
@@ -2132,6 +2647,20 @@ export const OrganizationCreateInputSchema = {
|
|
|
2132
2647
|
],
|
|
2133
2648
|
additionalProperties: false
|
|
2134
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
|
+
};
|
|
2135
2664
|
export const OrganizationSchema = {
|
|
2136
2665
|
type: 'object',
|
|
2137
2666
|
properties: {
|
|
@@ -2148,6 +2677,15 @@ export const OrganizationSchema = {
|
|
|
2148
2677
|
description: 'Name of the legal entity. This name will be used in invoices. Use your first and last name for individual accounts.',
|
|
2149
2678
|
example: 'ACME Corp.'
|
|
2150
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
|
+
},
|
|
2151
2689
|
date_created: {
|
|
2152
2690
|
type: 'string',
|
|
2153
2691
|
format: 'date-time',
|
|
@@ -2179,6 +2717,17 @@ export const OrganizationSchema = {
|
|
|
2179
2717
|
description: 'Available number of Pro clusters that can be created.',
|
|
2180
2718
|
example: 999
|
|
2181
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
|
+
},
|
|
2182
2731
|
fleets_max: {
|
|
2183
2732
|
type: 'integer',
|
|
2184
2733
|
minimum: 0,
|
|
@@ -2198,7 +2747,7 @@ export const OrganizationSchema = {
|
|
|
2198
2747
|
type: 'array',
|
|
2199
2748
|
items: {
|
|
2200
2749
|
type: 'string',
|
|
2201
|
-
example: 'northamerica-central-
|
|
2750
|
+
example: 'northamerica-central-1a'
|
|
2202
2751
|
},
|
|
2203
2752
|
minItems: 1,
|
|
2204
2753
|
description: 'List of Cloudfleet control plane regions available for the organization.'
|
|
@@ -2240,6 +2789,8 @@ export const OrganizationSchema = {
|
|
|
2240
2789
|
'basic_clusters_available',
|
|
2241
2790
|
'pro_clusters_max',
|
|
2242
2791
|
'pro_clusters_available',
|
|
2792
|
+
'enterprise_clusters_max',
|
|
2793
|
+
'enterprise_clusters_available',
|
|
2243
2794
|
'fleets_max',
|
|
2244
2795
|
'cluster_tiers',
|
|
2245
2796
|
'regions',
|
|
@@ -2257,13 +2808,25 @@ export const OrganizationSchema = {
|
|
|
2257
2808
|
'closed',
|
|
2258
2809
|
'suspended'
|
|
2259
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
|
+
]
|
|
2260
2821
|
}
|
|
2261
2822
|
},
|
|
2262
2823
|
required: [
|
|
2263
2824
|
'id',
|
|
2825
|
+
'type',
|
|
2264
2826
|
'date_created',
|
|
2265
2827
|
'quota',
|
|
2266
|
-
'status'
|
|
2828
|
+
'status',
|
|
2829
|
+
'verification'
|
|
2267
2830
|
],
|
|
2268
2831
|
additionalProperties: false
|
|
2269
2832
|
};
|
|
@@ -2272,28 +2835,23 @@ export const PaymentMethodSchema = {
|
|
|
2272
2835
|
properties: {
|
|
2273
2836
|
id: {
|
|
2274
2837
|
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
|
|
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'
|
|
2283
2840
|
},
|
|
2284
2841
|
type: {
|
|
2285
2842
|
type: 'string',
|
|
2286
|
-
|
|
2287
|
-
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.',
|
|
2288
2844
|
example: 'card',
|
|
2289
2845
|
enum: [
|
|
2290
|
-
'card'
|
|
2846
|
+
'card',
|
|
2847
|
+
'sepa_debit',
|
|
2848
|
+
'bank_transfer'
|
|
2291
2849
|
]
|
|
2292
2850
|
},
|
|
2293
2851
|
last4: {
|
|
2294
2852
|
type: 'string',
|
|
2295
2853
|
nullable: true,
|
|
2296
|
-
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.',
|
|
2297
2855
|
example: '4242'
|
|
2298
2856
|
},
|
|
2299
2857
|
exp_month: {
|
|
@@ -2301,42 +2859,56 @@ export const PaymentMethodSchema = {
|
|
|
2301
2859
|
minimum: 1,
|
|
2302
2860
|
maximum: 12,
|
|
2303
2861
|
nullable: true,
|
|
2304
|
-
description: 'Two-digit number representing the card\'s expiration month.',
|
|
2305
|
-
example:
|
|
2862
|
+
description: 'Two-digit number representing the card\'s expiration month. Null for SEPA Direct Debit and bank transfer.',
|
|
2863
|
+
example: 12
|
|
2306
2864
|
},
|
|
2307
2865
|
exp_year: {
|
|
2308
2866
|
type: 'integer',
|
|
2309
|
-
minimum: 2024,
|
|
2310
2867
|
nullable: true,
|
|
2311
|
-
description: 'Four-digit number representing the card\'s expiration year.',
|
|
2312
|
-
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
|
|
2313
2870
|
},
|
|
2314
2871
|
brand: {
|
|
2315
2872
|
type: 'string',
|
|
2316
2873
|
nullable: true,
|
|
2317
|
-
description: 'Payment card brand
|
|
2318
|
-
example: 'visa'
|
|
2319
|
-
|
|
2320
|
-
|
|
2321
|
-
|
|
2322
|
-
|
|
2323
|
-
|
|
2324
|
-
|
|
2325
|
-
|
|
2326
|
-
|
|
2327
|
-
|
|
2328
|
-
|
|
2329
|
-
|
|
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
|
|
2330
2899
|
}
|
|
2331
2900
|
},
|
|
2332
2901
|
required: [
|
|
2333
2902
|
'id',
|
|
2334
|
-
'setup',
|
|
2335
2903
|
'type',
|
|
2336
2904
|
'last4',
|
|
2337
2905
|
'exp_month',
|
|
2338
2906
|
'exp_year',
|
|
2339
|
-
'brand'
|
|
2907
|
+
'brand',
|
|
2908
|
+
'iban',
|
|
2909
|
+
'bic',
|
|
2910
|
+
'account_holder_name',
|
|
2911
|
+
'is_default'
|
|
2340
2912
|
],
|
|
2341
2913
|
additionalProperties: false
|
|
2342
2914
|
};
|
|
@@ -2365,6 +2937,17 @@ export const PlatformQuotaSchema = {
|
|
|
2365
2937
|
description: 'Available number of Pro clusters that can be created.',
|
|
2366
2938
|
example: 999
|
|
2367
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
|
+
},
|
|
2368
2951
|
fleets_max: {
|
|
2369
2952
|
type: 'integer',
|
|
2370
2953
|
minimum: 0,
|
|
@@ -2384,7 +2967,7 @@ export const PlatformQuotaSchema = {
|
|
|
2384
2967
|
type: 'array',
|
|
2385
2968
|
items: {
|
|
2386
2969
|
type: 'string',
|
|
2387
|
-
example: 'northamerica-central-
|
|
2970
|
+
example: 'northamerica-central-1a'
|
|
2388
2971
|
},
|
|
2389
2972
|
minItems: 1,
|
|
2390
2973
|
description: 'List of Cloudfleet control plane regions available for the organization.'
|
|
@@ -2426,6 +3009,8 @@ export const PlatformQuotaSchema = {
|
|
|
2426
3009
|
'basic_clusters_available',
|
|
2427
3010
|
'pro_clusters_max',
|
|
2428
3011
|
'pro_clusters_available',
|
|
3012
|
+
'enterprise_clusters_max',
|
|
3013
|
+
'enterprise_clusters_available',
|
|
2429
3014
|
'fleets_max',
|
|
2430
3015
|
'cluster_tiers',
|
|
2431
3016
|
'regions',
|
|
@@ -2768,172 +3353,6 @@ export const TicketCreateInputSchema = {
|
|
|
2768
3353
|
],
|
|
2769
3354
|
additionalProperties: false
|
|
2770
3355
|
};
|
|
2771
|
-
export const TicketListResponseSchema = {
|
|
2772
|
-
type: 'object',
|
|
2773
|
-
properties: {
|
|
2774
|
-
items: {
|
|
2775
|
-
type: 'array',
|
|
2776
|
-
items: {
|
|
2777
|
-
type: 'object',
|
|
2778
|
-
properties: {
|
|
2779
|
-
id: {
|
|
2780
|
-
type: 'string',
|
|
2781
|
-
description: 'Unique identifier of the ticket (Mongo ObjectId).',
|
|
2782
|
-
example: '60c72b2f9f1b2c001f8e4d3a'
|
|
2783
|
-
},
|
|
2784
|
-
status: {
|
|
2785
|
-
type: 'string',
|
|
2786
|
-
description: 'Current state of the ticket.',
|
|
2787
|
-
example: 'waiting_on_us',
|
|
2788
|
-
enum: [
|
|
2789
|
-
'waiting_on_us',
|
|
2790
|
-
'waiting_on_user',
|
|
2791
|
-
'closed'
|
|
2792
|
-
]
|
|
2793
|
-
},
|
|
2794
|
-
category: {
|
|
2795
|
-
type: 'string',
|
|
2796
|
-
description: 'Ticket category.',
|
|
2797
|
-
example: 'technical',
|
|
2798
|
-
enum: [
|
|
2799
|
-
'billing',
|
|
2800
|
-
'technical',
|
|
2801
|
-
'general'
|
|
2802
|
-
]
|
|
2803
|
-
},
|
|
2804
|
-
summary: {
|
|
2805
|
-
type: 'string',
|
|
2806
|
-
description: 'First 128 characters of the initial message body, with markdown formatting and newlines stripped. Used for ticket list previews.',
|
|
2807
|
-
example: 'My cluster cannot reach the registry. Logs attached.'
|
|
2808
|
-
},
|
|
2809
|
-
closed_at: {
|
|
2810
|
-
type: 'string',
|
|
2811
|
-
format: 'date-time',
|
|
2812
|
-
nullable: true,
|
|
2813
|
-
description: 'Closure timestamp. Null while the ticket is open.',
|
|
2814
|
-
example: '2026-05-18T16:08:14.338Z'
|
|
2815
|
-
},
|
|
2816
|
-
date_created: {
|
|
2817
|
-
type: 'string',
|
|
2818
|
-
format: 'date-time',
|
|
2819
|
-
description: 'Creation date of the ticket. ISO 8601 UTC.',
|
|
2820
|
-
example: '2026-05-11T16:08:14.338Z'
|
|
2821
|
-
},
|
|
2822
|
-
date_updated: {
|
|
2823
|
-
type: 'string',
|
|
2824
|
-
format: 'date-time',
|
|
2825
|
-
description: 'Last update date of the ticket. ISO 8601 UTC.',
|
|
2826
|
-
example: '2026-05-11T16:08:14.338Z'
|
|
2827
|
-
},
|
|
2828
|
-
messages: {
|
|
2829
|
-
type: 'array',
|
|
2830
|
-
items: {
|
|
2831
|
-
type: 'object',
|
|
2832
|
-
properties: {
|
|
2833
|
-
id: {
|
|
2834
|
-
type: 'string',
|
|
2835
|
-
description: 'Unique identifier of the message (Mongo ObjectId).',
|
|
2836
|
-
example: '60c72b2f9f1b2c001f8e4d3b'
|
|
2837
|
-
},
|
|
2838
|
-
type: {
|
|
2839
|
-
type: 'string',
|
|
2840
|
-
description: 'Message type. Internal notes are filtered out of customer-facing responses.',
|
|
2841
|
-
example: 'customer_reply',
|
|
2842
|
-
enum: [
|
|
2843
|
-
'customer_reply',
|
|
2844
|
-
'agent_reply'
|
|
2845
|
-
]
|
|
2846
|
-
},
|
|
2847
|
-
body: {
|
|
2848
|
-
type: 'string',
|
|
2849
|
-
description: 'Message body in markdown.',
|
|
2850
|
-
example: 'Thanks — that resolved it on my side.'
|
|
2851
|
-
},
|
|
2852
|
-
author_first_name: {
|
|
2853
|
-
type: 'string',
|
|
2854
|
-
nullable: true,
|
|
2855
|
-
description: 'First name of the author. Null when not provided.',
|
|
2856
|
-
example: 'Jane'
|
|
2857
|
-
},
|
|
2858
|
-
author_last_name: {
|
|
2859
|
-
type: 'string',
|
|
2860
|
-
nullable: true,
|
|
2861
|
-
description: 'Last name of the author. Null when not provided.',
|
|
2862
|
-
example: 'Doe'
|
|
2863
|
-
},
|
|
2864
|
-
attachments: {
|
|
2865
|
-
type: 'array',
|
|
2866
|
-
items: {
|
|
2867
|
-
type: 'object',
|
|
2868
|
-
properties: {
|
|
2869
|
-
id: {
|
|
2870
|
-
type: 'string',
|
|
2871
|
-
description: 'Unique identifier of the attachment (Mongo ObjectId).',
|
|
2872
|
-
example: '60c72b2f9f1b2c001f8e4d3c'
|
|
2873
|
-
},
|
|
2874
|
-
filename: {
|
|
2875
|
-
type: 'string',
|
|
2876
|
-
description: 'Original filename as uploaded.',
|
|
2877
|
-
example: 'debug.log'
|
|
2878
|
-
},
|
|
2879
|
-
content_type: {
|
|
2880
|
-
type: 'string',
|
|
2881
|
-
description: 'MIME content type of the attachment.',
|
|
2882
|
-
example: 'text/plain'
|
|
2883
|
-
},
|
|
2884
|
-
size: {
|
|
2885
|
-
type: 'integer',
|
|
2886
|
-
description: 'Size of the attachment in bytes.',
|
|
2887
|
-
example: 12345
|
|
2888
|
-
}
|
|
2889
|
-
},
|
|
2890
|
-
required: [
|
|
2891
|
-
'id',
|
|
2892
|
-
'filename',
|
|
2893
|
-
'content_type',
|
|
2894
|
-
'size'
|
|
2895
|
-
],
|
|
2896
|
-
additionalProperties: false
|
|
2897
|
-
},
|
|
2898
|
-
description: 'Attachments associated with this message.',
|
|
2899
|
-
example: []
|
|
2900
|
-
},
|
|
2901
|
-
date_created: {
|
|
2902
|
-
type: 'string',
|
|
2903
|
-
format: 'date-time',
|
|
2904
|
-
description: 'Creation date of the message. ISO 8601 UTC.',
|
|
2905
|
-
example: '2026-05-11T16:08:14.338Z'
|
|
2906
|
-
}
|
|
2907
|
-
},
|
|
2908
|
-
required: [
|
|
2909
|
-
'id',
|
|
2910
|
-
'type',
|
|
2911
|
-
'body',
|
|
2912
|
-
'date_created'
|
|
2913
|
-
],
|
|
2914
|
-
additionalProperties: false
|
|
2915
|
-
},
|
|
2916
|
-
description: 'Messages on the ticket in chronological order. Internal notes are excluded. Returned by the detail endpoint only.'
|
|
2917
|
-
}
|
|
2918
|
-
},
|
|
2919
|
-
required: [
|
|
2920
|
-
'id',
|
|
2921
|
-
'status',
|
|
2922
|
-
'category',
|
|
2923
|
-
'summary',
|
|
2924
|
-
'date_created',
|
|
2925
|
-
'date_updated'
|
|
2926
|
-
],
|
|
2927
|
-
additionalProperties: false
|
|
2928
|
-
},
|
|
2929
|
-
description: 'Tickets for the organization, ordered newest first. Messages are omitted from list responses.'
|
|
2930
|
-
}
|
|
2931
|
-
},
|
|
2932
|
-
required: [
|
|
2933
|
-
'items'
|
|
2934
|
-
],
|
|
2935
|
-
additionalProperties: false
|
|
2936
|
-
};
|
|
2937
3356
|
export const TicketMessageInputSchema = {
|
|
2938
3357
|
type: 'object',
|
|
2939
3358
|
properties: {
|
|
@@ -2975,11 +3394,13 @@ export const TicketMessageSchema = {
|
|
|
2975
3394
|
},
|
|
2976
3395
|
author_first_name: {
|
|
2977
3396
|
type: 'string',
|
|
3397
|
+
nullable: true,
|
|
2978
3398
|
description: 'First name of the author. Null when not provided.',
|
|
2979
3399
|
example: 'Jane'
|
|
2980
3400
|
},
|
|
2981
3401
|
author_last_name: {
|
|
2982
3402
|
type: 'string',
|
|
3403
|
+
nullable: true,
|
|
2983
3404
|
description: 'Last name of the author. Null when not provided.',
|
|
2984
3405
|
example: 'Doe'
|
|
2985
3406
|
},
|
|
@@ -3071,6 +3492,7 @@ export const TicketSchema = {
|
|
|
3071
3492
|
closed_at: {
|
|
3072
3493
|
type: 'string',
|
|
3073
3494
|
format: 'date-time',
|
|
3495
|
+
nullable: true,
|
|
3074
3496
|
description: 'Closure timestamp. Null while the ticket is open.',
|
|
3075
3497
|
example: '2026-05-18T16:08:14.338Z'
|
|
3076
3498
|
},
|
|
@@ -3295,12 +3717,21 @@ export const UsageFacetsSchema = {
|
|
|
3295
3717
|
product: {
|
|
3296
3718
|
type: 'array',
|
|
3297
3719
|
items: {
|
|
3298
|
-
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
|
+
]
|
|
3299
3730
|
},
|
|
3300
3731
|
description: 'List of unique products',
|
|
3301
3732
|
example: [
|
|
3302
|
-
'
|
|
3303
|
-
'
|
|
3733
|
+
'cfke_controlplane_pro',
|
|
3734
|
+
'cfke_connected_nodes_pro'
|
|
3304
3735
|
]
|
|
3305
3736
|
}
|
|
3306
3737
|
},
|
|
@@ -3327,7 +3758,16 @@ export const UsageResponseSchema = {
|
|
|
3327
3758
|
product: {
|
|
3328
3759
|
type: 'string',
|
|
3329
3760
|
description: 'The product the usage is associated with',
|
|
3330
|
-
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
|
+
]
|
|
3331
3771
|
},
|
|
3332
3772
|
value: {
|
|
3333
3773
|
type: 'number',
|
|
@@ -3375,12 +3815,21 @@ export const UsageResponseSchema = {
|
|
|
3375
3815
|
product: {
|
|
3376
3816
|
type: 'array',
|
|
3377
3817
|
items: {
|
|
3378
|
-
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
|
+
]
|
|
3379
3828
|
},
|
|
3380
3829
|
description: 'List of unique products',
|
|
3381
3830
|
example: [
|
|
3382
|
-
'
|
|
3383
|
-
'
|
|
3831
|
+
'cfke_controlplane_pro',
|
|
3832
|
+
'cfke_connected_nodes_pro'
|
|
3384
3833
|
]
|
|
3385
3834
|
}
|
|
3386
3835
|
},
|
|
@@ -3410,7 +3859,16 @@ export const UsageSchema = {
|
|
|
3410
3859
|
product: {
|
|
3411
3860
|
type: 'string',
|
|
3412
3861
|
description: 'The product the usage is associated with',
|
|
3413
|
-
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
|
+
]
|
|
3414
3872
|
},
|
|
3415
3873
|
value: {
|
|
3416
3874
|
type: 'number',
|
|
@@ -3473,24 +3931,6 @@ export const UserCreateInputSchema = {
|
|
|
3473
3931
|
type: 'string',
|
|
3474
3932
|
minLength: 8,
|
|
3475
3933
|
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
3934
|
}
|
|
3495
3935
|
},
|
|
3496
3936
|
required: [
|