@scaleway/sdk 2.52.0 → 2.53.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.
Files changed (59) hide show
  1. package/dist/api/applesilicon/v1alpha1/marshalling.gen.cjs +1 -0
  2. package/dist/api/applesilicon/v1alpha1/marshalling.gen.js +1 -0
  3. package/dist/api/applesilicon/v1alpha1/types.gen.d.ts +2 -0
  4. package/dist/api/container/v1beta1/index.gen.d.ts +1 -1
  5. package/dist/api/container/v1beta1/marshalling.gen.cjs +66 -6
  6. package/dist/api/container/v1beta1/marshalling.gen.js +67 -7
  7. package/dist/api/container/v1beta1/types.gen.d.ts +59 -2
  8. package/dist/api/container/v1beta1/validation-rules.gen.cjs +14 -0
  9. package/dist/api/container/v1beta1/validation-rules.gen.d.ts +12 -0
  10. package/dist/api/container/v1beta1/validation-rules.gen.js +14 -0
  11. package/dist/api/flexibleip/v1alpha1/api.gen.cjs +4 -1
  12. package/dist/api/flexibleip/v1alpha1/api.gen.js +4 -1
  13. package/dist/api/function/v1beta1/marshalling.gen.cjs +10 -4
  14. package/dist/api/function/v1beta1/marshalling.gen.js +11 -5
  15. package/dist/api/function/v1beta1/types.gen.d.ts +12 -0
  16. package/dist/api/iam/v1alpha1/api.gen.cjs +37 -0
  17. package/dist/api/iam/v1alpha1/api.gen.d.ts +22 -1
  18. package/dist/api/iam/v1alpha1/api.gen.js +37 -0
  19. package/dist/api/iam/v1alpha1/index.gen.d.ts +1 -1
  20. package/dist/api/iam/v1alpha1/types.gen.d.ts +12 -0
  21. package/dist/api/inference/v1beta1/types.gen.d.ts +3 -3
  22. package/dist/api/instance/v1/api.gen.cjs +2 -2
  23. package/dist/api/instance/v1/api.gen.d.ts +2 -2
  24. package/dist/api/instance/v1/api.gen.js +2 -2
  25. package/dist/api/instance/v1/types.gen.d.ts +2 -2
  26. package/dist/api/iot/v1/api.gen.cjs +4 -3
  27. package/dist/api/iot/v1/api.gen.d.ts +4 -3
  28. package/dist/api/iot/v1/api.gen.js +4 -3
  29. package/dist/api/iot/v1/types.gen.d.ts +6 -6
  30. package/dist/api/k8s/v1/api.gen.cjs +64 -0
  31. package/dist/api/k8s/v1/api.gen.d.ts +32 -1
  32. package/dist/api/k8s/v1/api.gen.js +65 -1
  33. package/dist/api/k8s/v1/index.gen.d.ts +1 -1
  34. package/dist/api/k8s/v1/marshalling.gen.cjs +62 -0
  35. package/dist/api/k8s/v1/marshalling.gen.d.ts +6 -1
  36. package/dist/api/k8s/v1/marshalling.gen.js +62 -0
  37. package/dist/api/k8s/v1/types.gen.d.ts +92 -0
  38. package/dist/api/k8s/v1/validation-rules.gen.cjs +6 -0
  39. package/dist/api/k8s/v1/validation-rules.gen.d.ts +5 -0
  40. package/dist/api/k8s/v1/validation-rules.gen.js +6 -0
  41. package/dist/api/lb/v1/types.gen.d.ts +15 -10
  42. package/dist/api/mongodb/v1alpha1/api.gen.cjs +33 -15
  43. package/dist/api/mongodb/v1alpha1/api.gen.d.ts +26 -18
  44. package/dist/api/mongodb/v1alpha1/api.gen.js +34 -16
  45. package/dist/api/mongodb/v1alpha1/index.gen.d.ts +1 -1
  46. package/dist/api/mongodb/v1alpha1/marshalling.gen.cjs +5 -0
  47. package/dist/api/mongodb/v1alpha1/marshalling.gen.d.ts +2 -1
  48. package/dist/api/mongodb/v1alpha1/marshalling.gen.js +5 -0
  49. package/dist/api/mongodb/v1alpha1/types.gen.d.ts +38 -25
  50. package/dist/api/mongodb/v1alpha1/validation-rules.gen.cjs +12 -0
  51. package/dist/api/mongodb/v1alpha1/validation-rules.gen.d.ts +11 -0
  52. package/dist/api/mongodb/v1alpha1/validation-rules.gen.js +12 -0
  53. package/dist/api/rdb/v1/marshalling.gen.cjs +2 -1
  54. package/dist/api/rdb/v1/marshalling.gen.js +2 -1
  55. package/dist/api/rdb/v1/types.gen.d.ts +22 -13
  56. package/dist/scw/constants.cjs +1 -1
  57. package/dist/scw/constants.d.ts +2 -2
  58. package/dist/scw/constants.js +1 -1
  59. package/package.json +2 -2
@@ -173,6 +173,12 @@ export interface Function {
173
173
  runtimeMessage: string;
174
174
  /** Execution environment of the function. */
175
175
  sandbox: FunctionSandbox;
176
+ /** Creation date of the function. */
177
+ createdAt?: Date;
178
+ /** Last update date of the function. */
179
+ updatedAt?: Date;
180
+ /** Last date when the function was successfully deployed and set to ready. */
181
+ readyAt?: Date;
176
182
  }
