@scaleway/sdk 1.4.0 → 1.6.0

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.
Files changed (52) hide show
  1. package/dist/api/account/index.js +0 -2
  2. package/dist/api/applesilicon/v1alpha1/api.gen.js +1 -1
  3. package/dist/api/baremetal/index.js +2 -2
  4. package/dist/api/baremetal/v1/api.gen.js +2 -2
  5. package/dist/api/billing/index.js +2 -0
  6. package/dist/api/billing/v2alpha1/api.gen.js +52 -0
  7. package/dist/api/billing/v2alpha1/index.gen.js +3 -0
  8. package/dist/api/billing/v2alpha1/marshalling.gen.js +52 -0
  9. package/dist/api/cockpit/v1beta1/api.gen.js +62 -7
  10. package/dist/api/cockpit/v1beta1/marshalling.gen.js +46 -2
  11. package/dist/api/container/v1beta1/api.gen.js +1 -1
  12. package/dist/api/flexibleip/v1alpha1/api.gen.js +8 -1
  13. package/dist/api/function/v1beta1/api.gen.js +1 -1
  14. package/dist/api/function/v1beta1/marshalling.gen.js +3 -20
  15. package/dist/api/iam/v1alpha1/api.gen.js +7 -0
  16. package/dist/api/iam/v1alpha1/validation-rules.gen.js +10 -10
  17. package/dist/api/instance/index.js +2 -2
  18. package/dist/api/instance/v1/api.gen.js +86 -67
  19. package/dist/api/iot/v1/api.gen.js +1 -1
  20. package/dist/api/k8s/index.js +2 -2
  21. package/dist/api/k8s/v1/api.gen.js +14 -2
  22. package/dist/api/k8s/v1/marshalling.gen.js +6 -1
  23. package/dist/api/lb/index.js +2 -2
  24. package/dist/api/lb/v1/api.gen.js +2 -2
  25. package/dist/api/lb/v1/marshalling.gen.js +33 -19
  26. package/dist/api/mnq/v1alpha1/api.gen.js +1 -1
  27. package/dist/api/rdb/v1/api.gen.js +11 -11
  28. package/dist/api/redis/v1/api.gen.js +89 -27
  29. package/dist/api/redis/v1/marshalling.gen.js +2 -0
  30. package/dist/api/registry/v1/api.gen.js +1 -1
  31. package/dist/api/secret/v1alpha1/api.gen.js +44 -20
  32. package/dist/api/secret/v1alpha1/marshalling.gen.js +14 -2
  33. package/dist/api/tem/v1alpha1/api.gen.js +26 -14
  34. package/dist/api/vpc/v1/api.gen.js +2 -2
  35. package/dist/api/vpcgw/v1/api.gen.js +1 -1
  36. package/dist/api/webhosting/v1alpha1/api.gen.js +4 -3
  37. package/dist/helpers/is-response.js +10 -0
  38. package/dist/index.cjs +625 -366
  39. package/dist/index.d.ts +1444 -1106
  40. package/dist/index.js +44 -42
  41. package/dist/internal/async/interval-retrier.js +6 -0
  42. package/dist/internal/logger/level-resolver.js +3 -3
  43. package/dist/scw/client-ini-factory.js +6 -0
  44. package/dist/scw/client-ini-profile.js +18 -0
  45. package/dist/scw/client-settings.js +12 -0
  46. package/dist/scw/constants.js +1 -1
  47. package/dist/scw/errors/standard/quotas-exceeded-error.js +6 -0
  48. package/dist/scw/fetch/response-parser.js +2 -1
  49. package/package.json +2 -2
  50. package/dist/api/account/v2alpha1/api.gen.js +0 -85
  51. package/dist/api/account/v2alpha1/index.js +0 -1
  52. package/dist/api/account/v2alpha1/marshalling.gen.js +0 -57
package/dist/index.cjs CHANGED
@@ -2,14 +2,14 @@
2
2
 
3
3
  // eslint-disable-next-line eslint-comments/disable-enable-pair
4
4
  /* eslint-disable @typescript-eslint/naming-convention */
5
- let LevelResolver;
6
- (function (LevelResolver) {
5
+ let LevelResolver = /*#__PURE__*/function (LevelResolver) {
7
6
  LevelResolver[LevelResolver["silent"] = 0] = "silent";
8
7
  LevelResolver[LevelResolver["error"] = 1] = "error";
9
8
  LevelResolver[LevelResolver["warn"] = 2] = "warn";
10
9
  LevelResolver[LevelResolver["info"] = 3] = "info";
11
10
  LevelResolver[LevelResolver["debug"] = 4] = "debug";
12
- })(LevelResolver || (LevelResolver = {}));
11
+ return LevelResolver;
12
+ }({});
13
13
  const shouldLog = (currentLevel, level) => LevelResolver[level] <= currentLevel;
14
14
 
15
15
  /**
@@ -138,6 +138,24 @@ const isURL = str => {
138
138
  return url.protocol === 'http:' || url.protocol === 'https:';
139
139
  };
140
140
 
141
+ /**
142
+ * Holds access key and secret key.
143
+ *
144
+ * @public
145
+ */
146
+
147
+ /**
148
+ * Holds default values of a Scaleway profile.
149
+ *
150
+ * @public
151
+ */
152
+
153
+ /**
154
+ * Holds values of a Scaleway profile.
155
+ *
156
+ * @public
157
+ */
158
+
141
159
  /**
142
160
  * Verifies that the payload contains both the accessKey and the secretKey.
143
161
  *
@@ -232,6 +250,12 @@ const obfuscateAuthHeadersEntry = ([name, value]) => {
232
250
  return [name, value];
233
251
  };
234
252
 
253
+ /**
254
+ * A factory to build {@link Settings}.
255
+ *
256
+ * @public
257
+ */
258
+
235
259
  /**
236
260
  * Instantiates the SDK from a configuration {@link Profile}.
237
261
  *
@@ -327,6 +351,18 @@ const withUserAgentSuffix = userAgent => settings => ({
327
351
  userAgent: settings.userAgent ? `${settings.userAgent} ${userAgent}` : userAgent
328
352
  });
329
353
 
354
+ /**
355
+ * Holds default values of settings.
356
+ *
357
+ * @public
358
+ */
359
+
360
+ /**
361
+ * Settings hold the values of all client options.
362
+ *
363
+ * @public
364
+ */
365
+
330
366
  /**
331
367
  * Validates the content of a {@link Settings} object.
332
368
  *
@@ -390,7 +426,7 @@ const assertValidSettings = obj => {
390
426
  }
391
427
  };
392
428
 
393
- const version = 'v1.3.0';
429
+ const version = 'v1.5.0';
394
430
  const userAgent = `scaleway-sdk-js/${version}`;
395
431
 
396
432
  const isBrowser = () => typeof window !== 'undefined' && typeof window.document !== 'undefined';
@@ -528,6 +564,15 @@ ${await dumpResponse(response)}
528
564
  return response;
529
565
  };
530
566
 
567
+ /**
568
+ * Validates an object is of type Response without using `instanceof`.
569
+ *
570
+ * @remarks Check issue #509 for more context.
571
+ *
572
+ * @internal
573
+ */
574
+ const isResponse = obj => obj !== null && obj !== undefined && typeof obj === 'object' && 'status' in obj && typeof obj.status === 'number' && 'statusText' in obj && typeof obj.statusText === 'string' && 'headers' in obj && typeof obj.headers === 'object' && 'body' in obj && typeof obj.body !== 'undefined';
575
+
531
576
  /**
532
577
  * Validates an unknown object is a JSON Object.
533
578
  *
@@ -683,6 +728,12 @@ class InvalidArgumentsError extends ScalewayError {
683
728
  * @public
684
729
  */
685
730
 
731
+ /**
732
+ * Details of an {@link QuotasExceededError} error.
733
+ *
734
+ * @public
735
+ */
736
+
686
737
  /**
687
738
  * Build the default message for {@link QuotasExceededError}.
688
739
  *
@@ -1244,7 +1295,7 @@ const fixLegacyTotalCount = (obj, headers) => {
1244
1295
  * @internal
1245
1296
  */
