@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
@@ -39,8 +39,7 @@ class API extends api.API {
39
39
  marshalling_gen.unmarshalListVolumeTypesResponse
40
40
  );
41
41
  /**
42
- * List volume types. List all available volume types in a specified zone. The
43
- * volume types listed are ordered by name in ascending order.
42
+ * List volume types. List all available volume types in a specified zone. The volume types listed are ordered by name in ascending order.
44
43
  *
45
44
  * @param request - The request {@link ListVolumeTypesRequest}
46
45
  * @returns A Promise of ListVolumeTypesResponse
@@ -67,25 +66,19 @@ class API extends api.API {
67
66
  marshalling_gen.unmarshalListVolumesResponse
68
67
  );
69
68
  /**
70
- * List volumes. List all existing volumes in a specified zone. By default,
71
- * the volumes listed are ordered by creation date in ascending order. This
72
- * can be modified via the `order_by` field.
69
+ * List volumes. List all existing volumes in a specified zone. By default, the volumes listed are ordered by creation date in ascending order. This can be modified via the `order_by` field.
73
70
  *
74
71
  * @param request - The request {@link ListVolumesRequest}
75
72
  * @returns A Promise of ListVolumesResponse
76
73
  */
77
74
  listVolumes = (request = {}) => resourcePaginator.enrichForPagination("volumes", this.pageOfListVolumes, request);
