@scaleway/sdk-mongodb 2.2.0 → 2.3.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/dist/v1/api.gen.d.ts +34 -1
- package/dist/v1/api.gen.js +96 -47
- package/dist/v1/content.gen.d.ts +3 -1
- package/dist/v1/content.gen.js +4 -0
- package/dist/v1/index.gen.d.ts +2 -2
- package/dist/v1/index.gen.js +5 -2
- package/dist/v1/marshalling.gen.d.ts +3 -1
- package/dist/v1/marshalling.gen.js +83 -13
- package/dist/v1/types.gen.d.ts +116 -1
- package/dist/v1/validation-rules.gen.d.ts +9 -0
- package/dist/v1/validation-rules.gen.js +10 -0
- package/dist/v1alpha1/api.gen.js +34 -43
- package/dist/v1alpha1/index.gen.d.ts +1 -1
- package/dist/v1alpha1/marshalling.gen.js +17 -14
- package/package.json +2 -2
package/dist/v1/api.gen.d.ts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import type { ApiLocality, WaitForOptions } from '@scaleway/sdk-client';
|
|
2
2
|
import { API as ParentAPI } from '@scaleway/sdk-client';
|
|
3
|
-
import type { CreateEndpointRequest, CreateInstanceRequest, CreateSnapshotRequest, CreateUserRequest, DeleteEndpointRequest, DeleteInstanceRequest, DeleteSnapshotRequest, DeleteUserRequest, Endpoint, GetInstanceCertificateRequest, GetInstanceRequest, GetSnapshotRequest, Instance, ListDatabasesRequest, ListDatabasesResponse, ListInstancesRequest, ListInstancesResponse, ListNodeTypesRequest, ListNodeTypesResponse, ListSnapshotsRequest, ListSnapshotsResponse, ListUsersRequest, ListUsersResponse, ListVersionsRequest, ListVersionsResponse, RestoreSnapshotRequest, SetUserRoleRequest, Snapshot, UpdateInstanceRequest, UpdateSnapshotRequest, UpdateUserRequest, UpgradeInstanceRequest, User } from './types.gen.js';
|
|
3
|
+
import type { ApplyMaintenanceRequest, CreateEndpointRequest, CreateInstanceRequest, CreateSnapshotRequest, CreateUserRequest, DeleteEndpointRequest, DeleteInstanceRequest, DeleteSnapshotRequest, DeleteUserRequest, Endpoint, GetInstanceCertificateRequest, GetInstanceRequest, GetMaintenanceRequest, GetSnapshotRequest, Instance, ListDatabasesRequest, ListDatabasesResponse, ListInstancesRequest, ListInstancesResponse, ListMaintenancesRequest, ListMaintenancesResponse, ListNodeTypesRequest, ListNodeTypesResponse, ListSnapshotsRequest, ListSnapshotsResponse, ListUsersRequest, ListUsersResponse, ListVersionsRequest, ListVersionsResponse, Maintenance, RestoreSnapshotRequest, SetUserRoleRequest, Snapshot, UpdateInstanceRequest, UpdateSnapshotRequest, UpdateUserRequest, UpgradeInstanceRequest, User } from './types.gen.js';
|
|
4
4
|
/**
|
|
5
5
|
* Managed MongoDB®.
|
|
6
6
|
|
|
@@ -211,4 +211,37 @@ export declare class API extends ParentAPI {
|
|
|
211
211
|
* @returns A Promise of Endpoint
|
|
212
212
|
*/
|
|
213
213
|
createEndpoint: (request: Readonly<CreateEndpointRequest>) => Promise<Endpoint>;
|
|
214
|
+
protected pageOfListMaintenances: (request: Readonly<ListMaintenancesRequest>) => Promise<ListMaintenancesResponse>;
|
|
215
|
+
/**
|
|
216
|
+
* List all the maintenances of a MongoDB® Database Instance.. List all the maintenances of a MongoDB® Database Instance.
|
|
217
|
+
*
|
|
218
|
+
* @param request - The request {@link ListMaintenancesRequest}
|
|
219
|
+
* @returns A Promise of ListMaintenancesResponse
|
|
220
|
+
*/
|
|
221
|
+
listMaintenances: (request: Readonly<ListMaintenancesRequest>) => Promise<ListMaintenancesResponse> & {
|
|
222
|
+
all: () => Promise<Maintenance[]>;
|
|
223
|
+
[Symbol.asyncIterator]: () => AsyncGenerator<Maintenance[], void, void>;
|
|
224
|
+
};
|
|
225
|
+
/**
|
|
226
|
+
* Get a maintenance of a MongoDB® Database Instance.. Get a maintenance of a MongoDB® Database Instance.
|
|
227
|
+
*
|
|
228
|
+
* @param request - The request {@link GetMaintenanceRequest}
|
|
229
|
+
* @returns A Promise of Maintenance
|
|
230
|
+
*/
|
|
231
|
+
getMaintenance: (request: Readonly<GetMaintenanceRequest>) => Promise<Maintenance>;
|
|
232
|
+
/**
|
|
233
|
+
* Waits for {@link Maintenance} to be in a final state.
|
|
234
|
+
*
|
|
235
|
+
* @param request - The request {@link GetMaintenanceRequest}
|
|
236
|
+
* @param options - The waiting options
|
|
237
|
+
* @returns A Promise of Maintenance
|
|
238
|
+
*/
|
|
239
|
+
waitForMaintenance: (request: Readonly<GetMaintenanceRequest>, options?: Readonly<WaitForOptions<Maintenance>>) => Promise<Maintenance>;
|
|
240
|
+
/**
|
|
241
|
+
* Apply a maintenance of a MongoDB® Database Instance.. Apply a maintenance of a MongoDB® Database Instance.
|
|
242
|
+
*
|
|
243
|
+
* @param request - The request {@link ApplyMaintenanceRequest}
|
|
244
|
+
* @returns A Promise of Maintenance
|
|
245
|
+
*/
|
|
246
|
+
applyMaintenance: (request: Readonly<ApplyMaintenanceRequest>) => Promise<Maintenance>;
|
|
214
247
|
}
|
package/dist/v1/api.gen.js
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { API as API$1, toApiLocality, urlParams, validatePathParam, enrichForPagination, waitForResource } from "@scaleway/sdk-client";
|
|
2
|
-
import { INSTANCE_TRANSIENT_STATUSES, SNAPSHOT_TRANSIENT_STATUSES } from "./content.gen.js";
|
|
3
|
-
import { unmarshalListNodeTypesResponse, unmarshalListVersionsResponse, unmarshalListInstancesResponse, unmarshalInstance, marshalCreateInstanceRequest, marshalUpdateInstanceRequest, marshalUpgradeInstanceRequest, marshalCreateSnapshotRequest, unmarshalSnapshot, marshalUpdateSnapshotRequest, marshalRestoreSnapshotRequest, unmarshalListSnapshotsResponse, unmarshalListUsersResponse, marshalCreateUserRequest, unmarshalUser, marshalUpdateUserRequest, marshalSetUserRoleRequest, unmarshalListDatabasesResponse, marshalCreateEndpointRequest, unmarshalEndpoint } from "./marshalling.gen.js";
|
|
2
|
+
import { INSTANCE_TRANSIENT_STATUSES, SNAPSHOT_TRANSIENT_STATUSES, MAINTENANCE_TRANSIENT_STATUSES } from "./content.gen.js";
|
|
3
|
+
import { unmarshalListNodeTypesResponse, unmarshalListVersionsResponse, unmarshalListInstancesResponse, unmarshalInstance, marshalCreateInstanceRequest, marshalUpdateInstanceRequest, marshalUpgradeInstanceRequest, marshalCreateSnapshotRequest, unmarshalSnapshot, marshalUpdateSnapshotRequest, marshalRestoreSnapshotRequest, unmarshalListSnapshotsResponse, unmarshalListUsersResponse, marshalCreateUserRequest, unmarshalUser, marshalUpdateUserRequest, marshalSetUserRoleRequest, unmarshalListDatabasesResponse, marshalCreateEndpointRequest, unmarshalEndpoint, unmarshalListMaintenancesResponse, unmarshalMaintenance } from "./marshalling.gen.js";
|
|
4
4
|
const jsonContentHeaders = {
|
|
5
5
|
"Content-Type": "application/json; charset=utf-8"
|
|
6
6
|
};
|
|
@@ -10,7 +10,9 @@ class API extends API$1 {
|
|
|
10
10
|
* type ∈ {'zone','region','global','unspecified'}
|
|
11
11
|
*/
|
|
12
12
|
static LOCALITY = toApiLocality({
|
|
13
|
-
regions: [
|
|
13
|
+
regions: [
|
|
14
|
+
"fr-par"
|
|
15
|
+
]
|
|
14
16
|
});
|
|
15
17
|
pageOfListNodeTypes = (request = {}) => this.client.fetch(
|
|
16
18
|
{
|
|
@@ -19,10 +21,7 @@ class API extends API$1 {
|
|
|
19
21
|
urlParams: urlParams(
|
|
20
22
|
["include_disabled", request.includeDisabled],
|
|
21
23
|
["page", request.page],
|
|
22
|
-
[
|
|
23
|
-
"page_size",
|
|
24
|
-
request.pageSize ?? this.client.settings.defaultPageSize
|
|
25
|
-
]
|
|
24
|
+
["page_size", request.pageSize ?? this.client.settings.defaultPageSize]
|
|
26
25
|
)
|
|
27
26
|
},
|
|
28
27
|
unmarshalListNodeTypesResponse
|
|
@@ -40,10 +39,7 @@ class API extends API$1 {
|
|
|
40
39
|
path: `/mongodb/v1/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/versions`,
|
|
41
40
|
urlParams: urlParams(
|
|
42
41
|
["page", request.page],
|
|
43
|
-
[
|
|
44
|
-
"page_size",
|
|
45
|
-
request.pageSize ?? this.client.settings.defaultPageSize
|
|
46
|
-
],
|
|
42
|
+
["page_size", request.pageSize ?? this.client.settings.defaultPageSize],
|
|
47
43
|
["version", request.version]
|
|
48
44
|
)
|
|
49
45
|
},
|
|
@@ -65,10 +61,7 @@ class API extends API$1 {
|
|
|
65
61
|
["order_by", request.orderBy],
|
|
66
62
|
["organization_id", request.organizationId],
|
|
67
63
|
["page", request.page],
|
|
68
|
-
[
|
|
69
|
-
"page_size",
|
|
70
|
-
request.pageSize ?? this.client.settings.defaultPageSize
|
|
71
|
-
],
|
|
64
|
+
["page_size", request.pageSize ?? this.client.settings.defaultPageSize],
|
|
72
65
|
["project_id", request.projectId],
|
|
73
66
|
["tags", request.tags]
|
|
74
67
|
)
|
|
@@ -103,9 +96,7 @@ class API extends API$1 {
|
|
|
103
96
|
* @returns A Promise of Instance
|
|
104
97
|
*/
|
|
105
98
|
waitForInstance = (request, options) => waitForResource(
|
|
106
|
-
options?.stop ?? ((res) => Promise.resolve(
|
|
107
|
-
!INSTANCE_TRANSIENT_STATUSES.includes(res.status)
|
|
108
|
-
)),
|
|
99
|
+
options?.stop ?? ((res) => Promise.resolve(!INSTANCE_TRANSIENT_STATUSES.includes(res.status))),
|
|
109
100
|
this.getInstance,
|
|
110
101
|
request,
|
|
111
102
|
options
|
|
@@ -180,12 +171,16 @@ class API extends API$1 {
|
|
|
180
171
|
* @param request - The request {@link GetInstanceCertificateRequest}
|
|
181
172
|
* @returns A Promise of Blob
|
|
182
173
|
*/
|
|
183
|
-
getInstanceCertificate = (request) => this.client.fetch(
|
|
184
|
-
|
|
185
|
-
|
|
186
|
-
|
|
187
|
-
|
|
188
|
-
|
|
174
|
+
getInstanceCertificate = (request) => this.client.fetch(
|
|
175
|
+
{
|
|
176
|
+
method: "GET",
|
|
177
|
+
path: `/mongodb/v1/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/instances/${validatePathParam("instanceId", request.instanceId)}/certificate`,
|
|
178
|
+
urlParams: urlParams(
|
|
179
|
+
["dl", 1]
|
|
180
|
+
),
|
|
181
|
+
responseType: "blob"
|
|
182
|
+
}
|
|
183
|
+
);
|
|
189
184
|
/**
|
|
190
185
|
* 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.
|
|
191
186
|
*
|
|
@@ -224,9 +219,7 @@ class API extends API$1 {
|
|
|
224
219
|
* @returns A Promise of Snapshot
|
|
225
220
|
*/
|
|
226
221
|
waitForSnapshot = (request, options) => waitForResource(
|
|
227
|
-
options?.stop ?? ((res) => Promise.resolve(
|
|
228
|
-
!SNAPSHOT_TRANSIENT_STATUSES.includes(res.status)
|
|
229
|
-
)),
|
|
222
|
+
options?.stop ?? ((res) => Promise.resolve(!SNAPSHOT_TRANSIENT_STATUSES.includes(res.status))),
|
|
230
223
|
this.getSnapshot,
|
|
231
224
|
request,
|
|
232
225
|
options
|
|
@@ -275,10 +268,7 @@ class API extends API$1 {
|
|
|
275
268
|
["order_by", request.orderBy],
|
|
276
269
|
["organization_id", request.organizationId],
|
|
277
270
|
["page", request.page],
|
|
278
|
-
[
|
|
279
|
-
"page_size",
|
|
280
|
-
request.pageSize ?? this.client.settings.defaultPageSize
|
|
281
|
-
],
|
|
271
|
+
["page_size", request.pageSize ?? this.client.settings.defaultPageSize],
|
|
282
272
|
["project_id", request.projectId]
|
|
283
273
|
)
|
|
284
274
|
},
|
|
@@ -312,10 +302,7 @@ class API extends API$1 {
|
|
|
312
302
|
["name", request.name],
|
|
313
303
|
["order_by", request.orderBy],
|
|
314
304
|
["page", request.page],
|
|
315
|
-
[
|
|
316
|
-
"page_size",
|
|
317
|
-
request.pageSize ?? this.client.settings.defaultPageSize
|
|
318
|
-
]
|
|
305
|
+
["page_size", request.pageSize ?? this.client.settings.defaultPageSize]
|
|
319
306
|
)
|
|
320
307
|
},
|
|
321
308
|
unmarshalListUsersResponse
|
|
@@ -366,10 +353,12 @@ class API extends API$1 {
|
|
|
366
353
|
*
|
|
367
354
|
* @param request - The request {@link DeleteUserRequest}
|
|
368
355
|
*/
|
|
369
|
-
deleteUser = (request) => this.client.fetch(
|
|
370
|
-
|
|
371
|
-
|
|
372
|
-
|
|
356
|
+
deleteUser = (request) => this.client.fetch(
|
|
357
|
+
{
|
|
358
|
+
method: "DELETE",
|
|
359
|
+
path: `/mongodb/v1/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/instances/${validatePathParam("instanceId", request.instanceId)}/users/${validatePathParam("name", request.name)}`
|
|
360
|
+
}
|
|
361
|
+
);
|
|
373
362
|
/**
|
|
374
363
|
* Apply user roles. Apply preset roles for a user in a Database Instance.
|
|
375
364
|
*
|
|
@@ -394,10 +383,7 @@ class API extends API$1 {
|
|
|
394
383
|
urlParams: urlParams(
|
|
395
384
|
["order_by", request.orderBy],
|
|
396
385
|
["page", request.page],
|
|
397
|
-
[
|
|
398
|
-
"page_size",
|
|
399
|
-
request.pageSize ?? this.client.settings.defaultPageSize
|
|
400
|
-
]
|
|
386
|
+
["page_size", request.pageSize ?? this.client.settings.defaultPageSize]
|
|
401
387
|
)
|
|
402
388
|
},
|
|
403
389
|
unmarshalListDatabasesResponse
|
|
@@ -414,10 +400,12 @@ class API extends API$1 {
|
|
|
414
400
|
*
|
|
415
401
|
* @param request - The request {@link DeleteEndpointRequest}
|
|
416
402
|
*/
|
|
417
|
-
deleteEndpoint = (request) => this.client.fetch(
|
|
418
|
-
|
|
419
|
-
|
|
420
|
-
|
|
403
|
+
deleteEndpoint = (request) => this.client.fetch(
|
|
404
|
+
{
|
|
405
|
+
method: "DELETE",
|
|
406
|
+
path: `/mongodb/v1/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/endpoints/${validatePathParam("endpointId", request.endpointId)}`
|
|
407
|
+
}
|
|
408
|
+
);
|
|
421
409
|
/**
|
|
422
410
|
* 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.
|
|
423
411
|
*
|
|
@@ -435,6 +423,67 @@ class API extends API$1 {
|
|
|
435
423
|
},
|
|
436
424
|
unmarshalEndpoint
|
|
437
425
|
);
|
|
426
|
+
pageOfListMaintenances = (request) => this.client.fetch(
|
|
427
|
+
{
|
|
428
|
+
method: "GET",
|
|
429
|
+
path: `/mongodb/v1/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/maintenances`,
|
|
430
|
+
urlParams: urlParams(
|
|
431
|
+
["instance_id", request.instanceId],
|
|
432
|
+
["order_by", request.orderBy],
|
|
433
|
+
["page", request.page],
|
|
434
|
+
["page_size", request.pageSize ?? this.client.settings.defaultPageSize]
|
|
435
|
+
)
|
|
436
|
+
},
|
|
437
|
+
unmarshalListMaintenancesResponse
|
|
438
|
+
);
|
|
439
|
+
/**
|
|
440
|
+
* List all the maintenances of a MongoDB® Database Instance.. List all the maintenances of a MongoDB® Database Instance.
|
|
441
|
+
*
|
|
442
|
+
* @param request - The request {@link ListMaintenancesRequest}
|
|
443
|
+
* @returns A Promise of ListMaintenancesResponse
|
|
444
|
+
*/
|
|
445
|
+
listMaintenances = (request) => enrichForPagination("maintenances", this.pageOfListMaintenances, request);
|
|
446
|
+
/**
|
|
447
|
+
* Get a maintenance of a MongoDB® Database Instance.. Get a maintenance of a MongoDB® Database Instance.
|
|
448
|
+
*
|
|
449
|
+
* @param request - The request {@link GetMaintenanceRequest}
|
|
450
|
+
* @returns A Promise of Maintenance
|
|
451
|
+
*/
|
|
452
|
+
getMaintenance = (request) => this.client.fetch(
|
|
453
|
+
{
|
|
454
|
+
method: "GET",
|
|
455
|
+
path: `/mongodb/v1/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/maintenances/${validatePathParam("maintenanceId", request.maintenanceId)}`
|
|
456
|
+
},
|
|
457
|
+
unmarshalMaintenance
|
|
458
|
+
);
|
|
459
|
+
/**
|
|
460
|
+
* Waits for {@link Maintenance} to be in a final state.
|
|
461
|
+
*
|
|
462
|
+
* @param request - The request {@link GetMaintenanceRequest}
|
|
463
|
+
* @param options - The waiting options
|
|
464
|
+
* @returns A Promise of Maintenance
|
|
465
|
+
*/
|
|
466
|
+
waitForMaintenance = (request, options) => waitForResource(
|
|
467
|
+
options?.stop ?? ((res) => Promise.resolve(!MAINTENANCE_TRANSIENT_STATUSES.includes(res.status))),
|
|
468
|
+
this.getMaintenance,
|
|
469
|
+
request,
|
|
470
|
+
options
|
|
471
|
+
);
|
|
472
|
+
/**
|
|
473
|
+
* Apply a maintenance of a MongoDB® Database Instance.. Apply a maintenance of a MongoDB® Database Instance.
|
|
474
|
+
*
|
|
475
|
+
* @param request - The request {@link ApplyMaintenanceRequest}
|
|
476
|
+
* @returns A Promise of Maintenance
|
|
477
|
+
*/
|
|
478
|
+
applyMaintenance = (request) => this.client.fetch(
|
|
479
|
+
{
|
|
480
|
+
body: "{}",
|
|
481
|
+
headers: jsonContentHeaders,
|
|
482
|
+
method: "POST",
|
|
483
|
+
path: `/mongodb/v1/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/maintenances/${validatePathParam("maintenanceId", request.maintenanceId)}/apply`
|
|
484
|
+
},
|
|
485
|
+
unmarshalMaintenance
|
|
486
|
+
);
|
|
438
487
|
}
|
|
439
488
|
export {
|
|
440
489
|
API
|
package/dist/v1/content.gen.d.ts
CHANGED
|
@@ -1,5 +1,7 @@
|
|
|
1
|
-
import type { InstanceStatus, SnapshotStatus } from './types.gen.js';
|
|
1
|
+
import type { InstanceStatus, MaintenanceStatus, SnapshotStatus } from './types.gen.js';
|
|
2
2
|
/** Lists transient statutes of the enum {@link InstanceStatus}. */
|
|
3
3
|
export declare const INSTANCE_TRANSIENT_STATUSES: InstanceStatus[];
|
|
4
|
+
/** Lists transient statutes of the enum {@link MaintenanceStatus}. */
|
|
5
|
+
export declare const MAINTENANCE_TRANSIENT_STATUSES: MaintenanceStatus[];
|
|
4
6
|
/** Lists transient statutes of the enum {@link SnapshotStatus}. */
|
|
5
7
|
export declare const SNAPSHOT_TRANSIENT_STATUSES: SnapshotStatus[];
|
package/dist/v1/content.gen.js
CHANGED
|
@@ -5,6 +5,9 @@ const INSTANCE_TRANSIENT_STATUSES = [
|
|
|
5
5
|
"initializing",
|
|
6
6
|
"snapshotting"
|
|
7
7
|
];
|
|
8
|
+
const MAINTENANCE_TRANSIENT_STATUSES = [
|
|
9
|
+
"ongoing"
|
|
10
|
+
];
|
|
8
11
|
const SNAPSHOT_TRANSIENT_STATUSES = [
|
|
9
12
|
"creating",
|
|
10
13
|
"restoring",
|
|
@@ -12,5 +15,6 @@ const SNAPSHOT_TRANSIENT_STATUSES = [
|
|
|
12
15
|
];
|
|
13
16
|
export {
|
|
14
17
|
INSTANCE_TRANSIENT_STATUSES,
|
|
18
|
+
MAINTENANCE_TRANSIENT_STATUSES,
|
|
15
19
|
SNAPSHOT_TRANSIENT_STATUSES
|
|
16
20
|
};
|
package/dist/v1/index.gen.d.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
export { API } from './api.gen.js';
|
|
1
|
+
export { API, } from './api.gen.js';
|
|
2
2
|
export * from './content.gen.js';
|
|
3
3
|
export * from './marshalling.gen.js';
|
|
4
|
-
export type { CreateEndpointRequest, CreateInstanceRequest, CreateSnapshotRequest, CreateUserRequest, Database, DeleteEndpointRequest, DeleteInstanceRequest, DeleteSnapshotRequest, DeleteUserRequest, Endpoint, EndpointPrivateNetworkDetails, EndpointPublicNetworkDetails, EndpointSpec, EndpointSpecPrivateNetworkDetails, EndpointSpecPublicNetworkDetails, GetInstanceCertificateRequest, GetInstanceRequest, GetSnapshotRequest, Instance, InstanceSnapshotSchedule, InstanceStatus, ListDatabasesRequest, ListDatabasesRequestOrderBy, ListDatabasesResponse, ListInstancesRequest, ListInstancesRequestOrderBy, ListInstancesResponse, ListNodeTypesRequest, ListNodeTypesResponse, ListSnapshotsRequest, ListSnapshotsRequestOrderBy, ListSnapshotsResponse, ListUsersRequest, ListUsersRequestOrderBy, ListUsersResponse, ListVersionsRequest, ListVersionsResponse, NodeType, NodeTypeStock, NodeTypeVolumeType, RestoreSnapshotRequest, SetUserRoleRequest, Snapshot, SnapshotStatus, UpdateInstanceRequest, UpdateSnapshotRequest, UpdateUserRequest, UpgradeInstanceRequest, User, UserRole, UserRoleRole, Version, Volume, VolumeType, } from './types.gen.js';
|
|
4
|
+
export type { ApplyMaintenanceRequest, CreateEndpointRequest, CreateInstanceRequest, CreateSnapshotRequest, CreateUserRequest, Database, DeleteEndpointRequest, DeleteInstanceRequest, DeleteSnapshotRequest, DeleteUserRequest, Endpoint, EndpointPrivateNetworkDetails, EndpointPublicNetworkDetails, EndpointSpec, EndpointSpecPrivateNetworkDetails, EndpointSpecPublicNetworkDetails, EngineUpgrade, GetInstanceCertificateRequest, GetInstanceRequest, GetMaintenanceRequest, GetSnapshotRequest, Instance, InstanceSnapshotSchedule, InstanceStatus, ListDatabasesRequest, ListDatabasesRequestOrderBy, ListDatabasesResponse, ListInstancesRequest, ListInstancesRequestOrderBy, ListInstancesResponse, ListMaintenancesRequest, ListMaintenancesRequestOrderBy, ListMaintenancesResponse, ListNodeTypesRequest, ListNodeTypesResponse, ListSnapshotsRequest, ListSnapshotsRequestOrderBy, ListSnapshotsResponse, ListUsersRequest, ListUsersRequestOrderBy, ListUsersResponse, ListVersionsRequest, ListVersionsResponse, Maintenance, MaintenanceAppliedBy, MaintenanceStatus, NodeType, NodeTypeStock, NodeTypeVolumeType, RestoreSnapshotRequest, ServiceUpdate, SetUserRoleRequest, Snapshot, SnapshotStatus, UpdateInstanceRequest, UpdateSnapshotRequest, UpdateUserRequest, UpgradeInstanceRequest, User, UserRole, UserRoleRole, Version, Volume, VolumeType, Workflow, } from './types.gen.js';
|
|
5
5
|
export * as ValidationRules from './validation-rules.gen.js';
|
package/dist/v1/index.gen.js
CHANGED
|
@@ -1,10 +1,11 @@
|
|
|
1
1
|
import { API } from "./api.gen.js";
|
|
2
|
-
import { INSTANCE_TRANSIENT_STATUSES, SNAPSHOT_TRANSIENT_STATUSES } from "./content.gen.js";
|
|
3
|
-
import { marshalCreateEndpointRequest, marshalCreateInstanceRequest, marshalCreateSnapshotRequest, marshalCreateUserRequest, marshalRestoreSnapshotRequest, marshalSetUserRoleRequest, marshalUpdateInstanceRequest, marshalUpdateSnapshotRequest, marshalUpdateUserRequest, marshalUpgradeInstanceRequest, unmarshalEndpoint, unmarshalInstance, unmarshalListDatabasesResponse, unmarshalListInstancesResponse, unmarshalListNodeTypesResponse, unmarshalListSnapshotsResponse, unmarshalListUsersResponse, unmarshalListVersionsResponse, unmarshalSnapshot, unmarshalUser } from "./marshalling.gen.js";
|
|
2
|
+
import { INSTANCE_TRANSIENT_STATUSES, MAINTENANCE_TRANSIENT_STATUSES, SNAPSHOT_TRANSIENT_STATUSES } from "./content.gen.js";
|
|
3
|
+
import { marshalCreateEndpointRequest, marshalCreateInstanceRequest, marshalCreateSnapshotRequest, marshalCreateUserRequest, marshalRestoreSnapshotRequest, marshalSetUserRoleRequest, marshalUpdateInstanceRequest, marshalUpdateSnapshotRequest, marshalUpdateUserRequest, marshalUpgradeInstanceRequest, unmarshalEndpoint, unmarshalInstance, unmarshalListDatabasesResponse, unmarshalListInstancesResponse, unmarshalListMaintenancesResponse, unmarshalListNodeTypesResponse, unmarshalListSnapshotsResponse, unmarshalListUsersResponse, unmarshalListVersionsResponse, unmarshalMaintenance, unmarshalSnapshot, unmarshalUser } from "./marshalling.gen.js";
|
|
4
4
|
import * as validationRules_gen from "./validation-rules.gen.js";
|
|
5
5
|
export {
|
|
6
6
|
API,
|
|
7
7
|
INSTANCE_TRANSIENT_STATUSES,
|
|
8
|
+
MAINTENANCE_TRANSIENT_STATUSES,
|
|
8
9
|
SNAPSHOT_TRANSIENT_STATUSES,
|
|
9
10
|
validationRules_gen as ValidationRules,
|
|
10
11
|
marshalCreateEndpointRequest,
|
|
@@ -21,10 +22,12 @@ export {
|
|
|
21
22
|
unmarshalInstance,
|
|
22
23
|
unmarshalListDatabasesResponse,
|
|
23
24
|
unmarshalListInstancesResponse,
|
|
25
|
+
unmarshalListMaintenancesResponse,
|
|
24
26
|
unmarshalListNodeTypesResponse,
|
|
25
27
|
unmarshalListSnapshotsResponse,
|
|
26
28
|
unmarshalListUsersResponse,
|
|
27
29
|
unmarshalListVersionsResponse,
|
|
30
|
+
unmarshalMaintenance,
|
|
28
31
|
unmarshalSnapshot,
|
|
29
32
|
unmarshalUser
|
|
30
33
|
};
|
|
@@ -1,11 +1,13 @@
|
|
|
1
1
|
import type { DefaultValues } from '@scaleway/sdk-client';
|
|
2
|
-
import type { CreateEndpointRequest, CreateInstanceRequest, CreateSnapshotRequest, CreateUserRequest, Endpoint, Instance, ListDatabasesResponse, ListInstancesResponse, ListNodeTypesResponse, ListSnapshotsResponse, ListUsersResponse, ListVersionsResponse, RestoreSnapshotRequest, SetUserRoleRequest, Snapshot, UpdateInstanceRequest, UpdateSnapshotRequest, UpdateUserRequest, UpgradeInstanceRequest, User } from './types.gen.js';
|
|
2
|
+
import type { CreateEndpointRequest, CreateInstanceRequest, CreateSnapshotRequest, CreateUserRequest, Endpoint, Instance, ListDatabasesResponse, ListInstancesResponse, ListMaintenancesResponse, ListNodeTypesResponse, ListSnapshotsResponse, ListUsersResponse, ListVersionsResponse, Maintenance, RestoreSnapshotRequest, SetUserRoleRequest, Snapshot, UpdateInstanceRequest, UpdateSnapshotRequest, UpdateUserRequest, UpgradeInstanceRequest, User } from './types.gen.js';
|
|
3
3
|
export declare const unmarshalEndpoint: (data: unknown) => Endpoint;
|
|
4
4
|
export declare const unmarshalInstance: (data: unknown) => Instance;
|
|
5
|
+
export declare const unmarshalMaintenance: (data: unknown) => Maintenance;
|
|
5
6
|
export declare const unmarshalSnapshot: (data: unknown) => Snapshot;
|
|
6
7
|
export declare const unmarshalUser: (data: unknown) => User;
|
|
7
8
|
export declare const unmarshalListDatabasesResponse: (data: unknown) => ListDatabasesResponse;
|
|
8
9
|
export declare const unmarshalListInstancesResponse: (data: unknown) => ListInstancesResponse;
|
|
10
|
+
export declare const unmarshalListMaintenancesResponse: (data: unknown) => ListMaintenancesResponse;
|
|
9
11
|
export declare const unmarshalListNodeTypesResponse: (data: unknown) => ListNodeTypesResponse;
|
|
10
12
|
export declare const unmarshalListSnapshotsResponse: (data: unknown) => ListSnapshotsResponse;
|
|
11
13
|
export declare const unmarshalListUsersResponse: (data: unknown) => ListUsersResponse;
|
|
@@ -80,6 +80,57 @@ const unmarshalInstance = (data) => {
|
|
|
80
80
|
volume: data.volume ? unmarshalVolume(data.volume) : void 0
|
|
81
81
|
};
|
|
82
82
|
};
|
|
83
|
+
const unmarshalEngineUpgrade = (data) => {
|
|
84
|
+
if (!isJSONObject(data)) {
|
|
85
|
+
throw new TypeError(
|
|
86
|
+
`Unmarshalling the type 'EngineUpgrade' failed as data isn't a dictionary.`
|
|
87
|
+
);
|
|
88
|
+
}
|
|
89
|
+
return {
|
|
90
|
+
newVersionId: data.new_version_id
|
|
91
|
+
};
|
|
92
|
+
};
|
|
93
|
+
const unmarshalServiceUpdate = (data) => {
|
|
94
|
+
if (!isJSONObject(data)) {
|
|
95
|
+
throw new TypeError(
|
|
96
|
+
`Unmarshalling the type 'ServiceUpdate' failed as data isn't a dictionary.`
|
|
97
|
+
);
|
|
98
|
+
}
|
|
99
|
+
return {
|
|
100
|
+
serviceName: data.service_name
|
|
101
|
+
};
|
|
102
|
+
};
|
|
103
|
+
const unmarshalWorkflow = (data) => {
|
|
104
|
+
if (!isJSONObject(data)) {
|
|
105
|
+
throw new TypeError(
|
|
106
|
+
`Unmarshalling the type 'Workflow' failed as data isn't a dictionary.`
|
|
107
|
+
);
|
|
108
|
+
}
|
|
109
|
+
return {
|
|
110
|
+
engineUpgrade: data.engine_upgrade ? unmarshalEngineUpgrade(data.engine_upgrade) : void 0,
|
|
111
|
+
serviceUpdate: data.service_update ? unmarshalServiceUpdate(data.service_update) : void 0
|
|
112
|
+
};
|
|
113
|
+
};
|
|
114
|
+
const unmarshalMaintenance = (data) => {
|
|
115
|
+
if (!isJSONObject(data)) {
|
|
116
|
+
throw new TypeError(
|
|
117
|
+
`Unmarshalling the type 'Maintenance' failed as data isn't a dictionary.`
|
|
118
|
+
);
|
|
119
|
+
}
|
|
120
|
+
return {
|
|
121
|
+
appliedAt: unmarshalDate(data.applied_at),
|
|
122
|
+
appliedBy: data.applied_by,
|
|
123
|
+
createdAt: unmarshalDate(data.created_at),
|
|
124
|
+
forcedAt: unmarshalDate(data.forced_at),
|
|
125
|
+
id: data.id,
|
|
126
|
+
instanceId: data.instance_id,
|
|
127
|
+
reason: data.reason,
|
|
128
|
+
startsAt: unmarshalDate(data.starts_at),
|
|
129
|
+
status: data.status,
|
|
130
|
+
stopsAt: unmarshalDate(data.stops_at),
|
|
131
|
+
workflow: data.workflow ? unmarshalWorkflow(data.workflow) : void 0
|
|
132
|
+
};
|
|
133
|
+
};
|
|
83
134
|
const unmarshalSnapshot = (data) => {
|
|
84
135
|
if (!isJSONObject(data)) {
|
|
85
136
|
throw new TypeError(
|
|
@@ -156,6 +207,17 @@ const unmarshalListInstancesResponse = (data) => {
|
|
|
156
207
|
totalCount: data.total_count
|
|
157
208
|
};
|
|
158
209
|
};
|
|
210
|
+
const unmarshalListMaintenancesResponse = (data) => {
|
|
211
|
+
if (!isJSONObject(data)) {
|
|
212
|
+
throw new TypeError(
|
|
213
|
+
`Unmarshalling the type 'ListMaintenancesResponse' failed as data isn't a dictionary.`
|
|
214
|
+
);
|
|
215
|
+
}
|
|
216
|
+
return {
|
|
217
|
+
maintenances: unmarshalArrayOfObject(data.maintenances, unmarshalMaintenance),
|
|
218
|
+
totalCount: data.total_count
|
|
219
|
+
};
|
|
220
|
+
};
|
|
159
221
|
const unmarshalNodeTypeVolumeType = (data) => {
|
|
160
222
|
if (!isJSONObject(data)) {
|
|
161
223
|
throw new TypeError(
|
|
@@ -177,10 +239,7 @@ const unmarshalNodeType = (data) => {
|
|
|
177
239
|
);
|
|
178
240
|
}
|
|
179
241
|
return {
|
|
180
|
-
availableVolumeTypes: unmarshalArrayOfObject(
|
|
181
|
-
data.available_volume_types,
|
|
182
|
-
unmarshalNodeTypeVolumeType
|
|
183
|
-
),
|
|
242
|
+
availableVolumeTypes: unmarshalArrayOfObject(data.available_volume_types, unmarshalNodeTypeVolumeType),
|
|
184
243
|
beta: data.beta,
|
|
185
244
|
description: data.description,
|
|
186
245
|
disabled: data.disabled,
|
|
@@ -254,15 +313,11 @@ const marshalEndpointSpec = (request, defaults) => ({
|
|
|
254
313
|
...resolveOneOf([
|
|
255
314
|
{
|
|
256
315
|
param: "public_network",
|
|
257
|
-
value: request.publicNetwork !== void 0 ? marshalEndpointSpecPublicNetworkDetails(
|
|
258
|
-
request.publicNetwork
|
|
259
|
-
) : void 0
|
|
316
|
+
value: request.publicNetwork !== void 0 ? marshalEndpointSpecPublicNetworkDetails(request.publicNetwork) : void 0
|
|
260
317
|
},
|
|
261
318
|
{
|
|
262
319
|
param: "private_network",
|
|
263
|
-
value: request.privateNetwork !== void 0 ? marshalEndpointSpecPrivateNetworkDetails(
|
|
264
|
-
request.privateNetwork
|
|
265
|
-
) : void 0
|
|
320
|
+
value: request.privateNetwork !== void 0 ? marshalEndpointSpecPrivateNetworkDetails(request.privateNetwork) : void 0
|
|
266
321
|
}
|
|
267
322
|
])
|
|
268
323
|
});
|
|
@@ -304,8 +359,14 @@ const marshalRestoreSnapshotRequest = (request, defaults) => ({
|
|
|
304
359
|
const marshalUserRole = (request, defaults) => ({
|
|
305
360
|
role: request.role,
|
|
306
361
|
...resolveOneOf([
|
|
307
|
-
{
|
|
308
|
-
|
|
362
|
+
{
|
|
363
|
+
param: "database_name",
|
|
364
|
+
value: request.databaseName
|
|
365
|
+
},
|
|
366
|
+
{
|
|
367
|
+
param: "any_database",
|
|
368
|
+
value: request.anyDatabase
|
|
369
|
+
}
|
|
309
370
|
])
|
|
310
371
|
});
|
|
311
372
|
const marshalSetUserRoleRequest = (request, defaults) => ({
|
|
@@ -328,7 +389,14 @@ const marshalUpdateUserRequest = (request, defaults) => ({
|
|
|
328
389
|
});
|
|
329
390
|
const marshalUpgradeInstanceRequest = (request, defaults) => ({
|
|
330
391
|
...resolveOneOf([
|
|
331
|
-
{
|
|
392
|
+
{
|
|
393
|
+
param: "volume_size_bytes",
|
|
394
|
+
value: request.volumeSizeBytes
|
|
395
|
+
},
|
|
396
|
+
{
|
|
397
|
+
param: "version_id",
|
|
398
|
+
value: request.versionId
|
|
399
|
+
}
|
|
332
400
|
])
|
|
333
401
|
});
|
|
334
402
|
export {
|
|
@@ -346,10 +414,12 @@ export {
|
|
|
346
414
|
unmarshalInstance,
|
|
347
415
|
unmarshalListDatabasesResponse,
|
|
348
416
|
unmarshalListInstancesResponse,
|
|
417
|
+
unmarshalListMaintenancesResponse,
|
|
349
418
|
unmarshalListNodeTypesResponse,
|
|
350
419
|
unmarshalListSnapshotsResponse,
|
|
351
420
|
unmarshalListUsersResponse,
|
|
352
421
|
unmarshalListVersionsResponse,
|
|
422
|
+
unmarshalMaintenance,
|
|
353
423
|
unmarshalSnapshot,
|
|
354
424
|
unmarshalUser
|
|
355
425
|
};
|
package/dist/v1/types.gen.d.ts
CHANGED
|
@@ -2,8 +2,11 @@ import type { Region as ScwRegion } from '@scaleway/sdk-client';
|
|
|
2
2
|
export type InstanceStatus = 'unknown_status' | 'ready' | 'provisioning' | 'configuring' | 'deleting' | 'error' | 'initializing' | 'locked' | 'snapshotting';
|
|
3
3
|
export type ListDatabasesRequestOrderBy = 'name_asc' | 'name_desc';
|
|
4
4
|
export type ListInstancesRequestOrderBy = 'created_at_asc' | 'created_at_desc' | 'name_asc' | 'name_desc' | 'status_asc' | 'status_desc';
|
|
5
|
+
export type ListMaintenancesRequestOrderBy = 'created_at_asc' | 'created_at_desc' | 'starts_at_asc' | 'starts_at_desc' | 'stops_at_asc' | 'stops_at_desc';
|
|
5
6
|
export type ListSnapshotsRequestOrderBy = 'created_at_asc' | 'created_at_desc' | 'name_asc' | 'name_desc' | 'expires_at_asc' | 'expires_at_desc';
|
|
6
7
|
export type ListUsersRequestOrderBy = 'name_asc' | 'name_desc';
|
|
8
|
+
export type MaintenanceAppliedBy = 'unknown_applied_by' | 'user' | 'admin';
|
|
9
|
+
export type MaintenanceStatus = 'unknown_status' | 'planned' | 'done' | 'cancelled' | 'ongoing';
|
|
7
10
|
export type NodeTypeStock = 'unknown_stock' | 'low_stock' | 'out_of_stock' | 'available';
|
|
8
11
|
export type SnapshotStatus = 'unknown_status' | 'creating' | 'ready' | 'restoring' | 'deleting' | 'error' | 'locked';
|
|
9
12
|
export type UserRoleRole = 'unknown_role' | 'read' | 'read_write' | 'db_admin' | 'sync';
|
|
@@ -22,6 +25,12 @@ export interface EndpointPrivateNetworkDetails {
|
|
|
22
25
|
*/
|
|
23
26
|
export interface EndpointPublicNetworkDetails {
|
|
24
27
|
}
|
|
28
|
+
export interface EngineUpgrade {
|
|
29
|
+
newVersionId: string;
|
|
30
|
+
}
|
|
31
|
+
export interface ServiceUpdate {
|
|
32
|
+
serviceName: string;
|
|
33
|
+
}
|
|
25
34
|
export interface EndpointSpecPrivateNetworkDetails {
|
|
26
35
|
/**
|
|
27
36
|
* UUID of the Private Network.
|
|
@@ -73,6 +82,18 @@ export interface Volume {
|
|
|
73
82
|
*/
|
|
74
83
|
sizeBytes: number;
|
|
75
84
|
}
|
|
85
|
+
export interface Workflow {
|
|
86
|
+
/**
|
|
87
|
+
*
|
|
88
|
+
* One-of ('workflowType'): at most one of 'engineUpgrade', 'serviceUpdate' could be set.
|
|
89
|
+
*/
|
|
90
|
+
engineUpgrade?: EngineUpgrade;
|
|
91
|
+
/**
|
|
92
|
+
*
|
|
93
|
+
* One-of ('workflowType'): at most one of 'engineUpgrade', 'serviceUpdate' could be set.
|
|
94
|
+
*/
|
|
95
|
+
serviceUpdate?: ServiceUpdate;
|
|
96
|
+
}
|
|
76
97
|
export interface NodeTypeVolumeType {
|
|
77
98
|
/**
|
|
78
99
|
* Volume Type.
|
|
@@ -186,6 +207,52 @@ export interface Instance {
|
|
|
186
207
|
*/
|
|
187
208
|
snapshotSchedule?: InstanceSnapshotSchedule;
|
|
188
209
|
}
|
|
210
|
+
export interface Maintenance {
|
|
211
|
+
/**
|
|
212
|
+
* ID of the maintenance.
|
|
213
|
+
*/
|
|
214
|
+
id: string;
|
|
215
|
+
/**
|
|
216
|
+
* ID of the instance on which the maintenance is applied.
|
|
217
|
+
*/
|
|
218
|
+
instanceId: string;
|
|
219
|
+
/**
|
|
220
|
+
* Creation date of the maintenance.
|
|
221
|
+
*/
|
|
222
|
+
createdAt?: Date;
|
|
223
|
+
/**
|
|
224
|
+
* Start date of the maintenance.
|
|
225
|
+
*/
|
|
226
|
+
startsAt?: Date;
|
|
227
|
+
/**
|
|
228
|
+
* Stop date of the maintenance.
|
|
229
|
+
*/
|
|
230
|
+
stopsAt?: Date;
|
|
231
|
+
/**
|
|
232
|
+
* Current status of the maintenance.
|
|
233
|
+
*/
|
|
234
|
+
status: MaintenanceStatus;
|
|
235
|
+
/**
|
|
236
|
+
* Forced application date of the maintenance.
|
|
237
|
+
*/
|
|
238
|
+
forcedAt?: Date;
|
|
239
|
+
/**
|
|
240
|
+
* Application date of the maintenance.
|
|
241
|
+
*/
|
|
242
|
+
appliedAt?: Date;
|
|
243
|
+
/**
|
|
244
|
+
* Usertype who launched the maintenance.
|
|
245
|
+
*/
|
|
246
|
+
appliedBy: MaintenanceAppliedBy;
|
|
247
|
+
/**
|
|
248
|
+
* Workflow to be applied during maintenance.
|
|
249
|
+
*/
|
|
250
|
+
workflow?: Workflow;
|
|
251
|
+
/**
|
|
252
|
+
* Reason of the maintenance.
|
|
253
|
+
*/
|
|
254
|
+
reason: string;
|
|
255
|
+
}
|
|
189
256
|
export interface NodeType {
|
|
190
257
|
/**
|
|
191
258
|
* Node type name identifier.
|
|
@@ -294,6 +361,13 @@ export interface Version {
|
|
|
294
361
|
*/
|
|
295
362
|
endOfLifeAt?: Date;
|
|
296
363
|
}
|
|
364
|
+
export type ApplyMaintenanceRequest = {
|
|
365
|
+
/**
|
|
366
|
+
* Region to target. If none is passed will use default region from the config.
|
|
367
|
+
*/
|
|
368
|
+
region?: ScwRegion;
|
|
369
|
+
maintenanceId: string;
|
|
370
|
+
};
|
|
297
371
|
export type CreateEndpointRequest = {
|
|
298
372
|
/**
|
|
299
373
|
* Region to target. If none is passed will use default region from the config.
|
|
@@ -454,6 +528,16 @@ export type GetInstanceRequest = {
|
|
|
454
528
|
*/
|
|
455
529
|
instanceId: string;
|
|
456
530
|
};
|
|
531
|
+
export type GetMaintenanceRequest = {
|
|
532
|
+
/**
|
|
533
|
+
* Region to target. If none is passed will use default region from the config.
|
|
534
|
+
*/
|
|
535
|
+
region?: ScwRegion;
|
|
536
|
+
/**
|
|
537
|
+
* ID of the maintenance.
|
|
538
|
+
*/
|
|
539
|
+
maintenanceId: string;
|
|
540
|
+
};
|
|
457
541
|
export type GetSnapshotRequest = {
|
|
458
542
|
/**
|
|
459
543
|
* Region to target. If none is passed will use default region from the config.
|
|
@@ -528,6 +612,32 @@ export interface ListInstancesResponse {
|
|
|
528
612
|
*/
|
|
529
613
|
totalCount: number;
|
|
530
614
|
}
|
|
615
|
+
export type ListMaintenancesRequest = {
|
|
616
|
+
/**
|
|
617
|
+
* Region to target. If none is passed will use default region from the config.
|
|
618
|
+
*/
|
|
619
|
+
region?: ScwRegion;
|
|
620
|
+
/**
|
|
621
|
+
* ID of the instance.
|
|
622
|
+
*/
|
|
623
|
+
instanceId: string;
|
|
624
|
+
/**
|
|
625
|
+
* Criteria to use when requesting user listing.
|
|
626
|
+
*/
|
|
627
|
+
orderBy?: ListMaintenancesRequestOrderBy;
|
|
628
|
+
page?: number;
|
|
629
|
+
pageSize?: number;
|
|
630
|
+
};
|
|
631
|
+
export interface ListMaintenancesResponse {
|
|
632
|
+
/**
|
|
633
|
+
* List of maintenances of a MongoDB© instance.
|
|
634
|
+
*/
|
|
635
|
+
maintenances: Maintenance[];
|
|
636
|
+
/**
|
|
637
|
+
* Total count of maintenances of a MongoDB© instance.
|
|
638
|
+
*/
|
|
639
|
+
totalCount: number;
|
|
640
|
+
}
|
|
531
641
|
export type ListNodeTypesRequest = {
|
|
532
642
|
/**
|
|
533
643
|
* Region to target. If none is passed will use default region from the config.
|
|
@@ -759,7 +869,12 @@ export type UpgradeInstanceRequest = {
|
|
|
759
869
|
/**
|
|
760
870
|
* Increase your Block Storage volume size.
|
|
761
871
|
*
|
|
762
|
-
* One-of ('upgradeTarget'): at most one of 'volumeSizeBytes' could be set.
|
|
872
|
+
* One-of ('upgradeTarget'): at most one of 'volumeSizeBytes', 'versionId' could be set.
|
|
763
873
|
*/
|
|
764
874
|
volumeSizeBytes?: number;
|
|
875
|
+
/**
|
|
876
|
+
*
|
|
877
|
+
* One-of ('upgradeTarget'): at most one of 'volumeSizeBytes', 'versionId' could be set.
|
|
878
|
+
*/
|
|
879
|
+
versionId?: string;
|
|
765
880
|
};
|
|
@@ -74,6 +74,15 @@ export declare const ListInstancesRequest: {
|
|
|
74
74
|
lessThanOrEqual: number;
|
|
75
75
|
};
|
|
76
76
|
};
|
|
77
|
+
export declare const ListMaintenancesRequest: {
|
|
78
|
+
page: {
|
|
79
|
+
greaterThanOrEqual: number;
|
|
80
|
+
};
|
|
81
|
+
pageSize: {
|
|
82
|
+
greaterThanOrEqual: number;
|
|
83
|
+
lessThanOrEqual: number;
|
|
84
|
+
};
|
|
85
|
+
};
|
|
77
86
|
export declare const ListNodeTypesRequest: {
|
|
78
87
|
page: {
|
|
79
88
|
greaterThanOrEqual: number;
|
|
@@ -74,6 +74,15 @@ const ListInstancesRequest = {
|
|
|
74
74
|
lessThanOrEqual: 100
|
|
75
75
|
}
|
|
76
76
|
};
|
|
77
|
+
const ListMaintenancesRequest = {
|
|
78
|
+
page: {
|
|
79
|
+
greaterThanOrEqual: 1
|
|
80
|
+
},
|
|
81
|
+
pageSize: {
|
|
82
|
+
greaterThanOrEqual: 1,
|
|
83
|
+
lessThanOrEqual: 100
|
|
84
|
+
}
|
|
85
|
+
};
|
|
77
86
|
const ListNodeTypesRequest = {
|
|
78
87
|
page: {
|
|
79
88
|
greaterThanOrEqual: 1
|
|
@@ -186,6 +195,7 @@ export {
|
|
|
186
195
|
DeleteUserRequest,
|
|
187
196
|
ListDatabasesRequest,
|
|
188
197
|
ListInstancesRequest,
|
|
198
|
+
ListMaintenancesRequest,
|
|
189
199
|
ListNodeTypesRequest,
|
|
190
200
|
ListSnapshotsRequest,
|
|
191
201
|
ListUsersRequest,
|
package/dist/v1alpha1/api.gen.js
CHANGED
|
@@ -10,7 +10,9 @@ class API extends API$1 {
|
|
|
10
10
|
* type ∈ {'zone','region','global','unspecified'}
|
|
11
11
|
*/
|
|
12
12
|
static LOCALITY = toApiLocality({
|
|
13
|
-
regions: [
|
|
13
|
+
regions: [
|
|
14
|
+
"fr-par"
|
|
15
|
+
]
|
|
14
16
|
});
|
|
15
17
|
pageOfListNodeTypes = (request = {}) => this.client.fetch(
|
|
16
18
|
{
|
|
@@ -19,10 +21,7 @@ class API extends API$1 {
|
|
|
19
21
|
urlParams: urlParams(
|
|
20
22
|
["include_disabled_types", request.includeDisabledTypes],
|
|
21
23
|
["page", request.page],
|
|
22
|
-
[
|
|
23
|
-
"page_size",
|
|
24
|
-
request.pageSize ?? this.client.settings.defaultPageSize
|
|
25
|
-
]
|
|
24
|
+
["page_size", request.pageSize ?? this.client.settings.defaultPageSize]
|
|
26
25
|
)
|
|
27
26
|
},
|
|
28
27
|
unmarshalListNodeTypesResponse
|
|
@@ -40,10 +39,7 @@ class API extends API$1 {
|
|
|
40
39
|
path: `/mongodb/v1alpha1/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/versions`,
|
|
41
40
|
urlParams: urlParams(
|
|
42
41
|
["page", request.page],
|
|
43
|
-
[
|
|
44
|
-
"page_size",
|
|
45
|
-
request.pageSize ?? this.client.settings.defaultPageSize
|
|
46
|
-
],
|
|
42
|
+
["page_size", request.pageSize ?? this.client.settings.defaultPageSize],
|
|
47
43
|
["version", request.version]
|
|
48
44
|
)
|
|
49
45
|
},
|
|
@@ -65,10 +61,7 @@ class API extends API$1 {
|
|
|
65
61
|
["order_by", request.orderBy],
|
|
66
62
|
["organization_id", request.organizationId],
|
|
67
63
|
["page", request.page],
|
|
68
|
-
[
|
|
69
|
-
"page_size",
|
|
70
|
-
request.pageSize ?? this.client.settings.defaultPageSize
|
|
71
|
-
],
|
|
64
|
+
["page_size", request.pageSize ?? this.client.settings.defaultPageSize],
|
|
72
65
|
["project_id", request.projectId],
|
|
73
66
|
["tags", request.tags]
|
|
74
67
|
)
|
|
@@ -103,9 +96,7 @@ class API extends API$1 {
|
|
|
103
96
|
* @returns A Promise of Instance
|
|
104
97
|
*/
|
|
105
98
|
waitForInstance = (request, options) => waitForResource(
|
|
106
|
-
options?.stop ?? ((res) => Promise.resolve(
|
|
107
|
-
!INSTANCE_TRANSIENT_STATUSES.includes(res.status)
|
|
108
|
-
)),
|
|
99
|
+
options?.stop ?? ((res) => Promise.resolve(!INSTANCE_TRANSIENT_STATUSES.includes(res.status))),
|
|
109
100
|
this.getInstance,
|
|
110
101
|
request,
|
|
111
102
|
options
|
|
@@ -180,12 +171,16 @@ class API extends API$1 {
|
|
|
180
171
|
* @param request - The request {@link GetInstanceCertificateRequest}
|
|
181
172
|
* @returns A Promise of Blob
|
|
182
173
|
*/
|
|
183
|
-
getInstanceCertificate = (request) => this.client.fetch(
|
|
184
|
-
|
|
185
|
-
|
|
186
|
-
|
|
187
|
-
|
|
188
|
-
|
|
174
|
+
getInstanceCertificate = (request) => this.client.fetch(
|
|
175
|
+
{
|
|
176
|
+
method: "GET",
|
|
177
|
+
path: `/mongodb/v1alpha1/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/instances/${validatePathParam("instanceId", request.instanceId)}/certificate`,
|
|
178
|
+
urlParams: urlParams(
|
|
179
|
+
["dl", 1]
|
|
180
|
+
),
|
|
181
|
+
responseType: "blob"
|
|
182
|
+
}
|
|
183
|
+
);
|
|
189
184
|
/**
|
|
190
185
|
* 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.
|
|
191
186
|
*
|
|
@@ -224,9 +219,7 @@ class API extends API$1 {
|
|
|
224
219
|
* @returns A Promise of Snapshot
|
|
225
220
|
*/
|
|
226
221
|
waitForSnapshot = (request, options) => waitForResource(
|
|
227
|
-
options?.stop ?? ((res) => Promise.resolve(
|
|
228
|
-
!SNAPSHOT_TRANSIENT_STATUSES.includes(res.status)
|
|
229
|
-
)),
|
|
222
|
+
options?.stop ?? ((res) => Promise.resolve(!SNAPSHOT_TRANSIENT_STATUSES.includes(res.status))),
|
|
230
223
|
this.getSnapshot,
|
|
231
224
|
request,
|
|
232
225
|
options
|
|
@@ -275,10 +268,7 @@ class API extends API$1 {
|
|
|
275
268
|
["order_by", request.orderBy],
|
|
276
269
|
["organization_id", request.organizationId],
|
|
277
270
|
["page", request.page],
|
|
278
|
-
[
|
|
279
|
-
"page_size",
|
|
280
|
-
request.pageSize ?? this.client.settings.defaultPageSize
|
|
281
|
-
],
|
|
271
|
+
["page_size", request.pageSize ?? this.client.settings.defaultPageSize],
|
|
282
272
|
["project_id", request.projectId]
|
|
283
273
|
)
|
|
284
274
|
},
|
|
@@ -312,10 +302,7 @@ class API extends API$1 {
|
|
|
312
302
|
["name", request.name],
|
|
313
303
|
["order_by", request.orderBy],
|
|
314
304
|
["page", request.page],
|
|
315
|
-
[
|
|
316
|
-
"page_size",
|
|
317
|
-
request.pageSize ?? this.client.settings.defaultPageSize
|
|
318
|
-
]
|
|
305
|
+
["page_size", request.pageSize ?? this.client.settings.defaultPageSize]
|
|
319
306
|
)
|
|
320
307
|
},
|
|
321
308
|
unmarshalListUsersResponse
|
|
@@ -366,12 +353,14 @@ class API extends API$1 {
|
|
|
366
353
|
*
|
|
367
354
|
* @param request - The request {@link DeleteUserRequest}
|
|
368
355
|
*/
|
|
369
|
-
deleteUser = (request) => this.client.fetch(
|
|
370
|
-
|
|
371
|
-
|
|
372
|
-
|
|
373
|
-
|
|
374
|
-
|
|
356
|
+
deleteUser = (request) => this.client.fetch(
|
|
357
|
+
{
|
|
358
|
+
body: "{}",
|
|
359
|
+
headers: jsonContentHeaders,
|
|
360
|
+
method: "DELETE",
|
|
361
|
+
path: `/mongodb/v1alpha1/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/instances/${validatePathParam("instanceId", request.instanceId)}/users/${validatePathParam("name", request.name)}`
|
|
362
|
+
}
|
|
363
|
+
);
|
|
375
364
|
/**
|
|
376
365
|
* Apply user roles. Apply preset roles for a user in a Database Instance.
|
|
377
366
|
*
|
|
@@ -394,10 +383,12 @@ class API extends API$1 {
|
|
|
394
383
|
*
|
|
395
384
|
* @param request - The request {@link DeleteEndpointRequest}
|
|
396
385
|
*/
|
|
397
|
-
deleteEndpoint = (request) => this.client.fetch(
|
|
398
|
-
|
|
399
|
-
|
|
400
|
-
|
|
386
|
+
deleteEndpoint = (request) => this.client.fetch(
|
|
387
|
+
{
|
|
388
|
+
method: "DELETE",
|
|
389
|
+
path: `/mongodb/v1alpha1/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/endpoints/${validatePathParam("endpointId", request.endpointId)}`
|
|
390
|
+
}
|
|
391
|
+
);
|
|
401
392
|
/**
|
|
402
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.
|
|
403
394
|
*
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
export { API } from './api.gen.js';
|
|
1
|
+
export { API, } from './api.gen.js';
|
|
2
2
|
export * from './content.gen.js';
|
|
3
3
|
export * from './marshalling.gen.js';
|
|
4
4
|
export type { CreateEndpointRequest, CreateInstanceRequest, CreateInstanceRequestVolumeDetails, CreateSnapshotRequest, CreateUserRequest, DeleteEndpointRequest, DeleteInstanceRequest, DeleteSnapshotRequest, DeleteUserRequest, Endpoint, EndpointPrivateNetworkDetails, EndpointPublicDetails, EndpointSpec, EndpointSpecPrivateNetworkDetails, EndpointSpecPublicDetails, GetInstanceCertificateRequest, GetInstanceRequest, GetSnapshotRequest, Instance, InstanceSetting, InstanceSnapshotSchedule, InstanceStatus, ListInstancesRequest, ListInstancesRequestOrderBy, ListInstancesResponse, ListNodeTypesRequest, ListNodeTypesResponse, ListSnapshotsRequest, ListSnapshotsRequestOrderBy, ListSnapshotsResponse, ListUsersRequest, ListUsersRequestOrderBy, ListUsersResponse, ListVersionsRequest, ListVersionsResponse, NodeType, NodeTypeStock, NodeTypeVolumeType, RestoreSnapshotRequest, RestoreSnapshotRequestVolumeDetails, Setting, SettingPropertyType, SetUserRoleRequest, Snapshot, SnapshotStatus, SnapshotVolumeType, UpdateInstanceRequest, UpdateSnapshotRequest, UpdateUserRequest, UpgradeInstanceRequest, User, UserRole, UserRoleRole, Version, Volume, VolumeType, } from './types.gen.js';
|
|
@@ -178,10 +178,7 @@ const unmarshalNodeType = (data) => {
|
|
|
178
178
|
);
|
|
179
179
|
}
|
|
180
180
|
return {
|
|
181
|
-
availableVolumeTypes: unmarshalArrayOfObject(
|
|
182
|
-
data.available_volume_types,
|
|
183
|
-
unmarshalNodeTypeVolumeType
|
|
184
|
-
),
|
|
181
|
+
availableVolumeTypes: unmarshalArrayOfObject(data.available_volume_types, unmarshalNodeTypeVolumeType),
|
|
185
182
|
beta: data.beta,
|
|
186
183
|
description: data.description,
|
|
187
184
|
disabled: data.disabled,
|
|
@@ -252,10 +249,7 @@ const unmarshalVersion = (data) => {
|
|
|
252
249
|
);
|
|
253
250
|
}
|
|
254
251
|
return {
|
|
255
|
-
availableSettings: unmarshalArrayOfObject(
|
|
256
|
-
data.available_settings,
|
|
257
|
-
unmarshalSetting
|
|
258
|
-
),
|
|
252
|
+
availableSettings: unmarshalArrayOfObject(data.available_settings, unmarshalSetting),
|
|
259
253
|
endOfLifeAt: unmarshalDate(data.end_of_life_at),
|
|
260
254
|
version: data.version
|
|
261
255
|
};
|
|
@@ -283,9 +277,7 @@ const marshalEndpointSpec = (request, defaults) => ({
|
|
|
283
277
|
},
|
|
284
278
|
{
|
|
285
279
|
param: "private_network",
|
|
286
|
-
value: request.privateNetwork !== void 0 ? marshalEndpointSpecPrivateNetworkDetails(
|
|
287
|
-
request.privateNetwork
|
|
288
|
-
) : void 0
|
|
280
|
+
value: request.privateNetwork !== void 0 ? marshalEndpointSpecPrivateNetworkDetails(request.privateNetwork) : void 0
|
|
289
281
|
}
|
|
290
282
|
])
|
|
291
283
|
});
|
|
@@ -329,8 +321,14 @@ const marshalRestoreSnapshotRequest = (request, defaults) => ({
|
|
|
329
321
|
const marshalUserRole = (request, defaults) => ({
|
|
330
322
|
role: request.role,
|
|
331
323
|
...resolveOneOf([
|
|
332
|
-
{
|
|
333
|
-
|
|
324
|
+
{
|
|
325
|
+
param: "database",
|
|
326
|
+
value: request.database
|
|
327
|
+
},
|
|
328
|
+
{
|
|
329
|
+
param: "any_database",
|
|
330
|
+
value: request.anyDatabase
|
|
331
|
+
}
|
|
334
332
|
])
|
|
335
333
|
});
|
|
336
334
|
const marshalSetUserRoleRequest = (request, defaults) => ({
|
|
@@ -349,7 +347,12 @@ const marshalUpdateUserRequest = (request, defaults) => ({
|
|
|
349
347
|
password: request.password
|
|
350
348
|
});
|
|
351
349
|
const marshalUpgradeInstanceRequest = (request, defaults) => ({
|
|
352
|
-
...resolveOneOf([
|
|
350
|
+
...resolveOneOf([
|
|
351
|
+
{
|
|
352
|
+
param: "volume_size",
|
|
353
|
+
value: request.volumeSize
|
|
354
|
+
}
|
|
355
|
+
])
|
|
353
356
|
});
|
|
354
357
|
export {
|
|
355
358
|
marshalCreateEndpointRequest,
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@scaleway/sdk-mongodb",
|
|
3
|
-
"version": "2.
|
|
3
|
+
"version": "2.3.1",
|
|
4
4
|
"description": "Scaleway SDK mongodb",
|
|
5
5
|
"license": "Apache-2.0",
|
|
6
6
|
"files": [
|
|
@@ -27,7 +27,7 @@
|
|
|
27
27
|
},
|
|
28
28
|
"dependencies": {
|
|
29
29
|
"@scaleway/random-name": "5.1.2",
|
|
30
|
-
"@scaleway/sdk-std": "2.1.
|
|
30
|
+
"@scaleway/sdk-std": "2.1.1"
|
|
31
31
|
},
|
|
32
32
|
"peerDependencies": {
|
|
33
33
|
"@scaleway/sdk-client": "^2.1.0"
|