@scaleway/sdk 2.57.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.
@@ -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
- * Messaging and Queuing NATS API.
5
+ * NATS API.
6
6
  *
7
- * This API allows you to manage Scaleway Messaging and Queuing NATS accounts.
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
- * Messaging and Queuing SNS API.
102
+ * Topics and Events API.
103
103
  *
104
- * This API allows you to manage your Scaleway Messaging and Queuing SNS
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 SNS. Activate SNS for the specified Project ID. SNS must be
112
- * activated before any usage. Activating SNS does not trigger any billing,
113
- * and you can deactivate at any time.
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 SNS info. Retrieve the SNS information of the specified Project ID.
121
- * Informations include the activation status and the SNS API endpoint URL.
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 SNS. Deactivate SNS for the specified Project ID.You must delete
129
- * all topics and credentials before this call or you need to set the
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 SNS credentials. Create a set of credentials for SNS, specified by a
138
- * Project ID. Credentials give the bearer access to topics, and the level of
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 SNS credentials. Delete a set of SNS credentials, specified by their
147
- * credentials ID. Deleting credentials is irreversible and cannot be undone.
148
- * The credentials can then no longer be used to access SNS.
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 SNS credentials. Update a set of SNS credentials. You can update the
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 SNS credentials. Retrieve an existing set of credentials, identified by
163
- * the `credentials_id`. The credentials themselves, as well as their metadata
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 SNS credentials. List existing SNS credentials in the specified
173
- * region. The response contains only the metadata for the credentials, not
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
- * Messaging and Queuing SQS API.
187
+ * Queues API.
186
188
  *
187
- * This API allows you to manage your Scaleway Messaging and Queuing SQS
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 SQS. Activate SQS for the specified Project ID. SQS must be
195
- * activated before any usage such as creating credentials and queues.
196
- * Activating SQS does not trigger any billing, and you can deactivate at any
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 SQS info. Retrieve the SQS information of the specified Project ID.
205
- * Informations include the activation status and the SQS API endpoint URL.
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 SQS. Deactivate SQS for the specified Project ID. You must
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 SQS credentials. Create a set of credentials for SQS, specified by a
222
- * Project ID. Credentials give the bearer access to queues, and the level of
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 SQS credentials. Delete a set of SQS credentials, specified by their
231
- * credentials ID. Deleting credentials is irreversible and cannot be undone.
232
- * The credentials can then no longer be used to access SQS.
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 SQS credentials. Update a set of SQS credentials. You can update the
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 SQS credentials. Retrieve an existing set of credentials, identified by
247
- * the `credentials_id`. The credentials themselves, as well as their metadata
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 SQS credentials. List existing SQS credentials in the specified
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 SNS. Activate SNS for the specified Project ID. SNS must be
185
- * activated before any usage. Activating SNS does not trigger any billing,
186
- * and you can deactivate at any time.
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 SNS info. Retrieve the SNS information of the specified Project ID.
204
- * Informations include the activation status and the SNS API endpoint URL.
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 SNS. Deactivate SNS for the specified Project ID.You must delete
222
- * all topics and credentials before this call or you need to set the
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 SNS credentials. Create a set of credentials for SNS, specified by a
241
- * Project ID. Credentials give the bearer access to topics, and the level of
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 SNS credentials. Delete a set of SNS credentials, specified by their
263
- * credentials ID. Deleting credentials is irreversible and cannot be undone.
264
- * The credentials can then no longer be used to access SNS.
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 SNS credentials. Update a set of SNS credentials. You can update the
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 SNS credentials. Retrieve an existing set of credentials, identified by
295
- * the `credentials_id`. The credentials themselves, as well as their metadata
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 SNS credentials. List existing SNS credentials in the specified
326
- * region. The response contains only the metadata for the credentials, not
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 SQS. Activate SQS for the specified Project ID. SQS must be
343
- * activated before any usage such as creating credentials and queues.
344
- * Activating SQS does not trigger any billing, and you can deactivate at any
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 SQS info. Retrieve the SQS information of the specified Project ID.
363
- * Informations include the activation status and the SQS API endpoint URL.
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 SQS. Deactivate SQS for the specified Project ID. You must
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 SQS credentials. Create a set of credentials for SQS, specified by a
400
- * Project ID. Credentials give the bearer access to queues, and the level of
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 SQS credentials. Delete a set of SQS credentials, specified by their
422
- * credentials ID. Deleting credentials is irreversible and cannot be undone.
423
- * The credentials can then no longer be used to access SQS.
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 SQS credentials. Update a set of SQS credentials. You can update the
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 SQS credentials. Retrieve an existing set of credentials, identified by
454
- * the `credentials_id`. The credentials themselves, as well as their metadata
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 SQS credentials. List existing SQS credentials in the specified
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
  *
