@cloudfleet/sdk 0.0.1-42b710c → 0.0.1-48f3efe

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.
@@ -67,11 +67,209 @@ export const BillingContactSchema = {
67
67
  type: 'string',
68
68
  description: 'Last name of the billing contact person.',
69
69
  example: 'Doe'
70
+ },
71
+ tax_id: {
72
+ type: 'string',
73
+ nullable: true,
74
+ description: 'Tax ID of the organization.',
75
+ example: 'DE123456789'
76
+ },
77
+ tax_id_type: {
78
+ type: 'string',
79
+ nullable: true,
80
+ description: 'Type of the tax ID.',
81
+ example: 'de_vat',
82
+ enum: ['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', '']
70
83
  }
71
84
  },
72
85
  required: ['email', 'first_name', 'last_name'],
73
86
  additionalProperties: false
74
87
  };
88
+ export const BillingCreditsSchema = {
89
+ type: 'object',
90
+ properties: {
91
+ id: {
92
+ type: 'string',
93
+ description: 'Generated unique identifier of the promotional code.',
94
+ example: '7kUZnH7nnKUFfvc4NK2KQF'
95
+ },
96
+ date_created: {
97
+ type: 'string',
98
+ format: 'date-time',
99
+ description: 'Date of the credit application. ISO 8601 date string in the UTC timezone.',
100
+ example: '2023-12-20T13:53:32.000Z'
101
+ },
102
+ code: {
103
+ type: 'string',
104
+ description: 'Promotional code used by the customer.',
105
+ example: 'VQ4SCMB'
106
+ },
107
+ description: {
108
+ type: 'string',
109
+ description: 'Description of the promotional code.',
110
+ example: '10% off on all products'
111
+ },
112
+ products: {
113
+ type: 'array',
114
+ items: {
115
+ type: 'string'
116
+ },
117
+ description: 'List of product SKUs that the promotional code can be used on.',
118
+ example: ['cfke_controlplane', 'cfke_connected_nodes', 'infra_compute', 'infra_storage', 'infra_loadbalancing', 'infra_traffic', 'cfcr_storage']
119
+ },
120
+ type: {
121
+ type: 'string',
122
+ description: 'Type of the promotional code.',
123
+ example: 'credit',
124
+ enum: ['credit', 'discount']
125
+ },
126
+ value: {
127
+ type: 'number',
128
+ format: 'float',
129
+ description: 'Value of the promotional code.',
130
+ example: 10
131
+ },
132
+ billing_period: {
133
+ type: 'string',
134
+ format: 'date-time',
135
+ description: 'Date of the billing cycle. An ISO 8601 date string in the UTC timezone.',
136
+ example: '2023-12-20T13:53:32.000Z'
137
+ },
138
+ value_remaining: {
139
+ type: 'number',
140
+ format: 'float',
141
+ description: 'Value of the promotional code.',
142
+ example: 10
143
+ }
144
+ },
145
+ required: ['date_created', 'code', 'type', 'value', 'billing_period'],
146
+ additionalProperties: false
147
+ };
148
+ export const ChartCreateInputSchema = {
149
+ type: 'object',
150
+ properties: {
151
+ values: {
152
+ type: 'string',
153
+ description: 'Values to be used in the chart encoded as a JSON string.'
154
+ },
155
+ version_channel: {
156
+ type: 'string',
157
+ 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-]+)*))?$',
158
+ description: 'Desired version range or channel for the chart.',
159
+ example: '2.x.x-cfke.x'
160
+ },
161
+ name: {
162
+ type: 'string',
163
+ maxLength: 63,
164
+ minLength: 1,
165
+ pattern: '^[a-z0-9]([-a-z0-9]*[a-z0-9])?$',
166
+ description: 'Unique identifier of the chart deployment aka name of the helm release.',
167
+ example: 'postgresql-0'
168
+ },
169
+ namespace: {
170
+ type: 'string',
171
+ maxLength: 63,
172
+ minLength: 1,
173
+ pattern: '^[a-z0-9]([-a-z0-9]*[a-z0-9])?$',
174
+ description: 'Namespace of the chart deployment',
175
+ example: 'default'
176
+ },
177
+ chart: {
178
+ type: 'string',
179
+ maxLength: 63,
180
+ minLength: 1,
181
+ pattern: '^[a-z0-9]([-a-z0-9]*[a-z0-9])?$',
182
+ description: 'Name of the chart listing',
183
+ example: 'postgresql'
184
+ }
185
+ },
186
+ required: ['values', 'version_channel', 'name', 'namespace', 'chart'],
187
+ additionalProperties: false
188
+ };
189
+ export const ChartSchema = {
190
+ type: 'object',
191
+ properties: {
192
+ values: {
193
+ type: 'string',
194
+ description: 'Values to be used in the chart encoded as a JSON string.'
195
+ },
196
+ version_channel: {
197
+ type: 'string',
198
+ 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-]+)*))?$',
199
+ description: 'Desired version range or channel for the chart.',
200
+ example: '2.x.x-cfke.x'
201
+ },
202
+ name: {
203
+ type: 'string',
204
+ maxLength: 63,
205
+ minLength: 1,
206
+ pattern: '^[a-z0-9]([-a-z0-9]*[a-z0-9])?$',
207
+ description: 'Unique identifier of the chart deployment aka name of the helm release.',
208
+ example: 'postgresql-0'
209
+ },
210
+ namespace: {
211
+ type: 'string',
212
+ maxLength: 63,
213
+ minLength: 1,
214
+ pattern: '^[a-z0-9]([-a-z0-9]*[a-z0-9])?$',
215
+ description: 'Namespace of the chart deployment',
216
+ example: 'default'
217
+ },
218
+ chart: {
219
+ type: 'string',
220
+ maxLength: 63,
221
+ minLength: 1,
222
+ pattern: '^[a-z0-9]([-a-z0-9]*[a-z0-9])?$',
223
+ description: 'Name of the chart listing',
224
+ example: 'postgresql'
225
+ },
226
+ status: {
227
+ type: 'string',
228
+ description: 'Status of the chart deployment.',
229
+ example: 'active',
230
+ enum: ['InstallSucceeded', 'InstallFailed', 'UpgradeSucceeded', 'UpgradeFailed', 'TestSucceeded', 'TestFailed', 'RollbackSucceeded', 'RollbackFailed', 'UninstallSucceeded', 'UninstallFailed', 'ArtifactFailed', 'DependencyNotReady', 'Progressing', 'SourceNotReady']
231
+ },
232
+ version_current: {
233
+ type: 'string',
234
+ description: 'Current version of the chart deployment.',
235
+ example: '2.1.33-cfke.11'
236
+ },
237
+ created_at: {
238
+ type: 'string',
239
+ description: 'Creation date and time of the chart deployment.',
240
+ example: '2024-09-12T09:11:27Z'
241
+ },
242
+ updated_at: {
243
+ type: 'string',
244
+ description: 'Last update date and time of the chart deployment.',
245
+ example: '2024-09-12T09:11:27Z'
246
+ },
247
+ ready: {
248
+ type: 'boolean',
249
+ description: 'Indicates if the chart deployment is ready to be used.',
250
+ example: true
251
+ }
252
+ },
253
+ required: ['values', 'version_channel', 'name', 'namespace', 'chart', 'status', 'version_current', 'created_at', 'updated_at', 'ready'],
254
+ additionalProperties: false
255
+ };
256
+ export const ChartUpdateInputSchema = {
257
+ type: 'object',
258
+ properties: {
259
+ values: {
260
+ type: 'string',
261
+ description: 'Values to be used in the chart encoded as a JSON string.'
262
+ },
263
+ version_channel: {
264
+ type: 'string',
265
+ 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-]+)*))?$',
266
+ description: 'Desired version range or channel for the chart.',
267
+ example: '2.x.x-cfke.x'
268
+ }
269
+ },
270
+ required: ['values', 'version_channel'],
271
+ additionalProperties: false
272
+ };
75
273
  export const ClusterCreateInputSchema = {
76
274
  type: 'object',
77
275
  properties: {
@@ -322,34 +520,19 @@ export const FleetCreateInputSchema = {
322
520
  additionalProperties: false
323
521
  },
324
522
  hetzner: {
325
- oneOf: [
326
- {
327
- type: 'object',
328
- properties: {
329
- enabled: {
330
- type: 'boolean',
331
- default: true
332
- },
333
- apiKey: {
334
- type: 'string'
335
- }
336
- },
337
- additionalProperties: false
523
+ type: 'object',
524
+ properties: {
525
+ enabled: {
526
+ type: 'boolean',
527
+ default: true
338
528
  },
339
- {
340
- type: 'object',
341
- properties: {
342
- apiKey: {
343
- type: 'string'
344
- },
345
- enabled: {
346
- type: 'boolean',
347
- default: true
348
- }
349
- },
350
- additionalProperties: false
529
+ apiKey: {
530
+ type: 'string',
531
+ description: 'Hetzner Cloud API key with read / write access'
351
532
  }
352
- ]
533
+ },
534
+ required: ['apiKey'],
535
+ additionalProperties: false
353
536
  },
354
537
  aws: {
355
538
  type: 'object',
@@ -373,14 +556,9 @@ export const FleetCreateInputSchema = {
373
556
  pattern: '^[a-z0-9]([-a-z0-9]*[a-z0-9])?$',
374
557
  description: 'Unique identifier of the kubernetes fleet.',
375
558
  example: 'new-clouds-fleet'
376
- },
377
- type: {
378
- type: 'string',
379
- description: 'Specifies the fleet type: infrastructure managed by Cloudfleet or Connected Fleets.',
380
- enum: ['managed', 'connected']
381
559
  }
382
560
  },
383
- required: ['id', 'type'],
561
+ required: ['id'],
384
562
  additionalProperties: false
385
563
  };
386
564
  export const FleetSchema = {
@@ -416,34 +594,19 @@ export const FleetSchema = {
416
594
  additionalProperties: false
417
595
  },
418
596
  hetzner: {
419
- oneOf: [
420
- {
421
- type: 'object',
422
- properties: {
423
- enabled: {
424
- type: 'boolean',
425
- default: true
426
- },
427
- apiKey: {
428
- type: 'string'
429
- }
430
- },
431
- additionalProperties: false
597
+ type: 'object',
598
+ properties: {
599
+ enabled: {
600
+ type: 'boolean',
601
+ default: true
432
602
  },
433
- {
434
- type: 'object',
435
- properties: {
436
- apiKey: {
437
- type: 'string'
438
- },
439
- enabled: {
440
- type: 'boolean',
441
- default: true
442
- }
443
- },
444
- additionalProperties: false
603
+ apiKey: {
604
+ type: 'string',
605
+ description: 'Hetzner Cloud API key with read / write access'
445
606
  }
446
- ]
607
+ },
608
+ required: ['apiKey'],
609
+ additionalProperties: false
447
610
  },
448
611
  aws: {
449
612
  type: 'object',
@@ -467,14 +630,9 @@ export const FleetSchema = {
467
630
  pattern: '^[a-z0-9]([-a-z0-9]*[a-z0-9])?$',
468
631
  description: 'Unique identifier of the kubernetes fleet.',
469
632
  example: 'new-clouds-fleet'
470
- },
471
- type: {
472
- type: 'string',
473
- description: 'Specifies the fleet type: infrastructure managed by Cloudfleet or Connected Fleets.',
474
- enum: ['managed', 'connected']
475
633
  }
476
634
  },
477
- required: ['id', 'type'],
635
+ required: ['id'],
478
636
  additionalProperties: false
479
637
  };
480
638
  export const FleetUpdateInputSchema = {
@@ -510,34 +668,19 @@ export const FleetUpdateInputSchema = {
510
668
  additionalProperties: false
511
669
  },
512
670
  hetzner: {
513
- oneOf: [
514
- {
515
- type: 'object',
516
- properties: {
517
- enabled: {
518
- type: 'boolean',
519
- default: true
520
- },
521
- apiKey: {
522
- type: 'string'
523
- }
524
- },
525
- additionalProperties: false
671
+ type: 'object',
672
+ properties: {
673
+ enabled: {
674
+ type: 'boolean',
675
+ default: true
526
676
  },
527
- {
528
- type: 'object',
529
- properties: {
530
- apiKey: {
531
- type: 'string'
532
- },
533
- enabled: {
534
- type: 'boolean',
535
- default: true
536
- }
537
- },
538
- additionalProperties: false
677
+ apiKey: {
678
+ type: 'string',
679
+ description: 'Hetzner Cloud API key with read / write access'
539
680
  }
540
- ]
681
+ },
682
+ required: ['apiKey'],
683
+ additionalProperties: false
541
684
  },
542
685
  aws: {
543
686
  type: 'object',
@@ -948,6 +1091,89 @@ export const InvoiceSchema = {
948
1091
  },
949
1092
  additionalProperties: false
950
1093
  };
1094
+ export const MarketplaceListingSchema = {
1095
+ type: 'object',
1096
+ properties: {
1097
+ id: {
1098
+ type: 'string',
1099
+ maxLength: 63,
1100
+ minLength: 1,
1101
+ pattern: '^[a-z0-9]([-a-z0-9]*[a-z0-9])?$',
1102
+ description: 'Id of the chart listing',
1103
+ example: 'portworx-enterprise-disaster-recovery-baremetal'
1104
+ },
1105
+ name: {
1106
+ type: 'string',
1107
+ description: 'Name of the chart listing',
1108
+ example: 'Portworx Enterprise + Disaster Recovery - Baremetal'
1109
+ },
1110
+ developer: {
1111
+ type: 'string',
1112
+ description: 'Author of the chart listing',
1113
+ example: 'Portworx'
1114
+ },
1115
+ description: {
1116
+ type: 'string',
1117
+ description: 'Short description of the chart listing',
1118
+ example: 'Run Kubernetes with unmatched scalability, availability, and self-service access to any storage'
1119
+ },
1120
+ logoUrl: {
1121
+ type: 'string',
1122
+ description: 'Logo of the chart listing',
1123
+ example: 'https://portworx.com/wp-content/themes/portworx/assets/images/header/portworx-logo.png'
1124
+ },
1125
+ longDescription: {
1126
+ type: 'string',
1127
+ description: 'Long description of the chart listing',
1128
+ example: 'Portworx-Enterprise is the complete multi-cloud ready Kubernetes storage platform for running mission-critical apps in production....'
1129
+ },
1130
+ categories: {
1131
+ type: 'array',
1132
+ items: {
1133
+ type: 'string',
1134
+ example: 'AI & Machine Learning'
1135
+ },
1136
+ description: 'Tags of the chart'
1137
+ },
1138
+ version_channels: {
1139
+ type: 'array',
1140
+ items: {
1141
+ type: 'string',
1142
+ 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-]+)*))?$',
1143
+ description: 'Version of the chart.',
1144
+ example: '2.x.x-cfke.x'
1145
+ }
1146
+ },
1147
+ value_schemas: {
1148
+ type: 'array',
1149
+ items: {
1150
+ type: 'object',
1151
+ properties: {
1152
+ version: {
1153
+ type: 'string',
1154
+ 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-]+)*))?$',
1155
+ description: 'Version of the chart.',
1156
+ example: '2.1.1-cfke.123'
1157
+ },
1158
+ schema: {
1159
+ type: 'string',
1160
+ description: 'Schema of the chart values. JSON Schema as string'
1161
+ },
1162
+ placeholder: {
1163
+ type: 'string',
1164
+ description: 'Schema of the chart values',
1165
+ example: `foo: 1
1166
+ bar: example`
1167
+ }
1168
+ },
1169
+ required: ['version', 'schema', 'placeholder'],
1170
+ additionalProperties: false
1171
+ }
1172
+ }
1173
+ },
1174
+ required: ['id', 'name', 'developer', 'description', 'logoUrl', 'longDescription', 'categories', 'version_channels', 'value_schemas'],
1175
+ additionalProperties: false
1176
+ };
951
1177
  export const OrganizationCreateInputSchema = {
952
1178
  type: 'object',
953
1179
  properties: {
@@ -1037,12 +1263,6 @@ export const OrganizationSchema = {
1037
1263
  description: 'Maximum number of fleets that can be created per cluster.',
1038
1264
  example: 999
1039
1265
  },
1040
- managed_fleets_cpu_max: {
1041
- type: 'integer',
1042
- minimum: 0,
1043
- description: 'Maximum number of CPU cores per managed fleet.',
1044
- example: 999
1045
- },
1046
1266
  cluster_tiers: {
1047
1267
  type: 'array',
1048
1268
  items: {
@@ -1084,7 +1304,7 @@ export const OrganizationSchema = {
1084
1304
  description: 'List of CFKE control plane versions available for the organization.'
1085
1305
  }
1086
1306
  },
1087
- required: ['basic_clusters_max', 'basic_clusters_available', 'pro_clusters_max', 'pro_clusters_available', 'fleets_max', 'managed_fleets_cpu_max', 'cluster_tiers', 'regions', 'versions'],
1307
+ required: ['basic_clusters_max', 'basic_clusters_available', 'pro_clusters_max', 'pro_clusters_available', 'fleets_max', 'cluster_tiers', 'regions', 'versions'],
1088
1308
  additionalProperties: false,
1089
1309
  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.'
1090
1310
  },
@@ -1246,13 +1466,13 @@ export const UsageSchema = {
1246
1466
  type: 'string',
1247
1467
  description: 'Tier of the cluster.',
1248
1468
  example: 'pro',
1249
- enum: ['']
1469
+ enum: ['basic', 'pro', '']
1250
1470
  },
1251
1471
  product: {
1252
1472
  type: 'string',
1253
1473
  description: 'The product the usage is associated with',
1254
- example: 'cfke_infra_compute',
1255
- enum: ['cfke_infra_compute', 'cfke_nodes', 'cfke_controlplane']
1474
+ example: 'cfke_controlplane',
1475
+ enum: ['cfke_controlplane', 'cfke_connected_nodes', 'infra_compute', 'infra_storage', 'infra_loadbalancing', 'infra_traffic', 'cfcr_storage']
1256
1476
  },
1257
1477
  node_name: {
1258
1478
  type: 'string',
@@ -1420,28 +1640,6 @@ export const UserSchema = {
1420
1640
  format: 'date-time',
1421
1641
  description: 'Creation date of the user. ISO 8601 date string in UTC timezone',
1422
1642
  example: '2023-11-02T16:08:14.338Z'
1423
- },
1424
- cluster_permissions: {
1425
- type: 'array',
1426
- items: {
1427
- type: 'object',
1428
- properties: {
1429
- cluster_id: {
1430
- type: 'string',
1431
- format: 'uuid',
1432
- description: 'Unique identifier of the cluster. UUID v4 string in canonical form',
1433
- example: '035ce46d-44d8-4e58-a8a2-b0192d1c27df'
1434
- },
1435
- permissions: {
1436
- type: 'string',
1437
- description: 'User permissions to access the cluster. Can be `readwrite` or `readonly`.',
1438
- example: 'readwrite',
1439
- enum: ['readwrite', 'readonly']
1440
- }
1441
- },
1442
- required: ['cluster_id', 'permissions'],
1443
- additionalProperties: false
1444
- }
1445
1643
  }
1446
1644
  },
1447
1645
  required: ['email', 'first_name', 'last_name', 'role', 'status', 'id', 'date_created'],