@cloudfleet/sdk 0.0.1-80ccdf7 → 0.0.1-81297bc
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 +1149 -0
- package/dist/@tanstack/react-query.gen.d.ts.map +1 -0
- package/dist/@tanstack/react-query.gen.js +1165 -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 +728 -119
- package/dist/schemas.gen.d.ts.map +1 -1
- package/dist/schemas.gen.js +1570 -180
- package/dist/schemas.gen.js.map +1 -1
- package/dist/sdk.gen.d.ts +67 -17
- package/dist/sdk.gen.d.ts.map +1 -1
- package/dist/sdk.gen.js +99 -16
- package/dist/sdk.gen.js.map +1 -1
- package/dist/services/kubernetes/api.d.ts +8 -8
- package/dist/types.gen.d.ts +650 -105
- package/dist/types.gen.d.ts.map +1 -1
- package/dist/zod.gen.d.ts +2172 -209
- package/dist/zod.gen.d.ts.map +1 -1
- package/dist/zod.gen.js +929 -93
- package/dist/zod.gen.js.map +1 -1
- package/package.json +23 -4
package/dist/schemas.gen.d.ts
CHANGED
|
@@ -1,6 +1,12 @@
|
|
|
1
1
|
export declare const BillingContactSchema: {
|
|
2
2
|
readonly type: "object";
|
|
3
3
|
readonly properties: {
|
|
4
|
+
readonly type: {
|
|
5
|
+
readonly type: "string";
|
|
6
|
+
readonly description: "Type of the organization. `business` for legal entities, `personal` for individuals.";
|
|
7
|
+
readonly example: "business";
|
|
8
|
+
readonly enum: readonly ["business", "personal"];
|
|
9
|
+
};
|
|
4
10
|
readonly company: {
|
|
5
11
|
readonly type: "string";
|
|
6
12
|
readonly maxLength: 120;
|
|
@@ -76,7 +82,7 @@ export declare const BillingContactSchema: {
|
|
|
76
82
|
readonly enum: readonly ["ad_nrt", "ae_trn", "al_tin", "am_tin", "ao_tin", "ar_cuit", "at_vat", "au_abn", "au_arn", "ba_tin", "bb_tin", "be_vat", "bg_uic", "bg_vat", "bh_vat", "bo_tin", "br_cnpj", "br_cpf", "bs_tin", "by_tin", "ca_bn", "ca_gst_hst", "ca_pst_bc", "ca_pst_mb", "ca_pst_sk", "ca_qst", "cd_nif", "ch_uid", "ch_vat", "cl_tin", "cn_tin", "co_nit", "cr_tin", "cy_vat", "cz_vat", "de_stn", "de_vat", "dk_vat", "do_rcn", "ec_ruc", "ee_vat", "eg_tin", "es_cif", "es_vat", "eu_oss_vat", "fi_vat", "fr_vat", "gb_vat", "ge_vat", "gn_nif", "gr_vat", "hk_br", "hr_oib", "hr_vat", "hu_tin", "hu_vat", "id_npwp", "ie_vat", "il_vat", "in_gst", "is_vat", "it_vat", "jp_cn", "jp_rn", "jp_trn", "ke_pin", "kh_tin", "kr_brn", "kz_bin", "li_uid", "li_vat", "lt_vat", "lu_vat", "lv_vat", "ma_vat", "md_vat", "me_pib", "mk_vat", "mr_nif", "mt_vat", "mx_rfc", "my_frp", "my_itn", "my_sst", "ng_tin", "nl_vat", "no_vat", "no_voec", "np_pan", "nz_gst", "om_vat", "pe_ruc", "ph_tin", "pl_vat", "pt_vat", "ro_tin", "ro_vat", "rs_pib", "ru_inn", "ru_kpp", "sa_vat", "se_vat", "sg_gst", "sg_uen", "si_tin", "si_vat", "sk_vat", "sn_ninea", "sr_fin", "sv_nit", "th_vat", "tj_tin", "tr_tin", "tw_vat", "tz_vat", "ua_vat", "ug_tin", "us_ein", "uy_ruc", "uz_tin", "uz_vat", "ve_rif", "vn_tin", "xi_vat", "za_vat", "zm_tin", "zw_tin", ""];
|
|
77
83
|
};
|
|
78
84
|
};
|
|
79
|
-
readonly required: readonly ["email", "individual_name"];
|
|
85
|
+
readonly required: readonly ["type", "email", "individual_name"];
|
|
80
86
|
readonly additionalProperties: false;
|
|
81
87
|
};
|
|
82
88
|
export declare const BillingCreditsSchema: {
|
|
@@ -211,9 +217,8 @@ export declare const ChartSchema: {
|
|
|
211
217
|
};
|
|
212
218
|
readonly status: {
|
|
213
219
|
readonly type: "string";
|
|
214
|
-
readonly description: "Status of the chart deployment.";
|
|
215
|
-
readonly example: "
|
|
216
|
-
readonly enum: readonly ["InstallSucceeded", "InstallFailed", "UpgradeSucceeded", "UpgradeFailed", "TestSucceeded", "TestFailed", "RollbackSucceeded", "RollbackFailed", "UninstallSucceeded", "UninstallFailed", "ArtifactFailed", "DependencyNotReady", "Progressing", "SourceNotReady"];
|
|
220
|
+
readonly description: "Status of the chart deployment (Flux HelmRelease Ready condition reason, e.g. InstallSucceeded, UpgradeFailed, Progressing).";
|
|
221
|
+
readonly example: "InstallSucceeded";
|
|
217
222
|
};
|
|
218
223
|
readonly version_current: {
|
|
219
224
|
readonly type: "string";
|
|
@@ -275,10 +280,8 @@ export declare const ClusterCreateInputSchema: {
|
|
|
275
280
|
};
|
|
276
281
|
readonly region: {
|
|
277
282
|
readonly type: "string";
|
|
278
|
-
readonly description: "Cloudfleet control plane region.
|
|
279
|
-
readonly
|
|
280
|
-
readonly example: "northamerica-central-1a";
|
|
281
|
-
readonly enum: readonly ["staging-1a", "northamerica-central-1", "europe-central-1a", "northamerica-central-1a"];
|
|
283
|
+
readonly description: "Cloudfleet control plane region. This field can not be updated after creation.";
|
|
284
|
+
readonly example: "europe-central-1a";
|
|
282
285
|
};
|
|
283
286
|
readonly version_channel: {
|
|
284
287
|
readonly type: "string";
|
|
@@ -286,10 +289,9 @@ export declare const ClusterCreateInputSchema: {
|
|
|
286
289
|
readonly description: "Version of the kubernetes cluster.";
|
|
287
290
|
readonly default: "1.x.x-cfke.x";
|
|
288
291
|
readonly example: "1.x.x-cfke.x";
|
|
289
|
-
readonly enum: readonly ["1.x.x-cfke.x", "1.31.x-cfke.x", "1.32.x-cfke.x", "1.33.x-cfke.x"];
|
|
290
292
|
};
|
|
291
293
|
};
|
|
292
|
-
readonly required: readonly ["name", "tier"];
|
|
294
|
+
readonly required: readonly ["name", "tier", "region"];
|
|
293
295
|
readonly additionalProperties: false;
|
|
294
296
|
};
|
|
295
297
|
export declare const ClusterJoinInformationSchema: {
|
|
@@ -311,6 +313,11 @@ export declare const ClusterJoinInformationSchema: {
|
|
|
311
313
|
readonly description: "Cluster DNS IP address. This is the IP address of the kube-dns service in the cluster.";
|
|
312
314
|
readonly example: "10.96.0.10";
|
|
313
315
|
};
|
|
316
|
+
readonly pod_cidr: {
|
|
317
|
+
readonly type: "string";
|
|
318
|
+
readonly description: "Pod CIDR for the cluster. Used to configure iptables rules on nodes to prevent Tailscale routing loops.";
|
|
319
|
+
readonly example: "10.244.0.0/16";
|
|
320
|
+
};
|
|
314
321
|
readonly auth_key: {
|
|
315
322
|
readonly type: "string";
|
|
316
323
|
readonly description: "Authentication key for the cluster.";
|
|
@@ -373,7 +380,7 @@ export declare const ClusterJoinInformationSchema: {
|
|
|
373
380
|
readonly description: "OIDC Information for hosts to access to third party API's.";
|
|
374
381
|
};
|
|
375
382
|
};
|
|
376
|
-
readonly required: readonly ["certificate_authority", "endpoint", "cluster_dns", "auth_key", "bootstrap_token", "versions", "third_party_api_access_config"];
|
|
383
|
+
readonly required: readonly ["certificate_authority", "endpoint", "cluster_dns", "pod_cidr", "auth_key", "bootstrap_token", "versions", "third_party_api_access_config"];
|
|
377
384
|
readonly additionalProperties: false;
|
|
378
385
|
};
|
|
379
386
|
export declare const ClusterSchema: {
|
|
@@ -395,10 +402,8 @@ export declare const ClusterSchema: {
|
|
|
395
402
|
};
|
|
396
403
|
readonly region: {
|
|
397
404
|
readonly type: "string";
|
|
398
|
-
readonly description: "Cloudfleet control plane region.
|
|
399
|
-
readonly
|
|
400
|
-
readonly example: "northamerica-central-1a";
|
|
401
|
-
readonly enum: readonly ["staging-1a", "northamerica-central-1", "europe-central-1a", "northamerica-central-1a"];
|
|
405
|
+
readonly description: "Cloudfleet control plane region. This field can not be updated after creation.";
|
|
406
|
+
readonly example: "europe-central-1a";
|
|
402
407
|
};
|
|
403
408
|
readonly id: {
|
|
404
409
|
readonly type: "string";
|
|
@@ -416,13 +421,24 @@ export declare const ClusterSchema: {
|
|
|
416
421
|
readonly anyOf: readonly [{
|
|
417
422
|
readonly type: "string";
|
|
418
423
|
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.";
|
|
424
|
+
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
425
|
readonly example: "https://2ae6557c-c61f-49c6-b4c1-a65473470a03.staging.cfke.cloudfleet.dev:6443";
|
|
421
426
|
}, {
|
|
422
427
|
readonly type: "string";
|
|
423
428
|
readonly enum: readonly [""];
|
|
424
429
|
}];
|
|
425
430
|
};
|
|
431
|
+
readonly endpoint_public: {
|
|
432
|
+
readonly anyOf: readonly [{
|
|
433
|
+
readonly type: "string";
|
|
434
|
+
readonly format: "uri";
|
|
435
|
+
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.";
|
|
436
|
+
readonly example: "https://2ae6557c-c61f-49c6-b4c1-a65473470a03.staging.cfke.io";
|
|
437
|
+
}, {
|
|
438
|
+
readonly type: "string";
|
|
439
|
+
readonly enum: readonly [""];
|
|
440
|
+
}];
|
|
441
|
+
};
|
|
426
442
|
readonly certificate_ca: {
|
|
427
443
|
readonly type: "string";
|
|
428
444
|
readonly description: "Certificate authority data for the kubernetes cluster. This is the root certificate authority for the cluster.";
|
|
@@ -455,7 +471,7 @@ export declare const ClusterSchema: {
|
|
|
455
471
|
readonly example: "1.x.x-cfke.x";
|
|
456
472
|
};
|
|
457
473
|
};
|
|
458
|
-
readonly required: readonly ["name", "tier", "id", "status"];
|
|
474
|
+
readonly required: readonly ["name", "tier", "region", "id", "status"];
|
|
459
475
|
readonly additionalProperties: false;
|
|
460
476
|
};
|
|
461
477
|
export declare const ClusterUpdateInputSchema: {
|
|
@@ -492,13 +508,12 @@ export declare const FleetCreateInputSchema: {
|
|
|
492
508
|
readonly type: "object";
|
|
493
509
|
readonly properties: {
|
|
494
510
|
readonly cpu: {
|
|
495
|
-
readonly type: "
|
|
496
|
-
readonly format: "float";
|
|
511
|
+
readonly type: "integer";
|
|
497
512
|
readonly minimum: 0;
|
|
498
|
-
readonly
|
|
513
|
+
readonly maximum: 100000;
|
|
514
|
+
readonly description: "CPU limit in cores. Maximum 100,000.";
|
|
499
515
|
};
|
|
500
516
|
};
|
|
501
|
-
readonly required: readonly ["cpu"];
|
|
502
517
|
readonly additionalProperties: false;
|
|
503
518
|
readonly description: "Limits define a set of bounds for provisioning capacity.";
|
|
504
519
|
};
|
|
@@ -507,14 +522,15 @@ export declare const FleetCreateInputSchema: {
|
|
|
507
522
|
readonly properties: {
|
|
508
523
|
readonly enabled: {
|
|
509
524
|
readonly type: "boolean";
|
|
510
|
-
readonly default: true;
|
|
511
525
|
};
|
|
512
526
|
readonly project: {
|
|
513
527
|
readonly type: "string";
|
|
514
|
-
readonly
|
|
528
|
+
readonly pattern: "^[a-z][a-z0-9-]{4,28}[a-z0-9]$";
|
|
529
|
+
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.";
|
|
530
|
+
readonly example: "my-cloudfleet-project";
|
|
515
531
|
};
|
|
516
532
|
};
|
|
517
|
-
readonly required: readonly ["
|
|
533
|
+
readonly required: readonly ["enabled"];
|
|
518
534
|
readonly additionalProperties: false;
|
|
519
535
|
};
|
|
520
536
|
readonly hetzner: {
|
|
@@ -522,14 +538,16 @@ export declare const FleetCreateInputSchema: {
|
|
|
522
538
|
readonly properties: {
|
|
523
539
|
readonly enabled: {
|
|
524
540
|
readonly type: "boolean";
|
|
525
|
-
readonly default: true;
|
|
526
541
|
};
|
|
527
542
|
readonly apiKey: {
|
|
528
543
|
readonly type: "string";
|
|
529
|
-
readonly
|
|
544
|
+
readonly maxLength: 64;
|
|
545
|
+
readonly minLength: 64;
|
|
546
|
+
readonly pattern: "^[A-Za-z0-9]+$";
|
|
547
|
+
readonly description: "Hetzner Cloud API token with read / write access (64 alphanumeric characters). Omit this field to keep the existing value.";
|
|
530
548
|
};
|
|
531
549
|
};
|
|
532
|
-
readonly required: readonly ["
|
|
550
|
+
readonly required: readonly ["enabled"];
|
|
533
551
|
readonly additionalProperties: false;
|
|
534
552
|
};
|
|
535
553
|
readonly aws: {
|
|
@@ -537,15 +555,66 @@ export declare const FleetCreateInputSchema: {
|
|
|
537
555
|
readonly properties: {
|
|
538
556
|
readonly enabled: {
|
|
539
557
|
readonly type: "boolean";
|
|
540
|
-
readonly default: true;
|
|
541
558
|
};
|
|
542
559
|
readonly controllerRoleArn: {
|
|
543
560
|
readonly type: "string";
|
|
544
|
-
readonly
|
|
561
|
+
readonly pattern: "^arn:aws(-[a-z]+)*:iam::\\d{12}:role\\/[\\w+=,.@/-]+$";
|
|
562
|
+
readonly description: "AWS IAM role ARN that Karpenter uses to manage resources. Omit when AWS is disabled.";
|
|
563
|
+
readonly example: "arn:aws:iam::123456789012:role/Cloudfleet";
|
|
564
|
+
};
|
|
565
|
+
};
|
|
566
|
+
readonly required: readonly ["enabled"];
|
|
567
|
+
readonly additionalProperties: false;
|
|
568
|
+
};
|
|
569
|
+
readonly constraints: {
|
|
570
|
+
readonly type: "object";
|
|
571
|
+
readonly properties: {
|
|
572
|
+
readonly 'karpenter.sh/capacity-type': {
|
|
573
|
+
readonly type: "array";
|
|
574
|
+
readonly items: {
|
|
575
|
+
readonly type: "string";
|
|
576
|
+
readonly enum: readonly ["on-demand", "spot"];
|
|
577
|
+
};
|
|
578
|
+
readonly minItems: 1;
|
|
579
|
+
readonly description: "Allowed values for `karpenter.sh/capacity-type`.";
|
|
580
|
+
readonly default: readonly ["on-demand", "spot"];
|
|
581
|
+
};
|
|
582
|
+
readonly 'kubernetes.io/arch': {
|
|
583
|
+
readonly type: "array";
|
|
584
|
+
readonly items: {
|
|
585
|
+
readonly type: "string";
|
|
586
|
+
readonly enum: readonly ["amd64", "arm64"];
|
|
587
|
+
};
|
|
588
|
+
readonly minItems: 1;
|
|
589
|
+
readonly description: "Allowed values for `kubernetes.io/arch`.";
|
|
590
|
+
readonly default: readonly ["amd64"];
|
|
591
|
+
};
|
|
592
|
+
readonly 'cfke.io/instance-family': {
|
|
593
|
+
readonly type: "array";
|
|
594
|
+
readonly items: {
|
|
595
|
+
readonly type: "string";
|
|
596
|
+
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"];
|
|
597
|
+
};
|
|
598
|
+
readonly description: "Allowed values for `cfke.io/instance-family`.";
|
|
599
|
+
};
|
|
600
|
+
readonly 'topology.kubernetes.io/region': {
|
|
601
|
+
readonly type: "array";
|
|
602
|
+
readonly items: {
|
|
603
|
+
readonly type: "string";
|
|
604
|
+
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"];
|
|
605
|
+
};
|
|
606
|
+
readonly description: "Allowed values for `topology.kubernetes.io/region`.";
|
|
545
607
|
};
|
|
546
608
|
};
|
|
547
|
-
readonly required: readonly ["controllerRoleArn"];
|
|
548
609
|
readonly additionalProperties: false;
|
|
610
|
+
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.";
|
|
611
|
+
};
|
|
612
|
+
readonly scalingProfile: {
|
|
613
|
+
readonly type: "string";
|
|
614
|
+
readonly description: "Controls scale-up / scale-down responsiveness. `aggressive` prioritizes cost-optimization. `conservative` prioritizes stability of the fleet.";
|
|
615
|
+
readonly default: "conservative";
|
|
616
|
+
readonly example: "conservative";
|
|
617
|
+
readonly enum: readonly ["aggressive", "conservative"];
|
|
549
618
|
};
|
|
550
619
|
readonly id: {
|
|
551
620
|
readonly type: "string";
|
|
@@ -566,13 +635,12 @@ export declare const FleetSchema: {
|
|
|
566
635
|
readonly type: "object";
|
|
567
636
|
readonly properties: {
|
|
568
637
|
readonly cpu: {
|
|
569
|
-
readonly type: "
|
|
570
|
-
readonly format: "float";
|
|
638
|
+
readonly type: "integer";
|
|
571
639
|
readonly minimum: 0;
|
|
572
|
-
readonly
|
|
640
|
+
readonly maximum: 100000;
|
|
641
|
+
readonly description: "CPU limit in cores. Maximum 100,000.";
|
|
573
642
|
};
|
|
574
643
|
};
|
|
575
|
-
readonly required: readonly ["cpu"];
|
|
576
644
|
readonly additionalProperties: false;
|
|
577
645
|
readonly description: "Limits define a set of bounds for provisioning capacity.";
|
|
578
646
|
};
|
|
@@ -581,14 +649,15 @@ export declare const FleetSchema: {
|
|
|
581
649
|
readonly properties: {
|
|
582
650
|
readonly enabled: {
|
|
583
651
|
readonly type: "boolean";
|
|
584
|
-
readonly default: true;
|
|
585
652
|
};
|
|
586
653
|
readonly project: {
|
|
587
654
|
readonly type: "string";
|
|
588
|
-
readonly
|
|
655
|
+
readonly pattern: "^[a-z][a-z0-9-]{4,28}[a-z0-9]$";
|
|
656
|
+
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.";
|
|
657
|
+
readonly example: "my-cloudfleet-project";
|
|
589
658
|
};
|
|
590
659
|
};
|
|
591
|
-
readonly required: readonly ["
|
|
660
|
+
readonly required: readonly ["enabled"];
|
|
592
661
|
readonly additionalProperties: false;
|
|
593
662
|
};
|
|
594
663
|
readonly hetzner: {
|
|
@@ -596,14 +665,14 @@ export declare const FleetSchema: {
|
|
|
596
665
|
readonly properties: {
|
|
597
666
|
readonly enabled: {
|
|
598
667
|
readonly type: "boolean";
|
|
599
|
-
readonly default: true;
|
|
600
668
|
};
|
|
601
669
|
readonly apiKey: {
|
|
602
670
|
readonly type: "string";
|
|
603
|
-
readonly
|
|
671
|
+
readonly pattern: "^\\*{64}$";
|
|
672
|
+
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
673
|
};
|
|
605
674
|
};
|
|
606
|
-
readonly required: readonly ["
|
|
675
|
+
readonly required: readonly ["enabled"];
|
|
607
676
|
readonly additionalProperties: false;
|
|
608
677
|
};
|
|
609
678
|
readonly aws: {
|
|
@@ -611,16 +680,67 @@ export declare const FleetSchema: {
|
|
|
611
680
|
readonly properties: {
|
|
612
681
|
readonly enabled: {
|
|
613
682
|
readonly type: "boolean";
|
|
614
|
-
readonly default: true;
|
|
615
683
|
};
|
|
616
684
|
readonly controllerRoleArn: {
|
|
617
685
|
readonly type: "string";
|
|
618
|
-
readonly
|
|
686
|
+
readonly pattern: "^arn:aws(-[a-z]+)*:iam::\\d{12}:role\\/[\\w+=,.@/-]+$";
|
|
687
|
+
readonly description: "AWS IAM role ARN that Karpenter uses to manage resources. Omit when AWS is disabled.";
|
|
688
|
+
readonly example: "arn:aws:iam::123456789012:role/Cloudfleet";
|
|
619
689
|
};
|
|
620
690
|
};
|
|
621
|
-
readonly required: readonly ["
|
|
691
|
+
readonly required: readonly ["enabled"];
|
|
622
692
|
readonly additionalProperties: false;
|
|
623
693
|
};
|
|
694
|
+
readonly constraints: {
|
|
695
|
+
readonly type: "object";
|
|
696
|
+
readonly properties: {
|
|
697
|
+
readonly 'karpenter.sh/capacity-type': {
|
|
698
|
+
readonly type: "array";
|
|
699
|
+
readonly items: {
|
|
700
|
+
readonly type: "string";
|
|
701
|
+
readonly enum: readonly ["on-demand", "spot"];
|
|
702
|
+
};
|
|
703
|
+
readonly minItems: 1;
|
|
704
|
+
readonly description: "Allowed values for `karpenter.sh/capacity-type`.";
|
|
705
|
+
readonly default: readonly ["on-demand", "spot"];
|
|
706
|
+
};
|
|
707
|
+
readonly 'kubernetes.io/arch': {
|
|
708
|
+
readonly type: "array";
|
|
709
|
+
readonly items: {
|
|
710
|
+
readonly type: "string";
|
|
711
|
+
readonly enum: readonly ["amd64", "arm64"];
|
|
712
|
+
};
|
|
713
|
+
readonly minItems: 1;
|
|
714
|
+
readonly description: "Allowed values for `kubernetes.io/arch`.";
|
|
715
|
+
readonly default: readonly ["amd64"];
|
|
716
|
+
};
|
|
717
|
+
readonly 'cfke.io/instance-family': {
|
|
718
|
+
readonly type: "array";
|
|
719
|
+
readonly items: {
|
|
720
|
+
readonly type: "string";
|
|
721
|
+
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"];
|
|
722
|
+
};
|
|
723
|
+
readonly description: "Allowed values for `cfke.io/instance-family`.";
|
|
724
|
+
};
|
|
725
|
+
readonly 'topology.kubernetes.io/region': {
|
|
726
|
+
readonly type: "array";
|
|
727
|
+
readonly items: {
|
|
728
|
+
readonly type: "string";
|
|
729
|
+
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"];
|
|
730
|
+
};
|
|
731
|
+
readonly description: "Allowed values for `topology.kubernetes.io/region`.";
|
|
732
|
+
};
|
|
733
|
+
};
|
|
734
|
+
readonly additionalProperties: false;
|
|
735
|
+
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.";
|
|
736
|
+
};
|
|
737
|
+
readonly scalingProfile: {
|
|
738
|
+
readonly type: "string";
|
|
739
|
+
readonly description: "Controls scale-up / scale-down responsiveness. `aggressive` prioritizes cost-optimization. `conservative` prioritizes stability of the fleet.";
|
|
740
|
+
readonly default: "conservative";
|
|
741
|
+
readonly example: "conservative";
|
|
742
|
+
readonly enum: readonly ["aggressive", "conservative"];
|
|
743
|
+
};
|
|
624
744
|
readonly id: {
|
|
625
745
|
readonly type: "string";
|
|
626
746
|
readonly maxLength: 63;
|
|
@@ -630,7 +750,7 @@ export declare const FleetSchema: {
|
|
|
630
750
|
readonly example: "new-clouds-fleet";
|
|
631
751
|
};
|
|
632
752
|
};
|
|
633
|
-
readonly required: readonly ["id"];
|
|
753
|
+
readonly required: readonly ["scalingProfile", "id"];
|
|
634
754
|
readonly additionalProperties: false;
|
|
635
755
|
};
|
|
636
756
|
export declare const FleetUpdateInputSchema: {
|
|
@@ -640,13 +760,12 @@ export declare const FleetUpdateInputSchema: {
|
|
|
640
760
|
readonly type: "object";
|
|
641
761
|
readonly properties: {
|
|
642
762
|
readonly cpu: {
|
|
643
|
-
readonly type: "
|
|
644
|
-
readonly format: "float";
|
|
763
|
+
readonly type: "integer";
|
|
645
764
|
readonly minimum: 0;
|
|
646
|
-
readonly
|
|
765
|
+
readonly maximum: 100000;
|
|
766
|
+
readonly description: "CPU limit in cores. Maximum 100,000.";
|
|
647
767
|
};
|
|
648
768
|
};
|
|
649
|
-
readonly required: readonly ["cpu"];
|
|
650
769
|
readonly additionalProperties: false;
|
|
651
770
|
readonly description: "Limits define a set of bounds for provisioning capacity.";
|
|
652
771
|
};
|
|
@@ -655,14 +774,15 @@ export declare const FleetUpdateInputSchema: {
|
|
|
655
774
|
readonly properties: {
|
|
656
775
|
readonly enabled: {
|
|
657
776
|
readonly type: "boolean";
|
|
658
|
-
readonly default: true;
|
|
659
777
|
};
|
|
660
778
|
readonly project: {
|
|
661
779
|
readonly type: "string";
|
|
662
|
-
readonly
|
|
780
|
+
readonly pattern: "^[a-z][a-z0-9-]{4,28}[a-z0-9]$";
|
|
781
|
+
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.";
|
|
782
|
+
readonly example: "my-cloudfleet-project";
|
|
663
783
|
};
|
|
664
784
|
};
|
|
665
|
-
readonly required: readonly ["
|
|
785
|
+
readonly required: readonly ["enabled"];
|
|
666
786
|
readonly additionalProperties: false;
|
|
667
787
|
};
|
|
668
788
|
readonly hetzner: {
|
|
@@ -670,14 +790,16 @@ export declare const FleetUpdateInputSchema: {
|
|
|
670
790
|
readonly properties: {
|
|
671
791
|
readonly enabled: {
|
|
672
792
|
readonly type: "boolean";
|
|
673
|
-
readonly default: true;
|
|
674
793
|
};
|
|
675
794
|
readonly apiKey: {
|
|
676
795
|
readonly type: "string";
|
|
677
|
-
readonly
|
|
796
|
+
readonly maxLength: 64;
|
|
797
|
+
readonly minLength: 64;
|
|
798
|
+
readonly pattern: "^[A-Za-z0-9]+$";
|
|
799
|
+
readonly description: "Hetzner Cloud API token with read / write access (64 alphanumeric characters). Omit this field to keep the existing value.";
|
|
678
800
|
};
|
|
679
801
|
};
|
|
680
|
-
readonly required: readonly ["
|
|
802
|
+
readonly required: readonly ["enabled"];
|
|
681
803
|
readonly additionalProperties: false;
|
|
682
804
|
};
|
|
683
805
|
readonly aws: {
|
|
@@ -685,17 +807,86 @@ export declare const FleetUpdateInputSchema: {
|
|
|
685
807
|
readonly properties: {
|
|
686
808
|
readonly enabled: {
|
|
687
809
|
readonly type: "boolean";
|
|
688
|
-
readonly default: true;
|
|
689
810
|
};
|
|
690
811
|
readonly controllerRoleArn: {
|
|
691
812
|
readonly type: "string";
|
|
692
|
-
readonly
|
|
813
|
+
readonly pattern: "^arn:aws(-[a-z]+)*:iam::\\d{12}:role\\/[\\w+=,.@/-]+$";
|
|
814
|
+
readonly description: "AWS IAM role ARN that Karpenter uses to manage resources. Omit when AWS is disabled.";
|
|
815
|
+
readonly example: "arn:aws:iam::123456789012:role/Cloudfleet";
|
|
693
816
|
};
|
|
694
817
|
};
|
|
695
|
-
readonly required: readonly ["
|
|
818
|
+
readonly required: readonly ["enabled"];
|
|
696
819
|
readonly additionalProperties: false;
|
|
697
820
|
};
|
|
821
|
+
readonly constraints: {
|
|
822
|
+
readonly type: "object";
|
|
823
|
+
readonly properties: {
|
|
824
|
+
readonly 'karpenter.sh/capacity-type': {
|
|
825
|
+
readonly type: "array";
|
|
826
|
+
readonly items: {
|
|
827
|
+
readonly type: "string";
|
|
828
|
+
readonly enum: readonly ["on-demand", "spot"];
|
|
829
|
+
};
|
|
830
|
+
readonly minItems: 1;
|
|
831
|
+
readonly description: "Allowed values for `karpenter.sh/capacity-type`.";
|
|
832
|
+
};
|
|
833
|
+
readonly 'kubernetes.io/arch': {
|
|
834
|
+
readonly type: "array";
|
|
835
|
+
readonly items: {
|
|
836
|
+
readonly type: "string";
|
|
837
|
+
readonly enum: readonly ["amd64", "arm64"];
|
|
838
|
+
};
|
|
839
|
+
readonly minItems: 1;
|
|
840
|
+
readonly description: "Allowed values for `kubernetes.io/arch`.";
|
|
841
|
+
};
|
|
842
|
+
readonly 'cfke.io/instance-family': {
|
|
843
|
+
readonly type: "array";
|
|
844
|
+
readonly items: {
|
|
845
|
+
readonly type: "string";
|
|
846
|
+
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"];
|
|
847
|
+
};
|
|
848
|
+
readonly description: "Allowed values for `cfke.io/instance-family`.";
|
|
849
|
+
};
|
|
850
|
+
readonly 'topology.kubernetes.io/region': {
|
|
851
|
+
readonly type: "array";
|
|
852
|
+
readonly items: {
|
|
853
|
+
readonly type: "string";
|
|
854
|
+
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"];
|
|
855
|
+
};
|
|
856
|
+
readonly description: "Allowed values for `topology.kubernetes.io/region`.";
|
|
857
|
+
};
|
|
858
|
+
};
|
|
859
|
+
readonly additionalProperties: false;
|
|
860
|
+
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.";
|
|
861
|
+
};
|
|
862
|
+
readonly scalingProfile: {
|
|
863
|
+
readonly type: "string";
|
|
864
|
+
readonly description: "Controls scale-up / scale-down responsiveness. `aggressive` prioritizes cost-optimization. `conservative` prioritizes stability of the fleet.";
|
|
865
|
+
readonly example: "conservative";
|
|
866
|
+
readonly enum: readonly ["aggressive", "conservative"];
|
|
867
|
+
};
|
|
698
868
|
};
|
|
869
|
+
readonly required: readonly ["scalingProfile"];
|
|
870
|
+
readonly additionalProperties: false;
|
|
871
|
+
};
|
|
872
|
+
export declare const InviteCreateInputSchema: {
|
|
873
|
+
readonly type: "object";
|
|
874
|
+
readonly properties: {
|
|
875
|
+
readonly email: {
|
|
876
|
+
readonly type: "string";
|
|
877
|
+
readonly format: "email";
|
|
878
|
+
readonly description: "Email address of the user to invite.";
|
|
879
|
+
readonly example: "email@example.com";
|
|
880
|
+
};
|
|
881
|
+
readonly role: {
|
|
882
|
+
readonly type: "string";
|
|
883
|
+
readonly description: "Role the invited user will be assigned on redemption. Can be 'Administrator' or 'User'.";
|
|
884
|
+
readonly default: "User";
|
|
885
|
+
readonly example: "User";
|
|
886
|
+
readonly enum: readonly ["Administrator", "User"];
|
|
887
|
+
};
|
|
888
|
+
};
|
|
889
|
+
readonly required: readonly ["email"];
|
|
699
890
|
readonly additionalProperties: false;
|
|
700
891
|
};
|
|
701
892
|
export declare const InviteSchema: {
|
|
@@ -729,6 +920,13 @@ export declare const InviteSchema: {
|
|
|
729
920
|
readonly description: "Generated unique invite code.";
|
|
730
921
|
readonly example: "7kUZnH7nnKUFfvc4NK2KQF";
|
|
731
922
|
};
|
|
923
|
+
readonly role: {
|
|
924
|
+
readonly type: "string";
|
|
925
|
+
readonly description: "Role the invited user will be assigned on redemption. Can be 'Administrator' or 'User'.";
|
|
926
|
+
readonly default: "User";
|
|
927
|
+
readonly example: "User";
|
|
928
|
+
readonly enum: readonly ["Administrator", "User"];
|
|
929
|
+
};
|
|
732
930
|
};
|
|
733
931
|
readonly required: readonly ["date_created"];
|
|
734
932
|
readonly additionalProperties: false;
|
|
@@ -926,6 +1124,12 @@ export declare const MarketplaceListingSchema: {
|
|
|
926
1124
|
export declare const OrganizationCreateInputSchema: {
|
|
927
1125
|
readonly type: "object";
|
|
928
1126
|
readonly properties: {
|
|
1127
|
+
readonly type: {
|
|
1128
|
+
readonly type: "string";
|
|
1129
|
+
readonly description: "Type of the organization. `business` for legal entities, `personal` for individuals.";
|
|
1130
|
+
readonly example: "business";
|
|
1131
|
+
readonly enum: readonly ["business", "personal"];
|
|
1132
|
+
};
|
|
929
1133
|
readonly email: {
|
|
930
1134
|
readonly type: "string";
|
|
931
1135
|
readonly format: "email";
|
|
@@ -934,11 +1138,13 @@ export declare const OrganizationCreateInputSchema: {
|
|
|
934
1138
|
};
|
|
935
1139
|
readonly first_name: {
|
|
936
1140
|
readonly type: "string";
|
|
1141
|
+
readonly minLength: 1;
|
|
937
1142
|
readonly description: "First name of the billing contact person.";
|
|
938
1143
|
readonly example: "John";
|
|
939
1144
|
};
|
|
940
1145
|
readonly last_name: {
|
|
941
1146
|
readonly type: "string";
|
|
1147
|
+
readonly minLength: 1;
|
|
942
1148
|
readonly description: "Last name of the billing contact person.";
|
|
943
1149
|
readonly example: "Doe";
|
|
944
1150
|
};
|
|
@@ -956,7 +1162,19 @@ export declare const OrganizationCreateInputSchema: {
|
|
|
956
1162
|
readonly description: "Password for the root account. Must be at least 8 characters long and contain at least one uppercase letter, one lowercase letter, one number and one special character.";
|
|
957
1163
|
};
|
|
958
1164
|
};
|
|
959
|
-
readonly required: readonly ["email", "first_name", "last_name", "company_name", "password"];
|
|
1165
|
+
readonly required: readonly ["type", "email", "first_name", "last_name", "company_name", "password"];
|
|
1166
|
+
readonly additionalProperties: false;
|
|
1167
|
+
};
|
|
1168
|
+
export declare const OrganizationCreateOutputSchema: {
|
|
1169
|
+
readonly type: "object";
|
|
1170
|
+
readonly properties: {
|
|
1171
|
+
readonly id: {
|
|
1172
|
+
readonly type: "string";
|
|
1173
|
+
readonly description: "Unique identifier of the newly created organization. Generated by the API and safe to use for client-side tracking immediately.";
|
|
1174
|
+
readonly example: "organization-id";
|
|
1175
|
+
};
|
|
1176
|
+
};
|
|
1177
|
+
readonly required: readonly ["id"];
|
|
960
1178
|
readonly additionalProperties: false;
|
|
961
1179
|
};
|
|
962
1180
|
export declare const OrganizationSchema: {
|
|
@@ -975,6 +1193,12 @@ export declare const OrganizationSchema: {
|
|
|
975
1193
|
readonly description: "Name of the legal entity. This name will be used in invoices. Use your first and last name for individual accounts.";
|
|
976
1194
|
readonly example: "ACME Corp.";
|
|
977
1195
|
};
|
|
1196
|
+
readonly type: {
|
|
1197
|
+
readonly type: "string";
|
|
1198
|
+
readonly description: "Type of the organization. `business` for legal entities, `personal` for individuals.";
|
|
1199
|
+
readonly example: "business";
|
|
1200
|
+
readonly enum: readonly ["business", "personal"];
|
|
1201
|
+
};
|
|
978
1202
|
readonly date_created: {
|
|
979
1203
|
readonly type: "string";
|
|
980
1204
|
readonly format: "date-time";
|
|
@@ -1025,7 +1249,7 @@ export declare const OrganizationSchema: {
|
|
|
1025
1249
|
readonly type: "array";
|
|
1026
1250
|
readonly items: {
|
|
1027
1251
|
readonly type: "string";
|
|
1028
|
-
readonly example: "northamerica-central-
|
|
1252
|
+
readonly example: "northamerica-central-1a";
|
|
1029
1253
|
};
|
|
1030
1254
|
readonly minItems: 1;
|
|
1031
1255
|
readonly description: "List of Cloudfleet control plane regions available for the organization.";
|
|
@@ -1052,18 +1276,6 @@ export declare const OrganizationSchema: {
|
|
|
1052
1276
|
readonly minItems: 1;
|
|
1053
1277
|
readonly description: "List of CFKE control plane versions available for the organization.";
|
|
1054
1278
|
};
|
|
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
1279
|
readonly cfcr_storage_gb: {
|
|
1068
1280
|
readonly type: "integer";
|
|
1069
1281
|
readonly minimum: -1;
|
|
@@ -1071,7 +1283,7 @@ export declare const OrganizationSchema: {
|
|
|
1071
1283
|
readonly example: 500;
|
|
1072
1284
|
};
|
|
1073
1285
|
};
|
|
1074
|
-
readonly required: readonly ["basic_clusters_max", "basic_clusters_available", "pro_clusters_max", "pro_clusters_available", "fleets_max", "cluster_tiers", "regions", "versions", "
|
|
1286
|
+
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
1287
|
readonly additionalProperties: false;
|
|
1076
1288
|
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
1289
|
};
|
|
@@ -1080,8 +1292,14 @@ export declare const OrganizationSchema: {
|
|
|
1080
1292
|
readonly description: "Status of the organization. Can be `active` or `closed`, or `suspended`.";
|
|
1081
1293
|
readonly enum: readonly ["active", "closed", "suspended"];
|
|
1082
1294
|
};
|
|
1295
|
+
readonly verification: {
|
|
1296
|
+
readonly type: "string";
|
|
1297
|
+
readonly 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.";
|
|
1298
|
+
readonly example: "verified";
|
|
1299
|
+
readonly enum: readonly ["none", "submitted", "verified"];
|
|
1300
|
+
};
|
|
1083
1301
|
};
|
|
1084
|
-
readonly required: readonly ["id", "date_created", "quota", "status"];
|
|
1302
|
+
readonly required: readonly ["id", "type", "date_created", "quota", "status", "verification"];
|
|
1085
1303
|
readonly additionalProperties: false;
|
|
1086
1304
|
};
|
|
1087
1305
|
export declare const PaymentMethodSchema: {
|
|
@@ -1089,26 +1307,19 @@ export declare const PaymentMethodSchema: {
|
|
|
1089
1307
|
readonly properties: {
|
|
1090
1308
|
readonly id: {
|
|
1091
1309
|
readonly type: "string";
|
|
1092
|
-
readonly
|
|
1093
|
-
readonly
|
|
1094
|
-
readonly example: "e94d30ec-a2dd-4dcb-832c-ac2be144ba91";
|
|
1095
|
-
};
|
|
1096
|
-
readonly setup: {
|
|
1097
|
-
readonly type: "boolean";
|
|
1098
|
-
readonly description: "Whether organization payment method was set up and ready to use for payments.";
|
|
1099
|
-
readonly example: true;
|
|
1310
|
+
readonly 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.";
|
|
1311
|
+
readonly example: "pm_1MtwBwLkdIwHu7ix28a3tqPa";
|
|
1100
1312
|
};
|
|
1101
1313
|
readonly type: {
|
|
1102
1314
|
readonly type: "string";
|
|
1103
|
-
readonly
|
|
1104
|
-
readonly description: "Payment method type type. Only `card` payments supported at the moment.";
|
|
1315
|
+
readonly description: "Payment method type. `card`, `sepa_debit` for SEPA Direct Debit (business accounts only), or `bank_transfer` for paying invoices by bank transfer.";
|
|
1105
1316
|
readonly example: "card";
|
|
1106
|
-
readonly enum: readonly ["card"];
|
|
1317
|
+
readonly enum: readonly ["card", "sepa_debit", "bank_transfer"];
|
|
1107
1318
|
};
|
|
1108
1319
|
readonly last4: {
|
|
1109
1320
|
readonly type: "string";
|
|
1110
1321
|
readonly nullable: true;
|
|
1111
|
-
readonly description: "Last 4 digits of the payment card number.";
|
|
1322
|
+
readonly 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.";
|
|
1112
1323
|
readonly example: "4242";
|
|
1113
1324
|
};
|
|
1114
1325
|
readonly exp_month: {
|
|
@@ -1116,25 +1327,46 @@ export declare const PaymentMethodSchema: {
|
|
|
1116
1327
|
readonly minimum: 1;
|
|
1117
1328
|
readonly maximum: 12;
|
|
1118
1329
|
readonly nullable: true;
|
|
1119
|
-
readonly description: "Two-digit number representing the card's expiration month.";
|
|
1120
|
-
readonly example:
|
|
1330
|
+
readonly description: "Two-digit number representing the card's expiration month. Null for SEPA Direct Debit and bank transfer.";
|
|
1331
|
+
readonly example: 12;
|
|
1121
1332
|
};
|
|
1122
1333
|
readonly exp_year: {
|
|
1123
1334
|
readonly type: "integer";
|
|
1124
|
-
readonly minimum: 2024;
|
|
1125
1335
|
readonly nullable: true;
|
|
1126
|
-
readonly description: "Four-digit number representing the card's expiration year.";
|
|
1127
|
-
readonly example:
|
|
1336
|
+
readonly 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.";
|
|
1337
|
+
readonly example: 2028;
|
|
1128
1338
|
};
|
|
1129
1339
|
readonly brand: {
|
|
1130
1340
|
readonly type: "string";
|
|
1131
1341
|
readonly nullable: true;
|
|
1132
|
-
readonly description: "Payment card brand
|
|
1342
|
+
readonly 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.";
|
|
1133
1343
|
readonly example: "visa";
|
|
1134
|
-
|
|
1344
|
+
};
|
|
1345
|
+
readonly iban: {
|
|
1346
|
+
readonly type: "string";
|
|
1347
|
+
readonly nullable: true;
|
|
1348
|
+
readonly 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.";
|
|
1349
|
+
readonly example: "DE11243015658023127510";
|
|
1350
|
+
};
|
|
1351
|
+
readonly bic: {
|
|
1352
|
+
readonly type: "string";
|
|
1353
|
+
readonly nullable: true;
|
|
1354
|
+
readonly description: "BIC/SWIFT of the destination bank for bank transfers. Set only for `bank_transfer`; null otherwise.";
|
|
1355
|
+
readonly example: "SOGEDEFFXXX";
|
|
1356
|
+
};
|
|
1357
|
+
readonly account_holder_name: {
|
|
1358
|
+
readonly type: "string";
|
|
1359
|
+
readonly nullable: true;
|
|
1360
|
+
readonly description: "Account holder name of the destination bank account for bank transfers. Set only for `bank_transfer`; null otherwise.";
|
|
1361
|
+
readonly example: "Cloudfleet GmbH";
|
|
1362
|
+
};
|
|
1363
|
+
readonly is_default: {
|
|
1364
|
+
readonly type: "boolean";
|
|
1365
|
+
readonly 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).";
|
|
1366
|
+
readonly example: true;
|
|
1135
1367
|
};
|
|
1136
1368
|
};
|
|
1137
|
-
readonly required: readonly ["id", "
|
|
1369
|
+
readonly required: readonly ["id", "type", "last4", "exp_month", "exp_year", "brand", "iban", "bic", "account_holder_name", "is_default"];
|
|
1138
1370
|
readonly additionalProperties: false;
|
|
1139
1371
|
};
|
|
1140
1372
|
export declare const PlatformQuotaSchema: {
|
|
@@ -1181,7 +1413,7 @@ export declare const PlatformQuotaSchema: {
|
|
|
1181
1413
|
readonly type: "array";
|
|
1182
1414
|
readonly items: {
|
|
1183
1415
|
readonly type: "string";
|
|
1184
|
-
readonly example: "northamerica-central-
|
|
1416
|
+
readonly example: "northamerica-central-1a";
|
|
1185
1417
|
};
|
|
1186
1418
|
readonly minItems: 1;
|
|
1187
1419
|
readonly description: "List of Cloudfleet control plane regions available for the organization.";
|
|
@@ -1208,18 +1440,6 @@ export declare const PlatformQuotaSchema: {
|
|
|
1208
1440
|
readonly minItems: 1;
|
|
1209
1441
|
readonly description: "List of CFKE control plane versions available for the organization.";
|
|
1210
1442
|
};
|
|
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
1443
|
readonly cfcr_storage_gb: {
|
|
1224
1444
|
readonly type: "integer";
|
|
1225
1445
|
readonly minimum: -1;
|
|
@@ -1227,7 +1447,7 @@ export declare const PlatformQuotaSchema: {
|
|
|
1227
1447
|
readonly example: 500;
|
|
1228
1448
|
};
|
|
1229
1449
|
};
|
|
1230
|
-
readonly required: readonly ["basic_clusters_max", "basic_clusters_available", "pro_clusters_max", "pro_clusters_available", "fleets_max", "cluster_tiers", "regions", "versions", "
|
|
1450
|
+
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
1451
|
readonly additionalProperties: false;
|
|
1232
1452
|
};
|
|
1233
1453
|
export declare const RegistryRepositorySchema: {
|
|
@@ -1461,6 +1681,407 @@ export declare const RegistryTagSchema: {
|
|
|
1461
1681
|
readonly required: readonly ["name", "digest", "size", "region", "repository", "uri"];
|
|
1462
1682
|
readonly additionalProperties: false;
|
|
1463
1683
|
};
|
|
1684
|
+
export declare const TicketAttachmentSchema: {
|
|
1685
|
+
readonly type: "object";
|
|
1686
|
+
readonly properties: {
|
|
1687
|
+
readonly id: {
|
|
1688
|
+
readonly type: "string";
|
|
1689
|
+
readonly description: "Unique identifier of the attachment (Mongo ObjectId).";
|
|
1690
|
+
readonly example: "60c72b2f9f1b2c001f8e4d3c";
|
|
1691
|
+
};
|
|
1692
|
+
readonly filename: {
|
|
1693
|
+
readonly type: "string";
|
|
1694
|
+
readonly description: "Original filename as uploaded.";
|
|
1695
|
+
readonly example: "debug.log";
|
|
1696
|
+
};
|
|
1697
|
+
readonly content_type: {
|
|
1698
|
+
readonly type: "string";
|
|
1699
|
+
readonly description: "MIME content type of the attachment.";
|
|
1700
|
+
readonly example: "text/plain";
|
|
1701
|
+
};
|
|
1702
|
+
readonly size: {
|
|
1703
|
+
readonly type: "integer";
|
|
1704
|
+
readonly description: "Size of the attachment in bytes.";
|
|
1705
|
+
readonly example: 12345;
|
|
1706
|
+
};
|
|
1707
|
+
};
|
|
1708
|
+
readonly required: readonly ["id", "filename", "content_type", "size"];
|
|
1709
|
+
readonly additionalProperties: false;
|
|
1710
|
+
};
|
|
1711
|
+
export declare const TicketCreateInputSchema: {
|
|
1712
|
+
readonly type: "object";
|
|
1713
|
+
readonly properties: {
|
|
1714
|
+
readonly category: {
|
|
1715
|
+
readonly type: "string";
|
|
1716
|
+
readonly description: "Ticket category. Drives auto-assignment and may carry a subcategory in `properties`.";
|
|
1717
|
+
readonly example: "technical";
|
|
1718
|
+
readonly enum: readonly ["billing", "technical", "general"];
|
|
1719
|
+
};
|
|
1720
|
+
readonly body: {
|
|
1721
|
+
readonly type: "string";
|
|
1722
|
+
readonly maxLength: 50000;
|
|
1723
|
+
readonly minLength: 1;
|
|
1724
|
+
readonly pattern: "\\S";
|
|
1725
|
+
readonly description: "Initial message body in markdown. There is no separate subject — the first message body is the description.";
|
|
1726
|
+
readonly example: "My cluster cannot reach the registry. Logs attached.";
|
|
1727
|
+
};
|
|
1728
|
+
readonly properties: {
|
|
1729
|
+
readonly type: "object";
|
|
1730
|
+
readonly additionalProperties: true;
|
|
1731
|
+
readonly description: "Free-form key/value bag set by the UI (e.g. `subcategory`, `cluster_id`, `cluster_name`, `region`).";
|
|
1732
|
+
readonly example: {
|
|
1733
|
+
readonly subcategory: "cluster-question";
|
|
1734
|
+
readonly cluster_id: "60c72b2f9f1b2c001f8e4d3a";
|
|
1735
|
+
};
|
|
1736
|
+
};
|
|
1737
|
+
};
|
|
1738
|
+
readonly required: readonly ["category", "body"];
|
|
1739
|
+
readonly additionalProperties: false;
|
|
1740
|
+
};
|
|
1741
|
+
export declare const TicketListResponseSchema: {
|
|
1742
|
+
readonly type: "object";
|
|
1743
|
+
readonly properties: {
|
|
1744
|
+
readonly items: {
|
|
1745
|
+
readonly type: "array";
|
|
1746
|
+
readonly items: {
|
|
1747
|
+
readonly type: "object";
|
|
1748
|
+
readonly properties: {
|
|
1749
|
+
readonly id: {
|
|
1750
|
+
readonly type: "string";
|
|
1751
|
+
readonly description: "Unique identifier of the ticket (Mongo ObjectId).";
|
|
1752
|
+
readonly example: "60c72b2f9f1b2c001f8e4d3a";
|
|
1753
|
+
};
|
|
1754
|
+
readonly status: {
|
|
1755
|
+
readonly type: "string";
|
|
1756
|
+
readonly description: "Current state of the ticket.";
|
|
1757
|
+
readonly example: "waiting_on_us";
|
|
1758
|
+
readonly enum: readonly ["waiting_on_us", "waiting_on_user", "closed"];
|
|
1759
|
+
};
|
|
1760
|
+
readonly category: {
|
|
1761
|
+
readonly type: "string";
|
|
1762
|
+
readonly description: "Ticket category.";
|
|
1763
|
+
readonly example: "technical";
|
|
1764
|
+
readonly enum: readonly ["billing", "technical", "general"];
|
|
1765
|
+
};
|
|
1766
|
+
readonly summary: {
|
|
1767
|
+
readonly type: "string";
|
|
1768
|
+
readonly description: "First 128 characters of the initial message body, with markdown formatting and newlines stripped. Used for ticket list previews.";
|
|
1769
|
+
readonly example: "My cluster cannot reach the registry. Logs attached.";
|
|
1770
|
+
};
|
|
1771
|
+
readonly closed_at: {
|
|
1772
|
+
readonly type: "string";
|
|
1773
|
+
readonly format: "date-time";
|
|
1774
|
+
readonly nullable: true;
|
|
1775
|
+
readonly description: "Closure timestamp. Null while the ticket is open.";
|
|
1776
|
+
readonly example: "2026-05-18T16:08:14.338Z";
|
|
1777
|
+
};
|
|
1778
|
+
readonly date_created: {
|
|
1779
|
+
readonly type: "string";
|
|
1780
|
+
readonly format: "date-time";
|
|
1781
|
+
readonly description: "Creation date of the ticket. ISO 8601 UTC.";
|
|
1782
|
+
readonly example: "2026-05-11T16:08:14.338Z";
|
|
1783
|
+
};
|
|
1784
|
+
readonly date_updated: {
|
|
1785
|
+
readonly type: "string";
|
|
1786
|
+
readonly format: "date-time";
|
|
1787
|
+
readonly description: "Last update date of the ticket. ISO 8601 UTC.";
|
|
1788
|
+
readonly example: "2026-05-11T16:08:14.338Z";
|
|
1789
|
+
};
|
|
1790
|
+
readonly messages: {
|
|
1791
|
+
readonly type: "array";
|
|
1792
|
+
readonly items: {
|
|
1793
|
+
readonly type: "object";
|
|
1794
|
+
readonly properties: {
|
|
1795
|
+
readonly id: {
|
|
1796
|
+
readonly type: "string";
|
|
1797
|
+
readonly description: "Unique identifier of the message (Mongo ObjectId).";
|
|
1798
|
+
readonly example: "60c72b2f9f1b2c001f8e4d3b";
|
|
1799
|
+
};
|
|
1800
|
+
readonly type: {
|
|
1801
|
+
readonly type: "string";
|
|
1802
|
+
readonly description: "Message type. Internal notes are filtered out of customer-facing responses.";
|
|
1803
|
+
readonly example: "customer_reply";
|
|
1804
|
+
readonly enum: readonly ["customer_reply", "agent_reply"];
|
|
1805
|
+
};
|
|
1806
|
+
readonly body: {
|
|
1807
|
+
readonly type: "string";
|
|
1808
|
+
readonly description: "Message body in markdown.";
|
|
1809
|
+
readonly example: "Thanks — that resolved it on my side.";
|
|
1810
|
+
};
|
|
1811
|
+
readonly author_first_name: {
|
|
1812
|
+
readonly type: "string";
|
|
1813
|
+
readonly nullable: true;
|
|
1814
|
+
readonly description: "First name of the author. Null when not provided.";
|
|
1815
|
+
readonly example: "Jane";
|
|
1816
|
+
};
|
|
1817
|
+
readonly author_last_name: {
|
|
1818
|
+
readonly type: "string";
|
|
1819
|
+
readonly nullable: true;
|
|
1820
|
+
readonly description: "Last name of the author. Null when not provided.";
|
|
1821
|
+
readonly example: "Doe";
|
|
1822
|
+
};
|
|
1823
|
+
readonly attachments: {
|
|
1824
|
+
readonly type: "array";
|
|
1825
|
+
readonly items: {
|
|
1826
|
+
readonly type: "object";
|
|
1827
|
+
readonly properties: {
|
|
1828
|
+
readonly id: {
|
|
1829
|
+
readonly type: "string";
|
|
1830
|
+
readonly description: "Unique identifier of the attachment (Mongo ObjectId).";
|
|
1831
|
+
readonly example: "60c72b2f9f1b2c001f8e4d3c";
|
|
1832
|
+
};
|
|
1833
|
+
readonly filename: {
|
|
1834
|
+
readonly type: "string";
|
|
1835
|
+
readonly description: "Original filename as uploaded.";
|
|
1836
|
+
readonly example: "debug.log";
|
|
1837
|
+
};
|
|
1838
|
+
readonly content_type: {
|
|
1839
|
+
readonly type: "string";
|
|
1840
|
+
readonly description: "MIME content type of the attachment.";
|
|
1841
|
+
readonly example: "text/plain";
|
|
1842
|
+
};
|
|
1843
|
+
readonly size: {
|
|
1844
|
+
readonly type: "integer";
|
|
1845
|
+
readonly description: "Size of the attachment in bytes.";
|
|
1846
|
+
readonly example: 12345;
|
|
1847
|
+
};
|
|
1848
|
+
};
|
|
1849
|
+
readonly required: readonly ["id", "filename", "content_type", "size"];
|
|
1850
|
+
readonly additionalProperties: false;
|
|
1851
|
+
};
|
|
1852
|
+
readonly description: "Attachments associated with this message.";
|
|
1853
|
+
readonly example: readonly [];
|
|
1854
|
+
};
|
|
1855
|
+
readonly date_created: {
|
|
1856
|
+
readonly type: "string";
|
|
1857
|
+
readonly format: "date-time";
|
|
1858
|
+
readonly description: "Creation date of the message. ISO 8601 UTC.";
|
|
1859
|
+
readonly example: "2026-05-11T16:08:14.338Z";
|
|
1860
|
+
};
|
|
1861
|
+
};
|
|
1862
|
+
readonly required: readonly ["id", "type", "body", "date_created"];
|
|
1863
|
+
readonly additionalProperties: false;
|
|
1864
|
+
};
|
|
1865
|
+
readonly description: "Messages on the ticket in chronological order. Internal notes are excluded. Returned by the detail endpoint only.";
|
|
1866
|
+
};
|
|
1867
|
+
};
|
|
1868
|
+
readonly required: readonly ["id", "status", "category", "summary", "date_created", "date_updated"];
|
|
1869
|
+
readonly additionalProperties: false;
|
|
1870
|
+
};
|
|
1871
|
+
readonly description: "Tickets for the organization, ordered newest first. Messages are omitted from list responses.";
|
|
1872
|
+
};
|
|
1873
|
+
};
|
|
1874
|
+
readonly required: readonly ["items"];
|
|
1875
|
+
readonly additionalProperties: false;
|
|
1876
|
+
};
|
|
1877
|
+
export declare const TicketMessageInputSchema: {
|
|
1878
|
+
readonly type: "object";
|
|
1879
|
+
readonly properties: {
|
|
1880
|
+
readonly body: {
|
|
1881
|
+
readonly type: "string";
|
|
1882
|
+
readonly maxLength: 50000;
|
|
1883
|
+
readonly minLength: 1;
|
|
1884
|
+
readonly pattern: "\\S";
|
|
1885
|
+
readonly description: "Reply body in markdown.";
|
|
1886
|
+
readonly example: "Thanks — that resolved it on my side.";
|
|
1887
|
+
};
|
|
1888
|
+
};
|
|
1889
|
+
readonly required: readonly ["body"];
|
|
1890
|
+
readonly additionalProperties: false;
|
|
1891
|
+
};
|
|
1892
|
+
export declare const TicketMessageSchema: {
|
|
1893
|
+
readonly type: "object";
|
|
1894
|
+
readonly properties: {
|
|
1895
|
+
readonly id: {
|
|
1896
|
+
readonly type: "string";
|
|
1897
|
+
readonly description: "Unique identifier of the message (Mongo ObjectId).";
|
|
1898
|
+
readonly example: "60c72b2f9f1b2c001f8e4d3b";
|
|
1899
|
+
};
|
|
1900
|
+
readonly type: {
|
|
1901
|
+
readonly type: "string";
|
|
1902
|
+
readonly description: "Message type. Internal notes are filtered out of customer-facing responses.";
|
|
1903
|
+
readonly example: "customer_reply";
|
|
1904
|
+
readonly enum: readonly ["customer_reply", "agent_reply"];
|
|
1905
|
+
};
|
|
1906
|
+
readonly body: {
|
|
1907
|
+
readonly type: "string";
|
|
1908
|
+
readonly description: "Message body in markdown.";
|
|
1909
|
+
readonly example: "Thanks — that resolved it on my side.";
|
|
1910
|
+
};
|
|
1911
|
+
readonly author_first_name: {
|
|
1912
|
+
readonly type: "string";
|
|
1913
|
+
readonly description: "First name of the author. Null when not provided.";
|
|
1914
|
+
readonly example: "Jane";
|
|
1915
|
+
};
|
|
1916
|
+
readonly author_last_name: {
|
|
1917
|
+
readonly type: "string";
|
|
1918
|
+
readonly description: "Last name of the author. Null when not provided.";
|
|
1919
|
+
readonly example: "Doe";
|
|
1920
|
+
};
|
|
1921
|
+
readonly attachments: {
|
|
1922
|
+
readonly type: "array";
|
|
1923
|
+
readonly items: {
|
|
1924
|
+
readonly type: "object";
|
|
1925
|
+
readonly properties: {
|
|
1926
|
+
readonly id: {
|
|
1927
|
+
readonly type: "string";
|
|
1928
|
+
readonly description: "Unique identifier of the attachment (Mongo ObjectId).";
|
|
1929
|
+
readonly example: "60c72b2f9f1b2c001f8e4d3c";
|
|
1930
|
+
};
|
|
1931
|
+
readonly filename: {
|
|
1932
|
+
readonly type: "string";
|
|
1933
|
+
readonly description: "Original filename as uploaded.";
|
|
1934
|
+
readonly example: "debug.log";
|
|
1935
|
+
};
|
|
1936
|
+
readonly content_type: {
|
|
1937
|
+
readonly type: "string";
|
|
1938
|
+
readonly description: "MIME content type of the attachment.";
|
|
1939
|
+
readonly example: "text/plain";
|
|
1940
|
+
};
|
|
1941
|
+
readonly size: {
|
|
1942
|
+
readonly type: "integer";
|
|
1943
|
+
readonly description: "Size of the attachment in bytes.";
|
|
1944
|
+
readonly example: 12345;
|
|
1945
|
+
};
|
|
1946
|
+
};
|
|
1947
|
+
readonly required: readonly ["id", "filename", "content_type", "size"];
|
|
1948
|
+
readonly additionalProperties: false;
|
|
1949
|
+
};
|
|
1950
|
+
readonly description: "Attachments associated with this message.";
|
|
1951
|
+
readonly example: readonly [];
|
|
1952
|
+
};
|
|
1953
|
+
readonly date_created: {
|
|
1954
|
+
readonly type: "string";
|
|
1955
|
+
readonly format: "date-time";
|
|
1956
|
+
readonly description: "Creation date of the message. ISO 8601 UTC.";
|
|
1957
|
+
readonly example: "2026-05-11T16:08:14.338Z";
|
|
1958
|
+
};
|
|
1959
|
+
};
|
|
1960
|
+
readonly required: readonly ["id", "type", "body", "date_created"];
|
|
1961
|
+
readonly additionalProperties: false;
|
|
1962
|
+
};
|
|
1963
|
+
export declare const TicketSchema: {
|
|
1964
|
+
readonly type: "object";
|
|
1965
|
+
readonly properties: {
|
|
1966
|
+
readonly id: {
|
|
1967
|
+
readonly type: "string";
|
|
1968
|
+
readonly description: "Unique identifier of the ticket (Mongo ObjectId).";
|
|
1969
|
+
readonly example: "60c72b2f9f1b2c001f8e4d3a";
|
|
1970
|
+
};
|
|
1971
|
+
readonly status: {
|
|
1972
|
+
readonly type: "string";
|
|
1973
|
+
readonly description: "Current state of the ticket.";
|
|
1974
|
+
readonly example: "waiting_on_us";
|
|
1975
|
+
readonly enum: readonly ["waiting_on_us", "waiting_on_user", "closed"];
|
|
1976
|
+
};
|
|
1977
|
+
readonly category: {
|
|
1978
|
+
readonly type: "string";
|
|
1979
|
+
readonly description: "Ticket category.";
|
|
1980
|
+
readonly example: "technical";
|
|
1981
|
+
readonly enum: readonly ["billing", "technical", "general"];
|
|
1982
|
+
};
|
|
1983
|
+
readonly summary: {
|
|
1984
|
+
readonly type: "string";
|
|
1985
|
+
readonly description: "First 128 characters of the initial message body, with markdown formatting and newlines stripped. Used for ticket list previews.";
|
|
1986
|
+
readonly example: "My cluster cannot reach the registry. Logs attached.";
|
|
1987
|
+
};
|
|
1988
|
+
readonly closed_at: {
|
|
1989
|
+
readonly type: "string";
|
|
1990
|
+
readonly format: "date-time";
|
|
1991
|
+
readonly description: "Closure timestamp. Null while the ticket is open.";
|
|
1992
|
+
readonly example: "2026-05-18T16:08:14.338Z";
|
|
1993
|
+
};
|
|
1994
|
+
readonly date_created: {
|
|
1995
|
+
readonly type: "string";
|
|
1996
|
+
readonly format: "date-time";
|
|
1997
|
+
readonly description: "Creation date of the ticket. ISO 8601 UTC.";
|
|
1998
|
+
readonly example: "2026-05-11T16:08:14.338Z";
|
|
1999
|
+
};
|
|
2000
|
+
readonly date_updated: {
|
|
2001
|
+
readonly type: "string";
|
|
2002
|
+
readonly format: "date-time";
|
|
2003
|
+
readonly description: "Last update date of the ticket. ISO 8601 UTC.";
|
|
2004
|
+
readonly example: "2026-05-11T16:08:14.338Z";
|
|
2005
|
+
};
|
|
2006
|
+
readonly messages: {
|
|
2007
|
+
readonly type: "array";
|
|
2008
|
+
readonly items: {
|
|
2009
|
+
readonly type: "object";
|
|
2010
|
+
readonly properties: {
|
|
2011
|
+
readonly id: {
|
|
2012
|
+
readonly type: "string";
|
|
2013
|
+
readonly description: "Unique identifier of the message (Mongo ObjectId).";
|
|
2014
|
+
readonly example: "60c72b2f9f1b2c001f8e4d3b";
|
|
2015
|
+
};
|
|
2016
|
+
readonly type: {
|
|
2017
|
+
readonly type: "string";
|
|
2018
|
+
readonly description: "Message type. Internal notes are filtered out of customer-facing responses.";
|
|
2019
|
+
readonly example: "customer_reply";
|
|
2020
|
+
readonly enum: readonly ["customer_reply", "agent_reply"];
|
|
2021
|
+
};
|
|
2022
|
+
readonly body: {
|
|
2023
|
+
readonly type: "string";
|
|
2024
|
+
readonly description: "Message body in markdown.";
|
|
2025
|
+
readonly example: "Thanks — that resolved it on my side.";
|
|
2026
|
+
};
|
|
2027
|
+
readonly author_first_name: {
|
|
2028
|
+
readonly type: "string";
|
|
2029
|
+
readonly description: "First name of the author. Null when not provided.";
|
|
2030
|
+
readonly example: "Jane";
|
|
2031
|
+
};
|
|
2032
|
+
readonly author_last_name: {
|
|
2033
|
+
readonly type: "string";
|
|
2034
|
+
readonly description: "Last name of the author. Null when not provided.";
|
|
2035
|
+
readonly example: "Doe";
|
|
2036
|
+
};
|
|
2037
|
+
readonly attachments: {
|
|
2038
|
+
readonly type: "array";
|
|
2039
|
+
readonly items: {
|
|
2040
|
+
readonly type: "object";
|
|
2041
|
+
readonly properties: {
|
|
2042
|
+
readonly id: {
|
|
2043
|
+
readonly type: "string";
|
|
2044
|
+
readonly description: "Unique identifier of the attachment (Mongo ObjectId).";
|
|
2045
|
+
readonly example: "60c72b2f9f1b2c001f8e4d3c";
|
|
2046
|
+
};
|
|
2047
|
+
readonly filename: {
|
|
2048
|
+
readonly type: "string";
|
|
2049
|
+
readonly description: "Original filename as uploaded.";
|
|
2050
|
+
readonly example: "debug.log";
|
|
2051
|
+
};
|
|
2052
|
+
readonly content_type: {
|
|
2053
|
+
readonly type: "string";
|
|
2054
|
+
readonly description: "MIME content type of the attachment.";
|
|
2055
|
+
readonly example: "text/plain";
|
|
2056
|
+
};
|
|
2057
|
+
readonly size: {
|
|
2058
|
+
readonly type: "integer";
|
|
2059
|
+
readonly description: "Size of the attachment in bytes.";
|
|
2060
|
+
readonly example: 12345;
|
|
2061
|
+
};
|
|
2062
|
+
};
|
|
2063
|
+
readonly required: readonly ["id", "filename", "content_type", "size"];
|
|
2064
|
+
readonly additionalProperties: false;
|
|
2065
|
+
};
|
|
2066
|
+
readonly description: "Attachments associated with this message.";
|
|
2067
|
+
readonly example: readonly [];
|
|
2068
|
+
};
|
|
2069
|
+
readonly date_created: {
|
|
2070
|
+
readonly type: "string";
|
|
2071
|
+
readonly format: "date-time";
|
|
2072
|
+
readonly description: "Creation date of the message. ISO 8601 UTC.";
|
|
2073
|
+
readonly example: "2026-05-11T16:08:14.338Z";
|
|
2074
|
+
};
|
|
2075
|
+
};
|
|
2076
|
+
readonly required: readonly ["id", "type", "body", "date_created"];
|
|
2077
|
+
readonly additionalProperties: false;
|
|
2078
|
+
};
|
|
2079
|
+
readonly description: "Messages on the ticket in chronological order. Internal notes are excluded. Returned by the detail endpoint only.";
|
|
2080
|
+
};
|
|
2081
|
+
};
|
|
2082
|
+
readonly required: readonly ["id", "status", "category", "summary", "date_created", "date_updated"];
|
|
2083
|
+
readonly additionalProperties: false;
|
|
2084
|
+
};
|
|
1464
2085
|
export declare const TokenCreateInputSchema: {
|
|
1465
2086
|
readonly type: "object";
|
|
1466
2087
|
readonly properties: {
|
|
@@ -1707,18 +2328,6 @@ export declare const UserCreateInputSchema: {
|
|
|
1707
2328
|
readonly minLength: 8;
|
|
1708
2329
|
readonly description: "User password. Must be at least 8 characters long.";
|
|
1709
2330
|
};
|
|
1710
|
-
readonly status: {
|
|
1711
|
-
readonly type: "string";
|
|
1712
|
-
readonly description: "Status of the user. Can be `active` or `inactive`. Inactive users cannot log in or manage organization resources.";
|
|
1713
|
-
readonly example: "active";
|
|
1714
|
-
readonly enum: readonly ["active", "inactive"];
|
|
1715
|
-
};
|
|
1716
|
-
readonly role: {
|
|
1717
|
-
readonly type: "string";
|
|
1718
|
-
readonly description: "User role. Can be 'Administrator', 'User'.";
|
|
1719
|
-
readonly example: "User";
|
|
1720
|
-
readonly enum: readonly ["Administrator", "User"];
|
|
1721
|
-
};
|
|
1722
2331
|
};
|
|
1723
2332
|
readonly required: readonly ["email", "first_name", "last_name", "code", "password"];
|
|
1724
2333
|
readonly additionalProperties: false;
|