@scaleway/sdk 2.72.0 → 2.74.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 (209) 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/index.gen.d.ts +1 -1
  5. package/dist/api/account/v3/marshalling.gen.cjs +94 -65
  6. package/dist/api/account/v3/marshalling.gen.js +94 -65
  7. package/dist/api/account/v3/types.gen.d.ts +224 -104
  8. package/dist/api/applesilicon/v1alpha1/api.gen.cjs +19 -46
  9. package/dist/api/applesilicon/v1alpha1/api.gen.d.ts +24 -49
  10. package/dist/api/applesilicon/v1alpha1/api.gen.js +19 -46
  11. package/dist/api/applesilicon/v1alpha1/types.gen.d.ts +310 -135
  12. package/dist/api/audit_trail/v1alpha1/api.gen.cjs +2 -5
  13. package/dist/api/audit_trail/v1alpha1/api.gen.d.ts +4 -8
  14. package/dist/api/audit_trail/v1alpha1/api.gen.js +2 -5
  15. package/dist/api/audit_trail/v1alpha1/types.gen.d.ts +110 -82
  16. package/dist/api/baremetal/v1/api.gen.cjs +28 -61
  17. package/dist/api/baremetal/v1/api.gen.d.ts +29 -60
  18. package/dist/api/baremetal/v1/api.gen.js +28 -61
  19. package/dist/api/baremetal/v1/types.gen.d.ts +802 -315
  20. package/dist/api/baremetal/v3/api.gen.cjs +7 -14
  21. package/dist/api/baremetal/v3/api.gen.d.ts +10 -15
  22. package/dist/api/baremetal/v3/api.gen.js +7 -14
  23. package/dist/api/baremetal/v3/types.gen.d.ts +82 -32
  24. package/dist/api/billing/v2beta1/api.gen.cjs +11 -20
  25. package/dist/api/billing/v2beta1/api.gen.d.ts +9 -19
  26. package/dist/api/billing/v2beta1/api.gen.js +11 -20
  27. package/dist/api/billing/v2beta1/types.gen.d.ts +231 -102
  28. package/dist/api/block/v1/api.gen.cjs +37 -55
  29. package/dist/api/block/v1/api.gen.d.ts +19 -37
  30. package/dist/api/block/v1/api.gen.js +37 -55
  31. package/dist/api/block/v1/types.gen.d.ts +306 -125
  32. package/dist/api/block/v1alpha1/api.gen.cjs +45 -64
  33. package/dist/api/block/v1alpha1/api.gen.d.ts +22 -41
  34. package/dist/api/block/v1alpha1/api.gen.js +45 -64
  35. package/dist/api/block/v1alpha1/types.gen.d.ts +327 -132
  36. package/dist/api/cockpit/v1/api.gen.cjs +132 -156
  37. package/dist/api/cockpit/v1/api.gen.d.ts +66 -113
  38. package/dist/api/cockpit/v1/api.gen.js +133 -157
  39. package/dist/api/cockpit/v1/index.gen.d.ts +1 -1
  40. package/dist/api/cockpit/v1/marshalling.gen.cjs +23 -0
  41. package/dist/api/cockpit/v1/marshalling.gen.d.ts +3 -1
  42. package/dist/api/cockpit/v1/marshalling.gen.js +23 -0
  43. package/dist/api/cockpit/v1/types.gen.d.ts +628 -246
  44. package/dist/api/container/v1beta1/api.gen.cjs +7 -14
  45. package/dist/api/container/v1beta1/api.gen.d.ts +9 -16
  46. package/dist/api/container/v1beta1/api.gen.js +7 -14
  47. package/dist/api/container/v1beta1/types.gen.d.ts +648 -322
  48. package/dist/api/dedibox/v1/api.gen.cjs +45 -69
  49. package/dist/api/dedibox/v1/api.gen.d.ts +52 -62
  50. package/dist/api/dedibox/v1/api.gen.js +45 -69
  51. package/dist/api/dedibox/v1/types.gen.d.ts +1765 -645
  52. package/dist/api/domain/v2beta1/api.gen.cjs +119 -178
  53. package/dist/api/domain/v2beta1/api.gen.d.ts +71 -130
  54. package/dist/api/domain/v2beta1/api.gen.js +119 -178
  55. package/dist/api/domain/v2beta1/content.gen.d.ts +1 -4
  56. package/dist/api/domain/v2beta1/types.gen.d.ts +411 -199
  57. package/dist/api/edge_services/v1beta1/api.gen.cjs +41 -22
  58. package/dist/api/edge_services/v1beta1/api.gen.d.ts +3 -2
  59. package/dist/api/edge_services/v1beta1/api.gen.js +41 -22
  60. package/dist/api/edge_services/v1beta1/index.gen.d.ts +1 -1
  61. package/dist/api/edge_services/v1beta1/types.gen.d.ts +7 -0
  62. package/dist/api/file/index.gen.cjs +4 -0
  63. package/dist/api/file/index.gen.d.ts +5 -0
  64. package/dist/api/file/index.gen.js +4 -0
  65. package/dist/api/file/v1alpha1/api.gen.cjs +142 -0
  66. package/dist/api/file/v1alpha1/api.gen.d.ts +73 -0
  67. package/dist/api/file/v1alpha1/api.gen.js +142 -0
  68. package/dist/api/file/v1alpha1/content.gen.cjs +7 -0
  69. package/dist/api/file/v1alpha1/content.gen.d.ts +3 -0
  70. package/dist/api/file/v1alpha1/content.gen.js +7 -0
  71. package/dist/api/file/v1alpha1/index.gen.cjs +8 -0
  72. package/dist/api/file/v1alpha1/index.gen.d.ts +4 -0
  73. package/dist/api/file/v1alpha1/index.gen.js +8 -0
  74. package/dist/api/file/v1alpha1/marshalling.gen.cjs +77 -0
  75. package/dist/api/file/v1alpha1/marshalling.gen.d.ts +7 -0
  76. package/dist/api/file/v1alpha1/marshalling.gen.js +77 -0
  77. package/dist/api/file/v1alpha1/types.gen.d.ts +239 -0
  78. package/dist/api/file/v1alpha1/validation-rules.gen.cjs +40 -0
  79. package/dist/api/file/v1alpha1/validation-rules.gen.d.ts +34 -0
  80. package/dist/api/file/v1alpha1/validation-rules.gen.js +40 -0
  81. package/dist/api/flexibleip/v1alpha1/api.gen.cjs +10 -25
  82. package/dist/api/flexibleip/v1alpha1/api.gen.d.ts +12 -28
  83. package/dist/api/flexibleip/v1alpha1/api.gen.js +10 -25
  84. package/dist/api/flexibleip/v1alpha1/types.gen.d.ts +186 -78
  85. package/dist/api/function/v1beta1/types.gen.d.ts +6 -6
  86. package/dist/api/iam/v1alpha1/api.gen.cjs +4 -4
  87. package/dist/api/iam/v1alpha1/api.gen.d.ts +4 -4
  88. package/dist/api/iam/v1alpha1/api.gen.js +4 -4
  89. package/dist/api/iam/v1alpha1/types.gen.d.ts +1 -1
  90. package/dist/api/index.gen.d.ts +3 -1
  91. package/dist/api/inference/v1/api.gen.cjs +8 -11
  92. package/dist/api/inference/v1/api.gen.d.ts +6 -9
  93. package/dist/api/inference/v1/api.gen.js +8 -11
  94. package/dist/api/inference/v1/types.gen.d.ts +330 -150
  95. package/dist/api/inference/v1beta1/api.gen.cjs +9 -12
  96. package/dist/api/inference/v1beta1/api.gen.d.ts +7 -10
  97. package/dist/api/inference/v1beta1/api.gen.js +9 -12
  98. package/dist/api/inference/v1beta1/types.gen.d.ts +341 -154
  99. package/dist/api/instance/v1/api.gen.cjs +64 -113
  100. package/dist/api/instance/v1/api.gen.d.ts +54 -103
  101. package/dist/api/instance/v1/api.gen.js +64 -113
  102. package/dist/api/instance/v1/marshalling.gen.cjs +4 -1
  103. package/dist/api/instance/v1/marshalling.gen.js +4 -1
  104. package/dist/api/instance/v1/types.gen.d.ts +1368 -600
  105. package/dist/api/instance/v1/types.private.gen.d.ts +131 -59
  106. package/dist/api/interlink/v1beta1/api.gen.cjs +21 -67
  107. package/dist/api/interlink/v1beta1/api.gen.d.ts +23 -70
  108. package/dist/api/interlink/v1beta1/api.gen.js +21 -67
  109. package/dist/api/interlink/v1beta1/marshalling.gen.cjs +2 -0
  110. package/dist/api/interlink/v1beta1/marshalling.gen.js +2 -0
  111. package/dist/api/interlink/v1beta1/types.gen.d.ts +464 -216
  112. package/dist/api/interlink/v1beta1/validation-rules.gen.cjs +8 -0
  113. package/dist/api/interlink/v1beta1/validation-rules.gen.d.ts +8 -0
  114. package/dist/api/interlink/v1beta1/validation-rules.gen.js +8 -0
  115. package/dist/api/iot/v1/api.gen.cjs +37 -70
  116. package/dist/api/iot/v1/api.gen.d.ts +34 -67
  117. package/dist/api/iot/v1/api.gen.js +37 -70
  118. package/dist/api/iot/v1/types.gen.d.ts +566 -321
  119. package/dist/api/ipam/v1/api.gen.cjs +6 -26
  120. package/dist/api/ipam/v1/api.gen.d.ts +8 -29
  121. package/dist/api/ipam/v1/api.gen.js +6 -26
  122. package/dist/api/ipam/v1/types.gen.d.ts +146 -105
  123. package/dist/api/jobs/v1alpha1/api.gen.cjs +2 -4
  124. package/dist/api/jobs/v1alpha1/api.gen.d.ts +4 -6
  125. package/dist/api/jobs/v1alpha1/api.gen.js +2 -4
  126. package/dist/api/jobs/v1alpha1/types.gen.d.ts +165 -91
  127. package/dist/api/k8s/v1/api.gen.cjs +33 -78
  128. package/dist/api/k8s/v1/api.gen.d.ts +27 -72
  129. package/dist/api/k8s/v1/api.gen.js +33 -78
  130. package/dist/api/k8s/v1/types.gen.d.ts +743 -506
  131. package/dist/api/key_manager/v1alpha1/api.gen.cjs +21 -57
  132. package/dist/api/key_manager/v1alpha1/api.gen.d.ts +19 -56
  133. package/dist/api/key_manager/v1alpha1/api.gen.js +21 -57
  134. package/dist/api/key_manager/v1alpha1/types.gen.d.ts +196 -114
  135. package/dist/api/lb/v1/marshalling.gen.cjs +4 -2
  136. package/dist/api/lb/v1/marshalling.gen.js +4 -2
  137. package/dist/api/lb/v1/types.gen.d.ts +4 -0
  138. package/dist/api/marketplace/v2/api.gen.cjs +8 -21
  139. package/dist/api/marketplace/v2/api.gen.d.ts +10 -24
  140. package/dist/api/marketplace/v2/api.gen.js +8 -21
  141. package/dist/api/marketplace/v2/types.gen.d.ts +94 -41
  142. package/dist/api/mnq/v1beta1/api.gen.cjs +24 -76
  143. package/dist/api/mnq/v1beta1/api.gen.d.ts +30 -82
  144. package/dist/api/mnq/v1beta1/api.gen.js +24 -76
  145. package/dist/api/mnq/v1beta1/types.gen.d.ts +342 -169
  146. package/dist/api/mongodb/v1alpha1/api.gen.cjs +19 -62
  147. package/dist/api/mongodb/v1alpha1/api.gen.d.ts +21 -64
  148. package/dist/api/mongodb/v1alpha1/api.gen.js +19 -62
  149. package/dist/api/mongodb/v1alpha1/types.gen.d.ts +443 -189
  150. package/dist/api/product_catalog/index.gen.cjs +4 -0
  151. package/dist/api/product_catalog/index.gen.d.ts +5 -0
  152. package/dist/api/product_catalog/index.gen.js +4 -0
  153. package/dist/api/product_catalog/v2alpha1/api.gen.cjs +36 -0
  154. package/dist/api/product_catalog/v2alpha1/api.gen.d.ts +18 -0
  155. package/dist/api/product_catalog/v2alpha1/api.gen.js +36 -0
  156. package/dist/api/product_catalog/v2alpha1/index.gen.cjs +6 -0
  157. package/dist/api/product_catalog/v2alpha1/index.gen.d.ts +3 -0
  158. package/dist/api/product_catalog/v2alpha1/index.gen.js +6 -0
  159. package/dist/api/product_catalog/v2alpha1/marshalling.gen.cjs +230 -0
  160. package/dist/api/product_catalog/v2alpha1/marshalling.gen.d.ts +2 -0
  161. package/dist/api/product_catalog/v2alpha1/marshalling.gen.js +230 -0
  162. package/dist/api/product_catalog/v2alpha1/types.gen.d.ts +293 -0
  163. package/dist/api/product_catalog/v2alpha1/validation-rules.gen.cjs +11 -0
  164. package/dist/api/product_catalog/v2alpha1/validation-rules.gen.d.ts +8 -0
  165. package/dist/api/product_catalog/v2alpha1/validation-rules.gen.js +11 -0
  166. package/dist/api/qaas/v1alpha1/api.gen.cjs +17 -34
  167. package/dist/api/qaas/v1alpha1/api.gen.d.ts +19 -36
  168. package/dist/api/qaas/v1alpha1/api.gen.js +17 -34
  169. package/dist/api/qaas/v1alpha1/types.gen.d.ts +502 -174
  170. package/dist/api/rdb/v1/api.gen.cjs +62 -202
  171. package/dist/api/rdb/v1/api.gen.d.ts +60 -201
  172. package/dist/api/rdb/v1/api.gen.js +62 -202
  173. package/dist/api/rdb/v1/types.gen.d.ts +1005 -524
  174. package/dist/api/redis/v1/api.gen.cjs +23 -83
  175. package/dist/api/redis/v1/api.gen.d.ts +25 -85
  176. package/dist/api/redis/v1/api.gen.js +23 -83
  177. package/dist/api/redis/v1/types.gen.d.ts +447 -170
  178. package/dist/api/registry/v1/api.gen.cjs +12 -40
  179. package/dist/api/registry/v1/api.gen.d.ts +14 -42
  180. package/dist/api/registry/v1/api.gen.js +12 -40
  181. package/dist/api/registry/v1/types.gen.d.ts +200 -116
  182. package/dist/api/secret/v1beta1/api.gen.cjs +19 -47
  183. package/dist/api/secret/v1beta1/api.gen.d.ts +21 -51
  184. package/dist/api/secret/v1beta1/api.gen.js +19 -47
  185. package/dist/api/secret/v1beta1/types.gen.d.ts +359 -224
  186. package/dist/api/serverless_sqldb/v1alpha1/api.gen.cjs +9 -27
  187. package/dist/api/serverless_sqldb/v1alpha1/api.gen.d.ts +11 -29
  188. package/dist/api/serverless_sqldb/v1alpha1/api.gen.js +9 -27
  189. package/dist/api/serverless_sqldb/v1alpha1/types.gen.d.ts +168 -76
  190. package/dist/api/tem/v1alpha1/api.gen.cjs +22 -58
  191. package/dist/api/tem/v1alpha1/api.gen.d.ts +24 -60
  192. package/dist/api/tem/v1alpha1/api.gen.js +22 -58
  193. package/dist/api/tem/v1alpha1/types.gen.d.ts +761 -338
  194. package/dist/api/test/v1/api.gen.cjs +8 -11
  195. package/dist/api/test/v1/api.gen.d.ts +6 -9
  196. package/dist/api/test/v1/api.gen.js +8 -11
  197. package/dist/api/test/v1/types.gen.d.ts +21 -10
  198. package/dist/api/vpcgw/v1/api.gen.cjs +37 -0
  199. package/dist/api/vpcgw/v1/api.gen.d.ts +37 -0
  200. package/dist/api/vpcgw/v1/api.gen.js +37 -0
  201. package/dist/client/dist/package.json.cjs +1 -1
  202. package/dist/client/dist/package.json.js +1 -1
  203. package/dist/index.cjs +36 -32
  204. package/dist/index.js +36 -32
  205. package/node_modules/@scaleway/sdk-client/dist/package.json.cjs +1 -1
  206. package/node_modules/@scaleway/sdk-client/dist/package.json.js +1 -1
  207. package/node_modules/@scaleway/sdk-client/package.json +1 -2
  208. package/package.json +2 -2
  209. package/node_modules/@scaleway/sdk-client/LICENSE +0 -191
