@scaleway/sdk 2.71.0 → 2.71.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/README.md CHANGED
@@ -3,9 +3,10 @@
3
3
  This SDK enables you to interact with Scaleway APIs.
4
4
 
5
5
  **🔗  Important links:**
6
- * [Reference documentation](https://scaleway.github.io/scaleway-sdk-js)
7
- * [Example projects](https://github.com/scaleway/scaleway-sdk-js/tree/master/examples)
8
- * [Developers website](https://developers.scaleway.com) (API documentation)
6
+
7
+ - [Reference documentation](https://scaleway.github.io/scaleway-sdk-js)
8
+ - [Example projects](https://github.com/scaleway/scaleway-sdk-js/tree/master/examples)
9
+ - [Developers website](https://developers.scaleway.com) (API documentation)
9
10
 
10
11
  ## Getting Started
11
12
 
@@ -30,8 +31,8 @@ const api = new Registry.v1.API(client)
30
31
  **For a simpler setup**, you could retrieve the profile from either the configuration file or the environment variables:
31
32
 
32
33
  ```ts
33
- import {
34
- loadProfileFromConfigurationFile,
34
+ import {
35
+ loadProfileFromConfigurationFile,
35
36
  // loadProfileFromEnvironmentValues,
36
37
  } from '@scaleway/configuration-loader'
37
38
 
@@ -198,8 +198,7 @@ class API extends api.API {
198
198
  marshalling_gen.unmarshalUser
199
199
  );
200
200
  /**
201
- * Update an user's username. Private Beta feature.. Update an user's
202
- * username. Private Beta feature.
201
+ * Update an user's username.. Update an user's username.
203
202
  *
204
203
  * @param request - The request {@link UpdateUserUsernameRequest}
205
204
  * @returns A Promise of User
@@ -216,8 +215,7 @@ class API extends api.API {
216
215
  marshalling_gen.unmarshalUser
217
216
  );
218
217
  /**
219
- * Update an user's password. Private Beta feature.. Update an user's
220
- * password. Private Beta feature.
218
+ * Update an user's password.. Update an user's password.
221
219
  *
222
220
  * @param request - The request {@link UpdateUserPasswordRequest}
223
221
  * @returns A Promise of User
@@ -234,8 +232,7 @@ class API extends api.API {
234
232
  marshalling_gen.unmarshalUser
235
233
  );
236
234
  /**
237
- * Create a MFA OTP. Private Beta feature.. Create a MFA OTP. Private Beta
238
- * feature.
235
+ * Create a MFA OTP.. Create a MFA OTP.
239
236
  *
240
237
  * @param request - The request {@link CreateUserMFAOTPRequest}
241
238
  * @returns A Promise of MFAOTP
@@ -250,8 +247,7 @@ class API extends api.API {
250
247
  marshalling_gen.unmarshalMFAOTP
251
248
  );
252
249
  /**
253
- * Validate a MFA OTP. Private Beta feature.. Validate a MFA OTP. Private Beta
254
- * feature.
250
+ * Validate a MFA OTP.. Validate a MFA OTP.
255
251
  *
256
252
  * @param request - The request {@link ValidateUserMFAOTPRequest}
257
253
  * @returns A Promise of ValidateUserMFAOTPResponse
@@ -268,8 +264,7 @@ class API extends api.API {
268
264
  marshalling_gen.unmarshalValidateUserMFAOTPResponse
269
265
  );
270
266
  /**
271
- * Delete a MFA OTP. Private Beta feature.. Delete a MFA OTP. Private Beta
272
- * feature.
267
+ * Delete a MFA OTP.. Delete a MFA OTP.
273
268
  *
274
269
  * @param request - The request {@link DeleteUserMFAOTPRequest}
275
270
  */
@@ -281,7 +276,7 @@ class API extends api.API {
281
276
  });
282
277
  /**
283
278
  * Lock a member. Lock a member. A locked member cannot log in or use API keys
284
- * until the locked status is removed. Private Beta feature.
279
+ * until the locked status is removed.
285
280
  *
286
281
  * @param request - The request {@link LockUserRequest}
287
282
  * @returns A Promise of User
@@ -296,7 +291,7 @@ class API extends api.API {
296
291
  marshalling_gen.unmarshalUser
297
292
  );
298
293
  /**
299
- * Unlock a member. Unlock a member. Private Beta feature.
294
+ * Unlock a member.
300
295
  *
301
296
  * @param request - The request {@link UnlockUserRequest}
302
297
  * @returns A Promise of User
@@ -311,8 +306,7 @@ class API extends api.API {
311
306
  marshalling_gen.unmarshalUser
312
307
  );
313
308
  /**
314
- * List grace periods of a member. List the grace periods of a member. Private
315
- * Beta feature.
309
+ * List grace periods of a member. List the grace periods of a member.
316
310
  *
317
311
  * @param request - The request {@link ListGracePeriodsRequest}
318
312
  * @returns A Promise of ListGracePeriodsResponse
@@ -104,62 +104,56 @@ export declare class API extends ParentAPI {
104
104
  */
105
105
  createUser: (request?: Readonly<CreateUserRequest>) => Promise<User>;
106
106
  /**
107
- * Update an user's username. Private Beta feature.. Update an user's
108
- * username. Private Beta feature.
107
+ * Update an user's username.. Update an user's username.
109
108
  *
110
109
  * @param request - The request {@link UpdateUserUsernameRequest}
111
110
  * @returns A Promise of User
112
111
  */
113
112
  updateUserUsername: (request: Readonly<UpdateUserUsernameRequest>) => Promise<User>;
114
113
  /**
115
- * Update an user's password. Private Beta feature.. Update an user's
116
- * password. Private Beta feature.
114
+ * Update an user's password.. Update an user's password.
117
115
  *
118
116
  * @param request - The request {@link UpdateUserPasswordRequest}
119
117
  * @returns A Promise of User
120
118
  */
121
119
  updateUserPassword: (request: Readonly<UpdateUserPasswordRequest>) => Promise<User>;
122
120
  /**
123
- * Create a MFA OTP. Private Beta feature.. Create a MFA OTP. Private Beta
124
- * feature.
121
+ * Create a MFA OTP.. Create a MFA OTP.
125
122
  *
126
123
  * @param request - The request {@link CreateUserMFAOTPRequest}
127
124
  * @returns A Promise of MFAOTP
128
125
  */
129
126
  createUserMFAOTP: (request: Readonly<CreateUserMFAOTPRequest>) => Promise<MFAOTP>;
130
127
  /**
131
- * Validate a MFA OTP. Private Beta feature.. Validate a MFA OTP. Private Beta
132
- * feature.
128
+ * Validate a MFA OTP.. Validate a MFA OTP.
133
129
  *
134
130
  * @param request - The request {@link ValidateUserMFAOTPRequest}
135
131
  * @returns A Promise of ValidateUserMFAOTPResponse
136
132
  */
137
133
  validateUserMFAOTP: (request: Readonly<ValidateUserMFAOTPRequest>) => Promise<ValidateUserMFAOTPResponse>;
138
134
  /**
139
- * Delete a MFA OTP. Private Beta feature.. Delete a MFA OTP. Private Beta
140
- * feature.
135
+ * Delete a MFA OTP.. Delete a MFA OTP.
141
136
  *
142
137
  * @param request - The request {@link DeleteUserMFAOTPRequest}
143
138
  */
144
139
  deleteUserMFAOTP: (request: Readonly<DeleteUserMFAOTPRequest>) => Promise<void>;
145
140
  /**
146
141
  * Lock a member. Lock a member. A locked member cannot log in or use API keys
147
- * until the locked status is removed. Private Beta feature.
142
+ * until the locked status is removed.
148
143
  *
149
144
  * @param request - The request {@link LockUserRequest}
150
145
  * @returns A Promise of User
151
146
  */
152
147
  lockUser: (request: Readonly<LockUserRequest>) => Promise<User>;
153
148
  /**
154
- * Unlock a member. Unlock a member. Private Beta feature.
149
+ * Unlock a member.
155
150
  *
156
151
  * @param request - The request {@link UnlockUserRequest}
157
152
  * @returns A Promise of User
158
153
  */
159
154
  unlockUser: (request: Readonly<UnlockUserRequest>) => Promise<User>;
160
155
  /**
161
- * List grace periods of a member. List the grace periods of a member. Private
162
- * Beta feature.
156
+ * List grace periods of a member. List the grace periods of a member.
163
157
  *
164
158
  * @param request - The request {@link ListGracePeriodsRequest}
165
159
  * @returns A Promise of ListGracePeriodsResponse
@@ -196,8 +196,7 @@ class API extends API$1 {
196
196
  unmarshalUser
197
197
  );
198
198
  /**
199
- * Update an user's username. Private Beta feature.. Update an user's
200
- * username. Private Beta feature.
199
+ * Update an user's username.. Update an user's username.
201
200
  *
202
201
  * @param request - The request {@link UpdateUserUsernameRequest}
203
202
  * @returns A Promise of User
@@ -214,8 +213,7 @@ class API extends API$1 {
214
213
  unmarshalUser
215
214
  );
216
215
  /**
217
- * Update an user's password. Private Beta feature.. Update an user's
218
- * password. Private Beta feature.
216
+ * Update an user's password.. Update an user's password.
219
217
  *
220
218
  * @param request - The request {@link UpdateUserPasswordRequest}
221
219
  * @returns A Promise of User
@@ -232,8 +230,7 @@ class API extends API$1 {
232
230
  unmarshalUser
233
231
  );
234
232
  /**
235
- * Create a MFA OTP. Private Beta feature.. Create a MFA OTP. Private Beta
236
- * feature.
233
+ * Create a MFA OTP.. Create a MFA OTP.
237
234
  *
238
235
  * @param request - The request {@link CreateUserMFAOTPRequest}
239
236
  * @returns A Promise of MFAOTP
@@ -248,8 +245,7 @@ class API extends API$1 {
248
245
  unmarshalMFAOTP
249
246
  );
250
247
  /**
251
- * Validate a MFA OTP. Private Beta feature.. Validate a MFA OTP. Private Beta
252
- * feature.
248
+ * Validate a MFA OTP.. Validate a MFA OTP.
253
249
  *
254
250
  * @param request - The request {@link ValidateUserMFAOTPRequest}
255
251
  * @returns A Promise of ValidateUserMFAOTPResponse
@@ -266,8 +262,7 @@ class API extends API$1 {
266
262
  unmarshalValidateUserMFAOTPResponse
267
263
  );
268
264
  /**
269
- * Delete a MFA OTP. Private Beta feature.. Delete a MFA OTP. Private Beta
270
- * feature.
265
+ * Delete a MFA OTP.. Delete a MFA OTP.
271
266
  *
272
267
  * @param request - The request {@link DeleteUserMFAOTPRequest}
273
268
  */
@@ -279,7 +274,7 @@ class API extends API$1 {
279
274
  });
280
275
  /**
281
276
  * Lock a member. Lock a member. A locked member cannot log in or use API keys
282
- * until the locked status is removed. Private Beta feature.
277
+ * until the locked status is removed.
283
278
  *
284
279
  * @param request - The request {@link LockUserRequest}
285
280
  * @returns A Promise of User
@@ -294,7 +289,7 @@ class API extends API$1 {
294
289
  unmarshalUser
295
290
  );
296
291
  /**
297
- * Unlock a member. Unlock a member. Private Beta feature.
292
+ * Unlock a member.
298
293
  *
299
294
  * @param request - The request {@link UnlockUserRequest}
300
295
  * @returns A Promise of User
@@ -309,8 +304,7 @@ class API extends API$1 {
309
304
  unmarshalUser
310
305
  );
311
306
  /**
312
- * List grace periods of a member. List the grace periods of a member. Private
313
- * Beta feature.
307
+ * List grace periods of a member. List the grace periods of a member.
314
308
  *
315
309
  * @param request - The request {@link ListGracePeriodsRequest}
316
310
  * @returns A Promise of ListGracePeriodsResponse
@@ -574,7 +574,7 @@ export type CreateUserRequest = {
574
574
  /** Tags associated with the user. */
575
575
  tags?: string[];
576
576
  /**
577
- * Details of IAM member. Private Beta feature.
577
+ * Details of IAM member.
578
578
  *
579
579
  * One-of ('type'): at most one of 'email', 'member' could be set.
580
580
  */
@@ -0,0 +1,76 @@
1
+ "use strict";
2
+ Object.defineProperties(exports, { __esModule: { value: true }, [Symbol.toStringTag]: { value: "Module" } });
3
+ const name = "@scaleway/sdk";
4
+ const version = "2.71.0";
5
+ const license = "Apache-2.0";
6
+ const description = "Scaleway SDK.";
7
+ const keywords = [
8
+ "scaleway",
9
+ "cloud",
10
+ "sdk"
11
+ ];
12
+ const main = "dist/index.cjs";
13
+ const module$1 = "dist/index.js";
14
+ const types = "dist/index.d.ts";
15
+ const scripts = {
16
+ typecheck: "tsc --noEmit",
17
+ "type:generate": "tsc --declaration -p tsconfig.build.json",
18
+ build: "vite build --config ../../vite.config.ts && pnpm run type:generate && tsc-alias -p tsconfig.build.json",
19
+ "build:profile": "npx vite-bundle-visualizer -c ../../vite.config.ts"
20
+ };
21
+ const files = [
22
+ "dist"
23
+ ];
24
+ const publishConfig = {
25
+ access: "public"
26
+ };
27
+ const repository = {
28
+ type: "git",
29
+ url: "https://github.com/scaleway/scaleway-sdk-js",
30
+ directory: "packages/clients"
31
+ };
32
+ const engines = {
33
+ node: ">=18.0"
34
+ };
35
+ const type = "module";
36
+ const dependencies = {
37
+ "@scaleway/random-name": "5.1.1"
38
+ };
39
+ const bundledDependencies = [
40
+ "@scaleway/random-name"
41
+ ];
42
+ const pkg = {
43
+ name,
44
+ version,
45
+ license,
46
+ description,
47
+ keywords,
48
+ main,
49
+ module: module$1,
50
+ types,
51
+ scripts,
52
+ files,
53
+ publishConfig,
54
+ repository,
55
+ engines,
56
+ type,
57
+ dependencies,
58
+ bundledDependencies
59
+ };
60
+ exports.bundledDependencies = bundledDependencies;
61
+ exports.default = pkg;
62
+ exports.dependencies = dependencies;
63
+ exports.description = description;
64
+ exports.engines = engines;
65
+ exports.files = files;
66
+ exports.keywords = keywords;
67
+ exports.license = license;
68
+ exports.main = main;
69
+ exports.module = module$1;
70
+ exports.name = name;
71
+ exports.publishConfig = publishConfig;
72
+ exports.repository = repository;
73
+ exports.scripts = scripts;
74
+ exports.type = type;
75
+ exports.types = types;
76
+ exports.version = version;
@@ -0,0 +1,76 @@
1
+ const name = "@scaleway/sdk";
2
+ const version = "2.71.0";
3
+ const license = "Apache-2.0";
4
+ const description = "Scaleway SDK.";
5
+ const keywords = [
6
+ "scaleway",
7
+ "cloud",
8
+ "sdk"
9
+ ];
10
+ const main = "dist/index.cjs";
11
+ const module = "dist/index.js";
12
+ const types = "dist/index.d.ts";
13
+ const scripts = {
14
+ typecheck: "tsc --noEmit",
15
+ "type:generate": "tsc --declaration -p tsconfig.build.json",
16
+ build: "vite build --config ../../vite.config.ts && pnpm run type:generate && tsc-alias -p tsconfig.build.json",
17
+ "build:profile": "npx vite-bundle-visualizer -c ../../vite.config.ts"
18
+ };
19
+ const files = [
20
+ "dist"
21
+ ];
22
+ const publishConfig = {
23
+ access: "public"
24
+ };
25
+ const repository = {
26
+ type: "git",
27
+ url: "https://github.com/scaleway/scaleway-sdk-js",
28
+ directory: "packages/clients"
29
+ };
30
+ const engines = {
31
+ node: ">=18.0"
32
+ };
33
+ const type = "module";
34
+ const dependencies = {
35
+ "@scaleway/random-name": "5.1.1"
36
+ };
37
+ const bundledDependencies = [
38
+ "@scaleway/random-name"
39
+ ];
40
+ const pkg = {
41
+ name,
42
+ version,
43
+ license,
44
+ description,
45
+ keywords,
46
+ main,
47
+ module,
48
+ types,
49
+ scripts,
50
+ files,
51
+ publishConfig,
52
+ repository,
53
+ engines,
54
+ type,
55
+ dependencies,
56
+ bundledDependencies
57
+ };
58
+ export {
59
+ bundledDependencies,
60
+ pkg as default,
61
+ dependencies,
62
+ description,
63
+ engines,
64
+ files,
65
+ keywords,
66
+ license,
67
+ main,
68
+ module,
69
+ name,
70
+ publishConfig,
71
+ repository,
72
+ scripts,
73
+ type,
74
+ types,
75
+ version
76
+ };
@@ -1,6 +1,7 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
3
- const version = "v2.70.0";
3
+ const _package = require("../package.json.cjs");
4
+ const { version } = _package.default;
4
5
  const userAgent = `scaleway-sdk-js/${version}`;
5
6
  exports.userAgent = userAgent;
6
7
  exports.version = version;
@@ -1,2 +1,2 @@
1
- export declare const version = "v2.70.0";
2
- export declare const userAgent = "scaleway-sdk-js/v2.70.0";
1
+ export declare const version: string;
2
+ export declare const userAgent: string;
@@ -1,4 +1,5 @@
1
- const version = "v2.70.0";
1
+ import pkg from "../package.json.js";
2
+ const { version } = pkg;
2
3
  const userAgent = `scaleway-sdk-js/${version}`;
3
4
  export {
4
5
  userAgent,
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@scaleway/sdk",
3
- "version": "2.71.0",
3
+ "version": "2.71.1",
4
4
  "license": "Apache-2.0",
5
5
  "description": "Scaleway SDK.",
6
6
  "keywords": [
@@ -12,7 +12,6 @@
12
12
  "module": "dist/index.js",
13
13
  "types": "dist/index.d.ts",
14
14
  "scripts": {
15
- "version": "./scripts/update-constants-file.sh",
16
15
  "typecheck": "tsc --noEmit",
17
16
  "type:generate": "tsc --declaration -p tsconfig.build.json",
18
17
  "build": "vite build --config ../../vite.config.ts && pnpm run type:generate && tsc-alias -p tsconfig.build.json",
@@ -39,5 +38,5 @@
39
38
  "bundledDependencies": [
40
39
  "@scaleway/random-name"
41
40
  ],
42
- "gitHead": "63b65bdaab2904d638e171a1b28eaa855e0a81ac"
41
+ "gitHead": "3436da6ff6b394f1000688c996f96c2471b2598a"
43
42
  }