@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
@@ -78,23 +78,14 @@ class API extends api.API {
78
78
  marshalling_gen.unmarshalListInstancesResponse
79
79
  );
80
80
  /**
81
- * List MongoDB® Database Instances. List all MongoDB® Database Instances in
82
- * the specified region. By default, the MongoDB® Database Instances returned
83
- * in the list are ordered by creation date in ascending order, though this
84
- * can be modified via the order_by field. You can define additional
85
- * parameters for your query, such as `tags` and `name`. For the `name`
86
- * parameter, the value you include will be checked against the whole name
87
- * string to see if it includes the string you put in the parameter.
81
+ * List MongoDB® Database Instances. List all MongoDB® Database Instances in the specified region. By default, the MongoDB® Database Instances returned in the list are ordered by creation date in ascending order, though this can be modified via the order_by field. You can define additional parameters for your query, such as `tags` and `name`. For the `name` parameter, the value you include will be checked against the whole name string to see if it includes the string you put in the parameter.
88
82
  *
89
83
  * @param request - The request {@link ListInstancesRequest}
90
84
  * @returns A Promise of ListInstancesResponse
91
85
  */
92
86
  listInstances = (request = {}) => resourcePaginator.enrichForPagination("instances", this.pageOfListInstances, request);
93
87
  /**
94
- * Get a MongoDB® Database Instance. Retrieve information about a given
95
- * MongoDB® Database Instance, specified by the `region` and `instance_id`
96
- * parameters. Its full details, including name, status, IP address and port,
97
- * are returned in the response object.
88
+ * Get a MongoDB® Database Instance. Retrieve information about a given MongoDB® Database Instance, specified by the `region` and `instance_id` parameters. Its full details, including name, status, IP address and port, are returned in the response object.
98
89
  *
99
90
  * @param request - The request {@link GetInstanceRequest}
100
91
  * @returns A Promise of Instance
@@ -122,8 +113,7 @@ class API extends api.API {
122
113
  options
123
114
  );
124
115
  /**
125
- * Create a MongoDB® Database Instance. Create a new MongoDB® Database
126
- * Instance.
116
+ * Create a MongoDB® Database Instance. Create a new MongoDB® Database Instance.
127
117
  *
128
118
  * @param request - The request {@link CreateInstanceRequest}
129
119
  * @returns A Promise of Instance
@@ -140,8 +130,7 @@ class API extends api.API {
140
130
  marshalling_gen.unmarshalInstance
141
131
  );
142
132
  /**
143
- * Update a MongoDB® Database Instance. Update the parameters of a MongoDB®
144
- * Database Instance.
133
+ * Update a MongoDB® Database Instance. Update the parameters of a MongoDB® Database Instance.
145
134
  *
146
135
  * @param request - The request {@link UpdateInstanceRequest}
147
136
  * @returns A Promise of Instance
@@ -158,10 +147,7 @@ class API extends api.API {
158
147
  marshalling_gen.unmarshalInstance
159
148
  );
160
149
  /**
161
- * Delete a MongoDB® Database Instance. Delete a given MongoDB® Database
162
- * Instance, specified by the `region` and `instance_id` parameters. Deleting
163
- * a MongoDB® Database Instance is permanent, and cannot be undone. Note that
164
- * upon deletion all your data will be lost.
150
+ * Delete a MongoDB® Database Instance. Delete a given MongoDB® Database Instance, specified by the `region` and `instance_id` parameters. Deleting a MongoDB® Database Instance is permanent, and cannot be undone. Note that upon deletion all your data will be lost.
165
151
  *
166
152
  * @param request - The request {@link DeleteInstanceRequest}
167
153
  * @returns A Promise of Instance
@@ -174,8 +160,7 @@ class API extends api.API {
174
160
  marshalling_gen.unmarshalInstance
175
161
  );
176
162
  /**
177
- * Upgrade a Database Instance. Upgrade your current Database Instance
178
- * specifications like volume size.
163
+ * Upgrade a Database Instance. Upgrade your current Database Instance specifications like volume size.
179
164
  *
180
165
  * @param request - The request {@link UpgradeInstanceRequest}
181
166
  * @returns A Promise of Instance
@@ -192,8 +177,7 @@ class API extends api.API {
192
177
  marshalling_gen.unmarshalInstance
193
178
  );
194
179
  /**
195
- * Get the certificate of a Database Instance. Retrieve the certificate of a
196
- * given Database Instance, specified by the `instance_id` parameter.
180
+ * Get the certificate of a Database Instance. Retrieve the certificate of a given Database Instance, specified by the `instance_id` parameter.
197
181
  *
198
182
  * @param request - The request {@link GetInstanceCertificateRequest}
199
183
  * @returns A Promise of Blob
@@ -205,9 +189,7 @@ class API extends api.API {
205
189
  responseType: "blob"
206
190
  });
207
191
  /**
208
- * Create a Database Instance snapshot. Create a new snapshot of a Database
209
- * Instance. You must define the `name` and `instance_id` parameters in the
210
- * request.
192
+ * Create a Database Instance snapshot. Create a new snapshot of a Database Instance. You must define the `name` and `instance_id` parameters in the request.
211
193
  *
212
194
  * @param request - The request {@link CreateSnapshotRequest}
213
195
  * @returns A Promise of Snapshot
@@ -224,9 +206,7 @@ class API extends api.API {
224
206
  marshalling_gen.unmarshalSnapshot
225
207
  );
226
208
  /**
227
- * Get a Database Instance snapshot. Retrieve information about a given
228
- * snapshot of a Database Instance. You must specify, in the endpoint, the
229
- * `snapshot_id` parameter of the snapshot you want to retrieve.
209
+ * Get a Database Instance snapshot. Retrieve information about a given snapshot of a Database Instance. You must specify, in the endpoint, the `snapshot_id` parameter of the snapshot you want to retrieve.
230
210
  *
231
211
  * @param request - The request {@link GetSnapshotRequest}
232
212
  * @returns A Promise of Snapshot
@@ -254,9 +234,7 @@ class API extends api.API {
254
234
  options
255
235
  );
256
236
  /**
257
- * Update a Database Instance snapshot. Update the parameters of a snapshot of
258
- * a Database Instance. You can update the `name` and `expires_at`
259
- * parameters.
237
+ * Update a Database Instance snapshot. Update the parameters of a snapshot of a Database Instance. You can update the `name` and `expires_at` parameters.
260
238
  *
261
239
  * @param request - The request {@link UpdateSnapshotRequest}
262
240
  * @returns A Promise of Snapshot
@@ -273,11 +251,7 @@ class API extends api.API {
273
251
  marshalling_gen.unmarshalSnapshot
274
252
  );
275
253
  /**
276
- * Restore a Database Instance snapshot. Restore a given snapshot of a
277
- * Database Instance. You must specify, in the endpoint, the `snapshot_id`
278
- * parameter of the snapshot you want to restore, the `instance_name` of the
279
- * new Database Instance, `node_type` of the new Database Instance and
280
- * `node_number` of the new Database Instance.
254
+ * Restore a Database Instance snapshot. Restore a given snapshot of a Database Instance. You must specify, in the endpoint, the `snapshot_id` parameter of the snapshot you want to restore, the `instance_name` of the new Database Instance, `node_type` of the new Database Instance and `node_number` of the new Database Instance.
281
255
  *
282
256
  * @param request - The request {@link RestoreSnapshotRequest}
283
257
  * @returns A Promise of Instance
@@ -313,20 +287,14 @@ class API extends api.API {
313
287
  marshalling_gen.unmarshalListSnapshotsResponse
314
288
  );
315
289
  /**
316
- * List snapshots. List snapshots. You can include the `instance_id` or
317
- * `project_id` in your query to get the list of snapshots for specific
318
- * Database Instances and/or Projects. By default, the details returned in the
319
- * list are ordered by creation date in ascending order, though this can be
320
- * modified via the `order_by` field.
290
+ * List snapshots. List snapshots. You can include the `instance_id` or `project_id` in your query to get the list of snapshots for specific Database Instances and/or Projects. By default, the details returned in the list are ordered by creation date in ascending order, though this can be modified via the `order_by` field.
321
291
  *
322
292
  * @param request - The request {@link ListSnapshotsRequest}
323
293
  * @returns A Promise of ListSnapshotsResponse
324
294
  */
