@scaleway/sdk 2.72.0 → 2.73.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 (146) hide show
  1. package/dist/api/account/v3/api.gen.cjs +13 -32
  2. package/dist/api/account/v3/api.gen.d.ts +17 -36
  3. package/dist/api/account/v3/api.gen.js +13 -32
  4. package/dist/api/account/v3/types.gen.d.ts +187 -85
  5. package/dist/api/applesilicon/v1alpha1/api.gen.cjs +19 -46
  6. package/dist/api/applesilicon/v1alpha1/api.gen.d.ts +24 -49
  7. package/dist/api/applesilicon/v1alpha1/api.gen.js +19 -46
  8. package/dist/api/applesilicon/v1alpha1/types.gen.d.ts +310 -135
  9. package/dist/api/audit_trail/v1alpha1/api.gen.cjs +2 -5
  10. package/dist/api/audit_trail/v1alpha1/api.gen.d.ts +4 -8
  11. package/dist/api/audit_trail/v1alpha1/api.gen.js +2 -5
  12. package/dist/api/audit_trail/v1alpha1/types.gen.d.ts +110 -82
  13. package/dist/api/baremetal/v1/api.gen.cjs +28 -61
  14. package/dist/api/baremetal/v1/api.gen.d.ts +29 -60
  15. package/dist/api/baremetal/v1/api.gen.js +28 -61
  16. package/dist/api/baremetal/v1/types.gen.d.ts +802 -315
  17. package/dist/api/baremetal/v3/api.gen.cjs +7 -14
  18. package/dist/api/baremetal/v3/api.gen.d.ts +10 -15
  19. package/dist/api/baremetal/v3/api.gen.js +7 -14
  20. package/dist/api/baremetal/v3/types.gen.d.ts +82 -32
  21. package/dist/api/billing/v2beta1/api.gen.cjs +11 -20
  22. package/dist/api/billing/v2beta1/api.gen.d.ts +9 -19
  23. package/dist/api/billing/v2beta1/api.gen.js +11 -20
  24. package/dist/api/billing/v2beta1/types.gen.d.ts +231 -102
  25. package/dist/api/block/v1/api.gen.cjs +37 -55
  26. package/dist/api/block/v1/api.gen.d.ts +19 -37
  27. package/dist/api/block/v1/api.gen.js +37 -55
  28. package/dist/api/block/v1/types.gen.d.ts +306 -125
  29. package/dist/api/block/v1alpha1/api.gen.cjs +45 -64
  30. package/dist/api/block/v1alpha1/api.gen.d.ts +22 -41
  31. package/dist/api/block/v1alpha1/api.gen.js +45 -64
  32. package/dist/api/block/v1alpha1/types.gen.d.ts +327 -132
  33. package/dist/api/cockpit/v1/api.gen.cjs +100 -156
  34. package/dist/api/cockpit/v1/api.gen.d.ts +53 -112
  35. package/dist/api/cockpit/v1/api.gen.js +100 -156
  36. package/dist/api/cockpit/v1/types.gen.d.ts +567 -246
  37. package/dist/api/container/v1beta1/api.gen.cjs +7 -14
  38. package/dist/api/container/v1beta1/api.gen.d.ts +9 -16
  39. package/dist/api/container/v1beta1/api.gen.js +7 -14
  40. package/dist/api/container/v1beta1/types.gen.d.ts +648 -322
  41. package/dist/api/dedibox/v1/api.gen.cjs +45 -69
  42. package/dist/api/dedibox/v1/api.gen.d.ts +52 -62
  43. package/dist/api/dedibox/v1/api.gen.js +45 -69
  44. package/dist/api/dedibox/v1/types.gen.d.ts +1765 -645
  45. package/dist/api/domain/v2beta1/api.gen.cjs +119 -178
  46. package/dist/api/domain/v2beta1/api.gen.d.ts +71 -130
  47. package/dist/api/domain/v2beta1/api.gen.js +119 -178
  48. package/dist/api/domain/v2beta1/content.gen.d.ts +1 -4
  49. package/dist/api/domain/v2beta1/types.gen.d.ts +411 -199
  50. package/dist/api/flexibleip/v1alpha1/api.gen.cjs +10 -25
  51. package/dist/api/flexibleip/v1alpha1/api.gen.d.ts +12 -28
  52. package/dist/api/flexibleip/v1alpha1/api.gen.js +10 -25
  53. package/dist/api/flexibleip/v1alpha1/types.gen.d.ts +186 -78
  54. package/dist/api/inference/v1/api.gen.cjs +8 -11
  55. package/dist/api/inference/v1/api.gen.d.ts +6 -9
  56. package/dist/api/inference/v1/api.gen.js +8 -11
  57. package/dist/api/inference/v1/types.gen.d.ts +330 -150
  58. package/dist/api/inference/v1beta1/api.gen.cjs +8 -11
  59. package/dist/api/inference/v1beta1/api.gen.d.ts +6 -9
  60. package/dist/api/inference/v1beta1/api.gen.js +8 -11
  61. package/dist/api/inference/v1beta1/types.gen.d.ts +341 -154
  62. package/dist/api/instance/v1/api.gen.cjs +64 -113
  63. package/dist/api/instance/v1/api.gen.d.ts +54 -103
  64. package/dist/api/instance/v1/api.gen.js +64 -113
  65. package/dist/api/instance/v1/types.gen.d.ts +1351 -598
  66. package/dist/api/instance/v1/types.private.gen.d.ts +131 -59
  67. package/dist/api/interlink/v1beta1/api.gen.cjs +21 -67
  68. package/dist/api/interlink/v1beta1/api.gen.d.ts +23 -70
  69. package/dist/api/interlink/v1beta1/api.gen.js +21 -67
  70. package/dist/api/interlink/v1beta1/marshalling.gen.cjs +2 -0
  71. package/dist/api/interlink/v1beta1/marshalling.gen.js +2 -0
  72. package/dist/api/interlink/v1beta1/types.gen.d.ts +464 -216
  73. package/dist/api/interlink/v1beta1/validation-rules.gen.cjs +8 -0
  74. package/dist/api/interlink/v1beta1/validation-rules.gen.d.ts +8 -0
  75. package/dist/api/interlink/v1beta1/validation-rules.gen.js +8 -0
  76. package/dist/api/iot/v1/api.gen.cjs +37 -70
  77. package/dist/api/iot/v1/api.gen.d.ts +34 -67
  78. package/dist/api/iot/v1/api.gen.js +37 -70
  79. package/dist/api/iot/v1/types.gen.d.ts +566 -321
  80. package/dist/api/ipam/v1/api.gen.cjs +6 -26
  81. package/dist/api/ipam/v1/api.gen.d.ts +8 -29
  82. package/dist/api/ipam/v1/api.gen.js +6 -26
  83. package/dist/api/ipam/v1/types.gen.d.ts +146 -105
  84. package/dist/api/jobs/v1alpha1/api.gen.cjs +2 -4
  85. package/dist/api/jobs/v1alpha1/api.gen.d.ts +4 -6
  86. package/dist/api/jobs/v1alpha1/api.gen.js +2 -4
  87. package/dist/api/jobs/v1alpha1/types.gen.d.ts +165 -91
  88. package/dist/api/k8s/v1/api.gen.cjs +33 -78
  89. package/dist/api/k8s/v1/api.gen.d.ts +27 -72
  90. package/dist/api/k8s/v1/api.gen.js +33 -78
  91. package/dist/api/k8s/v1/types.gen.d.ts +743 -506
  92. package/dist/api/key_manager/v1alpha1/api.gen.cjs +21 -57
  93. package/dist/api/key_manager/v1alpha1/api.gen.d.ts +19 -56
  94. package/dist/api/key_manager/v1alpha1/api.gen.js +21 -57
  95. package/dist/api/key_manager/v1alpha1/types.gen.d.ts +196 -114
  96. package/dist/api/marketplace/v2/api.gen.cjs +8 -21
  97. package/dist/api/marketplace/v2/api.gen.d.ts +10 -24
  98. package/dist/api/marketplace/v2/api.gen.js +8 -21
  99. package/dist/api/marketplace/v2/types.gen.d.ts +94 -41
  100. package/dist/api/mnq/v1beta1/api.gen.cjs +24 -76
  101. package/dist/api/mnq/v1beta1/api.gen.d.ts +30 -82
  102. package/dist/api/mnq/v1beta1/api.gen.js +24 -76
  103. package/dist/api/mnq/v1beta1/types.gen.d.ts +342 -169
  104. package/dist/api/mongodb/v1alpha1/api.gen.cjs +19 -62
  105. package/dist/api/mongodb/v1alpha1/api.gen.d.ts +21 -64
  106. package/dist/api/mongodb/v1alpha1/api.gen.js +19 -62
  107. package/dist/api/mongodb/v1alpha1/types.gen.d.ts +443 -189
  108. package/dist/api/qaas/v1alpha1/api.gen.cjs +17 -34
  109. package/dist/api/qaas/v1alpha1/api.gen.d.ts +19 -36
  110. package/dist/api/qaas/v1alpha1/api.gen.js +17 -34
  111. package/dist/api/qaas/v1alpha1/types.gen.d.ts +502 -174
  112. package/dist/api/rdb/v1/api.gen.cjs +62 -202
  113. package/dist/api/rdb/v1/api.gen.d.ts +60 -201
  114. package/dist/api/rdb/v1/api.gen.js +62 -202
  115. package/dist/api/rdb/v1/types.gen.d.ts +1005 -524
  116. package/dist/api/redis/v1/api.gen.cjs +23 -83
  117. package/dist/api/redis/v1/api.gen.d.ts +25 -85
  118. package/dist/api/redis/v1/api.gen.js +23 -83
  119. package/dist/api/redis/v1/types.gen.d.ts +447 -170
  120. package/dist/api/registry/v1/api.gen.cjs +12 -40
  121. package/dist/api/registry/v1/api.gen.d.ts +14 -42
  122. package/dist/api/registry/v1/api.gen.js +12 -40
  123. package/dist/api/registry/v1/types.gen.d.ts +200 -116
  124. package/dist/api/secret/v1beta1/api.gen.cjs +19 -47
  125. package/dist/api/secret/v1beta1/api.gen.d.ts +21 -51
  126. package/dist/api/secret/v1beta1/api.gen.js +19 -47
  127. package/dist/api/secret/v1beta1/types.gen.d.ts +359 -224
  128. package/dist/api/serverless_sqldb/v1alpha1/api.gen.cjs +9 -27
  129. package/dist/api/serverless_sqldb/v1alpha1/api.gen.d.ts +11 -29
  130. package/dist/api/serverless_sqldb/v1alpha1/api.gen.js +9 -27
  131. package/dist/api/serverless_sqldb/v1alpha1/types.gen.d.ts +168 -76
  132. package/dist/api/tem/v1alpha1/api.gen.cjs +22 -58
  133. package/dist/api/tem/v1alpha1/api.gen.d.ts +24 -60
  134. package/dist/api/tem/v1alpha1/api.gen.js +22 -58
  135. package/dist/api/tem/v1alpha1/types.gen.d.ts +761 -338
  136. package/dist/api/test/v1/api.gen.cjs +8 -11
  137. package/dist/api/test/v1/api.gen.d.ts +6 -9
  138. package/dist/api/test/v1/api.gen.js +8 -11
  139. package/dist/api/test/v1/types.gen.d.ts +21 -10
  140. package/dist/client/dist/package.json.cjs +1 -1
  141. package/dist/client/dist/package.json.js +1 -1
  142. package/node_modules/@scaleway/sdk-client/dist/package.json.cjs +1 -1
  143. package/node_modules/@scaleway/sdk-client/dist/package.json.js +1 -1
  144. package/node_modules/@scaleway/sdk-client/package.json +1 -2
  145. package/package.json +2 -2
  146. package/node_modules/@scaleway/sdk-client/LICENSE +0 -191
