@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
@@ -3,14 +3,13 @@ import type { WaitForOptions } from '@scaleway/sdk-client';
3
3
  import type { CheckContactsCompatibilityResponse, ClearDNSZoneRecordsRequest, ClearDNSZoneRecordsResponse, CloneDNSZoneRequest, Contact, CreateDNSZoneRequest, CreateSSLCertificateRequest, DNSZone, DeleteDNSZoneRequest, DeleteDNSZoneResponse, DeleteDNSZoneTsigKeyRequest, DeleteExternalDomainResponse, DeleteSSLCertificateRequest, DeleteSSLCertificateResponse, Domain, ExportRawDNSZoneRequest, GetDNSZoneTsigKeyRequest, GetDNSZoneTsigKeyResponse, GetDNSZoneVersionDiffRequest, GetDNSZoneVersionDiffResponse, GetDomainAuthCodeResponse, GetSSLCertificateRequest, Host, ImportProviderDNSZoneRequest, ImportProviderDNSZoneResponse, ImportRawDNSZoneRequest, ImportRawDNSZoneResponse, ListContactsResponse, ListDNSZoneNameserversRequest, ListDNSZoneNameserversResponse, ListDNSZoneRecordsRequest, ListDNSZoneRecordsResponse, ListDNSZoneVersionRecordsRequest, ListDNSZoneVersionRecordsResponse, ListDNSZoneVersionsRequest, ListDNSZoneVersionsResponse, ListDNSZonesRequest, ListDNSZonesResponse, ListDomainHostsResponse, ListDomainsResponse, ListRenewableDomainsResponse, ListSSLCertificatesRequest, ListSSLCertificatesResponse, ListTasksResponse, ListTldsResponse, OrderResponse, RefreshDNSZoneRequest, RefreshDNSZoneResponse, RegisterExternalDomainResponse, RegistrarApiBuyDomainsRequest, RegistrarApiCheckContactsCompatibilityRequest, RegistrarApiCreateDomainHostRequest, RegistrarApiDeleteDomainHostRequest, RegistrarApiDeleteExternalDomainRequest, RegistrarApiDisableDomainAutoRenewRequest, RegistrarApiDisableDomainDNSSECRequest, RegistrarApiEnableDomainAutoRenewRequest, RegistrarApiEnableDomainDNSSECRequest, RegistrarApiGetContactRequest, RegistrarApiGetDomainAuthCodeRequest, RegistrarApiGetDomainRequest, RegistrarApiListContactsRequest, RegistrarApiListDomainHostsRequest, RegistrarApiListDomainsRequest, RegistrarApiListRenewableDomainsRequest, RegistrarApiListTasksRequest, RegistrarApiListTldsRequest, RegistrarApiLockDomainTransferRequest, RegistrarApiRegisterExternalDomainRequest, RegistrarApiRenewDomainsRequest, RegistrarApiSearchAvailableDomainsRequest, RegistrarApiTradeDomainRequest, RegistrarApiTransferInDomainRequest, RegistrarApiUnlockDomainTransferRequest, RegistrarApiUpdateContactRequest, RegistrarApiUpdateDomainHostRequest, RegistrarApiUpdateDomainRequest, RestoreDNSZoneVersionRequest, RestoreDNSZoneVersionResponse, SSLCertificate, SearchAvailableDomainsResponse, UpdateDNSZoneNameserversRequest, UpdateDNSZoneNameserversResponse, UpdateDNSZoneRecordsRequest, UpdateDNSZoneRecordsResponse, UpdateDNSZoneRequest } from './types.gen';
4
4
  /**
5
5
  * Domains and DNS API.
6
- *
7
- * This API allows you to manage your domains, DNS zones and records.
6
+
7
+ This API allows you to manage your domains, DNS zones and records.
8
8
  */