177
183
  export interface Namespace {
178
184
  /** UUID of the namespace. */
@@ -199,6 +205,8 @@ export interface Namespace {
199
205
  secretEnvironmentVariables: SecretHashedValue[];
200
206
  /** Region in which the namespace is located. */
201
207
  region: Region;
208
+ /** [ALPHA] List of tags applied to the Serverless Function Namespace. */
209
+ tags: string[];
202
210
  }
203
211
  export interface Token {
204
212
  /** UUID of the token. */
@@ -348,6 +356,8 @@ export type CreateNamespaceRequest = {
348
356
  description?: string;
349
357
  /** Secret environment variables of the namespace. */
350
358
  secretEnvironmentVariables?: Secret[];
359
+ /** [ALPHA] Tags of the Serverless Function Namespace. */
360
+ tags?: string[];
351
361
  };
352
362
  export type CreateTokenRequest = {
353
363
  /**
@@ -786,6 +796,8 @@ export type UpdateNamespaceRequest = {
786
796
  description?: string;
787
797
  /** Secret environment variables of the namespace. */
788
798
  secretEnvironmentVariables?: Secret[];
799
+ /** [ALPHA] Tags of the Serverless Function Namespace. */
800
+ tags?: string[];
789
801
  };
790
802
  export type UpdateTriggerRequest = {
791
803
  /**
@@ -196,6 +196,12 @@ class API extends api.API {
196
196
  },
197
197
  marshalling_gen.unmarshalUser
198
198
  );
199
+ /**
200
+ * Update an user's password.
201
+ *
202
+ * @param request - The request {@link UpdateUserPasswordRequest}
203
+ * @returns A Promise of User
204
+ */
199
205
  updateUserPassword = (request) => this.client.fetch(
200
206
  {
201
207
  body: JSON.stringify(
@@ -207,6 +213,37 @@ class API extends api.API {
207
213
  },
208
214
  marshalling_gen.unmarshalUser
209
215
  );
216
+ /**
217
+ * Lock a user. Lock a user. Note that a locked user cannot log in or use API
218
+ * keys until the locked status is removed.
219
+ *
220
+ * @param request - The request {@link LockUserRequest}
221
+ * @returns A Promise of User
222
+ */
223
+ lockUser = (request) => this.client.fetch(
224
+ {
225
+ body: "{}",
226
+ headers: jsonContentHeaders,
227
+ method: "POST",
228
+ path: `/iam/v1alpha1/users/${marshalling.validatePathParam("userId", request.userId)}/lock`
229
+ },
230
+ marshalling_gen.unmarshalUser
231
+ );
232
+ /**
233
+ * Unlock a user.
234
+ *
235
+ * @param request - The request {@link UnlockUserRequest}
236
+ * @returns A Promise of User
237
+ */
238
+ unlockUser = (request) => this.client.fetch(
239
+ {
240
+ body: "{}",
241
+ headers: jsonContentHeaders,
242
+ method: "POST",
243
+ path: `/iam/v1alpha1/users/${marshalling.validatePathParam("userId", request.userId)}/unlock`
244
+ },
245
+ marshalling_gen.unmarshalUser
246
+ );
210
247
  pageOfListApplications = (request = {}) => this.client.fetch(
211
248
  {
212
249
  method: "GET",
@@ -1,5 +1,5 @@
1
1
  import { API as ParentAPI } from '../../../bridge';
2
- import type { APIKey, AddGroupMemberRequest, AddGroupMembersRequest, Application, ClonePolicyRequest, CreateAPIKeyRequest, CreateApplicationRequest, CreateGroupRequest, CreateJWTRequest, CreatePolicyRequest, CreateSSHKeyRequest, CreateUserRequest, DeleteAPIKeyRequest, DeleteApplicationRequest, DeleteGroupRequest, DeleteJWTRequest, DeletePolicyRequest, DeleteSSHKeyRequest, DeleteUserRequest, EncodedJWT, GetAPIKeyRequest, GetApplicationRequest, GetGroupRequest, GetJWTRequest, GetLogRequest, GetPolicyRequest, GetQuotumRequest, GetSSHKeyRequest, GetUserRequest, Group, JWT, ListAPIKeysRequest, ListAPIKeysResponse, ListApplicationsRequest, ListApplicationsResponse, ListGroupsRequest, ListGroupsResponse, ListJWTsRequest, ListJWTsResponse, ListLogsRequest, ListLogsResponse, ListPermissionSetsRequest, ListPermissionSetsResponse, ListPoliciesRequest, ListPoliciesResponse, ListQuotaRequest, ListQuotaResponse, ListRulesRequest, ListRulesResponse, ListSSHKeysRequest, ListSSHKeysResponse, ListUsersRequest, ListUsersResponse, Log, Policy, Quotum, RemoveGroupMemberRequest, SSHKey, SetGroupMembersRequest, SetRulesRequest, SetRulesResponse, UpdateAPIKeyRequest, UpdateApplicationRequest, UpdateGroupRequest, UpdatePolicyRequest, UpdateSSHKeyRequest, UpdateUserPasswordRequest, UpdateUserRequest, User } from './types.gen';
2
+ import type { APIKey, AddGroupMemberRequest, AddGroupMembersRequest, Application, ClonePolicyRequest, CreateAPIKeyRequest, CreateApplicationRequest, CreateGroupRequest, CreateJWTRequest, CreatePolicyRequest, CreateSSHKeyRequest, CreateUserRequest, DeleteAPIKeyRequest, DeleteApplicationRequest, DeleteGroupRequest, DeleteJWTRequest, DeletePolicyRequest, DeleteSSHKeyRequest, DeleteUserRequest, EncodedJWT, GetAPIKeyRequest, GetApplicationRequest, GetGroupRequest, GetJWTRequest, GetLogRequest, GetPolicyRequest, GetQuotumRequest, GetSSHKeyRequest, GetUserRequest, Group, JWT, ListAPIKeysRequest, ListAPIKeysResponse, ListApplicationsRequest, ListApplicationsResponse, ListGroupsRequest, ListGroupsResponse, ListJWTsRequest, ListJWTsResponse, ListLogsRequest, ListLogsResponse, ListPermissionSetsRequest, ListPermissionSetsResponse, ListPoliciesRequest, ListPoliciesResponse, ListQuotaRequest, ListQuotaResponse, ListRulesRequest, ListRulesResponse, ListSSHKeysRequest, ListSSHKeysResponse, ListUsersRequest, ListUsersResponse, LockUserRequest, Log, Policy, Quotum, RemoveGroupMemberRequest, SSHKey, SetGroupMembersRequest, SetRulesRequest, SetRulesResponse, UnlockUserRequest, UpdateAPIKeyRequest, UpdateApplicationRequest, UpdateGroupRequest, UpdatePolicyRequest, UpdateSSHKeyRequest, UpdateUserPasswordRequest, UpdateUserRequest, User } from './types.gen';
3
3
  /**
4
4
  * IAM API.
5
5
  *
@@ -103,7 +103,28 @@ export declare class API extends ParentAPI {
103
103
  * @returns A Promise of User
104
104
  */
105
105
  createUser: (request?: Readonly<CreateUserRequest>) => Promise<User>;
106
+ /**
107
+ * Update an user's password.
108
+ *
109
+ * @param request - The request {@link UpdateUserPasswordRequest}
110
+ * @returns A Promise of User
111
+ */
106
112
  updateUserPassword: (request: Readonly<UpdateUserPasswordRequest>) => Promise<User>;
113
+ /**
114
+ * Lock a user. Lock a user. Note that a locked user cannot log in or use API
115
+ * keys until the locked status is removed.
116
+ *
117
+ * @param request - The request {@link LockUserRequest}
118
+ * @returns A Promise of User
119
+ */
120
+ lockUser: (request: Readonly<LockUserRequest>) => Promise<User>;
121
+ /**
122
+ * Unlock a user.
123
+ *
124
+ * @param request - The request {@link UnlockUserRequest}
125
+ * @returns A Promise of User
126
+ */
127
+ unlockUser: (request: Readonly<UnlockUserRequest>) => Promise<User>;
107
128
  protected pageOfListApplications: (request?: Readonly<ListApplicationsRequest>) => Promise<ListApplicationsResponse>;
108
129
  /**
109
130
  * List applications of an Organization. List the applications of an
@@ -194,6 +194,12 @@ class API extends API$1 {
194
194
  },
195
195
  unmarshalUser
196
196
  );
197
+ /**
198
+ * Update an user's password.
199
+ *
200
+ * @param request - The request {@link UpdateUserPasswordRequest}
201
+ * @returns A Promise of User
202
+ */
197
203
  updateUserPassword = (request) => this.client.fetch(
198
204
  {
199
205
  body: JSON.stringify(
@@ -205,6 +211,37 @@ class API extends API$1 {
205
211
  },
206
212
  unmarshalUser
207
213
  );
214
+ /**
215
+ * Lock a user. Lock a user. Note that a locked user cannot log in or use API
216
+ * keys until the locked status is removed.
217
+ *
218
+ * @param request - The request {@link LockUserRequest}
219
+ * @returns A Promise of User
220
+ */
221
+ lockUser = (request) => this.client.fetch(
222
+ {
223
+ body: "{}",
224
+ headers: jsonContentHeaders,
225
+ method: "POST",
226
+ path: `/iam/v1alpha1/users/${validatePathParam("userId", request.userId)}/lock`
227
+ },
228
+ unmarshalUser
229
+ );
230
+ /**
231
+ * Unlock a user.
232
+ *
233
+ * @param request - The request {@link UnlockUserRequest}
234
+ * @returns A Promise of User
235
+ */
236
+ unlockUser = (request) => this.client.fetch(
237
+ {
238
+ body: "{}",
239
+ headers: jsonContentHeaders,
240
+ method: "POST",
241
+ path: `/iam/v1alpha1/users/${validatePathParam("userId", request.userId)}/unlock`
242
+ },
243
+ unmarshalUser
244
+ );
208
245
  pageOfListApplications = (request = {}) => this.client.fetch(
209
246
  {
210
247
  method: "GET",
@@ -1,3 +1,3 @@
1
1
  export { API } from './api.gen';
2
- export type { APIKey, AddGroupMemberRequest, AddGroupMembersRequest, Application, BearerType, ClonePolicyRequest, CreateAPIKeyRequest, CreateApplicationRequest, CreateGroupRequest, CreateJWTRequest, CreatePolicyRequest, CreateSSHKeyRequest, CreateUserRequest, CreateUserRequestMember, DeleteAPIKeyRequest, DeleteApplicationRequest, DeleteGroupRequest, DeleteJWTRequest, DeletePolicyRequest, DeleteSSHKeyRequest, DeleteUserRequest, EncodedJWT, GetAPIKeyRequest, GetApplicationRequest, GetGroupRequest, GetJWTRequest, GetLogRequest, GetPolicyRequest, GetQuotumRequest, GetSSHKeyRequest, GetUserRequest, Group, JWT, ListAPIKeysRequest, ListAPIKeysRequestOrderBy, ListAPIKeysResponse, ListApplicationsRequest, ListApplicationsRequestOrderBy, ListApplicationsResponse, ListGroupsRequest, ListGroupsRequestOrderBy, ListGroupsResponse, ListJWTsRequest, ListJWTsRequestOrderBy, ListJWTsResponse, ListLogsRequest, ListLogsRequestOrderBy, ListLogsResponse, ListPermissionSetsRequest, ListPermissionSetsRequestOrderBy, ListPermissionSetsResponse, ListPoliciesRequest, ListPoliciesRequestOrderBy, ListPoliciesResponse, ListQuotaRequest, ListQuotaRequestOrderBy, ListQuotaResponse, ListRulesRequest, ListRulesResponse, ListSSHKeysRequest, ListSSHKeysRequestOrderBy, ListSSHKeysResponse, ListUsersRequest, ListUsersRequestOrderBy, ListUsersResponse, Log, LogAction, LogResourceType, PermissionSet, PermissionSetScopeType, Policy, Quotum, RemoveGroupMemberRequest, Rule, RuleSpecs, SSHKey, SetGroupMembersRequest, SetRulesRequest, SetRulesResponse, UpdateAPIKeyRequest, UpdateApplicationRequest, UpdateGroupRequest, UpdatePolicyRequest, UpdateSSHKeyRequest, UpdateUserPasswordRequest, UpdateUserRequest, User, UserStatus, UserType, } from './types.gen';
2
+ export type { APIKey, AddGroupMemberRequest, AddGroupMembersRequest, Application, BearerType, ClonePolicyRequest, CreateAPIKeyRequest, CreateApplicationRequest, CreateGroupRequest, CreateJWTRequest, CreatePolicyRequest, CreateSSHKeyRequest, CreateUserRequest, CreateUserRequestMember, DeleteAPIKeyRequest, DeleteApplicationRequest, DeleteGroupRequest, DeleteJWTRequest, DeletePolicyRequest, DeleteSSHKeyRequest, DeleteUserRequest, EncodedJWT, GetAPIKeyRequest, GetApplicationRequest, GetGroupRequest, GetJWTRequest, GetLogRequest, GetPolicyRequest, GetQuotumRequest, GetSSHKeyRequest, GetUserRequest, Group, JWT, ListAPIKeysRequest, ListAPIKeysRequestOrderBy, ListAPIKeysResponse, ListApplicationsRequest, ListApplicationsRequestOrderBy, ListApplicationsResponse, ListGroupsRequest, ListGroupsRequestOrderBy, ListGroupsResponse, ListJWTsRequest, ListJWTsRequestOrderBy, ListJWTsResponse, ListLogsRequest, ListLogsRequestOrderBy, ListLogsResponse, ListPermissionSetsRequest, ListPermissionSetsRequestOrderBy, ListPermissionSetsResponse, ListPoliciesRequest, ListPoliciesRequestOrderBy, ListPoliciesResponse, ListQuotaRequest, ListQuotaRequestOrderBy, ListQuotaResponse, ListRulesRequest, ListRulesResponse, ListSSHKeysRequest, ListSSHKeysRequestOrderBy, ListSSHKeysResponse, ListUsersRequest, ListUsersRequestOrderBy, ListUsersResponse, LockUserRequest, Log, LogAction, LogResourceType, PermissionSet, PermissionSetScopeType, Policy, Quotum, RemoveGroupMemberRequest, Rule, RuleSpecs, SSHKey, SetGroupMembersRequest, SetRulesRequest, SetRulesResponse, UnlockUserRequest, UpdateAPIKeyRequest, UpdateApplicationRequest, UpdateGroupRequest, UpdatePolicyRequest, UpdateSSHKeyRequest, UpdateUserPasswordRequest, UpdateUserRequest, User, UserStatus, UserType, } from './types.gen';
3
3
  export * as ValidationRules from './validation-rules.gen';
@@ -817,6 +817,9 @@ export interface ListUsersResponse {
817
817
  /** Total count of users. */
818
818
  totalCount: number;
819
819
  }
820
+ export type LockUserRequest = {
821
+ userId: string;
822
+ };
820
823
  export type RemoveGroupMemberRequest = {
821
824
  /** ID of the group. */
822
825
  groupId: string;
@@ -848,6 +851,9 @@ export interface SetRulesResponse {
848
851
  /** Rules of the policy. */
849
852
  rules: Rule[];
850
853
  }
854
+ export type UnlockUserRequest = {
855
+ userId: string;
856
+ };
851
857
  export type UpdateAPIKeyRequest = {
852
858
  /** Access key to update. */
853
859
  accessKey: string;
@@ -925,8 +931,14 @@ export type UpdateSSHKeyRequest = {
925
931
  disabled?: boolean;
926
932
  };
927
933
  export type UpdateUserPasswordRequest = {
934
+ /** ID of the user to update. */
928
935
  userId: string;
936
+ /** The new password. */
929
937
  password: string;
938
+ /**
939
+ * Whether or not to send an email alerting the user their password has
940
+ * changed.
941
+ */
930
942
  sendEmail: boolean;
931
943
  };
932
944
  export type UpdateUserRequest = {
@@ -131,7 +131,7 @@ export interface Model {
131
131
  tags: string[];
132
132
  /** Purpose of the model. */
133
133
  description: string;
134
- /** Defines whether the model has an end user licence agreement. */
134
+ /** Defines whether the model has an end user license agreement. */
135
135
  hasEula: boolean;
136
136
  /** Creation date of the model. */
137
137
  createdAt?: Date;
@@ -140,7 +140,7 @@ export interface Model {
140
140
  /** Region of the model. */
141
141
  region: Region;
142
142
  /**
143
- * S3 URL pointing to the model source weight.
143
+ * Object Storage URL pointing to the model source weight.
144
144
  *
145
145
  * One-of ('source'): at most one of 's3Model' could be set.
146
146
  */
@@ -260,7 +260,7 @@ export type DeleteEndpointRequest = {
260
260
  endpointId: string;
261
261
  };
262
262
  export interface Eula {
263
- /** Content of the end user licence agreement. */
263
+ /** Content of the end user license agreement. */
264
264
  content: string;
265
265
  }
266
266
  export type GetDeploymentCertificateRequest = {
@@ -443,8 +443,8 @@ class API extends api.API {
443
443
  path: `/instance/v1/zones/${marshalling.validatePathParam("zone", request.zone ?? this.client.settings.defaultZone)}/snapshots/${marshalling.validatePathParam("snapshotId", request.snapshotId)}`
444
444
  });
445
445
  /**
446
- * Export a snapshot. Export a snapshot to a specified S3 bucket in the same
447
- * region.
446
+ * Export a snapshot. Export a snapshot to a specified Object Storage bucket
447
+ * in the same region.
448
448
  *
449
449
  * @param request - The request {@link ExportSnapshotRequest}
450
450
  * @returns A Promise of ExportSnapshotResponse
@@ -185,8 +185,8 @@ export declare class API extends ParentAPI {
185
185
  */
186
186
  deleteSnapshot: (request: Readonly<DeleteSnapshotRequest>) => Promise<void>;
187
187
  /**
188
- * Export a snapshot. Export a snapshot to a specified S3 bucket in the same
189
- * region.
188
+ * Export a snapshot. Export a snapshot to a specified Object Storage bucket
189
+ * in the same region.
190
190
  *
191
191
  * @param request - The request {@link ExportSnapshotRequest}
192
192
  * @returns A Promise of ExportSnapshotResponse
@@ -441,8 +441,8 @@ class API extends API$1 {
441
441
  path: `/instance/v1/zones/${validatePathParam("zone", request.zone ?? this.client.settings.defaultZone)}/snapshots/${validatePathParam("snapshotId", request.snapshotId)}`
442
442
  });
443
443
  /**
444
- * Export a snapshot. Export a snapshot to a specified S3 bucket in the same
445
- * region.
444
+ * Export a snapshot. Export a snapshot to a specified Object Storage bucket
445
+ * in the same region.
446
446
  *
447
447
  * @param request - The request {@link ExportSnapshotRequest}
448
448
  * @returns A Promise of ExportSnapshotResponse
@@ -1048,9 +1048,9 @@ export type ExportSnapshotRequest = {
1048
1048
  zone?: Zone;
1049
1049
  /** Snapshot ID. */
1050
1050
  snapshotId: string;
1051
- /** S3 bucket name. */
1051
+ /** Object Storage bucket name. */
1052
1052
  bucket: string;
1053
- /** S3 object key. */
1053
+ /** Object key. */
1054
1054
  key: string;
1055
1055
  };
1056
1056
  export interface ExportSnapshotResponse {
@@ -409,9 +409,10 @@ class API extends api.API {
409
409
  * into your database. <b>You need to manage the database by yourself</b>.
410
410
  * - REST Route. Create a route that will call a REST API on received subscribed
411
411
  * MQTT messages.
412
- * - S3 Routes. Create a route that will put subscribed MQTT messages into an S3
413
- * bucket. You need to create the bucket yourself and grant write access.
414
- * Granting can be done with s3cmd (`s3cmd setacl s3://<my-bucket>
412
+ * - Amazon S3 Routes. Create a route that will put subscribed MQTT messages
413
+ * into an Object Storage bucket. You need to create the bucket yourself and
414
+ * grant write access. Granting can be done with s3cmd (`s3cmd setacl
415
+ * s3://<my-bucket>
415
416
  * --acl-grant=write:555c69c3-87d0-4bf8-80f1-99a2f757d031:555c69c3-87d0-4bf8-80f1-99a2f757d031`).
416
417
  *
417
418
  * @param request - The request {@link CreateRouteRequest}
@@ -213,9 +213,10 @@ export declare class API extends ParentAPI {
213
213
  * into your database. <b>You need to manage the database by yourself</b>.
214
214
  * - REST Route. Create a route that will call a REST API on received subscribed
215
215
  * MQTT messages.
216
- * - S3 Routes. Create a route that will put subscribed MQTT messages into an S3
217
- * bucket. You need to create the bucket yourself and grant write access.
218
- * Granting can be done with s3cmd (`s3cmd setacl s3://<my-bucket>
216
+ * - Amazon S3 Routes. Create a route that will put subscribed MQTT messages
217
+ * into an Object Storage bucket. You need to create the bucket yourself and
218
+ * grant write access. Granting can be done with s3cmd (`s3cmd setacl
219
+ * s3://<my-bucket>
219
220
  * --acl-grant=write:555c69c3-87d0-4bf8-80f1-99a2f757d031:555c69c3-87d0-4bf8-80f1-99a2f757d031`).
220
221
  *
221
222
  * @param request - The request {@link CreateRouteRequest}
@@ -407,9 +407,10 @@ class API extends API$1 {
407
407
  * into your database. <b>You need to manage the database by yourself</b>.
408
408
  * - REST Route. Create a route that will call a REST API on received subscribed
409
409
  * MQTT messages.
410
- * - S3 Routes. Create a route that will put subscribed MQTT messages into an S3
411
- * bucket. You need to create the bucket yourself and grant write access.
412
- * Granting can be done with s3cmd (`s3cmd setacl s3://<my-bucket>
410
+ * - Amazon S3 Routes. Create a route that will put subscribed MQTT messages
411
+ * into an Object Storage bucket. You need to create the bucket yourself and
412
+ * grant write access. Granting can be done with s3cmd (`s3cmd setacl
413
+ * s3://<my-bucket>
413
414
  * --acl-grant=write:555c69c3-87d0-4bf8-80f1-99a2f757d031:555c69c3-87d0-4bf8-80f1-99a2f757d031`).
414
415
  *
415
416
  * @param request - The request {@link CreateRouteRequest}
@@ -222,14 +222,14 @@ export interface RouteRestConfig {
222
222
  headers: Record<string, string>;
223
223
  }
224
224
  export interface RouteS3Config {
225
- /** Region of the S3 route's destination bucket (e.g., 'fr-par'). */
225
+ /** Region of the Amazon S3 route's destination bucket (e.g., 'fr-par'). */
226
226
  bucketRegion: string;
227
- /** Destination bucket name of the S3 route. */
227
+ /** Destination bucket name of the Amazon S3 route. */
228
228
  bucketName: string;
229
229
  /** Optional string to prefix object names with. */
230
230
  objectPrefix: string;
231
231
  /**
232
- * How the S3 route's objects will be created: one per topic or one per
232
+ * How the Amazon S3 route's objects will be created: one per topic or one per
233
233
  * message.
234
234
  */
235
235
  strategy: RouteS3ConfigS3Strategy;
@@ -352,7 +352,7 @@ export type CreateRouteRequest = {
352
352
  */
353
353
  topic: string;
354
354
  /**
355
- * If creating S3 Route, S3-specific configuration fields.
355
+ * If creating Amazon S3 Routes, Amazon S3-specific configuration fields.
356
356
  *
357
357
  * One-of ('config'): at most one of 's3Config', 'dbConfig', 'restConfig'
358
358
  * could be set.
@@ -761,7 +761,7 @@ export interface Route {
761
761
  /** Date at which the route was created. */
762
762
  createdAt?: Date;
763
763
  /**
764
- * When using S3 Route, S3-specific configuration fields.
764
+ * When using Amazon S3 Routes, Amazon S3-specific configuration fields.
765
765
  *
766
766
  * One-of ('config'): at most one of 's3Config', 'dbConfig', 'restConfig'
767
767
  * could be set.
@@ -893,7 +893,7 @@ export type UpdateRouteRequest = {
893
893
  */
894
894
  topic?: string;
895
895
  /**
896
- * When updating S3 Route, S3-specific configuration fields.
896
+ * When updating Amazon S3 Route, Amazon S3-specific configuration fields.
897
897
  *
898
898
  * One-of ('config'): at most one of 's3Config', 'dbConfig', 'restConfig'
899
899
  * could be set.
@@ -228,6 +228,70 @@ class API extends api.API {
228
228
  },
229
229
  marshalling_gen.unmarshalCluster
230
230
  );
231
+ pageOfListClusterACLRules = (request) => this.client.fetch(
232
+ {
233
+ method: "GET",
234
+ path: `/k8s/v1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/clusters/${marshalling.validatePathParam("clusterId", request.clusterId)}/acls`,
235
+ urlParams: marshalling.urlParams(
236
+ ["page", request.page],
237
+ [
238
+ "page_size",
239
+ request.pageSize ?? this.client.settings.defaultPageSize
240
+ ]
241
+ )
242
+ },
243
+ marshalling_gen.unmarshalListClusterACLRulesResponse
244
+ );
245
+ /**
246
+ * List ACLs. List ACLs for a specific cluster.
247
+ *
248
+ * @param request - The request {@link ListClusterACLRulesRequest}
249
+ * @returns A Promise of ListClusterACLRulesResponse
250
+ */
251
+ listClusterACLRules = (request) => resourcePaginator.enrichForPagination("rules", this.pageOfListClusterACLRules, request);
252
+ /**
253
+ * Add new ACLs. Add new ACL rules for a specific cluster.
254
+ *
255
+ * @param request - The request {@link AddClusterACLRulesRequest}
256
+ * @returns A Promise of AddClusterACLRulesResponse
257
+ */
258
+ addClusterACLRules = (request) => this.client.fetch(
259
+ {
260
+ body: JSON.stringify(
261
+ marshalling_gen.marshalAddClusterACLRulesRequest(request, this.client.settings)
262
+ ),
263
+ headers: jsonContentHeaders,
264
+ method: "POST",
265
+ path: `/k8s/v1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/clusters/${marshalling.validatePathParam("clusterId", request.clusterId)}/acls`
266
+ },
267
+ marshalling_gen.unmarshalAddClusterACLRulesResponse
268
+ );
269
+ /**
270
+ * Set new ACLs. Set new ACL rules for a specific cluster.
271
+ *
272
+ * @param request - The request {@link SetClusterACLRulesRequest}
273
+ * @returns A Promise of SetClusterACLRulesResponse
274
+ */
275
+ setClusterACLRules = (request) => this.client.fetch(
276
+ {
277
+ body: JSON.stringify(
278
+ marshalling_gen.marshalSetClusterACLRulesRequest(request, this.client.settings)
279
+ ),
280
+ headers: jsonContentHeaders,
281
+ method: "PUT",
282
+ path: `/k8s/v1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/clusters/${marshalling.validatePathParam("clusterId", request.clusterId)}/acls`
283
+ },
284
+ marshalling_gen.unmarshalSetClusterACLRulesResponse
285
+ );
286
+ /**
287
+ * Delete an existing ACL.
288
+ *
289
+ * @param request - The request {@link DeleteACLRuleRequest}
290
+ */
291
+ deleteACLRule = (request) => this.client.fetch({
292
+ method: "DELETE",
293
+ path: `/k8s/v1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/acls/${marshalling.validatePathParam("aclId", request.aclId)}`
294
+ });
231
295
  pageOfListPools = (request) => this.client.fetch(
232
296
  {
233
297
  method: "GET",
@@ -1,6 +1,6 @@
1
1
  import { API as ParentAPI } from '../../../bridge';
2
2
  import type { Region, WaitForOptions } from '../../../bridge';
3
- import type { AuthExternalNodeRequest, Cluster, CreateClusterRequest, CreateExternalNodeRequest, CreatePoolRequest, DeleteClusterRequest, DeleteNodeRequest, DeletePoolRequest, ExternalNode, ExternalNodeAuth, GetClusterKubeConfigRequest, GetClusterRequest, GetNodeMetadataRequest, GetNodeRequest, GetPoolRequest, GetVersionRequest, ListClusterAvailableTypesRequest, ListClusterAvailableTypesResponse, ListClusterAvailableVersionsRequest, ListClusterAvailableVersionsResponse, ListClusterTypesRequest, ListClusterTypesResponse, ListClustersRequest, ListClustersResponse, ListNodesRequest, ListNodesResponse, ListPoolsRequest, ListPoolsResponse, ListVersionsRequest, ListVersionsResponse, MigrateClusterToSBSCSIRequest, Node, NodeMetadata, Pool, RebootNodeRequest, ReplaceNodeRequest, ResetClusterAdminTokenRequest, SetClusterTypeRequest, UpdateClusterRequest, UpdatePoolRequest, UpgradeClusterRequest, UpgradePoolRequest, Version } from './types.gen';
3
+ import type { AddClusterACLRulesRequest, AddClusterACLRulesResponse, AuthExternalNodeRequest, Cluster, CreateClusterRequest, CreateExternalNodeRequest, CreatePoolRequest, DeleteACLRuleRequest, DeleteClusterRequest, DeleteNodeRequest, DeletePoolRequest, ExternalNode, ExternalNodeAuth, GetClusterKubeConfigRequest, GetClusterRequest, GetNodeMetadataRequest, GetNodeRequest, GetPoolRequest, GetVersionRequest, ListClusterACLRulesRequest, ListClusterACLRulesResponse, ListClusterAvailableTypesRequest, ListClusterAvailableTypesResponse, ListClusterAvailableVersionsRequest, ListClusterAvailableVersionsResponse, ListClusterTypesRequest, ListClusterTypesResponse, ListClustersRequest, ListClustersResponse, ListNodesRequest, ListNodesResponse, ListPoolsRequest, ListPoolsResponse, ListVersionsRequest, ListVersionsResponse, MigrateClusterToSBSCSIRequest, Node, NodeMetadata, Pool, RebootNodeRequest, ReplaceNodeRequest, ResetClusterAdminTokenRequest, SetClusterACLRulesRequest, SetClusterACLRulesResponse, SetClusterTypeRequest, UpdateClusterRequest, UpdatePoolRequest, UpgradeClusterRequest, UpgradePoolRequest, Version } from './types.gen';
4
4
  /**
5
5
  * Kubernetes API.
6
6
  *
@@ -116,6 +116,37 @@ export declare class API extends ParentAPI {
116
116
  * @returns A Promise of Cluster
117
117
  */
118
118
  migrateClusterToSBSCSI: (request: Readonly<MigrateClusterToSBSCSIRequest>) => Promise<Cluster>;
119
+ protected pageOfListClusterACLRules: (request: Readonly<ListClusterACLRulesRequest>) => Promise<ListClusterACLRulesResponse>;
120
+ /**
121
+ * List ACLs. List ACLs for a specific cluster.
122
+ *
123
+ * @param request - The request {@link ListClusterACLRulesRequest}
124
+ * @returns A Promise of ListClusterACLRulesResponse
125
+ */
126
+ listClusterACLRules: (request: Readonly<ListClusterACLRulesRequest>) => Promise<ListClusterACLRulesResponse> & {
127
+ all: () => Promise<import("./types.gen").ACLRule[]>;
128
+ [Symbol.asyncIterator]: () => AsyncGenerator<import("./types.gen").ACLRule[], void, void>;
129
+ };
130
+ /**
131
+ * Add new ACLs. Add new ACL rules for a specific cluster.
132
+ *
133
+ * @param request - The request {@link AddClusterACLRulesRequest}
134
+ * @returns A Promise of AddClusterACLRulesResponse
135
+ */
136
+ addClusterACLRules: (request: Readonly<AddClusterACLRulesRequest>) => Promise<AddClusterACLRulesResponse>;
137
+ /**
138
+ * Set new ACLs. Set new ACL rules for a specific cluster.
139
+ *
140
+ * @param request - The request {@link SetClusterACLRulesRequest}
141
+ * @returns A Promise of SetClusterACLRulesResponse
142
+ */
143
+ setClusterACLRules: (request: Readonly<SetClusterACLRulesRequest>) => Promise<SetClusterACLRulesResponse>;
144
+ /**
145
+ * Delete an existing ACL.
146
+ *
147
+ * @param request - The request {@link DeleteACLRuleRequest}
148
+ */
149
+ deleteACLRule: (request: Readonly<DeleteACLRuleRequest>) => Promise<void>;
119
150
  protected pageOfListPools: (request: Readonly<ListPoolsRequest>) => Promise<ListPoolsResponse>;
120
151
  /**
121
152
  * List Pools in a Cluster. List all the existing pools for a specific
@@ -4,7 +4,7 @@ import { validatePathParam, urlParams } from "../../../helpers/marshalling.js";
4
4
  import "../../../vendor/base64/index.js";
5
5
  import { enrichForPagination } from "../../../scw/fetch/resource-paginator.js";
6
6
  import { CLUSTER_TRANSIENT_STATUSES, POOL_TRANSIENT_STATUSES, NODE_TRANSIENT_STATUSES } from "./content.gen.js";
7
- import { unmarshalListClustersResponse, marshalCreateClusterRequest, unmarshalCluster, marshalUpdateClusterRequest, marshalUpgradeClusterRequest, marshalSetClusterTypeRequest, unmarshalListClusterAvailableVersionsResponse, unmarshalListClusterAvailableTypesResponse, unmarshalListPoolsResponse, marshalCreatePoolRequest, unmarshalPool, marshalUpgradePoolRequest, marshalUpdatePoolRequest, unmarshalNodeMetadata, unmarshalExternalNodeAuth, unmarshalExternalNode, unmarshalListNodesResponse, unmarshalNode, unmarshalListVersionsResponse, unmarshalVersion, unmarshalListClusterTypesResponse } from "./marshalling.gen.js";
7
+ import { unmarshalListClustersResponse, marshalCreateClusterRequest, unmarshalCluster, marshalUpdateClusterRequest, marshalUpgradeClusterRequest, marshalSetClusterTypeRequest, unmarshalListClusterAvailableVersionsResponse, unmarshalListClusterAvailableTypesResponse, unmarshalListClusterACLRulesResponse, marshalAddClusterACLRulesRequest, unmarshalAddClusterACLRulesResponse, marshalSetClusterACLRulesRequest, unmarshalSetClusterACLRulesResponse, unmarshalListPoolsResponse, marshalCreatePoolRequest, unmarshalPool, marshalUpgradePoolRequest, marshalUpdatePoolRequest, unmarshalNodeMetadata, unmarshalExternalNodeAuth, unmarshalExternalNode, unmarshalListNodesResponse, unmarshalNode, unmarshalListVersionsResponse, unmarshalVersion, unmarshalListClusterTypesResponse } from "./marshalling.gen.js";
8
8
  const jsonContentHeaders = {
9
9
  "Content-Type": "application/json; charset=utf-8"
10
10
  };
@@ -226,6 +226,70 @@ class API extends API$1 {
226
226
  },
227
227
  unmarshalCluster
228
228
  );
229
+ pageOfListClusterACLRules = (request) => this.client.fetch(
230
+ {
231
+ method: "GET",
232
+ path: `/k8s/v1/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/clusters/${validatePathParam("clusterId", request.clusterId)}/acls`,
233
+ urlParams: urlParams(
234
+ ["page", request.page],
235
+ [
236
+ "page_size",
237
+ request.pageSize ?? this.client.settings.defaultPageSize
238
+ ]
239
+ )
240
+ },
241
+ unmarshalListClusterACLRulesResponse
242
+ );
243
+ /**
244
+ * List ACLs. List ACLs for a specific cluster.
245
+ *
246
+ * @param request - The request {@link ListClusterACLRulesRequest}
247
+ * @returns A Promise of ListClusterACLRulesResponse
248
+ */
249
+ listClusterACLRules = (request) => enrichForPagination("rules", this.pageOfListClusterACLRules, request);
250
+ /**
251
+ * Add new ACLs. Add new ACL rules for a specific cluster.
252
+ *
253
+ * @param request - The request {@link AddClusterACLRulesRequest}
254
+ * @returns A Promise of AddClusterACLRulesResponse
255
+ */
256
+ addClusterACLRules = (request) => this.client.fetch(
257
+ {
258
+ body: JSON.stringify(
259
+ marshalAddClusterACLRulesRequest(request, this.client.settings)
260
+ ),
261
+ headers: jsonContentHeaders,
262
+ method: "POST",
263
+ path: `/k8s/v1/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/clusters/${validatePathParam("clusterId", request.clusterId)}/acls`
264
+ },
265
+ unmarshalAddClusterACLRulesResponse
266
+ );
267
+ /**
268
+ * Set new ACLs. Set new ACL rules for a specific cluster.
269
+ *
270
+ * @param request - The request {@link SetClusterACLRulesRequest}
271
+ * @returns A Promise of SetClusterACLRulesResponse
272
+ */
273
+ setClusterACLRules = (request) => this.client.fetch(
274
+ {
275
+ body: JSON.stringify(
276
+ marshalSetClusterACLRulesRequest(request, this.client.settings)
277
+ ),
278
+ headers: jsonContentHeaders,
279
+ method: "PUT",
280
+ path: `/k8s/v1/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/clusters/${validatePathParam("clusterId", request.clusterId)}/acls`
281
+ },
282
+ unmarshalSetClusterACLRulesResponse
283
+ );
284
+ /**
285
+ * Delete an existing ACL.
286
+ *
287
+ * @param request - The request {@link DeleteACLRuleRequest}
288
+ */
289
+ deleteACLRule = (request) => this.client.fetch({
290
+ method: "DELETE",
291
+ path: `/k8s/v1/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/acls/${validatePathParam("aclId", request.aclId)}`
292
+ });
229
293
  pageOfListPools = (request) => this.client.fetch(
230
294
  {
231
295
  method: "GET",
@@ -1,4 +1,4 @@
1
1
  export { API } from './api.gen';
2
2
  export * from './content.gen';
3
- export type { AuthExternalNodeRequest, AutoscalerEstimator, AutoscalerExpander, CNI, Cluster, ClusterAutoUpgrade, ClusterAutoscalerConfig, ClusterOpenIDConnectConfig, ClusterStatus, ClusterType, ClusterTypeAvailability, ClusterTypeResiliency, CreateClusterRequest, CreateClusterRequestAutoUpgrade, CreateClusterRequestAutoscalerConfig, CreateClusterRequestOpenIDConnectConfig, CreateClusterRequestPoolConfig, CreateClusterRequestPoolConfigUpgradePolicy, CreateExternalNodeRequest, CreatePoolRequest, CreatePoolRequestUpgradePolicy, DeleteClusterRequest, DeleteNodeRequest, DeletePoolRequest, ExternalNode, ExternalNodeAuth, ExternalNodeCoreV1Taint, GetClusterKubeConfigRequest, GetClusterRequest, GetNodeMetadataRequest, GetNodeRequest, GetPoolRequest, GetVersionRequest, ListClusterAvailableTypesRequest, ListClusterAvailableTypesResponse, ListClusterAvailableVersionsRequest, ListClusterAvailableVersionsResponse, ListClusterTypesRequest, ListClusterTypesResponse, ListClustersRequest, ListClustersRequestOrderBy, ListClustersResponse, ListNodesRequest, ListNodesRequestOrderBy, ListNodesResponse, ListPoolsRequest, ListPoolsRequestOrderBy, ListPoolsResponse, ListVersionsRequest, ListVersionsResponse, MaintenanceWindow, MaintenanceWindowDayOfTheWeek, MigrateClusterToSBSCSIRequest, Node, NodeMetadata, NodeMetadataCoreV1Taint, NodeStatus, Pool, PoolStatus, PoolUpgradePolicy, PoolVolumeType, RebootNodeRequest, ReplaceNodeRequest, ResetClusterAdminTokenRequest, Runtime, SetClusterTypeRequest, UpdateClusterRequest, UpdateClusterRequestAutoUpgrade, UpdateClusterRequestAutoscalerConfig, UpdateClusterRequestOpenIDConnectConfig, UpdatePoolRequest, UpdatePoolRequestUpgradePolicy, UpgradeClusterRequest, UpgradePoolRequest, Version, } from './types.gen';
3
+ export type { ACLRule, ACLRuleRequest, AddClusterACLRulesRequest, AddClusterACLRulesResponse, AuthExternalNodeRequest, AutoscalerEstimator, AutoscalerExpander, CNI, Cluster, ClusterAutoUpgrade, ClusterAutoscalerConfig, ClusterOpenIDConnectConfig, ClusterStatus, ClusterType, ClusterTypeAvailability, ClusterTypeResiliency, CreateClusterRequest, CreateClusterRequestAutoUpgrade, CreateClusterRequestAutoscalerConfig, CreateClusterRequestOpenIDConnectConfig, CreateClusterRequestPoolConfig, CreateClusterRequestPoolConfigUpgradePolicy, CreateExternalNodeRequest, CreatePoolRequest, CreatePoolRequestUpgradePolicy, DeleteACLRuleRequest, DeleteClusterRequest, DeleteNodeRequest, DeletePoolRequest, ExternalNode, ExternalNodeAuth, ExternalNodeCoreV1Taint, GetClusterKubeConfigRequest, GetClusterRequest, GetNodeMetadataRequest, GetNodeRequest, GetPoolRequest, GetVersionRequest, ListClusterACLRulesRequest, ListClusterACLRulesResponse, ListClusterAvailableTypesRequest, ListClusterAvailableTypesResponse, ListClusterAvailableVersionsRequest, ListClusterAvailableVersionsResponse, ListClusterTypesRequest, ListClusterTypesResponse, ListClustersRequest, ListClustersRequestOrderBy, ListClustersResponse, ListNodesRequest, ListNodesRequestOrderBy, ListNodesResponse, ListPoolsRequest, ListPoolsRequestOrderBy, ListPoolsResponse, ListVersionsRequest, ListVersionsResponse, MaintenanceWindow, MaintenanceWindowDayOfTheWeek, MigrateClusterToSBSCSIRequest, Node, NodeMetadata, NodeMetadataCoreV1Taint, NodeStatus, Pool, PoolStatus, PoolUpgradePolicy, PoolVolumeType, RebootNodeRequest, ReplaceNodeRequest, ResetClusterAdminTokenRequest, Runtime, SetClusterACLRulesRequest, SetClusterACLRulesResponse, SetClusterTypeRequest, UpdateClusterRequest, UpdateClusterRequestAutoUpgrade, UpdateClusterRequestAutoscalerConfig, UpdateClusterRequestOpenIDConnectConfig, UpdatePoolRequest, UpdatePoolRequestUpgradePolicy, UpgradeClusterRequest, UpgradePoolRequest, Version, } from './types.gen';
4
4
  export * as ValidationRules from './validation-rules.gen';