@cloudfleet/sdk 0.0.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +9 -0
- package/dist/index.d.ts +4 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +4 -0
- package/dist/index.js.map +1 -0
- package/dist/schemas.gen.d.ts +1526 -0
- package/dist/schemas.gen.d.ts.map +1 -0
- package/dist/schemas.gen.js +1553 -0
- package/dist/schemas.gen.js.map +1 -0
- package/dist/sdk.gen.d.ts +355 -0
- package/dist/sdk.gen.d.ts.map +1 -0
- package/dist/sdk.gen.js +573 -0
- package/dist/sdk.gen.js.map +1 -0
- package/dist/types.gen.d.ts +2093 -0
- package/dist/types.gen.d.ts.map +1 -0
- package/dist/types.gen.js +3 -0
- package/dist/types.gen.js.map +1 -0
- package/dist/zod.gen.d.ts +2842 -0
- package/dist/zod.gen.d.ts.map +1 -0
- package/dist/zod.gen.js +968 -0
- package/dist/zod.gen.js.map +1 -0
- package/package.json +38 -0
|
@@ -0,0 +1,1526 @@
|
|
|
1
|
+
export declare const ClusterCreateInputSchema: {
|
|
2
|
+
readonly type: "object";
|
|
3
|
+
readonly properties: {
|
|
4
|
+
readonly name: {
|
|
5
|
+
readonly type: "string";
|
|
6
|
+
readonly maxLength: 63;
|
|
7
|
+
readonly minLength: 1;
|
|
8
|
+
readonly pattern: "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$";
|
|
9
|
+
readonly description: "Name of the cluster.";
|
|
10
|
+
readonly example: "production-cluster";
|
|
11
|
+
};
|
|
12
|
+
readonly region: {
|
|
13
|
+
readonly type: "string";
|
|
14
|
+
readonly description: "Cloudfleet control plane region. One of \"staging\", \"northamerica-central-1\". This field can not be updated after creation.";
|
|
15
|
+
readonly default: "staging";
|
|
16
|
+
readonly example: "northamerica-central-1";
|
|
17
|
+
readonly enum: readonly ["staging", "northamerica-central-1"];
|
|
18
|
+
};
|
|
19
|
+
readonly tier: {
|
|
20
|
+
readonly type: "string";
|
|
21
|
+
readonly description: "Tier of the cluster.";
|
|
22
|
+
readonly example: "pro";
|
|
23
|
+
readonly enum: readonly ["basic", "pro"];
|
|
24
|
+
};
|
|
25
|
+
readonly version_channel: {
|
|
26
|
+
readonly type: "string";
|
|
27
|
+
readonly pattern: "^(x|X|0|[1-9]\\d*)\\.(x|X|0|[1-9]\\d*)\\.(x|X|0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?$";
|
|
28
|
+
readonly description: "Version of the kubernetes cluster.";
|
|
29
|
+
readonly default: "1.x.x-cfke.x";
|
|
30
|
+
readonly example: "1.29.x-cfke.x";
|
|
31
|
+
};
|
|
32
|
+
};
|
|
33
|
+
readonly required: readonly ["name", "tier"];
|
|
34
|
+
readonly additionalProperties: false;
|
|
35
|
+
};
|
|
36
|
+
export declare const ClusterJoinInformationSchema: {
|
|
37
|
+
readonly type: "object";
|
|
38
|
+
readonly properties: {
|
|
39
|
+
readonly certificate_authority: {
|
|
40
|
+
readonly type: "string";
|
|
41
|
+
readonly description: "Certificate authority data for the kubernetes cluster. This is the root certificate authority for the cluster.";
|
|
42
|
+
readonly example: "-----BEGIN CERTIFICATE-----\nMIIC0DCCAbigAwIBAgI...";
|
|
43
|
+
};
|
|
44
|
+
readonly endpoint: {
|
|
45
|
+
readonly type: "string";
|
|
46
|
+
readonly format: "uri";
|
|
47
|
+
readonly description: "Internal URL of the Kubernetes cluster control plane. This is the endpoint that kubelet uses to connect to the cluster.";
|
|
48
|
+
readonly example: "https://10.31.64.7:6443";
|
|
49
|
+
};
|
|
50
|
+
readonly auth_key: {
|
|
51
|
+
readonly type: "string";
|
|
52
|
+
readonly description: "Authentication key for the cluster.";
|
|
53
|
+
readonly example: "tskey-auth-kBV8wr1dk911CNTRL-...";
|
|
54
|
+
};
|
|
55
|
+
readonly bootstrap_token: {
|
|
56
|
+
readonly type: "string";
|
|
57
|
+
readonly description: "Bootstrap token for the cluster.";
|
|
58
|
+
readonly example: "a797d6df6babc2cfdb202ba7.....";
|
|
59
|
+
};
|
|
60
|
+
readonly versions: {
|
|
61
|
+
readonly type: "object";
|
|
62
|
+
readonly properties: {
|
|
63
|
+
readonly kubernetes: {
|
|
64
|
+
readonly type: "string";
|
|
65
|
+
readonly description: "Kubernetes version of the cluster.";
|
|
66
|
+
readonly example: "1.29.3";
|
|
67
|
+
};
|
|
68
|
+
readonly tailscale: {
|
|
69
|
+
readonly type: "string";
|
|
70
|
+
readonly description: "Tailscale version of the cluster.";
|
|
71
|
+
readonly example: "1.74.1";
|
|
72
|
+
};
|
|
73
|
+
readonly containerd: {
|
|
74
|
+
readonly type: "string";
|
|
75
|
+
readonly description: "Containerd version of the cluster.";
|
|
76
|
+
readonly example: "1.7.19";
|
|
77
|
+
};
|
|
78
|
+
};
|
|
79
|
+
readonly required: readonly ["kubernetes", "tailscale", "containerd"];
|
|
80
|
+
readonly additionalProperties: false;
|
|
81
|
+
readonly description: "Versions of the different components of the cluster.";
|
|
82
|
+
};
|
|
83
|
+
};
|
|
84
|
+
readonly required: readonly ["certificate_authority", "endpoint", "auth_key", "bootstrap_token", "versions"];
|
|
85
|
+
readonly additionalProperties: false;
|
|
86
|
+
};
|
|
87
|
+
export declare const ClusterSchema: {
|
|
88
|
+
readonly type: "object";
|
|
89
|
+
readonly properties: {
|
|
90
|
+
readonly name: {
|
|
91
|
+
readonly type: "string";
|
|
92
|
+
readonly maxLength: 63;
|
|
93
|
+
readonly minLength: 1;
|
|
94
|
+
readonly pattern: "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$";
|
|
95
|
+
readonly description: "Name of the cluster.";
|
|
96
|
+
readonly example: "production-cluster";
|
|
97
|
+
};
|
|
98
|
+
readonly region: {
|
|
99
|
+
readonly type: "string";
|
|
100
|
+
readonly description: "Cloudfleet control plane region. One of \"staging\", \"northamerica-central-1\". This field can not be updated after creation.";
|
|
101
|
+
readonly default: "staging";
|
|
102
|
+
readonly example: "northamerica-central-1";
|
|
103
|
+
readonly enum: readonly ["staging", "northamerica-central-1"];
|
|
104
|
+
};
|
|
105
|
+
readonly tier: {
|
|
106
|
+
readonly type: "string";
|
|
107
|
+
readonly description: "Tier of the cluster.";
|
|
108
|
+
readonly example: "pro";
|
|
109
|
+
readonly enum: readonly ["basic", "pro"];
|
|
110
|
+
};
|
|
111
|
+
readonly version_channel: {
|
|
112
|
+
readonly type: "string";
|
|
113
|
+
readonly pattern: "^(x|X|0|[1-9]\\d*)\\.(x|X|0|[1-9]\\d*)\\.(x|X|0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?$";
|
|
114
|
+
readonly description: "Version of the kubernetes cluster.";
|
|
115
|
+
readonly default: "1.x.x-cfke.x";
|
|
116
|
+
readonly example: "1.29.x-cfke.x";
|
|
117
|
+
};
|
|
118
|
+
readonly id: {
|
|
119
|
+
readonly type: "string";
|
|
120
|
+
readonly format: "uuid";
|
|
121
|
+
readonly description: "Unique identifier of the kubernetes cluster. UUID v4 string in canonical form";
|
|
122
|
+
readonly example: "6b5439b1-923a-4f2b-a371-d554e5ea23fa";
|
|
123
|
+
};
|
|
124
|
+
readonly status: {
|
|
125
|
+
readonly type: "string";
|
|
126
|
+
readonly description: "Status of the cluster. When creating a new cluster, set to `active`. When deleting a clusters, set to `deleted`.";
|
|
127
|
+
readonly example: "active";
|
|
128
|
+
readonly enum: readonly ["active", "deleted", "creating", "deployed", "failed", "updating"];
|
|
129
|
+
};
|
|
130
|
+
readonly endpoint: {
|
|
131
|
+
readonly anyOf: readonly [{
|
|
132
|
+
readonly type: "string";
|
|
133
|
+
readonly format: "uri";
|
|
134
|
+
readonly description: "URL of the Kubernetes cluster control plane. This is the endpoint that kubectl uses to connect to the cluster.";
|
|
135
|
+
readonly example: "https://2ae6557c-c61f-49c6-b4c1-a65473470a03.staging.cfke.cloudfleet.dev:6443";
|
|
136
|
+
}, {
|
|
137
|
+
readonly type: "string";
|
|
138
|
+
readonly enum: readonly [""];
|
|
139
|
+
}];
|
|
140
|
+
};
|
|
141
|
+
readonly certificate_ca: {
|
|
142
|
+
readonly type: "string";
|
|
143
|
+
readonly description: "Certificate authority data for the kubernetes cluster. This is the root certificate authority for the cluster.";
|
|
144
|
+
readonly example: "-----BEGIN CERTIFICATE-----\nMIIC0DCCAbigAwIBAgI...";
|
|
145
|
+
};
|
|
146
|
+
readonly version_current: {
|
|
147
|
+
readonly type: "string";
|
|
148
|
+
readonly description: "Current version of the cluster.";
|
|
149
|
+
readonly example: "1.29.3-cfke.52";
|
|
150
|
+
};
|
|
151
|
+
readonly created_at: {
|
|
152
|
+
readonly type: "string";
|
|
153
|
+
readonly description: "Creation date and time of the cluster.";
|
|
154
|
+
readonly example: "2024-09-12T09:11:27Z";
|
|
155
|
+
};
|
|
156
|
+
readonly updated_at: {
|
|
157
|
+
readonly type: "string";
|
|
158
|
+
readonly description: "Last update date and time of the cluster.";
|
|
159
|
+
readonly example: "2024-09-12T09:11:27Z";
|
|
160
|
+
};
|
|
161
|
+
readonly ready: {
|
|
162
|
+
readonly type: "boolean";
|
|
163
|
+
readonly description: "Indicates if the cluster is ready to be used.";
|
|
164
|
+
readonly example: true;
|
|
165
|
+
};
|
|
166
|
+
};
|
|
167
|
+
readonly required: readonly ["name", "tier", "id", "status"];
|
|
168
|
+
readonly additionalProperties: false;
|
|
169
|
+
};
|
|
170
|
+
export declare const ClusterUpdateInputSchema: {
|
|
171
|
+
readonly type: "object";
|
|
172
|
+
readonly properties: {
|
|
173
|
+
readonly name: {
|
|
174
|
+
readonly type: "string";
|
|
175
|
+
readonly maxLength: 63;
|
|
176
|
+
readonly minLength: 1;
|
|
177
|
+
readonly pattern: "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$";
|
|
178
|
+
readonly description: "Name of the cluster.";
|
|
179
|
+
readonly example: "production-cluster";
|
|
180
|
+
};
|
|
181
|
+
readonly version_channel: {
|
|
182
|
+
readonly type: "string";
|
|
183
|
+
readonly pattern: "^(x|X|0|[1-9]\\d*)\\.(x|X|0|[1-9]\\d*)\\.(x|X|0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?$";
|
|
184
|
+
readonly description: "Version of the kubernetes cluster.";
|
|
185
|
+
readonly example: "1.29.x-cfke.x";
|
|
186
|
+
};
|
|
187
|
+
};
|
|
188
|
+
readonly additionalProperties: false;
|
|
189
|
+
};
|
|
190
|
+
export declare const FleetCreateInputSchema: {
|
|
191
|
+
readonly type: "object";
|
|
192
|
+
readonly properties: {
|
|
193
|
+
readonly limits: {
|
|
194
|
+
readonly type: "object";
|
|
195
|
+
readonly properties: {
|
|
196
|
+
readonly cpu: {
|
|
197
|
+
readonly type: "number";
|
|
198
|
+
readonly format: "float";
|
|
199
|
+
readonly minimum: 0;
|
|
200
|
+
readonly description: "CPU limit in cores.";
|
|
201
|
+
};
|
|
202
|
+
};
|
|
203
|
+
readonly required: readonly ["cpu"];
|
|
204
|
+
readonly additionalProperties: false;
|
|
205
|
+
readonly description: "Limits define a set of bounds for provisioning capacity.";
|
|
206
|
+
};
|
|
207
|
+
readonly gcp: {
|
|
208
|
+
readonly type: "object";
|
|
209
|
+
readonly properties: {
|
|
210
|
+
readonly enabled: {
|
|
211
|
+
readonly type: "boolean";
|
|
212
|
+
readonly default: true;
|
|
213
|
+
};
|
|
214
|
+
readonly project: {
|
|
215
|
+
readonly type: "string";
|
|
216
|
+
readonly description: "Project GCP Project id to deploy instances into";
|
|
217
|
+
};
|
|
218
|
+
};
|
|
219
|
+
readonly required: readonly ["project"];
|
|
220
|
+
readonly additionalProperties: false;
|
|
221
|
+
};
|
|
222
|
+
readonly hetzner: {
|
|
223
|
+
readonly oneOf: readonly [{
|
|
224
|
+
readonly type: "object";
|
|
225
|
+
readonly properties: {
|
|
226
|
+
readonly enabled: {
|
|
227
|
+
readonly type: "boolean";
|
|
228
|
+
readonly default: true;
|
|
229
|
+
};
|
|
230
|
+
readonly apiKey: {
|
|
231
|
+
readonly type: "string";
|
|
232
|
+
};
|
|
233
|
+
};
|
|
234
|
+
readonly additionalProperties: false;
|
|
235
|
+
}, {
|
|
236
|
+
readonly type: "object";
|
|
237
|
+
readonly properties: {
|
|
238
|
+
readonly apiKey: {
|
|
239
|
+
readonly type: "string";
|
|
240
|
+
};
|
|
241
|
+
readonly enabled: {
|
|
242
|
+
readonly type: "boolean";
|
|
243
|
+
readonly default: true;
|
|
244
|
+
};
|
|
245
|
+
};
|
|
246
|
+
readonly additionalProperties: false;
|
|
247
|
+
}];
|
|
248
|
+
};
|
|
249
|
+
readonly aws: {
|
|
250
|
+
readonly type: "object";
|
|
251
|
+
readonly properties: {
|
|
252
|
+
readonly enabled: {
|
|
253
|
+
readonly type: "boolean";
|
|
254
|
+
readonly default: true;
|
|
255
|
+
};
|
|
256
|
+
readonly controllerRoleArn: {
|
|
257
|
+
readonly type: "string";
|
|
258
|
+
readonly description: "ControllerRoleArn is the AWS IAM role that Karpenter uses to manage resources.";
|
|
259
|
+
};
|
|
260
|
+
};
|
|
261
|
+
readonly required: readonly ["controllerRoleArn"];
|
|
262
|
+
readonly additionalProperties: false;
|
|
263
|
+
};
|
|
264
|
+
readonly id: {
|
|
265
|
+
readonly type: "string";
|
|
266
|
+
readonly maxLength: 63;
|
|
267
|
+
readonly minLength: 1;
|
|
268
|
+
readonly pattern: "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$";
|
|
269
|
+
readonly description: "Unique identifier of the kubernetes fleet.";
|
|
270
|
+
readonly example: "new-clouds-fleet";
|
|
271
|
+
};
|
|
272
|
+
readonly type: {
|
|
273
|
+
readonly type: "string";
|
|
274
|
+
readonly description: "Specifies the fleet type: infrastructure managed by Cloudfleet or Connected Fleets.";
|
|
275
|
+
readonly enum: readonly ["managed", "connected"];
|
|
276
|
+
};
|
|
277
|
+
};
|
|
278
|
+
readonly required: readonly ["id", "type"];
|
|
279
|
+
readonly additionalProperties: false;
|
|
280
|
+
};
|
|
281
|
+
export declare const FleetSchema: {
|
|
282
|
+
readonly type: "object";
|
|
283
|
+
readonly properties: {
|
|
284
|
+
readonly limits: {
|
|
285
|
+
readonly type: "object";
|
|
286
|
+
readonly properties: {
|
|
287
|
+
readonly cpu: {
|
|
288
|
+
readonly type: "number";
|
|
289
|
+
readonly format: "float";
|
|
290
|
+
readonly minimum: 0;
|
|
291
|
+
readonly description: "CPU limit in cores.";
|
|
292
|
+
};
|
|
293
|
+
};
|
|
294
|
+
readonly required: readonly ["cpu"];
|
|
295
|
+
readonly additionalProperties: false;
|
|
296
|
+
readonly description: "Limits define a set of bounds for provisioning capacity.";
|
|
297
|
+
};
|
|
298
|
+
readonly gcp: {
|
|
299
|
+
readonly type: "object";
|
|
300
|
+
readonly properties: {
|
|
301
|
+
readonly enabled: {
|
|
302
|
+
readonly type: "boolean";
|
|
303
|
+
readonly default: true;
|
|
304
|
+
};
|
|
305
|
+
readonly project: {
|
|
306
|
+
readonly type: "string";
|
|
307
|
+
readonly description: "Project GCP Project id to deploy instances into";
|
|
308
|
+
};
|
|
309
|
+
};
|
|
310
|
+
readonly required: readonly ["project"];
|
|
311
|
+
readonly additionalProperties: false;
|
|
312
|
+
};
|
|
313
|
+
readonly hetzner: {
|
|
314
|
+
readonly oneOf: readonly [{
|
|
315
|
+
readonly type: "object";
|
|
316
|
+
readonly properties: {
|
|
317
|
+
readonly enabled: {
|
|
318
|
+
readonly type: "boolean";
|
|
319
|
+
readonly default: true;
|
|
320
|
+
};
|
|
321
|
+
readonly apiKey: {
|
|
322
|
+
readonly type: "string";
|
|
323
|
+
};
|
|
324
|
+
};
|
|
325
|
+
readonly additionalProperties: false;
|
|
326
|
+
}, {
|
|
327
|
+
readonly type: "object";
|
|
328
|
+
readonly properties: {
|
|
329
|
+
readonly apiKey: {
|
|
330
|
+
readonly type: "string";
|
|
331
|
+
};
|
|
332
|
+
readonly enabled: {
|
|
333
|
+
readonly type: "boolean";
|
|
334
|
+
readonly default: true;
|
|
335
|
+
};
|
|
336
|
+
};
|
|
337
|
+
readonly additionalProperties: false;
|
|
338
|
+
}];
|
|
339
|
+
};
|
|
340
|
+
readonly aws: {
|
|
341
|
+
readonly type: "object";
|
|
342
|
+
readonly properties: {
|
|
343
|
+
readonly enabled: {
|
|
344
|
+
readonly type: "boolean";
|
|
345
|
+
readonly default: true;
|
|
346
|
+
};
|
|
347
|
+
readonly controllerRoleArn: {
|
|
348
|
+
readonly type: "string";
|
|
349
|
+
readonly description: "ControllerRoleArn is the AWS IAM role that Karpenter uses to manage resources.";
|
|
350
|
+
};
|
|
351
|
+
};
|
|
352
|
+
readonly required: readonly ["controllerRoleArn"];
|
|
353
|
+
readonly additionalProperties: false;
|
|
354
|
+
};
|
|
355
|
+
readonly id: {
|
|
356
|
+
readonly type: "string";
|
|
357
|
+
readonly maxLength: 63;
|
|
358
|
+
readonly minLength: 1;
|
|
359
|
+
readonly pattern: "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$";
|
|
360
|
+
readonly description: "Unique identifier of the kubernetes fleet.";
|
|
361
|
+
readonly example: "new-clouds-fleet";
|
|
362
|
+
};
|
|
363
|
+
readonly type: {
|
|
364
|
+
readonly type: "string";
|
|
365
|
+
readonly description: "Specifies the fleet type: infrastructure managed by Cloudfleet or Connected Fleets.";
|
|
366
|
+
readonly enum: readonly ["managed", "connected"];
|
|
367
|
+
};
|
|
368
|
+
};
|
|
369
|
+
readonly required: readonly ["id", "type"];
|
|
370
|
+
readonly additionalProperties: false;
|
|
371
|
+
};
|
|
372
|
+
export declare const FleetUpdateInputSchema: {
|
|
373
|
+
readonly type: "object";
|
|
374
|
+
readonly properties: {
|
|
375
|
+
readonly limits: {
|
|
376
|
+
readonly type: "object";
|
|
377
|
+
readonly properties: {
|
|
378
|
+
readonly cpu: {
|
|
379
|
+
readonly type: "number";
|
|
380
|
+
readonly format: "float";
|
|
381
|
+
readonly minimum: 0;
|
|
382
|
+
readonly description: "CPU limit in cores.";
|
|
383
|
+
};
|
|
384
|
+
};
|
|
385
|
+
readonly required: readonly ["cpu"];
|
|
386
|
+
readonly additionalProperties: false;
|
|
387
|
+
readonly description: "Limits define a set of bounds for provisioning capacity.";
|
|
388
|
+
};
|
|
389
|
+
readonly gcp: {
|
|
390
|
+
readonly type: "object";
|
|
391
|
+
readonly properties: {
|
|
392
|
+
readonly enabled: {
|
|
393
|
+
readonly type: "boolean";
|
|
394
|
+
readonly default: true;
|
|
395
|
+
};
|
|
396
|
+
readonly project: {
|
|
397
|
+
readonly type: "string";
|
|
398
|
+
readonly description: "Project GCP Project id to deploy instances into";
|
|
399
|
+
};
|
|
400
|
+
};
|
|
401
|
+
readonly required: readonly ["project"];
|
|
402
|
+
readonly additionalProperties: false;
|
|
403
|
+
};
|
|
404
|
+
readonly hetzner: {
|
|
405
|
+
readonly oneOf: readonly [{
|
|
406
|
+
readonly type: "object";
|
|
407
|
+
readonly properties: {
|
|
408
|
+
readonly enabled: {
|
|
409
|
+
readonly type: "boolean";
|
|
410
|
+
readonly default: true;
|
|
411
|
+
};
|
|
412
|
+
readonly apiKey: {
|
|
413
|
+
readonly type: "string";
|
|
414
|
+
};
|
|
415
|
+
};
|
|
416
|
+
readonly additionalProperties: false;
|
|
417
|
+
}, {
|
|
418
|
+
readonly type: "object";
|
|
419
|
+
readonly properties: {
|
|
420
|
+
readonly apiKey: {
|
|
421
|
+
readonly type: "string";
|
|
422
|
+
};
|
|
423
|
+
readonly enabled: {
|
|
424
|
+
readonly type: "boolean";
|
|
425
|
+
readonly default: true;
|
|
426
|
+
};
|
|
427
|
+
};
|
|
428
|
+
readonly additionalProperties: false;
|
|
429
|
+
}];
|
|
430
|
+
};
|
|
431
|
+
readonly aws: {
|
|
432
|
+
readonly type: "object";
|
|
433
|
+
readonly properties: {
|
|
434
|
+
readonly enabled: {
|
|
435
|
+
readonly type: "boolean";
|
|
436
|
+
readonly default: true;
|
|
437
|
+
};
|
|
438
|
+
readonly controllerRoleArn: {
|
|
439
|
+
readonly type: "string";
|
|
440
|
+
readonly description: "ControllerRoleArn is the AWS IAM role that Karpenter uses to manage resources.";
|
|
441
|
+
};
|
|
442
|
+
};
|
|
443
|
+
readonly required: readonly ["controllerRoleArn"];
|
|
444
|
+
readonly additionalProperties: false;
|
|
445
|
+
};
|
|
446
|
+
};
|
|
447
|
+
readonly additionalProperties: false;
|
|
448
|
+
};
|
|
449
|
+
export declare const InfrastructureFilterSchema: {
|
|
450
|
+
readonly type: "object";
|
|
451
|
+
readonly properties: {
|
|
452
|
+
readonly version: {
|
|
453
|
+
readonly type: "integer";
|
|
454
|
+
readonly description: "Version of the infrastructure filter definition. Currently only version 1 is supported.";
|
|
455
|
+
readonly default: 1;
|
|
456
|
+
readonly example: 1;
|
|
457
|
+
readonly enum: readonly [1];
|
|
458
|
+
};
|
|
459
|
+
readonly provider: {
|
|
460
|
+
readonly type: "array";
|
|
461
|
+
readonly items: {
|
|
462
|
+
readonly type: "string";
|
|
463
|
+
};
|
|
464
|
+
readonly description: "Limit selection of cloud providers to this list. For the full list of supported providers, see [Providers](https://cloudfleet.ai/docs/cloud-infrastructure/providers/)";
|
|
465
|
+
readonly example: "AWS";
|
|
466
|
+
};
|
|
467
|
+
readonly region: {
|
|
468
|
+
readonly type: "array";
|
|
469
|
+
readonly items: {
|
|
470
|
+
readonly type: "string";
|
|
471
|
+
};
|
|
472
|
+
readonly description: "Limits selection of cloud regions to this list of Cloudfleet regions. For the full list of normalized regions and their mapping to CSP regions, see [Regions](https://cloudfleet.ai/docs/cloud-infrastructure/node-regions/)";
|
|
473
|
+
readonly example: "northamerica";
|
|
474
|
+
};
|
|
475
|
+
readonly sub_region: {
|
|
476
|
+
readonly type: "array";
|
|
477
|
+
readonly items: {
|
|
478
|
+
readonly type: "string";
|
|
479
|
+
};
|
|
480
|
+
readonly description: "Limits selection of cloud regions to this list of Cloudfleet regions. For the full list of normalized regions and their mapping to CSP regions, see [Regions](https://cloudfleet.ai/docs/cloud-infrastructure/node-regions/)";
|
|
481
|
+
readonly example: "west";
|
|
482
|
+
};
|
|
483
|
+
readonly csp_region: {
|
|
484
|
+
readonly type: "array";
|
|
485
|
+
readonly items: {
|
|
486
|
+
readonly type: "string";
|
|
487
|
+
};
|
|
488
|
+
readonly description: "Limits selection of cloud regions to this list of canonical provider regions";
|
|
489
|
+
readonly example: "eu-west-1";
|
|
490
|
+
};
|
|
491
|
+
readonly instance_type: {
|
|
492
|
+
readonly type: "array";
|
|
493
|
+
readonly items: {
|
|
494
|
+
readonly type: "string";
|
|
495
|
+
};
|
|
496
|
+
readonly description: "Limits selection of instance types to this list. Instance / VM type as defined by the cloud service provider";
|
|
497
|
+
readonly example: "p4d.24xlarge";
|
|
498
|
+
};
|
|
499
|
+
readonly accelerator_name: {
|
|
500
|
+
readonly type: "array";
|
|
501
|
+
readonly items: {
|
|
502
|
+
readonly type: "string";
|
|
503
|
+
};
|
|
504
|
+
readonly description: "List of Normalized accelerator model names. For example, all variations of Nvidia A100 GPUs will have 'A100' as accelerator name with various memory configurations set in accelerator_memory field";
|
|
505
|
+
readonly example: "A100";
|
|
506
|
+
};
|
|
507
|
+
readonly accelerator_manufacturer: {
|
|
508
|
+
readonly type: "array";
|
|
509
|
+
readonly items: {
|
|
510
|
+
readonly type: "string";
|
|
511
|
+
};
|
|
512
|
+
readonly description: "List of normalized accelerator manufacturer names. For example, all Nvidia GPUs will have 'NVIDIA' as accelerator manufacturer";
|
|
513
|
+
readonly example: "NVIDIA";
|
|
514
|
+
};
|
|
515
|
+
readonly accelerator_count_min: {
|
|
516
|
+
readonly type: "integer";
|
|
517
|
+
readonly minimum: 0;
|
|
518
|
+
readonly description: "Minimum number of accelerators available on the instance. Some cloud providers support shared accelerators, so the number of accelerators may be a fraction of the number of physical accelerators.";
|
|
519
|
+
readonly example: 1;
|
|
520
|
+
};
|
|
521
|
+
readonly accelerator_count_max: {
|
|
522
|
+
readonly type: "integer";
|
|
523
|
+
readonly minimum: 0;
|
|
524
|
+
readonly description: "Maximum number of accelerators available on the instance. Some cloud providers support shared accelerators, so the number of accelerators may be a fraction of the number of physical accelerators.";
|
|
525
|
+
readonly example: 8;
|
|
526
|
+
};
|
|
527
|
+
readonly accelerator_memory_min: {
|
|
528
|
+
readonly type: "number";
|
|
529
|
+
readonly format: "float";
|
|
530
|
+
readonly description: "Minimum amount of accelerator memory available to each accelerator. For example, Nvidia A100 GPUs will typically have '40.0' gibibytes (GiB) of memory, while A100 GPUs with HBM2E memory will have '80.0' gibibytes (GiB) of memory";
|
|
531
|
+
readonly example: 40;
|
|
532
|
+
};
|
|
533
|
+
readonly accelerator_memory_max: {
|
|
534
|
+
readonly type: "number";
|
|
535
|
+
readonly format: "float";
|
|
536
|
+
readonly description: "Maximum amount of accelerator memory available to each accelerator. For example, Nvidia A100 GPUs will typically have '40.0' gibibytes (GiB) of memory, while A100 GPUs with HBM2E memory will have '80.0' gibibytes (GiB) of memory";
|
|
537
|
+
readonly example: 80;
|
|
538
|
+
};
|
|
539
|
+
readonly memory_min: {
|
|
540
|
+
readonly type: "integer";
|
|
541
|
+
readonly minimum: 0;
|
|
542
|
+
readonly description: "Minimum amount of RAM in gibibytes (GiB)";
|
|
543
|
+
readonly example: 32;
|
|
544
|
+
};
|
|
545
|
+
readonly memory_max: {
|
|
546
|
+
readonly type: "integer";
|
|
547
|
+
readonly minimum: 0;
|
|
548
|
+
readonly description: "Maximum amount of RAM in gibibytes (GiB)";
|
|
549
|
+
readonly example: 64;
|
|
550
|
+
};
|
|
551
|
+
readonly vcpu_min: {
|
|
552
|
+
readonly type: "integer";
|
|
553
|
+
readonly minimum: 1;
|
|
554
|
+
readonly description: "Minimum number of vCPUs as defined by the cloud service provider. Some cloud providers use hyperthreading, so the number of vCPUs may be twice as high as the number of physical cores.";
|
|
555
|
+
readonly example: 32;
|
|
556
|
+
};
|
|
557
|
+
readonly vcpu_max: {
|
|
558
|
+
readonly type: "integer";
|
|
559
|
+
readonly minimum: 1;
|
|
560
|
+
readonly description: "Maximum number of vCPUs as defined by the cloud service provider. Some cloud providers use hyperthreading, so the number of vCPUs may be twice as high as the number of physical cores.";
|
|
561
|
+
readonly example: 128;
|
|
562
|
+
};
|
|
563
|
+
readonly storage_total_min: {
|
|
564
|
+
readonly type: "number";
|
|
565
|
+
readonly format: "float";
|
|
566
|
+
readonly minimum: 10;
|
|
567
|
+
readonly description: "Minimum total storage in GiB (attached and local)";
|
|
568
|
+
readonly example: 128;
|
|
569
|
+
};
|
|
570
|
+
readonly storage_total_max: {
|
|
571
|
+
readonly type: "number";
|
|
572
|
+
readonly format: "float";
|
|
573
|
+
readonly minimum: 10;
|
|
574
|
+
readonly description: "Maximum total storage in GiB (attached and local)";
|
|
575
|
+
readonly example: 256;
|
|
576
|
+
};
|
|
577
|
+
readonly storage_local_min: {
|
|
578
|
+
readonly type: "number";
|
|
579
|
+
readonly format: "float";
|
|
580
|
+
readonly description: "Minimum volume of directly attached, block-device local storage in gibibytes (GiB)";
|
|
581
|
+
readonly example: 24;
|
|
582
|
+
};
|
|
583
|
+
readonly storage_local_max: {
|
|
584
|
+
readonly type: "number";
|
|
585
|
+
readonly format: "float";
|
|
586
|
+
readonly description: "Maximum volume of directly attached, block-device local storage in gibibytes (GiB)";
|
|
587
|
+
readonly example: 128;
|
|
588
|
+
};
|
|
589
|
+
readonly price_min: {
|
|
590
|
+
readonly type: "number";
|
|
591
|
+
readonly format: "float";
|
|
592
|
+
readonly description: "Minimum price of running the inctance per hour in USD as defined by the cloud service provider. The cheapest instance will be selected.";
|
|
593
|
+
readonly example: 10;
|
|
594
|
+
};
|
|
595
|
+
readonly price_max: {
|
|
596
|
+
readonly type: "number";
|
|
597
|
+
readonly format: "float";
|
|
598
|
+
readonly description: "Maximum price of running the inctance per hour in USD as defined by the cloud service provider. The cheapest instance will be selected.";
|
|
599
|
+
readonly example: 50;
|
|
600
|
+
};
|
|
601
|
+
};
|
|
602
|
+
readonly additionalProperties: false;
|
|
603
|
+
};
|
|
604
|
+
export declare const InfrastructureInstanceSchema: {
|
|
605
|
+
readonly type: "object";
|
|
606
|
+
readonly properties: {
|
|
607
|
+
readonly sku: {
|
|
608
|
+
readonly type: "string";
|
|
609
|
+
readonly description: "Cloudfleet instance SKU. Has a format of <provider>-<csp_region>-<instance_type>.";
|
|
610
|
+
readonly example: "AWS-EU-WEST-1C-P4D.24XLARGE";
|
|
611
|
+
};
|
|
612
|
+
readonly provider: {
|
|
613
|
+
readonly type: "string";
|
|
614
|
+
readonly description: "Normalized cloud service provider name. For the full list of supported providers, see [Providers](https://cloudfleet.ai/docs/cloud-infrastructure/providers/)";
|
|
615
|
+
readonly example: "AWS";
|
|
616
|
+
};
|
|
617
|
+
readonly region: {
|
|
618
|
+
readonly type: "string";
|
|
619
|
+
readonly description: "Normalized region. For the full list of normalized regions and their mapping to CSP regions, see [Regions](https://cloudfleet.ai/docs/cloud-infrastructure/node-regions/)";
|
|
620
|
+
readonly example: "europe";
|
|
621
|
+
};
|
|
622
|
+
readonly sub_region: {
|
|
623
|
+
readonly type: "string";
|
|
624
|
+
readonly description: "Normalized sub-region. For the full list of normalized regions and their mapping to CSP regions, see [Regions](https://cloudfleet.ai/docs/cloud-infrastructure/node-regions/)";
|
|
625
|
+
readonly example: "west";
|
|
626
|
+
};
|
|
627
|
+
readonly csp_region: {
|
|
628
|
+
readonly type: "string";
|
|
629
|
+
readonly description: "Region as defined by the cloud service provider";
|
|
630
|
+
readonly example: "eu-west-1";
|
|
631
|
+
};
|
|
632
|
+
readonly csp_zone: {
|
|
633
|
+
readonly type: "string";
|
|
634
|
+
readonly description: "Availability zone as defined by the cloud service provider";
|
|
635
|
+
readonly example: "eu-west-1a";
|
|
636
|
+
};
|
|
637
|
+
readonly instance_type: {
|
|
638
|
+
readonly type: "string";
|
|
639
|
+
readonly description: "Instance / VM type as defined by the cloud service provider";
|
|
640
|
+
readonly example: "p4d.24xlarge";
|
|
641
|
+
};
|
|
642
|
+
readonly architecture: {
|
|
643
|
+
readonly type: "string";
|
|
644
|
+
readonly description: "Instance CPU architecture";
|
|
645
|
+
readonly example: "amd64";
|
|
646
|
+
};
|
|
647
|
+
readonly os: {
|
|
648
|
+
readonly type: "string";
|
|
649
|
+
readonly description: "Instance operating system";
|
|
650
|
+
readonly example: "linux";
|
|
651
|
+
};
|
|
652
|
+
readonly vcpu: {
|
|
653
|
+
readonly type: "number";
|
|
654
|
+
readonly format: "float";
|
|
655
|
+
readonly minimum: 1;
|
|
656
|
+
readonly description: "CPU count as defined by the cloud service provider. Some cloud providers use hyperthreading, so the number of vCPUs may be twice as high as the number of physical cores.";
|
|
657
|
+
readonly example: 96;
|
|
658
|
+
};
|
|
659
|
+
readonly memory: {
|
|
660
|
+
readonly type: "number";
|
|
661
|
+
readonly format: "float";
|
|
662
|
+
readonly minimum: 1;
|
|
663
|
+
readonly description: "Total amount of RAM in gibibytes (GiB)";
|
|
664
|
+
readonly example: 1152;
|
|
665
|
+
};
|
|
666
|
+
readonly local_storage: {
|
|
667
|
+
readonly type: "number";
|
|
668
|
+
readonly format: "float";
|
|
669
|
+
readonly description: "Volume of directly attached, block-device local storage in gibibytes (GiB)";
|
|
670
|
+
readonly example: 8000;
|
|
671
|
+
};
|
|
672
|
+
readonly accelerator_name: {
|
|
673
|
+
readonly type: "string";
|
|
674
|
+
readonly description: "Normalized model name of accelerator. For example, all variations of Nvidia A100 GPUs will have 'A100' as accelerator name with various memory configurations set in accelerator_memory field";
|
|
675
|
+
readonly example: "A100";
|
|
676
|
+
};
|
|
677
|
+
readonly accelerator_manufacturer: {
|
|
678
|
+
readonly type: "string";
|
|
679
|
+
readonly description: "Normalized manufacturer name of accelerator. For example, all Nvidia GPUs will have 'NVIDIA' as accelerator manufacturer";
|
|
680
|
+
readonly example: "NVIDIA";
|
|
681
|
+
};
|
|
682
|
+
readonly accelerator_count: {
|
|
683
|
+
readonly type: "integer";
|
|
684
|
+
readonly description: "Number of accelerators available on the instance. Some cloud providers support shared accelerators, so the number of accelerators may be a fraction of the number of physical accelerators.";
|
|
685
|
+
readonly example: 8;
|
|
686
|
+
};
|
|
687
|
+
readonly accelerator_memory: {
|
|
688
|
+
readonly type: "number";
|
|
689
|
+
readonly format: "float";
|
|
690
|
+
readonly description: "Ammount of accelerator memory available to each accelerator. For example, Nvidia A100 GPUs will typically have '40.0' gibibytes (GiB) of memory, while A100 GPUs with HBM2E memory will have '80.0' gibibytes (GiB) of memory";
|
|
691
|
+
readonly example: 40;
|
|
692
|
+
};
|
|
693
|
+
readonly pods_capacity: {
|
|
694
|
+
readonly type: "number";
|
|
695
|
+
readonly format: "float";
|
|
696
|
+
readonly description: "Maximum number of pods that can be run on this instance type.";
|
|
697
|
+
readonly example: 110;
|
|
698
|
+
};
|
|
699
|
+
readonly capacity_type: {
|
|
700
|
+
readonly type: "string";
|
|
701
|
+
readonly description: "Capacity type of the instance. E.g. `on-demand`, `spot`.";
|
|
702
|
+
readonly example: "on-demand";
|
|
703
|
+
};
|
|
704
|
+
readonly price: {
|
|
705
|
+
readonly type: "number";
|
|
706
|
+
readonly format: "float";
|
|
707
|
+
readonly description: "Price of running the inctance per hour in USD as defined by the cloud service provider";
|
|
708
|
+
readonly example: 35.39655;
|
|
709
|
+
};
|
|
710
|
+
readonly available: {
|
|
711
|
+
readonly type: "boolean";
|
|
712
|
+
readonly description: "Whether this instance type is available.";
|
|
713
|
+
readonly example: true;
|
|
714
|
+
};
|
|
715
|
+
};
|
|
716
|
+
readonly required: readonly ["sku", "provider", "region", "sub_region", "csp_region", "csp_zone", "instance_type", "architecture", "os", "vcpu", "memory", "local_storage", "price"];
|
|
717
|
+
readonly additionalProperties: false;
|
|
718
|
+
};
|
|
719
|
+
export declare const InviteSchema: {
|
|
720
|
+
readonly type: "object";
|
|
721
|
+
readonly properties: {
|
|
722
|
+
readonly id: {
|
|
723
|
+
readonly type: "string";
|
|
724
|
+
readonly description: "Unique identifier of the invitation.";
|
|
725
|
+
readonly example: "65831dd20d20165489cbb868";
|
|
726
|
+
};
|
|
727
|
+
readonly organization_id: {
|
|
728
|
+
readonly type: "string";
|
|
729
|
+
readonly format: "uuid";
|
|
730
|
+
readonly description: "Unique identifier of the organization the project belongs to. UUID v4 string in canonical form";
|
|
731
|
+
readonly example: "e94d30ec-a2dd-4dcb-832c-ac2be144ba91";
|
|
732
|
+
};
|
|
733
|
+
readonly date_created: {
|
|
734
|
+
readonly type: "string";
|
|
735
|
+
readonly format: "date-time";
|
|
736
|
+
readonly description: "Creationg date of the project. ISO 8601 date string in UTC timezone";
|
|
737
|
+
readonly example: "2023-11-02T16:08:14.338Z";
|
|
738
|
+
};
|
|
739
|
+
readonly email: {
|
|
740
|
+
readonly type: "string";
|
|
741
|
+
readonly format: "email";
|
|
742
|
+
readonly description: "User email address.";
|
|
743
|
+
readonly example: "email@example.com";
|
|
744
|
+
};
|
|
745
|
+
readonly code: {
|
|
746
|
+
readonly type: "string";
|
|
747
|
+
readonly description: "Generated unique invite code.";
|
|
748
|
+
readonly example: "7kUZnH7nnKUFfvc4NK2KQF";
|
|
749
|
+
};
|
|
750
|
+
};
|
|
751
|
+
readonly required: readonly ["date_created"];
|
|
752
|
+
readonly additionalProperties: false;
|
|
753
|
+
};
|
|
754
|
+
export declare const InvoiceSchema: {
|
|
755
|
+
readonly type: "object";
|
|
756
|
+
readonly properties: {
|
|
757
|
+
readonly id: {
|
|
758
|
+
readonly type: "string";
|
|
759
|
+
readonly format: "uuid";
|
|
760
|
+
readonly description: "Unique identifier of the invoice. UUID v4 string in canonical form";
|
|
761
|
+
readonly example: "415026b6-f00f-44f8-968d-fc6ef4d0fc6d";
|
|
762
|
+
};
|
|
763
|
+
readonly organizationId: {
|
|
764
|
+
readonly type: "string";
|
|
765
|
+
readonly format: "uuid";
|
|
766
|
+
readonly description: "Unique identifier of the organization. UUID v4 string in canonical form";
|
|
767
|
+
readonly example: "415026b6-f00f-44f8-968d-fc6ef4d0fc6d";
|
|
768
|
+
};
|
|
769
|
+
readonly status: {
|
|
770
|
+
readonly type: "string";
|
|
771
|
+
readonly description: "Status of the invoice";
|
|
772
|
+
readonly example: "DRAFT";
|
|
773
|
+
readonly enum: readonly ["DRAFT", "COMMITTED", "VOID"];
|
|
774
|
+
};
|
|
775
|
+
readonly amount: {
|
|
776
|
+
readonly type: "number";
|
|
777
|
+
readonly format: "float";
|
|
778
|
+
readonly description: "Total amount of the invoice";
|
|
779
|
+
readonly example: 100;
|
|
780
|
+
};
|
|
781
|
+
readonly currency: {
|
|
782
|
+
readonly type: "string";
|
|
783
|
+
readonly description: "Currency of the invoice";
|
|
784
|
+
readonly example: "USD";
|
|
785
|
+
readonly enum: readonly ["AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SPL", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TVD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD", "BTC"];
|
|
786
|
+
};
|
|
787
|
+
readonly creditAdj: {
|
|
788
|
+
readonly type: "number";
|
|
789
|
+
readonly format: "float";
|
|
790
|
+
readonly description: "Total amount of credit adjustments";
|
|
791
|
+
readonly example: 0;
|
|
792
|
+
};
|
|
793
|
+
readonly refundAdj: {
|
|
794
|
+
readonly type: "number";
|
|
795
|
+
readonly format: "float";
|
|
796
|
+
readonly description: "Total amount of refund adjustments";
|
|
797
|
+
readonly example: 0;
|
|
798
|
+
};
|
|
799
|
+
readonly invoiceDate: {
|
|
800
|
+
readonly type: "string";
|
|
801
|
+
readonly description: "Date of the invoice";
|
|
802
|
+
readonly example: "2019-01-01T00:00:00.000Z";
|
|
803
|
+
};
|
|
804
|
+
readonly targetDate: {
|
|
805
|
+
readonly type: "string";
|
|
806
|
+
readonly description: "Target date of the invoice";
|
|
807
|
+
readonly example: "2019-01-01T00:00:00.000Z";
|
|
808
|
+
};
|
|
809
|
+
readonly invoiceNumber: {
|
|
810
|
+
readonly type: "string";
|
|
811
|
+
readonly description: "Number of the invoice";
|
|
812
|
+
readonly example: "INV-0001";
|
|
813
|
+
};
|
|
814
|
+
readonly balance: {
|
|
815
|
+
readonly type: "number";
|
|
816
|
+
readonly format: "float";
|
|
817
|
+
readonly description: "Balance of the invoice";
|
|
818
|
+
readonly example: 100;
|
|
819
|
+
};
|
|
820
|
+
readonly bundleKeys: {
|
|
821
|
+
readonly type: "string";
|
|
822
|
+
readonly description: "Bundle keys of the invoice";
|
|
823
|
+
readonly example: "bundleKey1,bundleKey2";
|
|
824
|
+
};
|
|
825
|
+
readonly credits: {
|
|
826
|
+
readonly type: "array";
|
|
827
|
+
readonly items: {
|
|
828
|
+
readonly type: "object";
|
|
829
|
+
readonly properties: {
|
|
830
|
+
readonly id: {
|
|
831
|
+
readonly type: "string";
|
|
832
|
+
readonly format: "uuid";
|
|
833
|
+
readonly description: "Unique identifier of the invoice item. UUID v4 string in canonical form";
|
|
834
|
+
readonly example: "415026b6-f00f-44f8-968d-fc6ef4d0fc6d";
|
|
835
|
+
};
|
|
836
|
+
readonly linkedInvoiceItemId: {
|
|
837
|
+
readonly type: "string";
|
|
838
|
+
readonly format: "uuid";
|
|
839
|
+
readonly description: "Unique identifier of the linked invoice item. UUID v4 string in canonical form";
|
|
840
|
+
readonly example: "415026b6-f00f-44f8-968d-fc6ef4d0fc6d";
|
|
841
|
+
};
|
|
842
|
+
readonly productName: {
|
|
843
|
+
readonly type: "string";
|
|
844
|
+
readonly description: "Name of the product";
|
|
845
|
+
readonly example: "Research team";
|
|
846
|
+
};
|
|
847
|
+
readonly planName: {
|
|
848
|
+
readonly type: "string";
|
|
849
|
+
readonly description: "Name of the plan";
|
|
850
|
+
readonly example: "Plan A";
|
|
851
|
+
};
|
|
852
|
+
readonly phaseName: {
|
|
853
|
+
readonly type: "string";
|
|
854
|
+
readonly description: "Name of the phase";
|
|
855
|
+
readonly example: "Phase A";
|
|
856
|
+
};
|
|
857
|
+
readonly usageName: {
|
|
858
|
+
readonly type: "string";
|
|
859
|
+
readonly description: "Name of the usage";
|
|
860
|
+
readonly example: "Usage A";
|
|
861
|
+
};
|
|
862
|
+
readonly prettyProductName: {
|
|
863
|
+
readonly type: "string";
|
|
864
|
+
readonly description: "Pretty name of the product";
|
|
865
|
+
readonly example: "Research team";
|
|
866
|
+
};
|
|
867
|
+
readonly prettyPlanName: {
|
|
868
|
+
readonly type: "string";
|
|
869
|
+
readonly description: "Pretty name of the plan";
|
|
870
|
+
readonly example: "Plan A";
|
|
871
|
+
};
|
|
872
|
+
readonly prettyPhaseName: {
|
|
873
|
+
readonly type: "string";
|
|
874
|
+
readonly description: "Pretty name of the phase";
|
|
875
|
+
readonly example: "Phase A";
|
|
876
|
+
};
|
|
877
|
+
readonly prettyUsageName: {
|
|
878
|
+
readonly type: "string";
|
|
879
|
+
readonly description: "Pretty name of the usage";
|
|
880
|
+
readonly example: "Usage A";
|
|
881
|
+
};
|
|
882
|
+
readonly itemType: {
|
|
883
|
+
readonly type: "string";
|
|
884
|
+
readonly description: "Type of the invoice item";
|
|
885
|
+
readonly example: "EXTERNAL_CHARGE";
|
|
886
|
+
readonly enum: readonly ["EXTERNAL_CHARGE", "FIXED", "RECURRING", "REPAIR_ADJ", "CBA_ADJ", "CREDIT_ADJ", "ITEM_ADJ", "USAGE", "TAX", "PARENT_SUMMARY"];
|
|
887
|
+
};
|
|
888
|
+
readonly description: {
|
|
889
|
+
readonly type: "string";
|
|
890
|
+
readonly description: "Description of the invoice item";
|
|
891
|
+
readonly example: "Description of the invoice item";
|
|
892
|
+
};
|
|
893
|
+
readonly startDate: {
|
|
894
|
+
readonly type: "string";
|
|
895
|
+
readonly description: "Start date of the invoice item";
|
|
896
|
+
readonly example: "2019-01-01T00:00:00.000Z";
|
|
897
|
+
};
|
|
898
|
+
readonly endDate: {
|
|
899
|
+
readonly type: "string";
|
|
900
|
+
readonly description: "End date of the invoice item";
|
|
901
|
+
readonly example: "2019-01-01T00:00:00.000Z";
|
|
902
|
+
};
|
|
903
|
+
readonly amount: {
|
|
904
|
+
readonly type: "number";
|
|
905
|
+
readonly format: "float";
|
|
906
|
+
readonly description: "Amount of the invoice item";
|
|
907
|
+
readonly example: 100;
|
|
908
|
+
};
|
|
909
|
+
readonly rate: {
|
|
910
|
+
readonly type: "number";
|
|
911
|
+
readonly format: "float";
|
|
912
|
+
readonly description: "Rate of the invoice item";
|
|
913
|
+
readonly example: 100;
|
|
914
|
+
};
|
|
915
|
+
readonly currency: {
|
|
916
|
+
readonly type: "string";
|
|
917
|
+
readonly description: "Currency of the invoice item";
|
|
918
|
+
readonly example: "USD";
|
|
919
|
+
readonly enum: readonly ["AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SPL", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TVD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD", "BTC"];
|
|
920
|
+
};
|
|
921
|
+
readonly quantity: {
|
|
922
|
+
readonly type: "number";
|
|
923
|
+
readonly format: "float";
|
|
924
|
+
readonly description: "Quantity of the invoice item";
|
|
925
|
+
readonly example: 1;
|
|
926
|
+
};
|
|
927
|
+
readonly itemDetails: {
|
|
928
|
+
readonly type: "string";
|
|
929
|
+
readonly description: "Details of the invoice item";
|
|
930
|
+
readonly example: "Details of the invoice item";
|
|
931
|
+
};
|
|
932
|
+
readonly catalogEffectiveDate: {
|
|
933
|
+
readonly type: "string";
|
|
934
|
+
readonly description: "Effective date of the catalog";
|
|
935
|
+
readonly example: "2019-01-01T00:00:00.000Z";
|
|
936
|
+
};
|
|
937
|
+
readonly childItems: {
|
|
938
|
+
readonly type: "array";
|
|
939
|
+
readonly items: {
|
|
940
|
+
readonly oneOf: readonly [{
|
|
941
|
+
readonly type: "array";
|
|
942
|
+
}, {
|
|
943
|
+
readonly type: "boolean";
|
|
944
|
+
}, {
|
|
945
|
+
readonly type: "number";
|
|
946
|
+
}, {
|
|
947
|
+
readonly type: "object";
|
|
948
|
+
readonly additionalProperties: true;
|
|
949
|
+
}, {
|
|
950
|
+
readonly type: "string";
|
|
951
|
+
}];
|
|
952
|
+
};
|
|
953
|
+
readonly description: "Child items of the invoice item";
|
|
954
|
+
};
|
|
955
|
+
};
|
|
956
|
+
readonly additionalProperties: false;
|
|
957
|
+
};
|
|
958
|
+
readonly description: "Credits of the invoice";
|
|
959
|
+
};
|
|
960
|
+
readonly items: {
|
|
961
|
+
readonly type: "array";
|
|
962
|
+
readonly items: {
|
|
963
|
+
readonly type: "object";
|
|
964
|
+
readonly properties: {
|
|
965
|
+
readonly id: {
|
|
966
|
+
readonly type: "string";
|
|
967
|
+
readonly format: "uuid";
|
|
968
|
+
readonly description: "Unique identifier of the invoice item. UUID v4 string in canonical form";
|
|
969
|
+
readonly example: "415026b6-f00f-44f8-968d-fc6ef4d0fc6d";
|
|
970
|
+
};
|
|
971
|
+
readonly linkedInvoiceItemId: {
|
|
972
|
+
readonly type: "string";
|
|
973
|
+
readonly format: "uuid";
|
|
974
|
+
readonly description: "Unique identifier of the linked invoice item. UUID v4 string in canonical form";
|
|
975
|
+
readonly example: "415026b6-f00f-44f8-968d-fc6ef4d0fc6d";
|
|
976
|
+
};
|
|
977
|
+
readonly productName: {
|
|
978
|
+
readonly type: "string";
|
|
979
|
+
readonly description: "Name of the product";
|
|
980
|
+
readonly example: "Research team";
|
|
981
|
+
};
|
|
982
|
+
readonly planName: {
|
|
983
|
+
readonly type: "string";
|
|
984
|
+
readonly description: "Name of the plan";
|
|
985
|
+
readonly example: "Plan A";
|
|
986
|
+
};
|
|
987
|
+
readonly phaseName: {
|
|
988
|
+
readonly type: "string";
|
|
989
|
+
readonly description: "Name of the phase";
|
|
990
|
+
readonly example: "Phase A";
|
|
991
|
+
};
|
|
992
|
+
readonly usageName: {
|
|
993
|
+
readonly type: "string";
|
|
994
|
+
readonly description: "Name of the usage";
|
|
995
|
+
readonly example: "Usage A";
|
|
996
|
+
};
|
|
997
|
+
readonly prettyProductName: {
|
|
998
|
+
readonly type: "string";
|
|
999
|
+
readonly description: "Pretty name of the product";
|
|
1000
|
+
readonly example: "Research team";
|
|
1001
|
+
};
|
|
1002
|
+
readonly prettyPlanName: {
|
|
1003
|
+
readonly type: "string";
|
|
1004
|
+
readonly description: "Pretty name of the plan";
|
|
1005
|
+
readonly example: "Plan A";
|
|
1006
|
+
};
|
|
1007
|
+
readonly prettyPhaseName: {
|
|
1008
|
+
readonly type: "string";
|
|
1009
|
+
readonly description: "Pretty name of the phase";
|
|
1010
|
+
readonly example: "Phase A";
|
|
1011
|
+
};
|
|
1012
|
+
readonly prettyUsageName: {
|
|
1013
|
+
readonly type: "string";
|
|
1014
|
+
readonly description: "Pretty name of the usage";
|
|
1015
|
+
readonly example: "Usage A";
|
|
1016
|
+
};
|
|
1017
|
+
readonly itemType: {
|
|
1018
|
+
readonly type: "string";
|
|
1019
|
+
readonly description: "Type of the invoice item";
|
|
1020
|
+
readonly example: "EXTERNAL_CHARGE";
|
|
1021
|
+
readonly enum: readonly ["EXTERNAL_CHARGE", "FIXED", "RECURRING", "REPAIR_ADJ", "CBA_ADJ", "CREDIT_ADJ", "ITEM_ADJ", "USAGE", "TAX", "PARENT_SUMMARY"];
|
|
1022
|
+
};
|
|
1023
|
+
readonly description: {
|
|
1024
|
+
readonly type: "string";
|
|
1025
|
+
readonly description: "Description of the invoice item";
|
|
1026
|
+
readonly example: "Description of the invoice item";
|
|
1027
|
+
};
|
|
1028
|
+
readonly startDate: {
|
|
1029
|
+
readonly type: "string";
|
|
1030
|
+
readonly description: "Start date of the invoice item";
|
|
1031
|
+
readonly example: "2019-01-01T00:00:00.000Z";
|
|
1032
|
+
};
|
|
1033
|
+
readonly endDate: {
|
|
1034
|
+
readonly type: "string";
|
|
1035
|
+
readonly description: "End date of the invoice item";
|
|
1036
|
+
readonly example: "2019-01-01T00:00:00.000Z";
|
|
1037
|
+
};
|
|
1038
|
+
readonly amount: {
|
|
1039
|
+
readonly type: "number";
|
|
1040
|
+
readonly format: "float";
|
|
1041
|
+
readonly description: "Amount of the invoice item";
|
|
1042
|
+
readonly example: 100;
|
|
1043
|
+
};
|
|
1044
|
+
readonly rate: {
|
|
1045
|
+
readonly type: "number";
|
|
1046
|
+
readonly format: "float";
|
|
1047
|
+
readonly description: "Rate of the invoice item";
|
|
1048
|
+
readonly example: 100;
|
|
1049
|
+
};
|
|
1050
|
+
readonly currency: {
|
|
1051
|
+
readonly type: "string";
|
|
1052
|
+
readonly description: "Currency of the invoice item";
|
|
1053
|
+
readonly example: "USD";
|
|
1054
|
+
readonly enum: readonly ["AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SPL", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TVD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD", "BTC"];
|
|
1055
|
+
};
|
|
1056
|
+
readonly quantity: {
|
|
1057
|
+
readonly type: "number";
|
|
1058
|
+
readonly format: "float";
|
|
1059
|
+
readonly description: "Quantity of the invoice item";
|
|
1060
|
+
readonly example: 1;
|
|
1061
|
+
};
|
|
1062
|
+
readonly itemDetails: {
|
|
1063
|
+
readonly type: "string";
|
|
1064
|
+
readonly description: "Details of the invoice item";
|
|
1065
|
+
readonly example: "Details of the invoice item";
|
|
1066
|
+
};
|
|
1067
|
+
readonly catalogEffectiveDate: {
|
|
1068
|
+
readonly type: "string";
|
|
1069
|
+
readonly description: "Effective date of the catalog";
|
|
1070
|
+
readonly example: "2019-01-01T00:00:00.000Z";
|
|
1071
|
+
};
|
|
1072
|
+
readonly childItems: {
|
|
1073
|
+
readonly type: "array";
|
|
1074
|
+
readonly items: {
|
|
1075
|
+
readonly oneOf: readonly [{
|
|
1076
|
+
readonly type: "array";
|
|
1077
|
+
}, {
|
|
1078
|
+
readonly type: "boolean";
|
|
1079
|
+
}, {
|
|
1080
|
+
readonly type: "number";
|
|
1081
|
+
}, {
|
|
1082
|
+
readonly type: "object";
|
|
1083
|
+
readonly additionalProperties: true;
|
|
1084
|
+
}, {
|
|
1085
|
+
readonly type: "string";
|
|
1086
|
+
}];
|
|
1087
|
+
};
|
|
1088
|
+
readonly description: "Child items of the invoice item";
|
|
1089
|
+
};
|
|
1090
|
+
};
|
|
1091
|
+
readonly additionalProperties: false;
|
|
1092
|
+
};
|
|
1093
|
+
readonly description: "Items of the invoice";
|
|
1094
|
+
};
|
|
1095
|
+
};
|
|
1096
|
+
readonly additionalProperties: false;
|
|
1097
|
+
};
|
|
1098
|
+
export declare const OrganizationContactInfoSchema: {
|
|
1099
|
+
readonly type: "object";
|
|
1100
|
+
readonly properties: {
|
|
1101
|
+
readonly address1: {
|
|
1102
|
+
readonly type: "string";
|
|
1103
|
+
readonly nullable: true;
|
|
1104
|
+
readonly description: "Street address, P.O. box, c/o";
|
|
1105
|
+
readonly example: "123 Main St.";
|
|
1106
|
+
};
|
|
1107
|
+
readonly address2: {
|
|
1108
|
+
readonly type: "string";
|
|
1109
|
+
readonly nullable: true;
|
|
1110
|
+
readonly description: "Apartment, suite, unit, building, floor, etc.";
|
|
1111
|
+
readonly example: "Suite 100";
|
|
1112
|
+
};
|
|
1113
|
+
readonly postalCode: {
|
|
1114
|
+
readonly type: "string";
|
|
1115
|
+
readonly nullable: true;
|
|
1116
|
+
readonly description: "Postal code as a string.";
|
|
1117
|
+
readonly example: "94105";
|
|
1118
|
+
};
|
|
1119
|
+
readonly city: {
|
|
1120
|
+
readonly type: "string";
|
|
1121
|
+
readonly nullable: true;
|
|
1122
|
+
readonly description: "City or town name.";
|
|
1123
|
+
readonly example: "San Francisco";
|
|
1124
|
+
};
|
|
1125
|
+
readonly state: {
|
|
1126
|
+
readonly type: "string";
|
|
1127
|
+
readonly nullable: true;
|
|
1128
|
+
readonly description: "State, province, or region name.";
|
|
1129
|
+
readonly example: "CA";
|
|
1130
|
+
};
|
|
1131
|
+
readonly country: {
|
|
1132
|
+
readonly type: "string";
|
|
1133
|
+
readonly nullable: true;
|
|
1134
|
+
readonly description: "Country as a ISO 3166-1 alpha-2 country code.";
|
|
1135
|
+
readonly example: "US";
|
|
1136
|
+
};
|
|
1137
|
+
readonly phone: {
|
|
1138
|
+
readonly type: "string";
|
|
1139
|
+
readonly nullable: true;
|
|
1140
|
+
readonly description: "Phone number as a string.";
|
|
1141
|
+
readonly example: "+1 555 555 5555";
|
|
1142
|
+
};
|
|
1143
|
+
readonly email: {
|
|
1144
|
+
readonly type: "string";
|
|
1145
|
+
readonly format: "email";
|
|
1146
|
+
readonly description: "Email address used for billing as a string.";
|
|
1147
|
+
readonly example: "email@example.com";
|
|
1148
|
+
};
|
|
1149
|
+
readonly first_name: {
|
|
1150
|
+
readonly type: "string";
|
|
1151
|
+
readonly description: "First name of the billing contact person.";
|
|
1152
|
+
readonly example: "John";
|
|
1153
|
+
};
|
|
1154
|
+
readonly last_name: {
|
|
1155
|
+
readonly type: "string";
|
|
1156
|
+
readonly description: "Last name of the billing contact person.";
|
|
1157
|
+
readonly example: "Doe";
|
|
1158
|
+
};
|
|
1159
|
+
};
|
|
1160
|
+
readonly required: readonly ["email", "first_name", "last_name"];
|
|
1161
|
+
readonly additionalProperties: false;
|
|
1162
|
+
};
|
|
1163
|
+
export declare const OrganizationSchema: {
|
|
1164
|
+
readonly type: "object";
|
|
1165
|
+
readonly properties: {
|
|
1166
|
+
readonly id: {
|
|
1167
|
+
readonly type: "string";
|
|
1168
|
+
readonly format: "uuid";
|
|
1169
|
+
readonly description: "Unique identifier of the organization. UUID v4 string in canonical form";
|
|
1170
|
+
readonly example: "e94d30ec-a2dd-4dcb-832c-ac2be144ba91";
|
|
1171
|
+
};
|
|
1172
|
+
readonly date_created: {
|
|
1173
|
+
readonly type: "string";
|
|
1174
|
+
readonly format: "date-time";
|
|
1175
|
+
readonly description: "Creationg date of the organization. ISO 8601 date string in UTC timezone";
|
|
1176
|
+
readonly example: "2023-11-02T16:08:14.338Z";
|
|
1177
|
+
};
|
|
1178
|
+
readonly name: {
|
|
1179
|
+
readonly type: "string";
|
|
1180
|
+
readonly description: "Name of the legal entity. This name will be used in invoices. Use your first and last name for individual accounts.";
|
|
1181
|
+
readonly example: "ACME Corp.";
|
|
1182
|
+
};
|
|
1183
|
+
readonly contactInfo: {
|
|
1184
|
+
readonly type: "object";
|
|
1185
|
+
readonly properties: {
|
|
1186
|
+
readonly address1: {
|
|
1187
|
+
readonly type: "string";
|
|
1188
|
+
readonly description: "Street address, P.O. box, c/o";
|
|
1189
|
+
readonly example: "123 Main St.";
|
|
1190
|
+
};
|
|
1191
|
+
readonly address2: {
|
|
1192
|
+
readonly type: "string";
|
|
1193
|
+
readonly description: "Apartment, suite, unit, building, floor, etc.";
|
|
1194
|
+
readonly example: "Suite 100";
|
|
1195
|
+
};
|
|
1196
|
+
readonly postalCode: {
|
|
1197
|
+
readonly type: "string";
|
|
1198
|
+
readonly description: "Postal code as a string.";
|
|
1199
|
+
readonly example: "94105";
|
|
1200
|
+
};
|
|
1201
|
+
readonly city: {
|
|
1202
|
+
readonly type: "string";
|
|
1203
|
+
readonly description: "City or town name.";
|
|
1204
|
+
readonly example: "San Francisco";
|
|
1205
|
+
};
|
|
1206
|
+
readonly state: {
|
|
1207
|
+
readonly type: "string";
|
|
1208
|
+
readonly description: "State, province, or region name.";
|
|
1209
|
+
readonly example: "CA";
|
|
1210
|
+
};
|
|
1211
|
+
readonly country: {
|
|
1212
|
+
readonly type: "string";
|
|
1213
|
+
readonly description: "Country as a ISO 3166-1 alpha-2 country code.";
|
|
1214
|
+
readonly example: "US";
|
|
1215
|
+
};
|
|
1216
|
+
readonly phone: {
|
|
1217
|
+
readonly type: "string";
|
|
1218
|
+
readonly description: "Phone number as a string.";
|
|
1219
|
+
readonly example: "+1 555 555 5555";
|
|
1220
|
+
};
|
|
1221
|
+
readonly email: {
|
|
1222
|
+
readonly type: "string";
|
|
1223
|
+
readonly format: "email";
|
|
1224
|
+
readonly description: "Email address used for billing as a string.";
|
|
1225
|
+
readonly example: "email@example.com";
|
|
1226
|
+
};
|
|
1227
|
+
readonly first_name: {
|
|
1228
|
+
readonly type: "string";
|
|
1229
|
+
readonly description: "First name of the billing contact person.";
|
|
1230
|
+
readonly example: "John";
|
|
1231
|
+
};
|
|
1232
|
+
readonly last_name: {
|
|
1233
|
+
readonly type: "string";
|
|
1234
|
+
readonly description: "Last name of the billing contact person.";
|
|
1235
|
+
readonly example: "Doe";
|
|
1236
|
+
};
|
|
1237
|
+
};
|
|
1238
|
+
readonly required: readonly ["email", "first_name", "last_name"];
|
|
1239
|
+
readonly additionalProperties: false;
|
|
1240
|
+
readonly description: "Organization contact information and billing address.";
|
|
1241
|
+
};
|
|
1242
|
+
readonly quota: {
|
|
1243
|
+
readonly type: "object";
|
|
1244
|
+
readonly properties: {
|
|
1245
|
+
readonly basic_clusters_max: {
|
|
1246
|
+
readonly type: "integer";
|
|
1247
|
+
readonly minimum: 0;
|
|
1248
|
+
readonly description: "Maximum number of Basic clusters that can be created.";
|
|
1249
|
+
readonly example: 999;
|
|
1250
|
+
};
|
|
1251
|
+
readonly basic_clusters_available: {
|
|
1252
|
+
readonly type: "integer";
|
|
1253
|
+
readonly description: "Available number of Basic clusters that can be created.";
|
|
1254
|
+
readonly example: 999;
|
|
1255
|
+
};
|
|
1256
|
+
readonly pro_clusters_max: {
|
|
1257
|
+
readonly type: "integer";
|
|
1258
|
+
readonly minimum: 0;
|
|
1259
|
+
readonly description: "Maximum number of Pro clusters that can be created.";
|
|
1260
|
+
readonly example: 999;
|
|
1261
|
+
};
|
|
1262
|
+
readonly pro_clusters_available: {
|
|
1263
|
+
readonly type: "integer";
|
|
1264
|
+
readonly description: "Available number of Pro clusters that can be created.";
|
|
1265
|
+
readonly example: 999;
|
|
1266
|
+
};
|
|
1267
|
+
readonly fleets_max: {
|
|
1268
|
+
readonly type: "integer";
|
|
1269
|
+
readonly minimum: 0;
|
|
1270
|
+
readonly description: "Maximum number of fleets that can be created per cluster.";
|
|
1271
|
+
readonly example: 999;
|
|
1272
|
+
};
|
|
1273
|
+
readonly managed_fleets_cpu_max: {
|
|
1274
|
+
readonly type: "integer";
|
|
1275
|
+
readonly minimum: 0;
|
|
1276
|
+
readonly description: "Maximum number of CPU cores per managed fleet.";
|
|
1277
|
+
readonly example: 999;
|
|
1278
|
+
};
|
|
1279
|
+
readonly cluster_tiers: {
|
|
1280
|
+
readonly type: "array";
|
|
1281
|
+
readonly items: {
|
|
1282
|
+
readonly type: "string";
|
|
1283
|
+
readonly example: "basic";
|
|
1284
|
+
};
|
|
1285
|
+
readonly minItems: 0;
|
|
1286
|
+
readonly description: "List of Cloudfleet cluster tiers available for the organization.";
|
|
1287
|
+
};
|
|
1288
|
+
readonly regions: {
|
|
1289
|
+
readonly type: "array";
|
|
1290
|
+
readonly items: {
|
|
1291
|
+
readonly type: "string";
|
|
1292
|
+
readonly example: "northamerica-central-1";
|
|
1293
|
+
};
|
|
1294
|
+
readonly minItems: 1;
|
|
1295
|
+
readonly description: "List of Cloudfleet control plane regions available for the organization.";
|
|
1296
|
+
};
|
|
1297
|
+
readonly versions: {
|
|
1298
|
+
readonly type: "array";
|
|
1299
|
+
readonly items: {
|
|
1300
|
+
readonly type: "object";
|
|
1301
|
+
readonly properties: {
|
|
1302
|
+
readonly id: {
|
|
1303
|
+
readonly type: "string";
|
|
1304
|
+
readonly description: "Id of the control plane version. Used in API calls.";
|
|
1305
|
+
readonly example: "1.29.x-cfke.x";
|
|
1306
|
+
};
|
|
1307
|
+
readonly label: {
|
|
1308
|
+
readonly type: "string";
|
|
1309
|
+
readonly description: "Label of the control plane version. Used in frontent UI.";
|
|
1310
|
+
readonly example: "1.29.x (Always latest 1.29 patch version)";
|
|
1311
|
+
};
|
|
1312
|
+
};
|
|
1313
|
+
readonly required: readonly ["id", "label"];
|
|
1314
|
+
readonly additionalProperties: false;
|
|
1315
|
+
};
|
|
1316
|
+
readonly minItems: 1;
|
|
1317
|
+
readonly description: "List of CFKE control plane versions available for the organization.";
|
|
1318
|
+
};
|
|
1319
|
+
};
|
|
1320
|
+
readonly required: readonly ["basic_clusters_max", "basic_clusters_available", "pro_clusters_max", "pro_clusters_available", "fleets_max", "managed_fleets_cpu_max", "cluster_tiers", "regions", "versions"];
|
|
1321
|
+
readonly additionalProperties: false;
|
|
1322
|
+
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.";
|
|
1323
|
+
};
|
|
1324
|
+
readonly pending_actions: {
|
|
1325
|
+
readonly type: "array";
|
|
1326
|
+
readonly items: {
|
|
1327
|
+
readonly type: "string";
|
|
1328
|
+
readonly example: "signup-payment-method";
|
|
1329
|
+
readonly enum: readonly ["signup-billing-address", "signup-payment-method", "signup-invite-team", "signup-create-cluster"];
|
|
1330
|
+
};
|
|
1331
|
+
readonly description: "List of pending actions that the user needs to complete. Used in Cloudfleet console to guide the user through the onboarding process.";
|
|
1332
|
+
};
|
|
1333
|
+
readonly status: {
|
|
1334
|
+
readonly type: "string";
|
|
1335
|
+
readonly description: "Status of the organization. Can be `active` or `closed`, or `suspended`.";
|
|
1336
|
+
readonly enum: readonly ["active", "closed", "suspended"];
|
|
1337
|
+
};
|
|
1338
|
+
};
|
|
1339
|
+
readonly required: readonly ["date_created", "contactInfo", "quota"];
|
|
1340
|
+
readonly additionalProperties: false;
|
|
1341
|
+
};
|
|
1342
|
+
export declare const PaymentMethodSchema: {
|
|
1343
|
+
readonly type: "object";
|
|
1344
|
+
readonly properties: {
|
|
1345
|
+
readonly id: {
|
|
1346
|
+
readonly type: "string";
|
|
1347
|
+
readonly format: "uuid";
|
|
1348
|
+
readonly description: "Unique identifier of the organization. UUID v4 string in canonical form.";
|
|
1349
|
+
readonly example: "e94d30ec-a2dd-4dcb-832c-ac2be144ba91";
|
|
1350
|
+
};
|
|
1351
|
+
readonly setup: {
|
|
1352
|
+
readonly type: "boolean";
|
|
1353
|
+
readonly description: "Whether organization payment method was set up and ready to use for payments.";
|
|
1354
|
+
readonly example: true;
|
|
1355
|
+
};
|
|
1356
|
+
readonly type: {
|
|
1357
|
+
readonly type: "string";
|
|
1358
|
+
readonly nullable: true;
|
|
1359
|
+
readonly description: "Payment method type type. Only `card` payments supported at the moment.";
|
|
1360
|
+
readonly example: "card";
|
|
1361
|
+
readonly enum: readonly ["card"];
|
|
1362
|
+
};
|
|
1363
|
+
readonly last4: {
|
|
1364
|
+
readonly type: "string";
|
|
1365
|
+
readonly nullable: true;
|
|
1366
|
+
readonly description: "Last 4 digits of the payment card number.";
|
|
1367
|
+
readonly example: "4242";
|
|
1368
|
+
};
|
|
1369
|
+
readonly exp_month: {
|
|
1370
|
+
readonly type: "integer";
|
|
1371
|
+
readonly minimum: 1;
|
|
1372
|
+
readonly maximum: 12;
|
|
1373
|
+
readonly nullable: true;
|
|
1374
|
+
readonly description: "Two-digit number representing the card's expiration month.";
|
|
1375
|
+
readonly example: "12";
|
|
1376
|
+
};
|
|
1377
|
+
readonly exp_year: {
|
|
1378
|
+
readonly type: "integer";
|
|
1379
|
+
readonly minimum: 2024;
|
|
1380
|
+
readonly nullable: true;
|
|
1381
|
+
readonly description: "Four-digit number representing the card's expiration year.";
|
|
1382
|
+
readonly example: "2028";
|
|
1383
|
+
};
|
|
1384
|
+
readonly brand: {
|
|
1385
|
+
readonly type: "string";
|
|
1386
|
+
readonly nullable: true;
|
|
1387
|
+
readonly description: "Payment card brand. Can be `amex`, `diners`, `discover`, `eftpos_au`, `jcb`, `mastercard`, `unionpay`, `visa`, or `unknown`.";
|
|
1388
|
+
readonly example: "visa";
|
|
1389
|
+
readonly enum: readonly ["amex", "diners", "discover", "eftpos_au", "jcb", "mastercard", "unionpay", "visa", "unknown"];
|
|
1390
|
+
};
|
|
1391
|
+
};
|
|
1392
|
+
readonly required: readonly ["id", "setup", "type", "last4", "exp_month", "exp_year", "brand"];
|
|
1393
|
+
readonly additionalProperties: false;
|
|
1394
|
+
};
|
|
1395
|
+
export declare const TokenSchema: {
|
|
1396
|
+
readonly type: "object";
|
|
1397
|
+
readonly properties: {
|
|
1398
|
+
readonly id: {
|
|
1399
|
+
readonly type: "string";
|
|
1400
|
+
readonly description: "Generated unique identifier of the access token.";
|
|
1401
|
+
readonly example: "7kUZnH7nnKUFfvc4NK2KQF";
|
|
1402
|
+
};
|
|
1403
|
+
readonly secret: {
|
|
1404
|
+
readonly type: "string";
|
|
1405
|
+
readonly format: "uuid";
|
|
1406
|
+
readonly description: "Access token secret. Unmasked only during creation.";
|
|
1407
|
+
readonly example: "vq4SCMBsrgmBxbax80WDXuXoFNZAckI8";
|
|
1408
|
+
};
|
|
1409
|
+
readonly name: {
|
|
1410
|
+
readonly type: "string";
|
|
1411
|
+
readonly description: "Human readable access token name.";
|
|
1412
|
+
readonly example: "CI/CD token";
|
|
1413
|
+
};
|
|
1414
|
+
readonly date_created: {
|
|
1415
|
+
readonly type: "string";
|
|
1416
|
+
readonly format: "date-time";
|
|
1417
|
+
readonly description: "Creationg date of the access token. ISO 8601 date string in UTC timezone";
|
|
1418
|
+
readonly example: "2023-12-20T13:53:32.000Z";
|
|
1419
|
+
};
|
|
1420
|
+
readonly role: {
|
|
1421
|
+
readonly type: "string";
|
|
1422
|
+
readonly description: "Role assumed by the token.";
|
|
1423
|
+
readonly enum: readonly ["Administrator", "User"];
|
|
1424
|
+
};
|
|
1425
|
+
};
|
|
1426
|
+
readonly required: readonly ["date_created"];
|
|
1427
|
+
readonly additionalProperties: false;
|
|
1428
|
+
};
|
|
1429
|
+
export declare const UsageSchema: {
|
|
1430
|
+
readonly type: "object";
|
|
1431
|
+
readonly properties: {
|
|
1432
|
+
readonly id: {
|
|
1433
|
+
readonly type: "string";
|
|
1434
|
+
readonly format: "uuid";
|
|
1435
|
+
readonly description: "Unique identifier of the Usage object, equal to subscription id of the task . UUID v4 string in canonical form";
|
|
1436
|
+
readonly example: "8897e84c-2ba1-42fa-9d35-964c80a4ff0f";
|
|
1437
|
+
};
|
|
1438
|
+
readonly task_id: {
|
|
1439
|
+
readonly type: "string";
|
|
1440
|
+
readonly format: "uuid";
|
|
1441
|
+
readonly description: "Unique identifier of the project. UUID v4 string in canonical form";
|
|
1442
|
+
readonly example: "415026b6-f00f-44f8-968d-fc6ef4d0fc6d";
|
|
1443
|
+
};
|
|
1444
|
+
readonly unit: {
|
|
1445
|
+
readonly type: "string";
|
|
1446
|
+
readonly description: "Unit of measurement. E.g. GiB, seconds, etc";
|
|
1447
|
+
readonly example: "second";
|
|
1448
|
+
};
|
|
1449
|
+
readonly amount: {
|
|
1450
|
+
readonly type: "number";
|
|
1451
|
+
readonly format: "float";
|
|
1452
|
+
};
|
|
1453
|
+
};
|
|
1454
|
+
readonly required: readonly ["id", "task_id", "unit", "amount"];
|
|
1455
|
+
readonly additionalProperties: false;
|
|
1456
|
+
};
|
|
1457
|
+
export declare const UserSchema: {
|
|
1458
|
+
readonly type: "object";
|
|
1459
|
+
readonly properties: {
|
|
1460
|
+
readonly id: {
|
|
1461
|
+
readonly type: "string";
|
|
1462
|
+
readonly format: "uuid";
|
|
1463
|
+
readonly description: "Unique identifier of the user. UUID v4 string in canonical form";
|
|
1464
|
+
readonly example: "e94d30ec-a2dd-4dcb-832c-ac2be144ba91";
|
|
1465
|
+
};
|
|
1466
|
+
readonly date_created: {
|
|
1467
|
+
readonly type: "string";
|
|
1468
|
+
readonly format: "date-time";
|
|
1469
|
+
readonly description: "Creationg date of the user. ISO 8601 date string in UTC timezone";
|
|
1470
|
+
readonly example: "2023-11-02T16:08:14.338Z";
|
|
1471
|
+
};
|
|
1472
|
+
readonly email: {
|
|
1473
|
+
readonly type: "string";
|
|
1474
|
+
readonly format: "email";
|
|
1475
|
+
readonly description: "User email address.";
|
|
1476
|
+
readonly example: "email@example.com";
|
|
1477
|
+
};
|
|
1478
|
+
readonly first_name: {
|
|
1479
|
+
readonly type: "string";
|
|
1480
|
+
readonly description: "User first name.";
|
|
1481
|
+
readonly example: "John";
|
|
1482
|
+
};
|
|
1483
|
+
readonly last_name: {
|
|
1484
|
+
readonly type: "string";
|
|
1485
|
+
readonly description: "User last name.";
|
|
1486
|
+
readonly example: "Doe";
|
|
1487
|
+
};
|
|
1488
|
+
readonly role: {
|
|
1489
|
+
readonly type: "string";
|
|
1490
|
+
readonly description: "User role. Can be 'Administrator', 'User'.";
|
|
1491
|
+
readonly example: "User";
|
|
1492
|
+
readonly enum: readonly ["Administrator", "User"];
|
|
1493
|
+
};
|
|
1494
|
+
readonly cluster_permissions: {
|
|
1495
|
+
readonly type: "array";
|
|
1496
|
+
readonly items: {
|
|
1497
|
+
readonly type: "object";
|
|
1498
|
+
readonly properties: {
|
|
1499
|
+
readonly cluster_id: {
|
|
1500
|
+
readonly type: "string";
|
|
1501
|
+
readonly format: "uuid";
|
|
1502
|
+
readonly description: "Unique identifier of the cluster. UUID v4 string in canonical form";
|
|
1503
|
+
readonly example: "035ce46d-44d8-4e58-a8a2-b0192d1c27df";
|
|
1504
|
+
};
|
|
1505
|
+
readonly permissions: {
|
|
1506
|
+
readonly type: "string";
|
|
1507
|
+
readonly description: "User permissions to access the cluster. Can be `readwrite` or `readonly`.";
|
|
1508
|
+
readonly example: "readwrite";
|
|
1509
|
+
readonly enum: readonly ["readwrite", "readonly"];
|
|
1510
|
+
};
|
|
1511
|
+
};
|
|
1512
|
+
readonly required: readonly ["cluster_id", "permissions"];
|
|
1513
|
+
readonly additionalProperties: false;
|
|
1514
|
+
};
|
|
1515
|
+
};
|
|
1516
|
+
readonly status: {
|
|
1517
|
+
readonly type: "string";
|
|
1518
|
+
readonly description: "Status of the user. Can be `active` or `inactive`. Inactive users cannot log in or manage organization resources.";
|
|
1519
|
+
readonly example: "active";
|
|
1520
|
+
readonly enum: readonly ["active", "inactive"];
|
|
1521
|
+
};
|
|
1522
|
+
};
|
|
1523
|
+
readonly required: readonly ["date_created"];
|
|
1524
|
+
readonly additionalProperties: false;
|
|
1525
|
+
};
|
|
1526
|
+
//# sourceMappingURL=schemas.gen.d.ts.map
|