@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
@@ -15,10 +15,7 @@ class API extends api.API {
15
15
  /** Lists the available regions of the API. */
16
16
  static LOCALITIES = ["fr-par"];
17
17
  /**
18
- * Send an email. You must specify the `region`, the sender and the
19
- * recipient's information and the `project_id` to send an email from a
20
- * checked domain. The subject of the email must contain at least 6
21
- * characters.
18
+ * Send an email. You must specify the `region`, the sender and the recipient's information and the `project_id` to send an email from a checked domain. The subject of the email must contain at least 6 characters.
22
19
  *
23
20
  * @param request - The request {@link CreateEmailRequest}
24
21
  * @returns A Promise of CreateEmailResponse
@@ -35,8 +32,7 @@ class API extends api.API {
35
32
  marshalling_gen.unmarshalCreateEmailResponse
36
33
  );
37
34
  /**
38
- * Get an email. Retrieve information about a specific email using the
39
- * `email_id` and `region` parameters.
35
+ * Get an email. Retrieve information about a specific email using the `email_id` and `region` parameters.
40
36
  *
41
37
  * @param request - The request {@link GetEmailRequest}
42
38
  * @returns A Promise of Email
@@ -89,8 +85,7 @@ class API extends api.API {
89
85
  marshalling_gen.unmarshalListEmailsResponse
90
86
  );
91
87
  /**
92
- * List emails. Retrieve the list of emails sent from a specific domain or for
93
- * a specific Project or Organization. You must specify the `region`.
88
+ * List emails. Retrieve the list of emails sent from a specific domain or for a specific Project or Organization. You must specify the `region`.
94
89
  *
95
90
  * @param request - The request {@link ListEmailsRequest}
96
91
  * @returns A Promise of ListEmailsResponse
@@ -117,9 +112,7 @@ class API extends api.API {
117
112
  marshalling_gen.unmarshalStatistics
118
113
  );
119
114
  /**
120
- * Cancel an email. You can cancel the sending of an email if it has not been
121
- * sent yet. You must specify the `region` and the `email_id` of the email you
122
- * want to cancel.
115
+ * Cancel an email. You can cancel the sending of an email if it has not been sent yet. You must specify the `region` and the `email_id` of the email you want to cancel.
123
116
  *
124
117
  * @param request - The request {@link CancelEmailRequest}
125
118
  * @returns A Promise of Email
@@ -134,8 +127,7 @@ class API extends api.API {
134
127
  marshalling_gen.unmarshalEmail
135
128
  );
136
129
  /**
137
- * Register a domain in a project. You must specify the `region`, `project_id`
138
- * and `domain_name` to register a domain in a specific Project.
130
+ * Register a domain in a project. You must specify the `region`, `project_id` and `domain_name` to register a domain in a specific Project.
139
131
  *
140
132
  * @param request - The request {@link CreateDomainRequest}
141
133
  * @returns A Promise of Domain
@@ -152,14 +144,7 @@ class API extends api.API {
152
144
  marshalling_gen.unmarshalDomain
153
145
  );
154
146
  /**
155
- * Get information about a domain. Retrieve information about a specific
156
- * domain using the `region` and `domain_id` parameters. Monitor your domain's
157
- * reputation and improve **average** and **bad** reputation statuses, using
158
- * your domain's **Email activity** tab on the [Scaleway
159
- * console](https://console.scaleway.com/transactional-email/domains) to get a
160
- * more detailed report. Check out our [dedicated
161
- * documentation](https://www.scaleway.com/en/docs/managed-services/transactional-email/reference-content/understanding-tem-reputation-score/)
162
- * to improve your domain's reputation.
147
+ * Get information about a domain. Retrieve information about a specific domain using the `region` and `domain_id` parameters. Monitor your domain's reputation and improve **average** and **bad** reputation statuses, using your domain's **Email activity** tab on the [Scaleway console](https://console.scaleway.com/transactional-email/domains) to get a more detailed report. Check out our [dedicated documentation](https://www.scaleway.com/en/docs/managed-services/transactional-email/reference-content/understanding-tem-reputation-score/) to improve your domain's reputation.
163
148
  *
164
149
  * @param request - The request {@link GetDomainRequest}
165
150
  * @returns A Promise of Domain
@@ -203,17 +188,14 @@ class API extends api.API {
203
188
  marshalling_gen.unmarshalListDomainsResponse
204
189
  );
205
190
  /**
206
- * List domains. Retrieve domains in a specific Project or in a specific
207
- * Organization using the `region` parameter.
191
+ * List domains. Retrieve domains in a specific Project or in a specific Organization using the `region` parameter.
208
192
  *
209
193
  * @param request - The request {@link ListDomainsRequest}
210
194
  * @returns A Promise of ListDomainsResponse
211
195
  */
212
196
  listDomains = (request = {}) => resourcePaginator.enrichForPagination("domains", this.pageOfListDomains, request);
213
197
  /**
214
- * Delete a domain. You must specify the domain you want to delete by the
215
- * `region` and `domain_id`. Deleting a domain is permanent and cannot be
216
- * undone.
198
+ * Delete a domain. You must specify the domain you want to delete by the `region` and `domain_id`. Deleting a domain is permanent and cannot be undone.
217
199
  *
218
200
  * @param request - The request {@link RevokeDomainRequest}
219
201
  * @returns A Promise of Domain
@@ -228,8 +210,7 @@ class API extends api.API {
228
210
  marshalling_gen.unmarshalDomain
229
211
  );
230
212
  /**
231
- * Domain DNS check. Perform an immediate DNS check of a domain using the
232
- * `region` and `domain_id` parameters.
213
+ * Domain DNS check. Perform an immediate DNS check of a domain using the `region` and `domain_id` parameters.
233
214
  *
234
215
  * @param request - The request {@link CheckDomainRequest}
235
216
  * @returns A Promise of Domain
@@ -244,9 +225,7 @@ class API extends api.API {
244
225
  marshalling_gen.unmarshalDomain
245
226
  );
246
227
  /**
247
- * Display SPF and DKIM records status and potential errors. Display SPF and
248
- * DKIM records status and potential errors, including the found records to
249
- * make debugging easier.
228
+ * Display SPF and DKIM records status and potential errors. Display SPF and DKIM records status and potential errors, including the found records to make debugging easier.
250
229
  *
251
230
  * @param request - The request {@link GetDomainLastStatusRequest}
252
231
  * @returns A Promise of DomainLastStatus
@@ -276,8 +255,7 @@ class API extends api.API {
276
255
  marshalling_gen.unmarshalDomain
277
256
  );
278
257
  /**
279
- * Create a Webhook. Create a new Webhook triggered by a list of event types
280
- * and pushed to a Scaleway SNS ARN.
258
+ * Create a Webhook. Create a new Webhook triggered by a list of event types and pushed to a Scaleway SNS ARN.
281
259
  *
282
260
  * @param request - The request {@link CreateWebhookRequest}
283
261
  * @returns A Promise of Webhook
@@ -312,16 +290,14 @@ class API extends api.API {
312
290
  marshalling_gen.unmarshalListWebhooksResponse
313
291
  );
314
292
  /**
315
- * List Webhooks. Retrieve Webhooks in a specific Project or in a specific
316
- * Organization using the `region` parameter.
293
+ * List Webhooks. Retrieve Webhooks in a specific Project or in a specific Organization using the `region` parameter.
317
294
  *
318
295
  * @param request - The request {@link ListWebhooksRequest}
319
296
  * @returns A Promise of ListWebhooksResponse
320
297
  */
321
298
  listWebhooks = (request = {}) => resourcePaginator.enrichForPagination("webhooks", this.pageOfListWebhooks, request);
322
299
  /**
323
- * Get information about a Webhook. Retrieve information about a specific
324
- * Webhook using the `webhook_id` and `region` parameters.
300
+ * Get information about a Webhook. Retrieve information about a specific Webhook using the `webhook_id` and `region` parameters.
325
301
  *
326
302
  * @param request - The request {@link GetWebhookRequest}
327
303
  * @returns A Promise of Webhook
@@ -351,9 +327,7 @@ class API extends api.API {
351
327
  marshalling_gen.unmarshalWebhook
352
328
  );
353
329
  /**
354
- * Delete a Webhook. You must specify the Webhook you want to delete by the
355
- * `region` and `webhook_id`. Deleting a Webhook is permanent and cannot be
356
- * undone.
330
+ * Delete a Webhook. You must specify the Webhook you want to delete by the `region` and `webhook_id`. Deleting a Webhook is permanent and cannot be undone.
357
331
  *
358
332
  * @param request - The request {@link DeleteWebhookRequest}
359
333
  */
@@ -383,17 +357,14 @@ class API extends api.API {
383
357
  marshalling_gen.unmarshalListWebhookEventsResponse
384
358
  );
385
359
  /**
386
- * List Webhook triggered events. Retrieve the list of Webhook events
387
- * triggered from a specific Webhook or for a specific Project or
388
- * Organization. You must specify the `region`.
360
+ * List Webhook triggered events. Retrieve the list of Webhook events triggered from a specific Webhook or for a specific Project or Organization. You must specify the `region`.
389
361
  *
390
362
  * @param request - The request {@link ListWebhookEventsRequest}
391
363
  * @returns A Promise of ListWebhookEventsResponse
392
364
  */
393
365
  listWebhookEvents = (request) => resourcePaginator.enrichForPagination("webhookEvents", this.pageOfListWebhookEvents, request);
394
366
  /**
395
- * List project settings. Retrieve the project settings including periodic
396
- * reports.
367
+ * List project settings. Retrieve the project settings including periodic reports.
397
368
  *
398
369
  * @param request - The request {@link GetProjectSettingsRequest}
399
370
  * @returns A Promise of ProjectSettings
@@ -406,8 +377,7 @@ class API extends api.API {
406
377
  marshalling_gen.unmarshalProjectSettings
407
378
  );
408
379
  /**
409
- * Update project settings. Update the project settings including periodic
410
- * reports.
380
+ * Update project settings. Update the project settings including periodic reports.
411
381
  *
412
382
  * @param request - The request {@link UpdateProjectSettingsRequest}
413
383
  * @returns A Promise of ProjectSettings
@@ -450,8 +420,7 @@ class API extends api.API {
450
420
  */
451
421
  listBlocklists = (request) => resourcePaginator.enrichForPagination("blocklists", this.pageOfListBlocklists, request);
452
422
  /**
453
- * Bulk create blocklists. Create multiple blocklists in a specific Project or
454
- * Organization using the `region` parameter.
423
+ * Bulk create blocklists. Create multiple blocklists in a specific Project or Organization using the `region` parameter.
455
424
  *
456
425
  * @param request - The request {@link BulkCreateBlocklistsRequest}
457
426
  * @returns A Promise of BulkCreateBlocklistsResponse
@@ -468,8 +437,7 @@ class API extends api.API {
468
437
  marshalling_gen.unmarshalBulkCreateBlocklistsResponse
469
438
  );
470
439
  /**
471
- * Delete a blocklist. You must specify the blocklist you want to delete by
472
- * the `region` and `blocklist_id`.
440
+ * Delete a blocklist. You must specify the blocklist you want to delete by the `region` and `blocklist_id`.
473
441
  *
474
442
  * @param request - The request {@link DeleteBlocklistRequest}
475
443
  */
@@ -478,9 +446,7 @@ class API extends api.API {
478
446
  path: `/transactional-email/v1alpha1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/blocklists/${marshalling.validatePathParam("blocklistId", request.blocklistId)}`
479
447
  });