@@ -15,9 +15,7 @@ class API extends api.API {
15
15
  /** Lists the available zones of the API. */
16
16
  static LOCALITIES = ["fr-par-3"];
17
17
  /**
18
- * List server types. List all technical details about Apple silicon server
19
- * types available in the specified zone. Since there is only one Availability
20
- * Zone for Apple silicon servers, the targeted value is `fr-par-3`.
18
+ * List server types. List all technical details about Apple silicon server types available in the specified zone. Since there is only one Availability Zone for Apple silicon servers, the targeted value is `fr-par-3`.
21
19
  *
22
20
  * @param request - The request {@link ListServerTypesRequest}
23
21
  * @returns A Promise of ListServerTypesResponse
@@ -30,8 +28,7 @@ class API extends api.API {
30
28
  marshalling_gen.unmarshalListServerTypesResponse
31
29
  );
32
30
  /**
33
- * Get a server type. Get technical details (CPU, disk size etc.) of a server
34
- * type.
31
+ * Get a server type. Get technical details (CPU, disk size etc.) of a server type.
35
32
  *
36
33
  * @param request - The request {@link GetServerTypeRequest}
37
34
  * @returns A Promise of ServerType
@@ -44,8 +41,7 @@ class API extends api.API {
44
41
  marshalling_gen.unmarshalServerType
45
42
  );
46
43
  /**
47
- * Create a server. Create a new server in the targeted zone, specifying its
48
- * configuration including name and type.
44
+ * Create a server. Create a new server in the targeted zone, specifying its configuration including name and type.
49
45
  *
50
46
  * @param request - The request {@link CreateServerRequest}
51
47
  * @returns A Promise of Server
@@ -79,9 +75,7 @@ class API extends api.API {
79
75
  marshalling_gen.unmarshalListServersResponse
80
76
  );
81
77
  /**
82
- * List all servers. List all servers in the specified zone. By default,
83
- * returned servers in the list are ordered by creation date in ascending
84
- * order, though this can be modified via the `order_by` field.
78
+ * List all servers. List all servers in the specified zone. By default, returned servers in the list are ordered by creation date in ascending order, though this can be modified via the `order_by` field.
85
79
  *
86
80
  * @param request - The request {@link ListServersRequest}
87
81
  * @returns A Promise of ListServersResponse
@@ -104,17 +98,14 @@ class API extends api.API {
104
98
  marshalling_gen.unmarshalListOSResponse
105
99
  );
106
100
  /**
107
- * List all Operating Systems (OS). List all Operating Systems (OS). The
108
- * response will include the total number of OS as well as their associated
109
- * IDs, names and labels.
101
+ * List all Operating Systems (OS). List all Operating Systems (OS). The response will include the total number of OS as well as their associated IDs, names and labels.
110
102
  *
111
103
  * @param request - The request {@link ListOSRequest}
112
104
  * @returns A Promise of ListOSResponse
113
105
  */
114
106
  listOS = (request = {}) => resourcePaginator.enrichForPagination("os", this.pageOfListOS, request);
115
107
  /**
116
- * Get an Operating System (OS). Get an Operating System (OS). The response
117
- * will include the OS's unique ID as well as its name and label.
108
+ * Get an Operating System (OS). Get an Operating System (OS). The response will include the OS's unique ID as well as its name and label.
118
109
  *
119
110
  * @param request - The request {@link GetOSRequest}
120
111
  * @returns A Promise of OS
@@ -127,9 +118,7 @@ class API extends api.API {
127
118
  marshalling_gen.unmarshalOS
128
119
  );
129
120
  /**
130
- * Get a server. Retrieve information about an existing Apple silicon server,
131
- * specified by its server ID. Its full details, including name, status and IP
132
- * address, are returned in the response object.
121
+ * Get a server. Retrieve information about an existing Apple silicon server, specified by its server ID. Its full details, including name, status and IP address, are returned in the response object.
133
122
  *
134
123
  * @param request - The request {@link GetServerRequest}
135
124
  * @returns A Promise of Server
@@ -157,8 +146,7 @@ class API extends api.API {
157
146
  options
158
147
  );
159
148
  /**
160
- * Update a server. Update the parameters of an existing Apple silicon server,
161
- * specified by its server ID.
149
+ * Update a server. Update the parameters of an existing Apple silicon server, specified by its server ID.
162
150
  *
163
151
  * @param request - The request {@link UpdateServerRequest}
164
152
  * @returns A Promise of Server
@@ -175,10 +163,7 @@ class API extends api.API {
175
163
  marshalling_gen.unmarshalServer
176
164
  );
177
165
  /**
178
- * Delete a server. Delete an existing Apple silicon server, specified by its
179
- * server ID. Deleting a server is permanent, and cannot be undone. Note that
180
- * the minimum allocation period for Apple silicon-as-a-service is 24 hours,
181
- * meaning you cannot delete your server prior to that.
166
+ * Delete a server. Delete an existing Apple silicon server, specified by its server ID. Deleting a server is permanent, and cannot be undone. Note that the minimum allocation period for Apple silicon-as-a-service is 24 hours, meaning you cannot delete your server prior to that.
182
167
  *
183
168
  * @param request - The request {@link DeleteServerRequest}
184
169
  */
@@ -187,8 +172,7 @@ class API extends api.API {
187
172
  path: `/apple-silicon/v1alpha1/zones/${marshalling.validatePathParam("zone", request.zone ?? this.client.settings.defaultZone)}/servers/${marshalling.validatePathParam("serverId", request.serverId)}`
188
173
  });