325
295
  listSnapshots = (request = {}) => resourcePaginator.enrichForPagination("snapshots", this.pageOfListSnapshots, request);
326
296
  /**
327
- * Delete a Database Instance snapshot. Delete a given snapshot of a Database
328
- * Instance. You must specify, in the endpoint, the `snapshot_id` parameter of
329
- * the snapshot you want to delete.
297
+ * Delete a Database Instance snapshot. Delete a given snapshot of a Database Instance. You must specify, in the endpoint, the `snapshot_id` parameter of the snapshot you want to delete.
330
298
  *
331
299
  * @param request - The request {@link DeleteSnapshotRequest}
332
300
  * @returns A Promise of Snapshot
@@ -355,17 +323,14 @@ class API extends api.API {
355
323
  marshalling_gen.unmarshalListUsersResponse
356
324
  );
357
325
  /**
358
- * List users of a Database Instance. List all users of a given Database
359
- * Instance.
326
+ * List users of a Database Instance. List all users of a given Database Instance.
360
327
  *
361
328
  * @param request - The request {@link ListUsersRequest}
362
329
  * @returns A Promise of ListUsersResponse
363
330
  */
364
331
  listUsers = (request) => resourcePaginator.enrichForPagination("users", this.pageOfListUsers, request);
365
332
  /**
366
- * Create an user on a Database Instance. Create an user on a Database
367
- * Instance. You must define the `name`, `password` of the user and
368
- * `instance_id` parameters in the request.
333
+ * Create an user on a Database Instance. Create an user on a Database Instance. You must define the `name`, `password` of the user and `instance_id` parameters in the request.
369
334
  *
370
335
  * @param request - The request {@link CreateUserRequest}
371
336
  * @returns A Promise of User
@@ -382,9 +347,7 @@ class API extends api.API {
382
347
  marshalling_gen.unmarshalUser
383
348
  );
384
349
  /**
385
- * Update a user on a Database Instance. Update the parameters of a user on a
386
- * Database Instance. You can update the `password` parameter, but you cannot
387
- * change the name of the user.
350
+ * Update a user on a Database Instance. Update the parameters of a user on a Database Instance. You can update the `password` parameter, but you cannot change the name of the user.
388
351
  *
389
352
  * @param request - The request {@link UpdateUserRequest}
390
353
  * @returns A Promise of User
@@ -401,8 +364,7 @@ class API extends api.API {
401
364
  marshalling_gen.unmarshalUser
402
365
  );
403
366
  /**
404
- * Delete a user on a Database Instance. Delete an existing user on a Database
405
- * Instance.
367
+ * Delete a user on a Database Instance. Delete an existing user on a Database Instance.
406
368
  *
407
369
  * @param request - The request {@link DeleteUserRequest}
408
370
  */