@@ -37,16 +37,14 @@ class API extends api.API {
37
37
  marshalling_gen.unmarshalListDNSZonesResponse
38
38
  );
39
39
  /**
40
- * List DNS zones. Retrieve the list of DNS zones you can manage and filter
41
- * DNS zones associated with specific domain names.
40
+ * List DNS zones. Retrieve the list of DNS zones you can manage and filter DNS zones associated with specific domain names.
42
41
  *
43
42
  * @param request - The request {@link ListDNSZonesRequest}
44
43
  * @returns A Promise of ListDNSZonesResponse
45
44
  */
46
45
  listDNSZones = (request) => resourcePaginator.enrichForPagination("dnsZones", this.pageOfListDNSZones, request);
47
46
  /**
48
- * Create a DNS zone. Create a new DNS zone specified by the domain name, the
49
- * subdomain and the Project ID.
47
+ * Create a DNS zone. Create a new DNS zone specified by the domain name, the subdomain and the Project ID.
50
48
  *
51
49
  * @param request - The request {@link CreateDNSZoneRequest}
52
50
  * @returns A Promise of DNSZone
@@ -80,8 +78,7 @@ class API extends api.API {
80
78
  marshalling_gen.unmarshalDNSZone
81
79
  );
82
80
  /**
83
- * Clone a DNS zone. Clone an existing DNS zone with all its records into a
84
- * new DNS zone.
81
+ * Clone a DNS zone. Clone an existing DNS zone with all its records into a new DNS zone.
85
82
  *
86
83
  * @param request - The request {@link CloneDNSZoneRequest}
87
84
  * @returns A Promise of DNSZone
@@ -134,33 +131,27 @@ class API extends api.API {
134
131
  marshalling_gen.unmarshalListDNSZoneRecordsResponse
135
132
  );
136
133
  /**
137
- * List records within a DNS zone. Retrieve a list of DNS records within a DNS
138
- * zone that has default name servers. You can filter records by type and
139
- * name.
140
- *
141
- * @param request - The request {@link ListDNSZoneRecordsRequest}
142
- * @returns A Promise of ListDNSZoneRecordsResponse
143
- */
134
+ * List records within a DNS zone. Retrieve a list of DNS records within a DNS zone that has default name servers.
135
+ You can filter records by type and name.
136
+ *
137
+ * @param request - The request {@link ListDNSZoneRecordsRequest}
138
+ * @returns A Promise of ListDNSZoneRecordsResponse
139
+ */
144
140
  listDNSZoneRecords = (request) => resourcePaginator.enrichForPagination("records", this.pageOfListDNSZoneRecords, request);
