@cloudfleet/sdk 0.0.1-cdd334c → 0.0.1-cfddf24
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/@tanstack/react-query.gen.d.ts +1125 -0
- package/dist/@tanstack/react-query.gen.d.ts.map +1 -0
- package/dist/@tanstack/react-query.gen.js +1129 -0
- package/dist/@tanstack/react-query.gen.js.map +1 -0
- package/dist/client/client.gen.d.ts.map +1 -1
- package/dist/client/client.gen.js +103 -119
- package/dist/client/client.gen.js.map +1 -1
- package/dist/client/types.gen.d.ts +5 -2
- package/dist/client/types.gen.d.ts.map +1 -1
- package/dist/client/utils.gen.d.ts +5 -1
- package/dist/client/utils.gen.d.ts.map +1 -1
- package/dist/client/utils.gen.js.map +1 -1
- package/dist/core/serverSentEvents.gen.d.ts +1 -1
- package/dist/core/serverSentEvents.gen.d.ts.map +1 -1
- package/dist/core/serverSentEvents.gen.js +3 -4
- package/dist/core/serverSentEvents.gen.js.map +1 -1
- package/dist/schemas.gen.d.ts +610 -67
- package/dist/schemas.gen.d.ts.map +1 -1
- package/dist/schemas.gen.js +1418 -83
- package/dist/schemas.gen.js.map +1 -1
- package/dist/sdk.gen.d.ts +40 -2
- package/dist/sdk.gen.d.ts.map +1 -1
- package/dist/sdk.gen.js +67 -0
- package/dist/sdk.gen.js.map +1 -1
- package/dist/services/kubernetes/api.d.ts +8 -8
- package/dist/types.gen.d.ts +466 -49
- package/dist/types.gen.d.ts.map +1 -1
- package/dist/zod.gen.d.ts +2059 -73
- package/dist/zod.gen.d.ts.map +1 -1
- package/dist/zod.gen.js +864 -30
- package/dist/zod.gen.js.map +1 -1
- package/package.json +23 -4
package/dist/schemas.gen.d.ts
CHANGED
|
@@ -416,13 +416,24 @@ export declare const ClusterSchema: {
|
|
|
416
416
|
readonly anyOf: readonly [{
|
|
417
417
|
readonly type: "string";
|
|
418
418
|
readonly format: "uri";
|
|
419
|
-
readonly description: "URL of the Kubernetes cluster control plane. This is the endpoint that kubectl uses to connect to the cluster.";
|
|
419
|
+
readonly description: "URL signed by the private CA of the Kubernetes cluster control plane. This is the endpoint that kubectl uses to connect to the cluster. (Deprecated, use endpoint_public instead)";
|
|
420
420
|
readonly example: "https://2ae6557c-c61f-49c6-b4c1-a65473470a03.staging.cfke.cloudfleet.dev:6443";
|
|
421
421
|
}, {
|
|
422
422
|
readonly type: "string";
|
|
423
423
|
readonly enum: readonly [""];
|
|
424
424
|
}];
|
|
425
425
|
};
|
|
426
|
+
readonly endpoint_public: {
|
|
427
|
+
readonly anyOf: readonly [{
|
|
428
|
+
readonly type: "string";
|
|
429
|
+
readonly format: "uri";
|
|
430
|
+
readonly 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.";
|
|
431
|
+
readonly example: "https://2ae6557c-c61f-49c6-b4c1-a65473470a03.staging.cfke.io";
|
|
432
|
+
}, {
|
|
433
|
+
readonly type: "string";
|
|
434
|
+
readonly enum: readonly [""];
|
|
435
|
+
}];
|
|
436
|
+
};
|
|
426
437
|
readonly certificate_ca: {
|
|
427
438
|
readonly type: "string";
|
|
428
439
|
readonly description: "Certificate authority data for the kubernetes cluster. This is the root certificate authority for the cluster.";
|
|
@@ -492,13 +503,12 @@ export declare const FleetCreateInputSchema: {
|
|
|
492
503
|
readonly type: "object";
|
|
493
504
|
readonly properties: {
|
|
494
505
|
readonly cpu: {
|
|
495
|
-
readonly type: "
|
|
496
|
-
readonly format: "float";
|
|
506
|
+
readonly type: "integer";
|
|
497
507
|
readonly minimum: 0;
|
|
498
|
-
readonly
|
|
508
|
+
readonly maximum: 100000;
|
|
509
|
+
readonly description: "CPU limit in cores. Maximum 100,000.";
|
|
499
510
|
};
|
|
500
511
|
};
|
|
501
|
-
readonly required: readonly ["cpu"];
|
|
502
512
|
readonly additionalProperties: false;
|
|
503
513
|
readonly description: "Limits define a set of bounds for provisioning capacity.";
|
|
504
514
|
};
|
|
@@ -507,14 +517,15 @@ export declare const FleetCreateInputSchema: {
|
|
|
507
517
|
readonly properties: {
|
|
508
518
|
readonly enabled: {
|
|
509
519
|
readonly type: "boolean";
|
|
510
|
-
readonly default: true;
|
|
511
520
|
};
|
|
512
521
|
readonly project: {
|
|
513
522
|
readonly type: "string";
|
|
514
|
-
readonly
|
|
523
|
+
readonly pattern: "^[a-z][a-z0-9-]{4,28}[a-z0-9]$";
|
|
524
|
+
readonly description: "GCP project ID to deploy instances into. 6-30 chars, lowercase letters/digits/hyphens, must start with a letter and not end with a hyphen. Omit when GCP is disabled.";
|
|
525
|
+
readonly example: "my-cloudfleet-project";
|
|
515
526
|
};
|
|
516
527
|
};
|
|
517
|
-
readonly required: readonly ["
|
|
528
|
+
readonly required: readonly ["enabled"];
|
|
518
529
|
readonly additionalProperties: false;
|
|
519
530
|
};
|
|
520
531
|
readonly hetzner: {
|
|
@@ -522,14 +533,16 @@ export declare const FleetCreateInputSchema: {
|
|
|
522
533
|
readonly properties: {
|
|
523
534
|
readonly enabled: {
|
|
524
535
|
readonly type: "boolean";
|
|
525
|
-
readonly default: true;
|
|
526
536
|
};
|
|
527
537
|
readonly apiKey: {
|
|
528
538
|
readonly type: "string";
|
|
529
|
-
readonly
|
|
539
|
+
readonly maxLength: 64;
|
|
540
|
+
readonly minLength: 64;
|
|
541
|
+
readonly pattern: "^[A-Za-z0-9]+$";
|
|
542
|
+
readonly description: "Hetzner Cloud API token with read / write access (64 alphanumeric characters). Omit this field to keep the existing value.";
|
|
530
543
|
};
|
|
531
544
|
};
|
|
532
|
-
readonly required: readonly ["
|
|
545
|
+
readonly required: readonly ["enabled"];
|
|
533
546
|
readonly additionalProperties: false;
|
|
534
547
|
};
|
|
535
548
|
readonly aws: {
|
|
@@ -537,15 +550,66 @@ export declare const FleetCreateInputSchema: {
|
|
|
537
550
|
readonly properties: {
|
|
538
551
|
readonly enabled: {
|
|
539
552
|
readonly type: "boolean";
|
|
540
|
-
readonly default: true;
|
|
541
553
|
};
|
|
542
554
|
readonly controllerRoleArn: {
|
|
543
555
|
readonly type: "string";
|
|
544
|
-
readonly
|
|
556
|
+
readonly pattern: "^arn:aws(-[a-z]+)*:iam::\\d{12}:role\\/[\\w+=,.@/-]+$";
|
|
557
|
+
readonly description: "AWS IAM role ARN that Karpenter uses to manage resources. Omit when AWS is disabled.";
|
|
558
|
+
readonly example: "arn:aws:iam::123456789012:role/Cloudfleet";
|
|
559
|
+
};
|
|
560
|
+
};
|
|
561
|
+
readonly required: readonly ["enabled"];
|
|
562
|
+
readonly additionalProperties: false;
|
|
563
|
+
};
|
|
564
|
+
readonly constraints: {
|
|
565
|
+
readonly type: "object";
|
|
566
|
+
readonly properties: {
|
|
567
|
+
readonly 'karpenter.sh/capacity-type': {
|
|
568
|
+
readonly type: "array";
|
|
569
|
+
readonly items: {
|
|
570
|
+
readonly type: "string";
|
|
571
|
+
readonly enum: readonly ["on-demand", "spot"];
|
|
572
|
+
};
|
|
573
|
+
readonly minItems: 1;
|
|
574
|
+
readonly description: "Allowed values for `karpenter.sh/capacity-type`.";
|
|
575
|
+
readonly default: readonly ["on-demand", "spot"];
|
|
576
|
+
};
|
|
577
|
+
readonly 'kubernetes.io/arch': {
|
|
578
|
+
readonly type: "array";
|
|
579
|
+
readonly items: {
|
|
580
|
+
readonly type: "string";
|
|
581
|
+
readonly enum: readonly ["amd64", "arm64"];
|
|
582
|
+
};
|
|
583
|
+
readonly minItems: 1;
|
|
584
|
+
readonly description: "Allowed values for `kubernetes.io/arch`.";
|
|
585
|
+
readonly default: readonly ["amd64"];
|
|
586
|
+
};
|
|
587
|
+
readonly 'cfke.io/instance-family': {
|
|
588
|
+
readonly type: "array";
|
|
589
|
+
readonly items: {
|
|
590
|
+
readonly type: "string";
|
|
591
|
+
readonly enum: readonly ["a1", "a2", "a3", "a4", "c1", "c2", "c2d", "c3", "c3d", "c4", "c4a", "c4d", "c5", "c5a", "c5ad", "c5d", "c5n", "c6a", "c6g", "c6gd", "c6gn", "c6i", "c6id", "c6in", "c7a", "c7g", "c7gd", "c7gn", "c7i", "c7i-flex", "c8g", "c8gd", "cax", "ccx", "cpx", "cx", "d2", "d3", "d3en", "dl1", "dl2q", "e2", "f1", "f2", "g1", "g2", "g4ad", "g4dn", "g5", "g5g", "g6", "g6e", "gr6", "h1", "h3", "hpc6a", "hpc6id", "hpc7a", "hpc7g", "i2", "i3", "i3en", "i4g", "i4i", "i7i", "i7ie", "i8g", "im4gn", "inf1", "inf2", "is4gen", "m1", "m2", "m3", "m4", "m5", "m5a", "m5ad", "m5d", "m5dn", "m5n", "m5zn", "m6a", "m6g", "m6gd", "m6i", "m6id", "m6idn", "m6in", "m7a", "m7g", "m7gd", "m7i", "m7i-flex", "m8g", "m8gd", "n1", "n2", "n2d", "n4", "p3", "p3dn", "p4d", "p4de", "p5", "p5e", "p5en", "p6-b200", "r3", "r4", "r5", "r5a", "r5ad", "r5b", "r5d", "r5dn", "r5n", "r6a", "r6g", "r6gd", "r6i", "r6id", "r6idn", "r6in", "r7a", "r7g", "r7gd", "r7i", "r7iz", "r8g", "r8gd", "t2", "t2a", "t2d", "t3", "t3a", "t4g", "trn1", "trn1n", "u-3tb1", "u-6tb1", "u7i-12tb", "u7i-6tb", "u7i-8tb", "u7in-16tb", "u7in-24tb", "u7in-32tb", "vt1", "x1", "x1e", "x2gd", "x2idn", "x2iedn", "x2iezn", "x4", "x8g", "z1d", "z3"];
|
|
592
|
+
};
|
|
593
|
+
readonly description: "Allowed values for `cfke.io/instance-family`.";
|
|
594
|
+
};
|
|
595
|
+
readonly 'topology.kubernetes.io/region': {
|
|
596
|
+
readonly type: "array";
|
|
597
|
+
readonly items: {
|
|
598
|
+
readonly type: "string";
|
|
599
|
+
readonly enum: readonly ["africa-south1", "ap-northeast-1", "ap-northeast-2", "ap-northeast-3", "ap-south-1", "ap-southeast-1", "ap-southeast-2", "ash", "asia-east1", "asia-east2", "asia-northeast1", "asia-northeast2", "asia-northeast3", "asia-south1", "asia-south2", "asia-southeast1", "asia-southeast2", "australia-southeast1", "australia-southeast2", "ca-central-1", "eu-central-1", "eu-central-2", "eu-north-1", "eu-west-1", "eu-west-2", "eu-west-3", "europe-central2", "europe-north1", "europe-southwest1", "europe-west1", "europe-west10", "europe-west12", "europe-west2", "europe-west3", "europe-west4", "europe-west6", "europe-west8", "europe-west9", "fsn1", "hel1", "hil", "me-central1", "me-central2", "me-west1", "nbg1", "northamerica-northeast1", "northamerica-northeast2", "sa-east-1", "sin", "southamerica-east1", "southamerica-west1", "us-central1", "us-east-1", "us-east-2", "us-east1", "us-east4", "us-east5", "us-south1", "us-west-1", "us-west-2", "us-west1", "us-west2", "us-west3", "us-west4"];
|
|
600
|
+
};
|
|
601
|
+
readonly description: "Allowed values for `topology.kubernetes.io/region`.";
|
|
545
602
|
};
|
|
546
603
|
};
|
|
547
|
-
readonly required: readonly ["controllerRoleArn"];
|
|
548
604
|
readonly additionalProperties: false;
|
|
605
|
+
readonly description: "Constraints define scheduling and provisioning requirements for the fleet. Each field restricts the values allowed for a given Kubernetes label key. Multiple constraints are ANDed together. Omit a field to place no restriction on that key.";
|
|
606
|
+
};
|
|
607
|
+
readonly scalingProfile: {
|
|
608
|
+
readonly type: "string";
|
|
609
|
+
readonly description: "Controls scale-up / scale-down responsiveness. `aggressive` prioritizes cost-optimization. `conservative` prioritizes stability of the fleet.";
|
|
610
|
+
readonly default: "conservative";
|
|
611
|
+
readonly example: "conservative";
|
|
612
|
+
readonly enum: readonly ["aggressive", "conservative"];
|
|
549
613
|
};
|
|
550
614
|
readonly id: {
|
|
551
615
|
readonly type: "string";
|
|
@@ -566,13 +630,12 @@ export declare const FleetSchema: {
|
|
|
566
630
|
readonly type: "object";
|
|
567
631
|
readonly properties: {
|
|
568
632
|
readonly cpu: {
|
|
569
|
-
readonly type: "
|
|
570
|
-
readonly format: "float";
|
|
633
|
+
readonly type: "integer";
|
|
571
634
|
readonly minimum: 0;
|
|
572
|
-
readonly
|
|
635
|
+
readonly maximum: 100000;
|
|
636
|
+
readonly description: "CPU limit in cores. Maximum 100,000.";
|
|
573
637
|
};
|
|
574
638
|
};
|
|
575
|
-
readonly required: readonly ["cpu"];
|
|
576
639
|
readonly additionalProperties: false;
|
|
577
640
|
readonly description: "Limits define a set of bounds for provisioning capacity.";
|
|
578
641
|
};
|
|
@@ -581,14 +644,15 @@ export declare const FleetSchema: {
|
|
|
581
644
|
readonly properties: {
|
|
582
645
|
readonly enabled: {
|
|
583
646
|
readonly type: "boolean";
|
|
584
|
-
readonly default: true;
|
|
585
647
|
};
|
|
586
648
|
readonly project: {
|
|
587
649
|
readonly type: "string";
|
|
588
|
-
readonly
|
|
650
|
+
readonly pattern: "^[a-z][a-z0-9-]{4,28}[a-z0-9]$";
|
|
651
|
+
readonly description: "GCP project ID to deploy instances into. 6-30 chars, lowercase letters/digits/hyphens, must start with a letter and not end with a hyphen. Omit when GCP is disabled.";
|
|
652
|
+
readonly example: "my-cloudfleet-project";
|
|
589
653
|
};
|
|
590
654
|
};
|
|
591
|
-
readonly required: readonly ["
|
|
655
|
+
readonly required: readonly ["enabled"];
|
|
592
656
|
readonly additionalProperties: false;
|
|
593
657
|
};
|
|
594
658
|
readonly hetzner: {
|
|
@@ -596,14 +660,14 @@ export declare const FleetSchema: {
|
|
|
596
660
|
readonly properties: {
|
|
597
661
|
readonly enabled: {
|
|
598
662
|
readonly type: "boolean";
|
|
599
|
-
readonly default: true;
|
|
600
663
|
};
|
|
601
664
|
readonly apiKey: {
|
|
602
665
|
readonly type: "string";
|
|
603
|
-
readonly
|
|
666
|
+
readonly pattern: "^\\*{64}$";
|
|
667
|
+
readonly description: "Redacted Hetzner API token. Returned as 64 asterisks when a token is configured; omitted otherwise. The real value is never echoed by the API.";
|
|
604
668
|
};
|
|
605
669
|
};
|
|
606
|
-
readonly required: readonly ["
|
|
670
|
+
readonly required: readonly ["enabled"];
|
|
607
671
|
readonly additionalProperties: false;
|
|
608
672
|
};
|
|
609
673
|
readonly aws: {
|
|
@@ -611,15 +675,66 @@ export declare const FleetSchema: {
|
|
|
611
675
|
readonly properties: {
|
|
612
676
|
readonly enabled: {
|
|
613
677
|
readonly type: "boolean";
|
|
614
|
-
readonly default: true;
|
|
615
678
|
};
|
|
616
679
|
readonly controllerRoleArn: {
|
|
617
680
|
readonly type: "string";
|
|
618
|
-
readonly
|
|
681
|
+
readonly pattern: "^arn:aws(-[a-z]+)*:iam::\\d{12}:role\\/[\\w+=,.@/-]+$";
|
|
682
|
+
readonly description: "AWS IAM role ARN that Karpenter uses to manage resources. Omit when AWS is disabled.";
|
|
683
|
+
readonly example: "arn:aws:iam::123456789012:role/Cloudfleet";
|
|
684
|
+
};
|
|
685
|
+
};
|
|
686
|
+
readonly required: readonly ["enabled"];
|
|
687
|
+
readonly additionalProperties: false;
|
|
688
|
+
};
|
|
689
|
+
readonly constraints: {
|
|
690
|
+
readonly type: "object";
|
|
691
|
+
readonly properties: {
|
|
692
|
+
readonly 'karpenter.sh/capacity-type': {
|
|
693
|
+
readonly type: "array";
|
|
694
|
+
readonly items: {
|
|
695
|
+
readonly type: "string";
|
|
696
|
+
readonly enum: readonly ["on-demand", "spot"];
|
|
697
|
+
};
|
|
698
|
+
readonly minItems: 1;
|
|
699
|
+
readonly description: "Allowed values for `karpenter.sh/capacity-type`.";
|
|
700
|
+
readonly default: readonly ["on-demand", "spot"];
|
|
701
|
+
};
|
|
702
|
+
readonly 'kubernetes.io/arch': {
|
|
703
|
+
readonly type: "array";
|
|
704
|
+
readonly items: {
|
|
705
|
+
readonly type: "string";
|
|
706
|
+
readonly enum: readonly ["amd64", "arm64"];
|
|
707
|
+
};
|
|
708
|
+
readonly minItems: 1;
|
|
709
|
+
readonly description: "Allowed values for `kubernetes.io/arch`.";
|
|
710
|
+
readonly default: readonly ["amd64"];
|
|
711
|
+
};
|
|
712
|
+
readonly 'cfke.io/instance-family': {
|
|
713
|
+
readonly type: "array";
|
|
714
|
+
readonly items: {
|
|
715
|
+
readonly type: "string";
|
|
716
|
+
readonly enum: readonly ["a1", "a2", "a3", "a4", "c1", "c2", "c2d", "c3", "c3d", "c4", "c4a", "c4d", "c5", "c5a", "c5ad", "c5d", "c5n", "c6a", "c6g", "c6gd", "c6gn", "c6i", "c6id", "c6in", "c7a", "c7g", "c7gd", "c7gn", "c7i", "c7i-flex", "c8g", "c8gd", "cax", "ccx", "cpx", "cx", "d2", "d3", "d3en", "dl1", "dl2q", "e2", "f1", "f2", "g1", "g2", "g4ad", "g4dn", "g5", "g5g", "g6", "g6e", "gr6", "h1", "h3", "hpc6a", "hpc6id", "hpc7a", "hpc7g", "i2", "i3", "i3en", "i4g", "i4i", "i7i", "i7ie", "i8g", "im4gn", "inf1", "inf2", "is4gen", "m1", "m2", "m3", "m4", "m5", "m5a", "m5ad", "m5d", "m5dn", "m5n", "m5zn", "m6a", "m6g", "m6gd", "m6i", "m6id", "m6idn", "m6in", "m7a", "m7g", "m7gd", "m7i", "m7i-flex", "m8g", "m8gd", "n1", "n2", "n2d", "n4", "p3", "p3dn", "p4d", "p4de", "p5", "p5e", "p5en", "p6-b200", "r3", "r4", "r5", "r5a", "r5ad", "r5b", "r5d", "r5dn", "r5n", "r6a", "r6g", "r6gd", "r6i", "r6id", "r6idn", "r6in", "r7a", "r7g", "r7gd", "r7i", "r7iz", "r8g", "r8gd", "t2", "t2a", "t2d", "t3", "t3a", "t4g", "trn1", "trn1n", "u-3tb1", "u-6tb1", "u7i-12tb", "u7i-6tb", "u7i-8tb", "u7in-16tb", "u7in-24tb", "u7in-32tb", "vt1", "x1", "x1e", "x2gd", "x2idn", "x2iedn", "x2iezn", "x4", "x8g", "z1d", "z3"];
|
|
717
|
+
};
|
|
718
|
+
readonly description: "Allowed values for `cfke.io/instance-family`.";
|
|
719
|
+
};
|
|
720
|
+
readonly 'topology.kubernetes.io/region': {
|
|
721
|
+
readonly type: "array";
|
|
722
|
+
readonly items: {
|
|
723
|
+
readonly type: "string";
|
|
724
|
+
readonly enum: readonly ["africa-south1", "ap-northeast-1", "ap-northeast-2", "ap-northeast-3", "ap-south-1", "ap-southeast-1", "ap-southeast-2", "ash", "asia-east1", "asia-east2", "asia-northeast1", "asia-northeast2", "asia-northeast3", "asia-south1", "asia-south2", "asia-southeast1", "asia-southeast2", "australia-southeast1", "australia-southeast2", "ca-central-1", "eu-central-1", "eu-central-2", "eu-north-1", "eu-west-1", "eu-west-2", "eu-west-3", "europe-central2", "europe-north1", "europe-southwest1", "europe-west1", "europe-west10", "europe-west12", "europe-west2", "europe-west3", "europe-west4", "europe-west6", "europe-west8", "europe-west9", "fsn1", "hel1", "hil", "me-central1", "me-central2", "me-west1", "nbg1", "northamerica-northeast1", "northamerica-northeast2", "sa-east-1", "sin", "southamerica-east1", "southamerica-west1", "us-central1", "us-east-1", "us-east-2", "us-east1", "us-east4", "us-east5", "us-south1", "us-west-1", "us-west-2", "us-west1", "us-west2", "us-west3", "us-west4"];
|
|
725
|
+
};
|
|
726
|
+
readonly description: "Allowed values for `topology.kubernetes.io/region`.";
|
|
619
727
|
};
|
|
620
728
|
};
|
|
621
|
-
readonly required: readonly ["controllerRoleArn"];
|
|
622
729
|
readonly additionalProperties: false;
|
|
730
|
+
readonly description: "Constraints define scheduling and provisioning requirements for the fleet. Each field restricts the values allowed for a given Kubernetes label key. Multiple constraints are ANDed together. Omit a field to place no restriction on that key.";
|
|
731
|
+
};
|
|
732
|
+
readonly scalingProfile: {
|
|
733
|
+
readonly type: "string";
|
|
734
|
+
readonly description: "Controls scale-up / scale-down responsiveness. `aggressive` prioritizes cost-optimization. `conservative` prioritizes stability of the fleet.";
|
|
735
|
+
readonly default: "conservative";
|
|
736
|
+
readonly example: "conservative";
|
|
737
|
+
readonly enum: readonly ["aggressive", "conservative"];
|
|
623
738
|
};
|
|
624
739
|
readonly id: {
|
|
625
740
|
readonly type: "string";
|
|
@@ -630,7 +745,7 @@ export declare const FleetSchema: {
|
|
|
630
745
|
readonly example: "new-clouds-fleet";
|
|
631
746
|
};
|
|
632
747
|
};
|
|
633
|
-
readonly required: readonly ["id"];
|
|
748
|
+
readonly required: readonly ["scalingProfile", "id"];
|
|
634
749
|
readonly additionalProperties: false;
|
|
635
750
|
};
|
|
636
751
|
export declare const FleetUpdateInputSchema: {
|
|
@@ -640,13 +755,12 @@ export declare const FleetUpdateInputSchema: {
|
|
|
640
755
|
readonly type: "object";
|
|
641
756
|
readonly properties: {
|
|
642
757
|
readonly cpu: {
|
|
643
|
-
readonly type: "
|
|
644
|
-
readonly format: "float";
|
|
758
|
+
readonly type: "integer";
|
|
645
759
|
readonly minimum: 0;
|
|
646
|
-
readonly
|
|
760
|
+
readonly maximum: 100000;
|
|
761
|
+
readonly description: "CPU limit in cores. Maximum 100,000.";
|
|
647
762
|
};
|
|
648
763
|
};
|
|
649
|
-
readonly required: readonly ["cpu"];
|
|
650
764
|
readonly additionalProperties: false;
|
|
651
765
|
readonly description: "Limits define a set of bounds for provisioning capacity.";
|
|
652
766
|
};
|
|
@@ -655,14 +769,15 @@ export declare const FleetUpdateInputSchema: {
|
|
|
655
769
|
readonly properties: {
|
|
656
770
|
readonly enabled: {
|
|
657
771
|
readonly type: "boolean";
|
|
658
|
-
readonly default: true;
|
|
659
772
|
};
|
|
660
773
|
readonly project: {
|
|
661
774
|
readonly type: "string";
|
|
662
|
-
readonly
|
|
775
|
+
readonly pattern: "^[a-z][a-z0-9-]{4,28}[a-z0-9]$";
|
|
776
|
+
readonly description: "GCP project ID to deploy instances into. 6-30 chars, lowercase letters/digits/hyphens, must start with a letter and not end with a hyphen. Omit when GCP is disabled.";
|
|
777
|
+
readonly example: "my-cloudfleet-project";
|
|
663
778
|
};
|
|
664
779
|
};
|
|
665
|
-
readonly required: readonly ["
|
|
780
|
+
readonly required: readonly ["enabled"];
|
|
666
781
|
readonly additionalProperties: false;
|
|
667
782
|
};
|
|
668
783
|
readonly hetzner: {
|
|
@@ -670,14 +785,16 @@ export declare const FleetUpdateInputSchema: {
|
|
|
670
785
|
readonly properties: {
|
|
671
786
|
readonly enabled: {
|
|
672
787
|
readonly type: "boolean";
|
|
673
|
-
readonly default: true;
|
|
674
788
|
};
|
|
675
789
|
readonly apiKey: {
|
|
676
790
|
readonly type: "string";
|
|
677
|
-
readonly
|
|
791
|
+
readonly maxLength: 64;
|
|
792
|
+
readonly minLength: 64;
|
|
793
|
+
readonly pattern: "^[A-Za-z0-9]+$";
|
|
794
|
+
readonly description: "Hetzner Cloud API token with read / write access (64 alphanumeric characters). Omit this field to keep the existing value.";
|
|
678
795
|
};
|
|
679
796
|
};
|
|
680
|
-
readonly required: readonly ["
|
|
797
|
+
readonly required: readonly ["enabled"];
|
|
681
798
|
readonly additionalProperties: false;
|
|
682
799
|
};
|
|
683
800
|
readonly aws: {
|
|
@@ -685,17 +802,66 @@ export declare const FleetUpdateInputSchema: {
|
|
|
685
802
|
readonly properties: {
|
|
686
803
|
readonly enabled: {
|
|
687
804
|
readonly type: "boolean";
|
|
688
|
-
readonly default: true;
|
|
689
805
|
};
|
|
690
806
|
readonly controllerRoleArn: {
|
|
691
807
|
readonly type: "string";
|
|
692
|
-
readonly
|
|
808
|
+
readonly pattern: "^arn:aws(-[a-z]+)*:iam::\\d{12}:role\\/[\\w+=,.@/-]+$";
|
|
809
|
+
readonly description: "AWS IAM role ARN that Karpenter uses to manage resources. Omit when AWS is disabled.";
|
|
810
|
+
readonly example: "arn:aws:iam::123456789012:role/Cloudfleet";
|
|
693
811
|
};
|
|
694
812
|
};
|
|
695
|
-
readonly required: readonly ["
|
|
813
|
+
readonly required: readonly ["enabled"];
|
|
696
814
|
readonly additionalProperties: false;
|
|
697
815
|
};
|
|
816
|
+
readonly constraints: {
|
|
817
|
+
readonly type: "object";
|
|
818
|
+
readonly properties: {
|
|
819
|
+
readonly 'karpenter.sh/capacity-type': {
|
|
820
|
+
readonly type: "array";
|
|
821
|
+
readonly items: {
|
|
822
|
+
readonly type: "string";
|
|
823
|
+
readonly enum: readonly ["on-demand", "spot"];
|
|
824
|
+
};
|
|
825
|
+
readonly minItems: 1;
|
|
826
|
+
readonly description: "Allowed values for `karpenter.sh/capacity-type`.";
|
|
827
|
+
};
|
|
828
|
+
readonly 'kubernetes.io/arch': {
|
|
829
|
+
readonly type: "array";
|
|
830
|
+
readonly items: {
|
|
831
|
+
readonly type: "string";
|
|
832
|
+
readonly enum: readonly ["amd64", "arm64"];
|
|
833
|
+
};
|
|
834
|
+
readonly minItems: 1;
|
|
835
|
+
readonly description: "Allowed values for `kubernetes.io/arch`.";
|
|
836
|
+
};
|
|
837
|
+
readonly 'cfke.io/instance-family': {
|
|
838
|
+
readonly type: "array";
|
|
839
|
+
readonly items: {
|
|
840
|
+
readonly type: "string";
|
|
841
|
+
readonly enum: readonly ["a1", "a2", "a3", "a4", "c1", "c2", "c2d", "c3", "c3d", "c4", "c4a", "c4d", "c5", "c5a", "c5ad", "c5d", "c5n", "c6a", "c6g", "c6gd", "c6gn", "c6i", "c6id", "c6in", "c7a", "c7g", "c7gd", "c7gn", "c7i", "c7i-flex", "c8g", "c8gd", "cax", "ccx", "cpx", "cx", "d2", "d3", "d3en", "dl1", "dl2q", "e2", "f1", "f2", "g1", "g2", "g4ad", "g4dn", "g5", "g5g", "g6", "g6e", "gr6", "h1", "h3", "hpc6a", "hpc6id", "hpc7a", "hpc7g", "i2", "i3", "i3en", "i4g", "i4i", "i7i", "i7ie", "i8g", "im4gn", "inf1", "inf2", "is4gen", "m1", "m2", "m3", "m4", "m5", "m5a", "m5ad", "m5d", "m5dn", "m5n", "m5zn", "m6a", "m6g", "m6gd", "m6i", "m6id", "m6idn", "m6in", "m7a", "m7g", "m7gd", "m7i", "m7i-flex", "m8g", "m8gd", "n1", "n2", "n2d", "n4", "p3", "p3dn", "p4d", "p4de", "p5", "p5e", "p5en", "p6-b200", "r3", "r4", "r5", "r5a", "r5ad", "r5b", "r5d", "r5dn", "r5n", "r6a", "r6g", "r6gd", "r6i", "r6id", "r6idn", "r6in", "r7a", "r7g", "r7gd", "r7i", "r7iz", "r8g", "r8gd", "t2", "t2a", "t2d", "t3", "t3a", "t4g", "trn1", "trn1n", "u-3tb1", "u-6tb1", "u7i-12tb", "u7i-6tb", "u7i-8tb", "u7in-16tb", "u7in-24tb", "u7in-32tb", "vt1", "x1", "x1e", "x2gd", "x2idn", "x2iedn", "x2iezn", "x4", "x8g", "z1d", "z3"];
|
|
842
|
+
};
|
|
843
|
+
readonly description: "Allowed values for `cfke.io/instance-family`.";
|
|
844
|
+
};
|
|
845
|
+
readonly 'topology.kubernetes.io/region': {
|
|
846
|
+
readonly type: "array";
|
|
847
|
+
readonly items: {
|
|
848
|
+
readonly type: "string";
|
|
849
|
+
readonly enum: readonly ["africa-south1", "ap-northeast-1", "ap-northeast-2", "ap-northeast-3", "ap-south-1", "ap-southeast-1", "ap-southeast-2", "ash", "asia-east1", "asia-east2", "asia-northeast1", "asia-northeast2", "asia-northeast3", "asia-south1", "asia-south2", "asia-southeast1", "asia-southeast2", "australia-southeast1", "australia-southeast2", "ca-central-1", "eu-central-1", "eu-central-2", "eu-north-1", "eu-west-1", "eu-west-2", "eu-west-3", "europe-central2", "europe-north1", "europe-southwest1", "europe-west1", "europe-west10", "europe-west12", "europe-west2", "europe-west3", "europe-west4", "europe-west6", "europe-west8", "europe-west9", "fsn1", "hel1", "hil", "me-central1", "me-central2", "me-west1", "nbg1", "northamerica-northeast1", "northamerica-northeast2", "sa-east-1", "sin", "southamerica-east1", "southamerica-west1", "us-central1", "us-east-1", "us-east-2", "us-east1", "us-east4", "us-east5", "us-south1", "us-west-1", "us-west-2", "us-west1", "us-west2", "us-west3", "us-west4"];
|
|
850
|
+
};
|
|
851
|
+
readonly description: "Allowed values for `topology.kubernetes.io/region`.";
|
|
852
|
+
};
|
|
853
|
+
};
|
|
854
|
+
readonly additionalProperties: false;
|
|
855
|
+
readonly description: "Constraints define scheduling and provisioning requirements for the fleet. Each field restricts the values allowed for a given Kubernetes label key. Multiple constraints are ANDed together. Omit a field to place no restriction on that key.";
|
|
856
|
+
};
|
|
857
|
+
readonly scalingProfile: {
|
|
858
|
+
readonly type: "string";
|
|
859
|
+
readonly description: "Controls scale-up / scale-down responsiveness. `aggressive` prioritizes cost-optimization. `conservative` prioritizes stability of the fleet.";
|
|
860
|
+
readonly example: "conservative";
|
|
861
|
+
readonly enum: readonly ["aggressive", "conservative"];
|
|
862
|
+
};
|
|
698
863
|
};
|
|
864
|
+
readonly required: readonly ["scalingProfile"];
|
|
699
865
|
readonly additionalProperties: false;
|
|
700
866
|
};
|
|
701
867
|
export declare const InviteSchema: {
|
|
@@ -1052,18 +1218,6 @@ export declare const OrganizationSchema: {
|
|
|
1052
1218
|
readonly minItems: 1;
|
|
1053
1219
|
readonly description: "List of CFKE control plane versions available for the organization.";
|
|
1054
1220
|
};
|
|
1055
|
-
readonly copilot_user_hourly_tokens: {
|
|
1056
|
-
readonly type: "integer";
|
|
1057
|
-
readonly minimum: 0;
|
|
1058
|
-
readonly description: "User-level maximum number of tokens Cloudfleet Copilot can process per hour.";
|
|
1059
|
-
readonly example: 42000;
|
|
1060
|
-
};
|
|
1061
|
-
readonly copilot_organization_hourly_tokens: {
|
|
1062
|
-
readonly type: "integer";
|
|
1063
|
-
readonly minimum: 0;
|
|
1064
|
-
readonly description: "Organization-level maximum number of tokens Cloudfleet Copilot can process per hour.";
|
|
1065
|
-
readonly example: 242000;
|
|
1066
|
-
};
|
|
1067
1221
|
readonly cfcr_storage_gb: {
|
|
1068
1222
|
readonly type: "integer";
|
|
1069
1223
|
readonly minimum: -1;
|
|
@@ -1071,7 +1225,7 @@ export declare const OrganizationSchema: {
|
|
|
1071
1225
|
readonly example: 500;
|
|
1072
1226
|
};
|
|
1073
1227
|
};
|
|
1074
|
-
readonly required: readonly ["basic_clusters_max", "basic_clusters_available", "pro_clusters_max", "pro_clusters_available", "fleets_max", "cluster_tiers", "regions", "versions", "
|
|
1228
|
+
readonly required: readonly ["basic_clusters_max", "basic_clusters_available", "pro_clusters_max", "pro_clusters_available", "fleets_max", "cluster_tiers", "regions", "versions", "cfcr_storage_gb"];
|
|
1075
1229
|
readonly additionalProperties: false;
|
|
1076
1230
|
readonly description: "For security reasons, platform quota is controlled by Cloudfleet and can be updated only by Cloudfleet administrators. Please open a support ticket if you need to change the platform quota.";
|
|
1077
1231
|
};
|
|
@@ -1208,18 +1362,6 @@ export declare const PlatformQuotaSchema: {
|
|
|
1208
1362
|
readonly minItems: 1;
|
|
1209
1363
|
readonly description: "List of CFKE control plane versions available for the organization.";
|
|
1210
1364
|
};
|
|
1211
|
-
readonly copilot_user_hourly_tokens: {
|
|
1212
|
-
readonly type: "integer";
|
|
1213
|
-
readonly minimum: 0;
|
|
1214
|
-
readonly description: "User-level maximum number of tokens Cloudfleet Copilot can process per hour.";
|
|
1215
|
-
readonly example: 42000;
|
|
1216
|
-
};
|
|
1217
|
-
readonly copilot_organization_hourly_tokens: {
|
|
1218
|
-
readonly type: "integer";
|
|
1219
|
-
readonly minimum: 0;
|
|
1220
|
-
readonly description: "Organization-level maximum number of tokens Cloudfleet Copilot can process per hour.";
|
|
1221
|
-
readonly example: 242000;
|
|
1222
|
-
};
|
|
1223
1365
|
readonly cfcr_storage_gb: {
|
|
1224
1366
|
readonly type: "integer";
|
|
1225
1367
|
readonly minimum: -1;
|
|
@@ -1227,7 +1369,7 @@ export declare const PlatformQuotaSchema: {
|
|
|
1227
1369
|
readonly example: 500;
|
|
1228
1370
|
};
|
|
1229
1371
|
};
|
|
1230
|
-
readonly required: readonly ["basic_clusters_max", "basic_clusters_available", "pro_clusters_max", "pro_clusters_available", "fleets_max", "cluster_tiers", "regions", "versions", "
|
|
1372
|
+
readonly required: readonly ["basic_clusters_max", "basic_clusters_available", "pro_clusters_max", "pro_clusters_available", "fleets_max", "cluster_tiers", "regions", "versions", "cfcr_storage_gb"];
|
|
1231
1373
|
readonly additionalProperties: false;
|
|
1232
1374
|
};
|
|
1233
1375
|
export declare const RegistryRepositorySchema: {
|
|
@@ -1461,6 +1603,407 @@ export declare const RegistryTagSchema: {
|
|
|
1461
1603
|
readonly required: readonly ["name", "digest", "size", "region", "repository", "uri"];
|
|
1462
1604
|
readonly additionalProperties: false;
|
|
1463
1605
|
};
|
|
1606
|
+
export declare const TicketAttachmentSchema: {
|
|
1607
|
+
readonly type: "object";
|
|
1608
|
+
readonly properties: {
|
|
1609
|
+
readonly id: {
|
|
1610
|
+
readonly type: "string";
|
|
1611
|
+
readonly description: "Unique identifier of the attachment (Mongo ObjectId).";
|
|
1612
|
+
readonly example: "60c72b2f9f1b2c001f8e4d3c";
|
|
1613
|
+
};
|
|
1614
|
+
readonly filename: {
|
|
1615
|
+
readonly type: "string";
|
|
1616
|
+
readonly description: "Original filename as uploaded.";
|
|
1617
|
+
readonly example: "debug.log";
|
|
1618
|
+
};
|
|
1619
|
+
readonly content_type: {
|
|
1620
|
+
readonly type: "string";
|
|
1621
|
+
readonly description: "MIME content type of the attachment.";
|
|
1622
|
+
readonly example: "text/plain";
|
|
1623
|
+
};
|
|
1624
|
+
readonly size: {
|
|
1625
|
+
readonly type: "integer";
|
|
1626
|
+
readonly description: "Size of the attachment in bytes.";
|
|
1627
|
+
readonly example: 12345;
|
|
1628
|
+
};
|
|
1629
|
+
};
|
|
1630
|
+
readonly required: readonly ["id", "filename", "content_type", "size"];
|
|
1631
|
+
readonly additionalProperties: false;
|
|
1632
|
+
};
|
|
1633
|
+
export declare const TicketCreateInputSchema: {
|
|
1634
|
+
readonly type: "object";
|
|
1635
|
+
readonly properties: {
|
|
1636
|
+
readonly category: {
|
|
1637
|
+
readonly type: "string";
|
|
1638
|
+
readonly description: "Ticket category. Drives auto-assignment and may carry a subcategory in `properties`.";
|
|
1639
|
+
readonly example: "technical";
|
|
1640
|
+
readonly enum: readonly ["billing", "technical", "general"];
|
|
1641
|
+
};
|
|
1642
|
+
readonly body: {
|
|
1643
|
+
readonly type: "string";
|
|
1644
|
+
readonly maxLength: 50000;
|
|
1645
|
+
readonly minLength: 1;
|
|
1646
|
+
readonly pattern: "\\S";
|
|
1647
|
+
readonly description: "Initial message body in markdown. There is no separate subject — the first message body is the description.";
|
|
1648
|
+
readonly example: "My cluster cannot reach the registry. Logs attached.";
|
|
1649
|
+
};
|
|
1650
|
+
readonly properties: {
|
|
1651
|
+
readonly type: "object";
|
|
1652
|
+
readonly additionalProperties: true;
|
|
1653
|
+
readonly description: "Free-form key/value bag set by the UI (e.g. `subcategory`, `cluster_id`, `cluster_name`, `region`).";
|
|
1654
|
+
readonly example: {
|
|
1655
|
+
readonly subcategory: "cluster-question";
|
|
1656
|
+
readonly cluster_id: "60c72b2f9f1b2c001f8e4d3a";
|
|
1657
|
+
};
|
|
1658
|
+
};
|
|
1659
|
+
};
|
|
1660
|
+
readonly required: readonly ["category", "body"];
|
|
1661
|
+
readonly additionalProperties: false;
|
|
1662
|
+
};
|
|
1663
|
+
export declare const TicketListResponseSchema: {
|
|
1664
|
+
readonly type: "object";
|
|
1665
|
+
readonly properties: {
|
|
1666
|
+
readonly items: {
|
|
1667
|
+
readonly type: "array";
|
|
1668
|
+
readonly items: {
|
|
1669
|
+
readonly type: "object";
|
|
1670
|
+
readonly properties: {
|
|
1671
|
+
readonly id: {
|
|
1672
|
+
readonly type: "string";
|
|
1673
|
+
readonly description: "Unique identifier of the ticket (Mongo ObjectId).";
|
|
1674
|
+
readonly example: "60c72b2f9f1b2c001f8e4d3a";
|
|
1675
|
+
};
|
|
1676
|
+
readonly status: {
|
|
1677
|
+
readonly type: "string";
|
|
1678
|
+
readonly description: "Current state of the ticket.";
|
|
1679
|
+
readonly example: "waiting_on_us";
|
|
1680
|
+
readonly enum: readonly ["waiting_on_us", "waiting_on_user", "closed"];
|
|
1681
|
+
};
|
|
1682
|
+
readonly category: {
|
|
1683
|
+
readonly type: "string";
|
|
1684
|
+
readonly description: "Ticket category.";
|
|
1685
|
+
readonly example: "technical";
|
|
1686
|
+
readonly enum: readonly ["billing", "technical", "general"];
|
|
1687
|
+
};
|
|
1688
|
+
readonly summary: {
|
|
1689
|
+
readonly type: "string";
|
|
1690
|
+
readonly description: "First 128 characters of the initial message body, with markdown formatting and newlines stripped. Used for ticket list previews.";
|
|
1691
|
+
readonly example: "My cluster cannot reach the registry. Logs attached.";
|
|
1692
|
+
};
|
|
1693
|
+
readonly closed_at: {
|
|
1694
|
+
readonly type: "string";
|
|
1695
|
+
readonly format: "date-time";
|
|
1696
|
+
readonly nullable: true;
|
|
1697
|
+
readonly description: "Closure timestamp. Null while the ticket is open.";
|
|
1698
|
+
readonly example: "2026-05-18T16:08:14.338Z";
|
|
1699
|
+
};
|
|
1700
|
+
readonly date_created: {
|
|
1701
|
+
readonly type: "string";
|
|
1702
|
+
readonly format: "date-time";
|
|
1703
|
+
readonly description: "Creation date of the ticket. ISO 8601 UTC.";
|
|
1704
|
+
readonly example: "2026-05-11T16:08:14.338Z";
|
|
1705
|
+
};
|
|
1706
|
+
readonly date_updated: {
|
|
1707
|
+
readonly type: "string";
|
|
1708
|
+
readonly format: "date-time";
|
|
1709
|
+
readonly description: "Last update date of the ticket. ISO 8601 UTC.";
|
|
1710
|
+
readonly example: "2026-05-11T16:08:14.338Z";
|
|
1711
|
+
};
|
|
1712
|
+
readonly messages: {
|
|
1713
|
+
readonly type: "array";
|
|
1714
|
+
readonly items: {
|
|
1715
|
+
readonly type: "object";
|
|
1716
|
+
readonly properties: {
|
|
1717
|
+
readonly id: {
|
|
1718
|
+
readonly type: "string";
|
|
1719
|
+
readonly description: "Unique identifier of the message (Mongo ObjectId).";
|
|
1720
|
+
readonly example: "60c72b2f9f1b2c001f8e4d3b";
|
|
1721
|
+
};
|
|
1722
|
+
readonly type: {
|
|
1723
|
+
readonly type: "string";
|
|
1724
|
+
readonly description: "Message type. Internal notes are filtered out of customer-facing responses.";
|
|
1725
|
+
readonly example: "customer_reply";
|
|
1726
|
+
readonly enum: readonly ["customer_reply", "agent_reply"];
|
|
1727
|
+
};
|
|
1728
|
+
readonly body: {
|
|
1729
|
+
readonly type: "string";
|
|
1730
|
+
readonly description: "Message body in markdown.";
|
|
1731
|
+
readonly example: "Thanks — that resolved it on my side.";
|
|
1732
|
+
};
|
|
1733
|
+
readonly author_first_name: {
|
|
1734
|
+
readonly type: "string";
|
|
1735
|
+
readonly nullable: true;
|
|
1736
|
+
readonly description: "First name of the author. Null when not provided.";
|
|
1737
|
+
readonly example: "Jane";
|
|
1738
|
+
};
|
|
1739
|
+
readonly author_last_name: {
|
|
1740
|
+
readonly type: "string";
|
|
1741
|
+
readonly nullable: true;
|
|
1742
|
+
readonly description: "Last name of the author. Null when not provided.";
|
|
1743
|
+
readonly example: "Doe";
|
|
1744
|
+
};
|
|
1745
|
+
readonly attachments: {
|
|
1746
|
+
readonly type: "array";
|
|
1747
|
+
readonly items: {
|
|
1748
|
+
readonly type: "object";
|
|
1749
|
+
readonly properties: {
|
|
1750
|
+
readonly id: {
|
|
1751
|
+
readonly type: "string";
|
|
1752
|
+
readonly description: "Unique identifier of the attachment (Mongo ObjectId).";
|
|
1753
|
+
readonly example: "60c72b2f9f1b2c001f8e4d3c";
|
|
1754
|
+
};
|
|
1755
|
+
readonly filename: {
|
|
1756
|
+
readonly type: "string";
|
|
1757
|
+
readonly description: "Original filename as uploaded.";
|
|
1758
|
+
readonly example: "debug.log";
|
|
1759
|
+
};
|
|
1760
|
+
readonly content_type: {
|
|
1761
|
+
readonly type: "string";
|
|
1762
|
+
readonly description: "MIME content type of the attachment.";
|
|
1763
|
+
readonly example: "text/plain";
|
|
1764
|
+
};
|
|
1765
|
+
readonly size: {
|
|
1766
|
+
readonly type: "integer";
|
|
1767
|
+
readonly description: "Size of the attachment in bytes.";
|
|
1768
|
+
readonly example: 12345;
|
|
1769
|
+
};
|
|
1770
|
+
};
|
|
1771
|
+
readonly required: readonly ["id", "filename", "content_type", "size"];
|
|
1772
|
+
readonly additionalProperties: false;
|
|
1773
|
+
};
|
|
1774
|
+
readonly description: "Attachments associated with this message.";
|
|
1775
|
+
readonly example: readonly [];
|
|
1776
|
+
};
|
|
1777
|
+
readonly date_created: {
|
|
1778
|
+
readonly type: "string";
|
|
1779
|
+
readonly format: "date-time";
|
|
1780
|
+
readonly description: "Creation date of the message. ISO 8601 UTC.";
|
|
1781
|
+
readonly example: "2026-05-11T16:08:14.338Z";
|
|
1782
|
+
};
|
|
1783
|
+
};
|
|
1784
|
+
readonly required: readonly ["id", "type", "body", "date_created"];
|
|
1785
|
+
readonly additionalProperties: false;
|
|
1786
|
+
};
|
|
1787
|
+
readonly description: "Messages on the ticket in chronological order. Internal notes are excluded. Returned by the detail endpoint only.";
|
|
1788
|
+
};
|
|
1789
|
+
};
|
|
1790
|
+
readonly required: readonly ["id", "status", "category", "summary", "date_created", "date_updated"];
|
|
1791
|
+
readonly additionalProperties: false;
|
|
1792
|
+
};
|
|
1793
|
+
readonly description: "Tickets for the organization, ordered newest first. Messages are omitted from list responses.";
|
|
1794
|
+
};
|
|
1795
|
+
};
|
|
1796
|
+
readonly required: readonly ["items"];
|
|
1797
|
+
readonly additionalProperties: false;
|
|
1798
|
+
};
|
|
1799
|
+
export declare const TicketMessageInputSchema: {
|
|
1800
|
+
readonly type: "object";
|
|
1801
|
+
readonly properties: {
|
|
1802
|
+
readonly body: {
|
|
1803
|
+
readonly type: "string";
|
|
1804
|
+
readonly maxLength: 50000;
|
|
1805
|
+
readonly minLength: 1;
|
|
1806
|
+
readonly pattern: "\\S";
|
|
1807
|
+
readonly description: "Reply body in markdown.";
|
|
1808
|
+
readonly example: "Thanks — that resolved it on my side.";
|
|
1809
|
+
};
|
|
1810
|
+
};
|
|
1811
|
+
readonly required: readonly ["body"];
|
|
1812
|
+
readonly additionalProperties: false;
|
|
1813
|
+
};
|
|
1814
|
+
export declare const TicketMessageSchema: {
|
|
1815
|
+
readonly type: "object";
|
|
1816
|
+
readonly properties: {
|
|
1817
|
+
readonly id: {
|
|
1818
|
+
readonly type: "string";
|
|
1819
|
+
readonly description: "Unique identifier of the message (Mongo ObjectId).";
|
|
1820
|
+
readonly example: "60c72b2f9f1b2c001f8e4d3b";
|
|
1821
|
+
};
|
|
1822
|
+
readonly type: {
|
|
1823
|
+
readonly type: "string";
|
|
1824
|
+
readonly description: "Message type. Internal notes are filtered out of customer-facing responses.";
|
|
1825
|
+
readonly example: "customer_reply";
|
|
1826
|
+
readonly enum: readonly ["customer_reply", "agent_reply"];
|
|
1827
|
+
};
|
|
1828
|
+
readonly body: {
|
|
1829
|
+
readonly type: "string";
|
|
1830
|
+
readonly description: "Message body in markdown.";
|
|
1831
|
+
readonly example: "Thanks — that resolved it on my side.";
|
|
1832
|
+
};
|
|
1833
|
+
readonly author_first_name: {
|
|
1834
|
+
readonly type: "string";
|
|
1835
|
+
readonly description: "First name of the author. Null when not provided.";
|
|
1836
|
+
readonly example: "Jane";
|
|
1837
|
+
};
|
|
1838
|
+
readonly author_last_name: {
|
|
1839
|
+
readonly type: "string";
|
|
1840
|
+
readonly description: "Last name of the author. Null when not provided.";
|
|
1841
|
+
readonly example: "Doe";
|
|
1842
|
+
};
|
|
1843
|
+
readonly attachments: {
|
|
1844
|
+
readonly type: "array";
|
|
1845
|
+
readonly items: {
|
|
1846
|
+
readonly type: "object";
|
|
1847
|
+
readonly properties: {
|
|
1848
|
+
readonly id: {
|
|
1849
|
+
readonly type: "string";
|
|
1850
|
+
readonly description: "Unique identifier of the attachment (Mongo ObjectId).";
|
|
1851
|
+
readonly example: "60c72b2f9f1b2c001f8e4d3c";
|
|
1852
|
+
};
|
|
1853
|
+
readonly filename: {
|
|
1854
|
+
readonly type: "string";
|
|
1855
|
+
readonly description: "Original filename as uploaded.";
|
|
1856
|
+
readonly example: "debug.log";
|
|
1857
|
+
};
|
|
1858
|
+
readonly content_type: {
|
|
1859
|
+
readonly type: "string";
|
|
1860
|
+
readonly description: "MIME content type of the attachment.";
|
|
1861
|
+
readonly example: "text/plain";
|
|
1862
|
+
};
|
|
1863
|
+
readonly size: {
|
|
1864
|
+
readonly type: "integer";
|
|
1865
|
+
readonly description: "Size of the attachment in bytes.";
|
|
1866
|
+
readonly example: 12345;
|
|
1867
|
+
};
|
|
1868
|
+
};
|
|
1869
|
+
readonly required: readonly ["id", "filename", "content_type", "size"];
|
|
1870
|
+
readonly additionalProperties: false;
|
|
1871
|
+
};
|
|
1872
|
+
readonly description: "Attachments associated with this message.";
|
|
1873
|
+
readonly example: readonly [];
|
|
1874
|
+
};
|
|
1875
|
+
readonly date_created: {
|
|
1876
|
+
readonly type: "string";
|
|
1877
|
+
readonly format: "date-time";
|
|
1878
|
+
readonly description: "Creation date of the message. ISO 8601 UTC.";
|
|
1879
|
+
readonly example: "2026-05-11T16:08:14.338Z";
|
|
1880
|
+
};
|
|
1881
|
+
};
|
|
1882
|
+
readonly required: readonly ["id", "type", "body", "date_created"];
|
|
1883
|
+
readonly additionalProperties: false;
|
|
1884
|
+
};
|
|
1885
|
+
export declare const TicketSchema: {
|
|
1886
|
+
readonly type: "object";
|
|
1887
|
+
readonly properties: {
|
|
1888
|
+
readonly id: {
|
|
1889
|
+
readonly type: "string";
|
|
1890
|
+
readonly description: "Unique identifier of the ticket (Mongo ObjectId).";
|
|
1891
|
+
readonly example: "60c72b2f9f1b2c001f8e4d3a";
|
|
1892
|
+
};
|
|
1893
|
+
readonly status: {
|
|
1894
|
+
readonly type: "string";
|
|
1895
|
+
readonly description: "Current state of the ticket.";
|
|
1896
|
+
readonly example: "waiting_on_us";
|
|
1897
|
+
readonly enum: readonly ["waiting_on_us", "waiting_on_user", "closed"];
|
|
1898
|
+
};
|
|
1899
|
+
readonly category: {
|
|
1900
|
+
readonly type: "string";
|
|
1901
|
+
readonly description: "Ticket category.";
|
|
1902
|
+
readonly example: "technical";
|
|
1903
|
+
readonly enum: readonly ["billing", "technical", "general"];
|
|
1904
|
+
};
|
|
1905
|
+
readonly summary: {
|
|
1906
|
+
readonly type: "string";
|
|
1907
|
+
readonly description: "First 128 characters of the initial message body, with markdown formatting and newlines stripped. Used for ticket list previews.";
|
|
1908
|
+
readonly example: "My cluster cannot reach the registry. Logs attached.";
|
|
1909
|
+
};
|
|
1910
|
+
readonly closed_at: {
|
|
1911
|
+
readonly type: "string";
|
|
1912
|
+
readonly format: "date-time";
|
|
1913
|
+
readonly description: "Closure timestamp. Null while the ticket is open.";
|
|
1914
|
+
readonly example: "2026-05-18T16:08:14.338Z";
|
|
1915
|
+
};
|
|
1916
|
+
readonly date_created: {
|
|
1917
|
+
readonly type: "string";
|
|
1918
|
+
readonly format: "date-time";
|
|
1919
|
+
readonly description: "Creation date of the ticket. ISO 8601 UTC.";
|
|
1920
|
+
readonly example: "2026-05-11T16:08:14.338Z";
|
|
1921
|
+
};
|
|
1922
|
+
readonly date_updated: {
|
|
1923
|
+
readonly type: "string";
|
|
1924
|
+
readonly format: "date-time";
|
|
1925
|
+
readonly description: "Last update date of the ticket. ISO 8601 UTC.";
|
|
1926
|
+
readonly example: "2026-05-11T16:08:14.338Z";
|
|
1927
|
+
};
|
|
1928
|
+
readonly messages: {
|
|
1929
|
+
readonly type: "array";
|
|
1930
|
+
readonly items: {
|
|
1931
|
+
readonly type: "object";
|
|
1932
|
+
readonly properties: {
|
|
1933
|
+
readonly id: {
|
|
1934
|
+
readonly type: "string";
|
|
1935
|
+
readonly description: "Unique identifier of the message (Mongo ObjectId).";
|
|
1936
|
+
readonly example: "60c72b2f9f1b2c001f8e4d3b";
|
|
1937
|
+
};
|
|
1938
|
+
readonly type: {
|
|
1939
|
+
readonly type: "string";
|
|
1940
|
+
readonly description: "Message type. Internal notes are filtered out of customer-facing responses.";
|
|
1941
|
+
readonly example: "customer_reply";
|
|
1942
|
+
readonly enum: readonly ["customer_reply", "agent_reply"];
|
|
1943
|
+
};
|
|
1944
|
+
readonly body: {
|
|
1945
|
+
readonly type: "string";
|
|
1946
|
+
readonly description: "Message body in markdown.";
|
|
1947
|
+
readonly example: "Thanks — that resolved it on my side.";
|
|
1948
|
+
};
|
|
1949
|
+
readonly author_first_name: {
|
|
1950
|
+
readonly type: "string";
|
|
1951
|
+
readonly description: "First name of the author. Null when not provided.";
|
|
1952
|
+
readonly example: "Jane";
|
|
1953
|
+
};
|
|
1954
|
+
readonly author_last_name: {
|
|
1955
|
+
readonly type: "string";
|
|
1956
|
+
readonly description: "Last name of the author. Null when not provided.";
|
|
1957
|
+
readonly example: "Doe";
|
|
1958
|
+
};
|
|
1959
|
+
readonly attachments: {
|
|
1960
|
+
readonly type: "array";
|
|
1961
|
+
readonly items: {
|
|
1962
|
+
readonly type: "object";
|
|
1963
|
+
readonly properties: {
|
|
1964
|
+
readonly id: {
|
|
1965
|
+
readonly type: "string";
|
|
1966
|
+
readonly description: "Unique identifier of the attachment (Mongo ObjectId).";
|
|
1967
|
+
readonly example: "60c72b2f9f1b2c001f8e4d3c";
|
|
1968
|
+
};
|
|
1969
|
+
readonly filename: {
|
|
1970
|
+
readonly type: "string";
|
|
1971
|
+
readonly description: "Original filename as uploaded.";
|
|
1972
|
+
readonly example: "debug.log";
|
|
1973
|
+
};
|
|
1974
|
+
readonly content_type: {
|
|
1975
|
+
readonly type: "string";
|
|
1976
|
+
readonly description: "MIME content type of the attachment.";
|
|
1977
|
+
readonly example: "text/plain";
|
|
1978
|
+
};
|
|
1979
|
+
readonly size: {
|
|
1980
|
+
readonly type: "integer";
|
|
1981
|
+
readonly description: "Size of the attachment in bytes.";
|
|
1982
|
+
readonly example: 12345;
|
|
1983
|
+
};
|
|
1984
|
+
};
|
|
1985
|
+
readonly required: readonly ["id", "filename", "content_type", "size"];
|
|
1986
|
+
readonly additionalProperties: false;
|
|
1987
|
+
};
|
|
1988
|
+
readonly description: "Attachments associated with this message.";
|
|
1989
|
+
readonly example: readonly [];
|
|
1990
|
+
};
|
|
1991
|
+
readonly date_created: {
|
|
1992
|
+
readonly type: "string";
|
|
1993
|
+
readonly format: "date-time";
|
|
1994
|
+
readonly description: "Creation date of the message. ISO 8601 UTC.";
|
|
1995
|
+
readonly example: "2026-05-11T16:08:14.338Z";
|
|
1996
|
+
};
|
|
1997
|
+
};
|
|
1998
|
+
readonly required: readonly ["id", "type", "body", "date_created"];
|
|
1999
|
+
readonly additionalProperties: false;
|
|
2000
|
+
};
|
|
2001
|
+
readonly description: "Messages on the ticket in chronological order. Internal notes are excluded. Returned by the detail endpoint only.";
|
|
2002
|
+
};
|
|
2003
|
+
};
|
|
2004
|
+
readonly required: readonly ["id", "status", "category", "summary", "date_created", "date_updated"];
|
|
2005
|
+
readonly additionalProperties: false;
|
|
2006
|
+
};
|
|
1464
2007
|
export declare const TokenCreateInputSchema: {
|
|
1465
2008
|
readonly type: "object";
|
|
1466
2009
|
readonly properties: {
|