@@ -424,10 +386,7 @@ class API extends api.API {
424
386
  marshalling_gen.unmarshalUser
425
387
  );
426
388
  /**
427
- * Delete a Database Instance endpoint. Delete the endpoint of a Database
428
- * Instance. You must specify the `endpoint_id` parameter of the endpoint you
429
- * want to delete. Note that you might need to update any environment
430
- * configurations that point to the deleted endpoint.
389
+ * Delete a Database Instance endpoint. Delete the endpoint of a Database Instance. You must specify the `endpoint_id` parameter of the endpoint you want to delete. Note that you might need to update any environment configurations that point to the deleted endpoint.
431
390
  *
432
391
  * @param request - The request {@link DeleteEndpointRequest}
433
392
  */
@@ -436,9 +395,7 @@ class API extends api.API {
436
395
  path: `/mongodb/v1alpha1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/endpoints/${marshalling.validatePathParam("endpointId", request.endpointId)}`
437
396
  });
438
397
  /**
439
- * Create a new Instance endpoint. Create a new endpoint for a MongoDB®
440
- * Database Instance. You can add `public_network` or `private_network`
441
- * specifications to the body of the request.
398
+ * Create a new Instance endpoint. Create a new endpoint for a MongoDB® Database Instance. You can add `public_network` or `private_network` specifications to the body of the request.
442
399
  *
443
400
  * @param request - The request {@link CreateEndpointRequest}
444
401
  * @returns A Promise of Endpoint
@@ -3,8 +3,8 @@ import type { Region as ScwRegion, WaitForOptions } from '@scaleway/sdk-client';
3
3
  import type { CreateEndpointRequest, CreateInstanceRequest, CreateSnapshotRequest, CreateUserRequest, DeleteEndpointRequest, DeleteInstanceRequest, DeleteSnapshotRequest, DeleteUserRequest, Endpoint, GetInstanceCertificateRequest, GetInstanceRequest, GetSnapshotRequest, Instance, ListInstancesRequest, ListInstancesResponse, ListNodeTypesRequest, ListNodeTypesResponse, ListSnapshotsRequest, ListSnapshotsResponse, ListUsersRequest, ListUsersResponse, ListVersionsRequest, ListVersionsResponse, RestoreSnapshotRequest, SetUserRoleRequest, Snapshot, UpdateInstanceRequest, UpdateSnapshotRequest, UpdateUserRequest, UpgradeInstanceRequest, User } from './types.gen';
4
4
  /**
5
5
  * Managed MongoDB®.
6
- *
7
- * This API allows you to manage your Managed Databases for MongoDB®.
6
+
7
+ This API allows you to manage your Managed Databases for MongoDB®.
8
8
  */