189
174
  /**
190
- * Reboot a server. Reboot an existing Apple silicon server, specified by its
191
- * server ID.
175
+ * Reboot a server. Reboot an existing Apple silicon server, specified by its server ID.
192
176
  *
193
177
  * @param request - The request {@link RebootServerRequest}
194
178
  * @returns A Promise of Server
@@ -203,10 +187,7 @@ class API extends api.API {
203
187
  marshalling_gen.unmarshalServer
204
188
  );
205
189
  /**
206
- * Reinstall a server. Reinstall an existing Apple silicon server (specified
207
- * by its server ID) from a new image (OS). All the data on the disk is
208
- * deleted and all configuration is reset to the defailt configuration values
209
- * of the image (OS).
190
+ * Reinstall a server. Reinstall an existing Apple silicon server (specified by its server ID) from a new image (OS). All the data on the disk is deleted and all configuration is reset to the defailt configuration values of the image (OS).
210
191
  *
211
192
  * @param request - The request {@link ReinstallServerRequest}
212
193
  * @returns A Promise of Server
@@ -257,8 +238,7 @@ class PrivateNetworkAPI extends api.API {
257
238
  /**
258
239
  * Waits for {@link ServerPrivateNetwork} to be in a final state.
259
240
  *
260
- * @param request - The request
261
- * {@link PrivateNetworkApiGetServerPrivateNetworkRequest}
241
+ * @param request - The request {@link PrivateNetworkApiGetServerPrivateNetworkRequest}
262
242
  * @param options - The waiting options
263
243
  * @returns A Promise of ServerPrivateNetwork
264
244
  */
