@scaleway/sdk 2.52.0 → 2.52.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.
@@ -15,7 +15,10 @@ class API extends api.API {
15
15
  static LOCALITIES = [
16
16
  "fr-par-1",
17
17
  "fr-par-2",
18
- "nl-ams-1"
18
+ "nl-ams-1",
19
+ "nl-ams-2",
20
+ "pl-waw-2",
21
+ "pl-waw-3"
19
22
  ];
20
23
  /**
21
24
  * Create a new flexible IP. Generate a new flexible IP within a given zone,
@@ -13,7 +13,10 @@ class API extends API$1 {
13
13
  static LOCALITIES = [
14
14
  "fr-par-1",
15
15
  "fr-par-2",
16
- "nl-ams-1"
16
+ "nl-ams-1",
17
+ "nl-ams-2",
18
+ "pl-waw-2",
19
+ "pl-waw-3"
17
20
  ];
18
21
  /**
19
22
  * Create a new flexible IP. Generate a new flexible IP within a given zone,
@@ -51,7 +51,7 @@ class API extends api.API {
51
51
  marshalling_gen.unmarshalListVersionsResponse
52
52
  );
53
53
  /**
54
- * List available MongoDB versions.
54
+ * List available MongoDB® versions.
55
55
  *
56
56
  * @param request - The request {@link ListVersionsRequest}
57
57
  * @returns A Promise of ListVersionsResponse
@@ -83,22 +83,21 @@ class API extends api.API {
83
83
  marshalling_gen.unmarshalListInstancesResponse
84
84
  );
85
85
  /**
86
- * List MongoDB Database Instances. List all MongoDB Database Instances in
87
- * the specified region, for a given Scaleway Project. By default, the
88
- * MongoDB™ Database Instances returned in the list are ordered by creation
89
- * date in ascending order, though this can be modified via the order_by
90
- * field. You can define additional parameters for your query, such as `tags`
91
- * and `name`. For the `name` parameter, the value you include will be checked
92
- * against the whole name string to see if it includes the string you put in
93
- * the parameter.
86
+ * List MongoDB® Database Instances. List all MongoDB® Database Instances in
87
+ * the specified region. By default, the MongoDB® Database Instances returned
88
+ * in the list are ordered by creation date in ascending order, though this
89
+ * can be modified via the order_by field. You can define additional
90
+ * parameters for your query, such as `tags` and `name`. For the `name`
91
+ * parameter, the value you include will be checked against the whole name
92
+ * string to see if it includes the string you put in the parameter.
94
93
  *
95
94
  * @param request - The request {@link ListInstancesRequest}
96
95
  * @returns A Promise of ListInstancesResponse
97
96
  */
98
97
  listInstances = (request = {}) => resourcePaginator.enrichForPagination("instances", this.pageOfListInstances, request);
99
98
  /**
100
- * Get a MongoDB Database Instance. Retrieve information about a given
101
- * MongoDB Database Instance, specified by the `region` and `instance_id`
99
+ * Get a MongoDB® Database Instance. Retrieve information about a given
100
+ * MongoDB® Database Instance, specified by the `region` and `instance_id`
102
101
  * parameters. Its full details, including name, status, IP address and port,
103
102
  * are returned in the response object.
104
103
  *
@@ -126,7 +125,7 @@ class API extends api.API {
126
125
  options
127
126
  );
128
127
  /**
129
- * Create a MongoDB Database Instance. Create a new MongoDB Database
128
+ * Create a MongoDB® Database Instance. Create a new MongoDB® Database
130
129
  * Instance.
131
130
  *
132
131
  * @param request - The request {@link CreateInstanceRequest}
@@ -144,7 +143,7 @@ class API extends api.API {
144
143
  marshalling_gen.unmarshalInstance
145
144
  );
146
145
  /**
147
- * Update a MongoDB Database Instance. Update the parameters of a MongoDB
146
+ * Update a MongoDB® Database Instance. Update the parameters of a MongoDB®
148
147
  * Database Instance.
149
148
  *
150
149
  * @param request - The request {@link UpdateInstanceRequest}
@@ -162,9 +161,9 @@ class API extends api.API {
162
161
  marshalling_gen.unmarshalInstance
163
162
  );
164
163
  /**
165
- * Delete a MongoDB Database Instance. Delete a given MongoDB Database
164
+ * Delete a MongoDB® Database Instance. Delete a given MongoDB® Database
166
165
  * Instance, specified by the `region` and `instance_id` parameters. Deleting
167
- * a MongoDB Database Instance is permanent, and cannot be undone. Note that
166
+ * a MongoDB® Database Instance is permanent, and cannot be undone. Note that
168
167
  * upon deletion all your data will be lost.
169
168
  *
170
169
  * @param request - The request {@link DeleteInstanceRequest}
@@ -2,9 +2,9 @@ import { API as ParentAPI } from '../../../bridge';
2
2
  import type { Region, WaitForOptions } from '../../../bridge';
3
3
  import type { CreateInstanceRequest, CreateSnapshotRequest, DeleteInstanceRequest, DeleteSnapshotRequest, GetInstanceCertificateRequest, GetInstanceRequest, GetSnapshotRequest, Instance, ListInstancesRequest, ListInstancesResponse, ListNodeTypesRequest, ListNodeTypesResponse, ListSnapshotsRequest, ListSnapshotsResponse, ListUsersRequest, ListUsersResponse, ListVersionsRequest, ListVersionsResponse, RestoreSnapshotRequest, Snapshot, UpdateInstanceRequest, UpdateSnapshotRequest, UpdateUserRequest, UpgradeInstanceRequest, User } from './types.gen';
4
4
  /**
5
- * Managed Database for MongoDB.
5
+ * Managed Database for MongoDB®.
6
6
  *
7
- * This API allows you to manage your Managed Databases for MongoDB.
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. */
@@ -22,7 +22,7 @@ export declare class API extends ParentAPI {
22
22
  };
23
23
  protected pageOfListVersions: (request?: Readonly<ListVersionsRequest>) => Promise<ListVersionsResponse>;
24
24
  /**
25
- * List available MongoDB versions.
25
+ * List available MongoDB® versions.
26
26
  *
27
27
  * @param request - The request {@link ListVersionsRequest}
28
28
  * @returns A Promise of ListVersionsResponse
@@ -33,14 +33,13 @@ 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, for a given Scaleway Project. By default, the
38
- * MongoDB™ Database Instances returned in the list are ordered by creation
39
- * date in ascending order, though this can be modified via the order_by
40
- * field. You can define additional parameters for your query, such as `tags`
41
- * and `name`. For the `name` parameter, the value you include will be checked
42
- * against the whole name string to see if it includes the string you put in
43
- * the parameter.
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.
44
43
  *
45
44
  * @param request - The request {@link ListInstancesRequest}
46
45
  * @returns A Promise of ListInstancesResponse
@@ -50,8 +49,8 @@ export declare class API extends ParentAPI {
50
49
  [Symbol.asyncIterator]: () => AsyncGenerator<Instance[], void, void>;
51
50
  };
52
51
  /**
53
- * Get a MongoDB Database Instance. Retrieve information about a given
54
- * MongoDB Database Instance, specified by the `region` and `instance_id`
52
+ * Get a MongoDB® Database Instance. Retrieve information about a given
53
+ * MongoDB® Database Instance, specified by the `region` and `instance_id`
55
54
  * parameters. Its full details, including name, status, IP address and port,
56
55
  * are returned in the response object.
57
56
  *
@@ -68,7 +67,7 @@ export declare class API extends ParentAPI {
68
67
  */
69
68
  waitForInstance: (request: Readonly<GetInstanceRequest>, options?: Readonly<WaitForOptions<Instance>>) => Promise<Instance>;
70
69
  /**
71
- * Create a MongoDB Database Instance. Create a new MongoDB Database
70
+ * Create a MongoDB® Database Instance. Create a new MongoDB® Database
72
71
  * Instance.
73
72
  *
74
73
  * @param request - The request {@link CreateInstanceRequest}
@@ -76,7 +75,7 @@ export declare class API extends ParentAPI {
76
75
  */
77
76
  createInstance: (request: Readonly<CreateInstanceRequest>) => Promise<Instance>;
78
77
  /**
79
- * Update a MongoDB Database Instance. Update the parameters of a MongoDB
78
+ * Update a MongoDB® Database Instance. Update the parameters of a MongoDB®
80
79
  * Database Instance.
81
80
  *
82
81
  * @param request - The request {@link UpdateInstanceRequest}
@@ -84,9 +83,9 @@ export declare class API extends ParentAPI {
84
83
  */
85
84
  updateInstance: (request: Readonly<UpdateInstanceRequest>) => Promise<Instance>;
86
85
  /**
87
- * Delete a MongoDB Database Instance. Delete a given MongoDB Database
86
+ * Delete a MongoDB® Database Instance. Delete a given MongoDB® Database
88
87
  * Instance, specified by the `region` and `instance_id` parameters. Deleting
89
- * a MongoDB Database Instance is permanent, and cannot be undone. Note that
88
+ * a MongoDB® Database Instance is permanent, and cannot be undone. Note that
90
89
  * upon deletion all your data will be lost.
91
90
  *
92
91
  * @param request - The request {@link DeleteInstanceRequest}
@@ -49,7 +49,7 @@ class API extends API$1 {
49
49
  unmarshalListVersionsResponse
50
50
  );
51
51
  /**
52
- * List available MongoDB versions.
52
+ * List available MongoDB® versions.
53
53
  *
54
54
  * @param request - The request {@link ListVersionsRequest}
55
55
  * @returns A Promise of ListVersionsResponse
@@ -81,22 +81,21 @@ class API extends API$1 {
81
81
  unmarshalListInstancesResponse
82
82
  );
83
83
  /**
84
- * List MongoDB Database Instances. List all MongoDB Database Instances in
85
- * the specified region, for a given Scaleway Project. By default, the
86
- * MongoDB™ Database Instances returned in the list are ordered by creation
87
- * date in ascending order, though this can be modified via the order_by
88
- * field. You can define additional parameters for your query, such as `tags`
89
- * and `name`. For the `name` parameter, the value you include will be checked
90
- * against the whole name string to see if it includes the string you put in
91
- * the parameter.
84
+ * List MongoDB® Database Instances. List all MongoDB® Database Instances in
85
+ * the specified region. By default, the MongoDB® Database Instances returned
86
+ * in the list are ordered by creation date in ascending order, though this
87
+ * can be modified via the order_by field. You can define additional
88
+ * parameters for your query, such as `tags` and `name`. For the `name`
89
+ * parameter, the value you include will be checked against the whole name
90
+ * string to see if it includes the string you put in the parameter.
92
91
  *
93
92
  * @param request - The request {@link ListInstancesRequest}
94
93
  * @returns A Promise of ListInstancesResponse
95
94
  */
96
95
  listInstances = (request = {}) => enrichForPagination("instances", this.pageOfListInstances, request);
97
96
  /**
98
- * Get a MongoDB Database Instance. Retrieve information about a given
99
- * MongoDB Database Instance, specified by the `region` and `instance_id`
97
+ * Get a MongoDB® Database Instance. Retrieve information about a given
98
+ * MongoDB® Database Instance, specified by the `region` and `instance_id`
100
99
  * parameters. Its full details, including name, status, IP address and port,
101
100
  * are returned in the response object.
102
101
  *
@@ -124,7 +123,7 @@ class API extends API$1 {
124
123
  options
125
124
  );
126
125
  /**
127
- * Create a MongoDB Database Instance. Create a new MongoDB Database
126
+ * Create a MongoDB® Database Instance. Create a new MongoDB® Database
128
127
  * Instance.
129
128
  *
130
129
  * @param request - The request {@link CreateInstanceRequest}
@@ -142,7 +141,7 @@ class API extends API$1 {
142
141
  unmarshalInstance
143
142
  );
144
143
  /**
145
- * Update a MongoDB Database Instance. Update the parameters of a MongoDB
144
+ * Update a MongoDB® Database Instance. Update the parameters of a MongoDB®
146
145
  * Database Instance.
147
146
  *
148
147
  * @param request - The request {@link UpdateInstanceRequest}
@@ -160,9 +159,9 @@ class API extends API$1 {
160
159
  unmarshalInstance
161
160
  );
162
161
  /**
163
- * Delete a MongoDB Database Instance. Delete a given MongoDB Database
162
+ * Delete a MongoDB® Database Instance. Delete a given MongoDB® Database
164
163
  * Instance, specified by the `region` and `instance_id` parameters. Deleting
165
- * a MongoDB Database Instance is permanent, and cannot be undone. Note that
164
+ * a MongoDB® Database Instance is permanent, and cannot be undone. Note that
166
165
  * upon deletion all your data will be lost.
167
166
  *
168
167
  * @param request - The request {@link DeleteInstanceRequest}
@@ -9,13 +9,13 @@ export type SnapshotStatus = 'unknown_status' | 'creating' | 'ready' | 'restorin
9
9
  export type VolumeType = 'unknown_type' | 'sbs_5k' | 'sbs_15k';
10
10
  /** Private Network details. */
11
11
  export interface EndpointPrivateNetworkDetails {
12
- /** UUID of the private network. */
12
+ /** UUID of the Private Network. */
13
13
  privateNetworkId: string;
14
14
  }
15
15
  export interface EndpointPublicDetails {
16
16
  }
17
17
  export interface EndpointSpecPrivateNetworkDetails {
18
- /** UUID of the private network. */
18
+ /** UUID of the Private Network. */
19
19
  privateNetworkId: string;
20
20
  }
21
21
  export interface EndpointSpecPublicDetails {
@@ -57,11 +57,11 @@ export interface Volume {
57
57
  export interface NodeTypeVolumeType {
58
58
  /** Volume Type. */
59
59
  type: VolumeType;
60
- /** The description of the Volume. */
60
+ /** The description of the volume. */
61
61
  description: string;
62
- /** Mimimum size required for the Volume. */
62
+ /** Mimimum size required for the volume. */
63
63
  minSize: number;
64
- /** Maximum size required for the Volume. */
64
+ /** Maximum size required for the volume. */
65
65
  maxSize: number;
66
66
  /** Minimum increment level for a Block Storage volume size. */
67
67
  chunkSize: number;
@@ -114,7 +114,7 @@ export interface Instance {
114
114
  projectId: string;
115
115
  /** Status of the Database Instance. */
116
116
  status: InstanceStatus;
117
- /** MongoDB engine version of the Database Instance. */
117
+ /** MongoDB® engine version of the Database Instance. */
118
118
  version: string;
119
119
  /** List of tags applied to the Database Instance. */
120
120
  tags: string[];
@@ -134,9 +134,9 @@ export interface Instance {
134
134
  region: Region;
135
135
  }
136
136
  export interface NodeType {
137
- /** Node Type name identifier. */
137
+ /** Node type name identifier. */
138
138
  name: string;
139
- /** Current stock status for the Node Type. */
139
+ /** Current stock status for the node type. */
140
140
  stockStatus: NodeTypeStock;
141
141
  /** Current specs of the offer. */
142
142
  description: string;
@@ -144,13 +144,13 @@ export interface NodeType {
144
144
  vcpus: number;
145
145
  /** Quantity of RAM. */
146
146
  memory: number;
147
- /** Available storage options for the Node Type. */
147
+ /** Available storage options for the node type. */
148
148
  availableVolumeTypes: NodeTypeVolumeType[];
149
- /** The Node Type is currently disabled. */
149
+ /** The node type is currently disabled. */
150
150
  disabled: boolean;
151
- /** The Node Type is currently in beta. */
151
+ /** The node type is currently in beta. */
152
152
  beta: boolean;
153
- /** Instance range associated with the NodeType offer. */
153
+ /** Instance range associated with the node type offer. */
154
154
  instanceRange: string;
155
155
  }
156
156
  export interface Snapshot {
@@ -174,9 +174,9 @@ export interface Snapshot {
174
174
  instanceName: string;
175
175
  /** Source node type. */
176
176
  nodeType: string;
177
- /** Type of volume where data is stored sbs_5k or sbs_15k. */
177
+ /** Type of volume where data is stored - sbs_5k or sbs_15k. */
178
178
  volumeType?: SnapshotVolumeType;
179
- /** Region of this snapshot. */
179
+ /** Region of the snapshot. */
180
180
  region: Region;
181
181
  }
182
182
  export interface User {
@@ -188,7 +188,7 @@ export interface User {
188
188
  name: string;
189
189
  }
190
190
  export interface Version {
191
- /** MongoDB engine version. */
191
+ /** MongoDB® engine version. */
192
192
  version: string;
193
193
  /** Date of End of Life. */
194
194
  endOfLifeAt?: Date;
@@ -209,7 +209,7 @@ export type CreateInstanceRequest = {
209
209
  projectId?: string;
210
210
  /** Name of the Database Instance. */
211
211
  name?: string;
212
- /** Version of the MongoDB engine. */
212
+ /** Version of the MongoDB® engine. */
213
213
  version: string;
214
214
  /** Tags to apply to the Database Instance. */
215
215
  tags?: string[];
@@ -296,9 +296,9 @@ export type ListInstancesRequest = {
296
296
  name?: string;
297
297
  /** Criteria to use when ordering Database Instance listings. */
298
298
  orderBy?: ListInstancesRequestOrderBy;
299
- /** Organization ID the Database Instance belongs to. */
299
+ /** Organization ID of the Database Instance. */
300
300
  organizationId?: string;
301
- /** Project ID to list the Database Instance of. */
301
+ /** Project ID. */
302
302
  projectId?: string;
303
303
  page?: number;
304
304
  pageSize?: number;
@@ -306,7 +306,7 @@ export type ListInstancesRequest = {
306
306
  export interface ListInstancesResponse {
307
307
  /** List of all Database Instances available in an Organization or Project. */
308
308
  instances: Instance[];
309
- /** Total count of Database Instances available in a Organization or Project. */
309
+ /** Total count of Database Instances available in an Organization or Project. */
310
310
  totalCount: number;
311
311
  }
312
312
  export type ListNodeTypesRequest = {
@@ -334,7 +334,7 @@ export type ListSnapshotsRequest = {
334
334
  region?: Region;
335
335
  /** Instance ID the snapshots belongs to. */
336
336
  instanceId?: string;
337
- /** Lists Database snapshots that match a name pattern. */
337
+ /** Lists database snapshots that match a name pattern. */
338
338
  name?: string;
339
339
  /** Criteria to use when ordering snapshot listings. */
340
340
  orderBy?: ListSnapshotsRequestOrderBy;
@@ -346,9 +346,9 @@ export type ListSnapshotsRequest = {
346
346
  pageSize?: number;
347
347
  };
348
348
  export interface ListSnapshotsResponse {
349
- /** List of all Database Snapshots available in an Organization or Project. */
349
+ /** List of all database snapshots available in an Organization or Project. */
350
350
  snapshots: Snapshot[];
351
- /** Total count of Database Snapshots available in a Organization or Project. */
351
+ /** Total count of database snapshots available in a Organization or Project. */
352
352
  totalCount: number;
353
353
  }
354
354
  export type ListUsersRequest = {
@@ -383,9 +383,9 @@ export type ListVersionsRequest = {
383
383
  pageSize?: number;
384
384
  };
385
385
  export interface ListVersionsResponse {
386
- /** Available MongoDB engine version. */
386
+ /** Available MongoDB® engine version. */
387
387
  versions: Version[];
388
- /** Total count of MongoDB engine version available. */
388
+ /** Total count of MongoDB® engine version available. */
389
389
  totalCount: number;
390
390
  }
391
391
  export type RestoreSnapshotRequest = {
@@ -453,7 +453,7 @@ export type UpgradeInstanceRequest = {
453
453
  /** UUID of the Database Instance you want to upgrade. */
454
454
  instanceId: string;
455
455
  /**
456
- * Increase your block storage volume size.
456
+ * Increase your Block Storage volume size.
457
457
  *
458
458
  * One-of ('upgradeTarget'): at most one of 'volumeSize' could be set.
459
459
  */
@@ -1,6 +1,6 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
3
- const version = "v2.51.0";
3
+ const version = "v2.52.0";
4
4
  const userAgent = `scaleway-sdk-js/${version}`;
5
5
  exports.userAgent = userAgent;
6
6
  exports.version = version;
@@ -1,2 +1,2 @@
1
- export declare const version = "v2.51.0";
2
- export declare const userAgent = "scaleway-sdk-js/v2.51.0";
1
+ export declare const version = "v2.52.0";
2
+ export declare const userAgent = "scaleway-sdk-js/v2.52.0";
@@ -1,4 +1,4 @@
1
- const version = "v2.51.0";
1
+ const version = "v2.52.0";
2
2
  const userAgent = `scaleway-sdk-js/${version}`;
3
3
  export {
4
4
  userAgent,
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@scaleway/sdk",
3
- "version": "2.52.0",
3
+ "version": "2.52.1",
4
4
  "license": "Apache-2.0",
5
5
  "description": "Scaleway SDK.",
6
6
  "keywords": [
@@ -39,5 +39,5 @@
39
39
  "bundledDependencies": [
40
40
  "@scaleway/random-name"
41
41
  ],
42
- "gitHead": "19a9c06c134f827623abba2a0449225acc7d0360"
42
+ "gitHead": "88a43d873d33fefaf3dd10365bf0ea956f787103"
43
43
  }