@scaleway/sdk-jobs 2.1.1 → 2.2.1

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.
@@ -3,3 +3,4 @@
3
3
  * PLEASE DO NOT EDIT HERE
4
4
  */
5
5
  export * as Jobsv1alpha1 from './v1alpha1/index.gen.js';
6
+ export * as Jobsv1alpha2 from './v1alpha2/index.gen.js';
package/dist/index.gen.js CHANGED
@@ -1,4 +1,6 @@
1
1
  import * as index_gen from "./v1alpha1/index.gen.js";
2
+ import * as index_gen$1 from "./v1alpha2/index.gen.js";
2
3
  export {
3
- index_gen as Jobsv1alpha1
4
+ index_gen as Jobsv1alpha1,
5
+ index_gen$1 as Jobsv1alpha2
4
6
  };
@@ -9,11 +9,7 @@ class API extends API$1 {
9
9
  * type ∈ {'zone','region','global','unspecified'}
10
10
  */
11
11
  static LOCALITY = toApiLocality({
12
- regions: [
13
- "fr-par",
14
- "nl-ams",
15
- "pl-waw"
16
- ]
12
+ regions: ["fr-par", "nl-ams", "pl-waw"]
17
13
  });
18
14
  /**
19
15
  * Create a new job definition in a specified Project.
@@ -53,7 +49,10 @@ class API extends API$1 {
53
49
  ["order_by", request.orderBy],
54
50
  ["organization_id", request.organizationId],
55
51
  ["page", request.page],
56
- ["page_size", request.pageSize ?? this.client.settings.defaultPageSize],
52
+ [
53
+ "page_size",
54
+ request.pageSize ?? this.client.settings.defaultPageSize
55
+ ],
57
56
  ["project_id", request.projectId]
58
57
  )
59
58
  },
@@ -65,7 +64,11 @@ class API extends API$1 {
65
64
  * @param request - The request {@link ListJobDefinitionsRequest}
66
65
  * @returns A Promise of ListJobDefinitionsResponse
67
66
  */
68
- listJobDefinitions = (request = {}) => enrichForPagination("jobDefinitions", this.pageOfListJobDefinitions, request);
67
+ listJobDefinitions = (request = {}) => enrichForPagination(
68
+ "jobDefinitions",
69
+ this.pageOfListJobDefinitions,
70
+ request
71
+ );
69
72
  /**
70
73
  * Update an existing job definition associated with the specified unique identifier.
71
74
  *
@@ -88,12 +91,10 @@ class API extends API$1 {
88
91
  *
89
92
  * @param request - The request {@link DeleteJobDefinitionRequest}
90
93
  */
91
- deleteJobDefinition = (request) => this.client.fetch(
92
- {
93
- method: "DELETE",
94
- path: `/serverless-jobs/v1alpha1/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/job-definitions/${validatePathParam("jobDefinitionId", request.jobDefinitionId)}`
95
- }
96
- );
94
+ deleteJobDefinition = (request) => this.client.fetch({
95
+ method: "DELETE",
96
+ path: `/serverless-jobs/v1alpha1/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/job-definitions/${validatePathParam("jobDefinitionId", request.jobDefinitionId)}`
97
+ });
97
98
  /**
98
99
  * Run an existing job definition by its unique identifier. This will create a new job run.
99
100
  *
@@ -120,7 +121,10 @@ class API extends API$1 {
120
121
  createJobDefinitionSecrets = (request) => this.client.fetch(
121
122
  {
122
123
  body: JSON.stringify(
123
- marshalCreateJobDefinitionSecretsRequest(request, this.client.settings)
124
+ marshalCreateJobDefinitionSecretsRequest(
125
+ request,
126
+ this.client.settings
127
+ )
124
128
  ),
125
129
  headers: jsonContentHeaders,
126
130
  method: "POST",
@@ -163,7 +167,10 @@ class API extends API$1 {
163
167
  updateJobDefinitionSecret = (request) => this.client.fetch(
164
168
  {
165
169
  body: JSON.stringify(
166
- marshalUpdateJobDefinitionSecretRequest(request, this.client.settings)
170
+ marshalUpdateJobDefinitionSecretRequest(
171
+ request,
172
+ this.client.settings
173
+ )
167
174
  ),
168
175
  headers: jsonContentHeaders,
169
176
  method: "PATCH",
@@ -176,12 +183,10 @@ class API extends API$1 {
176
183
  *
177
184
  * @param request - The request {@link DeleteJobDefinitionSecretRequest}
178
185
  */
179
- deleteJobDefinitionSecret = (request) => this.client.fetch(
180
- {
181
- method: "DELETE",
182
- path: `/serverless-jobs/v1alpha1/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/job-definitions/${validatePathParam("jobDefinitionId", request.jobDefinitionId)}/secrets/${validatePathParam("secretId", request.secretId)}`
183
- }
184
- );
186
+ deleteJobDefinitionSecret = (request) => this.client.fetch({
187
+ method: "DELETE",
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)}`
189
+ });
185
190
  /**
186
191
  * Get a job run by its unique identifier.
187
192
  *
@@ -219,7 +224,10 @@ class API extends API$1 {
219
224
  ["order_by", request.orderBy],
220
225
  ["organization_id", request.organizationId],
221
226
  ["page", request.page],
222
- ["page_size", request.pageSize ?? this.client.settings.defaultPageSize],
227
+ [
228
+ "page_size",
229
+ request.pageSize ?? this.client.settings.defaultPageSize
230
+ ],
223
231
  ["project_id", request.projectId],
224
232
  ["state", request.state],
225
233
  ["states", request.states]
@@ -1,4 +1,4 @@
1
- export { API, } from './api.gen.js';
1
+ export { API } from './api.gen.js';
2
2
  export * from './content.gen.js';
3
3
  export * from './marshalling.gen.js';
4
4
  export type { CreateJobDefinitionRequest, CreateJobDefinitionRequestCronScheduleConfig, CreateJobDefinitionSecretsRequest, CreateJobDefinitionSecretsRequestSecretConfig, CreateJobDefinitionSecretsResponse, CronSchedule, DeleteJobDefinitionRequest, DeleteJobDefinitionSecretRequest, GetJobDefinitionRequest, GetJobDefinitionSecretRequest, GetJobRunRequest, GetJobsLimitsRequest, JobDefinition, JobRun, JobRunState, JobsLimits, ListJobDefinitionSecretsRequest, ListJobDefinitionSecretsResponse, ListJobDefinitionsRequest, ListJobDefinitionsRequestOrderBy, ListJobDefinitionsResponse, ListJobRunsRequest, ListJobRunsRequestOrderBy, ListJobRunsResponse, ListJobsResourcesRequest, ListJobsResourcesResponse, Resource, Secret, SecretEnvVar, SecretFile, StartJobDefinitionRequest, StartJobDefinitionResponse, StopJobRunRequest, UpdateJobDefinitionRequest, UpdateJobDefinitionRequestCronScheduleConfig, UpdateJobDefinitionSecretRequest, } from './types.gen.js';
@@ -132,7 +132,10 @@ const unmarshalListJobDefinitionsResponse = (data) => {
132
132
  );
133
133
  }
134
134
  return {
135
- jobDefinitions: unmarshalArrayOfObject(data.job_definitions, unmarshalJobDefinition),
135
+ jobDefinitions: unmarshalArrayOfObject(
136
+ data.job_definitions,
137
+ unmarshalJobDefinition
138
+ ),
136
139
  totalCount: data.total_count
137
140
  };
138
141
  };
@@ -185,7 +188,9 @@ const marshalCreateJobDefinitionRequestCronScheduleConfig = (request, defaults)
185
188
  const marshalCreateJobDefinitionRequest = (request, defaults) => ({
186
189
  command: request.command,
187
190
  cpu_limit: request.cpuLimit,
188
- cron_schedule: request.cronSchedule !== void 0 ? marshalCreateJobDefinitionRequestCronScheduleConfig(request.cronSchedule) : void 0,
191
+ cron_schedule: request.cronSchedule !== void 0 ? marshalCreateJobDefinitionRequestCronScheduleConfig(
192
+ request.cronSchedule
193
+ ) : void 0,
189
194
  description: request.description,
190
195
  environment_variables: request.environmentVariables !== void 0 ? request.environmentVariables : void 0,
191
196
  image_uri: request.imageUri,
@@ -199,18 +204,14 @@ const marshalCreateJobDefinitionSecretsRequestSecretConfig = (request, defaults)
199
204
  secret_manager_id: request.secretManagerId,
200
205
  secret_manager_version: request.secretManagerVersion,
201
206
  ...resolveOneOf([
202
- {
203
- param: "path",
204
- value: request.path
205
- },
206
- {
207
- param: "env_var_name",
208
- value: request.envVarName
209
- }
207
+ { param: "path", value: request.path },
208
+ { param: "env_var_name", value: request.envVarName }
210
209
  ])
211
210
  });
212
211
  const marshalCreateJobDefinitionSecretsRequest = (request, defaults) => ({
213
- secrets: request.secrets.map((elt) => marshalCreateJobDefinitionSecretsRequestSecretConfig(elt))
212
+ secrets: request.secrets.map(
213
+ (elt) => marshalCreateJobDefinitionSecretsRequestSecretConfig(elt)
214
+ )
214
215
  });
215
216
  const marshalStartJobDefinitionRequest = (request, defaults) => ({
216
217
  command: request.command,
@@ -224,7 +225,9 @@ const marshalUpdateJobDefinitionRequestCronScheduleConfig = (request, defaults)
224
225
  const marshalUpdateJobDefinitionRequest = (request, defaults) => ({
225
226
  command: request.command,
226
227
  cpu_limit: request.cpuLimit,
227
- cron_schedule: request.cronSchedule !== void 0 ? marshalUpdateJobDefinitionRequestCronScheduleConfig(request.cronSchedule) : void 0,
228
+ cron_schedule: request.cronSchedule !== void 0 ? marshalUpdateJobDefinitionRequestCronScheduleConfig(
229
+ request.cronSchedule
230
+ ) : void 0,
228
231
  description: request.description,
229
232
  environment_variables: request.environmentVariables,
230
233
  image_uri: request.imageUri,
@@ -236,14 +239,8 @@ const marshalUpdateJobDefinitionRequest = (request, defaults) => ({
236
239
  const marshalUpdateJobDefinitionSecretRequest = (request, defaults) => ({
237
240
  secret_manager_version: request.secretManagerVersion,
238
241
  ...resolveOneOf([
239
- {
240
- param: "path",
241
- value: request.path
242
- },
243
- {
244
- param: "env_var_name",
245
- value: request.envVarName
246
- }
242
+ { param: "path", value: request.path },
243
+ { param: "env_var_name", value: request.envVarName }
247
244
  ])
248
245
  });
249
246
  export {
@@ -0,0 +1,133 @@
1
+ import type { ApiLocality } from '@scaleway/sdk-client';
2
+ import { API as ParentAPI } from '@scaleway/sdk-client';
3
+ import type { CreateJobDefinitionRequest, CreateSecretsRequest, CreateSecretsResponse, DeleteJobDefinitionRequest, DeleteSecretRequest, GetJobDefinitionRequest, GetJobLimitsRequest, GetJobRunRequest, GetSecretRequest, JobDefinition, JobLimits, JobRun, ListJobDefinitionsRequest, ListJobDefinitionsResponse, ListJobResourcesRequest, ListJobResourcesResponse, ListJobRunsRequest, ListJobRunsResponse, ListSecretsRequest, ListSecretsResponse, Secret, StartJobDefinitionRequest, StartJobDefinitionResponse, StopJobRunRequest, UpdateJobDefinitionRequest, UpdateSecretRequest } from './types.gen.js';
4
+ /**
5
+ * Serverless Jobs API.
6
+
7
+ This API allows you to manage your Serverless Jobs.
8
+ */
9
+ export declare class API extends ParentAPI {
10
+ /**
11
+ * Locality of this API.
12
+ * type ∈ {'zone','region','global','unspecified'}
13
+ */
14
+ static readonly LOCALITY: ApiLocality;
15
+ /**
16
+ * Create a new job definition in a specified Project.
17
+ *
18
+ * @param request - The request {@link CreateJobDefinitionRequest}
19
+ * @returns A Promise of JobDefinition
20
+ */
21
+ createJobDefinition: (request: Readonly<CreateJobDefinitionRequest>) => Promise<JobDefinition>;
22
+ /**
23
+ * Get a job definition by its unique identifier.
24
+ *
25
+ * @param request - The request {@link GetJobDefinitionRequest}
26
+ * @returns A Promise of JobDefinition
27
+ */
28
+ getJobDefinition: (request: Readonly<GetJobDefinitionRequest>) => Promise<JobDefinition>;
29
+ protected pageOfListJobDefinitions: (request?: Readonly<ListJobDefinitionsRequest>) => Promise<ListJobDefinitionsResponse>;
30
+ /**
31
+ * List all your job definitions with filters.
32
+ *
33
+ * @param request - The request {@link ListJobDefinitionsRequest}
34
+ * @returns A Promise of ListJobDefinitionsResponse
35
+ */
36
+ listJobDefinitions: (request?: Readonly<ListJobDefinitionsRequest>) => Promise<ListJobDefinitionsResponse> & {
37
+ all: () => Promise<JobDefinition[]>;
38
+ [Symbol.asyncIterator]: () => AsyncGenerator<JobDefinition[], void, void>;
39
+ };
40
+ /**
41
+ * Update an existing job definition associated with the specified unique identifier.
42
+ *
43
+ * @param request - The request {@link UpdateJobDefinitionRequest}
44
+ * @returns A Promise of JobDefinition
45
+ */
46
+ updateJobDefinition: (request: Readonly<UpdateJobDefinitionRequest>) => Promise<JobDefinition>;
47
+ /**
48
+ * Delete an existing job definition by its unique identifier.
49
+ *
50
+ * @param request - The request {@link DeleteJobDefinitionRequest}
51
+ */
52
+ deleteJobDefinition: (request: Readonly<DeleteJobDefinitionRequest>) => Promise<void>;
53
+ /**
54
+ * Run an existing job definition using its unique identifier and create a new job run.
55
+ *
56
+ * @param request - The request {@link StartJobDefinitionRequest}
57
+ * @returns A Promise of StartJobDefinitionResponse
58
+ */
59
+ startJobDefinition: (request: Readonly<StartJobDefinitionRequest>) => Promise<StartJobDefinitionResponse>;
60
+ /**
61
+ * Get a job run by its unique identifier.
62
+ *
63
+ * @param request - The request {@link GetJobRunRequest}
64
+ * @returns A Promise of JobRun
65
+ */
66
+ getJobRun: (request: Readonly<GetJobRunRequest>) => Promise<JobRun>;
67
+ protected pageOfListJobRuns: (request?: Readonly<ListJobRunsRequest>) => Promise<ListJobRunsResponse>;
68
+ /**
69
+ * List all job runs with filters.
70
+ *
71
+ * @param request - The request {@link ListJobRunsRequest}
72
+ * @returns A Promise of ListJobRunsResponse
73
+ */
74
+ listJobRuns: (request?: Readonly<ListJobRunsRequest>) => Promise<ListJobRunsResponse> & {
75
+ all: () => Promise<JobRun[]>;
76
+ [Symbol.asyncIterator]: () => AsyncGenerator<JobRun[], void, void>;
77
+ };
78
+ /**
79
+ * Stop a job run using its unique identifier.
80
+ *
81
+ * @param request - The request {@link StopJobRunRequest}
82
+ * @returns A Promise of JobRun
83
+ */
84
+ stopJobRun: (request: Readonly<StopJobRunRequest>) => Promise<JobRun>;
85
+ /**
86
+ * Create a secret reference within a job definition.
87
+ *
88
+ * @param request - The request {@link CreateSecretsRequest}
89
+ * @returns A Promise of CreateSecretsResponse
90
+ */
91
+ createSecrets: (request: Readonly<CreateSecretsRequest>) => Promise<CreateSecretsResponse>;
92
+ /**
93
+ * Get a secret references within a job definition.
94
+ *
95
+ * @param request - The request {@link GetSecretRequest}
96
+ * @returns A Promise of Secret
97
+ */
98
+ getSecret: (request: Readonly<GetSecretRequest>) => Promise<Secret>;
99
+ /**
100
+ * List secrets references within a job definition.
101
+ *
102
+ * @param request - The request {@link ListSecretsRequest}
103
+ * @returns A Promise of ListSecretsResponse
104
+ */
105
+ listSecrets: (request: Readonly<ListSecretsRequest>) => Promise<ListSecretsResponse>;
106
+ /**
107
+ * Update a secret reference within a job definition.
108
+ *
109
+ * @param request - The request {@link UpdateSecretRequest}
110
+ * @returns A Promise of Secret
111
+ */
112
+ updateSecret: (request: Readonly<UpdateSecretRequest>) => Promise<Secret>;
113
+ /**
114
+ * Delete a secret reference within a job definition.
115
+ *
116
+ * @param request - The request {@link DeleteSecretRequest}
117
+ */
118
+ deleteSecret: (request: Readonly<DeleteSecretRequest>) => Promise<void>;
119
+ /**
120
+ * List job resources for the console.
121
+ *
122
+ * @param request - The request {@link ListJobResourcesRequest}
123
+ * @returns A Promise of ListJobResourcesResponse
124
+ */
125
+ listJobResources: (request?: Readonly<ListJobResourcesRequest>) => Promise<ListJobResourcesResponse>;
126
+ /**
127
+ * Get job limits for the console.
128
+ *
129
+ * @param request - The request {@link GetJobLimitsRequest}
130
+ * @returns A Promise of JobLimits
131
+ */
132
+ getJobLimits: (request?: Readonly<GetJobLimitsRequest>) => Promise<JobLimits>;
133
+ }
@@ -0,0 +1,270 @@
1
+ import { API as API$1, toApiLocality, validatePathParam, urlParams, enrichForPagination } from "@scaleway/sdk-client";
2
+ import { marshalCreateJobDefinitionRequest, unmarshalJobDefinition, unmarshalListJobDefinitionsResponse, marshalUpdateJobDefinitionRequest, marshalStartJobDefinitionRequest, unmarshalStartJobDefinitionResponse, unmarshalJobRun, unmarshalListJobRunsResponse, marshalCreateSecretsRequest, unmarshalCreateSecretsResponse, unmarshalSecret, unmarshalListSecretsResponse, marshalUpdateSecretRequest, unmarshalListJobResourcesResponse, unmarshalJobLimits } from "./marshalling.gen.js";
3
+ const jsonContentHeaders = {
4
+ "Content-Type": "application/json; charset=utf-8"
5
+ };
6
+ class API extends API$1 {
7
+ /**
8
+ * Locality of this API.
9
+ * type ∈ {'zone','region','global','unspecified'}
10
+ */
11
+ static LOCALITY = toApiLocality({
12
+ regions: ["fr-par", "nl-ams", "pl-waw"]
13
+ });
14
+ /**
15
+ * Create a new job definition in a specified Project.
16
+ *
17
+ * @param request - The request {@link CreateJobDefinitionRequest}
18
+ * @returns A Promise of JobDefinition
19
+ */
20
+ createJobDefinition = (request) => this.client.fetch(
21
+ {
22
+ body: JSON.stringify(
23
+ marshalCreateJobDefinitionRequest(request, this.client.settings)
24
+ ),
25
+ headers: jsonContentHeaders,
26
+ method: "POST",
27
+ path: `/serverless-jobs/v1alpha2/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/job-definitions`
28
+ },
29
+ unmarshalJobDefinition
30
+ );
31
+ /**
32
+ * Get a job definition by its unique identifier.
33
+ *
34
+ * @param request - The request {@link GetJobDefinitionRequest}
35
+ * @returns A Promise of JobDefinition
36
+ */
37
+ getJobDefinition = (request) => this.client.fetch(
38
+ {
39
+ method: "GET",
40
+ path: `/serverless-jobs/v1alpha2/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/job-definitions/${validatePathParam("jobDefinitionId", request.jobDefinitionId)}`
41
+ },
42
+ unmarshalJobDefinition
43
+ );
44
+ pageOfListJobDefinitions = (request = {}) => this.client.fetch(
45
+ {
46
+ method: "GET",
47
+ path: `/serverless-jobs/v1alpha2/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/job-definitions`,
48
+ urlParams: urlParams(
49
+ ["order_by", request.orderBy],
50
+ ["organization_id", request.organizationId],
51
+ ["page", request.page],
52
+ [
53
+ "page_size",
54
+ request.pageSize ?? this.client.settings.defaultPageSize
55
+ ],
56
+ ["project_id", request.projectId]
57
+ )
58
+ },
59
+ unmarshalListJobDefinitionsResponse
60
+ );
61
+ /**
62
+ * List all your job definitions with filters.
63
+ *
64
+ * @param request - The request {@link ListJobDefinitionsRequest}
65
+ * @returns A Promise of ListJobDefinitionsResponse
66
+ */
67
+ listJobDefinitions = (request = {}) => enrichForPagination(
68
+ "jobDefinitions",
69
+ this.pageOfListJobDefinitions,
70
+ request
71
+ );
72
+ /**
73
+ * Update an existing job definition associated with the specified unique identifier.
74
+ *
75
+ * @param request - The request {@link UpdateJobDefinitionRequest}
76
+ * @returns A Promise of JobDefinition
77
+ */
78
+ updateJobDefinition = (request) => this.client.fetch(
79
+ {
80
+ body: JSON.stringify(
81
+ marshalUpdateJobDefinitionRequest(request, this.client.settings)
82
+ ),
83
+ headers: jsonContentHeaders,
84
+ method: "PATCH",
85
+ path: `/serverless-jobs/v1alpha2/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/job-definitions/${validatePathParam("jobDefinitionId", request.jobDefinitionId)}`
86
+ },
87
+ unmarshalJobDefinition
88
+ );
89
+ /**
90
+ * Delete an existing job definition by its unique identifier.
91
+ *
92
+ * @param request - The request {@link DeleteJobDefinitionRequest}
93
+ */
94
+ deleteJobDefinition = (request) => this.client.fetch({
95
+ method: "DELETE",
96
+ path: `/serverless-jobs/v1alpha2/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/job-definitions/${validatePathParam("jobDefinitionId", request.jobDefinitionId)}`
97
+ });
98
+ /**
99
+ * Run an existing job definition using its unique identifier and create a new job run.
100
+ *
101
+ * @param request - The request {@link StartJobDefinitionRequest}
102
+ * @returns A Promise of StartJobDefinitionResponse
103
+ */
104
+ startJobDefinition = (request) => this.client.fetch(
105
+ {
106
+ body: JSON.stringify(
107
+ marshalStartJobDefinitionRequest(request, this.client.settings)
108
+ ),
109
+ headers: jsonContentHeaders,
110
+ method: "POST",
111
+ path: `/serverless-jobs/v1alpha2/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/job-definitions/${validatePathParam("jobDefinitionId", request.jobDefinitionId)}/start`
112
+ },
113
+ unmarshalStartJobDefinitionResponse
114
+ );
115
+ /**
116
+ * Get a job run by its unique identifier.
117
+ *
118
+ * @param request - The request {@link GetJobRunRequest}
119
+ * @returns A Promise of JobRun
120
+ */
121
+ getJobRun = (request) => this.client.fetch(
122
+ {
123
+ method: "GET",
124
+ path: `/serverless-jobs/v1alpha2/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/job-runs/${validatePathParam("jobRunId", request.jobRunId)}`
125
+ },
126
+ unmarshalJobRun
127
+ );
128
+ pageOfListJobRuns = (request = {}) => this.client.fetch(
129
+ {
130
+ method: "GET",
131
+ path: `/serverless-jobs/v1alpha2/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/job-runs`,
132
+ urlParams: urlParams(
133
+ ["job_definition_id", request.jobDefinitionId],
134
+ ["order_by", request.orderBy],
135
+ ["organization_id", request.organizationId],
136
+ ["page", request.page],
137
+ [
138
+ "page_size",
139
+ request.pageSize ?? this.client.settings.defaultPageSize
140
+ ],
141
+ ["project_id", request.projectId],
142
+ ["reasons", request.reasons],
143
+ ["state", request.state],
144
+ ["states", request.states]
145
+ )
146
+ },
147
+ unmarshalListJobRunsResponse
148
+ );
149
+ /**
150
+ * List all job runs with filters.
151
+ *
152
+ * @param request - The request {@link ListJobRunsRequest}
153
+ * @returns A Promise of ListJobRunsResponse
154
+ */
155
+ listJobRuns = (request = {}) => enrichForPagination("jobRuns", this.pageOfListJobRuns, request);
156
+ /**
157
+ * Stop a job run using its unique identifier.
158
+ *
159
+ * @param request - The request {@link StopJobRunRequest}
160
+ * @returns A Promise of JobRun
161
+ */
162
+ stopJobRun = (request) => this.client.fetch(
163
+ {
164
+ body: "{}",
165
+ headers: jsonContentHeaders,
166
+ method: "POST",
167
+ path: `/serverless-jobs/v1alpha2/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/job-runs/${validatePathParam("jobRunId", request.jobRunId)}/stop`
168
+ },
169
+ unmarshalJobRun
170
+ );
171
+ /**
172
+ * Create a secret reference within a job definition.
173
+ *
174
+ * @param request - The request {@link CreateSecretsRequest}
175
+ * @returns A Promise of CreateSecretsResponse
176
+ */
177
+ createSecrets = (request) => this.client.fetch(
178
+ {
179
+ body: JSON.stringify(
180
+ marshalCreateSecretsRequest(request, this.client.settings)
181
+ ),
182
+ headers: jsonContentHeaders,
183
+ method: "POST",
184
+ path: `/serverless-jobs/v1alpha2/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/secrets`
185
+ },
186
+ unmarshalCreateSecretsResponse
187
+ );
188
+ /**
189
+ * Get a secret references within a job definition.
190
+ *
191
+ * @param request - The request {@link GetSecretRequest}
192
+ * @returns A Promise of Secret
193
+ */
194
+ getSecret = (request) => this.client.fetch(
195
+ {
196
+ method: "GET",
197
+ path: `/serverless-jobs/v1alpha2/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/secrets/${validatePathParam("secretId", request.secretId)}`
198
+ },
199
+ unmarshalSecret
200
+ );
201
+ /**
202
+ * List secrets references within a job definition.
203
+ *
204
+ * @param request - The request {@link ListSecretsRequest}
205
+ * @returns A Promise of ListSecretsResponse
206
+ */
207
+ listSecrets = (request) => this.client.fetch(
208
+ {
209
+ method: "GET",
210
+ path: `/serverless-jobs/v1alpha2/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/secrets`,
211
+ urlParams: urlParams(["job_definition_id", request.jobDefinitionId])
212
+ },
213
+ unmarshalListSecretsResponse
214
+ );
215
+ /**
216
+ * Update a secret reference within a job definition.
217
+ *
218
+ * @param request - The request {@link UpdateSecretRequest}
219
+ * @returns A Promise of Secret
220
+ */
221
+ updateSecret = (request) => this.client.fetch(
222
+ {
223
+ body: JSON.stringify(
224
+ marshalUpdateSecretRequest(request, this.client.settings)
225
+ ),
226
+ headers: jsonContentHeaders,
227
+ method: "PATCH",
228
+ path: `/serverless-jobs/v1alpha2/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/secrets/${validatePathParam("secretId", request.secretId)}`
229
+ },
230
+ unmarshalSecret
231
+ );
232
+ /**
233
+ * Delete a secret reference within a job definition.
234
+ *
235
+ * @param request - The request {@link DeleteSecretRequest}
236
+ */
237
+ deleteSecret = (request) => this.client.fetch({
238
+ method: "DELETE",
239
+ path: `/serverless-jobs/v1alpha2/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/secrets/${validatePathParam("secretId", request.secretId)}`
240
+ });
241
+ /**
242
+ * List job resources for the console.
243
+ *
244
+ * @param request - The request {@link ListJobResourcesRequest}
245
+ * @returns A Promise of ListJobResourcesResponse
246
+ */
247
+ listJobResources = (request = {}) => this.client.fetch(
248
+ {
249
+ method: "GET",
250
+ path: `/serverless-jobs/v1alpha2/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/job-resources`
251
+ },
252
+ unmarshalListJobResourcesResponse
253
+ );
254
+ /**
255
+ * Get job limits for the console.
256
+ *
257
+ * @param request - The request {@link GetJobLimitsRequest}
258
+ * @returns A Promise of JobLimits
259
+ */
260
+ getJobLimits = (request = {}) => this.client.fetch(
261
+ {
262
+ method: "GET",
263
+ path: `/serverless-jobs/v1alpha2/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/job-limits`
264
+ },
265
+ unmarshalJobLimits
266
+ );
267
+ }
268
+ export {
269
+ API
270
+ };
@@ -0,0 +1,3 @@
1
+ import type { JobRunState } from './types.gen.js';
2
+ /** Lists transient statutes of the enum {@link JobRunState}. */
3
+ export declare const JOB_RUN_TRANSIENT_STATUSES: JobRunState[];
@@ -0,0 +1,10 @@
1
+ const JOB_RUN_TRANSIENT_STATUSES = [
2
+ "initialized",
3
+ "validated",
4
+ "queued",
5
+ "running",
6
+ "interrupting"
7
+ ];
8
+ export {
9
+ JOB_RUN_TRANSIENT_STATUSES
10
+ };
@@ -0,0 +1,5 @@
1
+ export { API } from './api.gen.js';
2
+ export * from './content.gen.js';
3
+ export * from './marshalling.gen.js';
4
+ export type { CreateJobDefinitionRequest, CreateJobDefinitionRequestCronScheduleConfig, CreateSecretsRequest, CreateSecretsRequestSecretConfig, CreateSecretsResponse, CronSchedule, DeleteJobDefinitionRequest, DeleteSecretRequest, GetJobDefinitionRequest, GetJobLimitsRequest, GetJobRunRequest, GetSecretRequest, JobDefinition, JobLimits, JobRun, JobRunReason, JobRunState, ListJobDefinitionsRequest, ListJobDefinitionsRequestOrderBy, ListJobDefinitionsResponse, ListJobResourcesRequest, ListJobResourcesResponse, ListJobRunsRequest, ListJobRunsRequestOrderBy, ListJobRunsResponse, ListSecretsRequest, ListSecretsResponse, Resource, Secret, SecretEnvVar, SecretFile, StartJobDefinitionRequest, StartJobDefinitionResponse, StopJobRunRequest, UpdateJobDefinitionRequest, UpdateJobDefinitionRequestCronScheduleConfig, UpdateSecretRequest, } from './types.gen.js';
5
+ export * as ValidationRules from './validation-rules.gen.js';
@@ -0,0 +1,24 @@
1
+ import { API } from "./api.gen.js";
2
+ import { JOB_RUN_TRANSIENT_STATUSES } from "./content.gen.js";
3
+ import { marshalCreateJobDefinitionRequest, marshalCreateSecretsRequest, marshalStartJobDefinitionRequest, marshalUpdateJobDefinitionRequest, marshalUpdateSecretRequest, unmarshalCreateSecretsResponse, unmarshalJobDefinition, unmarshalJobLimits, unmarshalJobRun, unmarshalListJobDefinitionsResponse, unmarshalListJobResourcesResponse, unmarshalListJobRunsResponse, unmarshalListSecretsResponse, unmarshalSecret, unmarshalStartJobDefinitionResponse } from "./marshalling.gen.js";
4
+ import * as validationRules_gen from "./validation-rules.gen.js";
5
+ export {
6
+ API,
7
+ JOB_RUN_TRANSIENT_STATUSES,
8
+ validationRules_gen as ValidationRules,
9
+ marshalCreateJobDefinitionRequest,
10
+ marshalCreateSecretsRequest,
11
+ marshalStartJobDefinitionRequest,
12
+ marshalUpdateJobDefinitionRequest,
13
+ marshalUpdateSecretRequest,
14
+ unmarshalCreateSecretsResponse,
15
+ unmarshalJobDefinition,
16
+ unmarshalJobLimits,
17
+ unmarshalJobRun,
18
+ unmarshalListJobDefinitionsResponse,
19
+ unmarshalListJobResourcesResponse,
20
+ unmarshalListJobRunsResponse,
21
+ unmarshalListSecretsResponse,
22
+ unmarshalSecret,
23
+ unmarshalStartJobDefinitionResponse
24
+ };
@@ -0,0 +1,17 @@
1
+ import type { DefaultValues } from '@scaleway/sdk-client';
2
+ import type { CreateJobDefinitionRequest, CreateSecretsRequest, CreateSecretsResponse, JobDefinition, JobLimits, JobRun, ListJobDefinitionsResponse, ListJobResourcesResponse, ListJobRunsResponse, ListSecretsResponse, Secret, StartJobDefinitionRequest, StartJobDefinitionResponse, UpdateJobDefinitionRequest, UpdateSecretRequest } from './types.gen.js';
3
+ export declare const unmarshalSecret: (data: unknown) => Secret;
4
+ export declare const unmarshalJobDefinition: (data: unknown) => JobDefinition;
5
+ export declare const unmarshalJobRun: (data: unknown) => JobRun;
6
+ export declare const unmarshalCreateSecretsResponse: (data: unknown) => CreateSecretsResponse;
7
+ export declare const unmarshalJobLimits: (data: unknown) => JobLimits;
8
+ export declare const unmarshalListJobDefinitionsResponse: (data: unknown) => ListJobDefinitionsResponse;
9
+ export declare const unmarshalListJobResourcesResponse: (data: unknown) => ListJobResourcesResponse;
10
+ export declare const unmarshalListJobRunsResponse: (data: unknown) => ListJobRunsResponse;
11
+ export declare const unmarshalListSecretsResponse: (data: unknown) => ListSecretsResponse;
12
+ export declare const unmarshalStartJobDefinitionResponse: (data: unknown) => StartJobDefinitionResponse;
13
+ export declare const marshalCreateJobDefinitionRequest: (request: CreateJobDefinitionRequest, defaults: DefaultValues) => Record<string, unknown>;
14
+ export declare const marshalCreateSecretsRequest: (request: CreateSecretsRequest, defaults: DefaultValues) => Record<string, unknown>;
15
+ export declare const marshalStartJobDefinitionRequest: (request: StartJobDefinitionRequest, defaults: DefaultValues) => Record<string, unknown>;
16
+ export declare const marshalUpdateJobDefinitionRequest: (request: UpdateJobDefinitionRequest, defaults: DefaultValues) => Record<string, unknown>;
17
+ export declare const marshalUpdateSecretRequest: (request: UpdateSecretRequest, defaults: DefaultValues) => Record<string, unknown>;