@@ -273,11 +253,9 @@ class PrivateNetworkAPI extends api.API {
273
253
  options
274
254
  );
275
255
  /**
276
- * Add a server to a Private Network. Add an Apple silicon server to a Private
277
- * Network.
256
+ * Add a server to a Private Network. Add an Apple silicon server to a Private Network.
278
257
  *
279
- * @param request - The request
280
- * {@link PrivateNetworkApiAddServerPrivateNetworkRequest}
258
+ * @param request - The request {@link PrivateNetworkApiAddServerPrivateNetworkRequest}
281
259
  * @returns A Promise of ServerPrivateNetwork
282
260
  */
283
261
  addServerPrivateNetwork = (request) => this.client.fetch(
@@ -295,11 +273,9 @@ class PrivateNetworkAPI extends api.API {
295
273
  marshalling_gen.unmarshalServerPrivateNetwork
296
274
  );
297
275
  /**
298
- * Set multiple Private Networks on a server. Configure multiple Private
299
- * Networks on an Apple silicon server.
276
+ * Set multiple Private Networks on a server. Configure multiple Private Networks on an Apple silicon server.
300
277
  *
301
- * @param request - The request
302
- * {@link PrivateNetworkApiSetServerPrivateNetworksRequest}
278
+ * @param request - The request {@link PrivateNetworkApiSetServerPrivateNetworksRequest}
303
279
  * @returns A Promise of SetServerPrivateNetworksResponse
304
280
  */
305
281
  setServerPrivateNetworks = (request) => this.client.fetch(
@@ -337,11 +313,9 @@ class PrivateNetworkAPI extends api.API {
337
313
  marshalling_gen.unmarshalListServerPrivateNetworksResponse
338
314
  );
339
315
  /**
340
- * List the Private Networks of a server. List the Private Networks of an
341
- * Apple silicon server.
316
+ * List the Private Networks of a server. List the Private Networks of an Apple silicon server.
342
317
  *
343
- * @param request - The request
344
- * {@link PrivateNetworkApiListServerPrivateNetworksRequest}
318
+ * @param request - The request {@link PrivateNetworkApiListServerPrivateNetworksRequest}
345
319
  * @returns A Promise of ListServerPrivateNetworksResponse
346
320
  */
347
321
  listServerPrivateNetworks = (request = {}) => resourcePaginator.enrichForPagination(
@@ -352,8 +326,7 @@ class PrivateNetworkAPI extends api.API {
352
326
  /**
353
327
  * Delete a Private Network.
354
328
  *
355
- * @param request - The request
356
- * {@link PrivateNetworkApiDeleteServerPrivateNetworkRequest}
329
+ * @param request - The request {@link PrivateNetworkApiDeleteServerPrivateNetworkRequest}
357
330
  */
358
331
  deleteServerPrivateNetwork = (request) => this.client.fetch({
359
332
  method: "DELETE",
@@ -3,32 +3,28 @@ import type { Zone as ScwZone, WaitForOptions } from '@scaleway/sdk-client';
3
3
  import type { ConnectivityDiagnostic, CreateServerRequest, DeleteServerRequest, GetConnectivityDiagnosticRequest, GetOSRequest, GetServerRequest, GetServerTypeRequest, ListOSRequest, ListOSResponse, ListServerPrivateNetworksResponse, ListServerTypesRequest, ListServerTypesResponse, ListServersRequest, ListServersResponse, OS, PrivateNetworkApiAddServerPrivateNetworkRequest, PrivateNetworkApiDeleteServerPrivateNetworkRequest, PrivateNetworkApiGetServerPrivateNetworkRequest, PrivateNetworkApiListServerPrivateNetworksRequest, PrivateNetworkApiSetServerPrivateNetworksRequest, RebootServerRequest, ReinstallServerRequest, Server, ServerPrivateNetwork, ServerType, SetServerPrivateNetworksResponse, StartConnectivityDiagnosticRequest, StartConnectivityDiagnosticResponse, UpdateServerRequest } from './types.gen';
4
4
  /**
5
5
  * Apple silicon API.
6
- *
7
- * This API allows you to manage your Apple silicon machines.
6
+
7
+ This API allows you to manage your Apple silicon machines.
8
8
  */
9
9
  export declare class API extends ParentAPI {
10
10
  /** Lists the available zones of the API. */
11
11
  static readonly LOCALITIES: ScwZone[];
12
12
  /**
13
- * List server types. List all technical details about Apple silicon server
14
- * types available in the specified zone. Since there is only one Availability
15
- * Zone for Apple silicon servers, the targeted value is `fr-par-3`.
13
+ * List server types. List all technical details about Apple silicon server types available in the specified zone. Since there is only one Availability Zone for Apple silicon servers, the targeted value is `fr-par-3`.
16
14
  *
17
15
  * @param request - The request {@link ListServerTypesRequest}
18
16
  * @returns A Promise of ListServerTypesResponse
19
17
  */
20
18
  listServerTypes: (request?: Readonly<ListServerTypesRequest>) => Promise<ListServerTypesResponse>;
21
19
  /**
22
- * Get a server type. Get technical details (CPU, disk size etc.) of a server
23
- * type.
20
+ * Get a server type. Get technical details (CPU, disk size etc.) of a server type.
24
21
  *
25
22
  * @param request - The request {@link GetServerTypeRequest}
26
23
  * @returns A Promise of ServerType
27
24
  */
28
25
  getServerType: (request: Readonly<GetServerTypeRequest>) => Promise<ServerType>;
29
26
  /**
30
- * Create a server. Create a new server in the targeted zone, specifying its
31
- * configuration including name and type.
27
+ * Create a server. Create a new server in the targeted zone, specifying its configuration including name and type.
32
28
  *
33
29
  * @param request - The request {@link CreateServerRequest}
34
30
  * @returns A Promise of Server
@@ -36,9 +32,7 @@ export declare class API extends ParentAPI {
36
32
  createServer: (request: Readonly<CreateServerRequest>) => Promise<Server>;
37
33
  protected pageOfListServers: (request?: Readonly<ListServersRequest>) => Promise<ListServersResponse>;
38
34
  /**
39
- * List all servers. List all servers in the specified zone. By default,
40
- * returned servers in the list are ordered by creation date in ascending
41
- * order, though this can be modified via the `order_by` field.
35
+ * List all servers. List all servers in the specified zone. By default, returned servers in the list are ordered by creation date in ascending order, though this can be modified via the `order_by` field.
42
36
  *
43
37
  * @param request - The request {@link ListServersRequest}
44
38
  * @returns A Promise of ListServersResponse
@@ -49,9 +43,7 @@ export declare class API extends ParentAPI {
49
43
  };
50
44
  protected pageOfListOS: (request?: Readonly<ListOSRequest>) => Promise<ListOSResponse>;
51
45
  /**
52
- * List all Operating Systems (OS). List all Operating Systems (OS). The
53
- * response will include the total number of OS as well as their associated
54
- * IDs, names and labels.
46
+ * List all Operating Systems (OS). List all Operating Systems (OS). The response will include the total number of OS as well as their associated IDs, names and labels.
55
47
  *
56
48
  * @param request - The request {@link ListOSRequest}
57
49
  * @returns A Promise of ListOSResponse
@@ -61,17 +53,14 @@ export declare class API extends ParentAPI {
61
53
  [Symbol.asyncIterator]: () => AsyncGenerator<OS[], void, void>;
62
54
  };
63
55
  /**
64
- * Get an Operating System (OS). Get an Operating System (OS). The response
65
- * will include the OS's unique ID as well as its name and label.
56
+ * Get an Operating System (OS). Get an Operating System (OS). The response will include the OS's unique ID as well as its name and label.
66
57
  *
67
58
  * @param request - The request {@link GetOSRequest}
68
59
  * @returns A Promise of OS
69
60
  */
70
61
  getOS: (request: Readonly<GetOSRequest>) => Promise<OS>;
71
62
  /**
72
- * Get a server. Retrieve information about an existing Apple silicon server,
73
- * specified by its server ID. Its full details, including name, status and IP
74
- * address, are returned in the response object.
63
+ * Get a server. Retrieve information about an existing Apple silicon server, specified by its server ID. Its full details, including name, status and IP address, are returned in the response object.
75
64
  *
76
65
  * @param request - The request {@link GetServerRequest}
77
66
  * @returns A Promise of Server
@@ -86,35 +75,27 @@ export declare class API extends ParentAPI {
86
75
  */
87
76
  waitForServer: (request: Readonly<GetServerRequest>, options?: Readonly<WaitForOptions<Server>>) => Promise<Server>;
88
77
  /**
89
- * Update a server. Update the parameters of an existing Apple silicon server,
90
- * specified by its server ID.
78
+ * Update a server. Update the parameters of an existing Apple silicon server, specified by its server ID.
91
79
  *
92
80
  * @param request - The request {@link UpdateServerRequest}
93
81
  * @returns A Promise of Server
94
82
  */
95
83
  updateServer: (request: Readonly<UpdateServerRequest>) => Promise<Server>;
96
84
  /**
97
- * Delete a server. Delete an existing Apple silicon server, specified by its
98
- * server ID. Deleting a server is permanent, and cannot be undone. Note that
99
- * the minimum allocation period for Apple silicon-as-a-service is 24 hours,
100
- * meaning you cannot delete your server prior to that.
85
+ * Delete a server. Delete an existing Apple silicon server, specified by its server ID. Deleting a server is permanent, and cannot be undone. Note that the minimum allocation period for Apple silicon-as-a-service is 24 hours, meaning you cannot delete your server prior to that.
101
86
  *
102
87
  * @param request - The request {@link DeleteServerRequest}
103
88
  */
104
89
  deleteServer: (request: Readonly<DeleteServerRequest>) => Promise<void>;
105
90
  /**
106
- * Reboot a server. Reboot an existing Apple silicon server, specified by its
107
- * server ID.
91
+ * Reboot a server. Reboot an existing Apple silicon server, specified by its server ID.
108
92
  *
109
93
  * @param request - The request {@link RebootServerRequest}
110
94
  * @returns A Promise of Server
111
95
  */
112
96
  rebootServer: (request: Readonly<RebootServerRequest>) => Promise<Server>;
113
97
  /**
114
- * Reinstall a server. Reinstall an existing Apple silicon server (specified
115
- * by its server ID) from a new image (OS). All the data on the disk is
116
- * deleted and all configuration is reset to the defailt configuration values
117
- * of the image (OS).
98
+ * Reinstall a server. Reinstall an existing Apple silicon server (specified by its server ID) from a new image (OS). All the data on the disk is deleted and all configuration is reset to the defailt configuration values of the image (OS).
118
99
  *
119
100
  * @param request - The request {@link ReinstallServerRequest}
120
101
  * @returns A Promise of Server
@@ -123,7 +104,9 @@ export declare class API extends ParentAPI {
123
104
  startConnectivityDiagnostic: (request: Readonly<StartConnectivityDiagnosticRequest>) => Promise<StartConnectivityDiagnosticResponse>;
124
105
  getConnectivityDiagnostic: (request: Readonly<GetConnectivityDiagnosticRequest>) => Promise<ConnectivityDiagnostic>;
125
106
  }
126
- /** Apple silicon - Private Networks API. */
107
+ /**
108
+ * Apple silicon - Private Networks API.
109
+ */
127
110
  export declare class PrivateNetworkAPI extends ParentAPI {
128
111
  /** Lists the available zones of the API. */
129
112
  static readonly LOCALITIES: ScwZone[];
@@ -131,37 +114,30 @@ export declare class PrivateNetworkAPI extends ParentAPI {
131
114
  /**
132
115
  * Waits for {@link ServerPrivateNetwork} to be in a final state.
133
116
  *
134
- * @param request - The request
135
- * {@link PrivateNetworkApiGetServerPrivateNetworkRequest}
117
+ * @param request - The request {@link PrivateNetworkApiGetServerPrivateNetworkRequest}
136
118
  * @param options - The waiting options
137
119
  * @returns A Promise of ServerPrivateNetwork
138
120
  */
139
121
  waitForServerPrivateNetwork: (request: Readonly<PrivateNetworkApiGetServerPrivateNetworkRequest>, options?: Readonly<WaitForOptions<ServerPrivateNetwork>>) => Promise<ServerPrivateNetwork>;
140
122
  /**
141
- * Add a server to a Private Network. Add an Apple silicon server to a Private
142
- * Network.
123
+ * Add a server to a Private Network. Add an Apple silicon server to a Private Network.
143
124
  *
144
- * @param request - The request
145
- * {@link PrivateNetworkApiAddServerPrivateNetworkRequest}
125
+ * @param request - The request {@link PrivateNetworkApiAddServerPrivateNetworkRequest}
146
126
  * @returns A Promise of ServerPrivateNetwork
147
127
  */
148
128
  addServerPrivateNetwork: (request: Readonly<PrivateNetworkApiAddServerPrivateNetworkRequest>) => Promise<ServerPrivateNetwork>;
149
129
  /**
150
- * Set multiple Private Networks on a server. Configure multiple Private
151
- * Networks on an Apple silicon server.
130
+ * Set multiple Private Networks on a server. Configure multiple Private Networks on an Apple silicon server.
152
131
  *
153
- * @param request - The request
154
- * {@link PrivateNetworkApiSetServerPrivateNetworksRequest}
132
+ * @param request - The request {@link PrivateNetworkApiSetServerPrivateNetworksRequest}
155
133
  * @returns A Promise of SetServerPrivateNetworksResponse
156
134
  */
157
135
  setServerPrivateNetworks: (request: Readonly<PrivateNetworkApiSetServerPrivateNetworksRequest>) => Promise<SetServerPrivateNetworksResponse>;
158
136
  protected pageOfListServerPrivateNetworks: (request?: Readonly<PrivateNetworkApiListServerPrivateNetworksRequest>) => Promise<ListServerPrivateNetworksResponse>;
159
137
  /**
160
- * List the Private Networks of a server. List the Private Networks of an
161
- * Apple silicon server.
138
+ * List the Private Networks of a server. List the Private Networks of an Apple silicon server.
162
139
  *
163
- * @param request - The request
164
- * {@link PrivateNetworkApiListServerPrivateNetworksRequest}
140
+ * @param request - The request {@link PrivateNetworkApiListServerPrivateNetworksRequest}
165
141
  * @returns A Promise of ListServerPrivateNetworksResponse
166
142
  */
167
143
  listServerPrivateNetworks: (request?: Readonly<PrivateNetworkApiListServerPrivateNetworksRequest>) => Promise<ListServerPrivateNetworksResponse> & {
@@ -171,8 +147,7 @@ export declare class PrivateNetworkAPI extends ParentAPI {
171
147
  /**
172
148
  * Delete a Private Network.
173
149
  *
174
- * @param request - The request
175
- * {@link PrivateNetworkApiDeleteServerPrivateNetworkRequest}
150
+ * @param request - The request {@link PrivateNetworkApiDeleteServerPrivateNetworkRequest}
176
151
  */
177
152
  deleteServerPrivateNetwork: (request: Readonly<PrivateNetworkApiDeleteServerPrivateNetworkRequest>) => Promise<void>;
178
153
  }
@@ -13,9 +13,7 @@ class API extends API$1 {
13
13
  /** Lists the available zones of the API. */
14
14
  static LOCALITIES = ["fr-par-3"];
15
15
  /**
16
- * List server types. List all technical details about Apple silicon server
17
- * types available in the specified zone. Since there is only one Availability
18
- * Zone for Apple silicon servers, the targeted value is `fr-par-3`.
16
+ * List server types. List all technical details about Apple silicon server types available in the specified zone. Since there is only one Availability Zone for Apple silicon servers, the targeted value is `fr-par-3`.
19
17
  *
20
18
  * @param request - The request {@link ListServerTypesRequest}
21
19
  * @returns A Promise of ListServerTypesResponse
@@ -28,8 +26,7 @@ class API extends API$1 {
28
26
  unmarshalListServerTypesResponse
29
27
  );
30
28
  /**
31
- * Get a server type. Get technical details (CPU, disk size etc.) of a server
32
- * type.
29
+ * Get a server type. Get technical details (CPU, disk size etc.) of a server type.
33
30
  *
34
31
  * @param request - The request {@link GetServerTypeRequest}
35
32
  * @returns A Promise of ServerType
@@ -42,8 +39,7 @@ class API extends API$1 {
42
39
  unmarshalServerType
43
40
  );
44
41
  /**
45
- * Create a server. Create a new server in the targeted zone, specifying its
46
- * configuration including name and type.
42
+ * Create a server. Create a new server in the targeted zone, specifying its configuration including name and type.
47
43
  *
48
44
  * @param request - The request {@link CreateServerRequest}
49
45
  * @returns A Promise of Server
@@ -77,9 +73,7 @@ class API extends API$1 {
77
73
  unmarshalListServersResponse
78
74
  );
79
75
  /**
80
- * List all servers. List all servers in the specified zone. By default,
81
- * returned servers in the list are ordered by creation date in ascending
82
- * order, though this can be modified via the `order_by` field.
76
+ * List all servers. List all servers in the specified zone. By default, returned servers in the list are ordered by creation date in ascending order, though this can be modified via the `order_by` field.
83
77
  *
84
78
  * @param request - The request {@link ListServersRequest}
85
79
  * @returns A Promise of ListServersResponse
@@ -102,17 +96,14 @@ class API extends API$1 {
102
96
  unmarshalListOSResponse
103
97
  );
104
98
  /**
105
- * List all Operating Systems (OS). List all Operating Systems (OS). The
106
- * response will include the total number of OS as well as their associated
107
- * IDs, names and labels.
99
+ * List all Operating Systems (OS). List all Operating Systems (OS). The response will include the total number of OS as well as their associated IDs, names and labels.
108
100
  *
109
101
  * @param request - The request {@link ListOSRequest}
110
102
  * @returns A Promise of ListOSResponse
111
103
  */
112
104
  listOS = (request = {}) => enrichForPagination("os", this.pageOfListOS, request);
113
105
  /**
114
- * Get an Operating System (OS). Get an Operating System (OS). The response
115
- * will include the OS's unique ID as well as its name and label.
106
+ * Get an Operating System (OS). Get an Operating System (OS). The response will include the OS's unique ID as well as its name and label.
116
107
  *
117
108
  * @param request - The request {@link GetOSRequest}
118
109
  * @returns A Promise of OS
@@ -125,9 +116,7 @@ class API extends API$1 {
125
116
  unmarshalOS
126
117
  );
127
118
  /**
128
- * Get a server. Retrieve information about an existing Apple silicon server,
129
- * specified by its server ID. Its full details, including name, status and IP
130
- * address, are returned in the response object.
119
+ * Get a server. Retrieve information about an existing Apple silicon server, specified by its server ID. Its full details, including name, status and IP address, are returned in the response object.
131
120
  *
132
121
  * @param request - The request {@link GetServerRequest}
133
122
  * @returns A Promise of Server
@@ -155,8 +144,7 @@ class API extends API$1 {
155
144
  options
156
145
  );
157
146
  /**
158
- * Update a server. Update the parameters of an existing Apple silicon server,
159
- * specified by its server ID.
147
+ * Update a server. Update the parameters of an existing Apple silicon server, specified by its server ID.
160
148
  *
161
149
  * @param request - The request {@link UpdateServerRequest}
162
150
  * @returns A Promise of Server
@@ -173,10 +161,7 @@ class API extends API$1 {
173
161
  unmarshalServer
174
162
  );
175
163
  /**
176
- * Delete a server. Delete an existing Apple silicon server, specified by its
177
- * server ID. Deleting a server is permanent, and cannot be undone. Note that
178
- * the minimum allocation period for Apple silicon-as-a-service is 24 hours,
179
- * meaning you cannot delete your server prior to that.
164
+ * Delete a server. Delete an existing Apple silicon server, specified by its server ID. Deleting a server is permanent, and cannot be undone. Note that the minimum allocation period for Apple silicon-as-a-service is 24 hours, meaning you cannot delete your server prior to that.
180
165
  *
181
166
  * @param request - The request {@link DeleteServerRequest}
182
167
  */
@@ -185,8 +170,7 @@ class API extends API$1 {
185
170
  path: `/apple-silicon/v1alpha1/zones/${validatePathParam("zone", request.zone ?? this.client.settings.defaultZone)}/servers/${validatePathParam("serverId", request.serverId)}`
186
171
  });
187
172
  /**
188
- * Reboot a server. Reboot an existing Apple silicon server, specified by its
189
- * server ID.
173
+ * Reboot a server. Reboot an existing Apple silicon server, specified by its server ID.
190
174
  *
191
175
  * @param request - The request {@link RebootServerRequest}
192
176
  * @returns A Promise of Server
@@ -201,10 +185,7 @@ class API extends API$1 {
201
185
  unmarshalServer
202
186
  );
203
187
  /**
204
- * Reinstall a server. Reinstall an existing Apple silicon server (specified
205
- * by its server ID) from a new image (OS). All the data on the disk is
206
- * deleted and all configuration is reset to the defailt configuration values
207
- * of the image (OS).
188
+ * Reinstall a server. Reinstall an existing Apple silicon server (specified by its server ID) from a new image (OS). All the data on the disk is deleted and all configuration is reset to the defailt configuration values of the image (OS).
208
189
  *
209
190
  * @param request - The request {@link ReinstallServerRequest}
210
191
  * @returns A Promise of Server
@@ -255,8 +236,7 @@ class PrivateNetworkAPI extends API$1 {
255
236
  /**
256
237
  * Waits for {@link ServerPrivateNetwork} to be in a final state.
257
238
  *
258
- * @param request - The request
259
- * {@link PrivateNetworkApiGetServerPrivateNetworkRequest}
239
+ * @param request - The request {@link PrivateNetworkApiGetServerPrivateNetworkRequest}
260
240
  * @param options - The waiting options
261
241
  * @returns A Promise of ServerPrivateNetwork
262
242
  */
@@ -271,11 +251,9 @@ class PrivateNetworkAPI extends API$1 {
271
251
  options
272
252
  );
273
253
  /**
274
- * Add a server to a Private Network. Add an Apple silicon server to a Private
275
- * Network.
254
+ * Add a server to a Private Network. Add an Apple silicon server to a Private Network.
276
255
  *
277
- * @param request - The request
278
- * {@link PrivateNetworkApiAddServerPrivateNetworkRequest}
256
+ * @param request - The request {@link PrivateNetworkApiAddServerPrivateNetworkRequest}
279
257
  * @returns A Promise of ServerPrivateNetwork
280
258
  */
281
259
  addServerPrivateNetwork = (request) => this.client.fetch(
@@ -293,11 +271,9 @@ class PrivateNetworkAPI extends API$1 {
293
271
  unmarshalServerPrivateNetwork
294
272
  );
295
273
  /**
296
- * Set multiple Private Networks on a server. Configure multiple Private
297
- * Networks on an Apple silicon server.
274
+ * Set multiple Private Networks on a server. Configure multiple Private Networks on an Apple silicon server.
298
275
  *
299
- * @param request - The request
300
- * {@link PrivateNetworkApiSetServerPrivateNetworksRequest}
276
+ * @param request - The request {@link PrivateNetworkApiSetServerPrivateNetworksRequest}
301
277
  * @returns A Promise of SetServerPrivateNetworksResponse
302
278
  */
303
279
  setServerPrivateNetworks = (request) => this.client.fetch(
@@ -335,11 +311,9 @@ class PrivateNetworkAPI extends API$1 {
335
311
  unmarshalListServerPrivateNetworksResponse
336
312
  );
337
313
  /**
338
- * List the Private Networks of a server. List the Private Networks of an
339
- * Apple silicon server.
314
+ * List the Private Networks of a server. List the Private Networks of an Apple silicon server.
340
315
  *
341
- * @param request - The request
342
- * {@link PrivateNetworkApiListServerPrivateNetworksRequest}
316
+ * @param request - The request {@link PrivateNetworkApiListServerPrivateNetworksRequest}
343
317
  * @returns A Promise of ListServerPrivateNetworksResponse
344
318
  */
345
319
  listServerPrivateNetworks = (request = {}) => enrichForPagination(
@@ -350,8 +324,7 @@ class PrivateNetworkAPI extends API$1 {
350
324
  /**
351
325
  * Delete a Private Network.
352
326
  *
353
- * @param request - The request
354
- * {@link PrivateNetworkApiDeleteServerPrivateNetworkRequest}
327
+ * @param request - The request {@link PrivateNetworkApiDeleteServerPrivateNetworkRequest}
355
328
  */
356
329
  deleteServerPrivateNetwork = (request) => this.client.fetch({
357
330
  method: "DELETE",