1246
1297
  const responseParser = (unmarshaller, responseType) => async response => {
1247
- if (!(response instanceof Response)) {
1298
+ if (!isResponse(response)) {
1248
1299
  throw new TypeError('Invalid response object');
1249
1300
  }
1250
1301
  if (response.ok) {
@@ -1495,6 +1546,12 @@ const tryAtIntervals = async (retry, strategy, timeout = DEFAULT_TIMEOUT_SECONDS
1495
1546
  * @public
1496
1547
  */
1497
1548
 
1549
+ /**
1550
+ * The options to wait until a resource is ready.
1551
+ *
1552
+ * @public
1553
+ */
1554
+
1498
1555
  /**
1499
1556
  * Fetches resource several times until an expected condition is reached, timeouts, or throws an exception.
1500
1557
  *
@@ -1521,7 +1578,7 @@ const waitForResource = (stop, fetcher, request, options, strategy = createExpon
1521
1578
  *
1522
1579
  * @internal
1523
1580
  */
1524
- let API$p = class API {
1581
+ let API$q = class API {
1525
1582
  constructor(client) {
1526
1583
  this.client = client;
1527
1584
  }
@@ -1829,133 +1886,6 @@ const enrichForPagination = (key, fetcher, request) => {
1829
1886
  });
1830
1887
  };
1831
1888
 
1832
- // This file was automatically generated. DO NOT EDIT.
1833
- const unmarshalSSHKeyCreationInfo = data => {
1834
- if (!isJSONObject(data)) {
1835
- throw new TypeError(`Unmarshalling the type 'SSHKeyCreationInfo' failed as data isn't a dictionary.`);
1836
- }
1837
- return {
1838
- address: data.address,
1839
- countryCode: data.country_code,
1840
- userAgent: data.user_agent
1841
- };
1842
- };
1843
- const unmarshalSSHKey$1 = data => {
1844
- if (!isJSONObject(data)) {
1845
- throw new TypeError(`Unmarshalling the type 'SSHKey' failed as data isn't a dictionary.`);
1846
- }
1847
- return {
1848
- createdAt: unmarshalDate(data.created_at),
1849
- creationInfo: data.creation_info ? unmarshalSSHKeyCreationInfo(data.creation_info) : undefined,
1850
- fingerprint: data.fingerprint,
1851
- id: data.id,
1852
- name: data.name,
1853
- organizationId: data.organization_id,
1854
- projectId: data.project_id,
1855
- publicKey: data.public_key,
1856
- updatedAt: unmarshalDate(data.updated_at)
1857
- };
1858
- };
1859
- const unmarshalListSSHKeysResponse$1 = data => {
1860
- if (!isJSONObject(data)) {
1861
- throw new TypeError(`Unmarshalling the type 'ListSSHKeysResponse' failed as data isn't a dictionary.`);
1862
- }
1863
- return {
1864
- sshKeys: unmarshalArrayOfObject(data.ssh_keys, unmarshalSSHKey$1),
1865
- totalCount: data.total_count
1866
- };
1867
- };
1868
- const marshalCreateSSHKeyRequest$1 = (request, defaults) => ({
1869
- name: request.name,
1870
- public_key: request.publicKey,
1871
- ...resolveOneOf([{
1872
- default: defaults.defaultProjectId,
1873
- param: 'project_id',
1874
- value: request.projectId
1875
- }, {
1876
- default: defaults.defaultOrganizationId,
1877
- param: 'organization_id',
1878
- value: request.organizationId
1879
- }])
1880
- });
1881
- const marshalUpdateSSHKeyRequest$1 = (request, defaults) => ({
1882
- name: request.name
1883
- });
1884
-
1885
- // This file was automatically generated. DO NOT EDIT.
1886
- const jsonContentHeaders$n = {
1887
- 'Content-Type': 'application/json; charset=utf-8'
1888
- };
1889
-
1890
- /** Account API. */
1891
- class AccountV2Alpha1GenAPI extends API$p {
1892
- pageOfListSSHKeys = (request = {}) => this.client.fetch({
1893
- method: 'GET',
1894
- path: `/account/v2alpha1/ssh-keys`,
1895
- urlParams: urlParams(['name', request.name], ['order_by', request.orderBy ?? 'created_at_asc'], ['organization_id', request.organizationId ?? this.client.settings.defaultOrganizationId], ['page', request.page], ['page_size', request.pageSize ?? this.client.settings.defaultPageSize], ['project_id', request.projectId ?? this.client.settings.defaultProjectId])
1896
- }, unmarshalListSSHKeysResponse$1);
1897
-
1898
- /**
1899
- * List all SSH keys of your project
1900
- *
1901
- * @param request - The request {@link ListSSHKeysRequest}
1902
- * @returns A Promise of ListSSHKeysResponse
1903
- */
1904
- listSSHKeys = (request = {}) => enrichForPagination('sshKeys', this.pageOfListSSHKeys, request);
1905
-
1906
- /**
1907
- * Add an SSH key to your project
1908
- *
1909
- * @param request - The request {@link CreateSSHKeyRequest}
1910
- * @returns A Promise of SSHKey
1911
- */
1912
- createSSHKey = request => this.client.fetch({
1913
- body: JSON.stringify(marshalCreateSSHKeyRequest$1(request, this.client.settings)),
1914
- headers: jsonContentHeaders$n,
1915
- method: 'POST',
1916
- path: `/account/v2alpha1/ssh-keys`
1917
- }, unmarshalSSHKey$1);
1918
-
1919
- /**
1920
- * Get an SSH key from your project
1921
- *
1922
- * @param request - The request {@link GetSSHKeyRequest}
1923
- * @returns A Promise of SSHKey
1924
- */
1925
- getSSHKey = request => this.client.fetch({
1926
- method: 'GET',
1927
- path: `/account/v2alpha1/ssh-key/${validatePathParam('sshKeyId', request.sshKeyId)}`
1928
- }, unmarshalSSHKey$1);
1929
-
1930
- /**
1931
- * Update an SSH key on your project
1932
- *
1933
- * @param request - The request {@link UpdateSSHKeyRequest}
1934
- * @returns A Promise of SSHKey
1935
- */
1936
- updateSSHKey = request => this.client.fetch({
1937
- body: JSON.stringify(marshalUpdateSSHKeyRequest$1(request, this.client.settings)),
1938
- headers: jsonContentHeaders$n,
1939
- method: 'PATCH',
1940
- path: `/account/v2alpha1/ssh-key/${validatePathParam('sshKeyId', request.sshKeyId)}`
1941
- }, unmarshalSSHKey$1);
1942
-
1943
- /**
1944
- * Remove an SSH key from your project
1945
- *
1946
- * @param request - The request {@link DeleteSSHKeyRequest}
1947
- */
1948
- deleteSSHKey = request => this.client.fetch({
1949
- method: 'DELETE',
1950
- path: `/account/v2alpha1/ssh-key/${validatePathParam('sshKeyId', request.sshKeyId)}`
1951
- });
1952
- }
1953
-
1954
- var index$s = /*#__PURE__*/Object.freeze({
1955
- __proto__: null,
1956
- API: AccountV2Alpha1GenAPI
1957
- });
1958
-
1959
1889
  // This file was automatically generated. DO NOT EDIT.
1960
1890
  const unmarshalProject = data => {
1961
1891
  if (!isJSONObject(data)) {
@@ -1999,7 +1929,7 @@ const jsonContentHeaders$m = {
1999
1929
  *
2000
1930
  * User related data. This API allows you to manage projects.
2001
1931
  */
2002
- let API$o = class API extends API$p {
1932
+ let API$p = class API extends API$q {
2003
1933
  /**
2004
1934
  * Create a new Project for an Organization. Generate a new Project for an
2005
1935
  * Organization, specifying its configuration including name and description.
@@ -2073,15 +2003,14 @@ let API$o = class API extends API$p {
2073
2003
 
2074
2004
  // This file was automatically generated. DO NOT EDIT.
2075
2005
 
2076
- var index_gen$k = /*#__PURE__*/Object.freeze({
2006
+ var index_gen$l = /*#__PURE__*/Object.freeze({
2077
2007
  __proto__: null,
2078
- API: API$o
2008
+ API: API$p
2079
2009
  });
2080
2010
 
2081
- var index$r = /*#__PURE__*/Object.freeze({
2011
+ var index$s = /*#__PURE__*/Object.freeze({
2082
2012
  __proto__: null,
2083
- v2: index_gen$k,
2084
- v2alpha1: index$s
2013
+ v2: index_gen$l
2085
2014
  });
2086
2015
 
2087
2016
  // This file was automatically generated. DO NOT EDIT.
@@ -2235,7 +2164,7 @@ const jsonContentHeaders$l = {
2235
2164
  * Cisco in the U.S. and other countries and is used by Apple under license.
2236
2165
  * Scaleway is not affiliated with Apple Inc.
2237
2166
  */
2238
- let API$n = class API extends API$p {
2167
+ let API$o = class API extends API$q {
2239
2168
  /** Lists the available zones of the API. */
2240
2169
  static LOCALITIES = ['fr-par-3'];
2241
2170
 
@@ -2401,15 +2330,15 @@ let API$n = class API extends API$p {
2401
2330
 
2402
2331
  // This file was automatically generated. DO NOT EDIT.
2403
2332
 
2404
- var index_gen$j = /*#__PURE__*/Object.freeze({
2333
+ var index_gen$k = /*#__PURE__*/Object.freeze({
2405
2334
  __proto__: null,
2406
- API: API$n,
2335
+ API: API$o,
2407
2336
  SERVER_TRANSIENT_STATUSES: SERVER_TRANSIENT_STATUSES$2
2408
2337
  });
2409
2338
 
2410
- var index$q = /*#__PURE__*/Object.freeze({
2339
+ var index$r = /*#__PURE__*/Object.freeze({
2411
2340
  __proto__: null,
2412
- v1alpha1: index_gen$j
2341
+ v1alpha1: index_gen$k
2413
2342
  });
2414
2343
 
2415
2344
  // This file was automatically generated. DO NOT EDIT.
@@ -2833,7 +2762,7 @@ const jsonContentHeaders$k = {
2833
2762
  *
2834
2763
  * This API allows to manage your Elastic Metal server. Elastic Metal API.
2835
2764
  */
2836
- let API$m = class API extends API$p {
2765
+ let API$n = class API extends API$q {
2837
2766
  /** Lists the available zones of the API. */
2838
2767
  static LOCALITIES = ['fr-par-1', 'fr-par-2', 'nl-ams-1'];
2839
2768
  pageOfListServers = (request = {}) => this.client.fetch({
@@ -3183,7 +3112,7 @@ let API$m = class API extends API$p {
3183
3112
  };
3184
3113
 
3185
3114
  /** Elastic Metal Private Network API. */
3186
- class PrivateNetworkAPI extends API$p {
3115
+ class PrivateNetworkAPI extends API$q {
3187
3116
  /** Lists the available zones of the API. */
3188
3117
  static LOCALITIES = ['fr-par-2'];
3189
3118
 
@@ -3241,7 +3170,7 @@ class PrivateNetworkAPI extends API$p {
3241
3170
  });
3242
3171
  }
3243
3172
 
3244
- class BaremetalV1UtilsAPI extends API$m {
3173
+ class BaremetalV1UtilsAPI extends API$n {
3245
3174
  /**
3246
3175
  * Waits for {@link ServerInstall} to be in a final state.
3247
3176
  *
@@ -3385,7 +3314,7 @@ var validationRules_gen$4 = /*#__PURE__*/Object.freeze({
3385
3314
  UpdateServerRequest: UpdateServerRequest
3386
3315
  });
3387
3316
 
3388
- var index$p = /*#__PURE__*/Object.freeze({
3317
+ var index$q = /*#__PURE__*/Object.freeze({
3389
3318
  __proto__: null,
3390
3319
  API: BaremetalV1UtilsAPI,
3391
3320
  PrivateNetworkAPI: PrivateNetworkAPI,
@@ -3395,9 +3324,94 @@ var index$p = /*#__PURE__*/Object.freeze({
3395
3324
  ValidationRules: validationRules_gen$4
3396
3325
  });
3397
3326
 
3327
+ var index$p = /*#__PURE__*/Object.freeze({
3328
+ __proto__: null,
3329
+ v1: index$q
3330
+ });
3331
+
3332
+ // This file was automatically generated. DO NOT EDIT.
3333
+ const unmarshalGetConsumptionResponseConsumption = data => {
3334
+ if (!isJSONObject(data)) {
3335
+ throw new TypeError(`Unmarshalling the type 'GetConsumptionResponseConsumption' failed as data isn't a dictionary.`);
3336
+ }
3337
+ return {
3338
+ category: data.category,
3339
+ description: data.description,
3340
+ operationPath: data.operation_path,
3341
+ projectId: data.project_id,
3342
+ value: data.value ? unmarshalMoney(data.value) : undefined
3343
+ };
3344
+ };
3345
+ const unmarshalInvoice = data => {
3346
+ if (!isJSONObject(data)) {
3347
+ throw new TypeError(`Unmarshalling the type 'Invoice' failed as data isn't a dictionary.`);
3348
+ }
3349
+ return {
3350
+ dueDate: unmarshalDate(data.due_date),
3351
+ id: data.id,
3352
+ invoiceType: data.invoice_type,
3353
+ issuedDate: unmarshalDate(data.issued_date),
3354
+ number: data.number,
3355
+ startDate: unmarshalDate(data.start_date),
3356
+ totalTaxed: data.total_taxed ? unmarshalMoney(data.total_taxed) : undefined,
3357
+ totalUntaxed: data.total_untaxed ? unmarshalMoney(data.total_untaxed) : undefined
3358
+ };
3359
+ };
3360
+ const unmarshalGetConsumptionResponse = data => {
3361
+ if (!isJSONObject(data)) {
3362
+ throw new TypeError(`Unmarshalling the type 'GetConsumptionResponse' failed as data isn't a dictionary.`);
3363
+ }
3364
+ return {
3365
+ consumptions: unmarshalArrayOfObject(data.consumptions, unmarshalGetConsumptionResponseConsumption),
3366
+ updatedAt: unmarshalDate(data.updated_at)
3367
+ };
3368
+ };
3369
+ const unmarshalListInvoicesResponse = data => {
3370
+ if (!isJSONObject(data)) {
3371
+ throw new TypeError(`Unmarshalling the type 'ListInvoicesResponse' failed as data isn't a dictionary.`);
3372
+ }
3373
+ return {
3374
+ invoices: unmarshalArrayOfObject(data.invoices, unmarshalInvoice),
3375
+ totalCount: data.total_count
3376
+ };
3377
+ };
3378
+
3379
+ // This file was automatically generated. DO NOT EDIT.
3380
+ /**
3381
+ * Billing API.
3382
+ *
3383
+ * This API allows you to query your consumption. Billing API.
3384
+ */
3385
+ let API$m = class API extends API$q {
3386
+ getConsumption = (request = {}) => this.client.fetch({
3387
+ method: 'GET',
3388
+ path: `/billing/v2alpha1/consumption`,
3389
+ urlParams: urlParams(['organization_id', request.organizationId ?? this.client.settings.defaultOrganizationId])
3390
+ }, unmarshalGetConsumptionResponse);
3391
+ pageOfListInvoices = (request = {}) => this.client.fetch({
3392
+ method: 'GET',
3393
+ path: `/billing/v2alpha1/invoices`,
3394
+ urlParams: urlParams(['invoice_type', request.invoiceType ?? 'unknown_type'], ['order_by', request.orderBy ?? 'invoice_number_desc'], ['organization_id', request.organizationId], ['page', request.page], ['page_size', request.pageSize ?? this.client.settings.defaultPageSize], ['started_after', request.startedAfter], ['started_before', request.startedBefore])
3395
+ }, unmarshalListInvoicesResponse);
3396
+ listInvoices = (request = {}) => enrichForPagination('invoices', this.pageOfListInvoices, request);
3397
+ downloadInvoice = request => this.client.fetch({
3398
+ method: 'GET',
3399
+ path: `/billing/v2alpha1/invoices/${validatePathParam('invoiceId', request.invoiceId)}/download`,
3400
+ urlParams: urlParams(['dl', 1], ['file_type', request.fileType ?? 'pdf']),
3401
+ responseType: 'blob'
3402
+ });
3403
+ };
3404
+
3405
+ // This file was automatically generated. DO NOT EDIT.
3406
+
3407
+ var index_gen$j = /*#__PURE__*/Object.freeze({
3408
+ __proto__: null,
3409
+ API: API$m
3410
+ });
3411
+
3398
3412
  var index$o = /*#__PURE__*/Object.freeze({
3399
3413
  __proto__: null,
3400
- v1: index$p
3414
+ v2alpha1: index_gen$j
3401
3415
  });
3402
3416
 
3403
3417
  // This file was automatically generated. DO NOT EDIT.
@@ -3459,6 +3473,20 @@ const unmarshalGrafanaUser = data => {
3459
3473
  role: data.role
3460
3474
  };
3461
3475
  };
3476
+ const unmarshalPlan = data => {
3477
+ if (!isJSONObject(data)) {
3478
+ throw new TypeError(`Unmarshalling the type 'Plan' failed as data isn't a dictionary.`);
3479
+ }
3480
+ return {
3481
+ id: data.id,
3482
+ logsIngestionPrice: data.logs_ingestion_price,
3483
+ name: data.name,
3484
+ retentionLogsInterval: data.retention_logs_interval,
3485
+ retentionMetricsInterval: data.retention_metrics_interval,
3486
+ retentionPrice: data.retention_price,
3487
+ sampleIngestionPrice: data.sample_ingestion_price
3488
+ };
3489
+ };
3462
3490
  const unmarshalToken$2 = data => {
3463
3491
  if (!isJSONObject(data)) {
3464
3492
  throw new TypeError(`Unmarshalling the type 'Token' failed as data isn't a dictionary.`);
@@ -3481,11 +3509,20 @@ const unmarshalCockpit = data => {
3481
3509
  createdAt: unmarshalDate(data.created_at),
3482
3510
  endpoints: data.endpoints ? unmarshalCockpitEndpoints(data.endpoints) : undefined,
3483
3511
  managedAlertsEnabled: data.managed_alerts_enabled,
3512
+ plan: data.plan ? unmarshalPlan(data.plan) : undefined,
3484
3513
  projectId: data.project_id,
3485
3514
  status: data.status,
3486
3515
  updatedAt: unmarshalDate(data.updated_at)
3487
3516
  };
3488
3517
  };
3518
+ const unmarshalCockpitMetrics = data => {
3519
+ if (!isJSONObject(data)) {
3520
+ throw new TypeError(`Unmarshalling the type 'CockpitMetrics' failed as data isn't a dictionary.`);
3521
+ }
3522
+ return {
3523
+ timeseries: unmarshalArrayOfObject(data.timeseries, unmarshalTimeSeries)
3524
+ };
3525
+ };
3489
3526
  const unmarshalListContactPointsResponse = data => {
3490
3527
  if (!isJSONObject(data)) {
3491
3528
  throw new TypeError(`Unmarshalling the type 'ListContactPointsResponse' failed as data isn't a dictionary.`);
@@ -3506,6 +3543,15 @@ const unmarshalListGrafanaUsersResponse = data => {
3506
3543
  totalCount: data.total_count
3507
3544
  };
3508
3545
  };
3546
+ const unmarshalListPlansResponse = data => {
3547
+ if (!isJSONObject(data)) {
3548
+ throw new TypeError(`Unmarshalling the type 'ListPlansResponse' failed as data isn't a dictionary.`);
3549
+ }
3550
+ return {
3551
+ plans: unmarshalArrayOfObject(data.plans, unmarshalPlan),
3552
+ totalCount: data.total_count
3553
+ };
3554
+ };
3509
3555
  const unmarshalListTokensResponse$2 = data => {
3510
3556
  if (!isJSONObject(data)) {
3511
3557
  throw new TypeError(`Unmarshalling the type 'ListTokensResponse' failed as data isn't a dictionary.`);
@@ -3515,6 +3561,12 @@ const unmarshalListTokensResponse$2 = data => {
3515
3561
  totalCount: data.total_count
3516
3562
  };
3517
3563
  };
3564
+ const unmarshalSelectPlanResponse = data => {
3565
+ if (!isJSONObject(data)) {
3566
+ throw new TypeError(`Unmarshalling the type 'SelectPlanResponse' failed as data isn't a dictionary.`);
3567
+ }
3568
+ return {};
3569
+ };
3518
3570
  const marshalContactPointEmail = (request, defaults) => ({
3519
3571
  to: request.to
3520
3572
  });
@@ -3546,7 +3598,7 @@ const marshalCreateGrafanaUserRequest = (request, defaults) => ({
3546
3598
  role: request.role ?? 'unknown_role'
3547
3599
  });
3548
3600
  const marshalCreateTokenRequest$2 = (request, defaults) => ({
3549
- name: request.name,
3601
+ name: request.name || randomName('token'),
3550
3602
  project_id: request.projectId ?? defaults.defaultProjectId,
3551
3603
  scopes: request.scopes ? marshalTokenScopes(request.scopes) : undefined
3552
3604
  });
@@ -3572,6 +3624,10 @@ const marshalResetCockpitGrafanaRequest = (request, defaults) => ({
3572
3624
  const marshalResetGrafanaUserPasswordRequest = (request, defaults) => ({
3573
3625
  project_id: request.projectId ?? defaults.defaultProjectId
3574
3626
  });
3627
+ const marshalSelectPlanRequest = (request, defaults) => ({
3628
+ plan_id: request.planId,
3629
+ project_id: request.projectId ?? defaults.defaultProjectId
3630
+ });
3575
3631
  const marshalTriggerTestAlertRequest = (request, defaults) => ({
3576
3632
  project_id: request.projectId ?? defaults.defaultProjectId
3577
3633
  });
@@ -3586,7 +3642,7 @@ const jsonContentHeaders$j = {
3586
3642
  *
3587
3643
  * This API allows to manage Cockpits. Cockpit API.
3588
3644
  */
3589
- let API$l = class API extends API$p {
3645
+ let API$l = class API extends API$q {
3590
3646
  /**
3591
3647
  * Activate a cockpit. Activate a cockpit associated with the given project
3592
3648
  * ID.
@@ -3622,6 +3678,18 @@ let API$l = class API extends API$p {
3622
3678
  */
3623
3679
  waitForCockpit = (request = {}, options) => waitForResource(options?.stop ?? (res => Promise.resolve(!COCKPIT_TRANSIENT_STATUSES.includes(res.status))), this.getCockpit, request, options);
3624
3680
 
3681
+ /**
3682
+ * Get cockpit metrics. Get the cockpit metrics with the given project ID.
3683
+ *
3684
+ * @param request - The request {@link GetCockpitMetricsRequest}
3685
+ * @returns A Promise of CockpitMetrics
3686
+ */
3687
+ getCockpitMetrics = (request = {}) => this.client.fetch({
3688
+ method: 'GET',
3689
+ path: `/cockpit/v1beta1/cockpit/metrics`,
3690
+ urlParams: urlParams(['end_date', request.endDate], ['metric_name', request.metricName], ['project_id', request.projectId ?? this.client.settings.defaultProjectId], ['start_date', request.startDate])
3691
+ }, unmarshalCockpitMetrics);
3692
+
3625
3693
  /**
3626
3694
  * Deactivate a cockpit. Deactivate a cockpit associated with the given
3627
3695
  * project ID.
@@ -3656,7 +3724,7 @@ let API$l = class API extends API$p {
3656
3724
  * @param request - The request {@link CreateTokenRequest}
3657
3725
  * @returns A Promise of Token
3658
3726
  */
3659
- createToken = request => this.client.fetch({
3727
+ createToken = (request = {}) => this.client.fetch({
3660
3728
  body: JSON.stringify(marshalCreateTokenRequest$2(request, this.client.settings)),
3661
3729
  headers: jsonContentHeaders$j,
3662
3730
  method: 'POST',
@@ -3826,6 +3894,32 @@ let API$l = class API extends API$p {
3826
3894
  method: 'POST',
3827
3895
  path: `/cockpit/v1beta1/grafana-users/${validatePathParam('grafanaUserId', request.grafanaUserId)}/reset-password`
3828
3896
  }, unmarshalGrafanaUser);
3897
+ pageOfListPlans = (request = {}) => this.client.fetch({
3898
+ method: 'GET',
3899
+ path: `/cockpit/v1beta1/plans`,
3900
+ urlParams: urlParams(['order_by', request.orderBy ?? 'name_asc'], ['page', request.page], ['page_size', request.pageSize ?? this.client.settings.defaultPageSize])
3901
+ }, unmarshalListPlansResponse);
3902
+
3903
+ /**
3904
+ * List plans. List all pricing plans.
3905
+ *
3906
+ * @param request - The request {@link ListPlansRequest}
3907
+ * @returns A Promise of ListPlansResponse
3908
+ */
3909
+ listPlans = (request = {}) => enrichForPagination('plans', this.pageOfListPlans, request);
3910
+
3911
+ /**
3912
+ * Select pricing plan. Select the wanted pricing plan.
3913
+ *
3914
+ * @param request - The request {@link SelectPlanRequest}
3915
+ * @returns A Promise of SelectPlanResponse
3916
+ */
3917
+ selectPlan = request => this.client.fetch({
3918
+ body: JSON.stringify(marshalSelectPlanRequest(request, this.client.settings)),
3919
+ headers: jsonContentHeaders$j,
3920
+ method: 'POST',
3921
+ path: `/cockpit/v1beta1/select-plan`
3922
+ }, unmarshalSelectPlanResponse);
3829
3923
  };
3830
3924
 
3831
3925
  // This file was automatically generated. DO NOT EDIT.
@@ -4111,7 +4205,7 @@ const jsonContentHeaders$i = {
4111
4205
  *
4112
4206
  * Serverless Containers API. Containers API.
4113
4207
  */
4114
- let API$k = class API extends API$p {
4208
+ let API$k = class API extends API$q {
4115
4209
  /** Lists the available regions of the API. */
4116
4210
  static LOCALITIES = ['fr-par', 'nl-ams', 'pl-waw'];
4117
4211
  pageOfListNamespaces = (request = {}) => this.client.fetch({
@@ -5697,7 +5791,7 @@ const jsonContentHeaders$h = {
5697
5791
  *
5698
5792
  * DNS API. Manage your DNS zones and records.
5699
5793
  */
5700
- let API$j = class API extends API$p {
5794
+ let API$j = class API extends API$q {
5701
5795
  pageOfListDNSZones = request => this.client.fetch({
5702
5796
  method: 'GET',
5703
5797
  path: `/domain/v2beta1/dns-zones`,
@@ -6041,7 +6135,7 @@ let API$j = class API extends API$p {
6041
6135
  *
6042
6136
  * Domains registrar API. Manage your domains and contacts.
6043
6137
  */
6044
- class RegistrarAPI extends API$p {
6138
+ class RegistrarAPI extends API$q {
6045
6139
  pageOfListTasks = (request = {}) => this.client.fetch({
6046
6140
  method: 'GET',
6047
6141
  path: `/domain/v2beta1/tasks`,
@@ -6569,7 +6663,7 @@ const jsonContentHeaders$g = {
6569
6663
  };
6570
6664
 
6571
6665
  /** Flexible IP API. */
6572
- let API$i = class API extends API$p {
6666
+ let API$i = class API extends API$q {
6573
6667
  /** Lists the available zones of the API. */
6574
6668
  static LOCALITIES = ['fr-par-1', 'fr-par-2', 'nl-ams-1'];
6575
6669
 
@@ -6694,6 +6788,14 @@ let API$i = class API extends API$p {
6694
6788
  method: 'POST',
6695
6789
  path: `/flexible-ip/v1alpha1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/fips/${validatePathParam('fipId', request.fipId)}/mac/duplicate`
6696
6790
  }, unmarshalFlexibleIP);
6791
+
6792
+ /**
6793
+ * Move a virtual MAC. Move a Virtual MAC from a given Flexible IP onto
6794
+ * another Flexible IP.
6795
+ *
6796
+ * @param request - The request {@link MoveMACAddrRequest}
6797
+ * @returns A Promise of FlexibleIP
6798
+ */
6697
6799
  moveMACAddr = request => this.client.fetch({
6698
6800
  body: JSON.stringify(marshalMoveMACAddrRequest(request, this.client.settings)),
6699
6801
  headers: jsonContentHeaders$g,
@@ -6781,6 +6883,7 @@ const unmarshalTriggerMnqNatsClientConfig = data => {
6781
6883
  throw new TypeError(`Unmarshalling the type 'TriggerMnqNatsClientConfig' failed as data isn't a dictionary.`);
6782
6884
  }
6783
6885
  return {
6886
+ mnqCredentialId: data.mnq_credential_id,
6784
6887
  mnqNamespaceId: data.mnq_namespace_id,
6785
6888
  mnqProjectId: data.mnq_project_id,
6786
6889
  mnqRegion: data.mnq_region,
@@ -6792,6 +6895,7 @@ const unmarshalTriggerMnqSqsClientConfig = data => {
6792
6895
  throw new TypeError(`Unmarshalling the type 'TriggerMnqSqsClientConfig' failed as data isn't a dictionary.`);
6793
6896
  }
6794
6897
  return {
6898
+ mnqCredentialId: data.mnq_credential_id,
6795
6899
  mnqNamespaceId: data.mnq_namespace_id,
6796
6900
  mnqProjectId: data.mnq_project_id,
6797
6901
  mnqRegion: data.mnq_region,
@@ -6904,6 +7008,7 @@ const unmarshalRuntime = data => {
6904
7008
  extension: data.extension,
6905
7009
  implementation: data.implementation,
6906
7010
  language: data.language,
7011
+ logoUrl: data.logo_url,
6907
7012
  name: data.name,
6908
7013
  status: data.status,
6909
7014
  statusMessage: data.status_message,
@@ -7054,22 +7159,8 @@ const marshalSecret = (request, defaults) => ({
7054
7159
  key: request.key,
7055
7160
  value: request.value
7056
7161
  });
7057
- const marshalUpdateTriggerRequestMnqNatsClientConfig = (request, defaults) => ({
7058
- mnq_namespace_id: request.mnqNamespaceId,
7059
- mnq_project_id: request.mnqProjectId,
7060
- mnq_region: request.mnqRegion,
7061
- subject: request.subject
7062
- });
7063
- const marshalUpdateTriggerRequestMnqSqsClientConfig = (request, defaults) => ({
7064
- mnq_namespace_id: request.mnqNamespaceId,
7065
- mnq_project_id: request.mnqProjectId,
7066
- mnq_region: request.mnqRegion,
7067
- queue: request.queue
7068
- });
7069
7162
  const marshalUpdateTriggerRequestSqsClientConfig = (request, defaults) => ({
7070
7163
  access_key: request.accessKey,
7071
- endpoint: request.endpoint,
7072
- queue_url: request.queueUrl,
7073
7164
  secret_key: request.secretKey
7074
7165
  });
7075
7166
  const marshalCreateCronRequest = (request, defaults) => ({
@@ -7159,14 +7250,8 @@ const marshalUpdateTriggerRequest = (request, defaults) => ({
7159
7250
  description: request.description,
7160
7251
  name: request.name,
7161
7252
  ...resolveOneOf([{
7162
- param: 'scw_sqs_config',
7163
- value: request.scwSqsConfig ? marshalUpdateTriggerRequestMnqSqsClientConfig(request.scwSqsConfig) : undefined
7164
- }, {
7165
7253
  param: 'sqs_config',
7166
7254
  value: request.sqsConfig ? marshalUpdateTriggerRequestSqsClientConfig(request.sqsConfig) : undefined
7167
- }, {
7168
- param: 'scw_nats_config',
7169
- value: request.scwNatsConfig ? marshalUpdateTriggerRequestMnqNatsClientConfig(request.scwNatsConfig) : undefined
7170
7255
  }])
7171
7256
  });
7172
7257
 
@@ -7180,7 +7265,7 @@ const jsonContentHeaders$f = {
7180
7265
  *
7181
7266
  * Serverless functions API. Functions API.
7182
7267
  */
7183
- let API$h = class API extends API$p {
7268
+ let API$h = class API extends API$q {
7184
7269
  /** Lists the available regions of the API. */
7185
7270
  static LOCALITIES = ['fr-par', 'nl-ams', 'pl-waw'];
7186
7271
  pageOfListNamespaces = (request = {}) => this.client.fetch({
@@ -8027,7 +8112,7 @@ const jsonContentHeaders$e = {
8027
8112
  };
8028
8113
 
8029
8114
  /** IAM API. */
8030
- let API$g = class API extends API$p {
8115
+ let API$g = class API extends API$q {
8031
8116
  pageOfListSSHKeys = (request = {}) => this.client.fetch({
8032
8117
  method: 'GET',
8033
8118
  path: `/iam/v1alpha1/ssh-keys`,
@@ -8410,6 +8495,14 @@ let API$g = class API extends API$p {
8410
8495
  method: 'DELETE',
8411
8496
  path: `/iam/v1alpha1/policies/${validatePathParam('policyId', request.policyId)}`
8412
8497
  });
8498
+
8499
+ /**
8500
+ * Clone a policy. Clone a policy. You must define specify the `policy_id`
8501
+ * parameter in your request.
8502
+ *
8503
+ * @param request - The request {@link ClonePolicyRequest}
8504
+ * @returns A Promise of Policy
8505
+ */
8413
8506
  clonePolicy = request => this.client.fetch({
8414
8507
  body: '{}',
8415
8508
  headers: jsonContentHeaders$e,
@@ -8676,7 +8769,7 @@ const ListAPIKeysRequest = {
8676
8769
  maxLength: 200
8677
8770
  },
8678
8771
  page: {
8679
- greaterThanOrEqual: 1
8772
+ greaterThan: 0
8680
8773
  },
8681
8774
  pageSize: {
8682
8775
  greaterThanOrEqual: 1,
@@ -8690,7 +8783,7 @@ const ListApplicationsRequest = {
8690
8783
  pattern: /^[a-zA-Z0-9\(\)\._\- ]+$/
8691
8784
  },
8692
8785
  page: {
8693
- greaterThanOrEqual: 1
8786
+ greaterThan: 0
8694
8787
  },
8695
8788
  pageSize: {
8696
8789
  greaterThanOrEqual: 1,
@@ -8702,7 +8795,7 @@ const ListGroupsRequest = {
8702
8795
  minLength: 1
8703
8796
  },
8704
8797
  page: {
8705
- greaterThanOrEqual: 1
8798
+ greaterThan: 0
8706
8799
  },
8707
8800
  pageSize: {
8708
8801
  greaterThanOrEqual: 1,
@@ -8711,7 +8804,7 @@ const ListGroupsRequest = {
8711
8804
  };
8712
8805
  const ListJWTsRequest = {
8713
8806
  page: {
8714
- greaterThanOrEqual: 1
8807
+ greaterThan: 0
8715
8808
  },
8716
8809
  pageSize: {
8717
8810
  greaterThanOrEqual: 1,
@@ -8720,7 +8813,7 @@ const ListJWTsRequest = {
8720
8813
  };
8721
8814
  const ListPermissionSetsRequest = {
8722
8815
  page: {
8723
- greaterThanOrEqual: 1
8816
+ greaterThan: 0
8724
8817
  },
8725
8818
  pageSize: {
8726
8819
  greaterThanOrEqual: 1,
@@ -8729,7 +8822,7 @@ const ListPermissionSetsRequest = {
8729
8822
  };
8730
8823
  const ListPoliciesRequest = {
8731
8824
  page: {
8732
- greaterThanOrEqual: 1
8825
+ greaterThan: 0
8733
8826
  },
8734
8827
  pageSize: {
8735
8828
  greaterThanOrEqual: 1,
@@ -8741,7 +8834,7 @@ const ListPoliciesRequest = {
8741
8834
  };
8742
8835
  const ListQuotaRequest = {
8743
8836
  page: {
8744
- greaterThanOrEqual: 1
8837
+ greaterThan: 0
8745
8838
  },
8746
8839
  pageSize: {
8747
8840
  greaterThanOrEqual: 1,
@@ -8750,7 +8843,7 @@ const ListQuotaRequest = {
8750
8843
  };
8751
8844
  const ListRulesRequest = {
8752
8845
  page: {
8753
- greaterThanOrEqual: 1
8846
+ greaterThan: 0
8754
8847
  },
8755
8848
  pageSize: {
8756
8849
  greaterThanOrEqual: 1,
@@ -8763,7 +8856,7 @@ const ListSSHKeysRequest = {
8763
8856
  minLength: 1
8764
8857
  },
8765
8858
  page: {
8766
- greaterThanOrEqual: 1
8859
+ greaterThan: 0
8767
8860
  },
8768
8861
  pageSize: {
8769
8862
  greaterThanOrEqual: 1,
@@ -8772,7 +8865,7 @@ const ListSSHKeysRequest = {
8772
8865
  };
8773
8866
  const ListUsersRequest = {
8774
8867
  page: {
8775
- greaterThanOrEqual: 1
8868
+ greaterThan: 0
8776
8869
  },
8777
8870
  pageSize: {
8778
8871
  greaterThanOrEqual: 1,
@@ -10193,12 +10286,12 @@ const jsonContentHeaders$d = {
10193
10286
  };
10194
10287
 
10195
10288
  /** Instance API. */
10196
- let API$f = class API extends API$p {
10289
+ let API$f = class API extends API$q {
10197
10290
  /** Lists the available zones of the API. */
10198
10291
  static LOCALITIES = ['fr-par-1', 'fr-par-2', 'fr-par-3', 'nl-ams-1', 'nl-ams-2', 'pl-waw-1', 'pl-waw-2'];
10199
10292
 
10200
10293
  /**
10201
- * Get availability. Get availability for all server types.
10294
+ * Get availability. Get availability for all Instance types.
10202
10295
  *
10203
10296
  * @param request - The request {@link GetServerTypesAvailabilityRequest}
10204
10297
  * @returns A Promise of GetServerTypesAvailabilityResponse
@@ -10210,7 +10303,8 @@ let API$f = class API extends API$p {
10210
10303
  }, unmarshalGetServerTypesAvailabilityResponse);
10211
10304
 
10212
10305
  /**
10213
- * List server types. Get server types technical details.
10306
+ * List Instance types. List available Instance types and their technical
10307
+ * details.
10214
10308
  *
10215
10309
  * @param request - The request {@link ListServersTypesRequest}
10216
10310
  * @returns A Promise of ListServersTypesResponse
@@ -10222,7 +10316,7 @@ let API$f = class API extends API$p {
10222
10316
  }, unmarshalListServersTypesResponse);
10223
10317
 
10224
10318
  /**
10225
- * List volumes types. Get volumes technical details.
10319
+ * List volumes types. List all volume types and their technical details.
10226
10320
  *
10227
10321
  * @param request - The request {@link ListVolumesTypesRequest}
10228
10322
  * @returns A Promise of ListVolumesTypesResponse
@@ -10239,7 +10333,8 @@ let API$f = class API extends API$p {
10239
10333
  }, unmarshalListServersResponse);
10240
10334
 
10241
10335
  /**
10242
- * List all servers.
10336
+ * List all Instances. List all Instances in a specified Availability Zone,
10337
+ * e.g. `fr-par-1`.
10243
10338
  *
10244
10339
  * @param request - The request {@link ListServersRequest}
10245
10340
  * @returns A Promise of ListServersResponse
@@ -10253,7 +10348,7 @@ let API$f = class API extends API$p {
10253
10348
  }, unmarshalCreateServerResponse);
10254
10349
 
10255
10350
  /**
10256
- * Delete a server. Delete a server with the given ID.
10351
+ * Delete an Instance. Delete the Instance with the specified ID.
10257
10352
  *
10258
10353
  * @param request - The request {@link DeleteServerRequest}
10259
10354
  */
@@ -10263,7 +10358,7 @@ let API$f = class API extends API$p {
10263
10358
  });
10264
10359
 
10265
10360
  /**
10266
- * Get a server. Get the details of a specified Server.
10361
+ * Get an Instance. Get the details of a specified Instance.
10267
10362
  *
10268
10363
  * @param request - The request {@link GetServerRequest}
10269
10364
  * @returns A Promise of GetServerResponse
@@ -10286,8 +10381,8 @@ let API$f = class API extends API$p {
10286
10381
  }, unmarshalUpdateServerResponse);
10287
10382
 
10288
10383
  /**
10289
- * List server actions. List all actions that can currently be performed on a
10290
- * server.
10384
+ * List Instance actions. List all actions (e.g. power on, power off, reboot)
10385
+ * that can currently be performed on an Instance.
10291
10386
  *
10292
10387
  * @param request - The request {@link ListServerActionsRequest}
10293
10388
  * @returns A Promise of ListServerActionsResponse
@@ -10298,13 +10393,19 @@ let API$f = class API extends API$p {
10298
10393
  }, unmarshalListServerActionsResponse);
10299
10394
 
10300
10395
  /**
10301
- * Perform action. Perform power related actions on a server. Be wary that
10302
- * when terminating a server, all the attached volumes (local _and_ block
10303
- * storage) are deleted. So, if you want to keep your local volumes, you must
10304
- * use the `archive` action instead of `terminate`. And if you want to keep
10305
- * block-storage volumes, **you must** detach it beforehand you issue the
10306
- * `terminate` call. For more information, read the [Volumes](#volumes-7e8a39)
10307
- * documentation.
10396
+ * Perform action. Perform an action on an Instance. Available actions are:
10397
+ * `poweron`: Start a stopped Instance. `poweroff`: Fully stop the Instance
10398
+ * and release the hypervisor slot. `stop_in_place`: Stop the Instance, but
10399
+ * keep the slot on the hypervisor. `reboot`: Stop the instance and restart
10400
+ * it. `backup`: Create an image with all the volumes of an Instance.
10401
+ * `terminate`: Delete the Instance along with all attached volumes.
10402
+ *
10403
+ * Keep in mind that terminating an Instance will result in the deletion of
10404
+ * all attached volumes, including local and block storage. If you want to
10405
+ * preserve your local volumes, you should use the `archive` action instead of
10406
+ * `terminate`. Similarly, if you want to keep your block storage volumes, you
10407
+ * must first detach them before issuing the `terminate` command. For more
10408
+ * information, read the [Volumes](#volumes-7e8a39) documentation.
10308
10409
  *
10309
10410
  * @param request - The request {@link ServerActionRequest}
10310
10411
  * @returns A Promise of ServerActionResponse
@@ -10317,7 +10418,7 @@ let API$f = class API extends API$p {
10317
10418
  }, unmarshalServerActionResponse);
10318
10419
 
10319
10420
  /**
10320
- * List user data. List all user data keys registered on a given server.
10421
+ * List user data. List all user data keys registered on a specified Instance.
10321
10422
  *
10322
10423
  * @param request - The request {@link ListServerUserDataRequest}
10323
10424
  * @returns A Promise of ListServerUserDataResponse
@@ -10328,7 +10429,7 @@ let API$f = class API extends API$p {
10328
10429
  }, unmarshalListServerUserDataResponse);
10329
10430
 
10330
10431
  /**
10331
- * Delete user data. Delete the given key from a server user data.
10432
+ * Delete user data. Delete the specified key from an Instance's user data.
10332
10433
  *
10333
10434
  * @param request - The request {@link DeleteServerUserDataRequest}
10334
10435
  */
@@ -10343,7 +10444,7 @@ let API$f = class API extends API$p {
10343
10444
  }, unmarshalListImagesResponse$3);
10344
10445
 
10345
10446
  /**
10346
- * List instance images. List all images available in an account.
10447
+ * List Instance images. List all existing Instance images.
10347
10448
  *
10348
10449
  * @param request - The request {@link ListImagesRequest}
10349
10450
  * @returns A Promise of ListImagesResponse
@@ -10351,7 +10452,7 @@ let API$f = class API extends API$p {
10351
10452
  listImages = (request = {}) => enrichForPagination('images', this.pageOfListImages, request);
10352
10453
 
10353
10454
  /**
10354
- * Get an instance image. Get details of an image with the given ID.
10455
+ * Get an Instance image. Get details of an image with the specified ID.
10355
10456
  *
10356
10457
  * @param request - The request {@link GetImageRequest}
10357
10458
  * @returns A Promise of GetImageResponse
@@ -10362,7 +10463,8 @@ let API$f = class API extends API$p {
10362
10463
  }, unmarshalGetImageResponse$1);
10363
10464
 
10364
10465
  /**
10365
- * Create an instance image.
10466
+ * Create an Instance image. Create an Instance image from the specified
10467
+ * snapshot ID.
10366
10468
  *
10367
10469
  * @param request - The request {@link CreateImageRequest}
10368
10470
  * @returns A Promise of CreateImageResponse
@@ -10381,7 +10483,7 @@ let API$f = class API extends API$p {
10381
10483
  }, unmarshalSetImageResponse);
10382
10484
 
10383
10485
  /**
10384
- * Delete an instance image. Delete the image with the given ID.
10486
+ * Delete an Instance image. Delete the image with the specified ID.
10385
10487
  *
10386
10488
  * @param request - The request {@link DeleteImageRequest}
10387
10489
  */
@@ -10396,7 +10498,8 @@ let API$f = class API extends API$p {
10396
10498
  }, unmarshalListSnapshotsResponse$1);
10397
10499
 
10398
10500
  /**
10399
- * List snapshots.
10501
+ * List snapshots. List all snapshots of an Organization in a specified
10502
+ * Availability Zone.
10400
10503
  *
10401
10504
  * @param request - The request {@link ListSnapshotsRequest}
10402
10505
  * @returns A Promise of ListSnapshotsResponse
@@ -10404,7 +10507,9 @@ let API$f = class API extends API$p {
10404
10507
  listSnapshots = (request = {}) => enrichForPagination('snapshots', this.pageOfListSnapshots, request);
10405
10508
 
10406
10509
  /**
10407
- * Create a snapshot from a given volume or from a QCOW2 file.
10510
+ * Create a snapshot from a specified volume or from a QCOW2 file. Create a
10511
+ * snapshot from a specified volume or from a QCOW2 file in a specified
10512
+ * Availability Zone.
10408
10513
  *
10409
10514
  * @param request - The request {@link CreateSnapshotRequest}
10410
10515
  * @returns A Promise of CreateSnapshotResponse
@@ -10417,7 +10522,7 @@ let API$f = class API extends API$p {
10417
10522
  }, unmarshalCreateSnapshotResponse);
10418
10523
 
10419
10524
  /**
10420
- * Get a snapshot. Get details of a snapshot with the given ID.
10525
+ * Get a snapshot. Get details of a snapshot with the specified ID.
10421
10526
  *
10422
10527
  * @param request - The request {@link GetSnapshotRequest}
10423
10528
  * @returns A Promise of GetSnapshotResponse
@@ -10434,7 +10539,7 @@ let API$f = class API extends API$p {
10434
10539
  }, unmarshalSetSnapshotResponse);
10435
10540
 
10436
10541
  /**
10437
- * Delete a snapshot. Delete the snapshot with the given ID.
10542
+ * Delete a snapshot. Delete the snapshot with the specified ID.
10438
10543
  *
10439
10544
  * @param request - The request {@link DeleteSnapshotRequest}
10440
10545
  */
@@ -10444,7 +10549,7 @@ let API$f = class API extends API$p {
10444
10549
  });
10445
10550
 
10446
10551
  /**
10447
- * Export a snapshot. Export a snapshot to a given S3 bucket in the same
10552
+ * Export a snapshot. Export a snapshot to a specified S3 bucket in the same
10448
10553
  * region.
10449
10554
  *
10450
10555
  * @param request - The request {@link ExportSnapshotRequest}
@@ -10463,7 +10568,8 @@ let API$f = class API extends API$p {
10463
10568
  }, unmarshalListVolumesResponse);
10464
10569
 
10465
10570
  /**
10466
- * List volumes.
10571
+ * List volumes. List volumes in the specified Availability Zone. You can
10572
+ * filter the output by volume type.
10467
10573
  *
10468
10574
  * @param request - The request {@link ListVolumesRequest}
10469
10575
  * @returns A Promise of ListVolumesResponse
@@ -10471,7 +10577,8 @@ let API$f = class API extends API$p {
10471
10577
  listVolumes = (request = {}) => enrichForPagination('volumes', this.pageOfListVolumes, request);
10472
10578
 
10473
10579
  /**
10474
- * Create a volume.
10580
+ * Create a volume. Create a volume of a specified type in an Availability
10581
+ * Zone.
10475
10582
  *
10476
10583
  * @param request - The request {@link CreateVolumeRequest}
10477
10584
  * @returns A Promise of CreateVolumeResponse
@@ -10484,7 +10591,7 @@ let API$f = class API extends API$p {
10484
10591
  }, unmarshalCreateVolumeResponse);
10485
10592
 
10486
10593
  /**
10487
- * Get a volume. Get details of a volume with the given ID.
10594
+ * Get a volume. Get details of a volume with the specified ID.
10488
10595
  *
10489
10596
  * @param request - The request {@link GetVolumeRequest}
10490
10597
  * @returns A Promise of GetVolumeResponse
@@ -10495,9 +10602,9 @@ let API$f = class API extends API$p {
10495
10602
  }, unmarshalGetVolumeResponse);
10496
10603
 
10497
10604
  /**
10498
- * Update a volume. Replace name and/or size properties of given ID volume
10499
- * with the given value(s). Any volume name can be changed while, for now,
10500
- * only `b_ssd` volume growing is supported.
10605
+ * Update a volume. Replace the name and/or size properties of a volume
10606
+ * specified by its ID, with the specified value(s). Any volume name can be
10607
+ * changed, however only `b_ssd` volumes can currently be increased in size.
10501
10608
  *
10502
10609
  * @param request - The request {@link UpdateVolumeRequest}
10503
10610
  * @returns A Promise of UpdateVolumeResponse
@@ -10510,7 +10617,7 @@ let API$f = class API extends API$p {
10510
10617
  }, unmarshalUpdateVolumeResponse);
10511
10618
 
10512
10619
  /**
10513
- * Delete a volume. Delete the volume with the given ID.
10620
+ * Delete a volume. Delete the volume with the specified ID.
10514
10621
  *
10515
10622
  * @param request - The request {@link DeleteVolumeRequest}
10516
10623
  */
@@ -10525,7 +10632,7 @@ let API$f = class API extends API$p {
10525
10632
  }, unmarshalListSecurityGroupsResponse);
10526
10633
 
10527
10634
  /**
10528
- * List security groups. List all security groups available in an account.
10635
+ * List security groups. List all existing security groups.
10529
10636
  *
10530
10637
  * @param request - The request {@link ListSecurityGroupsRequest}
10531
10638
  * @returns A Promise of ListSecurityGroupsResponse
@@ -10533,7 +10640,8 @@ let API$f = class API extends API$p {
10533
10640
  listSecurityGroups = (request = {}) => enrichForPagination('securityGroups', this.pageOfListSecurityGroups, request);
10534
10641
 
10535
10642
  /**
10536
- * Create a security group.
10643
+ * Create a security group. Create a security group with a specified name and
10644
+ * description.
10537
10645
  *
10538
10646
  * @param request - The request {@link CreateSecurityGroupRequest}
10539
10647
  * @returns A Promise of CreateSecurityGroupResponse
@@ -10546,8 +10654,8 @@ let API$f = class API extends API$p {
10546
10654
  }, unmarshalCreateSecurityGroupResponse);
10547
10655
 
10548
10656
  /**
10549
- * Get a security group. Get the details of a Security Group with the given
10550
- * ID.
10657
+ * Get a security group. Get the details of a security group with the
10658
+ * specified ID.
10551
10659
  *
10552
10660
  * @param request - The request {@link GetSecurityGroupRequest}
10553
10661
  * @returns A Promise of GetSecurityGroupResponse
@@ -10558,7 +10666,7 @@ let API$f = class API extends API$p {
10558
10666
  }, unmarshalGetSecurityGroupResponse);
10559
10667
 
10560
10668
  /**
10561
- * Delete a security group.
10669
+ * Delete a security group. Delete a security group with the specified ID.
10562
10670
  *
10563
10671
  * @param request - The request {@link DeleteSecurityGroupRequest}
10564
10672
  */
@@ -10591,7 +10699,7 @@ let API$f = class API extends API$p {
10591
10699
  }, unmarshalListSecurityGroupRulesResponse);
10592
10700
 
10593
10701
  /**
10594
- * List rules.
10702
+ * List rules. List the rules of the a specified security group ID.
10595
10703
  *
10596
10704
  * @param request - The request {@link ListSecurityGroupRulesRequest}
10597
10705
  * @returns A Promise of ListSecurityGroupRulesResponse
@@ -10599,7 +10707,7 @@ let API$f = class API extends API$p {
10599
10707
  listSecurityGroupRules = request => enrichForPagination('rules', this.pageOfListSecurityGroupRules, request);
10600
10708
 
10601
10709
  /**
10602
- * Create rule.
10710
+ * Create rule. Create a rule in the specified security group ID.
10603
10711
  *
10604
10712
  * @param request - The request {@link CreateSecurityGroupRuleRequest}
10605
10713
  * @returns A Promise of CreateSecurityGroupRuleResponse
@@ -10612,10 +10720,10 @@ let API$f = class API extends API$p {
10612
10720
  }, unmarshalCreateSecurityGroupRuleResponse);
10613
10721
 
10614
10722
  /**
10615
- * Update all the rules of a security group. Replaces the rules of the
10616
- * security group with the rules provided. This endpoint supports the update
10617
- * of existing rules, creation of new rules and deletion of existing rules
10618
- * when they are not passed in the request.
10723
+ * Update all the rules of a security group. Replaces the existing rules of
10724
+ * the security group with the rules provided. This endpoint supports the
10725
+ * update of existing rules, creation of new rules and deletion of existing
10726
+ * rules when they are not passed in the request.
10619
10727
  *
10620
10728
  * @param request - The request {@link SetSecurityGroupRulesRequest}
10621
10729
  * @returns A Promise of SetSecurityGroupRulesResponse
@@ -10628,7 +10736,7 @@ let API$f = class API extends API$p {
10628
10736
  }, unmarshalSetSecurityGroupRulesResponse);
10629
10737
 
10630
10738
  /**
10631
- * Delete rule. Delete a security group rule with the given ID.
10739
+ * Delete rule. Delete a security group rule with the specified ID.
10632
10740
  *
10633
10741
  * @param request - The request {@link DeleteSecurityGroupRuleRequest}
10634
10742
  */
@@ -10638,7 +10746,7 @@ let API$f = class API extends API$p {
10638
10746
  });
10639
10747
 
10640
10748
  /**
10641
- * Get rule. Get details of a security group rule with the given ID.
10749
+ * Get rule. Get details of a security group rule with the specified ID.
10642
10750
  *
10643
10751
  * @param request - The request {@link GetSecurityGroupRuleRequest}
10644
10752
  * @returns A Promise of GetSecurityGroupRuleResponse
@@ -10660,7 +10768,8 @@ let API$f = class API extends API$p {
10660
10768
  }, unmarshalListPlacementGroupsResponse);
10661
10769
 
10662
10770
  /**
10663
- * List placement groups. List all placement groups.
10771
+ * List placement groups. List all placement groups in a specified
10772
+ * Availability Zone.
10664
10773
  *
10665
10774
  * @param request - The request {@link ListPlacementGroupsRequest}
10666
10775
  * @returns A Promise of ListPlacementGroupsResponse
@@ -10668,7 +10777,8 @@ let API$f = class API extends API$p {
10668
10777
  listPlacementGroups = (request = {}) => enrichForPagination('placementGroups', this.pageOfListPlacementGroups, request);
10669
10778
 
10670
10779
  /**
10671
- * Create a placement group. Create a new placement group.
10780
+ * Create a placement group. Create a new placement group in a specified
10781
+ * Availability Zone.
10672
10782
  *
10673
10783
  * @param request - The request {@link CreatePlacementGroupRequest}
10674
10784
  * @returns A Promise of CreatePlacementGroupResponse
@@ -10681,7 +10791,7 @@ let API$f = class API extends API$p {
10681
10791
  }, unmarshalCreatePlacementGroupResponse);
10682
10792
 
10683
10793
  /**
10684
- * Get a placement group. Get the given placement group.
10794
+ * Get a placement group. Get the specified placement group.
10685
10795
  *
10686
10796
  * @param request - The request {@link GetPlacementGroupRequest}
10687
10797
  * @returns A Promise of GetPlacementGroupResponse
@@ -10692,7 +10802,7 @@ let API$f = class API extends API$p {
10692
10802
  }, unmarshalGetPlacementGroupResponse);
10693
10803
 
10694
10804
  /**
10695
- * Set placement group. Set all parameters of the given placement group.
10805
+ * Set placement group. Set all parameters of the specified placement group.
10696
10806
  *
10697
10807
  * @param request - The request {@link SetPlacementGroupRequest}
10698
10808
  * @returns A Promise of SetPlacementGroupResponse
@@ -10705,7 +10815,7 @@ let API$f = class API extends API$p {
10705
10815
  }, unmarshalSetPlacementGroupResponse);
10706
10816
 
10707
10817
  /**
10708
- * Update a placement group. Update one or more parameter of the given
10818
+ * Update a placement group. Update one or more parameter of the specified
10709
10819
  * placement group.
10710
10820
  *
10711
10821
  * @param request - The request {@link UpdatePlacementGroupRequest}
@@ -10719,7 +10829,7 @@ let API$f = class API extends API$p {
10719
10829
  }, unmarshalUpdatePlacementGroupResponse);
10720
10830
 
10721
10831
  /**
10722
- * Delete the given placement group.
10832
+ * Delete the specified placement group.
10723
10833
  *
10724
10834
  * @param request - The request {@link DeletePlacementGroupRequest}
10725
10835
  */
@@ -10729,7 +10839,7 @@ let API$f = class API extends API$p {
10729
10839
  });
10730
10840
 
10731
10841
  /**
10732
- * Get placement group servers. Get all servers belonging to the given
10842
+ * Get placement group servers. Get all Instances belonging to the specified
10733
10843
  * placement group.
10734
10844
  *
10735
10845
  * @param request - The request {@link GetPlacementGroupServersRequest}
@@ -10741,7 +10851,7 @@ let API$f = class API extends API$p {
10741
10851
  }, unmarshalGetPlacementGroupServersResponse);
10742
10852
 
10743
10853
  /**
10744
- * Set placement group servers. Set all servers belonging to the given
10854
+ * Set placement group servers. Set all Instances belonging to the specified
10745
10855
  * placement group.
10746
10856
  *
10747
10857
  * @param request - The request {@link SetPlacementGroupServersRequest}
@@ -10755,8 +10865,8 @@ let API$f = class API extends API$p {
10755
10865
  }, unmarshalSetPlacementGroupServersResponse);
10756
10866
 
10757
10867
  /**
10758
- * Update placement group servers. Update all servers belonging to the given
10759
- * placement group.
10868
+ * Update placement group servers. Update all Instances belonging to the
10869
+ * specified placement group.
10760
10870
  *
10761
10871
  * @param request - The request {@link UpdatePlacementGroupServersRequest}
10762
10872
  * @returns A Promise of UpdatePlacementGroupServersResponse
@@ -10774,7 +10884,7 @@ let API$f = class API extends API$p {
10774
10884
  }, unmarshalListIpsResponse$1);
10775
10885
 
10776
10886
  /**
10777
- * List all flexible IPs.
10887
+ * List all flexible IPs. List all flexible IPs in a specified zone.
10778
10888
  *
10779
10889
  * @param request - The request {@link ListIpsRequest}
10780
10890
  * @returns A Promise of ListIpsResponse
@@ -10782,7 +10892,8 @@ let API$f = class API extends API$p {
10782
10892
  listIps = (request = {}) => enrichForPagination('ips', this.pageOfListIps, request);
10783
10893
 
10784
10894
  /**
10785
- * Reserve a flexible IP.
10895
+ * Reserve a flexible IP. Reserve a flexible IP and attach it to the specified
10896
+ * Instance.
10786
10897
  *
10787
10898
  * @param request - The request {@link CreateIpRequest}
10788
10899
  * @returns A Promise of CreateIpResponse
@@ -10795,7 +10906,7 @@ let API$f = class API extends API$p {
10795
10906
  }, unmarshalCreateIpResponse);
10796
10907
 
10797
10908
  /**
10798
- * Get a flexible IP. Get details of an IP with the given ID or address.
10909
+ * Get a flexible IP. Get details of an IP with the specified ID or address.
10799
10910
  *
10800
10911
  * @param request - The request {@link GetIpRequest}
10801
10912
  * @returns A Promise of GetIpResponse
@@ -10806,7 +10917,8 @@ let API$f = class API extends API$p {
10806
10917
  }, unmarshalGetIpResponse);
10807
10918
 
10808
10919
  /**
10809
- * Update a flexible IP.
10920
+ * Update a flexible IP. Update a flexible IP in the specified zone with the
10921
+ * specified ID.
10810
10922
  *
10811
10923
  * @param request - The request {@link UpdateIpRequest}
10812
10924
  * @returns A Promise of UpdateIpResponse
@@ -10819,7 +10931,7 @@ let API$f = class API extends API$p {
10819
10931
  }, unmarshalUpdateIpResponse);
10820
10932
 
10821
10933
  /**
10822
- * Delete a flexible IP. Delete the IP with the given ID.
10934
+ * Delete a flexible IP. Delete the IP with the specified ID.
10823
10935
  *
10824
10936
  * @param request - The request {@link DeleteIpRequest}
10825
10937
  */
@@ -10834,7 +10946,7 @@ let API$f = class API extends API$p {
10834
10946
  }, unmarshalListPrivateNICsResponse);
10835
10947
 
10836
10948
  /**
10837
- * List all private NICs. List all private NICs of a given server.
10949
+ * List all private NICs. List all private NICs of a specified Instance.
10838
10950
  *
10839
10951
  * @param request - The request {@link ListPrivateNICsRequest}
10840
10952
  * @returns A Promise of ListPrivateNICsResponse
@@ -10842,7 +10954,7 @@ let API$f = class API extends API$p {
10842
10954
  listPrivateNICs = request => enrichForPagination('privateNics', this.pageOfListPrivateNICs, request);
10843
10955
 
10844
10956
  /**
10845
- * Create a private NIC connecting a server to a private network.
10957
+ * Create a private NIC connecting an Instance to a Private Network.
10846
10958
  *
10847
10959
  * @param request - The request {@link CreatePrivateNICRequest}
10848
10960
  * @returns A Promise of CreatePrivateNICResponse
@@ -10866,8 +10978,8 @@ let API$f = class API extends API$p {
10866
10978
  }, unmarshalGetPrivateNICResponse);
10867
10979
 
10868
10980
  /**
10869
- * Update a private NIC. Update one or more parameter/s to a given private
10870
- * NIC.
10981
+ * Update a private NIC. Update one or more parameter(s) of a specified
10982
+ * private NIC.
10871
10983
  *
10872
10984
  * @param request - The request {@link UpdatePrivateNICRequest}
10873
10985
  * @returns A Promise of PrivateNIC
@@ -10904,7 +11016,7 @@ let API$f = class API extends API$p {
10904
11016
  listBootscripts = (request = {}) => enrichForPagination('bootscripts', this.pageOfListBootscripts, request);
10905
11017
 
10906
11018
  /**
10907
- * Get bootscripts. Get details of a bootscript with the given ID.
11019
+ * Get bootscripts. Get details of a bootscript with the specified ID.
10908
11020
  *
10909
11021
  * @deprecated
10910
11022
  * @param request - The request {@link GetBootscriptRequest}
@@ -11834,7 +11946,7 @@ const jsonContentHeaders$c = {
11834
11946
  *
11835
11947
  * This API allows you to manage IoT hubs and devices. IoT API.
11836
11948
  */
11837
- let API$e = class API extends API$p {
11949
+ let API$e = class API extends API$q {
11838
11950
  /** Lists the available regions of the API. */
11839
11951
  static LOCALITIES = ['fr-par'];
11840
11952
  pageOfListHubs = (request = {}) => this.client.fetch({
@@ -12397,6 +12509,7 @@ const unmarshalCluster$1 = data => {
12397
12509
  name: data.name,
12398
12510
  openIdConnectConfig: data.open_id_connect_config ? unmarshalClusterOpenIDConnectConfig(data.open_id_connect_config) : undefined,
12399
12511
  organizationId: data.organization_id,
12512
+ privateNetworkId: data.private_network_id,
12400
12513
  projectId: data.project_id,
12401
12514
  region: data.region,
12402
12515
  status: data.status,
@@ -12625,6 +12738,7 @@ const marshalCreateClusterRequest$1 = (request, defaults) => ({
12625
12738
  name: request.name || randomName('k8s'),
12626
12739
  open_id_connect_config: request.openIdConnectConfig ? marshalCreateClusterRequestOpenIDConnectConfig(request.openIdConnectConfig) : undefined,
12627
12740
  pools: request.pools ? request.pools.map(elt => marshalCreateClusterRequestPoolConfig(elt)) : undefined,
12741
+ private_network_id: request.privateNetworkId,
12628
12742
  tags: request.tags,
12629
12743
  type: request.type,
12630
12744
  version: request.version,
@@ -12655,6 +12769,9 @@ const marshalCreatePoolRequest = (request, defaults) => ({
12655
12769
  upgrade_policy: request.upgradePolicy ? marshalCreatePoolRequestUpgradePolicy(request.upgradePolicy) : undefined,
12656
12770
  zone: request.zone ?? defaults.defaultZone
12657
12771
  });
12772
+ const marshalSetClusterTypeRequest = (request, defaults) => ({
12773
+ type: request.type
12774
+ });
12658
12775
  const marshalUpdateClusterRequest$1 = (request, defaults) => ({
12659
12776
  admission_plugins: request.admissionPlugins,
12660
12777
  apiserver_cert_sans: request.apiserverCertSans,
@@ -12692,7 +12809,7 @@ const jsonContentHeaders$b = {
12692
12809
  };
12693
12810
 
12694
12811
  /** Kapsule API. */
12695
- let API$d = class API extends API$p {
12812
+ let API$d = class API extends API$q {
12696
12813
  /** Lists the available regions of the API. */
12697
12814
  static LOCALITIES = ['fr-par', 'nl-ams', 'pl-waw'];
12698
12815
  pageOfListClusters = (request = {}) => this.client.fetch({
@@ -12789,6 +12906,19 @@ let API$d = class API extends API$p {
12789
12906
  path: `/k8s/v1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/clusters/${validatePathParam('clusterId', request.clusterId)}/upgrade`
12790
12907
  }, unmarshalCluster$1);
12791
12908
 
12909
+ /**
12910
+ * Change type of a cluster. Change type of a specific Kubernetes cluster.
12911
+ *
12912
+ * @param request - The request {@link SetClusterTypeRequest}
12913
+ * @returns A Promise of Cluster
12914
+ */
12915
+ setClusterType = request => this.client.fetch({
12916
+ body: JSON.stringify(marshalSetClusterTypeRequest(request, this.client.settings)),
12917
+ headers: jsonContentHeaders$b,
12918
+ method: 'POST',
12919
+ path: `/k8s/v1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/clusters/${validatePathParam('clusterId', request.clusterId)}/set-type`
12920
+ }, unmarshalCluster$1);
12921
+
12792
12922
  /**
12793
12923
  * List available versions for a cluster. List the versions that a specific
12794
12924
  * Kubernetes cluster is allowed to upgrade to. Results will comprise every
@@ -13316,7 +13446,8 @@ const unmarshalHealthCheck = data => {
13316
13446
  pgsqlConfig: data.pgsql_config ? unmarshalHealthCheckPgsqlConfig(data.pgsql_config) : undefined,
13317
13447
  port: data.port,
13318
13448
  redisConfig: data.redis_config ? unmarshalHealthCheckRedisConfig(data.redis_config) : undefined,
13319
- tcpConfig: data.tcp_config ? unmarshalHealthCheckTcpConfig(data.tcp_config) : undefined
13449
+ tcpConfig: data.tcp_config ? unmarshalHealthCheckTcpConfig(data.tcp_config) : undefined,
13450
+ transientCheckDelay: data.transient_check_delay
13320
13451
  };
13321
13452
  };
13322
13453
  const unmarshalLb = data => {
@@ -13370,10 +13501,12 @@ const unmarshalBackend = data => {
13370
13501
  id: data.id,
13371
13502
  ignoreSslServerVerify: data.ignore_ssl_server_verify,
13372
13503
  lb: data.lb ? unmarshalLb(data.lb) : undefined,
13504
+ maxRetries: data.max_retries,
13373
13505
  name: data.name,
13374
13506
  onMarkedDownAction: data.on_marked_down_action,
13375
13507
  pool: data.pool,
13376
13508
  proxyProtocol: data.proxy_protocol,
13509
+ redispatchAttemptCount: data.redispatch_attempt_count,
13377
13510
  sendProxyV2: data.send_proxy_v2,
13378
13511
  sslBridging: data.ssl_bridging,
13379
13512
  stickySessions: data.sticky_sessions,
@@ -13715,21 +13848,22 @@ const marshalHealthCheck = (request, defaults) => ({
13715
13848
  check_send_proxy: request.checkSendProxy,
13716
13849
  check_timeout: request.checkTimeout,
13717
13850
  port: request.port,
13851
+ transient_check_delay: request.transientCheckDelay,
13718
13852
  ...resolveOneOf([{
13853
+ param: 'tcp_config',
13854
+ value: request.tcpConfig ? marshalHealthCheckTcpConfig(request.tcpConfig) : undefined
13855
+ }, {
13719
13856
  param: 'mysql_config',
13720
13857
  value: request.mysqlConfig ? marshalHealthCheckMysqlConfig(request.mysqlConfig) : undefined
13858
+ }, {
13859
+ param: 'pgsql_config',
13860
+ value: request.pgsqlConfig ? marshalHealthCheckPgsqlConfig(request.pgsqlConfig) : undefined
13721
13861
  }, {
13722
13862
  param: 'ldap_config',
13723
13863
  value: request.ldapConfig ? marshalHealthCheckLdapConfig(request.ldapConfig) : undefined
13724
13864
  }, {
13725
13865
  param: 'redis_config',
13726
13866
  value: request.redisConfig ? marshalHealthCheckRedisConfig(request.redisConfig) : undefined
13727
- }, {
13728
- param: 'tcp_config',
13729
- value: request.tcpConfig ? marshalHealthCheckTcpConfig(request.tcpConfig) : undefined
13730
- }, {
13731
- param: 'pgsql_config',
13732
- value: request.pgsqlConfig ? marshalHealthCheckPgsqlConfig(request.pgsqlConfig) : undefined
13733
13867
  }, {
13734
13868
  param: 'http_config',
13735
13869
  value: request.httpConfig ? marshalHealthCheckHttpConfig(request.httpConfig) : undefined
@@ -13787,9 +13921,11 @@ const marshalCreateBackendRequest = (request, defaults) => ({
13787
13921
  forward_protocol: request.forwardProtocol,
13788
13922
  health_check: marshalHealthCheck(request.healthCheck),
13789
13923
  ignore_ssl_server_verify: request.ignoreSslServerVerify,
13924
+ max_retries: request.maxRetries,
13790
13925
  name: request.name || randomName('lbb'),
13791
13926
  on_marked_down_action: request.onMarkedDownAction ?? 'on_marked_down_action_none',
13792
13927
  proxy_protocol: request.proxyProtocol ?? 'proxy_protocol_unknown',
13928
+ redispatch_attempt_count: request.redispatchAttemptCount,
13793
13929
  send_proxy_v2: request.sendProxyV2,
13794
13930
  server_ip: request.serverIp,
13795
13931
  ssl_bridging: request.sslBridging,
@@ -13896,9 +14032,11 @@ const marshalUpdateBackendRequest = (request, defaults) => ({
13896
14032
  forward_port_algorithm: request.forwardPortAlgorithm,
13897
14033
  forward_protocol: request.forwardProtocol,
13898
14034
  ignore_ssl_server_verify: request.ignoreSslServerVerify,
14035
+ max_retries: request.maxRetries,
13899
14036
  name: request.name,
13900
14037
  on_marked_down_action: request.onMarkedDownAction ?? 'on_marked_down_action_none',
13901
14038
  proxy_protocol: request.proxyProtocol ?? 'proxy_protocol_unknown',
14039
+ redispatch_attempt_count: request.redispatchAttemptCount,
13902
14040
  send_proxy_v2: request.sendProxyV2,
13903
14041
  ssl_bridging: request.sslBridging,
13904
14042
  sticky_sessions: request.stickySessions,
@@ -13925,21 +14063,22 @@ const marshalUpdateHealthCheckRequest = (request, defaults) => ({
13925
14063
  check_send_proxy: request.checkSendProxy,
13926
14064
  check_timeout: request.checkTimeout,
13927
14065
  port: request.port,
14066
+ transient_check_delay: request.transientCheckDelay,
13928
14067
  ...resolveOneOf([{
14068
+ param: 'tcp_config',
14069
+ value: request.tcpConfig ? marshalHealthCheckTcpConfig(request.tcpConfig) : undefined
14070
+ }, {
13929
14071
  param: 'mysql_config',
13930
14072
  value: request.mysqlConfig ? marshalHealthCheckMysqlConfig(request.mysqlConfig) : undefined
14073
+ }, {
14074
+ param: 'pgsql_config',
14075
+ value: request.pgsqlConfig ? marshalHealthCheckPgsqlConfig(request.pgsqlConfig) : undefined
13931
14076
  }, {
13932
14077
  param: 'ldap_config',
13933
14078
  value: request.ldapConfig ? marshalHealthCheckLdapConfig(request.ldapConfig) : undefined
13934
14079
  }, {
13935
14080
  param: 'redis_config',
13936
14081
  value: request.redisConfig ? marshalHealthCheckRedisConfig(request.redisConfig) : undefined
13937
- }, {
13938
- param: 'pgsql_config',
13939
- value: request.pgsqlConfig ? marshalHealthCheckPgsqlConfig(request.pgsqlConfig) : undefined
13940
- }, {
13941
- param: 'tcp_config',
13942
- value: request.tcpConfig ? marshalHealthCheckTcpConfig(request.tcpConfig) : undefined
13943
14082
  }, {
13944
14083
  param: 'http_config',
13945
14084
  value: request.httpConfig ? marshalHealthCheckHttpConfig(request.httpConfig) : undefined
@@ -14000,9 +14139,11 @@ const marshalZonedApiCreateBackendRequest = (request, defaults) => ({
14000
14139
  forward_protocol: request.forwardProtocol,
14001
14140
  health_check: marshalHealthCheck(request.healthCheck),
14002
14141
  ignore_ssl_server_verify: request.ignoreSslServerVerify,
14142
+ max_retries: request.maxRetries,
14003
14143
  name: request.name || randomName('lbb'),
14004
14144
  on_marked_down_action: request.onMarkedDownAction ?? 'on_marked_down_action_none',
14005
14145
  proxy_protocol: request.proxyProtocol ?? 'proxy_protocol_unknown',
14146
+ redispatch_attempt_count: request.redispatchAttemptCount,
14006
14147
  send_proxy_v2: request.sendProxyV2,
14007
14148
  server_ip: request.serverIp,
14008
14149
  ssl_bridging: request.sslBridging,
@@ -14112,9 +14253,11 @@ const marshalZonedApiUpdateBackendRequest = (request, defaults) => ({
14112
14253
  forward_port_algorithm: request.forwardPortAlgorithm,
14113
14254
  forward_protocol: request.forwardProtocol,
14114
14255
  ignore_ssl_server_verify: request.ignoreSslServerVerify,
14256
+ max_retries: request.maxRetries,
14115
14257
  name: request.name,
14116
14258
  on_marked_down_action: request.onMarkedDownAction ?? 'on_marked_down_action_none',
14117
14259
  proxy_protocol: request.proxyProtocol ?? 'proxy_protocol_unknown',
14260
+ redispatch_attempt_count: request.redispatchAttemptCount,
14118
14261
  send_proxy_v2: request.sendProxyV2,
14119
14262
  ssl_bridging: request.sslBridging,
14120
14263
  sticky_sessions: request.stickySessions,
@@ -14141,21 +14284,22 @@ const marshalZonedApiUpdateHealthCheckRequest = (request, defaults) => ({
14141
14284
  check_send_proxy: request.checkSendProxy,
14142
14285
  check_timeout: request.checkTimeout,
14143
14286
  port: request.port,
14287
+ transient_check_delay: request.transientCheckDelay,
14144
14288
  ...resolveOneOf([{
14289
+ param: 'tcp_config',
14290
+ value: request.tcpConfig ? marshalHealthCheckTcpConfig(request.tcpConfig) : undefined
14291
+ }, {
14145
14292
  param: 'mysql_config',
14146
14293
  value: request.mysqlConfig ? marshalHealthCheckMysqlConfig(request.mysqlConfig) : undefined
14294
+ }, {
14295
+ param: 'pgsql_config',
14296
+ value: request.pgsqlConfig ? marshalHealthCheckPgsqlConfig(request.pgsqlConfig) : undefined
14147
14297
  }, {
14148
14298
  param: 'ldap_config',
14149
14299
  value: request.ldapConfig ? marshalHealthCheckLdapConfig(request.ldapConfig) : undefined
14150
14300
  }, {
14151
14301
  param: 'redis_config',
14152
14302
  value: request.redisConfig ? marshalHealthCheckRedisConfig(request.redisConfig) : undefined
14153
- }, {
14154
- param: 'pgsql_config',
14155
- value: request.pgsqlConfig ? marshalHealthCheckPgsqlConfig(request.pgsqlConfig) : undefined
14156
- }, {
14157
- param: 'tcp_config',
14158
- value: request.tcpConfig ? marshalHealthCheckTcpConfig(request.tcpConfig) : undefined
14159
14303
  }, {
14160
14304
  param: 'http_config',
14161
14305
  value: request.httpConfig ? marshalHealthCheckHttpConfig(request.httpConfig) : undefined
@@ -14198,7 +14342,7 @@ const jsonContentHeaders$a = {
14198
14342
  *
14199
14343
  * This API allows you to manage your load balancer service. Load balancer API.
14200
14344
  */
14201
- let API$c = class API extends API$p {
14345
+ let API$c = class API extends API$q {
14202
14346
  /** Lists the available regions of the API. */
14203
14347
  static LOCALITIES = ['fr-par', 'nl-ams', 'pl-waw'];
14204
14348
  pageOfListLbs = (request = {}) => this.client.fetch({
@@ -14867,7 +15011,7 @@ let API$c = class API extends API$p {
14867
15011
  * This API allows you to manage your Scaleway Load Balancer services. Load
14868
15012
  * Balancer API.
14869
15013
  */
14870
- class ZonedAPI extends API$p {
15014
+ class ZonedAPI extends API$q {
14871
15015
  /** Lists the available zones of the API. */
14872
15016
  static LOCALITIES = ['fr-par-1', 'fr-par-2', 'nl-ams-1', 'nl-ams-2', 'pl-waw-1', 'pl-waw-2'];
14873
15017
  pageOfListLbs = (request = {}) => this.client.fetch({
@@ -15844,7 +15988,7 @@ const unmarshalListVersionsResponse$1 = data => {
15844
15988
 
15845
15989
  // This file was automatically generated. DO NOT EDIT.
15846
15990
  /** Marketplace API. */
15847
- let API$b = class API extends API$p {
15991
+ let API$b = class API extends API$q {
15848
15992
  pageOfListImages = (request = {}) => this.client.fetch({
15849
15993
  method: 'GET',
15850
15994
  path: `/marketplace/v1/images`,
@@ -15976,7 +16120,7 @@ const unmarshalListVersionsResponse = data => {
15976
16120
 
15977
16121
  // This file was automatically generated. DO NOT EDIT.
15978
16122
  /** Marketplace API. */
15979
- let API$a = class API extends API$p {
16123
+ let API$a = class API extends API$q {
15980
16124
  pageOfListImages = request => this.client.fetch({
15981
16125
  method: 'GET',
15982
16126
  path: `/marketplace/v2/images`,
@@ -16198,7 +16342,7 @@ const jsonContentHeaders$9 = {
16198
16342
  *
16199
16343
  * This API allows you to manage Messaging or Queueing brokers. MnQ API (beta).
16200
16344
  */
16201
- let API$9 = class API extends API$p {
16345
+ let API$9 = class API extends API$q {
16202
16346
  /** Lists the available regions of the API. */
16203
16347
  static LOCALITIES = ['fr-par'];
16204
16348
  pageOfListNamespaces = (request = {}) => this.client.fetch({
@@ -17043,7 +17187,7 @@ const jsonContentHeaders$8 = {
17043
17187
  };
17044
17188
 
17045
17189
  /** Managed Database for PostgreSQL and MySQL API. */
17046
- let API$8 = class API extends API$p {
17190
+ let API$8 = class API extends API$q {
17047
17191
  /** Lists the available regions of the API. */
17048
17192
  static LOCALITIES = ['fr-par', 'nl-ams', 'pl-waw'];
17049
17193
  pageOfListDatabaseEngines = (request = {}) => this.client.fetch({
@@ -17068,8 +17212,8 @@ let API$8 = class API extends API$p {
17068
17212
 
17069
17213
  /**
17070
17214
  * List available node types. List all available node types. By default, the
17071
- * databases returned in the list are ordered by creation date in ascending
17072
- * order, though this can be modified via the order_by field.
17215
+ * node types returned in the list are ordered by creation date in ascending
17216
+ * order, though this can be modified via the `order_by` field.
17073
17217
  *
17074
17218
  * @param request - The request {@link ListNodeTypesRequest}
17075
17219
  * @returns A Promise of ListNodeTypesResponse
@@ -17082,7 +17226,7 @@ let API$8 = class API extends API$p {
17082
17226
  }, unmarshalListDatabaseBackupsResponse);
17083
17227
 
17084
17228
  /**
17085
- * List database backups. List all backups in a specified zone, for a given
17229
+ * List database backups. List all backups in a specified region, for a given
17086
17230
  * Scaleway Organization or Scaleway Project. By default, the backups listed
17087
17231
  * are ordered by creation date in ascending order. This can be modified via
17088
17232
  * the `order_by` field.
@@ -17207,9 +17351,9 @@ let API$8 = class API extends API$p {
17207
17351
  }, unmarshalListInstancesResponse);
17208
17352
 
17209
17353
  /**
17210
- * List Database Instances. List all Database Instances in the specified zone,
17211
- * for a given Scaleway Organization or Scaleway Project. By default, the
17212
- * Database Instances returned in the list are ordered by creation date in
17354
+ * List Database Instances. List all Database Instances in the specified
17355
+ * region, for a given Scaleway Organization or Scaleway Project. By default,
17356
+ * the Database Instances returned in the list are ordered by creation date in
17213
17357
  * ascending order, though this can be modified via the order_by field. You
17214
17358
  * can define additional parameters for your query, such as `tags` and `name`.
17215
17359
  * For the `name` parameter, the value you include will be checked against the
@@ -17351,7 +17495,7 @@ let API$8 = class API extends API$p {
17351
17495
  });
17352
17496
 
17353
17497
  /**
17354
- * Get Database Instance metrics. Retrieve the time series metrics of a give
17498
+ * Get Database Instance metrics. Retrieve the time series metrics of a given
17355
17499
  * Database Instance. You can define the period from which to retrieve metrics
17356
17500
  * by specifying the `start_date` and `end_date`.
17357
17501
  *
@@ -17772,10 +17916,10 @@ let API$8 = class API extends API$p {
17772
17916
 
17773
17917
  /**
17774
17918
  * List snapshots. List snapshots. You can include the `instance_id` or
17775
- * `project_id` in your query to get the list of snaphots for specific
17919
+ * `project_id` in your query to get the list of snapshots for specific
17776
17920
  * Database Instances and/or Projects. By default, the details returned in the
17777
17921
  * list are ordered by creation date in ascending order, though this can be
17778
- * modified via the order_by field.
17922
+ * modified via the `order_by` field.
17779
17923
  *
17780
17924
  * @param request - The request {@link ListSnapshotsRequest}
17781
17925
  * @returns A Promise of ListSnapshotsResponse
@@ -17868,7 +18012,7 @@ let API$8 = class API extends API$p {
17868
18012
 
17869
18013
  /**
17870
18014
  * Create a new Database Instance endpoint. Create a new endpoint for a
17871
- * Database Instance. You can add `load_balacer` and `private_network`
18015
+ * Database Instance. You can add `load_balancer` and `private_network`
17872
18016
  * specifications to the body of the request. Note that this action replaces
17873
18017
  * your current endpoint, which means you might need to update any environment
17874
18018
  * configurations that point to the old endpoint.
@@ -18139,8 +18283,10 @@ const unmarshalSetEndpointsResponse = data => {
18139
18283
  endpoints: unmarshalArrayOfObject(data.endpoints, unmarshalEndpoint)
18140
18284
  };
18141
18285
  };
18286
+ const marshalEndpointSpecPrivateNetworkSpecIpamConfig = (request, defaults) => ({});
18142
18287
  const marshalEndpointSpecPrivateNetworkSpec = (request, defaults) => ({
18143
18288
  id: request.id,
18289
+ ipam_config: request.ipamConfig ? marshalEndpointSpecPrivateNetworkSpecIpamConfig(request.ipamConfig) : undefined,
18144
18290
  service_ips: request.serviceIps
18145
18291
  });
18146
18292
  const marshalEndpointSpecPublicNetworkSpec = (request, defaults) => ({});
@@ -18227,12 +18373,15 @@ const jsonContentHeaders$7 = {
18227
18373
  };
18228
18374
 
18229
18375
  /** Managed Database for Redis™ API. */
18230
- let API$7 = class API extends API$p {
18376
+ let API$7 = class API extends API$q {
18231
18377
  /** Lists the available zones of the API. */
18232
18378
  static LOCALITIES = ['fr-par-1', 'fr-par-2', 'nl-ams-1', 'nl-ams-2', 'pl-waw-1', 'pl-waw-2'];
18233
18379
 
18234
18380
  /**
18235
- * Create a cluster.
18381
+ * Create a Redis™ Database Instance. Create a new Redis™ Database Instance
18382
+ * (Redis™ cluster). You must set the `zone`, `project_id`, `version`,
18383
+ * `node_type`, `user_name` and `password` parameters. Optionally you can
18384
+ * define `acl_rules`, `endpoints`, `tls_enabled` and `cluster_settings`.
18236
18385
  *
18237
18386
  * @param request - The request {@link CreateClusterRequest}
18238
18387
  * @returns A Promise of Cluster
@@ -18245,7 +18394,9 @@ let API$7 = class API extends API$p {
18245
18394
  }, unmarshalCluster);
18246
18395
 
18247
18396
  /**
18248
- * Update a cluster.
18397
+ * Update a Redis™ Database Instance. Update the parameters of a Redis™
18398
+ * Database Instance (Redis™ cluster), including `name`, `tags`, `user_name`
18399
+ * and `password`.
18249
18400
  *
18250
18401
  * @param request - The request {@link UpdateClusterRequest}
18251
18402
  * @returns A Promise of Cluster
@@ -18258,7 +18409,11 @@ let API$7 = class API extends API$p {
18258
18409
  }, unmarshalCluster);
18259
18410
 
18260
18411
  /**
18261
- * Get a cluster.
18412
+ * Get a Redis™ Database Instance. Retrieve information about a Redis™
18413
+ * Database Instance (Redis™ cluster). Specify the `cluster_id` and `region`
18414
+ * in your request to get information such as `id`, `status`, `version`,
18415
+ * `tls_enabled`, `cluster_settings`, `upgradable_versions` and `endpoints`
18416
+ * about your cluster in the response.
18262
18417
  *
18263
18418
  * @param request - The request {@link GetClusterRequest}
18264
18419
  * @returns A Promise of Cluster
@@ -18283,7 +18438,12 @@ let API$7 = class API extends API$p {
18283
18438
  }, unmarshalListClustersResponse);
18284
18439
 
18285
18440
  /**
18286
- * List clusters.
18441
+ * List Redis™ Database Instances. List all Redis™ Database Instances (Redis™
18442
+ * cluster) in the specified zone. By default, the Database Instances returned
18443
+ * in the list are ordered by creation date in ascending order, though this
18444
+ * can be modified via the order_by field. You can define additional
18445
+ * parameters for your query, such as `tags`, `name`, `organization_id` and
18446
+ * `version`.
18287
18447
  *
18288
18448
  * @param request - The request {@link ListClustersRequest}
18289
18449
  * @returns A Promise of ListClustersResponse
@@ -18291,11 +18451,13 @@ let API$7 = class API extends API$p {
18291
18451
  listClusters = (request = {}) => enrichForPagination('clusters', this.pageOfListClusters, request);
18292
18452
 
18293
18453
  /**
18294
- * Migrate your cluster architecture. Upgrade your Database for Redis® cluster
18295
- * to a new version or scale it vertically / horizontally. Please note:
18296
- * scaling horizontally your Database for Redis® cluster won't renew its TLS
18297
- * certificate. In order to refresh the SSL certificate, you have to use the
18298
- * dedicated api route.
18454
+ * Scale up a Redis™ Database Instance. Upgrade your standalone Redis
18455
+ * Database Instance node, either by upgrading to a bigger node type (vertical
18456
+ * scaling) or by adding more nodes to your Database Instance to increase your
18457
+ * number of endpoints and distribute cache (horizontal scaling). Note that
18458
+ * scaling horizontally your Redis™ Database Instance will not renew its TLS
18459
+ * certificate. In order to refresh the TLS certificate, you must use the
18460
+ * Renew TLS certificate endpoint.
18299
18461
  *
18300
18462
  * @param request - The request {@link MigrateClusterRequest}
18301
18463
  * @returns A Promise of Cluster
@@ -18308,7 +18470,10 @@ let API$7 = class API extends API$p {
18308
18470
  }, unmarshalCluster);
18309
18471
 
18310
18472
  /**
18311
- * Delete a cluster.
18473
+ * Delete a Redis™ Database Instance. Delete a Redis™ Database Instance
18474
+ * (Redis™ cluster), specified by the `region` and `cluster_id` parameters.
18475
+ * Deleting a Database Instance is permanent, and cannot be undone. Note that
18476
+ * upon deletion all your data will be lost.
18312
18477
  *
18313
18478
  * @param request - The request {@link DeleteClusterRequest}
18314
18479
  * @returns A Promise of Cluster
@@ -18319,7 +18484,9 @@ let API$7 = class API extends API$p {
18319
18484
  }, unmarshalCluster);
18320
18485
 
18321
18486
  /**
18322
- * Get metrics of a cluster.
18487
+ * Get metrics of a Redis™ Database Instance. Retrieve the metrics of a Redis™
18488
+ * Database Instance (Redis™ cluster). You can define the period from which to
18489
+ * retrieve metrics by specifying the `start_date` and `end_date`.
18323
18490
  *
18324
18491
  * @param request - The request {@link GetClusterMetricsRequest}
18325
18492
  * @returns A Promise of ClusterMetricsResponse
@@ -18336,7 +18503,9 @@ let API$7 = class API extends API$p {
18336
18503
  }, unmarshalListNodeTypesResponse);
18337
18504
 
18338
18505
  /**
18339
- * List available node types.
18506
+ * List available node types. List all available node types. By default, the
18507
+ * node types returned in the list are ordered by creation date in ascending
18508
+ * order, though this can be modified via the `order_by` field.
18340
18509
  *
18341
18510
  * @param request - The request {@link ListNodeTypesRequest}
18342
18511
  * @returns A Promise of ListNodeTypesResponse
@@ -18349,7 +18518,9 @@ let API$7 = class API extends API$p {
18349
18518
  }, unmarshalListClusterVersionsResponse);
18350
18519
 
18351
18520
  /**
18352
- * List available Redis™ versions.
18521
+ * List available Redis™ versions. List the Redis™ database engine versions
18522
+ * available. You can define additional parameters for your query, such as
18523
+ * `include_disabled`, `include_beta`, `include_deprecated` and `version`.
18353
18524
  *
18354
18525
  * @param request - The request {@link ListClusterVersionsRequest}
18355
18526
  * @returns A Promise of ListClusterVersionsResponse
@@ -18357,7 +18528,9 @@ let API$7 = class API extends API$p {
18357
18528
  listClusterVersions = request => enrichForPagination('versions', this.pageOfListClusterVersions, request);
18358
18529
 
18359
18530
  /**
18360
- * Get the TLS certificate of a cluster.
18531
+ * Get the TLS certificate of a cluster. Retrieve information about the TLS
18532
+ * certificate of a Redis™ Database Instance (Redis™ cluster). Details like
18533
+ * name and content are returned in the response.
18361
18534
  *
18362
18535
  * @param request - The request {@link GetClusterCertificateRequest}
18363
18536
  * @returns A Promise of Blob
@@ -18370,7 +18543,11 @@ let API$7 = class API extends API$p {
18370
18543
  });
18371
18544
 
18372
18545
  /**
18373
- * Renew the TLS certificate of a cluster.
18546
+ * Renew the TLS certificate of a cluster. Renew a TLS certificate for a
18547
+ * Redis™ Database Instance (Redis™ cluster). Renewing a certificate means
18548
+ * that you will not be able to connect to your Database Instance using the
18549
+ * previous certificate. You will also need to download and update the new
18550
+ * certificate for all database clients.
18374
18551
  *
18375
18552
  * @param request - The request {@link RenewClusterCertificateRequest}
18376
18553
  * @returns A Promise of Cluster
@@ -18383,7 +18560,9 @@ let API$7 = class API extends API$p {
18383
18560
  }, unmarshalCluster);
18384
18561
 
18385
18562
  /**
18386
- * Add cluster settings.
18563
+ * Add advanced settings. Add an advanced setting to a Redis™ Database
18564
+ * Instance (Redis™ cluster). You must set the `name` and the `value` of each
18565
+ * setting.
18387
18566
  *
18388
18567
  * @param request - The request {@link AddClusterSettingsRequest}
18389
18568
  * @returns A Promise of ClusterSettingsResponse
@@ -18396,7 +18575,9 @@ let API$7 = class API extends API$p {
18396
18575
  }, unmarshalClusterSettingsResponse);
18397
18576
 
18398
18577
  /**
18399
- * Delete a cluster setting.
18578
+ * Delete advanced setting. Delete an advanced setting in a Redis™ Database
18579
+ * Instance (Redis™ cluster). You must specify the names of the settings you
18580
+ * want to delete in the request body.
18400
18581
  *
18401
18582
  * @param request - The request {@link DeleteClusterSettingRequest}
18402
18583
  * @returns A Promise of Cluster
@@ -18407,7 +18588,9 @@ let API$7 = class API extends API$p {
18407
18588
  }, unmarshalCluster);
18408
18589
 
18409
18590
  /**
18410
- * Set cluster settings.
18591
+ * Set advanced settings. Update an advanced setting for a Redis™ Database
18592
+ * Instance (Redis™ cluster). Settings added upon database engine
18593
+ * initalization can only be defined once, and cannot, therefore, be updated.
18411
18594
  *
18412
18595
  * @param request - The request {@link SetClusterSettingsRequest}
18413
18596
  * @returns A Promise of ClusterSettingsResponse
@@ -18420,7 +18603,8 @@ let API$7 = class API extends API$p {
18420
18603
  }, unmarshalClusterSettingsResponse);
18421
18604
 
18422
18605
  /**
18423
- * Set ACL rules for a given cluster.
18606
+ * Set ACL rules for a cluster. Replace all the ACL rules of a Redis™ Database
18607
+ * Instance (Redis™ cluster).
18424
18608
  *
18425
18609
  * @param request - The request {@link SetAclRulesRequest}
18426
18610
  * @returns A Promise of SetAclRulesResponse
@@ -18433,7 +18617,8 @@ let API$7 = class API extends API$p {
18433
18617
  }, unmarshalSetAclRulesResponse);
18434
18618
 
18435
18619
  /**
18436
- * Add ACL rules for a given cluster.
18620
+ * Add ACL rules for a cluster. Add an additional ACL rule to a Redis™
18621
+ * Database Instance (Redis™ cluster).
18437
18622
  *
18438
18623
  * @param request - The request {@link AddAclRulesRequest}
18439
18624
  * @returns A Promise of AddAclRulesResponse
@@ -18446,7 +18631,9 @@ let API$7 = class API extends API$p {
18446
18631
  }, unmarshalAddAclRulesResponse);
18447
18632
 
18448
18633
  /**
18449
- * Delete an ACL rule for a given cluster.
18634
+ * Delete an ACL rule for a cluster. Delete an ACL rule of a Redis™ Database
18635
+ * Instance (Redis™ cluster). You must specify the `acl_id` of the rule you
18636
+ * want to delete in your request.
18450
18637
  *
18451
18638
  * @param request - The request {@link DeleteAclRuleRequest}
18452
18639
  * @returns A Promise of Cluster
@@ -18457,7 +18644,9 @@ let API$7 = class API extends API$p {
18457
18644
  }, unmarshalCluster);
18458
18645
 
18459
18646
  /**
18460
- * Get an ACL rule.
18647
+ * Get an ACL rule. Retrieve information about an ACL rule of a Redis™
18648
+ * Database Instance (Redis™ cluster). You must specify the `acl_id` of the
18649
+ * rule in your request.
18461
18650
  *
18462
18651
  * @param request - The request {@link GetAclRuleRequest}
18463
18652
  * @returns A Promise of ACLRule
@@ -18468,7 +18657,9 @@ let API$7 = class API extends API$p {
18468
18657
  }, unmarshalACLRule);
18469
18658
 
18470
18659
  /**
18471
- * Set endpoints for a given cluster.
18660
+ * Set endpoints for a cluster. Update an endpoint for a Redis™ Database
18661
+ * Instance (Redis™ cluster). You must specify the `cluster_id` and the
18662
+ * `endpoints` parameters in your request.
18472
18663
  *
18473
18664
  * @param request - The request {@link SetEndpointsRequest}
18474
18665
  * @returns A Promise of SetEndpointsResponse
@@ -18481,7 +18672,9 @@ let API$7 = class API extends API$p {
18481
18672
  }, unmarshalSetEndpointsResponse);
18482
18673
 
18483
18674
  /**
18484
- * Add endpoints for a given cluster.
18675
+ * Add endpoints for a cluster. Add a new endpoint for a Redis™ Database
18676
+ * Instance (Redis™ cluster). You can add `private_network` or
18677
+ * `public_network` specifications to the body of the request.
18485
18678
  *
18486
18679
  * @param request - The request {@link AddEndpointsRequest}
18487
18680
  * @returns A Promise of AddEndpointsResponse
@@ -18494,7 +18687,10 @@ let API$7 = class API extends API$p {
18494
18687
  }, unmarshalAddEndpointsResponse);
18495
18688
 
18496
18689
  /**
18497
- * Delete an endpoint for a given cluster.
18690
+ * Delete an endpoint for a cluster. Delete the endpoint of a Redis™ Database
18691
+ * Instance (Redis™ cluster). You must specify the `region` and `endpoint_id`
18692
+ * parameters of the endpoint you want to delete. Note that might need to
18693
+ * update any environment configurations that point to the deleted endpoint.
18498
18694
  *
18499
18695
  * @param request - The request {@link DeleteEndpointRequest}
18500
18696
  * @returns A Promise of Cluster
@@ -18505,7 +18701,10 @@ let API$7 = class API extends API$p {
18505
18701
  }, unmarshalCluster);
18506
18702
 
18507
18703
  /**
18508
- * Get an endpoint.
18704
+ * Get an endpoint. Retrieve information about a Redis™ Database Instance
18705
+ * (Redis™ cluster) endpoint. Full details about the endpoint, like `ips`,
18706
+ * `port`, `private_network` and `public_network` specifications are returned
18707
+ * in the response.
18509
18708
  *
18510
18709
  * @param request - The request {@link GetEndpointRequest}
18511
18710
  * @returns A Promise of Endpoint
@@ -18514,6 +18713,16 @@ let API$7 = class API extends API$p {
18514
18713
  method: 'GET',
18515
18714
  path: `/redis/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/endpoints/${validatePathParam('endpointId', request.endpointId)}`
18516
18715
  }, unmarshalEndpoint);
18716
+
18717
+ /**
18718
+ * Update an endpoint. Update information about a Redis™ Database Instance
18719
+ * (Redis™ cluster) endpoint. Full details about the endpoint, like `ips`,
18720
+ * `port`, `private_network` and `public_network` specifications are returned
18721
+ * in the response.
18722
+ *
18723
+ * @param request - The request {@link UpdateEndpointRequest}
18724
+ * @returns A Promise of Endpoint
18725
+ */
18517
18726
  updateEndpoint = request => this.client.fetch({
18518
18727
  body: JSON.stringify(marshalUpdateEndpointRequest(request, this.client.settings)),
18519
18728
  headers: jsonContentHeaders$7,
@@ -18659,7 +18868,7 @@ const jsonContentHeaders$6 = {
18659
18868
  *
18660
18869
  * Container registry API. Registry API.
18661
18870
  */
18662
- let API$6 = class API extends API$p {
18871
+ let API$6 = class API extends API$q {
18663
18872
  /** Lists the available regions of the API. */
18664
18873
  static LOCALITIES = ['fr-par', 'nl-ams', 'pl-waw'];
18665
18874
  pageOfListNamespaces = (request = {}) => this.client.fetch({
@@ -18912,6 +19121,13 @@ const unmarshalListSecretsResponse = data => {
18912
19121
  totalCount: data.total_count
18913
19122
  };
18914
19123
  };
19124
+ const marshalPasswordGenerationParams = (request, defaults) => ({
19125
+ additional_chars: request.additionalChars,
19126
+ length: request.length,
19127
+ no_digits: request.noDigits,
19128
+ no_lowercase_letters: request.noLowercaseLetters,
19129
+ no_uppercase_letters: request.noUppercaseLetters
19130
+ });
18915
19131
  const marshalCreateSecretRequest = (request, defaults) => ({
18916
19132
  description: request.description,
18917
19133
  name: request.name,
@@ -18920,7 +19136,12 @@ const marshalCreateSecretRequest = (request, defaults) => ({
18920
19136
  });
18921
19137
  const marshalCreateSecretVersionRequest = (request, defaults) => ({
18922
19138
  data: request.data,
18923
- description: request.description
19139
+ description: request.description,
19140
+ disable_previous: request.disablePrevious,
19141
+ ...resolveOneOf([{
19142
+ param: 'password_generation',
19143
+ value: request.passwordGeneration ? marshalPasswordGenerationParams(request.passwordGeneration) : undefined
19144
+ }])
18924
19145
  });
18925
19146
  const marshalUpdateSecretRequest = (request, defaults) => ({
18926
19147
  description: request.description,
@@ -18937,17 +19158,17 @@ const jsonContentHeaders$5 = {
18937
19158
  };
18938
19159
 
18939
19160
  /**
18940
- * Secret API (beta).
19161
+ * Secret Manager API documentation.
18941
19162
  *
18942
19163
  * This API allows you to conveniently store, access and share sensitive data.
18943
- * Secret API (beta).
19164
+ * Secret Manager API documentation.
18944
19165
  */
18945
- let API$5 = class API extends API$p {
19166
+ let API$5 = class API extends API$q {
18946
19167
  /** Lists the available regions of the API. */
18947
19168
  static LOCALITIES = ['fr-par'];
18948
19169
 
18949
19170
  /**
18950
- * Create a Secret containing no versions.
19171
+ * Create a secret. You must sepcify the `region` to create a secret.
18951
19172
  *
18952
19173
  * @param request - The request {@link CreateSecretRequest}
18953
19174
  * @returns A Promise of Secret
@@ -18960,7 +19181,8 @@ let API$5 = class API extends API$p {
18960
19181
  }, unmarshalSecret);
18961
19182
 
18962
19183
  /**
18963
- * Get metadata of a Secret.
19184
+ * Get metadata using the secret's name. Retrieve the metadata of a secret
19185
+ * specified by the `region` and the `secret_name` parameters.
18964
19186
  *
18965
19187
  * @param request - The request {@link GetSecretRequest}
18966
19188
  * @returns A Promise of Secret
@@ -18971,7 +19193,8 @@ let API$5 = class API extends API$p {
18971
19193
  }, unmarshalSecret);
18972
19194
 
18973
19195
  /**
18974
- * Get metadata of a Secret.
19196
+ * Get metadata using the secret's ID. Retrieve the metadata of a secret
19197
+ * specified by the `region` and the `secret_id` parameters.
18975
19198
  *
18976
19199
  * @param request - The request {@link GetSecretByNameRequest}
18977
19200
  * @returns A Promise of Secret
@@ -18982,7 +19205,9 @@ let API$5 = class API extends API$p {
18982
19205
  }, unmarshalSecret);
18983
19206
 
18984
19207
  /**
18985
- * Update metadata of a Secret.
19208
+ * Update metadata of a secret. Edit a secret's metadata such as name, tag(s)
19209
+ * and description. The secret to update is specified by the `secret_id` and
19210
+ * `region` parameters.
18986
19211
  *
18987
19212
  * @param request - The request {@link UpdateSecretRequest}
18988
19213
  * @returns A Promise of Secret
@@ -19000,7 +19225,9 @@ let API$5 = class API extends API$p {
19000
19225
  }, unmarshalListSecretsResponse);
19001
19226
 
19002
19227
  /**
19003
- * List Secrets.
19228
+ * List secrets. Retrieve the list of secrets created within an Organization
19229
+ * and/or Project. You must specify either the `organization_id` or the
19230
+ * `project_id` and the `region`.
19004
19231
  *
19005
19232
  * @param request - The request {@link ListSecretsRequest}
19006
19233
  * @returns A Promise of ListSecretsResponse
@@ -19008,7 +19235,8 @@ let API$5 = class API extends API$p {
19008
19235
  listSecrets = (request = {}) => enrichForPagination('secrets', this.pageOfListSecrets, request);
19009
19236
 
19010
19237
  /**
19011
- * Delete a secret.
19238
+ * Delete a secret. Delete a given secret specified by the `region` and
19239
+ * `secret_id` parameters.
19012
19240
  *
19013
19241
  * @param request - The request {@link DeleteSecretRequest}
19014
19242
  */
@@ -19018,7 +19246,8 @@ let API$5 = class API extends API$p {
19018
19246
  });
19019
19247
 
19020
19248
  /**
19021
- * Create a SecretVersion.
19249
+ * Create a version. Create a version of a given secret specified by the
19250
+ * `region` and `secret_id` parameters.
19022
19251
  *
19023
19252
  * @param request - The request {@link CreateSecretVersionRequest}
19024
19253
  * @returns A Promise of SecretVersion
@@ -19031,7 +19260,9 @@ let API$5 = class API extends API$p {
19031
19260
  }, unmarshalSecretVersion);
19032
19261
 
19033
19262
  /**
19034
- * Get metadata of a SecretVersion.
19263
+ * Get metadata of a secret's version using the secret's ID. Retrieve the
19264
+ * metadata of a secret's given version specified by the `region`, `secret_id`
19265
+ * and `revision` parameters.
19035
19266
  *
19036
19267
  * @param request - The request {@link GetSecretVersionRequest}
19037
19268
  * @returns A Promise of SecretVersion
@@ -19042,7 +19273,9 @@ let API$5 = class API extends API$p {
19042
19273
  }, unmarshalSecretVersion);
19043
19274
 
19044
19275
  /**
19045
- * Get metadata of a SecretVersion.
19276
+ * Get metadata of a secret's version using the secret's name. Retrieve the
19277
+ * metadata of a secret's given version specified by the `region`,
19278
+ * `secret_name` and `revision` parameters.
19046
19279
  *
19047
19280
  * @param request - The request {@link GetSecretVersionByNameRequest}
19048
19281
  * @returns A Promise of SecretVersion
@@ -19053,7 +19286,8 @@ let API$5 = class API extends API$p {
19053
19286
  }, unmarshalSecretVersion);
19054
19287
 
19055
19288
  /**
19056
- * Update metadata of a SecretVersion.
19289
+ * Update metadata of a version. Edit the metadata of a secret's given
19290
+ * version, specified by the `region`, `secret_id` and `revision` parameters.
19057
19291
  *
19058
19292
  * @param request - The request {@link UpdateSecretVersionRequest}
19059
19293
  * @returns A Promise of SecretVersion
@@ -19071,7 +19305,9 @@ let API$5 = class API extends API$p {
19071
19305
  }, unmarshalListSecretVersionsResponse);
19072
19306
 
19073
19307
  /**
19074
- * List versions of a secret, not returning any sensitive data.
19308
+ * List versions of a secret using the secret's ID. Retrieve the list of a
19309
+ * given secret's versions specified by the `secret_id` and `region`
19310
+ * parameters.
19075
19311
  *
19076
19312
  * @param request - The request {@link ListSecretVersionsRequest}
19077
19313
  * @returns A Promise of ListSecretVersionsResponse
@@ -19084,7 +19320,9 @@ let API$5 = class API extends API$p {
19084
19320
  }, unmarshalListSecretVersionsResponse);
19085
19321
 
19086
19322
  /**
19087
- * List versions of a secret, not returning any sensitive data.
19323
+ * List versions of a secret using the secret's name. Retrieve the list of a
19324
+ * given secret's versions specified by the `secret_name` and `region`
19325
+ * parameters.
19088
19326
  *
19089
19327
  * @param request - The request {@link ListSecretVersionsByNameRequest}
19090
19328
  * @returns A Promise of ListSecretVersionsResponse
@@ -19092,7 +19330,8 @@ let API$5 = class API extends API$p {
19092
19330
  listSecretVersionsByName = request => enrichForPagination('versions', this.pageOfListSecretVersionsByName, request);
19093
19331
 
19094
19332
  /**
19095
- * Destroy a SecretVersion, permanently destroying the sensitive data.
19333
+ * Delete a version. Delete a secret's version and the sensitive data
19334
+ * contained in it. Deleting a version is permanent and cannot be undone.
19096
19335
  *
19097
19336
  * @param request - The request {@link DestroySecretVersionRequest}
19098
19337
  * @returns A Promise of SecretVersion
@@ -19105,7 +19344,8 @@ let API$5 = class API extends API$p {
19105
19344
  }, unmarshalSecretVersion);
19106
19345
 
19107
19346
  /**
19108
- * Enable a SecretVersion.
19347
+ * Enable a version. Make a specific version accessible. You must specify the
19348
+ * `region`, `secret_id` and `revision` parameters.
19109
19349
  *
19110
19350
  * @param request - The request {@link EnableSecretVersionRequest}
19111
19351
  * @returns A Promise of SecretVersion
@@ -19118,7 +19358,8 @@ let API$5 = class API extends API$p {
19118
19358
  }, unmarshalSecretVersion);
19119
19359
 
19120
19360
  /**
19121
- * Disable a SecretVersion.
19361
+ * Disable a version. Make a specific version inaccessible. You must specify
19362
+ * the `region`, `secret_id` and `revision` parameters.
19122
19363
  *
19123
19364
  * @param request - The request {@link DisableSecretVersionRequest}
19124
19365
  * @returns A Promise of SecretVersion
@@ -19131,7 +19372,9 @@ let API$5 = class API extends API$p {
19131
19372
  }, unmarshalSecretVersion);
19132
19373
 
19133
19374
  /**
19134
- * Access a SecretVersion, returning the sensitive data.
19375
+ * Access a secret's version using the secret's ID. Access sensitive data in a
19376
+ * secret's version specified by the `region`, `secret_id` and `revision`
19377
+ * parameters.
19135
19378
  *
19136
19379
  * @param request - The request {@link AccessSecretVersionRequest}
19137
19380
  * @returns A Promise of AccessSecretVersionResponse
@@ -19142,7 +19385,9 @@ let API$5 = class API extends API$p {
19142
19385
  }, unmarshalAccessSecretVersionResponse);
19143
19386
 
19144
19387
  /**
19145
- * Access a SecretVersion, returning the sensitive data.
19388
+ * Access a secret's version using the secret's name. Access sensitive data in
19389
+ * a secret's version specified by the `region`, `secret_name` and `revision`
19390
+ * parameters.
19146
19391
  *
19147
19392
  * @param request - The request {@link AccessSecretVersionByNameRequest}
19148
19393
  * @returns A Promise of AccessSecretVersionResponse
@@ -19266,7 +19511,7 @@ const jsonContentHeaders$4 = {
19266
19511
  * access-key. Then, you can use other test commands by setting the
19267
19512
  * SCW_SECRET_KEY env variable.
19268
19513
  */
19269
- let API$4 = class API extends API$p {
19514
+ let API$4 = class API extends API$q {
19270
19515
  /**
19271
19516
  * Register a user. Register a human and return a access-key and a secret-key
19272
19517
  * that must be used in all other commands.
@@ -19541,16 +19786,19 @@ const jsonContentHeaders$3 = {
19541
19786
  };
19542
19787
 
19543
19788
  /**
19544
- * Transactional Email API.
19789
+ * Transactional Email API documentation.
19545
19790
  *
19546
- * Tem. Transactional Email API.
19791
+ * Tem. Transactional Email API documentation.
19547
19792
  */
19548
- let API$3 = class API extends API$p {
19793
+ let API$3 = class API extends API$q {
19549
19794
  /** Lists the available regions of the API. */
19550
19795
  static LOCALITIES = ['fr-par'];
19551
19796
 
19552
19797
  /**
19553
- * Send an email.
19798
+ * Send an email. You must specify the `region`, the sender and the
19799
+ * recipient's information and the `project_id` to send an email from a
19800
+ * checked domain. The subject of the email must contain at least 6
19801
+ * characters.
19554
19802
  *
19555
19803
  * @param request - The request {@link CreateEmailRequest}
19556
19804
  * @returns A Promise of CreateEmailResponse
@@ -19563,7 +19811,8 @@ let API$3 = class API extends API$p {
19563
19811
  }, unmarshalCreateEmailResponse);
19564
19812
 
19565
19813
  /**
19566
- * Get information about an email.
19814
+ * Get an email. Retrieve information about a specific email using the
19815
+ * `email_id` and `region` parameters.
19567
19816
  *
19568
19817
  * @param request - The request {@link GetEmailRequest}
19569
19818
  * @returns A Promise of Email
@@ -19588,8 +19837,8 @@ let API$3 = class API extends API$p {
19588
19837
  }, unmarshalListEmailsResponse);
19589
19838
 
19590
19839
  /**
19591
- * List emails sent from a domain and/or for a project and/or for an
19592
- * organization.
19840
+ * List emails. Retrieve the list of emails sent from a specific domain or for
19841
+ * a specific Project or Organization. You must specify the `region`.
19593
19842
  *
19594
19843
  * @param request - The request {@link ListEmailsRequest}
19595
19844
  * @returns A Promise of ListEmailsResponse
@@ -19597,7 +19846,7 @@ let API$3 = class API extends API$p {
19597
19846
  listEmails = (request = {}) => enrichForPagination('emails', this.pageOfListEmails, request);
19598
19847
 
19599
19848
  /**
19600
- * Get statistics on the email statuses.
19849
+ * Email statuses. Get information on your emails' statuses.
19601
19850
  *
19602
19851
  * @param request - The request {@link GetStatisticsRequest}
19603
19852
  * @returns A Promise of Statistics
@@ -19609,7 +19858,9 @@ let API$3 = class API extends API$p {
19609
19858
  }, unmarshalStatistics);
19610
19859
 
19611
19860
  /**
19612
- * Try to cancel an email if it has not yet been sent.
19861
+ * Cancel an email. You can cancel the sending of an email if it has not been
19862
+ * sent yet. You must specify the `region` and the `email_id` of the email you
19863
+ * want to cancel.
19613
19864
  *
19614
19865
  * @param request - The request {@link CancelEmailRequest}
19615
19866
  * @returns A Promise of Email
@@ -19622,7 +19873,8 @@ let API$3 = class API extends API$p {
19622
19873
  }, unmarshalEmail);
19623
19874
 
19624
19875
  /**
19625
- * Register a domain in a project.
19876
+ * Register a domain in a project. You must specify the `region`, `project_id`
19877
+ * and `domain_name` to register a domain in a specific Project.
19626
19878
  *
19627
19879
  * @param request - The request {@link CreateDomainRequest}
19628
19880
  * @returns A Promise of Domain
@@ -19635,7 +19887,8 @@ let API$3 = class API extends API$p {
19635
19887
  }, unmarshalDomain);
19636
19888
 
19637
19889
  /**
19638
- * Get information about a domain.
19890
+ * Get information about a domain. Retrieve information about a specific
19891
+ * domain using the `region` and `domain_id` parameters.
19639
19892
  *
19640
19893
  * @param request - The request {@link GetDomainRequest}
19641
19894
  * @returns A Promise of Domain
@@ -19660,7 +19913,8 @@ let API$3 = class API extends API$p {
19660
19913
  }, unmarshalListDomainsResponse);
19661
19914
 
19662
19915
  /**
19663
- * List domains in a project and/or in an organization.
19916
+ * List domains. Retrieve domains in a specific project or in a specific
19917
+ * Organization using the `region` parameter.
19664
19918
  *
19665
19919
  * @param request - The request {@link ListDomainsRequest}
19666
19920
  * @returns A Promise of ListDomainsResponse
@@ -19668,7 +19922,9 @@ let API$3 = class API extends API$p {
19668
19922
  listDomains = (request = {}) => enrichForPagination('domains', this.pageOfListDomains, request);
19669
19923
 
19670
19924
  /**
19671
- * Revoke a domain.
19925
+ * Delete a domain. You must specify the domain you want to delete by the
19926
+ * `region` and `domain_id`. Deleting a domain is permanent and cannot be
19927
+ * undone.
19672
19928
  *
19673
19929
  * @param request - The request {@link RevokeDomainRequest}
19674
19930
  * @returns A Promise of Domain
@@ -19681,7 +19937,8 @@ let API$3 = class API extends API$p {
19681
19937
  }, unmarshalDomain);
19682
19938
 
19683
19939
  /**
19684
- * Ask for an immediate check of a domain (DNS check).
19940
+ * Domain DNS check. Perform an immediate DNS check of a domain using the
19941
+ * `region` and `domain_id` parameters.
19685
19942
  *
19686
19943
  * @param request - The request {@link CheckDomainRequest}
19687
19944
  * @returns A Promise of Domain
@@ -19752,13 +20009,13 @@ const jsonContentHeaders$2 = {
19752
20009
  };
19753
20010
 
19754
20011
  /** VPC API. */
19755
- let API$2 = class API extends API$p {
20012
+ let API$2 = class API extends API$q {
19756
20013
  /** Lists the available zones of the API. */
19757
20014
  static LOCALITIES = ['fr-par-1', 'fr-par-2', 'fr-par-3', 'nl-ams-1', 'nl-ams-2', 'pl-waw-1', 'pl-waw-2'];
19758
20015
  pageOfListPrivateNetworks = (request = {}) => this.client.fetch({
19759
20016
  method: 'GET',
19760
20017
  path: `/vpc/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/private-networks`,
19761
- urlParams: urlParams(['name', request.name], ['order_by', request.orderBy ?? 'created_at_asc'], ['organization_id', request.organizationId], ['page', request.page], ['page_size', request.pageSize ?? this.client.settings.defaultPageSize], ['private_network_ids', request.privateNetworkIds], ['project_id', request.projectId], ['tags', request.tags])
20018
+ urlParams: urlParams(['include_regional', request.includeRegional], ['name', request.name], ['order_by', request.orderBy ?? 'created_at_asc'], ['organization_id', request.organizationId], ['page', request.page], ['page_size', request.pageSize ?? this.client.settings.defaultPageSize], ['private_network_ids', request.privateNetworkIds], ['project_id', request.projectId], ['tags', request.tags])
19762
20019
  }, unmarshalListPrivateNetworksResponse);
19763
20020
 
19764
20021
  /**
@@ -20178,7 +20435,7 @@ const jsonContentHeaders$1 = {
20178
20435
  };
20179
20436
 
20180
20437
  /** Public Gateways API. */
20181
- let API$1 = class API extends API$p {
20438
+ let API$1 = class API extends API$q {
20182
20439
  /** Lists the available zones of the API. */
20183
20440
  static LOCALITIES = ['fr-par-1', 'fr-par-2', 'nl-ams-1', 'nl-ams-2', 'pl-waw-1', 'pl-waw-2'];
20184
20441
  pageOfListGateways = (request = {}) => this.client.fetch({
@@ -20883,7 +21140,7 @@ const jsonContentHeaders = {
20883
21140
  };
20884
21141
 
20885
21142
  /** Webhosting API. */
20886
- class API extends API$p {
21143
+ class API extends API$q {
20887
21144
  /** Lists the available regions of the API. */
20888
21145
  static LOCALITIES = ['fr-par'];
20889
21146
 
@@ -20958,7 +21215,7 @@ class API extends API$p {
20958
21215
  }, unmarshalHosting);
20959
21216
 
20960
21217
  /**
20961
- * Retore a hosting. Restore a hosting with the given ID.
21218
+ * Restore a hosting. Restore a hosting with the given ID.
20962
21219
  *
20963
21220
  * @param request - The request {@link RestoreHostingRequest}
20964
21221
  * @returns A Promise of Hosting
@@ -20971,7 +21228,8 @@ class API extends API$p {
20971
21228
  }, unmarshalHosting);
20972
21229
 
20973
21230
  /**
20974
- * Get the DNS records. Get the DNS records of a specified domain.
21231
+ * Get the DNS records. The set of DNS record of a specific domain associated
21232
+ * to a hosting.
20975
21233
  *
20976
21234
  * @param request - The request {@link GetDomainDnsRecordsRequest}
20977
21235
  * @returns A Promise of DnsRecords
@@ -21026,10 +21284,11 @@ var index = /*#__PURE__*/Object.freeze({
21026
21284
  v1alpha1: index_gen
21027
21285
  });
21028
21286
 
21029
- exports.API = API$p;
21030
- exports.Account = index$r;
21031
- exports.AppleSilicon = index$q;
21032
- exports.BareMetal = index$o;
21287
+ exports.API = API$q;
21288
+ exports.Account = index$s;
21289
+ exports.AppleSilicon = index$r;
21290
+ exports.BareMetal = index$p;
21291
+ exports.Billing = index$o;
21033
21292
  exports.Cockpit = index$n;
21034
21293
  exports.Container = index$m;
21035
21294
  exports.Domain = index$l;