@scaleway/sdk-mongodb 1.0.1

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.
package/LICENSE ADDED
@@ -0,0 +1,191 @@
1
+
2
+ Apache License
3
+ Version 2.0, January 2004
4
+ https://www.apache.org/licenses/
5
+
6
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7
+
8
+ 1. Definitions.
9
+
10
+ "License" shall mean the terms and conditions for use, reproduction,
11
+ and distribution as defined by Sections 1 through 9 of this document.
12
+
13
+ "Licensor" shall mean the copyright owner or entity authorized by
14
+ the copyright owner that is granting the License.
15
+
16
+ "Legal Entity" shall mean the union of the acting entity and all
17
+ other entities that control, are controlled by, or are under common
18
+ control with that entity. For the purposes of this definition,
19
+ "control" means (i) the power, direct or indirect, to cause the
20
+ direction or management of such entity, whether by contract or
21
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
22
+ outstanding shares, or (iii) beneficial ownership of such entity.
23
+
24
+ "You" (or "Your") shall mean an individual or Legal Entity
25
+ exercising permissions granted by this License.
26
+
27
+ "Source" form shall mean the preferred form for making modifications,
28
+ including but not limited to software source code, documentation
29
+ source, and configuration files.
30
+
31
+ "Object" form shall mean any form resulting from mechanical
32
+ transformation or translation of a Source form, including but
33
+ not limited to compiled object code, generated documentation,
34
+ and conversions to other media types.
35
+
36
+ "Work" shall mean the work of authorship, whether in Source or
37
+ Object form, made available under the License, as indicated by a
38
+ copyright notice that is included in or attached to the work
39
+ (an example is provided in the Appendix below).
40
+
41
+ "Derivative Works" shall mean any work, whether in Source or Object
42
+ form, that is based on (or derived from) the Work and for which the
43
+ editorial revisions, annotations, elaborations, or other modifications
44
+ represent, as a whole, an original work of authorship. For the purposes
45
+ of this License, Derivative Works shall not include works that remain
46
+ separable from, or merely link (or bind by name) to the interfaces of,
47
+ the Work and Derivative Works thereof.
48
+
49
+ "Contribution" shall mean any work of authorship, including
50
+ the original version of the Work and any modifications or additions
51
+ to that Work or Derivative Works thereof, that is intentionally
52
+ submitted to Licensor for inclusion in the Work by the copyright owner
53
+ or by an individual or Legal Entity authorized to submit on behalf of
54
+ the copyright owner. For the purposes of this definition, "submitted"
55
+ means any form of electronic, verbal, or written communication sent
56
+ to the Licensor or its representatives, including but not limited to
57
+ communication on electronic mailing lists, source code control systems,
58
+ and issue tracking systems that are managed by, or on behalf of, the
59
+ Licensor for the purpose of discussing and improving the Work, but
60
+ excluding communication that is conspicuously marked or otherwise
61
+ designated in writing by the copyright owner as "Not a Contribution."
62
+
63
+ "Contributor" shall mean Licensor and any individual or Legal Entity
64
+ on behalf of whom a Contribution has been received by Licensor and
65
+ subsequently incorporated within the Work.
66
+
67
+ 2. Grant of Copyright License. Subject to the terms and conditions of
68
+ this License, each Contributor hereby grants to You a perpetual,
69
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70
+ copyright license to reproduce, prepare Derivative Works of,
71
+ publicly display, publicly perform, sublicense, and distribute the
72
+ Work and such Derivative Works in Source or Object form.
73
+
74
+ 3. Grant of Patent License. Subject to the terms and conditions of
75
+ this License, each Contributor hereby grants to You a perpetual,
76
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77
+ (except as stated in this section) patent license to make, have made,
78
+ use, offer to sell, sell, import, and otherwise transfer the Work,
79
+ where such license applies only to those patent claims licensable
80
+ by such Contributor that are necessarily infringed by their
81
+ Contribution(s) alone or by combination of their Contribution(s)
82
+ with the Work to which such Contribution(s) was submitted. If You
83
+ institute patent litigation against any entity (including a
84
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
85
+ or a Contribution incorporated within the Work constitutes direct
86
+ or contributory patent infringement, then any patent licenses
87
+ granted to You under this License for that Work shall terminate
88
+ as of the date such litigation is filed.
89
+
90
+ 4. Redistribution. You may reproduce and distribute copies of the
91
+ Work or Derivative Works thereof in any medium, with or without
92
+ modifications, and in Source or Object form, provided that You
93
+ meet the following conditions:
94
+
95
+ (a) You must give any other recipients of the Work or
96
+ Derivative Works a copy of this License; and
97
+
98
+ (b) You must cause any modified files to carry prominent notices
99
+ stating that You changed the files; and
100
+
101
+ (c) You must retain, in the Source form of any Derivative Works
102
+ that You distribute, all copyright, patent, trademark, and
103
+ attribution notices from the Source form of the Work,
104
+ excluding those notices that do not pertain to any part of
105
+ the Derivative Works; and
106
+
107
+ (d) If the Work includes a "NOTICE" text file as part of its
108
+ distribution, then any Derivative Works that You distribute must
109
+ include a readable copy of the attribution notices contained
110
+ within such NOTICE file, excluding those notices that do not
111
+ pertain to any part of the Derivative Works, in at least one
112
+ of the following places: within a NOTICE text file distributed
113
+ as part of the Derivative Works; within the Source form or
114
+ documentation, if provided along with the Derivative Works; or,
115
+ within a display generated by the Derivative Works, if and
116
+ wherever such third-party notices normally appear. The contents
117
+ of the NOTICE file are for informational purposes only and
118
+ do not modify the License. You may add Your own attribution
119
+ notices within Derivative Works that You distribute, alongside
120
+ or as an addendum to the NOTICE text from the Work, provided
121
+ that such additional attribution notices cannot be construed
122
+ as modifying the License.
123
+
124
+ You may add Your own copyright statement to Your modifications and
125
+ may provide additional or different license terms and conditions
126
+ for use, reproduction, or distribution of Your modifications, or
127
+ for any such Derivative Works as a whole, provided Your use,
128
+ reproduction, and distribution of the Work otherwise complies with
129
+ the conditions stated in this License.
130
+
131
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
132
+ any Contribution intentionally submitted for inclusion in the Work
133
+ by You to the Licensor shall be under the terms and conditions of
134
+ this License, without any additional terms or conditions.
135
+ Notwithstanding the above, nothing herein shall supersede or modify
136
+ the terms of any separate license agreement you may have executed
137
+ with Licensor regarding such Contributions.
138
+
139
+ 6. Trademarks. This License does not grant permission to use the trade
140
+ names, trademarks, service marks, or product names of the Licensor,
141
+ except as required for reasonable and customary use in describing the
142
+ origin of the Work and reproducing the content of the NOTICE file.
143
+
144
+ 7. Disclaimer of Warranty. Unless required by applicable law or
145
+ agreed to in writing, Licensor provides the Work (and each
146
+ Contributor provides its Contributions) on an "AS IS" BASIS,
147
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148
+ implied, including, without limitation, any warranties or conditions
149
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150
+ PARTICULAR PURPOSE. You are solely responsible for determining the
151
+ appropriateness of using or redistributing the Work and assume any
152
+ risks associated with Your exercise of permissions under this License.
153
+
154
+ 8. Limitation of Liability. In no event and under no legal theory,
155
+ whether in tort (including negligence), contract, or otherwise,
156
+ unless required by applicable law (such as deliberate and grossly
157
+ negligent acts) or agreed to in writing, shall any Contributor be
158
+ liable to You for damages, including any direct, indirect, special,
159
+ incidental, or consequential damages of any character arising as a
160
+ result of this License or out of the use or inability to use the
161
+ Work (including but not limited to damages for loss of goodwill,
162
+ work stoppage, computer failure or malfunction, or any and all
163
+ other commercial damages or losses), even if such Contributor
164
+ has been advised of the possibility of such damages.
165
+
166
+ 9. Accepting Warranty or Additional Liability. While redistributing
167
+ the Work or Derivative Works thereof, You may choose to offer,
168
+ and charge a fee for, acceptance of support, warranty, indemnity,
169
+ or other liability obligations and/or rights consistent with this
170
+ License. However, in accepting such obligations, You may act only
171
+ on Your own behalf and on Your sole responsibility, not on behalf
172
+ of any other Contributor, and only if You agree to indemnify,
173
+ defend, and hold each Contributor harmless for any liability
174
+ incurred by, or claims asserted against, such Contributor by reason
175
+ of your accepting any such warranty or additional liability.
176
+
177
+ END OF TERMS AND CONDITIONS
178
+
179
+ Copyright 2019 Scaleway.
180
+
181
+ Licensed under the Apache License, Version 2.0 (the "License");
182
+ you may not use this file except in compliance with the License.
183
+ You may obtain a copy of the License at
184
+
185
+ https://www.apache.org/licenses/LICENSE-2.0
186
+
187
+ Unless required by applicable law or agreed to in writing, software
188
+ distributed under the License is distributed on an "AS IS" BASIS,
189
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
190
+ See the License for the specific language governing permissions and
191
+ limitations under the License.
@@ -0,0 +1,4 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
3
+ const index_gen = require("./v1alpha1/index.gen.cjs");
4
+ exports.Mongodbv1alpha1 = index_gen;
@@ -0,0 +1,5 @@
1
+ /**
2
+ * This file is automatically generated
3
+ * PLEASE DO NOT EDIT HERE
4
+ */
5
+ export * as Mongodbv1alpha1 from './v1alpha1/index.gen';
@@ -0,0 +1,4 @@
1
+ import * as index_gen from "./v1alpha1/index.gen.js";
2
+ export {
3
+ index_gen as Mongodbv1alpha1
4
+ };
@@ -0,0 +1,410 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
3
+ const sdkClient = require("@scaleway/sdk-client");
4
+ const content_gen = require("./content.gen.cjs");
5
+ const marshalling_gen = require("./marshalling.gen.cjs");
6
+ const jsonContentHeaders = {
7
+ "Content-Type": "application/json; charset=utf-8"
8
+ };
9
+ class API extends sdkClient.API {
10
+ /** Lists the available regions of the API. */
11
+ static LOCALITIES = ["fr-par"];
12
+ pageOfListNodeTypes = (request = {}) => this.client.fetch(
13
+ {
14
+ method: "GET",
15
+ path: `/mongodb/v1alpha1/regions/${sdkClient.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/node-types`,
16
+ urlParams: sdkClient.urlParams(
17
+ ["include_disabled_types", request.includeDisabledTypes],
18
+ ["page", request.page],
19
+ [
20
+ "page_size",
21
+ request.pageSize ?? this.client.settings.defaultPageSize
22
+ ]
23
+ )
24
+ },
25
+ marshalling_gen.unmarshalListNodeTypesResponse
26
+ );
27
+ /**
28
+ * List available node types.
29
+ *
30
+ * @param request - The request {@link ListNodeTypesRequest}
31
+ * @returns A Promise of ListNodeTypesResponse
32
+ */
33
+ listNodeTypes = (request = {}) => sdkClient.enrichForPagination("nodeTypes", this.pageOfListNodeTypes, request);
34
+ pageOfListVersions = (request = {}) => this.client.fetch(
35
+ {
36
+ method: "GET",
37
+ path: `/mongodb/v1alpha1/regions/${sdkClient.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/versions`,
38
+ urlParams: sdkClient.urlParams(
39
+ ["page", request.page],
40
+ [
41
+ "page_size",
42
+ request.pageSize ?? this.client.settings.defaultPageSize
43
+ ],
44
+ ["version", request.version]
45
+ )
46
+ },
47
+ marshalling_gen.unmarshalListVersionsResponse
48
+ );
49
+ /**
50
+ * List available MongoDB® versions.
51
+ *
52
+ * @param request - The request {@link ListVersionsRequest}
53
+ * @returns A Promise of ListVersionsResponse
54
+ */
55
+ listVersions = (request = {}) => sdkClient.enrichForPagination("versions", this.pageOfListVersions, request);
56
+ pageOfListInstances = (request = {}) => this.client.fetch(
57
+ {
58
+ method: "GET",
59
+ path: `/mongodb/v1alpha1/regions/${sdkClient.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/instances`,
60
+ urlParams: sdkClient.urlParams(
61
+ ["name", request.name],
62
+ ["order_by", request.orderBy],
63
+ ["organization_id", request.organizationId],
64
+ ["page", request.page],
65
+ [
66
+ "page_size",
67
+ request.pageSize ?? this.client.settings.defaultPageSize
68
+ ],
69
+ ["project_id", request.projectId],
70
+ ["tags", request.tags]
71
+ )
72
+ },
73
+ marshalling_gen.unmarshalListInstancesResponse
74
+ );
75
+ /**
76
+ * 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.
77
+ *
78
+ * @param request - The request {@link ListInstancesRequest}
79
+ * @returns A Promise of ListInstancesResponse
80
+ */
81
+ listInstances = (request = {}) => sdkClient.enrichForPagination("instances", this.pageOfListInstances, request);
82
+ /**
83
+ * 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.
84
+ *
85
+ * @param request - The request {@link GetInstanceRequest}
86
+ * @returns A Promise of Instance
87
+ */
88
+ getInstance = (request) => this.client.fetch(
89
+ {
90
+ method: "GET",
91
+ path: `/mongodb/v1alpha1/regions/${sdkClient.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/instances/${sdkClient.validatePathParam("instanceId", request.instanceId)}`
92
+ },
93
+ marshalling_gen.unmarshalInstance
94
+ );
95
+ /**
96
+ * Waits for {@link Instance} to be in a final state.
97
+ *
98
+ * @param request - The request {@link GetInstanceRequest}
99
+ * @param options - The waiting options
100
+ * @returns A Promise of Instance
101
+ */
102
+ waitForInstance = (request, options) => sdkClient.waitForResource(
103
+ options?.stop ?? ((res) => Promise.resolve(
104
+ !content_gen.INSTANCE_TRANSIENT_STATUSES.includes(res.status)
105
+ )),
106
+ this.getInstance,
107
+ request,
108
+ options
109
+ );
110
+ /**
111
+ * Create a MongoDB® Database Instance. Create a new MongoDB® Database Instance.
112
+ *
113
+ * @param request - The request {@link CreateInstanceRequest}
114
+ * @returns A Promise of Instance
115
+ */
116
+ createInstance = (request) => this.client.fetch(
117
+ {
118
+ body: JSON.stringify(
119
+ marshalling_gen.marshalCreateInstanceRequest(request, this.client.settings)
120
+ ),
121
+ headers: jsonContentHeaders,
122
+ method: "POST",
123
+ path: `/mongodb/v1alpha1/regions/${sdkClient.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/instances`
124
+ },
125
+ marshalling_gen.unmarshalInstance
126
+ );
127
+ /**
128
+ * Update a MongoDB® Database Instance. Update the parameters of a MongoDB® Database Instance.
129
+ *
130
+ * @param request - The request {@link UpdateInstanceRequest}
131
+ * @returns A Promise of Instance
132
+ */
133
+ updateInstance = (request) => this.client.fetch(
134
+ {
135
+ body: JSON.stringify(
136
+ marshalling_gen.marshalUpdateInstanceRequest(request, this.client.settings)
137
+ ),
138
+ headers: jsonContentHeaders,
139
+ method: "PATCH",
140
+ path: `/mongodb/v1alpha1/regions/${sdkClient.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/instances/${sdkClient.validatePathParam("instanceId", request.instanceId)}`
141
+ },
142
+ marshalling_gen.unmarshalInstance
143
+ );
144
+ /**
145
+ * 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.
146
+ *
147
+ * @param request - The request {@link DeleteInstanceRequest}
148
+ * @returns A Promise of Instance
149
+ */
150
+ deleteInstance = (request) => this.client.fetch(
151
+ {
152
+ method: "DELETE",
153
+ path: `/mongodb/v1alpha1/regions/${sdkClient.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/instances/${sdkClient.validatePathParam("instanceId", request.instanceId)}`
154
+ },
155
+ marshalling_gen.unmarshalInstance
156
+ );
157
+ /**
158
+ * Upgrade a Database Instance. Upgrade your current Database Instance specifications like volume size.
159
+ *
160
+ * @param request - The request {@link UpgradeInstanceRequest}
161
+ * @returns A Promise of Instance
162
+ */
163
+ upgradeInstance = (request) => this.client.fetch(
164
+ {
165
+ body: JSON.stringify(
166
+ marshalling_gen.marshalUpgradeInstanceRequest(request, this.client.settings)
167
+ ),
168
+ headers: jsonContentHeaders,
169
+ method: "POST",
170
+ path: `/mongodb/v1alpha1/regions/${sdkClient.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/instances/${sdkClient.validatePathParam("instanceId", request.instanceId)}/upgrade`
171
+ },
172
+ marshalling_gen.unmarshalInstance
173
+ );
174
+ /**
175
+ * Get the certificate of a Database Instance. Retrieve the certificate of a given Database Instance, specified by the `instance_id` parameter.
176
+ *
177
+ * @param request - The request {@link GetInstanceCertificateRequest}
178
+ * @returns A Promise of Blob
179
+ */
180
+ getInstanceCertificate = (request) => this.client.fetch({
181
+ method: "GET",
182
+ path: `/mongodb/v1alpha1/regions/${sdkClient.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/instances/${sdkClient.validatePathParam("instanceId", request.instanceId)}/certificate`,
183
+ urlParams: sdkClient.urlParams(["dl", 1]),
184
+ responseType: "blob"
185
+ });
186
+ /**
187
+ * 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.
188
+ *
189
+ * @param request - The request {@link CreateSnapshotRequest}
190
+ * @returns A Promise of Snapshot
191
+ */
192
+ createSnapshot = (request) => this.client.fetch(
193
+ {
194
+ body: JSON.stringify(
195
+ marshalling_gen.marshalCreateSnapshotRequest(request, this.client.settings)
196
+ ),
197
+ headers: jsonContentHeaders,
198
+ method: "POST",
199
+ path: `/mongodb/v1alpha1/regions/${sdkClient.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/instances/${sdkClient.validatePathParam("instanceId", request.instanceId)}/snapshots`
200
+ },
201
+ marshalling_gen.unmarshalSnapshot
202
+ );
203
+ /**
204
+ * 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.
205
+ *
206
+ * @param request - The request {@link GetSnapshotRequest}
207
+ * @returns A Promise of Snapshot
208
+ */
209
+ getSnapshot = (request) => this.client.fetch(
210
+ {
211
+ method: "GET",
212
+ path: `/mongodb/v1alpha1/regions/${sdkClient.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/snapshots/${sdkClient.validatePathParam("snapshotId", request.snapshotId)}`
213
+ },
214
+ marshalling_gen.unmarshalSnapshot
215
+ );
216
+ /**
217
+ * Waits for {@link Snapshot} to be in a final state.
218
+ *
219
+ * @param request - The request {@link GetSnapshotRequest}
220
+ * @param options - The waiting options
221
+ * @returns A Promise of Snapshot
222
+ */
223
+ waitForSnapshot = (request, options) => sdkClient.waitForResource(
224
+ options?.stop ?? ((res) => Promise.resolve(
225
+ !content_gen.SNAPSHOT_TRANSIENT_STATUSES.includes(res.status)
226
+ )),
227
+ this.getSnapshot,
228
+ request,
229
+ options
230
+ );
231
+ /**
232
+ * Update a Database Instance snapshot. Update the parameters of a snapshot of a Database Instance. You can update the `name` and `expires_at` parameters.
233
+ *
234
+ * @param request - The request {@link UpdateSnapshotRequest}
235
+ * @returns A Promise of Snapshot
236
+ */
237
+ updateSnapshot = (request) => this.client.fetch(
238
+ {
239
+ body: JSON.stringify(
240
+ marshalling_gen.marshalUpdateSnapshotRequest(request, this.client.settings)
241
+ ),
242
+ headers: jsonContentHeaders,
243
+ method: "POST",
244
+ path: `/mongodb/v1alpha1/regions/${sdkClient.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/snapshots/${sdkClient.validatePathParam("snapshotId", request.snapshotId)}`
245
+ },
246
+ marshalling_gen.unmarshalSnapshot
247
+ );
248
+ /**
249
+ * 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.
250
+ *
251
+ * @param request - The request {@link RestoreSnapshotRequest}
252
+ * @returns A Promise of Instance
253
+ */
254
+ restoreSnapshot = (request) => this.client.fetch(
255
+ {
256
+ body: JSON.stringify(
257
+ marshalling_gen.marshalRestoreSnapshotRequest(request, this.client.settings)
258
+ ),
259
+ headers: jsonContentHeaders,
260
+ method: "POST",
261
+ path: `/mongodb/v1alpha1/regions/${sdkClient.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/snapshots/${sdkClient.validatePathParam("snapshotId", request.snapshotId)}/restore`
262
+ },
263
+ marshalling_gen.unmarshalInstance
264
+ );
265
+ pageOfListSnapshots = (request = {}) => this.client.fetch(
266
+ {
267
+ method: "GET",
268
+ path: `/mongodb/v1alpha1/regions/${sdkClient.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/snapshots`,
269
+ urlParams: sdkClient.urlParams(
270
+ ["instance_id", request.instanceId],
271
+ ["name", request.name],
272
+ ["order_by", request.orderBy],
273
+ ["organization_id", request.organizationId],
274
+ ["page", request.page],
275
+ [
276
+ "page_size",
277
+ request.pageSize ?? this.client.settings.defaultPageSize
278
+ ],
279
+ ["project_id", request.projectId]
280
+ )
281
+ },
282
+ marshalling_gen.unmarshalListSnapshotsResponse
283
+ );
284
+ /**
285
+ * 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.
286
+ *
287
+ * @param request - The request {@link ListSnapshotsRequest}
288
+ * @returns A Promise of ListSnapshotsResponse
289
+ */
290
+ listSnapshots = (request = {}) => sdkClient.enrichForPagination("snapshots", this.pageOfListSnapshots, request);
291
+ /**
292
+ * 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.
293
+ *
294
+ * @param request - The request {@link DeleteSnapshotRequest}
295
+ * @returns A Promise of Snapshot
296
+ */
297
+ deleteSnapshot = (request) => this.client.fetch(
298
+ {
299
+ method: "DELETE",
300
+ path: `/mongodb/v1alpha1/regions/${sdkClient.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/snapshots/${sdkClient.validatePathParam("snapshotId", request.snapshotId)}`
301
+ },
302
+ marshalling_gen.unmarshalSnapshot
303
+ );
304
+ pageOfListUsers = (request) => this.client.fetch(
305
+ {
306
+ method: "GET",
307
+ path: `/mongodb/v1alpha1/regions/${sdkClient.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/instances/${sdkClient.validatePathParam("instanceId", request.instanceId)}/users`,
308
+ urlParams: sdkClient.urlParams(
309
+ ["name", request.name],
310
+ ["order_by", request.orderBy],
311
+ ["page", request.page],
312
+ [
313
+ "page_size",
314
+ request.pageSize ?? this.client.settings.defaultPageSize
315
+ ]
316
+ )
317
+ },
318
+ marshalling_gen.unmarshalListUsersResponse
319
+ );
320
+ /**
321
+ * List users of a Database Instance. List all users of a given Database Instance.
322
+ *
323
+ * @param request - The request {@link ListUsersRequest}
324
+ * @returns A Promise of ListUsersResponse
325
+ */
326
+ listUsers = (request) => sdkClient.enrichForPagination("users", this.pageOfListUsers, request);
327
+ /**
328
+ * 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.
329
+ *
330
+ * @param request - The request {@link CreateUserRequest}
331
+ * @returns A Promise of User
332
+ */
333
+ createUser = (request) => this.client.fetch(
334
+ {
335
+ body: JSON.stringify(
336
+ marshalling_gen.marshalCreateUserRequest(request, this.client.settings)
337
+ ),
338
+ headers: jsonContentHeaders,
339
+ method: "POST",
340
+ path: `/mongodb/v1alpha1/regions/${sdkClient.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/instances/${sdkClient.validatePathParam("instanceId", request.instanceId)}/users`
341
+ },
342
+ marshalling_gen.unmarshalUser
343
+ );
344
+ /**
345
+ * 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.
346
+ *
347
+ * @param request - The request {@link UpdateUserRequest}
348
+ * @returns A Promise of User
349
+ */
350
+ updateUser = (request) => this.client.fetch(
351
+ {
352
+ body: JSON.stringify(
353
+ marshalling_gen.marshalUpdateUserRequest(request, this.client.settings)
354
+ ),
355
+ headers: jsonContentHeaders,
356
+ method: "PATCH",
357
+ path: `/mongodb/v1alpha1/regions/${sdkClient.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/instances/${sdkClient.validatePathParam("instanceId", request.instanceId)}/users/${sdkClient.validatePathParam("name", request.name)}`
358
+ },
359
+ marshalling_gen.unmarshalUser
360
+ );
361
+ /**
362
+ * Delete a user on a Database Instance. Delete an existing user on a Database Instance.
363
+ *
364
+ * @param request - The request {@link DeleteUserRequest}
365
+ */
366
+ deleteUser = (request) => this.client.fetch({
367
+ body: "{}",
368
+ headers: jsonContentHeaders,
369
+ method: "DELETE",
370
+ path: `/mongodb/v1alpha1/regions/${sdkClient.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/instances/${sdkClient.validatePathParam("instanceId", request.instanceId)}/users/${sdkClient.validatePathParam("name", request.name)}`
371
+ });
372
+ setUserRole = (request) => this.client.fetch(
373
+ {
374
+ body: JSON.stringify(
375
+ marshalling_gen.marshalSetUserRoleRequest(request, this.client.settings)
376
+ ),
377
+ headers: jsonContentHeaders,
378
+ method: "PUT",
379
+ path: `/mongodb/v1alpha1/regions/${sdkClient.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/instances/${sdkClient.validatePathParam("instanceId", request.instanceId)}/roles`
380
+ },
381
+ marshalling_gen.unmarshalUser
382
+ );
383
+ /**
384
+ * 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.
385
+ *
386
+ * @param request - The request {@link DeleteEndpointRequest}
387
+ */
388
+ deleteEndpoint = (request) => this.client.fetch({
389
+ method: "DELETE",
390
+ path: `/mongodb/v1alpha1/regions/${sdkClient.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/endpoints/${sdkClient.validatePathParam("endpointId", request.endpointId)}`
391
+ });
392
+ /**
393
+ * 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.
394
+ *
395
+ * @param request - The request {@link CreateEndpointRequest}
396
+ * @returns A Promise of Endpoint
397
+ */
398
+ createEndpoint = (request) => this.client.fetch(
399
+ {
400
+ body: JSON.stringify(
401
+ marshalling_gen.marshalCreateEndpointRequest(request, this.client.settings)
402
+ ),
403
+ headers: jsonContentHeaders,
404
+ method: "POST",
405
+ path: `/mongodb/v1alpha1/regions/${sdkClient.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/endpoints`
406
+ },
407
+ marshalling_gen.unmarshalEndpoint
408
+ );
409
+ }
410
+ exports.API = API;