9
9
  export declare class API extends ParentAPI {
10
10
  /** Lists the available regions of the API. */
@@ -33,13 +33,7 @@ export declare class API extends ParentAPI {
33
33
  };
34
34
  protected pageOfListInstances: (request?: Readonly<ListInstancesRequest>) => Promise<ListInstancesResponse>;
35
35
  /**
36
- * List MongoDB® Database Instances. List all MongoDB® Database Instances in
37
- * the specified region. By default, the MongoDB® Database Instances returned
38
- * in the list are ordered by creation date in ascending order, though this
39
- * can be modified via the order_by field. You can define additional
40
- * parameters for your query, such as `tags` and `name`. For the `name`
41
- * parameter, the value you include will be checked against the whole name
42
- * string to see if it includes the string you put in the parameter.
36
+ * List MongoDB® Database Instances. List all MongoDB® Database Instances in the specified region. By default, the MongoDB® Database Instances returned in the list are ordered by creation date in ascending order, though this can be modified via the order_by field. You can define additional parameters for your query, such as `tags` and `name`. For the `name` parameter, the value you include will be checked against the whole name string to see if it includes the string you put in the parameter.
43
37
  *
44
38
  * @param request - The request {@link ListInstancesRequest}
45
39
  * @returns A Promise of ListInstancesResponse
@@ -49,10 +43,7 @@ export declare class API extends ParentAPI {
49
43
  [Symbol.asyncIterator]: () => AsyncGenerator<Instance[], void, void>;
50
44
  };
51
45
  /**
52
- * Get a MongoDB® Database Instance. Retrieve information about a given
53
- * MongoDB® Database Instance, specified by the `region` and `instance_id`
54
- * parameters. Its full details, including name, status, IP address and port,
55
- * are returned in the response object.
46
+ * Get a MongoDB® Database Instance. Retrieve information about a given MongoDB® Database Instance, specified by the `region` and `instance_id` parameters. Its full details, including name, status, IP address and port, are returned in the response object.
56
47
  *
57
48
  * @param request - The request {@link GetInstanceRequest}
58
49
  * @returns A Promise of Instance
@@ -67,60 +58,49 @@ export declare class API extends ParentAPI {
67
58
  */
68
59
  waitForInstance: (request: Readonly<GetInstanceRequest>, options?: Readonly<WaitForOptions<Instance>>) => Promise<Instance>;
69
60
  /**
70
- * Create a MongoDB® Database Instance. Create a new MongoDB® Database
71
- * Instance.
61
+ * Create a MongoDB® Database Instance. Create a new MongoDB® Database Instance.
72
62
  *
73
63
  * @param request - The request {@link CreateInstanceRequest}
74
64
  * @returns A Promise of Instance
75
65
  */
76
66
  createInstance: (request: Readonly<CreateInstanceRequest>) => Promise<Instance>;
77
67
  /**
78
- * Update a MongoDB® Database Instance. Update the parameters of a MongoDB®
79
- * Database Instance.
68
+ * Update a MongoDB® Database Instance. Update the parameters of a MongoDB® Database Instance.
80
69
  *
81
70
  * @param request - The request {@link UpdateInstanceRequest}
82
71
  * @returns A Promise of Instance
83
72
  */
84
73
  updateInstance: (request: Readonly<UpdateInstanceRequest>) => Promise<Instance>;
85
74
  /**
86
- * Delete a MongoDB® Database Instance. Delete a given MongoDB® Database
87
- * Instance, specified by the `region` and `instance_id` parameters. Deleting
88
- * a MongoDB® Database Instance is permanent, and cannot be undone. Note that
89
- * upon deletion all your data will be lost.
75
+ * Delete a MongoDB® Database Instance. Delete a given MongoDB® Database Instance, specified by the `region` and `instance_id` parameters. Deleting a MongoDB® Database Instance is permanent, and cannot be undone. Note that upon deletion all your data will be lost.
90
76
  *
91
77
  * @param request - The request {@link DeleteInstanceRequest}
92
78
  * @returns A Promise of Instance
93
79
  */
94
80
  deleteInstance: (request: Readonly<DeleteInstanceRequest>) => Promise<Instance>;
95
81
  /**
96
- * Upgrade a Database Instance. Upgrade your current Database Instance
97
- * specifications like volume size.
82
+ * Upgrade a Database Instance. Upgrade your current Database Instance specifications like volume size.
98
83
  *
99
84
  * @param request - The request {@link UpgradeInstanceRequest}
100
85
  * @returns A Promise of Instance
101
86
  */
102
87
  upgradeInstance: (request: Readonly<UpgradeInstanceRequest>) => Promise<Instance>;
103
88
  /**
104
- * Get the certificate of a Database Instance. Retrieve the certificate of a
105
- * given Database Instance, specified by the `instance_id` parameter.
89
+ * Get the certificate of a Database Instance. Retrieve the certificate of a given Database Instance, specified by the `instance_id` parameter.
106
90
  *
107
91
  * @param request - The request {@link GetInstanceCertificateRequest}
108
92
  * @returns A Promise of Blob
109
93
  */
110
94
  getInstanceCertificate: (request: Readonly<GetInstanceCertificateRequest>) => Promise<Blob>;
111
95
  /**
112
- * Create a Database Instance snapshot. Create a new snapshot of a Database
113
- * Instance. You must define the `name` and `instance_id` parameters in the
114
- * request.
96
+ * Create a Database Instance snapshot. Create a new snapshot of a Database Instance. You must define the `name` and `instance_id` parameters in the request.
115
97
  *
116
98
  * @param request - The request {@link CreateSnapshotRequest}
117
99
  * @returns A Promise of Snapshot
118
100
  */
119
101
  createSnapshot: (request: Readonly<CreateSnapshotRequest>) => Promise<Snapshot>;
120
102
  /**
121
- * Get a Database Instance snapshot. Retrieve information about a given
122
- * snapshot of a Database Instance. You must specify, in the endpoint, the
123
- * `snapshot_id` parameter of the snapshot you want to retrieve.
103
+ * Get a Database Instance snapshot. Retrieve information about a given snapshot of a Database Instance. You must specify, in the endpoint, the `snapshot_id` parameter of the snapshot you want to retrieve.
124
104
  *
125
105
  * @param request - The request {@link GetSnapshotRequest}
126
106
  * @returns A Promise of Snapshot
@@ -135,20 +115,14 @@ export declare class API extends ParentAPI {
135
115
  */
136
116
  waitForSnapshot: (request: Readonly<GetSnapshotRequest>, options?: Readonly<WaitForOptions<Snapshot>>) => Promise<Snapshot>;
137
117
  /**
138
- * Update a Database Instance snapshot. Update the parameters of a snapshot of
139
- * a Database Instance. You can update the `name` and `expires_at`
140
- * parameters.
118
+ * Update a Database Instance snapshot. Update the parameters of a snapshot of a Database Instance. You can update the `name` and `expires_at` parameters.
141
119
  *
142
120
  * @param request - The request {@link UpdateSnapshotRequest}
143
121
  * @returns A Promise of Snapshot
144
122
  */
145
123
  updateSnapshot: (request: Readonly<UpdateSnapshotRequest>) => Promise<Snapshot>;
146
124
  /**
147
- * Restore a Database Instance snapshot. Restore a given snapshot of a
148
- * Database Instance. You must specify, in the endpoint, the `snapshot_id`
149
- * parameter of the snapshot you want to restore, the `instance_name` of the
150
- * new Database Instance, `node_type` of the new Database Instance and
151
- * `node_number` of the new Database Instance.
125
+ * Restore a Database Instance snapshot. Restore a given snapshot of a Database Instance. You must specify, in the endpoint, the `snapshot_id` parameter of the snapshot you want to restore, the `instance_name` of the new Database Instance, `node_type` of the new Database Instance and `node_number` of the new Database Instance.
152
126
  *
153
127
  * @param request - The request {@link RestoreSnapshotRequest}
154
128
  * @returns A Promise of Instance
@@ -156,11 +130,7 @@ export declare class API extends ParentAPI {
156
130
  restoreSnapshot: (request: Readonly<RestoreSnapshotRequest>) => Promise<Instance>;
157
131
  protected pageOfListSnapshots: (request?: Readonly<ListSnapshotsRequest>) => Promise<ListSnapshotsResponse>;
158
132
  /**
159
- * List snapshots. List snapshots. You can include the `instance_id` or
160
- * `project_id` in your query to get the list of snapshots for specific
161
- * Database Instances and/or Projects. By default, the details returned in the
162
- * list are ordered by creation date in ascending order, though this can be
163
- * modified via the `order_by` field.
133
+ * List snapshots. List snapshots. You can include the `instance_id` or `project_id` in your query to get the list of snapshots for specific Database Instances and/or Projects. By default, the details returned in the list are ordered by creation date in ascending order, though this can be modified via the `order_by` field.
164
134
  *
165
135
  * @param request - The request {@link ListSnapshotsRequest}
166
136
  * @returns A Promise of ListSnapshotsResponse
@@ -170,9 +140,7 @@ export declare class API extends ParentAPI {
170
140
  [Symbol.asyncIterator]: () => AsyncGenerator<Snapshot[], void, void>;
171
141
  };
172
142
  /**
173
- * Delete a Database Instance snapshot. Delete a given snapshot of a Database
174
- * Instance. You must specify, in the endpoint, the `snapshot_id` parameter of
175
- * the snapshot you want to delete.
143
+ * Delete a Database Instance snapshot. Delete a given snapshot of a Database Instance. You must specify, in the endpoint, the `snapshot_id` parameter of the snapshot you want to delete.
176
144
  *
177
145
  * @param request - The request {@link DeleteSnapshotRequest}
178
146
  * @returns A Promise of Snapshot
@@ -180,8 +148,7 @@ export declare class API extends ParentAPI {
180
148
  deleteSnapshot: (request: Readonly<DeleteSnapshotRequest>) => Promise<Snapshot>;
181
149
  protected pageOfListUsers: (request: Readonly<ListUsersRequest>) => Promise<ListUsersResponse>;
182
150
  /**
183
- * List users of a Database Instance. List all users of a given Database
184
- * Instance.
151
+ * List users of a Database Instance. List all users of a given Database Instance.
185
152
  *
186
153
  * @param request - The request {@link ListUsersRequest}
187
154
  * @returns A Promise of ListUsersResponse
@@ -191,44 +158,34 @@ export declare class API extends ParentAPI {
191
158
  [Symbol.asyncIterator]: () => AsyncGenerator<User[], void, void>;
192
159
  };
193
160
  /**
194
- * Create an user on a Database Instance. Create an user on a Database
195
- * Instance. You must define the `name`, `password` of the user and
196
- * `instance_id` parameters in the request.
161
+ * Create an user on a Database Instance. Create an user on a Database Instance. You must define the `name`, `password` of the user and `instance_id` parameters in the request.
197
162
  *
198
163
  * @param request - The request {@link CreateUserRequest}
199
164
  * @returns A Promise of User
200
165
  */
201
166
  createUser: (request: Readonly<CreateUserRequest>) => Promise<User>;
202
167
  /**
203
- * Update a user on a Database Instance. Update the parameters of a user on a
204
- * Database Instance. You can update the `password` parameter, but you cannot
205
- * change the name of the user.
168
+ * Update a user on a Database Instance. Update the parameters of a user on a Database Instance. You can update the `password` parameter, but you cannot change the name of the user.
206
169
  *
207
170
  * @param request - The request {@link UpdateUserRequest}
208
171
  * @returns A Promise of User
209
172
  */
210
173
  updateUser: (request: Readonly<UpdateUserRequest>) => Promise<User>;
211
174
  /**
212
- * Delete a user on a Database Instance. Delete an existing user on a Database
213
- * Instance.
175
+ * Delete a user on a Database Instance. Delete an existing user on a Database Instance.
214
176
  *
215
177
  * @param request - The request {@link DeleteUserRequest}
216
178
  */
217
179
  deleteUser: (request: Readonly<DeleteUserRequest>) => Promise<void>;
218
180
  setUserRole: (request: Readonly<SetUserRoleRequest>) => Promise<User>;
219
181
  /**
220
- * Delete a Database Instance endpoint. Delete the endpoint of a Database
221
- * Instance. You must specify the `endpoint_id` parameter of the endpoint you
222
- * want to delete. Note that you might need to update any environment
223
- * configurations that point to the deleted endpoint.
182
+ * Delete a Database Instance endpoint. Delete the endpoint of a Database Instance. You must specify the `endpoint_id` parameter of the endpoint you want to delete. Note that you might need to update any environment configurations that point to the deleted endpoint.
224
183
  *
225
184
  * @param request - The request {@link DeleteEndpointRequest}
226
185
  */
227
186
  deleteEndpoint: (request: Readonly<DeleteEndpointRequest>) => Promise<void>;
228
187
  /**
229
- * Create a new Instance endpoint. Create a new endpoint for a MongoDB®
230
- * Database Instance. You can add `public_network` or `private_network`
231
- * specifications to the body of the request.
188
+ * Create a new Instance endpoint. Create a new endpoint for a MongoDB® Database Instance. You can add `public_network` or `private_network` specifications to the body of the request.
232
189
  *
233
190
  * @param request - The request {@link CreateEndpointRequest}
234
191
  * @returns A Promise of Endpoint
@@ -76,23 +76,14 @@ class API extends API$1 {
76
76
  unmarshalListInstancesResponse
77
77
  );
78
78
  /**
79
- * List MongoDB® Database Instances. List all MongoDB® Database Instances in
80
- * the specified region. By default, the MongoDB® Database Instances returned
81
- * in the list are ordered by creation date in ascending order, though this
82
- * can be modified via the order_by field. You can define additional
83
- * parameters for your query, such as `tags` and `name`. For the `name`
84
- * parameter, the value you include will be checked against the whole name
85
- * string to see if it includes the string you put in the parameter.
79
+ * List MongoDB® Database Instances. List all MongoDB® Database Instances in the specified region. By default, the MongoDB® Database Instances returned in the list are ordered by creation date in ascending order, though this can be modified via the order_by field. You can define additional parameters for your query, such as `tags` and `name`. For the `name` parameter, the value you include will be checked against the whole name string to see if it includes the string you put in the parameter.
86
80
  *
87
81
  * @param request - The request {@link ListInstancesRequest}
88
82
  * @returns A Promise of ListInstancesResponse
89
83
  */
90
84
  listInstances = (request = {}) => enrichForPagination("instances", this.pageOfListInstances, request);
91
85
  /**
92
- * Get a MongoDB® Database Instance. Retrieve information about a given
93
- * MongoDB® Database Instance, specified by the `region` and `instance_id`
94
- * parameters. Its full details, including name, status, IP address and port,
95
- * are returned in the response object.
86
+ * Get a MongoDB® Database Instance. Retrieve information about a given MongoDB® Database Instance, specified by the `region` and `instance_id` parameters. Its full details, including name, status, IP address and port, are returned in the response object.
96
87
  *
97
88
  * @param request - The request {@link GetInstanceRequest}
98
89
  * @returns A Promise of Instance
@@ -120,8 +111,7 @@ class API extends API$1 {
120
111
  options
121
112
  );
122
113
  /**
123
- * Create a MongoDB® Database Instance. Create a new MongoDB® Database
124
- * Instance.
114
+ * Create a MongoDB® Database Instance. Create a new MongoDB® Database Instance.
125
115
  *
126
116
  * @param request - The request {@link CreateInstanceRequest}
127
117
  * @returns A Promise of Instance
@@ -138,8 +128,7 @@ class API extends API$1 {
138
128
  unmarshalInstance
139
129
  );
140
130
  /**
141
- * Update a MongoDB® Database Instance. Update the parameters of a MongoDB®
142
- * Database Instance.
131
+ * Update a MongoDB® Database Instance. Update the parameters of a MongoDB® Database Instance.
143
132
  *
144
133
  * @param request - The request {@link UpdateInstanceRequest}
145
134
  * @returns A Promise of Instance
@@ -156,10 +145,7 @@ class API extends API$1 {
156
145
  unmarshalInstance
157
146
  );
158
147
  /**
159
- * Delete a MongoDB® Database Instance. Delete a given MongoDB® Database
160
- * Instance, specified by the `region` and `instance_id` parameters. Deleting
161
- * a MongoDB® Database Instance is permanent, and cannot be undone. Note that
162
- * upon deletion all your data will be lost.
148
+ * Delete a MongoDB® Database Instance. Delete a given MongoDB® Database Instance, specified by the `region` and `instance_id` parameters. Deleting a MongoDB® Database Instance is permanent, and cannot be undone. Note that upon deletion all your data will be lost.
163
149
  *
164
150
  * @param request - The request {@link DeleteInstanceRequest}
165
151
  * @returns A Promise of Instance
@@ -172,8 +158,7 @@ class API extends API$1 {
172
158
  unmarshalInstance
173
159
  );
174
160
  /**
175
- * Upgrade a Database Instance. Upgrade your current Database Instance
176
- * specifications like volume size.
161
+ * Upgrade a Database Instance. Upgrade your current Database Instance specifications like volume size.
177
162
  *
178
163
  * @param request - The request {@link UpgradeInstanceRequest}
179
164
  * @returns A Promise of Instance
@@ -190,8 +175,7 @@ class API extends API$1 {
190
175
  unmarshalInstance
191
176
  );
192
177
  /**
193
- * Get the certificate of a Database Instance. Retrieve the certificate of a
194
- * given Database Instance, specified by the `instance_id` parameter.
178
+ * Get the certificate of a Database Instance. Retrieve the certificate of a given Database Instance, specified by the `instance_id` parameter.
195
179
  *
196
180
  * @param request - The request {@link GetInstanceCertificateRequest}
197
181
  * @returns A Promise of Blob
@@ -203,9 +187,7 @@ class API extends API$1 {
203
187
  responseType: "blob"
204
188
  });
205
189
  /**
206
- * Create a Database Instance snapshot. Create a new snapshot of a Database
207
- * Instance. You must define the `name` and `instance_id` parameters in the
208
- * request.
190
+ * Create a Database Instance snapshot. Create a new snapshot of a Database Instance. You must define the `name` and `instance_id` parameters in the request.
209
191
  *
210
192
  * @param request - The request {@link CreateSnapshotRequest}
211
193
  * @returns A Promise of Snapshot
@@ -222,9 +204,7 @@ class API extends API$1 {
222
204
  unmarshalSnapshot
223
205
  );
224
206
  /**
225
- * Get a Database Instance snapshot. Retrieve information about a given
226
- * snapshot of a Database Instance. You must specify, in the endpoint, the
227
- * `snapshot_id` parameter of the snapshot you want to retrieve.
207
+ * Get a Database Instance snapshot. Retrieve information about a given snapshot of a Database Instance. You must specify, in the endpoint, the `snapshot_id` parameter of the snapshot you want to retrieve.
228
208
  *
229
209
  * @param request - The request {@link GetSnapshotRequest}
230
210
  * @returns A Promise of Snapshot
@@ -252,9 +232,7 @@ class API extends API$1 {
252
232
  options
253
233
  );
254
234
  /**
255
- * Update a Database Instance snapshot. Update the parameters of a snapshot of
256
- * a Database Instance. You can update the `name` and `expires_at`
257
- * parameters.
235
+ * Update a Database Instance snapshot. Update the parameters of a snapshot of a Database Instance. You can update the `name` and `expires_at` parameters.
258
236
  *
259
237
  * @param request - The request {@link UpdateSnapshotRequest}
260
238
  * @returns A Promise of Snapshot
@@ -271,11 +249,7 @@ class API extends API$1 {
271
249
  unmarshalSnapshot
272
250
  );
273
251
  /**
274
- * Restore a Database Instance snapshot. Restore a given snapshot of a
275
- * Database Instance. You must specify, in the endpoint, the `snapshot_id`
276
- * parameter of the snapshot you want to restore, the `instance_name` of the
277
- * new Database Instance, `node_type` of the new Database Instance and
278
- * `node_number` of the new Database Instance.
252
+ * Restore a Database Instance snapshot. Restore a given snapshot of a Database Instance. You must specify, in the endpoint, the `snapshot_id` parameter of the snapshot you want to restore, the `instance_name` of the new Database Instance, `node_type` of the new Database Instance and `node_number` of the new Database Instance.
279
253
  *
280
254
  * @param request - The request {@link RestoreSnapshotRequest}
281
255
  * @returns A Promise of Instance
@@ -311,20 +285,14 @@ class API extends API$1 {
311
285
  unmarshalListSnapshotsResponse
312
286
  );
313
287
  /**
314
- * List snapshots. List snapshots. You can include the `instance_id` or
315
- * `project_id` in your query to get the list of snapshots for specific
316
- * Database Instances and/or Projects. By default, the details returned in the
317
- * list are ordered by creation date in ascending order, though this can be
318
- * modified via the `order_by` field.
288
+ * List snapshots. List snapshots. You can include the `instance_id` or `project_id` in your query to get the list of snapshots for specific Database Instances and/or Projects. By default, the details returned in the list are ordered by creation date in ascending order, though this can be modified via the `order_by` field.
319
289
  *
320
290
  * @param request - The request {@link ListSnapshotsRequest}
321
291
  * @returns A Promise of ListSnapshotsResponse
322
292
  */
323
293
  listSnapshots = (request = {}) => enrichForPagination("snapshots", this.pageOfListSnapshots, request);
324
294
  /**
325
- * Delete a Database Instance snapshot. Delete a given snapshot of a Database
326
- * Instance. You must specify, in the endpoint, the `snapshot_id` parameter of
327
- * the snapshot you want to delete.
295
+ * Delete a Database Instance snapshot. Delete a given snapshot of a Database Instance. You must specify, in the endpoint, the `snapshot_id` parameter of the snapshot you want to delete.
328
296
  *
329
297
  * @param request - The request {@link DeleteSnapshotRequest}
330
298
  * @returns A Promise of Snapshot
@@ -353,17 +321,14 @@ class API extends API$1 {
353
321
  unmarshalListUsersResponse
354
322
  );
355
323
  /**
356
- * List users of a Database Instance. List all users of a given Database
357
- * Instance.
324
+ * List users of a Database Instance. List all users of a given Database Instance.
358
325
  *
359
326
  * @param request - The request {@link ListUsersRequest}
360
327
  * @returns A Promise of ListUsersResponse
361
328
  */
362
329
  listUsers = (request) => enrichForPagination("users", this.pageOfListUsers, request);
363
330
  /**
364
- * Create an user on a Database Instance. Create an user on a Database
365
- * Instance. You must define the `name`, `password` of the user and
366
- * `instance_id` parameters in the request.
331
+ * Create an user on a Database Instance. Create an user on a Database Instance. You must define the `name`, `password` of the user and `instance_id` parameters in the request.
367
332
  *
368
333
  * @param request - The request {@link CreateUserRequest}
369
334
  * @returns A Promise of User
@@ -380,9 +345,7 @@ class API extends API$1 {
380
345
  unmarshalUser
381
346
  );
382
347
  /**
383
- * Update a user on a Database Instance. Update the parameters of a user on a
384
- * Database Instance. You can update the `password` parameter, but you cannot
385
- * change the name of the user.
348
+ * Update a user on a Database Instance. Update the parameters of a user on a Database Instance. You can update the `password` parameter, but you cannot change the name of the user.
386
349
  *
387
350
  * @param request - The request {@link UpdateUserRequest}
388
351
  * @returns A Promise of User
@@ -399,8 +362,7 @@ class API extends API$1 {
399
362
  unmarshalUser
400
363
  );
401
364
  /**
402
- * Delete a user on a Database Instance. Delete an existing user on a Database
403
- * Instance.
365
+ * Delete a user on a Database Instance. Delete an existing user on a Database Instance.
404
366
  *
405
367
  * @param request - The request {@link DeleteUserRequest}
406
368
  */
@@ -422,10 +384,7 @@ class API extends API$1 {
422
384
  unmarshalUser
423
385
  );
424
386
  /**
425
- * Delete a Database Instance endpoint. Delete the endpoint of a Database
426
- * Instance. You must specify the `endpoint_id` parameter of the endpoint you
427
- * want to delete. Note that you might need to update any environment
428
- * configurations that point to the deleted endpoint.
387
+ * Delete a Database Instance endpoint. Delete the endpoint of a Database Instance. You must specify the `endpoint_id` parameter of the endpoint you want to delete. Note that you might need to update any environment configurations that point to the deleted endpoint.
429
388
  *
430
389
  * @param request - The request {@link DeleteEndpointRequest}
431
390
  */
@@ -434,9 +393,7 @@ class API extends API$1 {
434
393
  path: `/mongodb/v1alpha1/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/endpoints/${validatePathParam("endpointId", request.endpointId)}`
435
394
  });
436
395
  /**
437
- * Create a new Instance endpoint. Create a new endpoint for a MongoDB®
438
- * Database Instance. You can add `public_network` or `private_network`
439
- * specifications to the body of the request.
396
+ * Create a new Instance endpoint. Create a new endpoint for a MongoDB® Database Instance. You can add `public_network` or `private_network` specifications to the body of the request.
440
397
  *
441
398
  * @param request - The request {@link CreateEndpointRequest}
442
399
  * @returns A Promise of Endpoint