145
141
  /**
146
- * Update records within a DNS zone. Update records within a DNS zone that has
147
- * default name servers and perform several actions on your records.
148
- *
149
- * Actions include:
150
- *
151
- * - Add: allows you to add a new record or add a new IP to an existing A
152
- * record, for example
153
- * - Set: allows you to edit a record or edit an IP from an existing A record,
154
- * for example
155
- * - Delete: allows you to delete a record or delete an IP from an existing A
156
- * record, for example
157
- * - Clear: allows you to delete all records from a DNS zone
158
- *
159
- * All edits will be versioned.
160
- *
161
- * @param request - The request {@link UpdateDNSZoneRecordsRequest}
162
- * @returns A Promise of UpdateDNSZoneRecordsResponse
163
- */
142
+ * Update records within a DNS zone. Update records within a DNS zone that has default name servers and perform several actions on your records.
143
+
144
+ Actions include:
145
+ - add: allows you to add a new record or add a new IP to an existing A record, for example
146
+ - set: allows you to edit a record or edit an IP from an existing A record, for example
147
+ - delete: allows you to delete a record or delete an IP from an existing A record, for example
148
+ - clear: allows you to delete all records from a DNS zone
149
+
150
+ All edits will be versioned.
151
+ *
152
+ * @param request - The request {@link UpdateDNSZoneRecordsRequest}
153
+ * @returns A Promise of UpdateDNSZoneRecordsResponse
154
+ */
164
155
  updateDNSZoneRecords = (request) => this.client.fetch(
165
156
  {
166
157
  body: JSON.stringify(
@@ -173,8 +164,7 @@ class API extends api.API {
173
164
  marshalling_gen.unmarshalUpdateDNSZoneRecordsResponse
174
165
  );
175
166
  /**
176
- * List name servers within a DNS zone. Retrieve a list of name servers within
177
- * a DNS zone and their optional glue records.
167
+ * List name servers within a DNS zone. Retrieve a list of name servers within a DNS zone and their optional glue records.
178
168
  *
179
169
  * @param request - The request {@link ListDNSZoneNameserversRequest}
180
170
  * @returns A Promise of ListDNSZoneNameserversResponse
@@ -188,8 +178,7 @@ class API extends api.API {
188
178
  marshalling_gen.unmarshalListDNSZoneNameserversResponse
189
179
  );
190
180
  /**
191
- * Update name servers within a DNS zone. Update name servers within a DNS
192
- * zone and set optional glue records.
181
+ * Update name servers within a DNS zone. Update name servers within a DNS zone and set optional glue records.
193
182
  *
194
183
  * @param request - The request {@link UpdateDNSZoneNameserversRequest}
195
184
  * @returns A Promise of UpdateDNSZoneNameserversResponse
@@ -206,12 +195,12 @@ class API extends api.API {
206
195
  marshalling_gen.unmarshalUpdateDNSZoneNameserversResponse
207
196
  );
208
197
  /**
209
- * Clear records within a DNS zone. Delete all records within a DNS zone that
210
- * has default name servers.<br/> All edits will be versioned.
211
- *
212
- * @param request - The request {@link ClearDNSZoneRecordsRequest}
213
- * @returns A Promise of ClearDNSZoneRecordsResponse
214
- */
198
+ * Clear records within a DNS zone. Delete all records within a DNS zone that has default name servers.<br/>
199
+ All edits will be versioned.
200
+ *
201
+ * @param request - The request {@link ClearDNSZoneRecordsRequest}
202
+ * @returns A Promise of ClearDNSZoneRecordsResponse
203
+ */
215
204
  clearDNSZoneRecords = (request) => this.client.fetch(
216
205
  {
217
206
  method: "DELETE",
@@ -220,8 +209,7 @@ class API extends api.API {
220
209
  marshalling_gen.unmarshalClearDNSZoneRecordsResponse
221
210
  );
222
211
  /**
223
- * Export a raw DNS zone. Export a DNS zone with default name servers, in a
224
- * specific format.
212
+ * Export a raw DNS zone. Export a DNS zone with default name servers, in a specific format.
225
213
  *
226
214
  * @param request - The request {@link ExportRawDNSZoneRequest}
227
215
  * @returns A Promise of Blob
@@ -233,8 +221,7 @@ class API extends api.API {
233
221
  responseType: "blob"
234
222
  });
235
223
  /**
236
- * Import a raw DNS zone. Import and replace the format of records from a
237
- * given provider, with default name servers.
224
+ * Import a raw DNS zone. Import and replace the format of records from a given provider, with default name servers.
238
225
  *
239
226
  * @param request - The request {@link ImportRawDNSZoneRequest}
240
227
  * @returns A Promise of ImportRawDNSZoneResponse
@@ -251,8 +238,7 @@ class API extends api.API {
251
238
  marshalling_gen.unmarshalImportRawDNSZoneResponse
252
239
  );
253
240
  /**
254
- * Import a DNS zone from another provider. Import and replace the format of
255
- * records from a given provider, with default name servers.
241
+ * Import a DNS zone from another provider. Import and replace the format of records from a given provider, with default name servers.
256
242
  *
257
243
  * @param request - The request {@link ImportProviderDNSZoneRequest}
258
244
  * @returns A Promise of ImportProviderDNSZoneResponse
@@ -269,13 +255,12 @@ class API extends api.API {
269
255
  marshalling_gen.unmarshalImportProviderDNSZoneResponse
270
256
  );
271
257
  /**
272
- * Refresh a DNS zone. Refresh an SOA DNS zone to reload the records in the
273
- * DNS zone and update the SOA serial. You can recreate the given DNS zone and
274
- * its sub DNS zone if needed.
275
- *
276
- * @param request - The request {@link RefreshDNSZoneRequest}
277
- * @returns A Promise of RefreshDNSZoneResponse
278
- */
258
+ * Refresh a DNS zone. Refresh an SOA DNS zone to reload the records in the DNS zone and update the SOA serial.
259
+ You can recreate the given DNS zone and its sub DNS zone if needed.
260
+ *
261
+ * @param request - The request {@link RefreshDNSZoneRequest}
262
+ * @returns A Promise of RefreshDNSZoneResponse
263
+ */
279
264
  refreshDNSZone = (request) => this.client.fetch(
280
265
  {
281
266
  body: JSON.stringify(
@@ -302,13 +287,12 @@ class API extends api.API {
302
287
  marshalling_gen.unmarshalListDNSZoneVersionsResponse
303
288
  );
304
289
  /**
305
- * List versions of a DNS zone. Retrieve a list of a DNS zone's versions.<br/>
306
- * The maximum version count is 100. If the count reaches this limit, the
307
- * oldest version will be deleted after each new modification.
308
- *
309
- * @param request - The request {@link ListDNSZoneVersionsRequest}
310
- * @returns A Promise of ListDNSZoneVersionsResponse
311
- */
290
+ * List versions of a DNS zone. Retrieve a list of a DNS zone's versions.<br/>
291
+ The maximum version count is 100. If the count reaches this limit, the oldest version will be deleted after each new modification.
292
+ *
293
+ * @param request - The request {@link ListDNSZoneVersionsRequest}
294
+ * @returns A Promise of ListDNSZoneVersionsResponse
295
+ */
312
296
  listDNSZoneVersions = (request) => resourcePaginator.enrichForPagination("versions", this.pageOfListDNSZoneVersions, request);
313
297
  pageOfListDNSZoneVersionRecords = (request) => this.client.fetch(
314
298
  {
@@ -325,8 +309,7 @@ class API extends api.API {
325
309
  marshalling_gen.unmarshalListDNSZoneVersionRecordsResponse
326
310
  );
327
311
  /**
328
- * List records from a given version of a specific DNS zone. Retrieve a list
329
- * of records from a specific DNS zone version.
312
+ * List records from a given version of a specific DNS zone. Retrieve a list of records from a specific DNS zone version.
330
313
  *
331
314
  * @param request - The request {@link ListDNSZoneVersionRecordsRequest}
332
315
  * @returns A Promise of ListDNSZoneVersionRecordsResponse
@@ -337,8 +320,7 @@ class API extends api.API {
337
320
  request
338
321
  );
339
322
  /**
340
- * Access differences from a specific DNS zone version. Access a previous DNS
341
- * zone version to see the differences from another specific version.
323
+ * Access differences from a specific DNS zone version. Access a previous DNS zone version to see the differences from another specific version.
342
324
  *
343
325
  * @param request - The request {@link GetDNSZoneVersionDiffRequest}
344
326
  * @returns A Promise of GetDNSZoneVersionDiffResponse
@@ -351,8 +333,7 @@ class API extends api.API {
351
333
  marshalling_gen.unmarshalGetDNSZoneVersionDiffResponse
352
334
  );
353
335
  /**
354
- * Restore a DNS zone version. Restore and activate a version of a specific
355
- * DNS zone.
336
+ * Restore a DNS zone version. Restore and activate a version of a specific DNS zone.
356
337
  *
357
338
  * @param request - The request {@link RestoreDNSZoneVersionRequest}
358
339
  * @returns A Promise of RestoreDNSZoneVersionResponse
@@ -367,8 +348,7 @@ class API extends api.API {
367
348
  marshalling_gen.unmarshalRestoreDNSZoneVersionResponse
368
349
  );
369
350
  /**
370
- * Get a DNS zone's TLS certificate. Get the DNS zone's TLS certificate. If
371
- * you do not have a certificate, the ouptut returns `no certificate found`.
351
+ * Get a DNS zone's TLS certificate. Get the DNS zone's TLS certificate. If you do not have a certificate, the ouptut returns `no certificate found`.
372
352
  *
373
353
  * @param request - The request {@link GetSSLCertificateRequest}
374
354
  * @returns A Promise of SSLCertificate
@@ -396,8 +376,7 @@ class API extends api.API {
396
376
  options
397
377
  );
398
378
  /**
399
- * Create or get the DNS zone's TLS certificate. Create a new TLS certificate
400
- * or retrieve information about an existing TLS certificate.
379
+ * Create or get the DNS zone's TLS certificate. Create a new TLS certificate or retrieve information about an existing TLS certificate.
401
380
  *
402
381
  * @param request - The request {@link CreateSSLCertificateRequest}
403
382
  * @returns A Promise of SSLCertificate
@@ -430,17 +409,14 @@ class API extends api.API {
430
409
  marshalling_gen.unmarshalListSSLCertificatesResponse
431
410
  );
432
411
  /**
433
- * List a user's TLS certificates. List all the TLS certificates a user has
434
- * created, specified by the user's Project ID and the DNS zone.
412
+ * List a user's TLS certificates. List all the TLS certificates a user has created, specified by the user's Project ID and the DNS zone.
435
413
  *
436
414
  * @param request - The request {@link ListSSLCertificatesRequest}
437
415
  * @returns A Promise of ListSSLCertificatesResponse
438
416
  */
439
417
  listSSLCertificates = (request) => resourcePaginator.enrichForPagination("certificates", this.pageOfListSSLCertificates, request);
440
418
  /**
441
- * Delete a TLS certificate. Delete an existing TLS certificate specified by
442
- * its DNS zone. Deleting a TLS certificate is permanent and cannot be
443
- * undone.
419
+ * Delete a TLS certificate. Delete an existing TLS certificate specified by its DNS zone. Deleting a TLS certificate is permanent and cannot be undone.
444
420
  *
445
421
  * @param request - The request {@link DeleteSSLCertificateRequest}
446
422
  * @returns A Promise of DeleteSSLCertificateResponse
@@ -453,8 +429,7 @@ class API extends api.API {
453
429
  marshalling_gen.unmarshalDeleteSSLCertificateResponse
454
430
  );
455
431
  /**
456
- * Get the DNS zone's TSIG key. Retrieve information about the TSIG key of a
457
- * given DNS zone to allow AXFR requests.
432
+ * Get the DNS zone's TSIG key. Retrieve information about the TSIG key of a given DNS zone to allow AXFR requests.
458
433
  *
459
434
  * @param request - The request {@link GetDNSZoneTsigKeyRequest}
460
435
  * @returns A Promise of GetDNSZoneTsigKeyResponse
@@ -467,8 +442,7 @@ class API extends api.API {
467
442
  marshalling_gen.unmarshalGetDNSZoneTsigKeyResponse
468
443
  );
469
444
  /**
470
- * Delete the DNS zone's TSIG key. Delete an existing TSIG key specified by
471
- * its DNS zone. Deleting a TSIG key is permanent and cannot be undone.
445
+ * Delete the DNS zone's TSIG key. Delete an existing TSIG key specified by its DNS zone. Deleting a TSIG key is permanent and cannot be undone.
472
446
  *
473
447
  * @param request - The request {@link DeleteDNSZoneTsigKeyRequest}
474
448
  */
@@ -499,20 +473,20 @@ class RegistrarAPI extends api.API {
499
473
  marshalling_gen.unmarshalListTasksResponse
500
474
  );
501
475
  /**
502
- * List tasks. List all operations performed on the account. You can filter
503
- * the list of tasks by domain name.
504
- *
505
- * @param request - The request {@link RegistrarApiListTasksRequest}
506
- * @returns A Promise of ListTasksResponse
507
- */
476
+ * List tasks. List all operations performed on the account.
477
+ You can filter the list of tasks by domain name.
478
+ *
479
+ * @param request - The request {@link RegistrarApiListTasksRequest}
480
+ * @returns A Promise of ListTasksResponse
481
+ */
508
482
  listTasks = (request = {}) => resourcePaginator.enrichForPagination("tasks", this.pageOfListTasks, request);
509
483
  /**
510
- * Purchase domains. Request the registration of domain names. You can provide
511
- * a domain's already existing contact or a new contact.
512
- *
513
- * @param request - The request {@link RegistrarApiBuyDomainsRequest}
514
- * @returns A Promise of OrderResponse
515
- */
484
+ * Purchase domains. Request the registration of domain names.
485
+ You can provide a domain's already existing contact or a new contact.
486
+ *
487
+ * @param request - The request {@link RegistrarApiBuyDomainsRequest}
488
+ * @returns A Promise of OrderResponse
489
+ */
516
490
  buyDomains = (request) => this.client.fetch(
517
491
  {
518
492
  body: JSON.stringify(
@@ -542,8 +516,7 @@ class RegistrarAPI extends api.API {
542
516
  marshalling_gen.unmarshalOrderResponse
543
517
  );
544
518
  /**
545
- * Transfer a domain. Request the transfer of a domain from another registrar
546
- * to Scaleway Domains and DNS.
519
+ * Transfer a domain. Request the transfer of a domain from another registrar to Scaleway Domains and DNS.
547
520
  *
548
521
  * @param request - The request {@link RegistrarApiTransferInDomainRequest}
549
522
  * @returns A Promise of OrderResponse
@@ -563,18 +536,14 @@ class RegistrarAPI extends api.API {
563
536
  marshalling_gen.unmarshalOrderResponse
564
537
  );
565
538
  /**
566
- * Trade a domain's contact. Request to change a domain's contact owner.<br/>
567
- * If you specify the `organization_id` of the domain's new owner, the contact
568
- * will change from the current owner's Scaleway account to the new owner's
569
- * Scaleway account.<br/> If the new owner's current contact information is
570
- * not available, the first ever contact they have created for previous
571
- * domains is taken into account to operate the change.<br/> If the new owner
572
- * has never created a contact to register domains before, an error message
573
- * displays.
574
- *
575
- * @param request - The request {@link RegistrarApiTradeDomainRequest}
576
- * @returns A Promise of OrderResponse
577
- */
539
+ * Trade a domain's contact. Request to change a domain's contact owner.<br/>
540
+ If you specify the `organization_id` of the domain's new owner, the contact will change from the current owner's Scaleway account to the new owner's Scaleway account.<br/>
541
+ If the new owner's current contact information is not available, the first ever contact they have created for previous domains is taken into account to operate the change.<br/>
542
+ If the new owner has never created a contact to register domains before, an error message displays.
543
+ *
544
+ * @param request - The request {@link RegistrarApiTradeDomainRequest}
545
+ * @returns A Promise of OrderResponse
546
+ */
578
547
  tradeDomain = (request) => this.client.fetch(
579
548
  {
580
549
  body: JSON.stringify(
@@ -587,11 +556,9 @@ class RegistrarAPI extends api.API {
587
556
  marshalling_gen.unmarshalOrderResponse
588
557
  );
589
558
  /**
590
- * Register an external domain. Request the registration of an external domain
591
- * name.
559
+ * Register an external domain. Request the registration of an external domain name.
592
560
  *
593
- * @param request - The request
594
- * {@link RegistrarApiRegisterExternalDomainRequest}
561
+ * @param request - The request {@link RegistrarApiRegisterExternalDomainRequest}
595
562
  * @returns A Promise of RegisterExternalDomainResponse
596
563
  */
597
564
  registerExternalDomain = (request) => this.client.fetch(
@@ -622,15 +589,12 @@ class RegistrarAPI extends api.API {
622
589
  marshalling_gen.unmarshalDeleteExternalDomainResponse
623
590
  );
624
591
  /**
625
- * Check if contacts are compatible with a domain or a TLD. Check whether
626
- * contacts are compatible with a domain or a TLD. If contacts are not
627
- * compatible with either the domain or the TLD, the information that needs to
628
- * be corrected is returned.
629
- *
630
- * @param request - The request
631
- * {@link RegistrarApiCheckContactsCompatibilityRequest}
632
- * @returns A Promise of CheckContactsCompatibilityResponse
633
- */
592
+ * Check if contacts are compatible with a domain or a TLD. Check whether contacts are compatible with a domain or a TLD.
593
+ If contacts are not compatible with either the domain or the TLD, the information that needs to be corrected is returned.
594
+ *
595
+ * @param request - The request {@link RegistrarApiCheckContactsCompatibilityRequest}
596
+ * @returns A Promise of CheckContactsCompatibilityResponse
597
+ */
634
598
  checkContactsCompatibility = (request = {}) => this.client.fetch(
635
599
  {
636
600
  body: JSON.stringify(
@@ -665,16 +629,15 @@ class RegistrarAPI extends api.API {
665
629
  marshalling_gen.unmarshalListContactsResponse
666
630
  );
667
631
  /**
668
- * List contacts. Retrieve the list of contacts and their associated domains
669
- * and roles. You can filter the list by domain name.
670
- *
671
- * @param request - The request {@link RegistrarApiListContactsRequest}
672
- * @returns A Promise of ListContactsResponse
673
- */
632
+ * List contacts. Retrieve the list of contacts and their associated domains and roles.
633
+ You can filter the list by domain name.
634
+ *
635
+ * @param request - The request {@link RegistrarApiListContactsRequest}
636
+ * @returns A Promise of ListContactsResponse
637
+ */
674
638
  listContacts = (request = {}) => resourcePaginator.enrichForPagination("contacts", this.pageOfListContacts, request);
675
639
  /**
676
- * Get a contact. Retrieve a contact's details from the registrar using the
677
- * given contact's ID.
640
+ * Get a contact. Retrieve a contact's details from the registrar using the given contact's ID.
678
641
  *
679
642
  * @param request - The request {@link RegistrarApiGetContactRequest}
680
643
  * @returns A Promise of Contact
@@ -752,17 +715,14 @@ class RegistrarAPI extends api.API {
752
715
  marshalling_gen.unmarshalListRenewableDomainsResponse
753
716
  );
754
717
  /**
755
- * List domains that can be renewed. Retrieve the list of domains you own that
756
- * can be renewed. You can also see the maximum renewal duration in years for
757
- * your domains that are renewable.
718
+ * List domains that can be renewed. Retrieve the list of domains you own that can be renewed. You can also see the maximum renewal duration in years for your domains that are renewable.
758
719
  *
759
720
  * @param request - The request {@link RegistrarApiListRenewableDomainsRequest}
760
721
  * @returns A Promise of ListRenewableDomainsResponse
761
722
  */
762
723
  listRenewableDomains = (request = {}) => resourcePaginator.enrichForPagination("domains", this.pageOfListRenewableDomains, request);
763
724
  /**
764
- * Get domain. Retrieve a specific domain and display the domain's
765
- * information.
725
+ * Get domain. Retrieve a specific domain and display the domain's information.
766
726
  *
767
727
  * @param request - The request {@link RegistrarApiGetDomainRequest}
768
728
  * @returns A Promise of Domain
@@ -790,14 +750,12 @@ class RegistrarAPI extends api.API {
790
750
  options
791
751
  );
792
752
  /**
793
- * Update a domain's contacts. Update contacts for a specific domain or create
794
- * a new contact.<br/> If you add the same contact for multiple roles (owner,
795
- * administrative, technical), only one ID will be created and used for all of
796
- * the roles.
797
- *
798
- * @param request - The request {@link RegistrarApiUpdateDomainRequest}
799
- * @returns A Promise of Domain
800
- */
753
+ * Update a domain's contacts. Update contacts for a specific domain or create a new contact.<br/>
754
+ If you add the same contact for multiple roles (owner, administrative, technical), only one ID will be created and used for all of the roles.
755
+ *
756
+ * @param request - The request {@link RegistrarApiUpdateDomainRequest}
757
+ * @returns A Promise of Domain
758
+ */
801
759
  updateDomain = (request) => this.client.fetch(
802
760
  {
803
761
  body: JSON.stringify(
@@ -810,9 +768,7 @@ class RegistrarAPI extends api.API {
810
768
  marshalling_gen.unmarshalDomain
811
769
  );
812
770
  /**
813
- * Lock the transfer of a domain. Lock the transfer of a domain. This means
814
- * that the domain cannot be transferred and the authorization code cannot be
815
- * requested to your current registrar.
771
+ * Lock the transfer of a domain. Lock the transfer of a domain. This means that the domain cannot be transferred and the authorization code cannot be requested to your current registrar.
816
772
  *
817
773
  * @param request - The request {@link RegistrarApiLockDomainTransferRequest}
818
774
  * @returns A Promise of Domain
@@ -827,9 +783,7 @@ class RegistrarAPI extends api.API {
827
783
  marshalling_gen.unmarshalDomain
828
784
  );
829
785
  /**
830
- * Unlock the transfer of a domain. Unlock the transfer of a domain. This
831
- * means that the domain can be transferred and the authorization code can be
832
- * requested to your current registrar.
786
+ * Unlock the transfer of a domain. Unlock the transfer of a domain. This means that the domain can be transferred and the authorization code can be requested to your current registrar.
833
787
  *
834
788
  * @param request - The request {@link RegistrarApiUnlockDomainTransferRequest}
835
789
  * @returns A Promise of Domain
@@ -844,11 +798,9 @@ class RegistrarAPI extends api.API {
844
798
  marshalling_gen.unmarshalDomain
845
799
  );
846
800
  /**
847
- * Enable auto renew. Enable the `auto renew` feature for a domain. This means
848
- * the domain will be automatically renewed before its expiry date.
801
+ * Enable auto renew. Enable the `auto renew` feature for a domain. This means the domain will be automatically renewed before its expiry date.
849
802
  *
850
- * @param request - The request
851
- * {@link RegistrarApiEnableDomainAutoRenewRequest}
803
+ * @param request - The request {@link RegistrarApiEnableDomainAutoRenewRequest}
852
804
  * @returns A Promise of Domain
853
805
  */
854
806
  enableDomainAutoRenew = (request) => this.client.fetch(
@@ -861,11 +813,9 @@ class RegistrarAPI extends api.API {
861
813
  marshalling_gen.unmarshalDomain
862
814
  );
863
815
  /**
864
- * Disable auto renew. Disable the `auto renew` feature for a domain. This
865
- * means the domain will not be renewed before its expiry date.
816
+ * Disable auto renew. Disable the `auto renew` feature for a domain. This means the domain will not be renewed before its expiry date.
866
817
  *
867
- * @param request - The request
868
- * {@link RegistrarApiDisableDomainAutoRenewRequest}
818
+ * @param request - The request {@link RegistrarApiDisableDomainAutoRenewRequest}
869
819
  * @returns A Promise of Domain
870
820
  */
871
821
  disableDomainAutoRenew = (request) => this.client.fetch(
@@ -878,15 +828,12 @@ class RegistrarAPI extends api.API {
878
828
  marshalling_gen.unmarshalDomain
879
829
  );
880
830
  /**
881
- * Get a domain's authorization code. Retrieve the authorization code to
882
- * tranfer an unlocked domain. The output returns an error if the domain is
883
- * locked. Some TLDs may have a different procedure to retrieve the
884
- * authorization code. In that case, the information displays in the message
885
- * field.
886
- *
887
- * @param request - The request {@link RegistrarApiGetDomainAuthCodeRequest}
888
- * @returns A Promise of GetDomainAuthCodeResponse
889
- */
831
+ * Get a domain's authorization code. Retrieve the authorization code to tranfer an unlocked domain. The output returns an error if the domain is locked.
832
+ Some TLDs may have a different procedure to retrieve the authorization code. In that case, the information displays in the message field.
833
+ *
834
+ * @param request - The request {@link RegistrarApiGetDomainAuthCodeRequest}
835
+ * @returns A Promise of GetDomainAuthCodeResponse
836
+ */
890
837
  getDomainAuthCode = (request) => this.client.fetch(
891
838
  {
892
839
  method: "GET",
@@ -895,9 +842,7 @@ class RegistrarAPI extends api.API {
895
842
  marshalling_gen.unmarshalGetDomainAuthCodeResponse
896
843
  );
897
844
  /**
898
- * Update domain DNSSEC. If your domain uses another registrar and has the
899
- * default Scaleway NS, you have to **update the DS record at your
900
- * registrar**.
845
+ * Update domain DNSSEC. If your domain uses another registrar and has the default Scaleway NS, you have to **update the DS record at your registrar**.
901
846
  *
902
847
  * @param request - The request {@link RegistrarApiEnableDomainDNSSECRequest}
903
848
  * @returns A Promise of Domain
@@ -932,16 +877,13 @@ class RegistrarAPI extends api.API {
932
877
  marshalling_gen.unmarshalDomain
933
878
  );
934
879
  /**
935
- * Search available domains. Search a domain or a maximum of 10 domains that
936
- * are available.
937
- *
938
- * If the TLD list is empty or not set, the search returns the results from
939
- * the most popular TLDs.
940
- *
941
- * @param request - The request
942
- * {@link RegistrarApiSearchAvailableDomainsRequest}
943
- * @returns A Promise of SearchAvailableDomainsResponse
944
- */
880
+ * Search available domains. Search a domain or a maximum of 10 domains that are available.
881
+
882
+ If the TLD list is empty or not set, the search returns the results from the most popular TLDs.
883
+ *
884
+ * @param request - The request {@link RegistrarApiSearchAvailableDomainsRequest}
885
+ * @returns A Promise of SearchAvailableDomainsResponse
886
+ */
945
887
  searchAvailableDomains = (request) => this.client.fetch(
946
888
  {
947
889
  method: "GET",
@@ -978,8 +920,7 @@ class RegistrarAPI extends api.API {
978
920
  */
979
921
  listTlds = (request = {}) => resourcePaginator.enrichForPagination("tlds", this.pageOfListTlds, request);
980
922
  /**
981
- * Create a hostname for a domain. Create a hostname for a domain with glue
982
- * IPs.
923
+ * Create a hostname for a domain. Create a hostname for a domain with glue IPs.
983
924
  *
984
925
  * @param request - The request {@link RegistrarApiCreateDomainHostRequest}
985
926
  * @returns A Promise of Host