@scaleway/sdk 2.52.1 → 2.54.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 (84) hide show
  1. package/dist/api/applesilicon/v1alpha1/api.gen.cjs +21 -0
  2. package/dist/api/applesilicon/v1alpha1/api.gen.d.ts +3 -1
  3. package/dist/api/applesilicon/v1alpha1/api.gen.js +22 -1
  4. package/dist/api/applesilicon/v1alpha1/index.gen.d.ts +1 -1
  5. package/dist/api/applesilicon/v1alpha1/marshalling.gen.cjs +47 -0
  6. package/dist/api/applesilicon/v1alpha1/marshalling.gen.d.ts +4 -1
  7. package/dist/api/applesilicon/v1alpha1/marshalling.gen.js +48 -1
  8. package/dist/api/applesilicon/v1alpha1/types.gen.d.ts +33 -0
  9. package/dist/api/block/v1alpha1/api.gen.cjs +2 -1
  10. package/dist/api/block/v1alpha1/api.gen.js +2 -1
  11. package/dist/api/block/v1alpha1/types.gen.d.ts +5 -0
  12. package/dist/api/cockpit/v1/api.gen.cjs +21 -2
  13. package/dist/api/cockpit/v1/api.gen.d.ts +16 -3
  14. package/dist/api/cockpit/v1/api.gen.js +22 -3
  15. package/dist/api/cockpit/v1/index.gen.d.ts +1 -1
  16. package/dist/api/cockpit/v1/marshalling.gen.cjs +29 -1
  17. package/dist/api/cockpit/v1/marshalling.gen.d.ts +2 -1
  18. package/dist/api/cockpit/v1/marshalling.gen.js +29 -1
  19. package/dist/api/cockpit/v1/types.gen.d.ts +29 -1
  20. package/dist/api/cockpit/v1/validation-rules.gen.cjs +11 -0
  21. package/dist/api/cockpit/v1/validation-rules.gen.d.ts +11 -0
  22. package/dist/api/cockpit/v1/validation-rules.gen.js +11 -0
  23. package/dist/api/container/v1beta1/index.gen.d.ts +1 -1
  24. package/dist/api/container/v1beta1/marshalling.gen.cjs +70 -6
  25. package/dist/api/container/v1beta1/marshalling.gen.js +71 -7
  26. package/dist/api/container/v1beta1/types.gen.d.ts +74 -2
  27. package/dist/api/container/v1beta1/validation-rules.gen.cjs +14 -0
  28. package/dist/api/container/v1beta1/validation-rules.gen.d.ts +12 -0
  29. package/dist/api/container/v1beta1/validation-rules.gen.js +14 -0
  30. package/dist/api/edge_services/v1alpha1/types.gen.d.ts +4 -4
  31. package/dist/api/function/v1beta1/marshalling.gen.cjs +12 -4
  32. package/dist/api/function/v1beta1/marshalling.gen.js +13 -5
  33. package/dist/api/function/v1beta1/types.gen.d.ts +16 -0
  34. package/dist/api/iam/v1alpha1/api.gen.cjs +37 -0
  35. package/dist/api/iam/v1alpha1/api.gen.d.ts +22 -1
  36. package/dist/api/iam/v1alpha1/api.gen.js +37 -0
  37. package/dist/api/iam/v1alpha1/index.gen.d.ts +1 -1
  38. package/dist/api/iam/v1alpha1/types.gen.d.ts +12 -0
  39. package/dist/api/inference/v1beta1/types.gen.d.ts +3 -3
  40. package/dist/api/instance/v1/api.gen.cjs +2 -2
  41. package/dist/api/instance/v1/api.gen.d.ts +2 -2
  42. package/dist/api/instance/v1/api.gen.js +2 -2
  43. package/dist/api/instance/v1/types.gen.d.ts +2 -2
  44. package/dist/api/iot/v1/api.gen.cjs +4 -3
  45. package/dist/api/iot/v1/api.gen.d.ts +4 -3
  46. package/dist/api/iot/v1/api.gen.js +4 -3
  47. package/dist/api/iot/v1/types.gen.d.ts +6 -6
  48. package/dist/api/ipam/v1/types.gen.d.ts +1 -1
  49. package/dist/api/jobs/v1alpha1/api.gen.cjs +29 -0
  50. package/dist/api/jobs/v1alpha1/api.gen.d.ts +29 -0
  51. package/dist/api/jobs/v1alpha1/api.gen.js +29 -0
  52. package/dist/api/jobs/v1alpha1/types.gen.d.ts +38 -6
  53. package/dist/api/k8s/v1/api.gen.cjs +65 -1
  54. package/dist/api/k8s/v1/api.gen.d.ts +32 -1
  55. package/dist/api/k8s/v1/api.gen.js +66 -2
  56. package/dist/api/k8s/v1/index.gen.d.ts +1 -1
  57. package/dist/api/k8s/v1/marshalling.gen.cjs +62 -0
  58. package/dist/api/k8s/v1/marshalling.gen.d.ts +6 -1
  59. package/dist/api/k8s/v1/marshalling.gen.js +62 -0
  60. package/dist/api/k8s/v1/types.gen.d.ts +93 -1
  61. package/dist/api/k8s/v1/validation-rules.gen.cjs +6 -0
  62. package/dist/api/k8s/v1/validation-rules.gen.d.ts +5 -0
  63. package/dist/api/k8s/v1/validation-rules.gen.js +6 -0
  64. package/dist/api/lb/v1/types.gen.d.ts +15 -10
  65. package/dist/api/mongodb/v1alpha1/api.gen.cjs +23 -16
  66. package/dist/api/mongodb/v1alpha1/api.gen.d.ts +10 -1
  67. package/dist/api/mongodb/v1alpha1/api.gen.js +24 -17
  68. package/dist/api/mongodb/v1alpha1/index.gen.d.ts +1 -1
  69. package/dist/api/mongodb/v1alpha1/marshalling.gen.cjs +5 -0
  70. package/dist/api/mongodb/v1alpha1/marshalling.gen.d.ts +2 -1
  71. package/dist/api/mongodb/v1alpha1/marshalling.gen.js +5 -0
  72. package/dist/api/mongodb/v1alpha1/types.gen.d.ts +13 -0
  73. package/dist/api/mongodb/v1alpha1/validation-rules.gen.cjs +12 -0
  74. package/dist/api/mongodb/v1alpha1/validation-rules.gen.d.ts +11 -0
  75. package/dist/api/mongodb/v1alpha1/validation-rules.gen.js +12 -0
  76. package/dist/api/rdb/v1/marshalling.gen.cjs +2 -1
  77. package/dist/api/rdb/v1/marshalling.gen.js +2 -1
  78. package/dist/api/rdb/v1/types.gen.d.ts +22 -13
  79. package/dist/api/webhosting/v1/api.gen.cjs +2 -8
  80. package/dist/api/webhosting/v1/api.gen.js +2 -8
  81. package/dist/scw/constants.cjs +1 -1
  82. package/dist/scw/constants.d.ts +2 -2
  83. package/dist/scw/constants.js +1 -1
  84. package/package.json +2 -2
