@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.
- package/dist/api/audit_trail/v1alpha1/types.gen.d.ts +19 -0
- 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/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 +5 -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/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/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
|
@@ -67,24 +67,41 @@ export interface Resource {
|
|
|
67
67
|
kubeAclInfo?: KubernetesACLInfo;
|
|
68
68
|
}
|
|
69
69
|
export interface Event {
|
|
70
|
+
/** ID of the event. */
|
|
70
71
|
id: string;
|
|
72
|
+
/** Timestamp of the event. */
|
|
71
73
|
recordedAt?: Date;
|
|
74
|
+
/** Locality of the resource attached to the event. */
|
|
72
75
|
locality: string;
|
|
76
|
+
/** User or IAM application at the origin of the event. */
|
|
73
77
|
principal?: EventPrincipal;
|
|
78
|
+
/** Organization ID containing the event. */
|
|
74
79
|
organizationId: string;
|
|
80
|
+
/** (Optional) Project of the resource attached to the event. */
|
|
75
81
|
projectId?: string;
|
|
82
|
+
/** IP address at the origin of the event. */
|
|
76
83
|
sourceIp: string;
|
|
84
|
+
/** User Agent at the origin of the event. */
|
|
77
85
|
userAgent?: string;
|
|
86
|
+
/** Product name of the resource attached to the event. */
|
|
78
87
|
productName: string;
|
|
88
|
+
/** API name called to trigger the event. */
|
|
79
89
|
serviceName: string;
|
|
90
|
+
/** API method called to trigger the event. */
|
|
80
91
|
methodName: string;
|
|
92
|
+
/** Resource attached to the event. */
|
|
81
93
|
resource?: Resource;
|
|
94
|
+
/** Unique identifier of the request at the origin of the event. */
|
|
82
95
|
requestId: string;
|
|
96
|
+
/** Request at the origin of the event. */
|
|
83
97
|
requestBody?: Record<string, unknown>;
|
|
98
|
+
/** HTTP status code resulting of the API call. */
|
|
84
99
|
statusCode: number;
|
|
85
100
|
}
|
|
86
101
|
export interface Product {
|
|
102
|
+
/** Product title. */
|
|
87
103
|
title: string;
|
|
104
|
+
/** Product name. */
|
|
88
105
|
name: string;
|
|
89
106
|
}
|
|
90
107
|
export type ListEventsRequest = {
|
|
@@ -137,6 +154,8 @@ export type ListProductsRequest = {
|
|
|
137
154
|
region?: Region;
|
|
138
155
|
};
|
|
139
156
|
export interface ListProductsResponse {
|
|
157
|
+
/** List of all products integrated with Audit Trail. */
|
|
140
158
|
products: Product[];
|
|
159
|
+
/** Number of integrated products. */
|
|
141
160
|
totalCount: number;
|
|
142
161
|
}
|
|
@@ -197,7 +197,8 @@ class API extends api.API {
|
|
|
197
197
|
marshalling_gen.unmarshalUser
|
|
198
198
|
);
|
|
199
199
|
/**
|
|
200
|
-
* Update an user's password.
|
|
200
|
+
* Update an user's password. Private Beta feature.. Update an user's
|
|
201
|
+
* password. Private Beta feature.
|
|
201
202
|
*
|
|
202
203
|
* @param request - The request {@link UpdateUserPasswordRequest}
|
|
203
204
|
* @returns A Promise of User
|
|
@@ -214,8 +215,8 @@ class API extends api.API {
|
|
|
214
215
|
marshalling_gen.unmarshalUser
|
|
215
216
|
);
|
|
216
217
|
/**
|
|
217
|
-
* Lock a
|
|
218
|
-
*
|
|
218
|
+
* Lock a member. Lock a member. A locked member cannot log in or use API keys
|
|
219
|
+
* until the locked status is removed. Private Beta feature.
|
|
219
220
|
*
|
|
220
221
|
* @param request - The request {@link LockUserRequest}
|
|
221
222
|
* @returns A Promise of User
|
|
@@ -230,7 +231,7 @@ class API extends api.API {
|
|
|
230
231
|
marshalling_gen.unmarshalUser
|
|
231
232
|
);
|
|
232
233
|
/**
|
|
233
|
-
* Unlock a
|
|
234
|
+
* Unlock a member. Unlock a member. Private Beta feature.
|
|
234
235
|
*
|
|
235
236
|
* @param request - The request {@link UnlockUserRequest}
|
|
236
237
|
* @returns A Promise of User
|
|
@@ -245,7 +246,8 @@ class API extends api.API {
|
|
|
245
246
|
marshalling_gen.unmarshalUser
|
|
246
247
|
);
|
|
247
248
|
/**
|
|
248
|
-
* List grace periods of a
|
|
249
|
+
* List grace periods of a member. List the grace periods of a member. Private
|
|
250
|
+
* Beta feature.
|
|
249
251
|
*
|
|
250
252
|
* @param request - The request {@link ListGracePeriodsRequest}
|
|
251
253
|
* @returns A Promise of ListGracePeriodsResponse
|
|
@@ -783,9 +785,9 @@ class API extends api.API {
|
|
|
783
785
|
/**
|
|
784
786
|
* Create an API key. Create an API key. You must specify the `application_id`
|
|
785
787
|
* or the `user_id` and the description. You can also specify the
|
|
786
|
-
* `default_project_id
|
|
788
|
+
* `default_project_id`, which is the Project ID of your preferred Project, to
|
|
787
789
|
* use with Object Storage. The `access_key` and `secret_key` values are
|
|
788
|
-
* returned in the response. Note that
|
|
790
|
+
* returned in the response. Note that the secret key is only shown once. Make
|
|
789
791
|
* sure that you copy and store both keys somewhere safe.
|
|
790
792
|
*
|
|
791
793
|
* @param request - The request {@link CreateAPIKeyRequest}
|
|
@@ -104,29 +104,31 @@ export declare class API extends ParentAPI {
|
|
|
104
104
|
*/
|
|
105
105
|
createUser: (request?: Readonly<CreateUserRequest>) => Promise<User>;
|
|
106
106
|
/**
|
|
107
|
-
* Update an user's password.
|
|
107
|
+
* Update an user's password. Private Beta feature.. Update an user's
|
|
108
|
+
* password. Private Beta feature.
|
|
108
109
|
*
|
|
109
110
|
* @param request - The request {@link UpdateUserPasswordRequest}
|
|
110
111
|
* @returns A Promise of User
|
|
111
112
|
*/
|
|
112
113
|
updateUserPassword: (request: Readonly<UpdateUserPasswordRequest>) => Promise<User>;
|
|
113
114
|
/**
|
|
114
|
-
* Lock a
|
|
115
|
-
*
|
|
115
|
+
* Lock a member. Lock a member. A locked member cannot log in or use API keys
|
|
116
|
+
* until the locked status is removed. Private Beta feature.
|
|
116
117
|
*
|
|
117
118
|
* @param request - The request {@link LockUserRequest}
|
|
118
119
|
* @returns A Promise of User
|
|
119
120
|
*/
|
|
120
121
|
lockUser: (request: Readonly<LockUserRequest>) => Promise<User>;
|
|
121
122
|
/**
|
|
122
|
-
* Unlock a
|
|
123
|
+
* Unlock a member. Unlock a member. Private Beta feature.
|
|
123
124
|
*
|
|
124
125
|
* @param request - The request {@link UnlockUserRequest}
|
|
125
126
|
* @returns A Promise of User
|
|
126
127
|
*/
|
|
127
128
|
unlockUser: (request: Readonly<UnlockUserRequest>) => Promise<User>;
|
|
128
129
|
/**
|
|
129
|
-
* List grace periods of a
|
|
130
|
+
* List grace periods of a member. List the grace periods of a member. Private
|
|
131
|
+
* Beta feature.
|
|
130
132
|
*
|
|
131
133
|
* @param request - The request {@link ListGracePeriodsRequest}
|
|
132
134
|
* @returns A Promise of ListGracePeriodsResponse
|
|
@@ -392,9 +394,9 @@ export declare class API extends ParentAPI {
|
|
|
392
394
|
/**
|
|
393
395
|
* Create an API key. Create an API key. You must specify the `application_id`
|
|
394
396
|
* or the `user_id` and the description. You can also specify the
|
|
395
|
-
* `default_project_id
|
|
397
|
+
* `default_project_id`, which is the Project ID of your preferred Project, to
|
|
396
398
|
* use with Object Storage. The `access_key` and `secret_key` values are
|
|
397
|
-
* returned in the response. Note that
|
|
399
|
+
* returned in the response. Note that the secret key is only shown once. Make
|
|
398
400
|
* sure that you copy and store both keys somewhere safe.
|
|
399
401
|
*
|
|
400
402
|
* @param request - The request {@link CreateAPIKeyRequest}
|
|
@@ -195,7 +195,8 @@ class API extends API$1 {
|
|
|
195
195
|
unmarshalUser
|
|
196
196
|
);
|
|
197
197
|
/**
|
|
198
|
-
* Update an user's password.
|
|
198
|
+
* Update an user's password. Private Beta feature.. Update an user's
|
|
199
|
+
* password. Private Beta feature.
|
|
199
200
|
*
|
|
200
201
|
* @param request - The request {@link UpdateUserPasswordRequest}
|
|
201
202
|
* @returns A Promise of User
|
|
@@ -212,8 +213,8 @@ class API extends API$1 {
|
|
|
212
213
|
unmarshalUser
|
|
213
214
|
);
|
|
214
215
|
/**
|
|
215
|
-
* Lock a
|
|
216
|
-
*
|
|
216
|
+
* Lock a member. Lock a member. A locked member cannot log in or use API keys
|
|
217
|
+
* until the locked status is removed. Private Beta feature.
|
|
217
218
|
*
|
|
218
219
|
* @param request - The request {@link LockUserRequest}
|
|
219
220
|
* @returns A Promise of User
|
|
@@ -228,7 +229,7 @@ class API extends API$1 {
|
|
|
228
229
|
unmarshalUser
|
|
229
230
|
);
|
|
230
231
|
/**
|
|
231
|
-
* Unlock a
|
|
232
|
+
* Unlock a member. Unlock a member. Private Beta feature.
|
|
232
233
|
*
|
|
233
234
|
* @param request - The request {@link UnlockUserRequest}
|
|
234
235
|
* @returns A Promise of User
|
|
@@ -243,7 +244,8 @@ class API extends API$1 {
|
|
|
243
244
|
unmarshalUser
|
|
244
245
|
);
|
|
245
246
|
/**
|
|
246
|
-
* List grace periods of a
|
|
247
|
+
* List grace periods of a member. List the grace periods of a member. Private
|
|
248
|
+
* Beta feature.
|
|
247
249
|
*
|
|
248
250
|
* @param request - The request {@link ListGracePeriodsRequest}
|
|
249
251
|
* @returns A Promise of ListGracePeriodsResponse
|
|
@@ -781,9 +783,9 @@ class API extends API$1 {
|
|
|
781
783
|
/**
|
|
782
784
|
* Create an API key. Create an API key. You must specify the `application_id`
|
|
783
785
|
* or the `user_id` and the description. You can also specify the
|
|
784
|
-
* `default_project_id
|
|
786
|
+
* `default_project_id`, which is the Project ID of your preferred Project, to
|
|
785
787
|
* use with Object Storage. The `access_key` and `secret_key` values are
|
|
786
|
-
* returned in the response. Note that
|
|
788
|
+
* returned in the response. Note that the secret key is only shown once. Make
|
|
787
789
|
* sure that you copy and store both keys somewhere safe.
|
|
788
790
|
*
|
|
789
791
|
* @param request - The request {@link CreateAPIKeyRequest}
|
|
@@ -494,7 +494,7 @@ export type CreateUserRequest = {
|
|
|
494
494
|
/** Tags associated with the user. */
|
|
495
495
|
tags?: string[];
|
|
496
496
|
/**
|
|
497
|
-
*
|
|
497
|
+
* Details of IAM member. Private Beta feature.
|
|
498
498
|
*
|
|
499
499
|
* One-of ('type'): at most one of 'email', 'member' could be set.
|
|
500
500
|
*/
|
|
@@ -970,6 +970,6 @@ export type UpdateUserRequest = {
|
|
|
970
970
|
userId: string;
|
|
971
971
|
/** New tags for the user (maximum of 10 tags). */
|
|
972
972
|
tags?: string[];
|
|
973
|
-
/**
|
|
973
|
+
/** IAM member email. */
|
|
974
974
|
email?: string;
|
|
975
975
|
};
|
|
@@ -96,6 +96,7 @@ class API extends api.API {
|
|
|
96
96
|
],
|
|
97
97
|
["project_id", request.projectId],
|
|
98
98
|
["resource_id", request.resourceId],
|
|
99
|
+
["resource_ids", request.resourceIds],
|
|
99
100
|
["resource_name", request.resourceName],
|
|
100
101
|
["resource_type", request.resourceType],
|
|
101
102
|
["resource_types", request.resourceTypes],
|
|
@@ -94,6 +94,7 @@ class API extends API$1 {
|
|
|
94
94
|
],
|
|
95
95
|
["project_id", request.projectId],
|
|
96
96
|
["resource_id", request.resourceId],
|
|
97
|
+
["resource_ids", request.resourceIds],
|
|
97
98
|
["resource_name", request.resourceName],
|
|
98
99
|
["resource_type", request.resourceType],
|
|
99
100
|
["resource_types", request.resourceTypes],
|
|
@@ -191,6 +191,11 @@ export type ListIPsRequest = {
|
|
|
191
191
|
* returned.
|
|
192
192
|
*/
|
|
193
193
|
resourceId?: string;
|
|
194
|
+
/**
|
|
195
|
+
* Resource IDs to filter for. Only IPs attached to at least one of these
|
|
196
|
+
* resources will be returned.
|
|
197
|
+
*/
|
|
198
|
+
resourceIds?: string[];
|
|
194
199
|
/**
|
|
195
200
|
* Resource type to filter for. Only IPs attached to this type of resource
|
|
196
201
|
* will be returned.
|
|
@@ -128,6 +128,7 @@ const unmarshalCluster = (data) => {
|
|
|
128
128
|
);
|
|
129
129
|
}
|
|
130
130
|
return {
|
|
131
|
+
aclAvailable: data.acl_available,
|
|
131
132
|
admissionPlugins: data.admission_plugins,
|
|
132
133
|
apiserverCertSans: data.apiserver_cert_sans,
|
|
133
134
|
autoUpgrade: data.auto_upgrade ? unmarshalClusterAutoUpgrade(data.auto_upgrade) : void 0,
|
|
@@ -139,7 +140,6 @@ const unmarshalCluster = (data) => {
|
|
|
139
140
|
description: data.description,
|
|
140
141
|
dnsWildcard: data.dns_wildcard,
|
|
141
142
|
featureGates: data.feature_gates,
|
|
142
|
-
fullVpcIntegratonEnabled: data.full_vpc_integraton_enabled,
|
|
143
143
|
id: data.id,
|
|
144
144
|
name: data.name,
|
|
145
145
|
openIdConnectConfig: data.open_id_connect_config ? unmarshalClusterOpenIDConnectConfig(data.open_id_connect_config) : void 0,
|
|
@@ -147,7 +147,6 @@ const unmarshalCluster = (data) => {
|
|
|
147
147
|
privateNetworkId: data.private_network_id,
|
|
148
148
|
projectId: data.project_id,
|
|
149
149
|
region: data.region,
|
|
150
|
-
routedIpEnabled: data.routed_ip_enabled,
|
|
151
150
|
sbsCsiEnabled: data.sbs_csi_enabled,
|
|
152
151
|
status: data.status,
|
|
153
152
|
tags: data.tags,
|
|
@@ -126,6 +126,7 @@ const unmarshalCluster = (data) => {
|
|
|
126
126
|
);
|
|
127
127
|
}
|
|
128
128
|
return {
|
|
129
|
+
aclAvailable: data.acl_available,
|
|
129
130
|
admissionPlugins: data.admission_plugins,
|
|
130
131
|
apiserverCertSans: data.apiserver_cert_sans,
|
|
131
132
|
autoUpgrade: data.auto_upgrade ? unmarshalClusterAutoUpgrade(data.auto_upgrade) : void 0,
|
|
@@ -137,7 +138,6 @@ const unmarshalCluster = (data) => {
|
|
|
137
138
|
description: data.description,
|
|
138
139
|
dnsWildcard: data.dns_wildcard,
|
|
139
140
|
featureGates: data.feature_gates,
|
|
140
|
-
fullVpcIntegratonEnabled: data.full_vpc_integraton_enabled,
|
|
141
141
|
id: data.id,
|
|
142
142
|
name: data.name,
|
|
143
143
|
openIdConnectConfig: data.open_id_connect_config ? unmarshalClusterOpenIDConnectConfig(data.open_id_connect_config) : void 0,
|
|
@@ -145,7 +145,6 @@ const unmarshalCluster = (data) => {
|
|
|
145
145
|
privateNetworkId: data.private_network_id,
|
|
146
146
|
projectId: data.project_id,
|
|
147
147
|
region: data.region,
|
|
148
|
-
routedIpEnabled: data.routed_ip_enabled,
|
|
149
148
|
sbsCsiEnabled: data.sbs_csi_enabled,
|
|
150
149
|
status: data.status,
|
|
151
150
|
tags: data.tags,
|
|
@@ -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
|
*
|