@@ -14,7 +14,7 @@ export interface File {
14
14
  export interface SnsPermissions {
15
15
  /**
16
16
  * Defines whether the credentials bearer can publish messages to the service
17
- * (publish to SNS topics).
17
+ * (publish to Topics and Events topics).
18
18
  */
19
19
  canPublish?: boolean;
20
20
  /**
@@ -23,24 +23,24 @@ export interface SnsPermissions {
23
23
  */
24
24
  canReceive?: boolean;
25
25
  /**
26
- * Defines whether the credentials bearer can manage the associated SNS topics
27
- * or subscriptions.
26
+ * Defines whether the credentials bearer can manage the associated Topics and
27
+ * Events topics or subscriptions.
28
28
  */
29
29
  canManage?: boolean;
30
30
  }
31
31
  export interface SqsPermissions {
32
32
  /**
33
33
  * Defines whether the credentials bearer can publish messages to the service
34
- * (send messages to SQS queues).
34
+ * (send messages to Queues queues).
35
35
  */
36
36
  canPublish?: boolean;
37
37
  /**
38
- * Defines whether the credentials bearer can receive messages from SQS
38
+ * Defines whether the credentials bearer can receive messages from Queues
39
39
  * queues.
40
40
  */
41
41
  canReceive?: boolean;
42
42
  /**
43
- * Defines whether the credentials bearer can manage the associated SQS
43
+ * Defines whether the credentials bearer can manage the associated Queues
44
44
  * queues.
45
45
  */
46
46
  canManage?: boolean;
@@ -95,7 +95,10 @@ export interface SnsCredentials {
95
95
  updatedAt?: Date;
96
96
  /** Access key ID. */
97
97
  accessKey: string;
98
- /** Secret key ID (Only returned by **Create SNS Credentials** call). */
98
+ /**
99
+ * Secret key ID (Only returned by **Create Topics and Events Credentials**
100
+ * call).
101
+ */
99
102
  secretKey: string;
100
103
  /** Checksum of the Secret key. */
101
104
  secretChecksum: string;
@@ -117,7 +120,7 @@ export interface SqsCredentials {
117
120
  updatedAt?: Date;
118
121
  /** Access key ID. */
119
122
  accessKey: string;
120
- /** Secret key ID (Only returned by **Create SQS Credentials** call). */
123
+ /** Secret key ID (Only returned by **Create Queues Credentials** call). */
121
124
  secretKey: string;
122
125
  /** Checksum of the Secret key. */
123
126
  secretChecksum: string;
@@ -139,13 +142,13 @@ export interface ListNatsCredentialsResponse {
139
142
  export interface ListSnsCredentialsResponse {
140
143
  /** Total count of existing credentials (matching any filters specified). */
141
144
  totalCount: number;
142
- /** SNS credentials on this page. */
145
+ /** Topics and Events credentials on this page. */
143
146
  snsCredentials: SnsCredentials[];
144
147
  }
145
148
  export interface ListSqsCredentialsResponse {
146
149
  /** Total count of existing credentials (matching any filters specified). */
147
150
  totalCount: number;
148
- /** SQS credentials on this page. */
151
+ /** Queues credentials on this page. */
149
152
  sqsCredentials: SqsCredentials[];
150
153
  }
151
154
  export type NatsApiCreateNatsAccountRequest = {
@@ -227,6 +230,8 @@ export type NatsApiListNatsCredentialsRequest = {
227
230
  * config.
228
231
  */
229
232
  region?: Region;
233
+ /** Include only NATS accounts in this Project. */
234
+ projectId?: string;
230
235
  /** Include only credentials for this NATS account. */
231
236
  natsAccountId?: string;
232
237
  /** Page number to return. */
@@ -253,7 +258,7 @@ export type SnsApiActivateSnsRequest = {
253
258
  * config.
254
259
  */
255
260
  region?: Region;
256
- /** Project on which to activate the SNS service. */
261
+ /** Project on which to activate the Topics and Events service. */
257
262
  projectId?: string;
258
263
  };
259
264
  export type SnsApiCreateSnsCredentialsRequest = {
@@ -262,7 +267,7 @@ export type SnsApiCreateSnsCredentialsRequest = {
262
267
  * config.
263
268
  */
264
269
  region?: Region;
265
- /** Project containing the SNS credentials. */
270
+ /** Project containing the Topics and Events credentials. */
266
271
  projectId?: string;
267
272
  /** Name of the credentials. */
268
273
  name?: string;
@@ -275,7 +280,7 @@ export type SnsApiDeactivateSnsRequest = {
275
280
  * config.
276
281
  */
277
282
  region?: Region;
278
- /** Project on which to deactivate the SNS service. */
283
+ /** Project on which to deactivate the Topics and Events service. */
279
284
  projectId?: string;
280
285
  };
281
286
  export type SnsApiDeleteSnsCredentialsRequest = {
@@ -293,7 +298,7 @@ export type SnsApiGetSnsCredentialsRequest = {
293
298
  * config.
294
299
  */
295
300
  region?: Region;
296
- /** ID of the SNS credentials to get. */
301
+ /** ID of the Topics and Events credentials to get. */
297
302
  snsCredentialsId: string;
298
303
  };
299
304
  export type SnsApiGetSnsInfoRequest = {
@@ -302,7 +307,7 @@ export type SnsApiGetSnsInfoRequest = {
302
307
  * config.
303
308
  */
304
309
  region?: Region;
305
- /** Project to retrieve SNS info from. */
310
+ /** Project to retrieve Topics and Events info from. */
306
311
  projectId?: string;
307
312
  };
308
313
  export type SnsApiListSnsCredentialsRequest = {
@@ -311,7 +316,7 @@ export type SnsApiListSnsCredentialsRequest = {
311
316
  * config.
312
317
  */
313
318
  region?: Region;
314
- /** Include only SNS credentials in this Project. */
319
+ /** Include only Topics and Events credentials in this Project. */
315
320
  projectId?: string;
316
321
  /** Page number to return. */
317
322
  page?: number;
@@ -326,7 +331,7 @@ export type SnsApiUpdateSnsCredentialsRequest = {
326
331
  * config.
327
332
  */
328
333
  region?: Region;
329
- /** ID of the SNS credentials to update. */
334
+ /** ID of the Topics and Events credentials to update. */
330
335
  snsCredentialsId: string;
331
336
  /** Name of the credentials. */
332
337
  name?: string;
@@ -338,13 +343,13 @@ export interface SnsInfo {
338
343
  projectId: string;
339
344
  /** Region of the service. */
340
345
  region: Region;
341
- /** SNS creation date. */
346
+ /** Topics and Events creation date. */
342
347
  createdAt?: Date;
343
- /** SNS last modification date. */
348
+ /** Topics and Events last modification date. */
344
349
  updatedAt?: Date;
345
- /** SNS activation status. */
350
+ /** Topics and Events activation status. */
346
351
  status: SnsInfoStatus;
347
- /** Endpoint of the SNS service for this region and project. */
352
+ /** Endpoint of the Topics and Events service for this region and project. */
348
353
  snsEndpointUrl: string;
349
354
  }
350
355
  export type SqsApiActivateSqsRequest = {
@@ -353,7 +358,7 @@ export type SqsApiActivateSqsRequest = {
353
358
  * config.
354
359
  */
355
360
  region?: Region;
356
- /** Project on which to activate the SQS service. */
361
+ /** Project on which to activate the Queues service. */
357
362
  projectId?: string;
358
363
  };
359
364
  export type SqsApiCreateSqsCredentialsRequest = {
@@ -362,7 +367,7 @@ export type SqsApiCreateSqsCredentialsRequest = {
362
367
  * config.
363
368
  */
364
369
  region?: Region;
365
- /** Project containing the SQS credentials. */
370
+ /** Project containing the Queues credentials. */
366
371
  projectId?: string;
367
372
  /** Name of the credentials. */
368
373
  name?: string;
@@ -375,7 +380,7 @@ export type SqsApiDeactivateSqsRequest = {
375
380
  * config.
376
381
  */
377
382
  region?: Region;
378
- /** Project on which to deactivate the SQS service. */
383
+ /** Project on which to deactivate the Queues service. */
379
384
  projectId?: string;
380
385
  };
381
386
  export type SqsApiDeleteSqsCredentialsRequest = {
@@ -393,7 +398,7 @@ export type SqsApiGetSqsCredentialsRequest = {
393
398
  * config.
394
399
  */
395
400
  region?: Region;
396
- /** ID of the SQS credentials to get. */
401
+ /** ID of the Queues credentials to get. */
397
402
  sqsCredentialsId: string;
398
403
  };
399
404
  export type SqsApiGetSqsInfoRequest = {
@@ -402,7 +407,7 @@ export type SqsApiGetSqsInfoRequest = {
402
407
  * config.
403
408
  */
404
409
  region?: Region;
405
- /** Project to retrieve SQS info from. */
410
+ /** Project to retrieve Queues info from. */
406
411
  projectId?: string;
407
412
  };
408
413
  export type SqsApiListSqsCredentialsRequest = {
@@ -411,7 +416,7 @@ export type SqsApiListSqsCredentialsRequest = {
411
416
  * config.
412
417
  */
413
418
  region?: Region;
414
- /** Include only SQS credentials in this Project. */
419
+ /** Include only Queues credentials in this Project. */
415
420
  projectId?: string;
416
421
  /** Page number to return. */
417
422
  page?: number;
@@ -426,7 +431,7 @@ export type SqsApiUpdateSqsCredentialsRequest = {
426
431
  * config.
427
432
  */
428
433
  region?: Region;
429
- /** ID of the SQS credentials to update. */
434
+ /** ID of the Queues credentials to update. */
430
435
  sqsCredentialsId: string;
431
436
  /** Name of the credentials. */
432
437
  name?: string;
@@ -438,12 +443,12 @@ export interface SqsInfo {
438
443
  projectId: string;
439
444
  /** Region of the service. */
440
445
  region: Region;
441
- /** SQS creation date. */
446
+ /** Queues creation date. */
442
447
  createdAt?: Date;
443
- /** SQS last modification date. */
448
+ /** Queues last modification date. */
444
449
  updatedAt?: Date;
445
- /** SQS activation status. */
450
+ /** Queues activation status. */
446
451
  status: SqsInfoStatus;
447
- /** Endpoint of the SQS service for this region and project. */
452
+ /** Endpoint of the Queues service for this region and project. */
448
453
  sqsEndpointUrl: string;
449
454
  }