480
448
  /**
481
- * Get information about subscribed offers. Retrieve information about the
482
- * offers you are subscribed to using the `project_id` and `region`
483
- * parameters.
449
+ * Get information about subscribed offers. Retrieve information about the offers you are subscribed to using the `project_id` and `region` parameters.
484
450
  *
485
451
  * @param request - The request {@link ListOfferSubscriptionsRequest}
486
452
  * @returns A Promise of ListOfferSubscriptionsResponse
@@ -514,8 +480,7 @@ class API extends api.API {
514
480
  marshalling_gen.unmarshalOfferSubscription
515
481
  );
516
482
  /**
517
- * List the available offers.. Retrieve the list of the available and
518
- * free-of-charge offers you can subscribe to.
483
+ * List the available offers.. Retrieve the list of the available and free-of-charge offers you can subscribe to.
519
484
  *
520
485
  * @param request - The request {@link ListOffersRequest}
521
486
  * @returns A Promise of ListOffersResponse
@@ -546,8 +511,7 @@ class API extends api.API {
546
511
  marshalling_gen.unmarshalListPoolsResponse
547
512
  );
548
513
  /**
549
- * Get information about a sending pool.. Retrieve information about a sending
550
- * pool, including its creation status and configuration parameters.
514
+ * Get information about a sending pool.. Retrieve information about a sending pool, including its creation status and configuration parameters.
551
515
  *
552
516
  * @param request - The request {@link ListPoolsRequest}
553
517
  * @returns A Promise of ListPoolsResponse
@@ -3,25 +3,21 @@ import type { Region as ScwRegion, WaitForOptions } from '@scaleway/sdk-client';
3
3
  import type { BulkCreateBlocklistsRequest, BulkCreateBlocklistsResponse, CancelEmailRequest, CheckDomainRequest, CreateDomainRequest, CreateEmailRequest, CreateEmailResponse, CreateWebhookRequest, DeleteBlocklistRequest, DeleteWebhookRequest, Domain, DomainLastStatus, Email, GetDomainLastStatusRequest, GetDomainRequest, GetEmailRequest, GetProjectConsumptionRequest, GetProjectSettingsRequest, GetStatisticsRequest, GetWebhookRequest, ListBlocklistsRequest, ListBlocklistsResponse, ListDomainsRequest, ListDomainsResponse, ListEmailsRequest, ListEmailsResponse, ListOfferSubscriptionsRequest, ListOfferSubscriptionsResponse, ListOffersRequest, ListOffersResponse, ListPoolsRequest, ListPoolsResponse, ListWebhookEventsRequest, ListWebhookEventsResponse, ListWebhooksRequest, ListWebhooksResponse, OfferSubscription, ProjectConsumption, ProjectSettings, RevokeDomainRequest, Statistics, UpdateDomainRequest, UpdateOfferSubscriptionRequest, UpdateProjectSettingsRequest, UpdateWebhookRequest, Webhook } from './types.gen';
4
4
  /**
5
5
  * Transactional Email API.
6
- *
7
- * This API allows you to manage your Transactional Email services.
6
+
7
+ This API allows you to manage your Transactional Email services.
8
8
  */