9
9
  export declare class API extends ParentAPI {
10
10
  protected pageOfListDNSZones: (request: Readonly<ListDNSZonesRequest>) => Promise<ListDNSZonesResponse>;
11
11
  /**
12
- * List DNS zones. Retrieve the list of DNS zones you can manage and filter
13
- * DNS zones associated with specific domain names.
12
+ * List DNS zones. Retrieve the list of DNS zones you can manage and filter DNS zones associated with specific domain names.
14
13
  *
15
14
  * @param request - The request {@link ListDNSZonesRequest}
16
15
  * @returns A Promise of ListDNSZonesResponse
@@ -20,8 +19,7 @@ export declare class API extends ParentAPI {
20
19
  [Symbol.asyncIterator]: () => AsyncGenerator<DNSZone[], void, void>;
21
20
  };
22
21
  /**
23
- * Create a DNS zone. Create a new DNS zone specified by the domain name, the
24
- * subdomain and the Project ID.
22
+ * Create a DNS zone. Create a new DNS zone specified by the domain name, the subdomain and the Project ID.
25
23
  *
26
24
  * @param request - The request {@link CreateDNSZoneRequest}
27
25
  * @returns A Promise of DNSZone
@@ -35,8 +33,7 @@ export declare class API extends ParentAPI {
35
33
  */
36
34
  updateDNSZone: (request: Readonly<UpdateDNSZoneRequest>) => Promise<DNSZone>;
37
35
  /**
38
- * Clone a DNS zone. Clone an existing DNS zone with all its records into a
39
- * new DNS zone.
36
+ * Clone a DNS zone. Clone an existing DNS zone with all its records into a new DNS zone.
40
37
  *
41
38
  * @param request - The request {@link CloneDNSZoneRequest}
42
39
  * @returns A Promise of DNSZone
@@ -51,9 +48,8 @@ export declare class API extends ParentAPI {
51
48
  deleteDNSZone: (request: Readonly<DeleteDNSZoneRequest>) => Promise<DeleteDNSZoneResponse>;
52
49
  protected pageOfListDNSZoneRecords: (request: Readonly<ListDNSZoneRecordsRequest>) => Promise<ListDNSZoneRecordsResponse>;
53
50
  /**
54
- * List records within a DNS zone. Retrieve a list of DNS records within a DNS
55
- * zone that has default name servers. You can filter records by type and
56
- * name.
51
+ * List records within a DNS zone. Retrieve a list of DNS records within a DNS zone that has default name servers.
52
+ You can filter records by type and name.
57
53
  *
58
54
  * @param request - The request {@link ListDNSZoneRecordsRequest}
59
55
  * @returns A Promise of ListDNSZoneRecordsResponse
@@ -63,77 +59,66 @@ export declare class API extends ParentAPI {
63
59
  [Symbol.asyncIterator]: () => AsyncGenerator<import("./types.gen").DomainRecord[], void, void>;
64
60
  };
65
61
  /**
66
- * Update records within a DNS zone. Update records within a DNS zone that has
67
- * default name servers and perform several actions on your records.
68
- *
69
- * Actions include:
70
- *
71
- * - Add: allows you to add a new record or add a new IP to an existing A
72
- * record, for example
73
- * - Set: allows you to edit a record or edit an IP from an existing A record,
74
- * for example
75
- * - Delete: allows you to delete a record or delete an IP from an existing A
76
- * record, for example
77
- * - Clear: allows you to delete all records from a DNS zone
78
- *
79
- * All edits will be versioned.
62
+ * Update records within a DNS zone. Update records within a DNS zone that has default name servers and perform several actions on your records.
63
+
64
+ Actions include:
65
+ - add: allows you to add a new record or add a new IP to an existing A record, for example
66
+ - set: allows you to edit a record or edit an IP from an existing A record, for example
67
+ - delete: allows you to delete a record or delete an IP from an existing A record, for example
68
+ - clear: allows you to delete all records from a DNS zone
69
+
70
+ All edits will be versioned.
80
71
  *
81
72
  * @param request - The request {@link UpdateDNSZoneRecordsRequest}
82
73
  * @returns A Promise of UpdateDNSZoneRecordsResponse
83
74
  */
84
75
  updateDNSZoneRecords: (request: Readonly<UpdateDNSZoneRecordsRequest>) => Promise<UpdateDNSZoneRecordsResponse>;
85
76
  /**
86
- * List name servers within a DNS zone. Retrieve a list of name servers within
87
- * a DNS zone and their optional glue records.
77
+ * List name servers within a DNS zone. Retrieve a list of name servers within a DNS zone and their optional glue records.
88
78
  *
89
79
  * @param request - The request {@link ListDNSZoneNameserversRequest}
90
80
  * @returns A Promise of ListDNSZoneNameserversResponse
91
81
  */
92
82
  listDNSZoneNameservers: (request: Readonly<ListDNSZoneNameserversRequest>) => Promise<ListDNSZoneNameserversResponse>;
93
83
  /**
94
- * Update name servers within a DNS zone. Update name servers within a DNS
95
- * zone and set optional glue records.
84
+ * Update name servers within a DNS zone. Update name servers within a DNS zone and set optional glue records.
96
85
  *
97
86
  * @param request - The request {@link UpdateDNSZoneNameserversRequest}
98
87
  * @returns A Promise of UpdateDNSZoneNameserversResponse
99
88
  */
100
89
  updateDNSZoneNameservers: (request: Readonly<UpdateDNSZoneNameserversRequest>) => Promise<UpdateDNSZoneNameserversResponse>;
101
90
  /**
102
- * Clear records within a DNS zone. Delete all records within a DNS zone that
103
- * has default name servers.<br/> All edits will be versioned.
91
+ * Clear records within a DNS zone. Delete all records within a DNS zone that has default name servers.<br/>
92
+ All edits will be versioned.
104
93
  *
105
94
  * @param request - The request {@link ClearDNSZoneRecordsRequest}
106
95
  * @returns A Promise of ClearDNSZoneRecordsResponse
107
96
  */
108
97
  clearDNSZoneRecords: (request: Readonly<ClearDNSZoneRecordsRequest>) => Promise<ClearDNSZoneRecordsResponse>;
109
98
  /**
110
- * Export a raw DNS zone. Export a DNS zone with default name servers, in a
111
- * specific format.
99
+ * Export a raw DNS zone. Export a DNS zone with default name servers, in a specific format.
112
100
  *
113
101
  * @param request - The request {@link ExportRawDNSZoneRequest}
114
102
  * @returns A Promise of Blob
115
103
  */
116
104
  exportRawDNSZone: (request: Readonly<ExportRawDNSZoneRequest>) => Promise<Blob>;
117
105
  /**
118
- * Import a raw DNS zone. Import and replace the format of records from a
119
- * given provider, with default name servers.
106
+ * Import a raw DNS zone. Import and replace the format of records from a given provider, with default name servers.
120
107
  *
121
108
  * @param request - The request {@link ImportRawDNSZoneRequest}
122
109
  * @returns A Promise of ImportRawDNSZoneResponse
123
110
  */
124
111
  importRawDNSZone: (request: Readonly<ImportRawDNSZoneRequest>) => Promise<ImportRawDNSZoneResponse>;
125
112
  /**
126
- * Import a DNS zone from another provider. Import and replace the format of
127
- * records from a given provider, with default name servers.
113
+ * Import a DNS zone from another provider. Import and replace the format of records from a given provider, with default name servers.
128
114
  *
129
115
  * @param request - The request {@link ImportProviderDNSZoneRequest}
130
116
  * @returns A Promise of ImportProviderDNSZoneResponse
131
117
  */
132
118
  importProviderDNSZone: (request: Readonly<ImportProviderDNSZoneRequest>) => Promise<ImportProviderDNSZoneResponse>;
133
119
  /**
134
- * Refresh a DNS zone. Refresh an SOA DNS zone to reload the records in the
135
- * DNS zone and update the SOA serial. You can recreate the given DNS zone and
136
- * its sub DNS zone if needed.
120
+ * Refresh a DNS zone. Refresh an SOA DNS zone to reload the records in the DNS zone and update the SOA serial.
121
+ You can recreate the given DNS zone and its sub DNS zone if needed.
137
122
  *
138
123
  * @param request - The request {@link RefreshDNSZoneRequest}
139
124
  * @returns A Promise of RefreshDNSZoneResponse
@@ -142,8 +127,7 @@ export declare class API extends ParentAPI {
142
127
  protected pageOfListDNSZoneVersions: (request: Readonly<ListDNSZoneVersionsRequest>) => Promise<ListDNSZoneVersionsResponse>;
143
128
  /**
144
129
  * List versions of a DNS zone. Retrieve a list of a DNS zone's versions.<br/>
145
- * The maximum version count is 100. If the count reaches this limit, the
146
- * oldest version will be deleted after each new modification.
130
+ The maximum version count is 100. If the count reaches this limit, the oldest version will be deleted after each new modification.
147
131
  *
148
132
  * @param request - The request {@link ListDNSZoneVersionsRequest}
149
133
  * @returns A Promise of ListDNSZoneVersionsResponse
@@ -154,8 +138,7 @@ export declare class API extends ParentAPI {
154
138
  };
155
139
  protected pageOfListDNSZoneVersionRecords: (request: Readonly<ListDNSZoneVersionRecordsRequest>) => Promise<ListDNSZoneVersionRecordsResponse>;
156
140
  /**
157
- * List records from a given version of a specific DNS zone. Retrieve a list
158
- * of records from a specific DNS zone version.
141
+ * List records from a given version of a specific DNS zone. Retrieve a list of records from a specific DNS zone version.
159
142
  *
160
143
  * @param request - The request {@link ListDNSZoneVersionRecordsRequest}
161
144
  * @returns A Promise of ListDNSZoneVersionRecordsResponse
@@ -165,24 +148,21 @@ export declare class API extends ParentAPI {
165
148
  [Symbol.asyncIterator]: () => AsyncGenerator<import("./types.gen").DomainRecord[], void, void>;
166
149
  };
167
150
  /**
168
- * Access differences from a specific DNS zone version. Access a previous DNS
169
- * zone version to see the differences from another specific version.
151
+ * Access differences from a specific DNS zone version. Access a previous DNS zone version to see the differences from another specific version.
170
152
  *
171
153
  * @param request - The request {@link GetDNSZoneVersionDiffRequest}
172
154
  * @returns A Promise of GetDNSZoneVersionDiffResponse
173
155
  */
174
156
  getDNSZoneVersionDiff: (request: Readonly<GetDNSZoneVersionDiffRequest>) => Promise<GetDNSZoneVersionDiffResponse>;
175
157
  /**
176
- * Restore a DNS zone version. Restore and activate a version of a specific
177
- * DNS zone.
158
+ * Restore a DNS zone version. Restore and activate a version of a specific DNS zone.
178
159
  *
179
160
  * @param request - The request {@link RestoreDNSZoneVersionRequest}
180
161
  * @returns A Promise of RestoreDNSZoneVersionResponse
181
162
  */
182
163
  restoreDNSZoneVersion: (request: Readonly<RestoreDNSZoneVersionRequest>) => Promise<RestoreDNSZoneVersionResponse>;
183
164
  /**
184
- * Get a DNS zone's TLS certificate. Get the DNS zone's TLS certificate. If
185
- * you do not have a certificate, the ouptut returns `no certificate found`.
165
+ * 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`.
186
166
  *
187
167
  * @param request - The request {@link GetSSLCertificateRequest}
188
168
  * @returns A Promise of SSLCertificate
@@ -197,8 +177,7 @@ export declare class API extends ParentAPI {
197
177
  */
198
178
  waitForSSLCertificate: (request: Readonly<GetSSLCertificateRequest>, options?: Readonly<WaitForOptions<SSLCertificate>>) => Promise<SSLCertificate>;
199
179
  /**
200
- * Create or get the DNS zone's TLS certificate. Create a new TLS certificate
201
- * or retrieve information about an existing TLS certificate.
180
+ * Create or get the DNS zone's TLS certificate. Create a new TLS certificate or retrieve information about an existing TLS certificate.
202
181
  *
203
182
  * @param request - The request {@link CreateSSLCertificateRequest}
204
183
  * @returns A Promise of SSLCertificate
@@ -206,8 +185,7 @@ export declare class API extends ParentAPI {
206
185
  createSSLCertificate: (request: Readonly<CreateSSLCertificateRequest>) => Promise<SSLCertificate>;
207
186
  protected pageOfListSSLCertificates: (request: Readonly<ListSSLCertificatesRequest>) => Promise<ListSSLCertificatesResponse>;
208
187
  /**
209
- * List a user's TLS certificates. List all the TLS certificates a user has
210
- * created, specified by the user's Project ID and the DNS zone.
188
+ * 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.
211
189
  *
212
190
  * @param request - The request {@link ListSSLCertificatesRequest}
213
191
  * @returns A Promise of ListSSLCertificatesResponse
@@ -217,25 +195,21 @@ export declare class API extends ParentAPI {
217
195
  [Symbol.asyncIterator]: () => AsyncGenerator<SSLCertificate[], void, void>;
218
196
  };
219
197
  /**
220
- * Delete a TLS certificate. Delete an existing TLS certificate specified by
221
- * its DNS zone. Deleting a TLS certificate is permanent and cannot be
222
- * undone.
198
+ * Delete a TLS certificate. Delete an existing TLS certificate specified by its DNS zone. Deleting a TLS certificate is permanent and cannot be undone.
223
199
  *
224
200
  * @param request - The request {@link DeleteSSLCertificateRequest}
225
201
  * @returns A Promise of DeleteSSLCertificateResponse
226
202
  */
227
203
  deleteSSLCertificate: (request: Readonly<DeleteSSLCertificateRequest>) => Promise<DeleteSSLCertificateResponse>;
228
204
  /**
229
- * Get the DNS zone's TSIG key. Retrieve information about the TSIG key of a
230
- * given DNS zone to allow AXFR requests.
205
+ * Get the DNS zone's TSIG key. Retrieve information about the TSIG key of a given DNS zone to allow AXFR requests.
231
206
  *
232
207
  * @param request - The request {@link GetDNSZoneTsigKeyRequest}
233
208
  * @returns A Promise of GetDNSZoneTsigKeyResponse
234
209
  */
235
210
  getDNSZoneTsigKey: (request: Readonly<GetDNSZoneTsigKeyRequest>) => Promise<GetDNSZoneTsigKeyResponse>;
236
211
  /**
237
- * Delete the DNS zone's TSIG key. Delete an existing TSIG key specified by
238
- * its DNS zone. Deleting a TSIG key is permanent and cannot be undone.
212
+ * 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.
239
213
  *
240
214
  * @param request - The request {@link DeleteDNSZoneTsigKeyRequest}
241
215
  */
@@ -243,14 +217,14 @@ export declare class API extends ParentAPI {
243
217
  }
244
218
  /**
245
219
  * Domains and DNS - Registrar API.
246
- *
247
- * Manage your domains and contacts.
220
+
221
+ Manage your domains and contacts.
248
222
  */
249
223
  export declare class RegistrarAPI extends ParentAPI {
250
224
  protected pageOfListTasks: (request?: Readonly<RegistrarApiListTasksRequest>) => Promise<ListTasksResponse>;
251
225
  /**
252
- * List tasks. List all operations performed on the account. You can filter
253
- * the list of tasks by domain name.
226
+ * List tasks. List all operations performed on the account.
227
+ You can filter the list of tasks by domain name.
254
228
  *
255
229
  * @param request - The request {@link RegistrarApiListTasksRequest}
256
230
  * @returns A Promise of ListTasksResponse
@@ -260,8 +234,8 @@ export declare class RegistrarAPI extends ParentAPI {
260
234
  [Symbol.asyncIterator]: () => AsyncGenerator<import("./types.gen").Task[], void, void>;
261
235
  };
262
236
  /**
263
- * Purchase domains. Request the registration of domain names. You can provide
264
- * a domain's already existing contact or a new contact.
237
+ * Purchase domains. Request the registration of domain names.
238
+ You can provide a domain's already existing contact or a new contact.
265
239
  *
266
240
  * @param request - The request {@link RegistrarApiBuyDomainsRequest}
267
241
  * @returns A Promise of OrderResponse
@@ -275,8 +249,7 @@ export declare class RegistrarAPI extends ParentAPI {
275
249
  */
276
250
  renewDomains: (request: Readonly<RegistrarApiRenewDomainsRequest>) => Promise<OrderResponse>;
277
251
  /**
278
- * Transfer a domain. Request the transfer of a domain from another registrar
279
- * to Scaleway Domains and DNS.
252
+ * Transfer a domain. Request the transfer of a domain from another registrar to Scaleway Domains and DNS.
280
253
  *
281
254
  * @param request - The request {@link RegistrarApiTransferInDomainRequest}
282
255
  * @returns A Promise of OrderResponse
@@ -284,24 +257,18 @@ export declare class RegistrarAPI extends ParentAPI {
284
257
  transferInDomain: (request: Readonly<RegistrarApiTransferInDomainRequest>) => Promise<OrderResponse>;
285
258
  /**
286
259
  * Trade a domain's contact. Request to change a domain's contact owner.<br/>
287
- * If you specify the `organization_id` of the domain's new owner, the contact
288
- * will change from the current owner's Scaleway account to the new owner's
289
- * Scaleway account.<br/> If the new owner's current contact information is
290
- * not available, the first ever contact they have created for previous
291
- * domains is taken into account to operate the change.<br/> If the new owner
292
- * has never created a contact to register domains before, an error message
293
- * displays.
260
+ 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/>
261
+ 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/>
262
+ If the new owner has never created a contact to register domains before, an error message displays.
294
263
  *
295
264
  * @param request - The request {@link RegistrarApiTradeDomainRequest}
296
265
  * @returns A Promise of OrderResponse
297
266
  */
298
267
  tradeDomain: (request: Readonly<RegistrarApiTradeDomainRequest>) => Promise<OrderResponse>;
299
268
  /**
300
- * Register an external domain. Request the registration of an external domain
301
- * name.
269
+ * Register an external domain. Request the registration of an external domain name.
302
270
  *
303
- * @param request - The request
304
- * {@link RegistrarApiRegisterExternalDomainRequest}
271
+ * @param request - The request {@link RegistrarApiRegisterExternalDomainRequest}
305
272
  * @returns A Promise of RegisterExternalDomainResponse
306
273
  */
307
274
  registerExternalDomain: (request: Readonly<RegistrarApiRegisterExternalDomainRequest>) => Promise<RegisterExternalDomainResponse>;
@@ -313,20 +280,17 @@ export declare class RegistrarAPI extends ParentAPI {
313
280
  */
314
281
  deleteExternalDomain: (request: Readonly<RegistrarApiDeleteExternalDomainRequest>) => Promise<DeleteExternalDomainResponse>;
315
282
  /**
316
- * Check if contacts are compatible with a domain or a TLD. Check whether
317
- * contacts are compatible with a domain or a TLD. If contacts are not
318
- * compatible with either the domain or the TLD, the information that needs to
319
- * be corrected is returned.
283
+ * Check if contacts are compatible with a domain or a TLD. Check whether contacts are compatible with a domain or a TLD.
284
+ If contacts are not compatible with either the domain or the TLD, the information that needs to be corrected is returned.
320
285
  *
321
- * @param request - The request
322
- * {@link RegistrarApiCheckContactsCompatibilityRequest}
286
+ * @param request - The request {@link RegistrarApiCheckContactsCompatibilityRequest}
323
287
  * @returns A Promise of CheckContactsCompatibilityResponse
324
288
  */
325
289
  checkContactsCompatibility: (request?: Readonly<RegistrarApiCheckContactsCompatibilityRequest>) => Promise<CheckContactsCompatibilityResponse>;
326
290
  protected pageOfListContacts: (request?: Readonly<RegistrarApiListContactsRequest>) => Promise<ListContactsResponse>;
327
291
  /**
328
- * List contacts. Retrieve the list of contacts and their associated domains
329
- * and roles. You can filter the list by domain name.
292
+ * List contacts. Retrieve the list of contacts and their associated domains and roles.
293
+ You can filter the list by domain name.
330
294
  *
331
295
  * @param request - The request {@link RegistrarApiListContactsRequest}
332
296
  * @returns A Promise of ListContactsResponse
@@ -336,8 +300,7 @@ export declare class RegistrarAPI extends ParentAPI {
336
300
  [Symbol.asyncIterator]: () => AsyncGenerator<import("./types.gen").ContactRoles[], void, void>;
337
301
  };
338
302
  /**
339
- * Get a contact. Retrieve a contact's details from the registrar using the
340
- * given contact's ID.
303
+ * Get a contact. Retrieve a contact's details from the registrar using the given contact's ID.
341
304
  *
342
305
  * @param request - The request {@link RegistrarApiGetContactRequest}
343
306
  * @returns A Promise of Contact
@@ -363,9 +326,7 @@ export declare class RegistrarAPI extends ParentAPI {
363
326
  };
364
327
  protected pageOfListRenewableDomains: (request?: Readonly<RegistrarApiListRenewableDomainsRequest>) => Promise<ListRenewableDomainsResponse>;
365
328
  /**
366
- * List domains that can be renewed. Retrieve the list of domains you own that
367
- * can be renewed. You can also see the maximum renewal duration in years for
368
- * your domains that are renewable.
329
+ * 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.
369
330
  *
370
331
  * @param request - The request {@link RegistrarApiListRenewableDomainsRequest}
371
332
  * @returns A Promise of ListRenewableDomainsResponse
@@ -375,8 +336,7 @@ export declare class RegistrarAPI extends ParentAPI {
375
336
  [Symbol.asyncIterator]: () => AsyncGenerator<import("./types.gen").RenewableDomain[], void, void>;
376
337
  };
377
338
  /**
378
- * Get domain. Retrieve a specific domain and display the domain's
379
- * information.
339
+ * Get domain. Retrieve a specific domain and display the domain's information.
380
340
  *
381
341
  * @param request - The request {@link RegistrarApiGetDomainRequest}
382
342
  * @returns A Promise of Domain
@@ -391,66 +351,51 @@ export declare class RegistrarAPI extends ParentAPI {
391
351
  */
392
352
  waitForDomain: (request: Readonly<RegistrarApiGetDomainRequest>, options?: Readonly<WaitForOptions<Domain>>) => Promise<Domain>;
393
353
  /**
394
- * Update a domain's contacts. Update contacts for a specific domain or create
395
- * a new contact.<br/> If you add the same contact for multiple roles (owner,
396
- * administrative, technical), only one ID will be created and used for all of
397
- * the roles.
354
+ * Update a domain's contacts. Update contacts for a specific domain or create a new contact.<br/>
355
+ 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.
398
356
  *
399
357
  * @param request - The request {@link RegistrarApiUpdateDomainRequest}
400
358
  * @returns A Promise of Domain
401
359
  */
402
360
  updateDomain: (request: Readonly<RegistrarApiUpdateDomainRequest>) => Promise<Domain>;
403
361
  /**
404
- * Lock the transfer of a domain. Lock the transfer of a domain. This means
405
- * that the domain cannot be transferred and the authorization code cannot be
406
- * requested to your current registrar.
362
+ * 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.
407
363
  *
408
364
  * @param request - The request {@link RegistrarApiLockDomainTransferRequest}
409
365
  * @returns A Promise of Domain
410
366
  */
411
367
  lockDomainTransfer: (request: Readonly<RegistrarApiLockDomainTransferRequest>) => Promise<Domain>;
412
368
  /**
413
- * Unlock the transfer of a domain. Unlock the transfer of a domain. This
414
- * means that the domain can be transferred and the authorization code can be
415
- * requested to your current registrar.
369
+ * 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.
416
370
  *
417
371
  * @param request - The request {@link RegistrarApiUnlockDomainTransferRequest}
418
372
  * @returns A Promise of Domain
419
373
  */
420
374
  unlockDomainTransfer: (request: Readonly<RegistrarApiUnlockDomainTransferRequest>) => Promise<Domain>;
421
375
  /**
422
- * Enable auto renew. Enable the `auto renew` feature for a domain. This means
423
- * the domain will be automatically renewed before its expiry date.
376
+ * Enable auto renew. Enable the `auto renew` feature for a domain. This means the domain will be automatically renewed before its expiry date.
424
377
  *
425
- * @param request - The request
426
- * {@link RegistrarApiEnableDomainAutoRenewRequest}
378
+ * @param request - The request {@link RegistrarApiEnableDomainAutoRenewRequest}
427
379
  * @returns A Promise of Domain
428
380
  */
429
381
  enableDomainAutoRenew: (request: Readonly<RegistrarApiEnableDomainAutoRenewRequest>) => Promise<Domain>;
430
382
  /**
431
- * Disable auto renew. Disable the `auto renew` feature for a domain. This
432
- * means the domain will not be renewed before its expiry date.
383
+ * Disable auto renew. Disable the `auto renew` feature for a domain. This means the domain will not be renewed before its expiry date.
433
384
  *
434
- * @param request - The request
435
- * {@link RegistrarApiDisableDomainAutoRenewRequest}
385
+ * @param request - The request {@link RegistrarApiDisableDomainAutoRenewRequest}
436
386
  * @returns A Promise of Domain
437
387
  */
438
388
  disableDomainAutoRenew: (request: Readonly<RegistrarApiDisableDomainAutoRenewRequest>) => Promise<Domain>;
439
389
  /**
440
- * Get a domain's authorization code. Retrieve the authorization code to
441
- * tranfer an unlocked domain. The output returns an error if the domain is
442
- * locked. Some TLDs may have a different procedure to retrieve the
443
- * authorization code. In that case, the information displays in the message
444
- * field.
390
+ * 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.
391
+ Some TLDs may have a different procedure to retrieve the authorization code. In that case, the information displays in the message field.
445
392
  *
446
393
  * @param request - The request {@link RegistrarApiGetDomainAuthCodeRequest}
447
394
  * @returns A Promise of GetDomainAuthCodeResponse
448
395
  */
449
396
  getDomainAuthCode: (request: Readonly<RegistrarApiGetDomainAuthCodeRequest>) => Promise<GetDomainAuthCodeResponse>;
450
397
  /**
451
- * Update domain DNSSEC. If your domain uses another registrar and has the
452
- * default Scaleway NS, you have to **update the DS record at your
453
- * registrar**.
398
+ * 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**.
454
399
  *
455
400
  * @param request - The request {@link RegistrarApiEnableDomainDNSSECRequest}
456
401
  * @returns A Promise of Domain
@@ -464,14 +409,11 @@ export declare class RegistrarAPI extends ParentAPI {
464
409
  */
465
410
  disableDomainDNSSEC: (request: Readonly<RegistrarApiDisableDomainDNSSECRequest>) => Promise<Domain>;
466
411
  /**
467
- * Search available domains. Search a domain or a maximum of 10 domains that
468
- * are available.
469
- *
470
- * If the TLD list is empty or not set, the search returns the results from
471
- * the most popular TLDs.
412
+ * Search available domains. Search a domain or a maximum of 10 domains that are available.
413
+
414
+ If the TLD list is empty or not set, the search returns the results from the most popular TLDs.
472
415
  *
473
- * @param request - The request
474
- * {@link RegistrarApiSearchAvailableDomainsRequest}
416
+ * @param request - The request {@link RegistrarApiSearchAvailableDomainsRequest}
475
417
  * @returns A Promise of SearchAvailableDomainsResponse
476
418
  */
477
419
  searchAvailableDomains: (request: Readonly<RegistrarApiSearchAvailableDomainsRequest>) => Promise<SearchAvailableDomainsResponse>;
@@ -487,8 +429,7 @@ export declare class RegistrarAPI extends ParentAPI {
487
429
  [Symbol.asyncIterator]: () => AsyncGenerator<import("./types.gen").Tld[], void, void>;
488
430
  };
489
431
  /**
490
- * Create a hostname for a domain. Create a hostname for a domain with glue
491
- * IPs.
432
+ * Create a hostname for a domain. Create a hostname for a domain with glue IPs.
492
433
  *
493
434
  * @param request - The request {@link RegistrarApiCreateDomainHostRequest}
494
435
  * @returns A Promise of Host