@scaleway/sdk 1.7.0 → 1.9.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.
package/dist/index.cjs CHANGED
@@ -426,7 +426,7 @@ const assertValidSettings = obj => {
426
426
  }
427
427
  };
428
428
 
429
- const version = 'v1.6.0';
429
+ const version = 'v1.8.0';
430
430
  const userAgent = `scaleway-sdk-js/${version}`;
431
431
 
432
432
  const isBrowser = () => typeof window !== 'undefined' && typeof window.document !== 'undefined';
@@ -1886,6 +1886,18 @@ const enrichForPagination = (key, fetcher, request) => {
1886
1886
  });
1887
1887
  };
1888
1888
 
1889
+ const ADJECTIVES = ['admiring', 'adoring', 'affectionate', 'agitated', 'amazing', 'angry', 'awesome', 'beautiful', 'blissful', 'bold', 'boring', 'brave', 'busy', 'charming', 'clever', 'cool', 'compassionate', 'competent', 'condescending', 'confident', 'cranky', 'crazy', 'dazzling', 'determined', 'distracted', 'dreamy', 'eager', 'ecstatic', 'elastic', 'elated', 'elegant', 'eloquent', 'epic', 'exciting', 'fervent', 'festive', 'flamboyant', 'focused', 'friendly', 'frosty', 'funny', 'gallant', 'gifted', 'goofy', 'gracious', 'great', 'happy', 'hardcore', 'heuristic', 'hopeful', 'hungry', 'infallible', 'inspiring', 'interesting', 'intelligent', 'jolly', 'jovial', 'keen', 'kind', 'laughing', 'loving', 'lucid', 'magical', 'mystifying', 'modest', 'musing', 'naughty', 'nervous', 'nice', 'nifty', 'nostalgic', 'objective', 'optimistic', 'peaceful', 'pedantic', 'pensive', 'practical', 'priceless', 'quirky', 'quizzical', 'recursing', 'relaxed', 'reverent', 'romantic', 'sad', 'serene', 'sharp', 'silly', 'sleepy', 'stoic', 'strange', 'stupefied', 'suspicious', 'sweet', 'tender', 'thirsty', 'trusting', 'unruffled', 'upbeat', 'vibrant', 'vigilant', 'vigorous', 'wizardly', 'wonderful', 'xenodochial', 'youthful', 'zealous', 'zen'];
1890
+ const NAMES = ['albattani', 'allen', 'almeida', 'antonelli', 'agnesi', 'archimedes', 'ardinghelli', 'aryabhata', 'austin', 'babbage', 'banach', 'banzai', 'bardeen', 'bartik', 'bassi', 'beaver', 'bell', 'benz', 'bhabha', 'bhaskara', 'black', 'blackburn', 'blackwell', 'bohr', 'booth', 'borg', 'bose', 'bouman', 'boyd', 'brahmagupta', 'brattain', 'brown', 'buck', 'burnell', 'cannon', 'carson', 'cartwright', 'carver', 'cerf', 'chandrasekhar', 'chaplygin', 'chatelet', 'chatterjee', 'chebyshev', 'cohen', 'chaum', 'clarke', 'colden', 'cori', 'cray', 'curran', 'curie', 'darwin', 'davinci', 'dewdney', 'dhawan', 'diffie', 'dijkstra', 'dirac', 'driscoll', 'dubinsky', 'easley', 'edison', 'einstein', 'elbakyan', 'elgamal', 'elion', 'ellis', 'engelbart', 'euclid', 'euler', 'faraday', 'feistel', 'fermat', 'fermi', 'feynman', 'franklin', 'gagarin', 'galileo', 'galois', 'ganguly', 'gates', 'gauss', 'germain', 'goldberg', 'goldstine', 'goldwasser', 'golick', 'goodall', 'gould', 'greider', 'grothendieck', 'haibt', 'hamilton', 'haslett', 'hawking', 'hellman', 'heisenberg', 'hermann', 'herschel', 'hertz', 'heyrovsky', 'hodgkin', 'hofstadter', 'hoover', 'hopper', 'hugle', 'hypatia', 'ishizaka', 'jackson', 'jang', 'jemison', 'jennings', 'jepsen', 'johnson', 'joliot', 'jones', 'kalam', 'kapitsa', 'kare', 'keldysh', 'keller', 'kepler', 'khayyam', 'khorana', 'kilby', 'kirch', 'knuth', 'kowalevski', 'lalande', 'lamarr', 'lamport', 'leakey', 'leavitt', 'lederberg', 'lehmann', 'lewin', 'lichterman', 'liskov', 'lovelace', 'lumiere', 'mahavira', 'margulis', 'matsumoto', 'maxwell', 'mayer', 'mccarthy', 'mcclintock', 'mclaren', 'mclean', 'mcnulty', 'mendel', 'mendeleev', 'meitner', 'meninsky', 'merkle', 'mestorf', 'mirzakhani', 'montalcini', 'moore', 'morse', 'murdock', 'moser', 'napier', 'nash', 'neumann', 'newton', 'nightingale', 'nobel', 'noether', 'northcutt', 'noyce', 'panini', 'pare', 'pascal', 'pasteur', 'payne', 'perlman', 'pike', 'poincare', 'poitras', 'proskuriakova', 'ptolemy', 'raman', 'ramanujan', 'ride', 'ritchie', 'rhodes', 'robinson', 'roentgen', 'rosalind', 'rubin', 'saha', 'sammet', 'sanderson', 'satoshi', 'shamir', 'shannon', 'shaw', 'shirley', 'shockley', 'shtern', 'sinoussi', 'snyder', 'solomon', 'spence', 'stonebraker', 'sutherland', 'swanson', 'swartz', 'swirles', 'taussig', 'tereshkova', 'tesla', 'tharp', 'thompson', 'torvalds', 'tu', 'turing', 'varahamihira', 'vaughan', 'visvesvaraya', 'volhard', 'villani', 'wescoff', 'wilbur', 'wiles', 'williams', 'williamson', 'wilson', 'wing', 'wozniak', 'wright', 'wu', 'yalow', 'yonath', 'zhukovsky'];
1891
+ const randomName = function () {
1892
+ let prefix = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : '';
1893
+ let separator = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : '-';
1894
+ const name = `${ADJECTIVES[Math.floor(Math.random() * ADJECTIVES.length)] ?? ''}${separator}${NAMES[Math.floor(Math.random() * NAMES.length)] ?? ''}`;
1895
+ if (name === `boring${separator}wozniak`) {
1896
+ return randomName(prefix, separator);
1897
+ }
1898
+ return prefix.length > 0 ? `${prefix}${separator}${name}` : name;
1899
+ };
1900
+
1889
1901
  // This file was automatically generated. DO NOT EDIT.