9
9
  export declare class API extends ParentAPI {
10
10
  /** Lists the available regions of the API. */
11
11
  static readonly LOCALITIES: ScwRegion[];
12
12
  /**
13
- * Send an email. You must specify the `region`, the sender and the
14
- * recipient's information and the `project_id` to send an email from a
15
- * checked domain. The subject of the email must contain at least 6
16
- * characters.
13
+ * Send an email. You must specify the `region`, the sender and the recipient's information and the `project_id` to send an email from a checked domain. The subject of the email must contain at least 6 characters.
17
14
  *
18
15
  * @param request - The request {@link CreateEmailRequest}
19
16
  * @returns A Promise of CreateEmailResponse
20
17
  */
21
18
  createEmail: (request: Readonly<CreateEmailRequest>) => Promise<CreateEmailResponse>;
22
19
  /**
23
- * Get an email. Retrieve information about a specific email using the
24
- * `email_id` and `region` parameters.
20
+ * Get an email. Retrieve information about a specific email using the `email_id` and `region` parameters.
25
21
  *
26
22
  * @param request - The request {@link GetEmailRequest}
27
23
  * @returns A Promise of Email
@@ -37,8 +33,7 @@ export declare class API extends ParentAPI {
37
33
  waitForEmail: (request: Readonly<GetEmailRequest>, options?: Readonly<WaitForOptions<Email>>) => Promise<Email>;
38
34
  protected pageOfListEmails: (request?: Readonly<ListEmailsRequest>) => Promise<ListEmailsResponse>;
39
35
  /**
40
- * List emails. Retrieve the list of emails sent from a specific domain or for
41
- * a specific Project or Organization. You must specify the `region`.
36
+ * List emails. Retrieve the list of emails sent from a specific domain or for a specific Project or Organization. You must specify the `region`.
42
37
  *
43
38
  * @param request - The request {@link ListEmailsRequest}
44
39
  * @returns A Promise of ListEmailsResponse
@@ -55,31 +50,21 @@ export declare class API extends ParentAPI {
55
50
  */
56
51
  getStatistics: (request?: Readonly<GetStatisticsRequest>) => Promise<Statistics>;
57
52
  /**
58
- * Cancel an email. You can cancel the sending of an email if it has not been
59
- * sent yet. You must specify the `region` and the `email_id` of the email you
60
- * want to cancel.
53
+ * Cancel an email. You can cancel the sending of an email if it has not been sent yet. You must specify the `region` and the `email_id` of the email you want to cancel.
61
54
  *
62
55
  * @param request - The request {@link CancelEmailRequest}
63
56
  * @returns A Promise of Email
64
57
  */
65
58
  cancelEmail: (request: Readonly<CancelEmailRequest>) => Promise<Email>;
66
59
  /**
67
- * Register a domain in a project. You must specify the `region`, `project_id`
68
- * and `domain_name` to register a domain in a specific Project.
60
+ * Register a domain in a project. You must specify the `region`, `project_id` and `domain_name` to register a domain in a specific Project.
69
61
  *
70
62
  * @param request - The request {@link CreateDomainRequest}
71
63
  * @returns A Promise of Domain
72
64
  */
73
65
  createDomain: (request: Readonly<CreateDomainRequest>) => Promise<Domain>;
74
66
  /**
75
- * Get information about a domain. Retrieve information about a specific
76
- * domain using the `region` and `domain_id` parameters. Monitor your domain's
77
- * reputation and improve **average** and **bad** reputation statuses, using
78
- * your domain's **Email activity** tab on the [Scaleway
79
- * console](https://console.scaleway.com/transactional-email/domains) to get a
80
- * more detailed report. Check out our [dedicated
81
- * documentation](https://www.scaleway.com/en/docs/managed-services/transactional-email/reference-content/understanding-tem-reputation-score/)
82
- * to improve your domain's reputation.
67
+ * Get information about a domain. Retrieve information about a specific domain using the `region` and `domain_id` parameters. Monitor your domain's reputation and improve **average** and **bad** reputation statuses, using your domain's **Email activity** tab on the [Scaleway console](https://console.scaleway.com/transactional-email/domains) to get a more detailed report. Check out our [dedicated documentation](https://www.scaleway.com/en/docs/managed-services/transactional-email/reference-content/understanding-tem-reputation-score/) to improve your domain's reputation.
83
68
  *
84
69
  * @param request - The request {@link GetDomainRequest}
85
70
  * @returns A Promise of Domain
@@ -95,8 +80,7 @@ export declare class API extends ParentAPI {
95
80
  waitForDomain: (request: Readonly<GetDomainRequest>, options?: Readonly<WaitForOptions<Domain>>) => Promise<Domain>;
96
81
  protected pageOfListDomains: (request?: Readonly<ListDomainsRequest>) => Promise<ListDomainsResponse>;
97
82
  /**
98
- * List domains. Retrieve domains in a specific Project or in a specific
99
- * Organization using the `region` parameter.
83
+ * List domains. Retrieve domains in a specific Project or in a specific Organization using the `region` parameter.
100
84
  *
101
85
  * @param request - The request {@link ListDomainsRequest}
102
86
  * @returns A Promise of ListDomainsResponse
@@ -106,26 +90,21 @@ export declare class API extends ParentAPI {
106
90
  [Symbol.asyncIterator]: () => AsyncGenerator<Domain[], void, void>;
107
91
  };
108
92
  /**
109
- * Delete a domain. You must specify the domain you want to delete by the
110
- * `region` and `domain_id`. Deleting a domain is permanent and cannot be
111
- * undone.
93
+ * Delete a domain. You must specify the domain you want to delete by the `region` and `domain_id`. Deleting a domain is permanent and cannot be undone.
112
94
  *
113
95
  * @param request - The request {@link RevokeDomainRequest}
114
96
  * @returns A Promise of Domain
115
97
  */
116
98
  revokeDomain: (request: Readonly<RevokeDomainRequest>) => Promise<Domain>;
117
99
  /**
118
- * Domain DNS check. Perform an immediate DNS check of a domain using the
119
- * `region` and `domain_id` parameters.
100
+ * Domain DNS check. Perform an immediate DNS check of a domain using the `region` and `domain_id` parameters.
120
101
  *
121
102
  * @param request - The request {@link CheckDomainRequest}
122
103
  * @returns A Promise of Domain
123
104
  */
124
105
  checkDomain: (request: Readonly<CheckDomainRequest>) => Promise<Domain>;
125
106
  /**
126
- * Display SPF and DKIM records status and potential errors. Display SPF and
127
- * DKIM records status and potential errors, including the found records to
128
- * make debugging easier.
107
+ * Display SPF and DKIM records status and potential errors. Display SPF and DKIM records status and potential errors, including the found records to make debugging easier.
129
108
  *
130
109
  * @param request - The request {@link GetDomainLastStatusRequest}
131
110
  * @returns A Promise of DomainLastStatus
@@ -139,8 +118,7 @@ export declare class API extends ParentAPI {
139
118
  */
140
119
  updateDomain: (request: Readonly<UpdateDomainRequest>) => Promise<Domain>;
141
120
  /**
142
- * Create a Webhook. Create a new Webhook triggered by a list of event types
143
- * and pushed to a Scaleway SNS ARN.
121
+ * Create a Webhook. Create a new Webhook triggered by a list of event types and pushed to a Scaleway SNS ARN.
144
122
  *
145
123
  * @param request - The request {@link CreateWebhookRequest}
146
124
  * @returns A Promise of Webhook
@@ -148,8 +126,7 @@ export declare class API extends ParentAPI {
148
126
  createWebhook: (request: Readonly<CreateWebhookRequest>) => Promise<Webhook>;
149
127
  protected pageOfListWebhooks: (request?: Readonly<ListWebhooksRequest>) => Promise<ListWebhooksResponse>;
150
128
  /**
151
- * List Webhooks. Retrieve Webhooks in a specific Project or in a specific
152
- * Organization using the `region` parameter.
129
+ * List Webhooks. Retrieve Webhooks in a specific Project or in a specific Organization using the `region` parameter.
153
130
  *
154
131
  * @param request - The request {@link ListWebhooksRequest}
155
132
  * @returns A Promise of ListWebhooksResponse
@@ -159,8 +136,7 @@ export declare class API extends ParentAPI {
159
136
  [Symbol.asyncIterator]: () => AsyncGenerator<Webhook[], void, void>;
160
137
  };
161
138
  /**
162
- * Get information about a Webhook. Retrieve information about a specific
163
- * Webhook using the `webhook_id` and `region` parameters.
139
+ * Get information about a Webhook. Retrieve information about a specific Webhook using the `webhook_id` and `region` parameters.
164
140
  *
165
141
  * @param request - The request {@link GetWebhookRequest}
166
142
  * @returns A Promise of Webhook
@@ -174,18 +150,14 @@ export declare class API extends ParentAPI {
174
150
  */
175
151
  updateWebhook: (request: Readonly<UpdateWebhookRequest>) => Promise<Webhook>;
176
152
  /**
177
- * Delete a Webhook. You must specify the Webhook you want to delete by the
178
- * `region` and `webhook_id`. Deleting a Webhook is permanent and cannot be
179
- * undone.
153
+ * Delete a Webhook. You must specify the Webhook you want to delete by the `region` and `webhook_id`. Deleting a Webhook is permanent and cannot be undone.
180
154
  *
181
155
  * @param request - The request {@link DeleteWebhookRequest}
182
156
  */
183
157
  deleteWebhook: (request: Readonly<DeleteWebhookRequest>) => Promise<void>;
184
158
  protected pageOfListWebhookEvents: (request: Readonly<ListWebhookEventsRequest>) => Promise<ListWebhookEventsResponse>;
185
159
  /**
186
- * List Webhook triggered events. Retrieve the list of Webhook events
187
- * triggered from a specific Webhook or for a specific Project or
188
- * Organization. You must specify the `region`.
160
+ * List Webhook triggered events. Retrieve the list of Webhook events triggered from a specific Webhook or for a specific Project or Organization. You must specify the `region`.
189
161
  *
190
162
  * @param request - The request {@link ListWebhookEventsRequest}
191
163
  * @returns A Promise of ListWebhookEventsResponse
@@ -195,16 +167,14 @@ export declare class API extends ParentAPI {
195
167
  [Symbol.asyncIterator]: () => AsyncGenerator<import("./types.gen").WebhookEvent[], void, void>;
196
168
  };
197
169
  /**
198
- * List project settings. Retrieve the project settings including periodic
199
- * reports.
170
+ * List project settings. Retrieve the project settings including periodic reports.
200
171
  *
201
172
  * @param request - The request {@link GetProjectSettingsRequest}
202
173
  * @returns A Promise of ProjectSettings
203
174
  */
204
175
  getProjectSettings: (request?: Readonly<GetProjectSettingsRequest>) => Promise<ProjectSettings>;
205
176
  /**
206
- * Update project settings. Update the project settings including periodic
207
- * reports.
177
+ * Update project settings. Update the project settings including periodic reports.
208
178
  *
209
179
  * @param request - The request {@link UpdateProjectSettingsRequest}
210
180
  * @returns A Promise of ProjectSettings
@@ -222,24 +192,20 @@ export declare class API extends ParentAPI {
222
192
  [Symbol.asyncIterator]: () => AsyncGenerator<import("./types.gen").Blocklist[], void, void>;
223
193
  };
224
194
  /**
225
- * Bulk create blocklists. Create multiple blocklists in a specific Project or
226
- * Organization using the `region` parameter.
195
+ * Bulk create blocklists. Create multiple blocklists in a specific Project or Organization using the `region` parameter.
227
196
  *
228
197
  * @param request - The request {@link BulkCreateBlocklistsRequest}
229
198
  * @returns A Promise of BulkCreateBlocklistsResponse
230
199
  */
231
200
  bulkCreateBlocklists: (request: Readonly<BulkCreateBlocklistsRequest>) => Promise<BulkCreateBlocklistsResponse>;
232
201
  /**
233
- * Delete a blocklist. You must specify the blocklist you want to delete by
234
- * the `region` and `blocklist_id`.
202
+ * Delete a blocklist. You must specify the blocklist you want to delete by the `region` and `blocklist_id`.
235
203
  *
236
204
  * @param request - The request {@link DeleteBlocklistRequest}
237
205
  */
238
206
  deleteBlocklist: (request: Readonly<DeleteBlocklistRequest>) => Promise<void>;
239
207
  /**
240
- * Get information about subscribed offers. Retrieve information about the
241
- * offers you are subscribed to using the `project_id` and `region`
242
- * parameters.
208
+ * Get information about subscribed offers. Retrieve information about the offers you are subscribed to using the `project_id` and `region` parameters.
243
209
  *
244
210
  * @param request - The request {@link ListOfferSubscriptionsRequest}
245
211
  * @returns A Promise of ListOfferSubscriptionsResponse
@@ -253,8 +219,7 @@ export declare class API extends ParentAPI {
253
219
  */
254
220
  updateOfferSubscription: (request?: Readonly<UpdateOfferSubscriptionRequest>) => Promise<OfferSubscription>;
255
221
  /**
256
- * List the available offers.. Retrieve the list of the available and
257
- * free-of-charge offers you can subscribe to.
222
+ * List the available offers.. Retrieve the list of the available and free-of-charge offers you can subscribe to.
258
223
  *
259
224
  * @param request - The request {@link ListOffersRequest}
260
225
  * @returns A Promise of ListOffersResponse
@@ -262,8 +227,7 @@ export declare class API extends ParentAPI {
262
227
  listOffers: (request?: Readonly<ListOffersRequest>) => Promise<ListOffersResponse>;
263
228
  protected pageOfListPools: (request?: Readonly<ListPoolsRequest>) => Promise<ListPoolsResponse>;
264
229
  /**
265
- * Get information about a sending pool.. Retrieve information about a sending
266
- * pool, including its creation status and configuration parameters.
230
+ * Get information about a sending pool.. Retrieve information about a sending pool, including its creation status and configuration parameters.
267
231
  *
268
232
  * @param request - The request {@link ListPoolsRequest}
269
233
  * @returns A Promise of ListPoolsResponse