@@ -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.
@@ -1,6 +1,6 @@
1
1
  import type { Region, Zone } from '../../../bridge';
2
2
  export type ListIPsRequestOrderBy = 'created_at_desc' | 'created_at_asc' | 'updated_at_desc' | 'updated_at_asc' | 'attached_at_desc' | 'attached_at_asc';
3
- export type ResourceType = 'unknown_type' | 'custom' | 'instance_server' | 'instance_ip' | 'instance_private_nic' | 'lb_server' | 'fip_ip' | 'vpc_gateway' | 'vpc_gateway_network' | 'k8s_node' | 'k8s_cluster' | 'rdb_instance' | 'redis_cluster' | 'baremetal_server' | 'baremetal_private_nic' | 'llm_deployment';
3
+ export type ResourceType = 'unknown_type' | 'custom' | 'instance_server' | 'instance_ip' | 'instance_private_nic' | 'lb_server' | 'fip_ip' | 'vpc_gateway' | 'vpc_gateway_network' | 'k8s_node' | 'k8s_cluster' | 'rdb_instance' | 'redis_cluster' | 'baremetal_server' | 'baremetal_private_nic' | 'llm_deployment' | 'mgdb_instance';
4
4
  export interface Resource {
5
5
  /** Type of resource the IP is attached to. */
6
6
  type: ResourceType;
@@ -114,6 +114,12 @@ class API extends api.API {
114
114
  },
115
115
  marshalling_gen.unmarshalStartJobDefinitionResponse
116
116
  );