78
75
  /**
79
- * Create a volume. To create a new volume from scratch, you must specify
80
- * `from_empty` and the `size`. To create a volume from an existing snapshot,
81
- * specify `from_snapshot` and the `snapshot_id` in the request payload
82
- * instead, size is optional and can be specified if you need to extend the
83
- * original size. The volume will take on the same volume class and underlying
84
- * IOPS limitations as the original snapshot.
85
- *
86
- * @param request - The request {@link CreateVolumeRequest}
87
- * @returns A Promise of Volume
88
- */
76
+ * Create a volume. To create a new volume from scratch, you must specify `from_empty` and the `size`.
77
+ To create a volume from an existing snapshot, specify `from_snapshot` and the `snapshot_id` in the request payload instead, size is optional and can be specified if you need to extend the original size. The volume will take on the same volume class and underlying IOPS limitations as the original snapshot.
78
+ *
79
+ * @param request - The request {@link CreateVolumeRequest}
80
+ * @returns A Promise of Volume
81
+ */
89
82
  createVolume = (request = {}) => this.client.fetch(
90
83
  {
91
84
  body: JSON.stringify(
@@ -98,8 +91,7 @@ class API extends api.API {
98
91
  marshalling_gen.unmarshalVolume
99
92
  );
100
93
  /**
101
- * Get a volume. Retrieve technical information about a specific volume.
102
- * Details such as size, type, and status are returned in the response.
94
+ * Get a volume. Retrieve technical information about a specific volume. Details such as size, type, and status are returned in the response.
103
95
  *
104
96
  * @param request - The request {@link GetVolumeRequest}
105
97
  * @returns A Promise of Volume
@@ -127,8 +119,7 @@ class API extends api.API {
127
119
  options
128
120
  );
129
121
  /**
130
- * Delete a detached volume. You must specify the `volume_id` of the volume
131
- * you want to delete. The volume must not be in the `in_use` status.
122
+ * Delete a detached volume. You must specify the `volume_id` of the volume you want to delete. The volume must not be in the `in_use` status.
132
123
  *
133
124
  * @param request - The request {@link DeleteVolumeRequest}
134
125
  */
@@ -137,14 +128,12 @@ class API extends api.API {
137
128
  path: `/block/v1alpha1/zones/${marshalling.validatePathParam("zone", request.zone ?? this.client.settings.defaultZone)}/volumes/${marshalling.validatePathParam("volumeId", request.volumeId)}`
138
129
  });
139
130
  /**
140
- * Update a volume. Update the technical details of a volume, such as its
141
- * name, tags, or its new size and `volume_type` (within the same Block
142
- * Storage class). You can only resize a volume to a larger size. It is
143
- * currently not possible to change your Block Storage Class.
144
- *
145
- * @param request - The request {@link UpdateVolumeRequest}
146
- * @returns A Promise of Volume
147
- */
131
+ * Update a volume. Update the technical details of a volume, such as its name, tags, or its new size and `volume_type` (within the same Block Storage class).
132
+ You can only resize a volume to a larger size. It is currently not possible to change your Block Storage Class.
133
+ *
134
+ * @param request - The request {@link UpdateVolumeRequest}
135
+ * @returns A Promise of Volume
136
+ */
148
137
  updateVolume = (request) => this.client.fetch(
149
138
  {
150
139
  body: JSON.stringify(
@@ -177,18 +166,14 @@ class API extends api.API {
177
166
  marshalling_gen.unmarshalListSnapshotsResponse
178
167
  );
179
168
  /**
180
- * List all snapshots. List all available snapshots in a specified zone. By
181
- * default, the snapshots listed are ordered by creation date in ascending
182
- * order. This can be modified via the `order_by` field.
169
+ * List all snapshots. List all available snapshots in a specified zone. By default, the snapshots listed are ordered by creation date in ascending order. This can be modified via the `order_by` field.
183
170
  *
184
171
  * @param request - The request {@link ListSnapshotsRequest}
185
172
  * @returns A Promise of ListSnapshotsResponse
186
173
  */
187
174
  listSnapshots = (request = {}) => resourcePaginator.enrichForPagination("snapshots", this.pageOfListSnapshots, request);
188
175
  /**
189
- * Get a snapshot. Retrieve technical information about a specific snapshot.
190
- * Details such as size, volume type, and status are returned in the
191
- * response.
176
+ * Get a snapshot. Retrieve technical information about a specific snapshot. Details such as size, volume type, and status are returned in the response.
192
177
  *
193
178
  * @param request - The request {@link GetSnapshotRequest}
194
179
  * @returns A Promise of Snapshot
@@ -216,13 +201,12 @@ class API extends api.API {
216
201
  options
217
202
  );
218
203
  /**
219
- * Create a snapshot of a volume. To create a snapshot, the volume must be in
220
- * the `in_use` or the `available` status. If your volume is in a transient
221
- * state, you need to wait until the end of the current operation.
222
- *
223
- * @param request - The request {@link CreateSnapshotRequest}
224
- * @returns A Promise of Snapshot
225
- */
204
+ * Create a snapshot of a volume. To create a snapshot, the volume must be in the `in_use` or the `available` status.
205
+ If your volume is in a transient state, you need to wait until the end of the current operation.
206
+ *
207
+ * @param request - The request {@link CreateSnapshotRequest}
208
+ * @returns A Promise of Snapshot
209
+ */
226
210
  createSnapshot = (request) => this.client.fetch(
227
211
  {
228
212
  body: JSON.stringify(
@@ -235,15 +219,14 @@ class API extends api.API {
235
219
  marshalling_gen.unmarshalSnapshot
236
220
  );
237
221
  /**
238
- * (Deprecated in favor of `ImportSnapshotFromObjectStorage`). Import a
239
- * snapshot from a Scaleway Object Storage bucket The bucket must contain a
240
- * QCOW2 image. The bucket can be imported into any Availability Zone as long
241
- * as it is in the same region as the bucket.
242
- *
243
- * @deprecated
244
- * @param request - The request {@link ImportSnapshotFromS3Request}
245
- * @returns A Promise of Snapshot
246
- */
222
+ * (Deprecated in favor of `ImportSnapshotFromObjectStorage`). Import a snapshot from a Scaleway Object Storage bucket
223
+ The bucket must contain a QCOW2 image.
224
+ The bucket can be imported into any Availability Zone as long as it is in the same region as the bucket.
225
+ *
226
+ * @deprecated
227
+ * @param request - The request {@link ImportSnapshotFromS3Request}
228
+ * @returns A Promise of Snapshot
229
+ */
247
230
  importSnapshotFromS3 = (request) => this.client.fetch(
248
231
  {
249
232
  body: JSON.stringify(
@@ -256,13 +239,12 @@ class API extends api.API {
256
239
  marshalling_gen.unmarshalSnapshot
257
240
  );
258
241
  /**
259
- * Import a snapshot from a Scaleway Object Storage bucket. The bucket must
260
- * contain a QCOW2 image. The bucket can be imported into any Availability
261
- * Zone as long as it is in the same region as the bucket.
262
- *
263
- * @param request - The request {@link ImportSnapshotFromObjectStorageRequest}
264
- * @returns A Promise of Snapshot
265
- */
242
+ * Import a snapshot from a Scaleway Object Storage bucket. The bucket must contain a QCOW2 image.
243
+ The bucket can be imported into any Availability Zone as long as it is in the same region as the bucket.
244
+ *
245
+ * @param request - The request {@link ImportSnapshotFromObjectStorageRequest}
246
+ * @returns A Promise of Snapshot
247
+ */
266
248
  importSnapshotFromObjectStorage = (request) => this.client.fetch(
267
249
  {
268
250
  body: JSON.stringify(
@@ -278,12 +260,12 @@ class API extends api.API {
278
260
  marshalling_gen.unmarshalSnapshot
279
261
  );
280
262
  /**
281
- * Export a snapshot to a Scaleway Object Storage bucket. The snapshot is
282
- * exported in QCOW2 format. The snapshot must not be in transient state.
283
- *
284
- * @param request - The request {@link ExportSnapshotToObjectStorageRequest}
285
- * @returns A Promise of Snapshot
286
- */
263
+ * Export a snapshot to a Scaleway Object Storage bucket. The snapshot is exported in QCOW2 format.
264
+ The snapshot must not be in transient state.
265
+ *
266
+ * @param request - The request {@link ExportSnapshotToObjectStorageRequest}
267
+ * @returns A Promise of Snapshot
268
+ */
287
269
  exportSnapshotToObjectStorage = (request) => this.client.fetch(
288
270
  {
289
271
  body: JSON.stringify(
@@ -299,8 +281,7 @@ class API extends api.API {
299
281
  marshalling_gen.unmarshalSnapshot
300
282
  );
301
283
  /**
302
- * Delete a snapshot. You must specify the `snapshot_id` of the snapshot you
303
- * want to delete. The snapshot must not be in use.
284
+ * Delete a snapshot. You must specify the `snapshot_id` of the snapshot you want to delete. The snapshot must not be in use.
304
285
  *
305
286
  * @param request - The request {@link DeleteSnapshotRequest}
306
287
  */
@@ -3,16 +3,15 @@ import type { Zone as ScwZone, WaitForOptions } from '@scaleway/sdk-client';
3
3
  import type { CreateSnapshotRequest, CreateVolumeRequest, DeleteSnapshotRequest, DeleteVolumeRequest, ExportSnapshotToObjectStorageRequest, GetSnapshotRequest, GetVolumeRequest, ImportSnapshotFromObjectStorageRequest, ImportSnapshotFromS3Request, ListSnapshotsRequest, ListSnapshotsResponse, ListVolumeTypesRequest, ListVolumeTypesResponse, ListVolumesRequest, ListVolumesResponse, Snapshot, UpdateSnapshotRequest, UpdateVolumeRequest, Volume } from './types.gen';
4
4
  /**
5
5
  * Block Storage API.
6
- *
7
- * This API allows you to manage your Block Storage volumes.
6
+
7
+ This API allows you to manage your Block Storage volumes.
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
  protected pageOfListVolumeTypes: (request?: Readonly<ListVolumeTypesRequest>) => Promise<ListVolumeTypesResponse>;
13
13
  /**
14
- * List volume types. List all available volume types in a specified zone. The
15
- * volume types listed are ordered by name in ascending order.
14
+ * List volume types. List all available volume types in a specified zone. The volume types listed are ordered by name in ascending order.
16
15
  *
17
16
  * @param request - The request {@link ListVolumeTypesRequest}
18
17
  * @returns A Promise of ListVolumeTypesResponse
@@ -23,9 +22,7 @@ export declare class API extends ParentAPI {
23
22
  };
24
23
  protected pageOfListVolumes: (request?: Readonly<ListVolumesRequest>) => Promise<ListVolumesResponse>;
25
24
  /**
26
- * List volumes. List all existing volumes in a specified zone. By default,
27
- * the volumes listed are ordered by creation date in ascending order. This
28
- * can be modified via the `order_by` field.
25
+ * List volumes. List all existing volumes in a specified zone. By default, the volumes listed are ordered by creation date in ascending order. This can be modified via the `order_by` field.
29
26
  *
30
27
  * @param request - The request {@link ListVolumesRequest}
31
28
  * @returns A Promise of ListVolumesResponse
@@ -35,20 +32,15 @@ export declare class API extends ParentAPI {
35
32
  [Symbol.asyncIterator]: () => AsyncGenerator<Volume[], void, void>;
36
33
  };
37
34
  /**
38
- * Create a volume. To create a new volume from scratch, you must specify
39
- * `from_empty` and the `size`. To create a volume from an existing snapshot,
40
- * specify `from_snapshot` and the `snapshot_id` in the request payload
41
- * instead, size is optional and can be specified if you need to extend the
42
- * original size. The volume will take on the same volume class and underlying
43
- * IOPS limitations as the original snapshot.
35
+ * Create a volume. To create a new volume from scratch, you must specify `from_empty` and the `size`.
36
+ To create a volume from an existing snapshot, specify `from_snapshot` and the `snapshot_id` in the request payload instead, size is optional and can be specified if you need to extend the original size. The volume will take on the same volume class and underlying IOPS limitations as the original snapshot.
44
37
  *
45
38
  * @param request - The request {@link CreateVolumeRequest}
46
39
  * @returns A Promise of Volume
47
40
  */
48
41
  createVolume: (request?: Readonly<CreateVolumeRequest>) => Promise<Volume>;
49
42
  /**
50
- * Get a volume. Retrieve technical information about a specific volume.
51
- * Details such as size, type, and status are returned in the response.
43
+ * Get a volume. Retrieve technical information about a specific volume. Details such as size, type, and status are returned in the response.
52
44
  *
53
45
  * @param request - The request {@link GetVolumeRequest}
54
46
  * @returns A Promise of Volume
@@ -63,17 +55,14 @@ export declare class API extends ParentAPI {
63
55
  */
64
56
  waitForVolume: (request: Readonly<GetVolumeRequest>, options?: Readonly<WaitForOptions<Volume>>) => Promise<Volume>;
65
57
  /**
66
- * Delete a detached volume. You must specify the `volume_id` of the volume
67
- * you want to delete. The volume must not be in the `in_use` status.
58
+ * Delete a detached volume. You must specify the `volume_id` of the volume you want to delete. The volume must not be in the `in_use` status.
68
59
  *
69
60
  * @param request - The request {@link DeleteVolumeRequest}
70
61
  */
71
62
  deleteVolume: (request: Readonly<DeleteVolumeRequest>) => Promise<void>;
72
63
  /**
73
- * Update a volume. Update the technical details of a volume, such as its
74
- * name, tags, or its new size and `volume_type` (within the same Block
75
- * Storage class). You can only resize a volume to a larger size. It is
76
- * currently not possible to change your Block Storage Class.
64
+ * Update a volume. Update the technical details of a volume, such as its name, tags, or its new size and `volume_type` (within the same Block Storage class).
65
+ You can only resize a volume to a larger size. It is currently not possible to change your Block Storage Class.
77
66
  *
78
67
  * @param request - The request {@link UpdateVolumeRequest}
79
68
  * @returns A Promise of Volume
@@ -81,9 +70,7 @@ export declare class API extends ParentAPI {
81
70
  updateVolume: (request: Readonly<UpdateVolumeRequest>) => Promise<Volume>;
82
71
  protected pageOfListSnapshots: (request?: Readonly<ListSnapshotsRequest>) => Promise<ListSnapshotsResponse>;
83
72
  /**
84
- * List all snapshots. List all available snapshots in a specified zone. By
85
- * default, the snapshots listed are ordered by creation date in ascending
86
- * order. This can be modified via the `order_by` field.
73
+ * List all snapshots. List all available snapshots in a specified zone. By default, the snapshots listed are ordered by creation date in ascending order. This can be modified via the `order_by` field.
87
74
  *
88
75
  * @param request - The request {@link ListSnapshotsRequest}
89
76
  * @returns A Promise of ListSnapshotsResponse
@@ -93,9 +80,7 @@ export declare class API extends ParentAPI {
93
80
  [Symbol.asyncIterator]: () => AsyncGenerator<Snapshot[], void, void>;
94
81
  };
95
82
  /**
96
- * Get a snapshot. Retrieve technical information about a specific snapshot.
97
- * Details such as size, volume type, and status are returned in the
98
- * response.
83
+ * Get a snapshot. Retrieve technical information about a specific snapshot. Details such as size, volume type, and status are returned in the response.
99
84
  *
100
85
  * @param request - The request {@link GetSnapshotRequest}
101
86
  * @returns A Promise of Snapshot
@@ -110,19 +95,17 @@ export declare class API extends ParentAPI {
110
95
  */
111
96
  waitForSnapshot: (request: Readonly<GetSnapshotRequest>, options?: Readonly<WaitForOptions<Snapshot>>) => Promise<Snapshot>;
112
97
  /**
113
- * Create a snapshot of a volume. To create a snapshot, the volume must be in
114
- * the `in_use` or the `available` status. If your volume is in a transient
115
- * state, you need to wait until the end of the current operation.
98
+ * Create a snapshot of a volume. To create a snapshot, the volume must be in the `in_use` or the `available` status.
99
+ If your volume is in a transient state, you need to wait until the end of the current operation.
116
100
  *
117
101
  * @param request - The request {@link CreateSnapshotRequest}
118
102
  * @returns A Promise of Snapshot
119
103
  */
120
104
  createSnapshot: (request: Readonly<CreateSnapshotRequest>) => Promise<Snapshot>;
121
105
  /**
122
- * (Deprecated in favor of `ImportSnapshotFromObjectStorage`). Import a
123
- * snapshot from a Scaleway Object Storage bucket The bucket must contain a
124
- * QCOW2 image. The bucket can be imported into any Availability Zone as long
125
- * as it is in the same region as the bucket.
106
+ * (Deprecated in favor of `ImportSnapshotFromObjectStorage`). Import a snapshot from a Scaleway Object Storage bucket
107
+ The bucket must contain a QCOW2 image.
108
+ The bucket can be imported into any Availability Zone as long as it is in the same region as the bucket.
126
109
  *
127
110
  * @deprecated
128
111
  * @param request - The request {@link ImportSnapshotFromS3Request}
@@ -130,25 +113,23 @@ export declare class API extends ParentAPI {
130
113
  */
131
114
  importSnapshotFromS3: (request: Readonly<ImportSnapshotFromS3Request>) => Promise<Snapshot>;
132
115
  /**
133
- * Import a snapshot from a Scaleway Object Storage bucket. The bucket must
134
- * contain a QCOW2 image. The bucket can be imported into any Availability
135
- * Zone as long as it is in the same region as the bucket.
116
+ * Import a snapshot from a Scaleway Object Storage bucket. The bucket must contain a QCOW2 image.
117
+ The bucket can be imported into any Availability Zone as long as it is in the same region as the bucket.
136
118
  *
137
119
  * @param request - The request {@link ImportSnapshotFromObjectStorageRequest}
138
120
  * @returns A Promise of Snapshot
139
121
  */
140
122
  importSnapshotFromObjectStorage: (request: Readonly<ImportSnapshotFromObjectStorageRequest>) => Promise<Snapshot>;
141
123
  /**
142
- * Export a snapshot to a Scaleway Object Storage bucket. The snapshot is
143
- * exported in QCOW2 format. The snapshot must not be in transient state.
124
+ * Export a snapshot to a Scaleway Object Storage bucket. The snapshot is exported in QCOW2 format.
125
+ The snapshot must not be in transient state.
144
126
  *
145
127
  * @param request - The request {@link ExportSnapshotToObjectStorageRequest}
146
128
  * @returns A Promise of Snapshot
147
129
  */
148
130
  exportSnapshotToObjectStorage: (request: Readonly<ExportSnapshotToObjectStorageRequest>) => Promise<Snapshot>;
149
131
  /**
150
- * Delete a snapshot. You must specify the `snapshot_id` of the snapshot you
151
- * want to delete. The snapshot must not be in use.
132
+ * Delete a snapshot. You must specify the `snapshot_id` of the snapshot you want to delete. The snapshot must not be in use.
152
133
  *
153
134
  * @param request - The request {@link DeleteSnapshotRequest}
154
135
  */
@@ -37,8 +37,7 @@ class API extends API$1 {
37
37
  unmarshalListVolumeTypesResponse
38
38
  );
39
39
  /**
40
- * List volume types. List all available volume types in a specified zone. The
41
- * volume types listed are ordered by name in ascending order.
40
+ * List volume types. List all available volume types in a specified zone. The volume types listed are ordered by name in ascending order.
42
41
  *
43
42
  * @param request - The request {@link ListVolumeTypesRequest}
44
43
  * @returns A Promise of ListVolumeTypesResponse
@@ -65,25 +64,19 @@ class API extends API$1 {
65
64
  unmarshalListVolumesResponse
66
65
  );
67
66
  /**
68
- * List volumes. List all existing volumes in a specified zone. By default,
69
- * the volumes listed are ordered by creation date in ascending order. This
70
- * can be modified via the `order_by` field.
67
+ * List volumes. List all existing volumes in a specified zone. By default, the volumes listed are ordered by creation date in ascending order. This can be modified via the `order_by` field.
71
68
  *
72
69
  * @param request - The request {@link ListVolumesRequest}
73
70
  * @returns A Promise of ListVolumesResponse
74
71
  */
75
72
  listVolumes = (request = {}) => enrichForPagination("volumes", this.pageOfListVolumes, request);
76
73
  /**
77
- * Create a volume. To create a new volume from scratch, you must specify
78
- * `from_empty` and the `size`. To create a volume from an existing snapshot,
79
- * specify `from_snapshot` and the `snapshot_id` in the request payload
80
- * instead, size is optional and can be specified if you need to extend the
81
- * original size. The volume will take on the same volume class and underlying
82
- * IOPS limitations as the original snapshot.
83
- *
84
- * @param request - The request {@link CreateVolumeRequest}
85
- * @returns A Promise of Volume
86
- */
74
+ * Create a volume. To create a new volume from scratch, you must specify `from_empty` and the `size`.
75
+ To create a volume from an existing snapshot, specify `from_snapshot` and the `snapshot_id` in the request payload instead, size is optional and can be specified if you need to extend the original size. The volume will take on the same volume class and underlying IOPS limitations as the original snapshot.
76
+ *
77
+ * @param request - The request {@link CreateVolumeRequest}
78
+ * @returns A Promise of Volume
79
+ */
87
80
  createVolume = (request = {}) => this.client.fetch(
88
81
  {
89
82
  body: JSON.stringify(
@@ -96,8 +89,7 @@ class API extends API$1 {
96
89
  unmarshalVolume
97
90
  );
98
91
  /**
99
- * Get a volume. Retrieve technical information about a specific volume.
100
- * Details such as size, type, and status are returned in the response.
92
+ * Get a volume. Retrieve technical information about a specific volume. Details such as size, type, and status are returned in the response.
101
93
  *
102
94
  * @param request - The request {@link GetVolumeRequest}
103
95
  * @returns A Promise of Volume
@@ -125,8 +117,7 @@ class API extends API$1 {
125
117
  options
126
118
  );
127
119
  /**
128
- * Delete a detached volume. You must specify the `volume_id` of the volume
129
- * you want to delete. The volume must not be in the `in_use` status.
120
+ * Delete a detached volume. You must specify the `volume_id` of the volume you want to delete. The volume must not be in the `in_use` status.
130
121
  *
131
122
  * @param request - The request {@link DeleteVolumeRequest}
132
123
  */
@@ -135,14 +126,12 @@ class API extends API$1 {
135
126
  path: `/block/v1alpha1/zones/${validatePathParam("zone", request.zone ?? this.client.settings.defaultZone)}/volumes/${validatePathParam("volumeId", request.volumeId)}`
136
127
  });
137
128
  /**
138
- * Update a volume. Update the technical details of a volume, such as its
139
- * name, tags, or its new size and `volume_type` (within the same Block
140
- * Storage class). You can only resize a volume to a larger size. It is
141
- * currently not possible to change your Block Storage Class.
142
- *
143
- * @param request - The request {@link UpdateVolumeRequest}
144
- * @returns A Promise of Volume
145
- */
129
+ * Update a volume. Update the technical details of a volume, such as its name, tags, or its new size and `volume_type` (within the same Block Storage class).
130
+ You can only resize a volume to a larger size. It is currently not possible to change your Block Storage Class.
131
+ *
132
+ * @param request - The request {@link UpdateVolumeRequest}
133
+ * @returns A Promise of Volume
134
+ */
146
135
  updateVolume = (request) => this.client.fetch(
147
136
  {
148
137
  body: JSON.stringify(
@@ -175,18 +164,14 @@ class API extends API$1 {
175
164
  unmarshalListSnapshotsResponse
176
165
  );
177
166
  /**
178
- * List all snapshots. List all available snapshots in a specified zone. By
179
- * default, the snapshots listed are ordered by creation date in ascending
180
- * order. This can be modified via the `order_by` field.
167
+ * List all snapshots. List all available snapshots in a specified zone. By default, the snapshots listed are ordered by creation date in ascending order. This can be modified via the `order_by` field.
181
168
  *
182
169
  * @param request - The request {@link ListSnapshotsRequest}
183
170
  * @returns A Promise of ListSnapshotsResponse
184
171
  */
185
172
  listSnapshots = (request = {}) => enrichForPagination("snapshots", this.pageOfListSnapshots, request);
186
173
  /**
187
- * Get a snapshot. Retrieve technical information about a specific snapshot.
188
- * Details such as size, volume type, and status are returned in the
189
- * response.
174
+ * Get a snapshot. Retrieve technical information about a specific snapshot. Details such as size, volume type, and status are returned in the response.
190
175
  *
191
176
  * @param request - The request {@link GetSnapshotRequest}
192
177
  * @returns A Promise of Snapshot
@@ -214,13 +199,12 @@ class API extends API$1 {
214
199
  options
215
200
  );
216
201
  /**
217
- * Create a snapshot of a volume. To create a snapshot, the volume must be in
218
- * the `in_use` or the `available` status. If your volume is in a transient
219
- * state, you need to wait until the end of the current operation.
220
- *
221
- * @param request - The request {@link CreateSnapshotRequest}
222
- * @returns A Promise of Snapshot
223
- */
202
+ * Create a snapshot of a volume. To create a snapshot, the volume must be in the `in_use` or the `available` status.
203
+ If your volume is in a transient state, you need to wait until the end of the current operation.
204
+ *
205
+ * @param request - The request {@link CreateSnapshotRequest}
206
+ * @returns A Promise of Snapshot
207
+ */
224
208
  createSnapshot = (request) => this.client.fetch(
225
209
  {
226
210
  body: JSON.stringify(
@@ -233,15 +217,14 @@ class API extends API$1 {
233
217
  unmarshalSnapshot
234
218
  );
235
219
  /**
236
- * (Deprecated in favor of `ImportSnapshotFromObjectStorage`). Import a
237
- * snapshot from a Scaleway Object Storage bucket The bucket must contain a
238
- * QCOW2 image. The bucket can be imported into any Availability Zone as long
239
- * as it is in the same region as the bucket.
240
- *
241
- * @deprecated
242
- * @param request - The request {@link ImportSnapshotFromS3Request}
243
- * @returns A Promise of Snapshot
244
- */
220
+ * (Deprecated in favor of `ImportSnapshotFromObjectStorage`). Import a snapshot from a Scaleway Object Storage bucket
221
+ The bucket must contain a QCOW2 image.
222
+ The bucket can be imported into any Availability Zone as long as it is in the same region as the bucket.
223
+ *
224
+ * @deprecated
225
+ * @param request - The request {@link ImportSnapshotFromS3Request}
226
+ * @returns A Promise of Snapshot
227
+ */
245
228
  importSnapshotFromS3 = (request) => this.client.fetch(
246
229
  {
247
230
  body: JSON.stringify(
@@ -254,13 +237,12 @@ class API extends API$1 {
254
237
  unmarshalSnapshot
255
238
  );
256
239
  /**
257
- * Import a snapshot from a Scaleway Object Storage bucket. The bucket must
258
- * contain a QCOW2 image. The bucket can be imported into any Availability
259
- * Zone as long as it is in the same region as the bucket.
260
- *
261
- * @param request - The request {@link ImportSnapshotFromObjectStorageRequest}
262
- * @returns A Promise of Snapshot
263
- */
240
+ * Import a snapshot from a Scaleway Object Storage bucket. The bucket must contain a QCOW2 image.
241
+ The bucket can be imported into any Availability Zone as long as it is in the same region as the bucket.
242
+ *
243
+ * @param request - The request {@link ImportSnapshotFromObjectStorageRequest}
244
+ * @returns A Promise of Snapshot
245
+ */
264
246
  importSnapshotFromObjectStorage = (request) => this.client.fetch(
265
247
  {
266
248
  body: JSON.stringify(
@@ -276,12 +258,12 @@ class API extends API$1 {
276
258
  unmarshalSnapshot
277
259
  );
278
260
  /**
279
- * Export a snapshot to a Scaleway Object Storage bucket. The snapshot is
280
- * exported in QCOW2 format. The snapshot must not be in transient state.
281
- *
282
- * @param request - The request {@link ExportSnapshotToObjectStorageRequest}
283
- * @returns A Promise of Snapshot
284
- */
261
+ * Export a snapshot to a Scaleway Object Storage bucket. The snapshot is exported in QCOW2 format.
262
+ The snapshot must not be in transient state.
263
+ *
264
+ * @param request - The request {@link ExportSnapshotToObjectStorageRequest}
265
+ * @returns A Promise of Snapshot
266
+ */
285
267
  exportSnapshotToObjectStorage = (request) => this.client.fetch(
286
268
  {
287
269
  body: JSON.stringify(
@@ -297,8 +279,7 @@ class API extends API$1 {
297
279
  unmarshalSnapshot
298
280
  );
299
281
  /**
300
- * Delete a snapshot. You must specify the `snapshot_id` of the snapshot you
301
- * want to delete. The snapshot must not be in use.
282
+ * Delete a snapshot. You must specify the `snapshot_id` of the snapshot you want to delete. The snapshot must not be in use.
302
283
  *
303
284
  * @param request - The request {@link DeleteSnapshotRequest}
304
285
  */