1890
1902
  const unmarshalProject = data => {
1891
1903
  if (!isJSONObject(data)) {
@@ -1911,7 +1923,7 @@ const unmarshalListProjectsResponse = data => {
1911
1923
  };
1912
1924
  const marshalCreateProjectRequest = (request, defaults) => ({
1913
1925
  description: request.description,
1914
- name: request.name,
1926
+ name: request.name || randomName('proj'),
1915
1927
  organization_id: request.organizationId ?? defaults.defaultOrganizationId
1916
1928
  });
1917
1929
  const marshalUpdateProjectRequest = (request, defaults) => ({
@@ -1937,7 +1949,7 @@ let API$p = class API extends API$q {
1937
1949
  * @param request - The request {@link CreateProjectRequest}
1938
1950
  * @returns A Promise of Project
1939
1951
  */
1940
- createProject = request => this.client.fetch({
1952
+ createProject = (request = {}) => this.client.fetch({
1941
1953
  body: JSON.stringify(marshalCreateProjectRequest(request, this.client.settings)),
1942
1954
  headers: jsonContentHeaders$m,
1943
1955
  method: 'POST',
@@ -2019,18 +2031,6 @@ var index$s = /*#__PURE__*/Object.freeze({
2019
2031
  /** Lists transient statutes of the enum {@link ServerStatus}. */
2020
2032
  const SERVER_TRANSIENT_STATUSES$2 = ['starting', 'rebooting', 'updating', 'locking', 'unlocking', 'reinstalling'];
2021
2033
 
2022
- const ADJECTIVES = ['admiring', 'adoring', 'affectionate', 'agitated', 'amazing', 'angry', 'awesome', 'beautiful', 'blissful', 'bold', 'boring', 'brave', 'busy', 'charming', 'clever', 'cool', 'compassionate', 'competent', 'condescending', 'confident', 'cranky', 'crazy', 'dazzling', 'determined', 'distracted', 'dreamy', 'eager', 'ecstatic', 'elastic', 'elated', 'elegant', 'eloquent', 'epic', 'exciting', 'fervent', 'festive', 'flamboyant', 'focused', 'friendly', 'frosty', 'funny', 'gallant', 'gifted', 'goofy', 'gracious', 'great', 'happy', 'hardcore', 'heuristic', 'hopeful', 'hungry', 'infallible', 'inspiring', 'interesting', 'intelligent', 'jolly', 'jovial', 'keen', 'kind', 'laughing', 'loving', 'lucid', 'magical', 'mystifying', 'modest', 'musing', 'naughty', 'nervous', 'nice', 'nifty', 'nostalgic', 'objective', 'optimistic', 'peaceful', 'pedantic', 'pensive', 'practical', 'priceless', 'quirky', 'quizzical', 'recursing', 'relaxed', 'reverent', 'romantic', 'sad', 'serene', 'sharp', 'silly', 'sleepy', 'stoic', 'strange', 'stupefied', 'suspicious', 'sweet', 'tender', 'thirsty', 'trusting', 'unruffled', 'upbeat', 'vibrant', 'vigilant', 'vigorous', 'wizardly', 'wonderful', 'xenodochial', 'youthful', 'zealous', 'zen'];
2023
- const NAMES = ['albattani', 'allen', 'almeida', 'antonelli', 'agnesi', 'archimedes', 'ardinghelli', 'aryabhata', 'austin', 'babbage', 'banach', 'banzai', 'bardeen', 'bartik', 'bassi', 'beaver', 'bell', 'benz', 'bhabha', 'bhaskara', 'black', 'blackburn', 'blackwell', 'bohr', 'booth', 'borg', 'bose', 'bouman', 'boyd', 'brahmagupta', 'brattain', 'brown', 'buck', 'burnell', 'cannon', 'carson', 'cartwright', 'carver', 'cerf', 'chandrasekhar', 'chaplygin', 'chatelet', 'chatterjee', 'chebyshev', 'cohen', 'chaum', 'clarke', 'colden', 'cori', 'cray', 'curran', 'curie', 'darwin', 'davinci', 'dewdney', 'dhawan', 'diffie', 'dijkstra', 'dirac', 'driscoll', 'dubinsky', 'easley', 'edison', 'einstein', 'elbakyan', 'elgamal', 'elion', 'ellis', 'engelbart', 'euclid', 'euler', 'faraday', 'feistel', 'fermat', 'fermi', 'feynman', 'franklin', 'gagarin', 'galileo', 'galois', 'ganguly', 'gates', 'gauss', 'germain', 'goldberg', 'goldstine', 'goldwasser', 'golick', 'goodall', 'gould', 'greider', 'grothendieck', 'haibt', 'hamilton', 'haslett', 'hawking', 'hellman', 'heisenberg', 'hermann', 'herschel', 'hertz', 'heyrovsky', 'hodgkin', 'hofstadter', 'hoover', 'hopper', 'hugle', 'hypatia', 'ishizaka', 'jackson', 'jang', 'jemison', 'jennings', 'jepsen', 'johnson', 'joliot', 'jones', 'kalam', 'kapitsa', 'kare', 'keldysh', 'keller', 'kepler', 'khayyam', 'khorana', 'kilby', 'kirch', 'knuth', 'kowalevski', 'lalande', 'lamarr', 'lamport', 'leakey', 'leavitt', 'lederberg', 'lehmann', 'lewin', 'lichterman', 'liskov', 'lovelace', 'lumiere', 'mahavira', 'margulis', 'matsumoto', 'maxwell', 'mayer', 'mccarthy', 'mcclintock', 'mclaren', 'mclean', 'mcnulty', 'mendel', 'mendeleev', 'meitner', 'meninsky', 'merkle', 'mestorf', 'mirzakhani', 'montalcini', 'moore', 'morse', 'murdock', 'moser', 'napier', 'nash', 'neumann', 'newton', 'nightingale', 'nobel', 'noether', 'northcutt', 'noyce', 'panini', 'pare', 'pascal', 'pasteur', 'payne', 'perlman', 'pike', 'poincare', 'poitras', 'proskuriakova', 'ptolemy', 'raman', 'ramanujan', 'ride', 'ritchie', 'rhodes', 'robinson', 'roentgen', 'rosalind', 'rubin', 'saha', 'sammet', 'sanderson', 'satoshi', 'shamir', 'shannon', 'shaw', 'shirley', 'shockley', 'shtern', 'sinoussi', 'snyder', 'solomon', 'spence', 'stonebraker', 'sutherland', 'swanson', 'swartz', 'swirles', 'taussig', 'tereshkova', 'tesla', 'tharp', 'thompson', 'torvalds', 'tu', 'turing', 'varahamihira', 'vaughan', 'visvesvaraya', 'volhard', 'villani', 'wescoff', 'wilbur', 'wiles', 'williams', 'williamson', 'wilson', 'wing', 'wozniak', 'wright', 'wu', 'yalow', 'yonath', 'zhukovsky'];
2024
- const randomName = function () {
2025
- let prefix = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : '';
2026
- let separator = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : '-';
2027
- const name = `${ADJECTIVES[Math.floor(Math.random() * ADJECTIVES.length)] ?? ''}${separator}${NAMES[Math.floor(Math.random() * NAMES.length)] ?? ''}`;
2028
- if (name === `boring${separator}wozniak`) {
2029
- return randomName(prefix, separator);
2030
- }
2031
- return prefix.length > 0 ? `${prefix}${separator}${name}` : name;
2032
- };
2033
-
2034
2034
  // This file was automatically generated. DO NOT EDIT.
2035
2035
  const unmarshalServerTypeCPU = data => {
2036
2036
  if (!isJSONObject(data)) {
@@ -2144,7 +2144,7 @@ const jsonContentHeaders$l = {
2144
2144
  };
2145
2145
 
2146
2146
  /**
2147
- * Apple silicon.
2147
+ * Apple silicon API.
2148
2148
  *
2149
2149
  * Apple Mac mini as a service. Scaleway Apple silicon as-a-Service is built
2150
2150
  * using the latest generation of Apple Mac mini hardware (fifth generation).
@@ -2182,7 +2182,8 @@ let API$o = class API extends API$q {
2182
2182
  }, unmarshalListServerTypesResponse);
2183
2183
 
2184
2184
  /**
2185
- * Get a server type. Get a server technical details.
2185
+ * Get a server type. Get technical details (CPU, disk size etc.) of a server
2186
+ * type.
2186
2187
  *
2187
2188
  * @param request - The request {@link GetServerTypeRequest}
2188
2189
  * @returns A Promise of ServerType
@@ -2227,7 +2228,7 @@ let API$o = class API extends API$q {
2227
2228
  }, unmarshalListOSResponse$1);
2228
2229
 
2229
2230
  /**
2230
- * List all Operating System (OS). List all Operating System (OS). The
2231
+ * List all Operating Systems (OS). List all Operating Systems (OS). The
2231
2232
  * response will include the total number of OS as well as their associated
2232
2233
  * IDs, names and labels.
2233
2234
  *
@@ -2482,6 +2483,7 @@ const unmarshalOS = data => {
2482
2483
  throw new TypeError(`Unmarshalling the type 'OS' failed as data isn't a dictionary.`);
2483
2484
  }
2484
2485
  return {
2486
+ allowed: data.allowed,
2485
2487
  enabled: data.enabled,
2486
2488
  id: data.id,
2487
2489
  licenseRequired: data.license_required,
@@ -2772,8 +2774,8 @@ let API$n = class API extends API$q {
2772
2774
  }, unmarshalListServersResponse$1);
2773
2775
 
2774
2776
  /**
2775
- * List Elastic Metal servers for an organization. List Elastic Metal servers
2776
- * for a specific organization.
2777
+ * List Elastic Metal servers for an Organization. List Elastic Metal servers
2778
+ * for a specific Organization.
2777
2779
  *
2778
2780
  * @param request - The request {@link ListServersRequest}
2779
2781
  * @returns A Promise of ListServersResponse
@@ -3065,7 +3067,7 @@ let API$n = class API extends API$q {
3065
3067
  }, unmarshalListSettingsResponse);
3066
3068
 
3067
3069
  /**
3068
- * List all settings. Return all settings for a project ID.
3070
+ * List all settings. Return all settings for a Project ID.
3069
3071
  *
3070
3072
  * @param request - The request {@link ListSettingsRequest}
3071
3073
  * @returns A Promise of ListSettingsResponse
@@ -3073,7 +3075,7 @@ let API$n = class API extends API$q {
3073
3075
  listSettings = (request = {}) => enrichForPagination('settings', this.pageOfListSettings, request);
3074
3076
 
3075
3077
  /**
3076
- * Update setting. Update a setting for a project ID (enable or disable).
3078
+ * Update setting. Update a setting for a Project ID (enable or disable).
3077
3079
  *
3078
3080
  * @param request - The request {@link UpdateSettingRequest}
3079
3081
  * @returns A Promise of Setting
@@ -3100,7 +3102,7 @@ let API$n = class API extends API$q {
3100
3102
  listOS = (request = {}) => enrichForPagination('os', this.pageOfListOS, request);
3101
3103
 
3102
3104
  /**
3103
- * Get an OS with an ID. Return specific OS for the ID.
3105
+ * Get OS with an ID. Return the specific OS for the ID.
3104
3106
  *
3105
3107
  * @param request - The request {@link GetOSRequest}
3106
3108
  * @returns A Promise of OS
@@ -3638,10 +3640,9 @@ const jsonContentHeaders$j = {
3638
3640
  };
3639
3641
 
3640
3642
  /**
3641
- * Cockpit API documentation.
3643
+ * Cockpit API.
3642
3644
  *
3643
- * Cockpit's API allows you to monitor your applications and their
3644
- * infrastructure. Cockpit's API allows you to activate your Cockpit on your
3645
+ * Cockpit API. Cockpit's API allows you to activate your Cockpit on your
3645
3646
  * Projects. Scaleway's Cockpit stores metrics and logs and provides a dedicated
3646
3647
  * Grafana for dashboarding to visualize them.
3647
3648
  */
@@ -4133,6 +4134,7 @@ const marshalSecret$1 = (request, defaults) => ({
4133
4134
  value: request.value
4134
4135
  });
4135
4136
  const marshalCreateContainerRequest = (request, defaults) => ({
4137
+ cpu_limit: request.cpuLimit,
4136
4138
  description: request.description,
4137
4139
  environment_variables: request.environmentVariables,
4138
4140
  http_option: request.httpOption ?? 'unknown_http_option',
@@ -4178,6 +4180,7 @@ const marshalCreateTokenRequest$1 = (request, defaults) => ({
4178
4180
  }])
4179
4181
  });
4180
4182
  const marshalUpdateContainerRequest = (request, defaults) => ({
4183
+ cpu_limit: request.cpuLimit,
4181
4184
  description: request.description,
4182
4185
  environment_variables: request.environmentVariables,
4183
4186
  http_option: request.httpOption ?? 'unknown_http_option',
@@ -4210,11 +4213,7 @@ const jsonContentHeaders$i = {
4210
4213
  'Content-Type': 'application/json; charset=utf-8'
4211
4214
  };
4212
4215
 
4213
- /**
4214
- * Containers API.
4215
- *
4216
- * Serverless Containers API. Containers API.
4217
- */
4216
+ /** Serverless Containers API. */
4218
4217
  let API$k = class API extends API$q {
4219
4218
  /** Lists the available regions of the API. */
4220
4219
  static LOCALITIES = ['fr-par', 'nl-ams', 'pl-waw'];
@@ -5803,9 +5802,10 @@ const jsonContentHeaders$h = {
5803
5802
  };
5804
5803
 
5805
5804
  /**
5806
- * DNS API.
5805
+ * Domains and DNS API.
5807
5806
  *
5808
- * DNS API. Manage your DNS zones and records.
5807
+ * Domains and DNS API. Manage your domains, DNS zones and records with the
5808
+ * Domains and DNS API.
5809
5809
  */
5810
5810
  let API$j = class API extends API$q {
5811
5811
  pageOfListDNSZones = request => this.client.fetch({
@@ -5815,8 +5815,8 @@ let API$j = class API extends API$q {
5815
5815
  }, unmarshalListDNSZonesResponse);
5816
5816
 
5817
5817
  /**
5818
- * List DNS zones. Returns a list of manageable DNS zones. You can filter the
5819
- * DNS zones by domain name.
5818
+ * List DNS zones. Retrieve the list of DNS zones you can manage and filter
5819
+ * DNS zones associated with specific domain names.
5820
5820
  *
5821
5821
  * @param request - The request {@link ListDNSZonesRequest}
5822
5822
  * @returns A Promise of ListDNSZonesResponse
@@ -5824,7 +5824,8 @@ let API$j = class API extends API$q {
5824
5824
  listDNSZones = request => enrichForPagination('dnsZones', this.pageOfListDNSZones, request);
5825
5825
 
5826
5826
  /**
5827
- * Create a DNS zone. Create a new DNS zone.
5827
+ * Create a DNS zone. Create a new DNS zone specified by the domain name, the
5828
+ * subdomain and the Project ID.
5828
5829
  *
5829
5830
  * @param request - The request {@link CreateDNSZoneRequest}
5830
5831
  * @returns A Promise of DNSZone
@@ -5837,7 +5838,7 @@ let API$j = class API extends API$q {
5837
5838
  }, unmarshalDNSZone);
5838
5839
 
5839
5840
  /**
5840
- * Update a DNS zone. Update the name and/or the organizations for a DNS zone.
5841
+ * Update a DNS zone. Update the name and/or the Organizations for a DNS zone.
5841
5842
  *
5842
5843
  * @param request - The request {@link UpdateDNSZoneRequest}
5843
5844
  * @returns A Promise of DNSZone
@@ -5850,8 +5851,8 @@ let API$j = class API extends API$q {
5850
5851
  }, unmarshalDNSZone);
5851
5852
 
5852
5853
  /**
5853
- * Clone a DNS zone. Clone an existed DNS zone with all its records into a new
5854
- * one.
5854
+ * Clone a DNS zone. Clone an existing DNS zone with all its records into a
5855
+ * new DNS zone.
5855
5856
  *
5856
5857
  * @param request - The request {@link CloneDNSZoneRequest}
5857
5858
  * @returns A Promise of DNSZone
@@ -5864,7 +5865,7 @@ let API$j = class API extends API$q {
5864
5865
  }, unmarshalDNSZone);
5865
5866
 
5866
5867
  /**
5867
- * Delete DNS zone. Delete a DNS zone and all it's records.
5868
+ * Delete a DNS zone. Delete a DNS zone and all its records.
5868
5869
  *
5869
5870
  * @param request - The request {@link DeleteDNSZoneRequest}
5870
5871
  * @returns A Promise of DeleteDNSZoneResponse
@@ -5881,8 +5882,9 @@ let API$j = class API extends API$q {
5881
5882
  }, unmarshalListDNSZoneRecordsResponse);
5882
5883
 
5883
5884
  /**
5884
- * List DNS zone records. Returns a list of DNS records of a DNS zone with
5885
- * default NS. You can filter the records by type and name.
5885
+ * List records within a DNS zone. Retrieve a list of DNS records within a DNS
5886
+ * zone that has default name servers. You can filter records by type and
5887
+ * name.
5886
5888
  *
5887
5889
  * @param request - The request {@link ListDNSZoneRecordsRequest}
5888
5890
  * @returns A Promise of ListDNSZoneRecordsResponse
@@ -5890,22 +5892,18 @@ let API$j = class API extends API$q {
5890
5892
  listDNSZoneRecords = request => enrichForPagination('records', this.pageOfListDNSZoneRecords, request);
5891
5893
 
5892
5894
  /**
5893
- * Update DNS zone records. Only available with default NS.<br/> Send a list
5894
- * of actions and records.
5895
+ * Update records within a DNS zone. Update records within a DNS zone that has
5896
+ * default name servers and perform several actions on your records.
5895
5897
  *
5896
- * Action can be:
5898
+ * Actions include:
5897
5899
  *
5898
- * - Add:
5899
- * - Add new record
5900
- * - Can be more specific and add a new IP to an existing A record for example
5901
- * - Set:
5902
- * - Edit a record
5903
- * - Can be more specific and edit an IP from an existing A record for example
5904
- * - Delete:
5905
- * - Delete a record
5906
- * - Can be more specific and delete an IP from an existing A record for example
5907
- * - Clear:
5908
- * - Delete all records from a DNS zone
5900
+ * - Add: allows you to add a new record or add a new IP to an existing A
5901
+ * record, for example
5902
+ * - Set: allows you to edit a record or edit an IP from an existing A record,
5903
+ * for example
5904
+ * - Delete: allows you to delete a record or delete an IP from an existing A
5905
+ * record, for example
5906
+ * - Clear: allows you to delete all records from a DNS zone
5909
5907
  *
5910
5908
  * All edits will be versioned.
5911
5909
  *
@@ -5920,8 +5918,8 @@ let API$j = class API extends API$q {
5920
5918
  }, unmarshalUpdateDNSZoneRecordsResponse);
5921
5919
 
5922
5920
  /**
5923
- * List DNS zone nameservers. Returns a list of Nameservers and their optional
5924
- * glue records for a DNS zone.
5921
+ * List name servers within a DNS zone. Retrieve a list of name servers within
5922
+ * a DNS zone and their optional glue records.
5925
5923
  *
5926
5924
  * @param request - The request {@link ListDNSZoneNameserversRequest}
5927
5925
  * @returns A Promise of ListDNSZoneNameserversResponse
@@ -5933,8 +5931,8 @@ let API$j = class API extends API$q {
5933
5931
  }, unmarshalListDNSZoneNameserversResponse);
5934
5932
 
5935
5933
  /**
5936
- * Update DNS zone nameservers. Update DNS zone nameservers and set optional
5937
- * glue records.
5934
+ * Update name servers within a DNS zone. Update name servers within a DNS
5935
+ * zone and set optional glue records.
5938
5936
  *
5939
5937
  * @param request - The request {@link UpdateDNSZoneNameserversRequest}
5940
5938
  * @returns A Promise of UpdateDNSZoneNameserversResponse
@@ -5947,8 +5945,8 @@ let API$j = class API extends API$q {
5947
5945
  }, unmarshalUpdateDNSZoneNameserversResponse);
5948
5946
 
5949
5947
  /**
5950
- * Clear DNS zone records. Only available with default NS.<br/> Delete all the
5951
- * records from a DNS zone. All edits will be versioned.
5948
+ * Clear records within a DNS zone. Delete all records within a DNS zone that
5949
+ * has default name servers.<br/> All edits will be versioned.
5952
5950
  *
5953
5951
  * @param request - The request {@link ClearDNSZoneRecordsRequest}
5954
5952
  * @returns A Promise of ClearDNSZoneRecordsResponse
@@ -5959,7 +5957,8 @@ let API$j = class API extends API$q {
5959
5957
  }, unmarshalClearDNSZoneRecordsResponse);
5960
5958
 
5961
5959
  /**
5962
- * Export raw DNS zone. Get a DNS zone in a given format with default NS.
5960
+ * Export a raw DNS zone. Export a DNS zone with default name servers, in a
5961
+ * specific format.
5963
5962
  *
5964
5963
  * @param request - The request {@link ExportRawDNSZoneRequest}
5965
5964
  * @returns A Promise of Blob
@@ -5972,8 +5971,8 @@ let API$j = class API extends API$q {
5972
5971
  });
5973
5972
 
5974
5973
  /**
5975
- * Import raw DNS zone. Import and replace records from a given provider
5976
- * format with default NS.
5974
+ * Import a raw DNS zone. Import and replace the format of records from a
5975
+ * given provider, with default name servers.
5977
5976
  *
5978
5977
  * @param request - The request {@link ImportRawDNSZoneRequest}
5979
5978
  * @returns A Promise of ImportRawDNSZoneResponse
@@ -5986,8 +5985,8 @@ let API$j = class API extends API$q {
5986
5985
  }, unmarshalImportRawDNSZoneResponse);
5987
5986
 
5988
5987
  /**
5989
- * Import provider DNS zone. Import and replace records from a given provider
5990
- * format with default NS.
5988
+ * Import a DNS zone from another provider. Import and replace the format of
5989
+ * records from a given provider, with default name servers.
5991
5990
  *
5992
5991
  * @param request - The request {@link ImportProviderDNSZoneRequest}
5993
5992
  * @returns A Promise of ImportProviderDNSZoneResponse
@@ -6000,8 +5999,9 @@ let API$j = class API extends API$q {
6000
5999
  }, unmarshalImportProviderDNSZoneResponse);
6001
6000
 
6002
6001
  /**
6003
- * Refresh DNS zone. Refresh SOA DNS zone. You can recreate the given DNS zone
6004
- * and its sub DNS zone if needed.
6002
+ * Refresh a DNS zone. Refresh an SOA DNS zone to reload the records in the
6003
+ * DNS zone and update the SOA serial. You can recreate the given DNS zone and
6004
+ * its sub DNS zone if needed.
6005
6005
  *
6006
6006
  * @param request - The request {@link RefreshDNSZoneRequest}
6007
6007
  * @returns A Promise of RefreshDNSZoneResponse
@@ -6019,9 +6019,9 @@ let API$j = class API extends API$q {
6019
6019
  }, unmarshalListDNSZoneVersionsResponse);
6020
6020
 
6021
6021
  /**
6022
- * List DNS zone versions. Get a list of DNS zone versions.<br/> The maximum
6023
- * version count is 100.<br/> If the count reaches this limit, the oldest
6024
- * version will be deleted after each new modification.
6022
+ * List versions of a DNS zone. Retrieve a list of a DNS zone's versions.<br/>
6023
+ * The maximum version count is 100. If the count reaches this limit, the
6024
+ * oldest version will be deleted after each new modification.
6025
6025
  *
6026
6026
  * @param request - The request {@link ListDNSZoneVersionsRequest}
6027
6027
  * @returns A Promise of ListDNSZoneVersionsResponse
@@ -6034,8 +6034,8 @@ let API$j = class API extends API$q {
6034
6034
  }, unmarshalListDNSZoneVersionRecordsResponse);
6035
6035
 
6036
6036
  /**
6037
- * List DNS zone version records. Get a list of records from a previous DNS
6038
- * zone version.
6037
+ * List records from a given version of a specific DNS zone. Retrieve a list
6038
+ * of records from a specific DNS zone version.
6039
6039
  *
6040
6040
  * @param request - The request {@link ListDNSZoneVersionRecordsRequest}
6041
6041
  * @returns A Promise of ListDNSZoneVersionRecordsResponse
@@ -6043,8 +6043,8 @@ let API$j = class API extends API$q {
6043
6043
  listDNSZoneVersionRecords = request => enrichForPagination('records', this.pageOfListDNSZoneVersionRecords, request);
6044
6044
 
6045
6045
  /**
6046
- * Get DNS zone version diff. Get all differences from a previous DNS zone
6047
- * version.
6046
+ * Access differences from a specific DNS zone version. Access a previous DNS
6047
+ * zone version to see the differences from another specific version.
6048
6048
  *
6049
6049
  * @param request - The request {@link GetDNSZoneVersionDiffRequest}
6050
6050
  * @returns A Promise of GetDNSZoneVersionDiffResponse
@@ -6055,7 +6055,8 @@ let API$j = class API extends API$q {
6055
6055
  }, unmarshalGetDNSZoneVersionDiffResponse);
6056
6056
 
6057
6057
  /**
6058
- * Restore DNS zone version. Restore and activate a previous DNS zone version.
6058
+ * Restore a DNS zone version. Restore and activate a version of a specific
6059
+ * DNS zone.
6059
6060
  *
6060
6061
  * @param request - The request {@link RestoreDNSZoneVersionRequest}
6061
6062
  * @returns A Promise of RestoreDNSZoneVersionResponse
@@ -6068,7 +6069,8 @@ let API$j = class API extends API$q {
6068
6069
  }, unmarshalRestoreDNSZoneVersionResponse);
6069
6070
 
6070
6071
  /**
6071
- * Get the zone TLS certificate if it exists.
6072
+ * Get a DNS zone's TLS certificate. Get the DNS zone's TLS certificate. If
6073
+ * you do not have a certificate, the ouptut returns `no certificate found`.
6072
6074
  *
6073
6075
  * @param request - The request {@link GetSSLCertificateRequest}
6074
6076
  * @returns A Promise of SSLCertificate
@@ -6088,7 +6090,8 @@ let API$j = class API extends API$q {
6088
6090
  waitForSSLCertificate = (request, options) => waitForResource(options?.stop ?? (res => Promise.resolve(!SSL_CERTIFICATE_TRANSIENT_STATUSES.includes(res.status))), this.getSSLCertificate, request, options);
6089
6091
 
6090
6092
  /**
6091
- * Create or return the zone TLS certificate.
6093
+ * Create or get the DNS zone's TLS certificate. Create a new TLS certificate
6094
+ * or retrieve information about an existing TLS certificate.
6092
6095
  *
6093
6096
  * @param request - The request {@link CreateSSLCertificateRequest}
6094
6097
  * @returns A Promise of SSLCertificate
@@ -6106,7 +6109,8 @@ let API$j = class API extends API$q {
6106
6109
  }, unmarshalListSSLCertificatesResponse);
6107
6110
 
6108
6111
  /**
6109
- * List all user TLS certificates.
6112
+ * List a user's TLS certificates. List all the TLS certificates a user has
6113
+ * created, specified by the user's Project ID and the DNS zone.
6110
6114
  *
6111
6115
  * @param request - The request {@link ListSSLCertificatesRequest}
6112
6116
  * @returns A Promise of ListSSLCertificatesResponse
@@ -6114,7 +6118,9 @@ let API$j = class API extends API$q {
6114
6118
  listSSLCertificates = request => enrichForPagination('certificates', this.pageOfListSSLCertificates, request);
6115
6119
 
6116
6120
  /**
6117
- * Delete an TLS certificate.
6121
+ * Delete a TLS certificate. Delete an existing TLS certificate specified by
6122
+ * its DNS zone. Deleting a TLS certificate is permanent and cannot be
6123
+ * undone.
6118
6124
  *
6119
6125
  * @param request - The request {@link DeleteSSLCertificateRequest}
6120
6126
  * @returns A Promise of DeleteSSLCertificateResponse
@@ -6125,7 +6131,8 @@ let API$j = class API extends API$q {
6125
6131
  }, unmarshalDeleteSSLCertificateResponse);
6126
6132
 
6127
6133
  /**
6128
- * Get the DNS zone TSIG Key. Get the DNS zone TSIG Key to allow AXFR request.
6134
+ * Get the DNS zone's TSIG key. Retrieve information about the TSIG key of a
6135
+ * given DNS zone to allow AXFR requests.
6129
6136
  *
6130
6137
  * @param request - The request {@link GetDNSZoneTsigKeyRequest}
6131
6138
  * @returns A Promise of GetDNSZoneTsigKeyResponse
@@ -6136,7 +6143,8 @@ let API$j = class API extends API$q {
6136
6143
  }, unmarshalGetDNSZoneTsigKeyResponse);
6137
6144
 
6138
6145
  /**
6139
- * Delete the DNS zone TSIG Key.
6146
+ * Delete the DNS zone's TSIG key. Delete an existing TSIG key specified by
6147
+ * its DNS zone. Deleting a TSIG key is permanent and cannot be undone.
6140
6148
  *
6141
6149
  * @param request - The request {@link DeleteDNSZoneTsigKeyRequest}
6142
6150
  */
@@ -6678,13 +6686,14 @@ const jsonContentHeaders$g = {
6678
6686
  'Content-Type': 'application/json; charset=utf-8'
6679
6687
  };
6680
6688
 
6681
- /** Flexible IP API. */
6689
+ /** Elastic Metal - Flexible IP API. */
6682
6690
  let API$i = class API extends API$q {
6683
6691
  /** Lists the available zones of the API. */
6684
6692
  static LOCALITIES = ['fr-par-1', 'fr-par-2', 'nl-ams-1'];
6685
6693
 
6686
6694
  /**
6687
- * Create a Flexible IP.
6695
+ * Create a new flexible IP. Generate a new flexible IP within a given zone,
6696
+ * specifying its configuration including Project ID and description.
6688
6697
  *
6689
6698
  * @param request - The request {@link CreateFlexibleIPRequest}
6690
6699
  * @returns A Promise of FlexibleIP
@@ -6697,7 +6706,9 @@ let API$i = class API extends API$q {
6697
6706
  }, unmarshalFlexibleIP);
6698
6707
 
6699
6708
  /**
6700
- * Get a Flexible IP.
6709
+ * Get an existing flexible IP. Retrieve information about an existing
6710
+ * flexible IP, specified by its ID and zone. Its full details, including
6711
+ * Project ID, description and status, are returned in the response object.
6701
6712
  *
6702
6713
  * @param request - The request {@link GetFlexibleIPRequest}
6703
6714
  * @returns A Promise of FlexibleIP
@@ -6722,7 +6733,7 @@ let API$i = class API extends API$q {
6722
6733
  }, unmarshalListFlexibleIPsResponse);
6723
6734
 
6724
6735
  /**
6725
- * List Flexible IPs.
6736
+ * List flexible IPs. List all flexible IPs within a given zone.
6726
6737
  *
6727
6738
  * @param request - The request {@link ListFlexibleIPsRequest}
6728
6739
  * @returns A Promise of ListFlexibleIPsResponse
@@ -6730,7 +6741,9 @@ let API$i = class API extends API$q {
6730
6741
  listFlexibleIPs = (request = {}) => enrichForPagination('flexibleIps', this.pageOfListFlexibleIPs, request);
6731
6742
 
6732
6743
  /**
6733
- * Update a Flexible IP.
6744
+ * Update an existing flexible IP. Update the parameters of an existing
6745
+ * flexible IP, specified by its ID and zone. These parameters include tags
6746
+ * and description.
6734
6747
  *
6735
6748
  * @param request - The request {@link UpdateFlexibleIPRequest}
6736
6749
  * @returns A Promise of FlexibleIP
@@ -6743,7 +6756,9 @@ let API$i = class API extends API$q {
6743
6756
  }, unmarshalFlexibleIP);
6744
6757
 
6745
6758
  /**
6746
- * Delete a Flexible IP.
6759
+ * Delete an existing flexible IP. Delete an existing flexible IP, specified
6760
+ * by its ID and zone. Note that deleting a flexible IP is permanent and
6761
+ * cannot be undone.
6747
6762
  *
6748
6763
  * @param request - The request {@link DeleteFlexibleIPRequest}
6749
6764
  */
@@ -6753,7 +6768,8 @@ let API$i = class API extends API$q {
6753
6768
  });
6754
6769
 
6755
6770
  /**
6756
- * Attach a Flexible IP to a server.
6771
+ * Attach an existing flexible IP to a server. Attach an existing flexible IP
6772
+ * to a specified Elastic Metal server.
6757
6773
  *
6758
6774
  * @param request - The request {@link AttachFlexibleIPRequest}
6759
6775
  * @returns A Promise of AttachFlexibleIPsResponse
@@ -6766,7 +6782,8 @@ let API$i = class API extends API$q {
6766
6782
  }, unmarshalAttachFlexibleIPsResponse);
6767
6783
 
6768
6784
  /**
6769
- * Detach a Flexible IP from a server.
6785
+ * Detach an existing flexible IP from a server. Detach an existing flexible
6786
+ * IP from a specified Elastic Metal server.
6770
6787
  *
6771
6788
  * @param request - The request {@link DetachFlexibleIPRequest}
6772
6789
  * @returns A Promise of DetachFlexibleIPsResponse
@@ -6779,7 +6796,8 @@ let API$i = class API extends API$q {
6779
6796
  }, unmarshalDetachFlexibleIPsResponse);
6780
6797
 
6781
6798
  /**
6782
- * Generate a virtual MAC on a given Flexible IP.
6799
+ * Generate a virtual MAC address on an existing flexible IP. Generate a
6800
+ * virtual MAC (Media Access Control) address on an existing flexible IP.
6783
6801
  *
6784
6802
  * @param request - The request {@link GenerateMACAddrRequest}
6785
6803
  * @returns A Promise of FlexibleIP
@@ -6792,8 +6810,9 @@ let API$i = class API extends API$q {
6792
6810
  }, unmarshalFlexibleIP);
6793
6811
 
6794
6812
  /**
6795
- * Duplicate a Virtual MAC. Duplicate a Virtual MAC from a given Flexible IP
6796
- * onto another attached on the same server.
6813
+ * Duplicate a virtual MAC address to another flexible IP. Duplicate a virtual
6814
+ * MAC address from a given flexible IP to another flexible IP attached to the
6815
+ * same server.
6797
6816
  *
6798
6817
  * @param request - The request {@link DuplicateMACAddrRequest}
6799
6818
  * @returns A Promise of FlexibleIP
@@ -6806,8 +6825,9 @@ let API$i = class API extends API$q {
6806
6825
  }, unmarshalFlexibleIP);
6807
6826
 
6808
6827
  /**
6809
- * Move a virtual MAC. Move a Virtual MAC from a given Flexible IP onto
6810
- * another Flexible IP.
6828
+ * Relocate an existing virtual MAC address to a different flexible IP.
6829
+ * Relocate a virtual MAC (Media Access Control) address from an existing
6830
+ * flexible IP to a different flexible IP.
6811
6831
  *
6812
6832
  * @param request - The request {@link MoveMACAddrRequest}
6813
6833
  * @returns A Promise of FlexibleIP
@@ -6820,7 +6840,8 @@ let API$i = class API extends API$q {
6820
6840
  }, unmarshalFlexibleIP);
6821
6841
 
6822
6842
  /**
6823
- * Remove a virtual MAC from a Flexible IP.
6843
+ * Detach a given virtual MAC address from an existing flexible IP. Detach a
6844
+ * given MAC (Media Access Control) address from an existing flexible IP.
6824
6845
  *
6825
6846
  * @param request - The request {@link DeleteMACAddrRequest}
6826
6847
  */
@@ -7277,11 +7298,7 @@ const jsonContentHeaders$f = {
7277
7298
  'Content-Type': 'application/json; charset=utf-8'
7278
7299
  };
7279
7300
 
7280
- /**
7281
- * Functions API.
7282
- *
7283
- * Serverless functions API. Functions API.
7284
- */
7301
+ /** Serverless Functions API. */
7285
7302
  let API$h = class API extends API$q {
7286
7303
  /** Lists the available regions of the API. */
7287
7304
  static LOCALITIES = ['fr-par', 'nl-ams', 'pl-waw'];
@@ -7906,6 +7923,7 @@ const unmarshalUser$1 = data => {
7906
7923
  throw new TypeError(`Unmarshalling the type 'User' failed as data isn't a dictionary.`);
7907
7924
  }
7908
7925
  return {
7926
+ accountRootUserId: data.account_root_user_id,
7909
7927
  createdAt: unmarshalDate(data.created_at),
7910
7928
  deletable: data.deletable,
7911
7929
  email: data.email,
@@ -10342,7 +10360,7 @@ let API$f = class API extends API$q {
10342
10360
  }, unmarshalListServersTypesResponse);
10343
10361
 
10344
10362
  /**
10345
- * List volumes types. List all volume types and their technical details.
10363
+ * List volume types. List all volume types and their technical details.
10346
10364
  *
10347
10365
  * @param request - The request {@link ListVolumesTypesRequest}
10348
10366
  * @returns A Promise of ListVolumesTypesResponse
@@ -10431,7 +10449,7 @@ let API$f = class API extends API$q {
10431
10449
  * preserve your local volumes, you should use the `archive` action instead of
10432
10450
  * `terminate`. Similarly, if you want to keep your block storage volumes, you
10433
10451
  * must first detach them before issuing the `terminate` command. For more
10434
- * information, read the [Volumes](#volumes-7e8a39) documentation.
10452
+ * information, read the [Volumes](#path-volumes-list-volumes) documentation.
10435
10453
  *
10436
10454
  * @param request - The request {@link ServerActionRequest}
10437
10455
  * @returns A Promise of ServerActionResponse
@@ -11968,9 +11986,9 @@ const jsonContentHeaders$c = {
11968
11986
  };
11969
11987
 
11970
11988
  /**
11971
- * IoT API.
11989
+ * IoT Hub API.
11972
11990
  *
11973
- * This API allows you to manage IoT hubs and devices. IoT API.
11991
+ * This API allows you to manage IoT hubs and devices. IoT Hub API.
11974
11992
  */
11975
11993
  let API$e = class API extends API$q {
11976
11994
  /** Lists the available regions of the API. */
@@ -11982,7 +12000,9 @@ let API$e = class API extends API$q {
11982
12000
  }, unmarshalListHubsResponse);
11983
12001
 
11984
12002
  /**
11985
- * List hubs.
12003
+ * List hubs. List all Hubs in the specified zone. By default, returned Hubs
12004
+ * are ordered by creation date in ascending order, though this can be
12005
+ * modified via the `order_by` field.
11986
12006
  *
11987
12007
  * @param request - The request {@link ListHubsRequest}
11988
12008
  * @returns A Promise of ListHubsResponse
@@ -11990,7 +12010,8 @@ let API$e = class API extends API$q {
11990
12010
  listHubs = (request = {}) => enrichForPagination('hubs', this.pageOfListHubs, request);
11991
12011
 
11992
12012
  /**
11993
- * Create a hub.
12013
+ * Create a hub. Create a new Hub in the targeted region, specifying its
12014
+ * configuration including name and product plan.
11994
12015
  *
11995
12016
  * @param request - The request {@link CreateHubRequest}
11996
12017
  * @returns A Promise of Hub
@@ -12003,7 +12024,9 @@ let API$e = class API extends API$q {
12003
12024
  }, unmarshalHub);
12004
12025
 
12005
12026
  /**
12006
- * Get a hub.
12027
+ * Get a hub. Retrieve information about an existing IoT Hub, specified by its
12028
+ * Hub ID. Its full details, including name, status and endpoint, are returned
12029
+ * in the response object.
12007
12030
  *
12008
12031
  * @param request - The request {@link GetHubRequest}
12009
12032
  * @returns A Promise of Hub
@@ -12023,7 +12046,8 @@ let API$e = class API extends API$q {
12023
12046
  waitForHub = (request, options) => waitForResource(options?.stop ?? (res => Promise.resolve(!HUB_TRANSIENT_STATUSES.includes(res.status))), this.getHub, request, options);
12024
12047
 
12025
12048
  /**
12026
- * Update a hub.
12049
+ * Update a hub. Update the parameters of an existing IoT Hub, specified by
12050
+ * its Hub ID.
12027
12051
  *
12028
12052
  * @param request - The request {@link UpdateHubRequest}
12029
12053
  * @returns A Promise of Hub
@@ -12036,7 +12060,7 @@ let API$e = class API extends API$q {
12036
12060
  }, unmarshalHub);
12037
12061
 
12038
12062
  /**
12039
- * Enable a hub.
12063
+ * Enable a hub. Enable an existing IoT Hub, specified by its Hub ID.
12040
12064
  *
12041
12065
  * @param request - The request {@link EnableHubRequest}
12042
12066
  * @returns A Promise of Hub
@@ -12049,7 +12073,7 @@ let API$e = class API extends API$q {
12049
12073
  }, unmarshalHub);
12050
12074
 
12051
12075
  /**
12052
- * Disable a hub.
12076
+ * Disable a hub. Disable an existing IoT Hub, specified by its Hub ID.
12053
12077
  *
12054
12078
  * @param request - The request {@link DisableHubRequest}
12055
12079
  * @returns A Promise of Hub
@@ -12062,7 +12086,8 @@ let API$e = class API extends API$q {
12062
12086
  }, unmarshalHub);
12063
12087
 
12064
12088
  /**
12065
- * Delete a hub.
12089
+ * Delete a hub. Delete an existing IoT Hub, specified by its Hub ID. Deleting
12090
+ * a Hub is permanent, and cannot be undone.
12066
12091
  *
12067
12092
  * @param request - The request {@link DeleteHubRequest}
12068
12093
  */
@@ -12073,7 +12098,8 @@ let API$e = class API extends API$q {
12073
12098
  });
12074
12099
 
12075
12100
  /**
12076
- * Get a hub's metrics.
12101
+ * Get a hub's metrics. Get the metrics of an existing IoT Hub, specified by
12102
+ * its Hub ID.
12077
12103
  *
12078
12104
  * @deprecated
12079
12105
  * @param request - The request {@link GetHubMetricsRequest}
@@ -12086,7 +12112,8 @@ let API$e = class API extends API$q {
12086
12112
  }, unmarshalGetHubMetricsResponse);
12087
12113
 
12088
12114
  /**
12089
- * Set the certificate authority of a hub.
12115
+ * Set the certificate authority of a hub. Set a particular PEM-encoded
12116
+ * certificate, specified by the Hub ID.
12090
12117
  *
12091
12118
  * @param request - The request {@link SetHubCARequest}
12092
12119
  * @returns A Promise of Hub
@@ -12099,7 +12126,8 @@ let API$e = class API extends API$q {
12099
12126
  }, unmarshalHub);
12100
12127
 
12101
12128
  /**
12102
- * Get the certificate authority of a hub.
12129
+ * Get the certificate authority of a hub. Get information for a particular
12130
+ * PEM-encoded certificate, specified by the Hub ID.
12103
12131
  *
12104
12132
  * @param request - The request {@link GetHubCARequest}
12105
12133
  * @returns A Promise of GetHubCAResponse
@@ -12115,7 +12143,9 @@ let API$e = class API extends API$q {
12115
12143
  }, unmarshalListDevicesResponse);
12116
12144
 
12117
12145
  /**
12118
- * List devices.
12146
+ * List devices. List all devices in the specified region. By default,
12147
+ * returned devices are ordered by creation date in ascending order, though
12148
+ * this can be modified via the `order_by` field.
12119
12149
  *
12120
12150
  * @param request - The request {@link ListDevicesRequest}
12121
12151
  * @returns A Promise of ListDevicesResponse
@@ -12123,7 +12153,7 @@ let API$e = class API extends API$q {
12123
12153
  listDevices = (request = {}) => enrichForPagination('devices', this.pageOfListDevices, request);
12124
12154
 
12125
12155
  /**
12126
- * Add a device.
12156
+ * Add a device. Attach a device to a given Hub.
12127
12157
  *
12128
12158
  * @param request - The request {@link CreateDeviceRequest}
12129
12159
  * @returns A Promise of CreateDeviceResponse
@@ -12136,7 +12166,9 @@ let API$e = class API extends API$q {
12136
12166
  }, unmarshalCreateDeviceResponse);
12137
12167
 
12138
12168
  /**
12139
- * Get a device.
12169
+ * Get a device. Retrieve information about an existing device, specified by
12170
+ * its device ID. Its full details, including name, status and ID, are
12171
+ * returned in the response object.
12140
12172
  *
12141
12173
  * @param request - The request {@link GetDeviceRequest}
12142
12174
  * @returns A Promise of Device
@@ -12147,7 +12179,8 @@ let API$e = class API extends API$q {
12147
12179
  }, unmarshalDevice);
12148
12180
 
12149
12181
  /**
12150
- * Update a device.
12182
+ * Update a device. Update the parameters of an existing device, specified by
12183
+ * its device ID.
12151
12184
  *
12152
12185
  * @param request - The request {@link UpdateDeviceRequest}
12153
12186
  * @returns A Promise of Device
@@ -12160,7 +12193,7 @@ let API$e = class API extends API$q {
12160
12193
  }, unmarshalDevice);
12161
12194
 
12162
12195
  /**
12163
- * Enable a device.
12196
+ * Enable a device. Enable a specific device, specified by its device ID.
12164
12197
  *
12165
12198
  * @param request - The request {@link EnableDeviceRequest}
12166
12199
  * @returns A Promise of Device
@@ -12173,7 +12206,7 @@ let API$e = class API extends API$q {
12173
12206
  }, unmarshalDevice);
12174
12207
 
12175
12208
  /**
12176
- * Disable a device.
12209
+ * Disable a device. Disable an existing device, specified by its device ID.
12177
12210
  *
12178
12211
  * @param request - The request {@link DisableDeviceRequest}
12179
12212
  * @returns A Promise of Device
@@ -12186,7 +12219,8 @@ let API$e = class API extends API$q {
12186
12219
  }, unmarshalDevice);
12187
12220
 
12188
12221
  /**
12189
- * Renew a device certificate.
12222
+ * Renew a device certificate. Renew the certificate of an existing device,
12223
+ * specified by its device ID.
12190
12224
  *
12191
12225
  * @param request - The request {@link RenewDeviceCertificateRequest}
12192
12226
  * @returns A Promise of RenewDeviceCertificateResponse
@@ -12199,7 +12233,8 @@ let API$e = class API extends API$q {
12199
12233
  }, unmarshalRenewDeviceCertificateResponse);
12200
12234
 
12201
12235
  /**
12202
- * Set a custom certificate on a device.
12236
+ * Set a custom certificate on a device. Switch the existing certificate of a
12237
+ * given device with an EM-encoded custom certificate.
12203
12238
  *
12204
12239
  * @param request - The request {@link SetDeviceCertificateRequest}
12205
12240
  * @returns A Promise of SetDeviceCertificateResponse
@@ -12212,7 +12247,9 @@ let API$e = class API extends API$q {
12212
12247
  }, unmarshalSetDeviceCertificateResponse);
12213
12248
 
12214
12249
  /**
12215
- * Get a device's certificate.
12250
+ * Get a device's certificate. Get information for a particular PEM-encoded
12251
+ * certificate, specified by the device ID. The response returns full details
12252
+ * of the device, including its type of certificate.
12216
12253
  *
12217
12254
  * @param request - The request {@link GetDeviceCertificateRequest}
12218
12255
  * @returns A Promise of GetDeviceCertificateResponse
@@ -12223,7 +12260,8 @@ let API$e = class API extends API$q {
12223
12260
  }, unmarshalGetDeviceCertificateResponse);
12224
12261
 
12225
12262
  /**
12226
- * Remove a device.
12263
+ * Remove a device. Remove a specific device from the specific Hub it is
12264
+ * attached to.
12227
12265
  *
12228
12266
  * @param request - The request {@link DeleteDeviceRequest}
12229
12267
  */
@@ -12233,7 +12271,8 @@ let API$e = class API extends API$q {
12233
12271
  });
12234
12272
 
12235
12273
  /**
12236
- * Get a device's metrics.
12274
+ * Get a device's metrics. Get the metrics of an existing device, specified by
12275
+ * its device ID.
12237
12276
  *
12238
12277
  * @deprecated
12239
12278
  * @param request - The request {@link GetDeviceMetricsRequest}
@@ -12251,7 +12290,9 @@ let API$e = class API extends API$q {
12251
12290
  }, unmarshalListRoutesResponse$1);
12252
12291
 
12253
12292
  /**
12254
- * List routes.
12293
+ * List routes. List all routes in the specified region. By default, returned
12294
+ * routes are ordered by creation date in ascending order, though this can be
12295
+ * modified via the `order_by` field.
12255
12296
  *
12256
12297
  * @param request - The request {@link ListRoutesRequest}
12257
12298
  * @returns A Promise of ListRoutesResponse
@@ -12259,15 +12300,15 @@ let API$e = class API extends API$q {
12259
12300
  listRoutes = (request = {}) => enrichForPagination('routes', this.pageOfListRoutes, request);
12260
12301
 
12261
12302
  /**
12262
- * Create a route. Multiple route kinds can be created:
12303
+ * Create a route. Multiple kinds of routes can be created, such as:
12263
12304
  *
12264
- * - Database Route. Create a route that will record subscribed MQTT messages
12305
+ * - Database Route Create a route that will record subscribed MQTT messages
12265
12306
  * into your database. <b>You need to manage the database by yourself</b>.
12266
12307
  * - REST Route. Create a route that will call a REST API on received subscribed
12267
12308
  * MQTT messages.
12268
12309
  * - S3 Routes. Create a route that will put subscribed MQTT messages into an S3
12269
- * bucket. You need to create the bucket yourself and grant us write access.
12270
- * The grant can be done with s3cmd (`s3cmd setacl s3://&lt;my-bucket&gt;
12310
+ * bucket. You need to create the bucket yourself and grant write access.
12311
+ * Granting can be done with s3cmd (`s3cmd setacl s3://&lt;my-bucket&gt;
12271
12312
  * --acl-grant=write:555c69c3-87d0-4bf8-80f1-99a2f757d031:555c69c3-87d0-4bf8-80f1-99a2f757d031`).
12272
12313
  *
12273
12314
  * @param request - The request {@link CreateRouteRequest}
@@ -12281,7 +12322,8 @@ let API$e = class API extends API$q {
12281
12322
  }, unmarshalRoute$1);
12282
12323
 
12283
12324
  /**
12284
- * Update a route.
12325
+ * Update a route. Update the parameters of an existing route, specified by
12326
+ * its route ID.
12285
12327
  *
12286
12328
  * @param request - The request {@link UpdateRouteRequest}
12287
12329
  * @returns A Promise of Route
@@ -12294,7 +12336,9 @@ let API$e = class API extends API$q {
12294
12336
  }, unmarshalRoute$1);
12295
12337
 
12296
12338
  /**
12297
- * Get a route.
12339
+ * Get a route. Get information for a particular route, specified by the route
12340
+ * ID. The response returns full details of the route, including its type, the
12341
+ * topic it subscribes to and its configuration.
12298
12342
  *
12299
12343
  * @param request - The request {@link GetRouteRequest}
12300
12344
  * @returns A Promise of Route
@@ -12305,7 +12349,8 @@ let API$e = class API extends API$q {
12305
12349
  }, unmarshalRoute$1);
12306
12350
 
12307
12351
  /**
12308
- * Delete a route.
12352
+ * Delete a route. Delete an existing route, specified by its route ID.
12353
+ * Deleting a route is permanent, and cannot be undone.
12309
12354
  *
12310
12355
  * @param request - The request {@link DeleteRouteRequest}
12311
12356
  */
@@ -12320,7 +12365,7 @@ let API$e = class API extends API$q {
12320
12365
  }, unmarshalListNetworksResponse);
12321
12366
 
12322
12367
  /**
12323
- * List the Networks.
12368
+ * List the networks.
12324
12369
  *
12325
12370
  * @param request - The request {@link ListNetworksRequest}
12326
12371
  * @returns A Promise of ListNetworksResponse
@@ -12328,7 +12373,9 @@ let API$e = class API extends API$q {
12328
12373
  listNetworks = (request = {}) => enrichForPagination('networks', this.pageOfListNetworks, request);
12329
12374
 
12330
12375
  /**
12331
- * Create a new Network.
12376
+ * Create a new network. Create a new network for an existing hub. Beside the
12377
+ * default network, you can add networks for different data providers.
12378
+ * Possible network types are Sigfox and REST.
12332
12379
  *
12333
12380
  * @param request - The request {@link CreateNetworkRequest}
12334
12381
  * @returns A Promise of CreateNetworkResponse
@@ -12341,7 +12388,9 @@ let API$e = class API extends API$q {
12341
12388
  }, unmarshalCreateNetworkResponse);
12342
12389
 
12343
12390
  /**
12344
- * Retrieve a specific Network.
12391
+ * Retrieve a specific network. Retrieve an existing network, specified by its
12392
+ * network ID. The response returns full details of the network, including its
12393
+ * type, the topic prefix and its endpoint.
12345
12394
  *
12346
12395
  * @param request - The request {@link GetNetworkRequest}
12347
12396
  * @returns A Promise of Network
@@ -12352,7 +12401,8 @@ let API$e = class API extends API$q {
12352
12401
  }, unmarshalNetwork);
12353
12402
 
12354
12403
  /**
12355
- * Delete a Network.
12404
+ * Delete a Network. Delete an existing network, specified by its network ID.
12405
+ * Deleting a network is permanent, and cannot be undone.
12356
12406
  *
12357
12407
  * @param request - The request {@link DeleteNetworkRequest}
12358
12408
  */
@@ -12834,7 +12884,7 @@ const jsonContentHeaders$b = {
12834
12884
  'Content-Type': 'application/json; charset=utf-8'
12835
12885
  };
12836
12886
 
12837
- /** Kapsule API. */
12887
+ /** Kubernetes API. */
12838
12888
  let API$d = class API extends API$q {
12839
12889
  /** Lists the available regions of the API. */
12840
12890
  static LOCALITIES = ['fr-par', 'nl-ams', 'pl-waw'];
@@ -16384,10 +16434,7 @@ const marshalPermissions = (request, defaults) => ({
16384
16434
  const marshalCreateCredentialRequest = (request, defaults) => ({
16385
16435
  name: request.name || randomName('mnq'),
16386
16436
  namespace_id: request.namespaceId,
16387
- ...resolveOneOf([{
16388
- param: 'permissions',
16389
- value: request.permissions ? marshalPermissions(request.permissions) : undefined
16390
- }])
16437
+ permissions: request.permissions ? marshalPermissions(request.permissions) : undefined
16391
16438
  });
16392
16439
  const marshalCreateNamespaceRequest$1 = (request, defaults) => ({
16393
16440
  name: request.name || randomName('mnq'),
@@ -16396,10 +16443,7 @@ const marshalCreateNamespaceRequest$1 = (request, defaults) => ({
16396
16443
  });
16397
16444
  const marshalUpdateCredentialRequest = (request, defaults) => ({
16398
16445
  name: request.name,
16399
- ...resolveOneOf([{
16400
- param: 'permissions',
16401
- value: request.permissions ? marshalPermissions(request.permissions) : undefined
16402
- }])
16446
+ permissions: request.permissions ? marshalPermissions(request.permissions) : undefined
16403
16447
  });
16404
16448
  const marshalUpdateNamespaceRequest$1 = (request, defaults) => ({
16405
16449
  name: request.name,
@@ -16412,10 +16456,10 @@ const jsonContentHeaders$9 = {
16412
16456
  };
16413
16457
 
16414
16458
  /**
16415
- * MnQ API (beta).
16459
+ * Messaging and Queuing API.
16416
16460
  *
16417
- * This API allows you to manage Scaleway Messaging and Queueing brokers. MnQ
16418
- * API (beta).
16461
+ * This API allows you to manage Scaleway Messaging and Queueing brokers.
16462
+ * Messaging and Queuing API.
16419
16463
  */
16420
16464
  let API$9 = class API extends API$q {
16421
16465
  /** Lists the available regions of the API. */
@@ -18960,11 +19004,7 @@ const jsonContentHeaders$6 = {
18960
19004
  'Content-Type': 'application/json; charset=utf-8'
18961
19005
  };
18962
19006
 
18963
- /**
18964
- * Registry API.
18965
- *
18966
- * Container registry API. Registry API.
18967
- */
19007
+ /** Container Registry API. */
18968
19008
  let API$6 = class API extends API$q {
18969
19009
  /** Lists the available regions of the API. */
18970
19010
  static LOCALITIES = ['fr-par', 'nl-ams', 'pl-waw'];
@@ -18975,7 +19015,11 @@ let API$6 = class API extends API$q {
18975
19015
  }, unmarshalListNamespacesResponse);
18976
19016
 
18977
19017
  /**
18978
- * List all your namespaces.
19018
+ * List namespaces. List all namespaces in a specified region. By default, the
19019
+ * namespaces listed are ordered by creation date in ascending order. This can
19020
+ * be modified via the order_by field. You can also define additional
19021
+ * parameters for your query, such as the `instance_id` and `project_id`
19022
+ * parameters.
18979
19023
  *
18980
19024
  * @param request - The request {@link ListNamespacesRequest}
18981
19025
  * @returns A Promise of ListNamespacesResponse
@@ -18983,7 +19027,10 @@ let API$6 = class API extends API$q {
18983
19027
  listNamespaces = (request = {}) => enrichForPagination('namespaces', this.pageOfListNamespaces, request);
18984
19028
 
18985
19029
  /**
18986
- * Get a namespace. Get the namespace associated with the given id.
19030
+ * Get a namespace. Retrieve information about a given namespace, specified by
19031
+ * its `namespace_id` and region. Full details about the namespace, such as
19032
+ * `description`, `project_id`, `status`, `endpoint`, `is_public`, `size`, and
19033
+ * `image_count` are returned in the response.
18987
19034
  *
18988
19035
  * @param request - The request {@link GetNamespaceRequest}
18989
19036
  * @returns A Promise of Namespace
@@ -19003,7 +19050,10 @@ let API$6 = class API extends API$q {
19003
19050
  waitForNamespace = (request, options) => waitForResource(options?.stop ?? (res => Promise.resolve(!NAMESPACE_TRANSIENT_STATUSES.includes(res.status))), this.getNamespace, request, options);
19004
19051
 
19005
19052
  /**
19006
- * Create a new namespace.
19053
+ * Create a namespace. Create a new Container Registry namespace. You must
19054
+ * specify the namespace name and region in which you want it to be created.
19055
+ * Optionally, you can specify the `project_id` and `is_public` in the request
19056
+ * payload.
19007
19057
  *
19008
19058
  * @param request - The request {@link CreateNamespaceRequest}
19009
19059
  * @returns A Promise of Namespace
@@ -19016,8 +19066,9 @@ let API$6 = class API extends API$q {
19016
19066
  }, unmarshalNamespace);
19017
19067
 
19018
19068
  /**
19019
- * Update an existing namespace. Update the namespace associated with the
19020
- * given id.
19069
+ * Update a namespace. Update the parameters of a given namespace, specified
19070
+ * by its `namespace_id` and `region`. You can update the `description` and
19071
+ * `is_public` parameters.
19021
19072
  *
19022
19073
  * @param request - The request {@link UpdateNamespaceRequest}
19023
19074
  * @returns A Promise of Namespace
@@ -19030,8 +19081,9 @@ let API$6 = class API extends API$q {
19030
19081
  }, unmarshalNamespace);
19031
19082
 
19032
19083
  /**
19033
- * Delete an existing namespace. Delete the namespace associated with the
19034
- * given id.
19084
+ * Delete a namespace. Delete a given namespace. You must specify, in the
19085
+ * endpoint, the `region` and `namespace_id` parameters of the namespace you
19086
+ * want to delete.
19035
19087
  *
19036
19088
  * @param request - The request {@link DeleteNamespaceRequest}
19037
19089
  * @returns A Promise of Namespace
@@ -19047,7 +19099,10 @@ let API$6 = class API extends API$q {
19047
19099
  }, unmarshalListImagesResponse);
19048
19100
 
19049
19101
  /**
19050
- * List all your images.
19102
+ * List images. List all images in a specified region. By default, the images
19103
+ * listed are ordered by creation date in ascending order. This can be
19104
+ * modified via the order_by field. You can also define additional parameters
19105
+ * for your query, such as the `namespace_id` and `project_id` parameters.
19051
19106
  *
19052
19107
  * @param request - The request {@link ListImagesRequest}
19053
19108
  * @returns A Promise of ListImagesResponse
@@ -19055,7 +19110,10 @@ let API$6 = class API extends API$q {
19055
19110
  listImages = (request = {}) => enrichForPagination('images', this.pageOfListImages, request);
19056
19111
 
19057
19112
  /**
19058
- * Get a image. Get the image associated with the given id.
19113
+ * Get an image. Retrieve information about a given container image, specified
19114
+ * by its `image_id` and region. Full details about the image, such as `name`,
19115
+ * `namespace_id`, `status`, `visibility`, and `size` are returned in the
19116
+ * response.
19059
19117
  *
19060
19118
  * @param request - The request {@link GetImageRequest}
19061
19119
  * @returns A Promise of Image
@@ -19075,7 +19133,8 @@ let API$6 = class API extends API$q {
19075
19133
  waitForImage = (request, options) => waitForResource(options?.stop ?? (res => Promise.resolve(!IMAGE_TRANSIENT_STATUSES.includes(res.status))), this.getImage, request, options);
19076
19134
 
19077
19135
  /**
19078
- * Update an existing image. Update the image associated with the given id.
19136
+ * Update an image. Update the parameters of a given image, specified by its
19137
+ * `image_id` and `region`. You can update the `visibility` parameter.
19079
19138
  *
19080
19139
  * @param request - The request {@link UpdateImageRequest}
19081
19140
  * @returns A Promise of Image
@@ -19088,7 +19147,8 @@ let API$6 = class API extends API$q {
19088
19147
  }, unmarshalImage);
19089
19148
 
19090
19149
  /**
19091
- * Delete an image. Delete the image associated with the given id.
19150
+ * Delete an image. Delete a given image. You must specify, in the endpoint,
19151
+ * the `region` and `image_id` parameters of the image you want to delete.
19092
19152
  *
19093
19153
  * @param request - The request {@link DeleteImageRequest}
19094
19154
  * @returns A Promise of Image
@@ -19104,7 +19164,10 @@ let API$6 = class API extends API$q {
19104
19164
  }, unmarshalListTagsResponse);
19105
19165
 
19106
19166
  /**
19107
- * List all your tags.
19167
+ * List tags. List all tags for a given image, specified by region. By
19168
+ * default, the tags listed are ordered by creation date in ascending order.
19169
+ * This can be modified via the order_by field. You can also define additional
19170
+ * parameters for your query, such as the `name`.
19108
19171
  *
19109
19172
  * @param request - The request {@link ListTagsRequest}
19110
19173
  * @returns A Promise of ListTagsResponse
@@ -19112,7 +19175,9 @@ let API$6 = class API extends API$q {
19112
19175
  listTags = request => enrichForPagination('tags', this.pageOfListTags, request);
19113
19176
 
19114
19177
  /**
19115
- * Get a tag. Get the tag associated with the given id.
19178
+ * Get a tag. Retrieve information about a given image tag, specified by its
19179
+ * `tag_id` and region. Full details about the tag, such as `name`,
19180
+ * `image_id`, `status`, and `digest` are returned in the response.
19116
19181
  *
19117
19182
  * @param request - The request {@link GetTagRequest}
19118
19183
  * @returns A Promise of Tag
@@ -19132,7 +19197,8 @@ let API$6 = class API extends API$q {
19132
19197
  waitForTag = (request, options) => waitForResource(options?.stop ?? (res => Promise.resolve(!TAG_TRANSIENT_STATUSES.includes(res.status))), this.getTag, request, options);
19133
19198
 
19134
19199
  /**
19135
- * Delete a tag. Delete the tag associated with the given id.
19200
+ * Delete a tag. Delete a given image tag. You must specify, in the endpoint,
19201
+ * the `region` and `tag_id` parameters of the tag you want to delete.
19136
19202
  *
19137
19203
  * @param request - The request {@link DeleteTagRequest}
19138
19204
  * @returns A Promise of Tag
@@ -19262,10 +19328,10 @@ const jsonContentHeaders$5 = {
19262
19328
  };
19263
19329
 
19264
19330
  /**
19265
- * Secret Manager API documentation.
19331
+ * Secret Manager API.
19266
19332
  *
19267
- * This API allows you to conveniently store, access and share sensitive data.
19268
- * Secret Manager API documentation.
19333
+ * Secret Manager API. This API allows you to conveniently store, access and
19334
+ * share sensitive data.
19269
19335
  */
19270
19336
  let API$5 = class API extends API$q {
19271
19337
  /** Lists the available regions of the API. */
@@ -19901,11 +19967,7 @@ const jsonContentHeaders$3 = {
19901
19967
  'Content-Type': 'application/json; charset=utf-8'
19902
19968
  };
19903
19969
 
19904
- /**
19905
- * Transactional Email API documentation.
19906
- *
19907
- * Tem. Transactional Email API documentation.
19908
- */
19970
+ /** Transactional Email API. */
19909
19971
  let API$3 = class API extends API$q {
19910
19972
  /** Lists the available regions of the API. */
19911
19973
  static LOCALITIES = ['fr-par'];