@scaleway/sdk 2.56.0 → 2.58.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/api/audit_trail/index.gen.cjs +4 -0
- package/dist/api/audit_trail/index.gen.d.ts +5 -0
- package/dist/api/audit_trail/index.gen.js +4 -0
- package/dist/api/audit_trail/v1alpha1/api.gen.cjs +59 -0
- package/dist/api/audit_trail/v1alpha1/api.gen.d.ts +30 -0
- package/dist/api/audit_trail/v1alpha1/api.gen.js +59 -0
- package/dist/api/audit_trail/v1alpha1/index.gen.cjs +6 -0
- package/dist/api/audit_trail/v1alpha1/index.gen.d.ts +3 -0
- package/dist/api/audit_trail/v1alpha1/index.gen.js +6 -0
- package/dist/api/audit_trail/v1alpha1/marshalling.gen.cjs +155 -0
- package/dist/api/audit_trail/v1alpha1/marshalling.gen.d.ts +5 -0
- package/dist/api/audit_trail/v1alpha1/marshalling.gen.js +155 -0
- package/dist/api/audit_trail/v1alpha1/types.gen.d.ts +161 -0
- package/dist/api/audit_trail/v1alpha1/validation-rules.gen.cjs +19 -0
- package/dist/api/audit_trail/v1alpha1/validation-rules.gen.d.ts +16 -0
- package/dist/api/audit_trail/v1alpha1/validation-rules.gen.js +19 -0
- package/dist/api/billing/v2beta1/types.gen.d.ts +1 -1
- package/dist/api/edge_services/v1alpha1/types.gen.d.ts +5 -1
- package/dist/api/iam/v1alpha1/api.gen.cjs +9 -7
- package/dist/api/iam/v1alpha1/api.gen.d.ts +9 -7
- package/dist/api/iam/v1alpha1/api.gen.js +9 -7
- package/dist/api/iam/v1alpha1/types.gen.d.ts +2 -2
- package/dist/api/index.gen.d.ts +2 -1
- package/dist/api/instance/v1/api.gen.cjs +11 -0
- package/dist/api/instance/v1/api.gen.d.ts +2 -1
- package/dist/api/instance/v1/api.gen.js +12 -1
- package/dist/api/instance/v1/index.gen.d.ts +1 -1
- package/dist/api/instance/v1/marshalling.gen.cjs +5 -1
- package/dist/api/instance/v1/marshalling.gen.d.ts +2 -1
- package/dist/api/instance/v1/marshalling.gen.js +5 -1
- package/dist/api/instance/v1/types.gen.d.ts +10 -5
- package/dist/api/ipam/v1/api.gen.cjs +1 -0
- package/dist/api/ipam/v1/api.gen.js +1 -0
- package/dist/api/ipam/v1/types.gen.d.ts +6 -1
- package/dist/api/jobs/v1alpha1/validation-rules.gen.cjs +6 -0
- package/dist/api/jobs/v1alpha1/validation-rules.gen.d.ts +6 -0
- package/dist/api/jobs/v1alpha1/validation-rules.gen.js +6 -0
- package/dist/api/k8s/v1/marshalling.gen.cjs +1 -2
- package/dist/api/k8s/v1/marshalling.gen.js +1 -2
- package/dist/api/k8s/v1/types.gen.d.ts +2 -7
- package/dist/api/mnq/v1beta1/api.gen.cjs +47 -42
- package/dist/api/mnq/v1beta1/api.gen.d.ts +51 -49
- package/dist/api/mnq/v1beta1/api.gen.js +47 -42
- package/dist/api/mnq/v1beta1/types.gen.d.ts +37 -32
- package/dist/api/rdb/v1/types.gen.d.ts +15 -3
- package/dist/api/tem/v1alpha1/types.gen.d.ts +1 -1
- package/dist/api/webhosting/v1/api.gen.cjs +41 -2
- package/dist/api/webhosting/v1/api.gen.d.ts +26 -2
- package/dist/api/webhosting/v1/api.gen.js +42 -3
- package/dist/api/webhosting/v1/index.gen.cjs +1 -0
- package/dist/api/webhosting/v1/index.gen.d.ts +2 -2
- package/dist/api/webhosting/v1/index.gen.js +2 -1
- package/dist/api/webhosting/v1/marshalling.gen.cjs +123 -50
- package/dist/api/webhosting/v1/marshalling.gen.d.ts +4 -1
- package/dist/api/webhosting/v1/marshalling.gen.js +124 -51
- package/dist/api/webhosting/v1/types.gen.d.ts +124 -60
- package/dist/index.cjs +46 -44
- package/dist/index.js +46 -44
- package/dist/scw/constants.cjs +1 -1
- package/dist/scw/constants.d.ts +2 -2
- package/dist/scw/constants.js +1 -1
- package/package.json +2 -2
|
@@ -474,18 +474,13 @@ export interface Cluster {
|
|
|
474
474
|
privateNetworkId?: string;
|
|
475
475
|
/** Date on which it will be possible to switch to a smaller offer. */
|
|
476
476
|
commitmentEndsAt?: Date;
|
|
477
|
-
/**
|
|
478
|
-
* @deprecated Defines whether routed IPs are enabled for nodes of this
|
|
479
|
-
* cluster.
|
|
480
|
-
*/
|
|
481
|
-
routedIpEnabled?: boolean;
|
|
482
477
|
/**
|
|
483
478
|
* @deprecated Defines whether the SBS-enabled CSI starting from v0.3 is
|
|
484
479
|
* installed on the cluster.
|
|
485
480
|
*/
|
|
486
481
|
sbsCsiEnabled?: boolean;
|
|
487
|
-
/** @deprecated Defines whether
|
|
488
|
-
|
|
482
|
+
/** @deprecated Defines whether ACL is available on the cluster. */
|
|
483
|
+
aclAvailable?: boolean;
|
|
489
484
|
}
|
|
490
485
|
export interface Node {
|
|
491
486
|
/** Node ID. */
|
|
@@ -159,7 +159,8 @@ class NatsAPI extends api.API {
|
|
|
159
159
|
[
|
|
160
160
|
"page_size",
|
|
161
161
|
request.pageSize ?? this.client.settings.defaultPageSize
|
|
162
|
-
]
|
|
162
|
+
],
|
|
163
|
+
["project_id", request.projectId]
|
|
163
164
|
)
|
|
164
165
|
},
|
|
165
166
|
marshalling_gen.unmarshalListNatsCredentialsResponse
|
|
@@ -183,9 +184,10 @@ class SnsAPI extends api.API {
|
|
|
183
184
|
/** Lists the available regions of the API. */
|
|
184
185
|
static LOCALITIES = ["fr-par", "nl-ams"];
|
|
185
186
|
/**
|
|
186
|
-
* Activate
|
|
187
|
-
*
|
|
188
|
-
* and
|
|
187
|
+
* Activate Topics and Events. Activate Topics and Events for the specified
|
|
188
|
+
* Project ID. Topics and Events must be activated before any usage.
|
|
189
|
+
* Activating Topics and Events does not trigger any billing, and you can
|
|
190
|
+
* deactivate at any time.
|
|
189
191
|
*
|
|
190
192
|
* @param request - The request {@link SnsApiActivateSnsRequest}
|
|
191
193
|
* @returns A Promise of SnsInfo
|
|
@@ -202,8 +204,9 @@ class SnsAPI extends api.API {
|
|
|
202
204
|
marshalling_gen.unmarshalSnsInfo
|
|
203
205
|
);
|
|
204
206
|
/**
|
|
205
|
-
* Get
|
|
206
|
-
* Informations include the activation status and
|
|
207
|
+
* Get Topics and Events info. Retrieve the Topics and Events information of
|
|
208
|
+
* the specified Project ID. Informations include the activation status and
|
|
209
|
+
* the Topics and Events API endpoint URL.
|
|
207
210
|
*
|
|
208
211
|
* @param request - The request {@link SnsApiGetSnsInfoRequest}
|
|
209
212
|
* @returns A Promise of SnsInfo
|
|
@@ -220,9 +223,9 @@ class SnsAPI extends api.API {
|
|
|
220
223
|
marshalling_gen.unmarshalSnsInfo
|
|
221
224
|
);
|
|
222
225
|
/**
|
|
223
|
-
* Deactivate
|
|
224
|
-
*
|
|
225
|
-
* force_delete parameter.
|
|
226
|
+
* Deactivate Topics and Events. Deactivate Topics and Events for the
|
|
227
|
+
* specified Project ID. You must delete all topics and credentials before
|
|
228
|
+
* this call or you need to set the force_delete parameter.
|
|
226
229
|
*
|
|
227
230
|
* @param request - The request {@link SnsApiDeactivateSnsRequest}
|
|
228
231
|
* @returns A Promise of SnsInfo
|
|
@@ -239,9 +242,9 @@ class SnsAPI extends api.API {
|
|
|
239
242
|
marshalling_gen.unmarshalSnsInfo
|
|
240
243
|
);
|
|
241
244
|
/**
|
|
242
|
-
* Create
|
|
243
|
-
* Project ID. Credentials give the bearer
|
|
244
|
-
* permissions can be defined granularly.
|
|
245
|
+
* Create Topics and Events credentials. Create a set of credentials for
|
|
246
|
+
* Topics and Events, specified by a Project ID. Credentials give the bearer
|
|
247
|
+
* access to topics, and the level of permissions can be defined granularly.
|
|
245
248
|
*
|
|
246
249
|
* @param request - The request {@link SnsApiCreateSnsCredentialsRequest}
|
|
247
250
|
* @returns A Promise of SnsCredentials
|
|
@@ -261,9 +264,10 @@ class SnsAPI extends api.API {
|
|
|
261
264
|
marshalling_gen.unmarshalSnsCredentials
|
|
262
265
|
);
|
|
263
266
|
/**
|
|
264
|
-
* Delete
|
|
265
|
-
* credentials ID. Deleting credentials is
|
|
266
|
-
* The credentials can then no longer be
|
|
267
|
+
* Delete Topics and Events credentials. Delete a set of Topics and Events
|
|
268
|
+
* credentials, specified by their credentials ID. Deleting credentials is
|
|
269
|
+
* irreversible and cannot be undone. The credentials can then no longer be
|
|
270
|
+
* used to access Topics and Events.
|
|
267
271
|
*
|
|
268
272
|
* @param request - The request {@link SnsApiDeleteSnsCredentialsRequest}
|
|
269
273
|
*/
|
|
@@ -272,8 +276,8 @@ class SnsAPI extends api.API {
|
|
|
272
276
|
path: `/mnq/v1beta1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/sns-credentials/${marshalling.validatePathParam("snsCredentialsId", request.snsCredentialsId)}`
|
|
273
277
|
});
|
|
274
278
|
/**
|
|
275
|
-
* Update
|
|
276
|
-
* credentials' name, or their permissions.
|
|
279
|
+
* Update Topics and Events credentials. Update a set of Topics and Events
|
|
280
|
+
* credentials. You can update the credentials' name, or their permissions.
|
|
277
281
|
*
|
|
278
282
|
* @param request - The request {@link SnsApiUpdateSnsCredentialsRequest}
|
|
279
283
|
* @returns A Promise of SnsCredentials
|
|
@@ -293,9 +297,9 @@ class SnsAPI extends api.API {
|
|
|
293
297
|
marshalling_gen.unmarshalSnsCredentials
|
|
294
298
|
);
|
|
295
299
|
/**
|
|
296
|
-
* Get
|
|
297
|
-
* the `credentials_id`. The credentials themselves, as well as
|
|
298
|
-
* (name, project ID etc), are returned in the response.
|
|
300
|
+
* Get Topics and Events credentials. Retrieve an existing set of credentials,
|
|
301
|
+
* identified by the `credentials_id`. The credentials themselves, as well as
|
|
302
|
+
* their metadata (name, project ID etc), are returned in the response.
|
|
299
303
|
*
|
|
300
304
|
* @param request - The request {@link SnsApiGetSnsCredentialsRequest}
|
|
301
305
|
* @returns A Promise of SnsCredentials
|
|
@@ -324,9 +328,9 @@ class SnsAPI extends api.API {
|
|
|
324
328
|
marshalling_gen.unmarshalListSnsCredentialsResponse
|
|
325
329
|
);
|
|
326
330
|
/**
|
|
327
|
-
* List
|
|
328
|
-
* region. The response contains only the
|
|
329
|
-
* the credentials themselves.
|
|
331
|
+
* List Topics and Events credentials. List existing Topics and Events
|
|
332
|
+
* credentials in the specified region. The response contains only the
|
|
333
|
+
* metadata for the credentials, not the credentials themselves.
|
|
330
334
|
*
|
|
331
335
|
* @param request - The request {@link SnsApiListSnsCredentialsRequest}
|
|
332
336
|
* @returns A Promise of ListSnsCredentialsResponse
|
|
@@ -341,10 +345,10 @@ class SqsAPI extends api.API {
|
|
|
341
345
|
/** Lists the available regions of the API. */
|
|
342
346
|
static LOCALITIES = ["fr-par", "nl-ams"];
|
|
343
347
|
/**
|
|
344
|
-
* Activate
|
|
345
|
-
* activated before any usage such as creating credentials and queues.
|
|
346
|
-
* Activating
|
|
347
|
-
* time.
|
|
348
|
+
* Activate Queues. Activate Queues for the specified Project ID. Queues must
|
|
349
|
+
* be activated before any usage such as creating credentials and queues.
|
|
350
|
+
* Activating Queues does not trigger any billing, and you can deactivate at
|
|
351
|
+
* any time.
|
|
348
352
|
*
|
|
349
353
|
* @param request - The request {@link SqsApiActivateSqsRequest}
|
|
350
354
|
* @returns A Promise of SqsInfo
|
|
@@ -361,8 +365,9 @@ class SqsAPI extends api.API {
|
|
|
361
365
|
marshalling_gen.unmarshalSqsInfo
|
|
362
366
|
);
|
|
363
367
|
/**
|
|
364
|
-
* Get
|
|
365
|
-
* Informations include the activation status and the
|
|
368
|
+
* Get Queues info. Retrieve the Queues information of the specified Project
|
|
369
|
+
* ID. Informations include the activation status and the Queues API endpoint
|
|
370
|
+
* URL.
|
|
366
371
|
*
|
|
367
372
|
* @param request - The request {@link SqsApiGetSqsInfoRequest}
|
|
368
373
|
* @returns A Promise of SqsInfo
|
|
@@ -379,7 +384,7 @@ class SqsAPI extends api.API {
|
|
|
379
384
|
marshalling_gen.unmarshalSqsInfo
|
|
380
385
|
);
|
|
381
386
|
/**
|
|
382
|
-
* Deactivate
|
|
387
|
+
* Deactivate Queues. Deactivate Queues for the specified Project ID. You must
|
|
383
388
|
* delete all queues and credentials before this call or you need to set the
|
|
384
389
|
* force_delete parameter.
|
|
385
390
|
*
|
|
@@ -398,9 +403,9 @@ class SqsAPI extends api.API {
|
|
|
398
403
|
marshalling_gen.unmarshalSqsInfo
|
|
399
404
|
);
|
|
400
405
|
/**
|
|
401
|
-
* Create
|
|
402
|
-
* Project ID. Credentials give the bearer access to queues,
|
|
403
|
-
* permissions can be defined granularly.
|
|
406
|
+
* Create Queues credentials. Create a set of credentials for Queues,
|
|
407
|
+
* specified by a Project ID. Credentials give the bearer access to queues,
|
|
408
|
+
* and the level of permissions can be defined granularly.
|
|
404
409
|
*
|
|
405
410
|
* @param request - The request {@link SqsApiCreateSqsCredentialsRequest}
|
|
406
411
|
* @returns A Promise of SqsCredentials
|
|
@@ -420,9 +425,9 @@ class SqsAPI extends api.API {
|
|
|
420
425
|
marshalling_gen.unmarshalSqsCredentials
|
|
421
426
|
);
|
|
422
427
|
/**
|
|
423
|
-
* Delete
|
|
424
|
-
* credentials ID. Deleting credentials is irreversible and cannot be
|
|
425
|
-
* The credentials can then no longer be used to access
|
|
428
|
+
* Delete Queues credentials. Delete a set of Queues credentials, specified by
|
|
429
|
+
* their credentials ID. Deleting credentials is irreversible and cannot be
|
|
430
|
+
* undone. The credentials can then no longer be used to access Queues.
|
|
426
431
|
*
|
|
427
432
|
* @param request - The request {@link SqsApiDeleteSqsCredentialsRequest}
|
|
428
433
|
*/
|
|
@@ -431,8 +436,8 @@ class SqsAPI extends api.API {
|
|
|
431
436
|
path: `/mnq/v1beta1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/sqs-credentials/${marshalling.validatePathParam("sqsCredentialsId", request.sqsCredentialsId)}`
|
|
432
437
|
});
|
|
433
438
|
/**
|
|
434
|
-
* Update
|
|
435
|
-
* credentials' name, or their permissions.
|
|
439
|
+
* Update Queues credentials. Update a set of Queues credentials. You can
|
|
440
|
+
* update the credentials' name, or their permissions.
|
|
436
441
|
*
|
|
437
442
|
* @param request - The request {@link SqsApiUpdateSqsCredentialsRequest}
|
|
438
443
|
* @returns A Promise of SqsCredentials
|
|
@@ -452,9 +457,9 @@ class SqsAPI extends api.API {
|
|
|
452
457
|
marshalling_gen.unmarshalSqsCredentials
|
|
453
458
|
);
|
|
454
459
|
/**
|
|
455
|
-
* Get
|
|
456
|
-
* the `credentials_id`. The credentials themselves, as well as their
|
|
457
|
-
* (name, project ID etc), are returned in the response.
|
|
460
|
+
* Get Queues credentials. Retrieve an existing set of credentials, identified
|
|
461
|
+
* by the `credentials_id`. The credentials themselves, as well as their
|
|
462
|
+
* metadata (name, project ID etc), are returned in the response.
|
|
458
463
|
*
|
|
459
464
|
* @param request - The request {@link SqsApiGetSqsCredentialsRequest}
|
|
460
465
|
* @returns A Promise of SqsCredentials
|
|
@@ -483,7 +488,7 @@ class SqsAPI extends api.API {
|
|
|
483
488
|
marshalling_gen.unmarshalListSqsCredentialsResponse
|
|
484
489
|
);
|
|
485
490
|
/**
|
|
486
|
-
* List
|
|
491
|
+
* List Queues credentials. List existing Queues credentials in the specified
|
|
487
492
|
* region. The response contains only the metadata for the credentials, not
|
|
488
493
|
* the credentials themselves.
|
|
489
494
|
*
|
|
@@ -2,9 +2,9 @@ import { API as ParentAPI } from '../../../bridge';
|
|
|
2
2
|
import type { Region } from '../../../bridge';
|
|
3
3
|
import type { ListNatsAccountsResponse, ListNatsCredentialsResponse, ListSnsCredentialsResponse, ListSqsCredentialsResponse, NatsAccount, NatsApiCreateNatsAccountRequest, NatsApiCreateNatsCredentialsRequest, NatsApiDeleteNatsAccountRequest, NatsApiDeleteNatsCredentialsRequest, NatsApiGetNatsAccountRequest, NatsApiGetNatsCredentialsRequest, NatsApiListNatsAccountsRequest, NatsApiListNatsCredentialsRequest, NatsApiUpdateNatsAccountRequest, NatsCredentials, SnsApiActivateSnsRequest, SnsApiCreateSnsCredentialsRequest, SnsApiDeactivateSnsRequest, SnsApiDeleteSnsCredentialsRequest, SnsApiGetSnsCredentialsRequest, SnsApiGetSnsInfoRequest, SnsApiListSnsCredentialsRequest, SnsApiUpdateSnsCredentialsRequest, SnsCredentials, SnsInfo, SqsApiActivateSqsRequest, SqsApiCreateSqsCredentialsRequest, SqsApiDeactivateSqsRequest, SqsApiDeleteSqsCredentialsRequest, SqsApiGetSqsCredentialsRequest, SqsApiGetSqsInfoRequest, SqsApiListSqsCredentialsRequest, SqsApiUpdateSqsCredentialsRequest, SqsCredentials, SqsInfo } from './types.gen';
|
|
4
4
|
/**
|
|
5
|
-
*
|
|
5
|
+
* NATS API.
|
|
6
6
|
*
|
|
7
|
-
* This API allows you to manage Scaleway
|
|
7
|
+
* This API allows you to manage Scaleway NATS accounts.
|
|
8
8
|
*/
|
|
9
9
|
export declare class NatsAPI extends ParentAPI {
|
|
10
10
|
/** Lists the available regions of the API. */
|
|
@@ -99,69 +99,71 @@ export declare class NatsAPI extends ParentAPI {
|
|
|
99
99
|
};
|
|
100
100
|
}
|
|
101
101
|
/**
|
|
102
|
-
*
|
|
102
|
+
* Topics and Events API.
|
|
103
103
|
*
|
|
104
|
-
* This API allows you to manage your Scaleway
|
|
105
|
-
* brokers.
|
|
104
|
+
* This API allows you to manage your Scaleway Topics and Events.
|
|
106
105
|
*/
|
|
107
106
|
export declare class SnsAPI extends ParentAPI {
|
|
108
107
|
/** Lists the available regions of the API. */
|
|
109
108
|
static readonly LOCALITIES: Region[];
|
|
110
109
|
/**
|
|
111
|
-
* Activate
|
|
112
|
-
*
|
|
113
|
-
* and
|
|
110
|
+
* Activate Topics and Events. Activate Topics and Events for the specified
|
|
111
|
+
* Project ID. Topics and Events must be activated before any usage.
|
|
112
|
+
* Activating Topics and Events does not trigger any billing, and you can
|
|
113
|
+
* deactivate at any time.
|
|
114
114
|
*
|
|
115
115
|
* @param request - The request {@link SnsApiActivateSnsRequest}
|
|
116
116
|
* @returns A Promise of SnsInfo
|
|
117
117
|
*/
|
|
118
118
|
activateSns: (request?: Readonly<SnsApiActivateSnsRequest>) => Promise<SnsInfo>;
|
|
119
119
|
/**
|
|
120
|
-
* Get
|
|
121
|
-
* Informations include the activation status and
|
|
120
|
+
* Get Topics and Events info. Retrieve the Topics and Events information of
|
|
121
|
+
* the specified Project ID. Informations include the activation status and
|
|
122
|
+
* the Topics and Events API endpoint URL.
|
|
122
123
|
*
|
|
123
124
|
* @param request - The request {@link SnsApiGetSnsInfoRequest}
|
|
124
125
|
* @returns A Promise of SnsInfo
|
|
125
126
|
*/
|
|
126
127
|
getSnsInfo: (request?: Readonly<SnsApiGetSnsInfoRequest>) => Promise<SnsInfo>;
|
|
127
128
|
/**
|
|
128
|
-
* Deactivate
|
|
129
|
-
*
|
|
130
|
-
* force_delete parameter.
|
|
129
|
+
* Deactivate Topics and Events. Deactivate Topics and Events for the
|
|
130
|
+
* specified Project ID. You must delete all topics and credentials before
|
|
131
|
+
* this call or you need to set the force_delete parameter.
|
|
131
132
|
*
|
|
132
133
|
* @param request - The request {@link SnsApiDeactivateSnsRequest}
|
|
133
134
|
* @returns A Promise of SnsInfo
|
|
134
135
|
*/
|
|
135
136
|
deactivateSns: (request?: Readonly<SnsApiDeactivateSnsRequest>) => Promise<SnsInfo>;
|
|
136
137
|
/**
|
|
137
|
-
* Create
|
|
138
|
-
* Project ID. Credentials give the bearer
|
|
139
|
-
* permissions can be defined granularly.
|
|
138
|
+
* Create Topics and Events credentials. Create a set of credentials for
|
|
139
|
+
* Topics and Events, specified by a Project ID. Credentials give the bearer
|
|
140
|
+
* access to topics, and the level of permissions can be defined granularly.
|
|
140
141
|
*
|
|
141
142
|
* @param request - The request {@link SnsApiCreateSnsCredentialsRequest}
|
|
142
143
|
* @returns A Promise of SnsCredentials
|
|
143
144
|
*/
|
|
144
145
|
createSnsCredentials: (request?: Readonly<SnsApiCreateSnsCredentialsRequest>) => Promise<SnsCredentials>;
|
|
145
146
|
/**
|
|
146
|
-
* Delete
|
|
147
|
-
* credentials ID. Deleting credentials is
|
|
148
|
-
* The credentials can then no longer be
|
|
147
|
+
* Delete Topics and Events credentials. Delete a set of Topics and Events
|
|
148
|
+
* credentials, specified by their credentials ID. Deleting credentials is
|
|
149
|
+
* irreversible and cannot be undone. The credentials can then no longer be
|
|
150
|
+
* used to access Topics and Events.
|
|
149
151
|
*
|
|
150
152
|
* @param request - The request {@link SnsApiDeleteSnsCredentialsRequest}
|
|
151
153
|
*/
|
|
152
154
|
deleteSnsCredentials: (request: Readonly<SnsApiDeleteSnsCredentialsRequest>) => Promise<void>;
|
|
153
155
|
/**
|
|
154
|
-
* Update
|
|
155
|
-
* credentials' name, or their permissions.
|
|
156
|
+
* Update Topics and Events credentials. Update a set of Topics and Events
|
|
157
|
+
* credentials. You can update the credentials' name, or their permissions.
|
|
156
158
|
*
|
|
157
159
|
* @param request - The request {@link SnsApiUpdateSnsCredentialsRequest}
|
|
158
160
|
* @returns A Promise of SnsCredentials
|
|
159
161
|
*/
|
|
160
162
|
updateSnsCredentials: (request: Readonly<SnsApiUpdateSnsCredentialsRequest>) => Promise<SnsCredentials>;
|
|
161
163
|
/**
|
|
162
|
-
* Get
|
|
163
|
-
* the `credentials_id`. The credentials themselves, as well as
|
|
164
|
-
* (name, project ID etc), are returned in the response.
|
|
164
|
+
* Get Topics and Events credentials. Retrieve an existing set of credentials,
|
|
165
|
+
* identified by the `credentials_id`. The credentials themselves, as well as
|
|
166
|
+
* their metadata (name, project ID etc), are returned in the response.
|
|
165
167
|
*
|
|
166
168
|
* @param request - The request {@link SnsApiGetSnsCredentialsRequest}
|
|
167
169
|
* @returns A Promise of SnsCredentials
|
|
@@ -169,9 +171,9 @@ export declare class SnsAPI extends ParentAPI {
|
|
|
169
171
|
getSnsCredentials: (request: Readonly<SnsApiGetSnsCredentialsRequest>) => Promise<SnsCredentials>;
|
|
170
172
|
protected pageOfListSnsCredentials: (request?: Readonly<SnsApiListSnsCredentialsRequest>) => Promise<ListSnsCredentialsResponse>;
|
|
171
173
|
/**
|
|
172
|
-
* List
|
|
173
|
-
* region. The response contains only the
|
|
174
|
-
* the credentials themselves.
|
|
174
|
+
* List Topics and Events credentials. List existing Topics and Events
|
|
175
|
+
* credentials in the specified region. The response contains only the
|
|
176
|
+
* metadata for the credentials, not the credentials themselves.
|
|
175
177
|
*
|
|
176
178
|
* @param request - The request {@link SnsApiListSnsCredentialsRequest}
|
|
177
179
|
* @returns A Promise of ListSnsCredentialsResponse
|
|
@@ -182,34 +184,34 @@ export declare class SnsAPI extends ParentAPI {
|
|
|
182
184
|
};
|
|
183
185
|
}
|
|
184
186
|
/**
|
|
185
|
-
*
|
|
187
|
+
* Queues API.
|
|
186
188
|
*
|
|
187
|
-
* This API allows you to manage your Scaleway
|
|
188
|
-
* brokers.
|
|
189
|
+
* This API allows you to manage your Scaleway Queues.
|
|
189
190
|
*/
|
|
190
191
|
export declare class SqsAPI extends ParentAPI {
|
|
191
192
|
/** Lists the available regions of the API. */
|
|
192
193
|
static readonly LOCALITIES: Region[];
|
|
193
194
|
/**
|
|
194
|
-
* Activate
|
|
195
|
-
* activated before any usage such as creating credentials and queues.
|
|
196
|
-
* Activating
|
|
197
|
-
* time.
|
|
195
|
+
* Activate Queues. Activate Queues for the specified Project ID. Queues must
|
|
196
|
+
* be activated before any usage such as creating credentials and queues.
|
|
197
|
+
* Activating Queues does not trigger any billing, and you can deactivate at
|
|
198
|
+
* any time.
|
|
198
199
|
*
|
|
199
200
|
* @param request - The request {@link SqsApiActivateSqsRequest}
|
|
200
201
|
* @returns A Promise of SqsInfo
|
|
201
202
|
*/
|
|
202
203
|
activateSqs: (request?: Readonly<SqsApiActivateSqsRequest>) => Promise<SqsInfo>;
|
|
203
204
|
/**
|
|
204
|
-
* Get
|
|
205
|
-
* Informations include the activation status and the
|
|
205
|
+
* Get Queues info. Retrieve the Queues information of the specified Project
|
|
206
|
+
* ID. Informations include the activation status and the Queues API endpoint
|
|
207
|
+
* URL.
|
|
206
208
|
*
|
|
207
209
|
* @param request - The request {@link SqsApiGetSqsInfoRequest}
|
|
208
210
|
* @returns A Promise of SqsInfo
|
|
209
211
|
*/
|
|
210
212
|
getSqsInfo: (request?: Readonly<SqsApiGetSqsInfoRequest>) => Promise<SqsInfo>;
|
|
211
213
|
/**
|
|
212
|
-
* Deactivate
|
|
214
|
+
* Deactivate Queues. Deactivate Queues for the specified Project ID. You must
|
|
213
215
|
* delete all queues and credentials before this call or you need to set the
|
|
214
216
|
* force_delete parameter.
|
|
215
217
|
*
|
|
@@ -218,34 +220,34 @@ export declare class SqsAPI extends ParentAPI {
|
|
|
218
220
|
*/
|
|
219
221
|
deactivateSqs: (request?: Readonly<SqsApiDeactivateSqsRequest>) => Promise<SqsInfo>;
|
|
220
222
|
/**
|
|
221
|
-
* Create
|
|
222
|
-
* Project ID. Credentials give the bearer access to queues,
|
|
223
|
-
* permissions can be defined granularly.
|
|
223
|
+
* Create Queues credentials. Create a set of credentials for Queues,
|
|
224
|
+
* specified by a Project ID. Credentials give the bearer access to queues,
|
|
225
|
+
* and the level of permissions can be defined granularly.
|
|
224
226
|
*
|
|
225
227
|
* @param request - The request {@link SqsApiCreateSqsCredentialsRequest}
|
|
226
228
|
* @returns A Promise of SqsCredentials
|
|
227
229
|
*/
|
|
228
230
|
createSqsCredentials: (request?: Readonly<SqsApiCreateSqsCredentialsRequest>) => Promise<SqsCredentials>;
|
|
229
231
|
/**
|
|
230
|
-
* Delete
|
|
231
|
-
* credentials ID. Deleting credentials is irreversible and cannot be
|
|
232
|
-
* The credentials can then no longer be used to access
|
|
232
|
+
* Delete Queues credentials. Delete a set of Queues credentials, specified by
|
|
233
|
+
* their credentials ID. Deleting credentials is irreversible and cannot be
|
|
234
|
+
* undone. The credentials can then no longer be used to access Queues.
|
|
233
235
|
*
|
|
234
236
|
* @param request - The request {@link SqsApiDeleteSqsCredentialsRequest}
|
|
235
237
|
*/
|
|
236
238
|
deleteSqsCredentials: (request: Readonly<SqsApiDeleteSqsCredentialsRequest>) => Promise<void>;
|
|
237
239
|
/**
|
|
238
|
-
* Update
|
|
239
|
-
* credentials' name, or their permissions.
|
|
240
|
+
* Update Queues credentials. Update a set of Queues credentials. You can
|
|
241
|
+
* update the credentials' name, or their permissions.
|
|
240
242
|
*
|
|
241
243
|
* @param request - The request {@link SqsApiUpdateSqsCredentialsRequest}
|
|
242
244
|
* @returns A Promise of SqsCredentials
|
|
243
245
|
*/
|
|
244
246
|
updateSqsCredentials: (request: Readonly<SqsApiUpdateSqsCredentialsRequest>) => Promise<SqsCredentials>;
|
|
245
247
|
/**
|
|
246
|
-
* Get
|
|
247
|
-
* the `credentials_id`. The credentials themselves, as well as their
|
|
248
|
-
* (name, project ID etc), are returned in the response.
|
|
248
|
+
* Get Queues credentials. Retrieve an existing set of credentials, identified
|
|
249
|
+
* by the `credentials_id`. The credentials themselves, as well as their
|
|
250
|
+
* metadata (name, project ID etc), are returned in the response.
|
|
249
251
|
*
|
|
250
252
|
* @param request - The request {@link SqsApiGetSqsCredentialsRequest}
|
|
251
253
|
* @returns A Promise of SqsCredentials
|
|
@@ -253,7 +255,7 @@ export declare class SqsAPI extends ParentAPI {
|
|
|
253
255
|
getSqsCredentials: (request: Readonly<SqsApiGetSqsCredentialsRequest>) => Promise<SqsCredentials>;
|
|
254
256
|
protected pageOfListSqsCredentials: (request?: Readonly<SqsApiListSqsCredentialsRequest>) => Promise<ListSqsCredentialsResponse>;
|
|
255
257
|
/**
|
|
256
|
-
* List
|
|
258
|
+
* List Queues credentials. List existing Queues credentials in the specified
|
|
257
259
|
* region. The response contains only the metadata for the credentials, not
|
|
258
260
|
* the credentials themselves.
|
|
259
261
|
*
|
|
@@ -157,7 +157,8 @@ class NatsAPI extends API$1 {
|
|
|
157
157
|
[
|
|
158
158
|
"page_size",
|
|
159
159
|
request.pageSize ?? this.client.settings.defaultPageSize
|
|
160
|
-
]
|
|
160
|
+
],
|
|
161
|
+
["project_id", request.projectId]
|
|
161
162
|
)
|
|
162
163
|
},
|
|
163
164
|
unmarshalListNatsCredentialsResponse
|
|
@@ -181,9 +182,10 @@ class SnsAPI extends API$1 {
|
|
|
181
182
|
/** Lists the available regions of the API. */
|
|
182
183
|
static LOCALITIES = ["fr-par", "nl-ams"];
|
|
183
184
|
/**
|
|
184
|
-
* Activate
|
|
185
|
-
*
|
|
186
|
-
* and
|
|
185
|
+
* Activate Topics and Events. Activate Topics and Events for the specified
|
|
186
|
+
* Project ID. Topics and Events must be activated before any usage.
|
|
187
|
+
* Activating Topics and Events does not trigger any billing, and you can
|
|
188
|
+
* deactivate at any time.
|
|
187
189
|
*
|
|
188
190
|
* @param request - The request {@link SnsApiActivateSnsRequest}
|
|
189
191
|
* @returns A Promise of SnsInfo
|
|
@@ -200,8 +202,9 @@ class SnsAPI extends API$1 {
|
|
|
200
202
|
unmarshalSnsInfo
|
|
201
203
|
);
|
|
202
204
|
/**
|
|
203
|
-
* Get
|
|
204
|
-
* Informations include the activation status and
|
|
205
|
+
* Get Topics and Events info. Retrieve the Topics and Events information of
|
|
206
|
+
* the specified Project ID. Informations include the activation status and
|
|
207
|
+
* the Topics and Events API endpoint URL.
|
|
205
208
|
*
|
|
206
209
|
* @param request - The request {@link SnsApiGetSnsInfoRequest}
|
|
207
210
|
* @returns A Promise of SnsInfo
|
|
@@ -218,9 +221,9 @@ class SnsAPI extends API$1 {
|
|
|
218
221
|
unmarshalSnsInfo
|
|
219
222
|
);
|
|
220
223
|
/**
|
|
221
|
-
* Deactivate
|
|
222
|
-
*
|
|
223
|
-
* force_delete parameter.
|
|
224
|
+
* Deactivate Topics and Events. Deactivate Topics and Events for the
|
|
225
|
+
* specified Project ID. You must delete all topics and credentials before
|
|
226
|
+
* this call or you need to set the force_delete parameter.
|
|
224
227
|
*
|
|
225
228
|
* @param request - The request {@link SnsApiDeactivateSnsRequest}
|
|
226
229
|
* @returns A Promise of SnsInfo
|
|
@@ -237,9 +240,9 @@ class SnsAPI extends API$1 {
|
|
|
237
240
|
unmarshalSnsInfo
|
|
238
241
|
);
|
|
239
242
|
/**
|
|
240
|
-
* Create
|
|
241
|
-
* Project ID. Credentials give the bearer
|
|
242
|
-
* permissions can be defined granularly.
|
|
243
|
+
* Create Topics and Events credentials. Create a set of credentials for
|
|
244
|
+
* Topics and Events, specified by a Project ID. Credentials give the bearer
|
|
245
|
+
* access to topics, and the level of permissions can be defined granularly.
|
|
243
246
|
*
|
|
244
247
|
* @param request - The request {@link SnsApiCreateSnsCredentialsRequest}
|
|
245
248
|
* @returns A Promise of SnsCredentials
|
|
@@ -259,9 +262,10 @@ class SnsAPI extends API$1 {
|
|
|
259
262
|
unmarshalSnsCredentials
|
|
260
263
|
);
|
|
261
264
|
/**
|
|
262
|
-
* Delete
|
|
263
|
-
* credentials ID. Deleting credentials is
|
|
264
|
-
* The credentials can then no longer be
|
|
265
|
+
* Delete Topics and Events credentials. Delete a set of Topics and Events
|
|
266
|
+
* credentials, specified by their credentials ID. Deleting credentials is
|
|
267
|
+
* irreversible and cannot be undone. The credentials can then no longer be
|
|
268
|
+
* used to access Topics and Events.
|
|
265
269
|
*
|
|
266
270
|
* @param request - The request {@link SnsApiDeleteSnsCredentialsRequest}
|
|
267
271
|
*/
|
|
@@ -270,8 +274,8 @@ class SnsAPI extends API$1 {
|
|
|
270
274
|
path: `/mnq/v1beta1/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/sns-credentials/${validatePathParam("snsCredentialsId", request.snsCredentialsId)}`
|
|
271
275
|
});
|
|
272
276
|
/**
|
|
273
|
-
* Update
|
|
274
|
-
* credentials' name, or their permissions.
|
|
277
|
+
* Update Topics and Events credentials. Update a set of Topics and Events
|
|
278
|
+
* credentials. You can update the credentials' name, or their permissions.
|
|
275
279
|
*
|
|
276
280
|
* @param request - The request {@link SnsApiUpdateSnsCredentialsRequest}
|
|
277
281
|
* @returns A Promise of SnsCredentials
|
|
@@ -291,9 +295,9 @@ class SnsAPI extends API$1 {
|
|
|
291
295
|
unmarshalSnsCredentials
|
|
292
296
|
);
|
|
293
297
|
/**
|
|
294
|
-
* Get
|
|
295
|
-
* the `credentials_id`. The credentials themselves, as well as
|
|
296
|
-
* (name, project ID etc), are returned in the response.
|
|
298
|
+
* Get Topics and Events credentials. Retrieve an existing set of credentials,
|
|
299
|
+
* identified by the `credentials_id`. The credentials themselves, as well as
|
|
300
|
+
* their metadata (name, project ID etc), are returned in the response.
|
|
297
301
|
*
|
|
298
302
|
* @param request - The request {@link SnsApiGetSnsCredentialsRequest}
|
|
299
303
|
* @returns A Promise of SnsCredentials
|
|
@@ -322,9 +326,9 @@ class SnsAPI extends API$1 {
|
|
|
322
326
|
unmarshalListSnsCredentialsResponse
|
|
323
327
|
);
|
|
324
328
|
/**
|
|
325
|
-
* List
|
|
326
|
-
* region. The response contains only the
|
|
327
|
-
* the credentials themselves.
|
|
329
|
+
* List Topics and Events credentials. List existing Topics and Events
|
|
330
|
+
* credentials in the specified region. The response contains only the
|
|
331
|
+
* metadata for the credentials, not the credentials themselves.
|
|
328
332
|
*
|
|
329
333
|
* @param request - The request {@link SnsApiListSnsCredentialsRequest}
|
|
330
334
|
* @returns A Promise of ListSnsCredentialsResponse
|
|
@@ -339,10 +343,10 @@ class SqsAPI extends API$1 {
|
|
|
339
343
|
/** Lists the available regions of the API. */
|
|
340
344
|
static LOCALITIES = ["fr-par", "nl-ams"];
|
|
341
345
|
/**
|
|
342
|
-
* Activate
|
|
343
|
-
* activated before any usage such as creating credentials and queues.
|
|
344
|
-
* Activating
|
|
345
|
-
* time.
|
|
346
|
+
* Activate Queues. Activate Queues for the specified Project ID. Queues must
|
|
347
|
+
* be activated before any usage such as creating credentials and queues.
|
|
348
|
+
* Activating Queues does not trigger any billing, and you can deactivate at
|
|
349
|
+
* any time.
|
|
346
350
|
*
|
|
347
351
|
* @param request - The request {@link SqsApiActivateSqsRequest}
|
|
348
352
|
* @returns A Promise of SqsInfo
|
|
@@ -359,8 +363,9 @@ class SqsAPI extends API$1 {
|
|
|
359
363
|
unmarshalSqsInfo
|
|
360
364
|
);
|
|
361
365
|
/**
|
|
362
|
-
* Get
|
|
363
|
-
* Informations include the activation status and the
|
|
366
|
+
* Get Queues info. Retrieve the Queues information of the specified Project
|
|
367
|
+
* ID. Informations include the activation status and the Queues API endpoint
|
|
368
|
+
* URL.
|
|
364
369
|
*
|
|
365
370
|
* @param request - The request {@link SqsApiGetSqsInfoRequest}
|
|
366
371
|
* @returns A Promise of SqsInfo
|
|
@@ -377,7 +382,7 @@ class SqsAPI extends API$1 {
|
|
|
377
382
|
unmarshalSqsInfo
|
|
378
383
|
);
|
|
379
384
|
/**
|
|
380
|
-
* Deactivate
|
|
385
|
+
* Deactivate Queues. Deactivate Queues for the specified Project ID. You must
|
|
381
386
|
* delete all queues and credentials before this call or you need to set the
|
|
382
387
|
* force_delete parameter.
|
|
383
388
|
*
|
|
@@ -396,9 +401,9 @@ class SqsAPI extends API$1 {
|
|
|
396
401
|
unmarshalSqsInfo
|
|
397
402
|
);
|
|
398
403
|
/**
|
|
399
|
-
* Create
|
|
400
|
-
* Project ID. Credentials give the bearer access to queues,
|
|
401
|
-
* permissions can be defined granularly.
|
|
404
|
+
* Create Queues credentials. Create a set of credentials for Queues,
|
|
405
|
+
* specified by a Project ID. Credentials give the bearer access to queues,
|
|
406
|
+
* and the level of permissions can be defined granularly.
|
|
402
407
|
*
|
|
403
408
|
* @param request - The request {@link SqsApiCreateSqsCredentialsRequest}
|
|
404
409
|
* @returns A Promise of SqsCredentials
|
|
@@ -418,9 +423,9 @@ class SqsAPI extends API$1 {
|
|
|
418
423
|
unmarshalSqsCredentials
|
|
419
424
|
);
|
|
420
425
|
/**
|
|
421
|
-
* Delete
|
|
422
|
-
* credentials ID. Deleting credentials is irreversible and cannot be
|
|
423
|
-
* The credentials can then no longer be used to access
|
|
426
|
+
* Delete Queues credentials. Delete a set of Queues credentials, specified by
|
|
427
|
+
* their credentials ID. Deleting credentials is irreversible and cannot be
|
|
428
|
+
* undone. The credentials can then no longer be used to access Queues.
|
|
424
429
|
*
|
|
425
430
|
* @param request - The request {@link SqsApiDeleteSqsCredentialsRequest}
|
|
426
431
|
*/
|
|
@@ -429,8 +434,8 @@ class SqsAPI extends API$1 {
|
|
|
429
434
|
path: `/mnq/v1beta1/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/sqs-credentials/${validatePathParam("sqsCredentialsId", request.sqsCredentialsId)}`
|
|
430
435
|
});
|
|
431
436
|
/**
|
|
432
|
-
* Update
|
|
433
|
-
* credentials' name, or their permissions.
|
|
437
|
+
* Update Queues credentials. Update a set of Queues credentials. You can
|
|
438
|
+
* update the credentials' name, or their permissions.
|
|
434
439
|
*
|
|
435
440
|
* @param request - The request {@link SqsApiUpdateSqsCredentialsRequest}
|
|
436
441
|
* @returns A Promise of SqsCredentials
|
|
@@ -450,9 +455,9 @@ class SqsAPI extends API$1 {
|
|
|
450
455
|
unmarshalSqsCredentials
|
|
451
456
|
);
|
|
452
457
|
/**
|
|
453
|
-
* Get
|
|
454
|
-
* the `credentials_id`. The credentials themselves, as well as their
|
|
455
|
-
* (name, project ID etc), are returned in the response.
|
|
458
|
+
* Get Queues credentials. Retrieve an existing set of credentials, identified
|
|
459
|
+
* by the `credentials_id`. The credentials themselves, as well as their
|
|
460
|
+
* metadata (name, project ID etc), are returned in the response.
|
|
456
461
|
*
|
|
457
462
|
* @param request - The request {@link SqsApiGetSqsCredentialsRequest}
|
|
458
463
|
* @returns A Promise of SqsCredentials
|
|
@@ -481,7 +486,7 @@ class SqsAPI extends API$1 {
|
|
|
481
486
|
unmarshalListSqsCredentialsResponse
|
|
482
487
|
);
|
|
483
488
|
/**
|
|
484
|
-
* List
|
|
489
|
+
* List Queues credentials. List existing Queues credentials in the specified
|
|
485
490
|
* region. The response contains only the metadata for the credentials, not
|
|
486
491
|
* the credentials themselves.
|
|
487
492
|
*
|