117
+ /**
118
+ * Create a secret reference within a job definition.
119
+ *
120
+ * @param request - The request {@link CreateJobDefinitionSecretsRequest}
121
+ * @returns A Promise of CreateJobDefinitionSecretsResponse
122
+ */
117
123
  createJobDefinitionSecrets = (request) => this.client.fetch(
118
124
  {
119
125
  body: JSON.stringify(
@@ -128,6 +134,12 @@ class API extends api.API {
128
134
  },
129
135
  marshalling_gen.unmarshalCreateJobDefinitionSecretsResponse
130
136
  );
137
+ /**
138
+ * Get a secret references within a job definition.
139
+ *
140
+ * @param request - The request {@link GetJobDefinitionSecretRequest}
141
+ * @returns A Promise of Secret
142
+ */
131
143
  getJobDefinitionSecret = (request) => this.client.fetch(
132
144
  {
133
145
  method: "GET",
@@ -135,6 +147,12 @@ class API extends api.API {
135
147
  },
136
148
  marshalling_gen.unmarshalSecret
137
149
  );
150
+ /**
151
+ * List secrets references within a job definition.
152
+ *
153
+ * @param request - The request {@link ListJobDefinitionSecretsRequest}
154
+ * @returns A Promise of ListJobDefinitionSecretsResponse
155
+ */
138
156
  listJobDefinitionSecrets = (request) => this.client.fetch(
139
157
  {
140
158
  method: "GET",
@@ -142,6 +160,12 @@ class API extends api.API {
142
160
  },
143
161
  marshalling_gen.unmarshalListJobDefinitionSecretsResponse
144
162
  );
163
+ /**
164
+ * Update a secret reference within a job definition.
165
+ *
166
+ * @param request - The request {@link UpdateJobDefinitionSecretRequest}
167
+ * @returns A Promise of Secret
168
+ */
145
169
  updateJobDefinitionSecret = (request) => this.client.fetch(
146
170
  {
147
171
  body: JSON.stringify(
@@ -156,6 +180,11 @@ class API extends api.API {
156
180
  },
157
181
  marshalling_gen.unmarshalSecret
158
182
  );
183
+ /**
184
+ * Delete a secret reference within a job definition.
185
+ *
186
+ * @param request - The request {@link DeleteJobDefinitionSecretRequest}
187
+ */
159
188
  deleteJobDefinitionSecret = (request) => this.client.fetch({
160
189
  method: "DELETE",
161
190
  path: `/serverless-jobs/v1alpha1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/job-definitions/${marshalling.validatePathParam("jobDefinitionId", request.jobDefinitionId)}/secrets/${marshalling.validatePathParam("secretId", request.secretId)}`
@@ -56,10 +56,39 @@ export declare class API extends ParentAPI {
56
56
  * @returns A Promise of StartJobDefinitionResponse
57
57
  */
58
58
  startJobDefinition: (request: Readonly<StartJobDefinitionRequest>) => Promise<StartJobDefinitionResponse>;
59
+ /**
60
+ * Create a secret reference within a job definition.
61
+ *
62
+ * @param request - The request {@link CreateJobDefinitionSecretsRequest}
63
+ * @returns A Promise of CreateJobDefinitionSecretsResponse
64
+ */
59
65
  createJobDefinitionSecrets: (request: Readonly<CreateJobDefinitionSecretsRequest>) => Promise<CreateJobDefinitionSecretsResponse>;
66
+ /**
67
+ * Get a secret references within a job definition.
68
+ *
69
+ * @param request - The request {@link GetJobDefinitionSecretRequest}
70
+ * @returns A Promise of Secret
71
+ */
60
72
  getJobDefinitionSecret: (request: Readonly<GetJobDefinitionSecretRequest>) => Promise<Secret>;
73
+ /**
74
+ * List secrets references within a job definition.
75
+ *
76
+ * @param request - The request {@link ListJobDefinitionSecretsRequest}
77
+ * @returns A Promise of ListJobDefinitionSecretsResponse
78
+ */
61
79
  listJobDefinitionSecrets: (request: Readonly<ListJobDefinitionSecretsRequest>) => Promise<ListJobDefinitionSecretsResponse>;
80
+ /**
81
+ * Update a secret reference within a job definition.
82
+ *
83
+ * @param request - The request {@link UpdateJobDefinitionSecretRequest}
84
+ * @returns A Promise of Secret
85
+ */
62
86
  updateJobDefinitionSecret: (request: Readonly<UpdateJobDefinitionSecretRequest>) => Promise<Secret>;
87
+ /**
88
+ * Delete a secret reference within a job definition.
89
+ *
90
+ * @param request - The request {@link DeleteJobDefinitionSecretRequest}
91
+ */
63
92
  deleteJobDefinitionSecret: (request: Readonly<DeleteJobDefinitionSecretRequest>) => Promise<void>;
64
93
  /**
65
94
  * Get a job run by its unique identifier.
@@ -112,6 +112,12 @@ class API extends API$1 {
112
112
  },
113
113
  unmarshalStartJobDefinitionResponse
114
114
  );
115
+ /**
116
+ * Create a secret reference within a job definition.
117
+ *
118
+ * @param request - The request {@link CreateJobDefinitionSecretsRequest}
119
+ * @returns A Promise of CreateJobDefinitionSecretsResponse
120
+ */
115
121
  createJobDefinitionSecrets = (request) => this.client.fetch(
116
122
  {
117
123
  body: JSON.stringify(
@@ -126,6 +132,12 @@ class API extends API$1 {
126
132
  },
127
133
  unmarshalCreateJobDefinitionSecretsResponse
128
134
  );
135
+ /**
136
+ * Get a secret references within a job definition.
137
+ *
138
+ * @param request - The request {@link GetJobDefinitionSecretRequest}
139
+ * @returns A Promise of Secret
140
+ */
129
141
  getJobDefinitionSecret = (request) => this.client.fetch(
130
142
  {
131
143
  method: "GET",
@@ -133,6 +145,12 @@ class API extends API$1 {
133
145
  },
134
146
  unmarshalSecret
135
147
  );
148
+ /**
149
+ * List secrets references within a job definition.
150
+ *
151
+ * @param request - The request {@link ListJobDefinitionSecretsRequest}
152
+ * @returns A Promise of ListJobDefinitionSecretsResponse
153
+ */
136
154
  listJobDefinitionSecrets = (request) => this.client.fetch(
137
155
  {
138
156
  method: "GET",
@@ -140,6 +158,12 @@ class API extends API$1 {
140
158
  },
141
159
  unmarshalListJobDefinitionSecretsResponse
142
160
  );
161
+ /**
162
+ * Update a secret reference within a job definition.
163
+ *
164
+ * @param request - The request {@link UpdateJobDefinitionSecretRequest}
165
+ * @returns A Promise of Secret
166
+ */
143
167
  updateJobDefinitionSecret = (request) => this.client.fetch(
144
168
  {
145
169
  body: JSON.stringify(
@@ -154,6 +178,11 @@ class API extends API$1 {
154
178
  },
155
179
  unmarshalSecret
156
180
  );
181
+ /**
182
+ * Delete a secret reference within a job definition.
183
+ *
184
+ * @param request - The request {@link DeleteJobDefinitionSecretRequest}
185
+ */
157
186
  deleteJobDefinitionSecret = (request) => this.client.fetch({
158
187
  method: "DELETE",
159
188
  path: `/serverless-jobs/v1alpha1/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/job-definitions/${validatePathParam("jobDefinitionId", request.jobDefinitionId)}/secrets/${validatePathParam("secretId", request.secretId)}`
@@ -30,12 +30,23 @@ export interface CreateJobDefinitionSecretsRequestSecretConfig {
30
30
  envVarName?: string;
31
31
  }
32
32
  export interface Secret {
33
+ /** UUID of the secret reference within the job. */
33
34
  secretId: string;
35
+ /** UUID of the secret in Secret Manager. */
34
36
  secretManagerId: string;
37
+ /** Version of the secret in Secret Manager. */
35
38
  secretManagerVersion: string;
36
- /** One-of ('secretConfig'): at most one of 'file', 'envVar' could be set. */
39
+ /**
40
+ * File secret mounted inside the job.
41
+ *
42
+ * One-of ('secretConfig'): at most one of 'file', 'envVar' could be set.
43
+ */
37
44
  file?: SecretFile;
38
- /** One-of ('secretConfig'): at most one of 'file', 'envVar' could be set. */
45
+ /**
46
+ * Environment variable used to expose the secret.
47
+ *
48
+ * One-of ('secretConfig'): at most one of 'file', 'envVar' could be set.
49
+ */
39
50
  envVar?: SecretEnvVar;
40
51
  }
41
52
  export interface JobDefinition {
@@ -127,12 +138,13 @@ export type CreateJobDefinitionSecretsRequest = {
127
138
  * config.
128
139
  */
129
140
  region?: Region;
130
- /** UUID of the job definition to get. */
141
+ /** UUID of the job definition. */
131
142
  jobDefinitionId: string;
132
- /** Secrets to inject into the job. */
143
+ /** List of secrets to inject into the job. */
133
144
  secrets: CreateJobDefinitionSecretsRequestSecretConfig[];
134
145
  };
135
146
  export interface CreateJobDefinitionSecretsResponse {
147
+ /** List of secrets created. */
136
148
  secrets: Secret[];
137
149
  }
138
150
  export type DeleteJobDefinitionRequest = {
@@ -150,7 +162,9 @@ export type DeleteJobDefinitionSecretRequest = {
150
162
  * config.
151
163
  */
152
164
  region?: Region;
165
+ /** UUID of the job definition. */
153
166
  jobDefinitionId: string;
167
+ /** UUID of the secret reference within the job. */
154
168
  secretId: string;
155
169
  };
156
170
  export type GetJobDefinitionRequest = {
@@ -168,7 +182,9 @@ export type GetJobDefinitionSecretRequest = {
168
182
  * config.
169
183
  */
170
184
  region?: Region;
185
+ /** UUID of the job definition. */
171
186
  jobDefinitionId: string;
187
+ /** UUID of the secret reference within the job. */
172
188
  secretId: string;
173
189
  };
174
190
  export type GetJobRunRequest = {
@@ -196,10 +212,13 @@ export type ListJobDefinitionSecretsRequest = {
196
212
  * config.
197
213
  */
198
214
  region?: Region;
215
+ /** UUID of the job definition. */
199
216
  jobDefinitionId: string;
200
217
  };
201
218
  export interface ListJobDefinitionSecretsResponse {
219
+ /** List of secret references within a job definition. */
202
220
  secrets: Secret[];
221
+ /** Total count of secret references within a job definition. */
203
222
  totalCount: number;
204
223
  }
205
224
  export type ListJobDefinitionsRequest = {
@@ -306,11 +325,24 @@ export type UpdateJobDefinitionSecretRequest = {
306
325
  * config.
307
326
  */
308
327
  region?: Region;
328
+ /** UUID of the job definition. */
309
329
  jobDefinitionId: string;
330
+ /** UUID of the secret reference within the job. */
310
331
  secretId: string;
332
+ /** Version of the secret in Secret Manager. */
311
333
  secretManagerVersion?: string;
312
- /** One-of ('secretConfig'): at most one of 'path', 'envVarName' could be set. */
334
+ /**
335
+ * Path of the secret to mount inside the job (either `path` or `env_var_name`
336
+ * must be set).
337
+ *
338
+ * One-of ('secretConfig'): at most one of 'path', 'envVarName' could be set.
339
+ */
313
340
  path?: string;
314
- /** One-of ('secretConfig'): at most one of 'path', 'envVarName' could be set. */
341
+ /**
342
+ * Environment variable name used to expose the secret inside the job (either
343
+ * `path` or `env_var_name` must be set).
344
+ *
345
+ * One-of ('secretConfig'): at most one of 'path', 'envVarName' could be set.
346
+ */
315
347
  envVarName?: string;
316
348
  };
@@ -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",
@@ -360,7 +424,7 @@ class API extends api.API {
360
424
  getNodeMetadata = (request = {}) => this.client.fetch(
361
425
  {
362
426
  method: "GET",
363
- path: `/k8s/v1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/nodes/metadata`
427
+ path: `/k8s/v1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/node-metadata`
364
428
  },
365
429
  marshalling_gen.unmarshalNodeMetadata
366
430
  );
@@ -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",
@@ -358,7 +422,7 @@ class API extends API$1 {
358
422
  getNodeMetadata = (request = {}) => this.client.fetch(
359
423
  {
360
424
  method: "GET",
361
- path: `/k8s/v1/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/nodes/metadata`
425
+ path: `/k8s/v1/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/node-metadata`
362
426
  },
363
427
  unmarshalNodeMetadata
364
428
  );
@@ -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';