@scaleway/sdk-jobs 2.2.0 → 2.2.1

package/dist/index.gen.d.ts

@@ -3,3 +3,4 @@
  * PLEASE DO NOT EDIT HERE
  */
 export * as Jobsv1alpha1 from './v1alpha1/index.gen.js';
+export * as Jobsv1alpha2 from './v1alpha2/index.gen.js';

package/dist/index.gen.js

@@ -1,4 +1,6 @@
 import * as index_gen from "./v1alpha1/index.gen.js";
+import * as index_gen$1 from "./v1alpha2/index.gen.js";
 export {
-  index_gen as Jobsv1alpha1
+  index_gen as Jobsv1alpha1,
+  index_gen$1 as Jobsv1alpha2
 };

package/dist/v1alpha2/api.gen.d.ts

@@ -0,0 +1,133 @@
+import type { ApiLocality } from '@scaleway/sdk-client';
+import { API as ParentAPI } from '@scaleway/sdk-client';
+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';
+/**
+ * Serverless Jobs API.
+
+This API allows you to manage your Serverless Jobs.
+ */
+export declare class API extends ParentAPI {
+    /**
+     * Locality of this API.
+     * type ∈ {'zone','region','global','unspecified'}
+     */
+    static readonly LOCALITY: ApiLocality;
+    /**
+     * Create a new job definition in a specified Project.
+     *
+     * @param request - The request {@link CreateJobDefinitionRequest}
+     * @returns A Promise of JobDefinition
+     */
+    createJobDefinition: (request: Readonly<CreateJobDefinitionRequest>) => Promise<JobDefinition>;
+    /**
+     * Get a job definition by its unique identifier.
+     *
+     * @param request - The request {@link GetJobDefinitionRequest}
+     * @returns A Promise of JobDefinition
+     */
+    getJobDefinition: (request: Readonly<GetJobDefinitionRequest>) => Promise<JobDefinition>;
+    protected pageOfListJobDefinitions: (request?: Readonly<ListJobDefinitionsRequest>) => Promise<ListJobDefinitionsResponse>;
+    /**
+     * List all your job definitions with filters.
+     *
+     * @param request - The request {@link ListJobDefinitionsRequest}
+     * @returns A Promise of ListJobDefinitionsResponse
+     */
+    listJobDefinitions: (request?: Readonly<ListJobDefinitionsRequest>) => Promise<ListJobDefinitionsResponse> & {
+        all: () => Promise<JobDefinition[]>;
+        [Symbol.asyncIterator]: () => AsyncGenerator<JobDefinition[], void, void>;
+    };
+    /**
+     * Update an existing job definition associated with the specified unique identifier.
+     *
+     * @param request - The request {@link UpdateJobDefinitionRequest}
+     * @returns A Promise of JobDefinition
+     */
+    updateJobDefinition: (request: Readonly<UpdateJobDefinitionRequest>) => Promise<JobDefinition>;
+    /**
+     * Delete an existing job definition by its unique identifier.
+     *
+     * @param request - The request {@link DeleteJobDefinitionRequest}
+     */
+    deleteJobDefinition: (request: Readonly<DeleteJobDefinitionRequest>) => Promise<void>;
+    /**
+     * Run an existing job definition using its unique identifier and create a new job run.
+     *
+     * @param request - The request {@link StartJobDefinitionRequest}
+     * @returns A Promise of StartJobDefinitionResponse
+     */
+    startJobDefinition: (request: Readonly<StartJobDefinitionRequest>) => Promise<StartJobDefinitionResponse>;
+    /**
+     * Get a job run by its unique identifier.
+     *
+     * @param request - The request {@link GetJobRunRequest}
+     * @returns A Promise of JobRun
+     */
+    getJobRun: (request: Readonly<GetJobRunRequest>) => Promise<JobRun>;
+    protected pageOfListJobRuns: (request?: Readonly<ListJobRunsRequest>) => Promise<ListJobRunsResponse>;
+    /**
+     * List all job runs with filters.
+     *
+     * @param request - The request {@link ListJobRunsRequest}
+     * @returns A Promise of ListJobRunsResponse
+     */
+    listJobRuns: (request?: Readonly<ListJobRunsRequest>) => Promise<ListJobRunsResponse> & {
+        all: () => Promise<JobRun[]>;
+        [Symbol.asyncIterator]: () => AsyncGenerator<JobRun[], void, void>;
+    };
+    /**
+     * Stop a job run using its unique identifier.
+     *
+     * @param request - The request {@link StopJobRunRequest}
+     * @returns A Promise of JobRun
+     */
+    stopJobRun: (request: Readonly<StopJobRunRequest>) => Promise<JobRun>;
+    /**
+     * Create a secret reference within a job definition.
+     *
+     * @param request - The request {@link CreateSecretsRequest}
+     * @returns A Promise of CreateSecretsResponse
+     */
+    createSecrets: (request: Readonly<CreateSecretsRequest>) => Promise<CreateSecretsResponse>;
+    /**
+     * Get a secret references within a job definition.
+     *
+     * @param request - The request {@link GetSecretRequest}
+     * @returns A Promise of Secret
+     */
+    getSecret: (request: Readonly<GetSecretRequest>) => Promise<Secret>;
+    /**
+     * List secrets references within a job definition.
+     *
+     * @param request - The request {@link ListSecretsRequest}
+     * @returns A Promise of ListSecretsResponse
+     */
+    listSecrets: (request: Readonly<ListSecretsRequest>) => Promise<ListSecretsResponse>;
+    /**
+     * Update a secret reference within a job definition.
+     *
+     * @param request - The request {@link UpdateSecretRequest}
+     * @returns A Promise of Secret
+     */
+    updateSecret: (request: Readonly<UpdateSecretRequest>) => Promise<Secret>;
+    /**
+     * Delete a secret reference within a job definition.
+     *
+     * @param request - The request {@link DeleteSecretRequest}
+     */
+    deleteSecret: (request: Readonly<DeleteSecretRequest>) => Promise<void>;
+    /**
+     * List job resources for the console.
+     *
+     * @param request - The request {@link ListJobResourcesRequest}
+     * @returns A Promise of ListJobResourcesResponse
+     */
+    listJobResources: (request?: Readonly<ListJobResourcesRequest>) => Promise<ListJobResourcesResponse>;
+    /**
+     * Get job limits for the console.
+     *
+     * @param request - The request {@link GetJobLimitsRequest}
+     * @returns A Promise of JobLimits
+     */
+    getJobLimits: (request?: Readonly<GetJobLimitsRequest>) => Promise<JobLimits>;
+}

package/dist/v1alpha2/api.gen.js

@@ -0,0 +1,270 @@
+import { API as API$1, toApiLocality, validatePathParam, urlParams, enrichForPagination } from "@scaleway/sdk-client";
+import { marshalCreateJobDefinitionRequest, unmarshalJobDefinition, unmarshalListJobDefinitionsResponse, marshalUpdateJobDefinitionRequest, marshalStartJobDefinitionRequest, unmarshalStartJobDefinitionResponse, unmarshalJobRun, unmarshalListJobRunsResponse, marshalCreateSecretsRequest, unmarshalCreateSecretsResponse, unmarshalSecret, unmarshalListSecretsResponse, marshalUpdateSecretRequest, unmarshalListJobResourcesResponse, unmarshalJobLimits } from "./marshalling.gen.js";
+const jsonContentHeaders = {
+  "Content-Type": "application/json; charset=utf-8"
+};
+class API extends API$1 {
+  /**
+   * Locality of this API.
+   * type ∈ {'zone','region','global','unspecified'}
+   */
+  static LOCALITY = toApiLocality({
+    regions: ["fr-par", "nl-ams", "pl-waw"]
+  });
+  /**
+   * Create a new job definition in a specified Project.
+   *
+   * @param request - The request {@link CreateJobDefinitionRequest}
+   * @returns A Promise of JobDefinition
+   */
+  createJobDefinition = (request) => this.client.fetch(
+    {
+      body: JSON.stringify(
+        marshalCreateJobDefinitionRequest(request, this.client.settings)
+      ),
+      headers: jsonContentHeaders,
+      method: "POST",
+      path: `/serverless-jobs/v1alpha2/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/job-definitions`
+    },
+    unmarshalJobDefinition
+  );
+  /**
+   * Get a job definition by its unique identifier.
+   *
+   * @param request - The request {@link GetJobDefinitionRequest}
+   * @returns A Promise of JobDefinition
+   */
+  getJobDefinition = (request) => this.client.fetch(
+    {
+      method: "GET",
+      path: `/serverless-jobs/v1alpha2/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/job-definitions/${validatePathParam("jobDefinitionId", request.jobDefinitionId)}`
+    },
+    unmarshalJobDefinition
+  );
+  pageOfListJobDefinitions = (request = {}) => this.client.fetch(
+    {
+      method: "GET",
+      path: `/serverless-jobs/v1alpha2/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/job-definitions`,
+      urlParams: urlParams(
+        ["order_by", request.orderBy],
+        ["organization_id", request.organizationId],
+        ["page", request.page],
+        [
+          "page_size",
+          request.pageSize ?? this.client.settings.defaultPageSize
+        ],
+        ["project_id", request.projectId]
+      )
+    },
+    unmarshalListJobDefinitionsResponse
+  );
+  /**
+   * List all your job definitions with filters.
+   *
+   * @param request - The request {@link ListJobDefinitionsRequest}
+   * @returns A Promise of ListJobDefinitionsResponse
+   */
+  listJobDefinitions = (request = {}) => enrichForPagination(
+    "jobDefinitions",
+    this.pageOfListJobDefinitions,
+    request
+  );
+  /**
+   * Update an existing job definition associated with the specified unique identifier.
+   *
+   * @param request - The request {@link UpdateJobDefinitionRequest}
+   * @returns A Promise of JobDefinition
+   */
+  updateJobDefinition = (request) => this.client.fetch(
+    {
+      body: JSON.stringify(
+        marshalUpdateJobDefinitionRequest(request, this.client.settings)
+      ),
+      headers: jsonContentHeaders,
+      method: "PATCH",
+      path: `/serverless-jobs/v1alpha2/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/job-definitions/${validatePathParam("jobDefinitionId", request.jobDefinitionId)}`
+    },
+    unmarshalJobDefinition
+  );
+  /**
+   * Delete an existing job definition by its unique identifier.
+   *
+   * @param request - The request {@link DeleteJobDefinitionRequest}
+   */
+  deleteJobDefinition = (request) => this.client.fetch({
+    method: "DELETE",
+    path: `/serverless-jobs/v1alpha2/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/job-definitions/${validatePathParam("jobDefinitionId", request.jobDefinitionId)}`
+  });
+  /**
+   * Run an existing job definition using its unique identifier and create a new job run.
+   *
+   * @param request - The request {@link StartJobDefinitionRequest}
+   * @returns A Promise of StartJobDefinitionResponse
+   */
+  startJobDefinition = (request) => this.client.fetch(
+    {
+      body: JSON.stringify(
+        marshalStartJobDefinitionRequest(request, this.client.settings)
+      ),
+      headers: jsonContentHeaders,
+      method: "POST",
+      path: `/serverless-jobs/v1alpha2/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/job-definitions/${validatePathParam("jobDefinitionId", request.jobDefinitionId)}/start`
+    },
+    unmarshalStartJobDefinitionResponse
+  );
+  /**
+   * Get a job run by its unique identifier.
+   *
+   * @param request - The request {@link GetJobRunRequest}
+   * @returns A Promise of JobRun
+   */
+  getJobRun = (request) => this.client.fetch(
+    {
+      method: "GET",
+      path: `/serverless-jobs/v1alpha2/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/job-runs/${validatePathParam("jobRunId", request.jobRunId)}`
+    },
+    unmarshalJobRun
+  );
+  pageOfListJobRuns = (request = {}) => this.client.fetch(
+    {
+      method: "GET",
+      path: `/serverless-jobs/v1alpha2/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/job-runs`,
+      urlParams: urlParams(
+        ["job_definition_id", request.jobDefinitionId],
+        ["order_by", request.orderBy],
+        ["organization_id", request.organizationId],
+        ["page", request.page],
+        [
+          "page_size",
+          request.pageSize ?? this.client.settings.defaultPageSize
+        ],
+        ["project_id", request.projectId],
+        ["reasons", request.reasons],
+        ["state", request.state],
+        ["states", request.states]
+      )
+    },
+    unmarshalListJobRunsResponse
+  );
+  /**
+   * List all job runs with filters.
+   *
+   * @param request - The request {@link ListJobRunsRequest}
+   * @returns A Promise of ListJobRunsResponse
+   */
+  listJobRuns = (request = {}) => enrichForPagination("jobRuns", this.pageOfListJobRuns, request);
+  /**
+   * Stop a job run using its unique identifier.
+   *
+   * @param request - The request {@link StopJobRunRequest}
+   * @returns A Promise of JobRun
+   */
+  stopJobRun = (request) => this.client.fetch(
+    {
+      body: "{}",
+      headers: jsonContentHeaders,
+      method: "POST",
+      path: `/serverless-jobs/v1alpha2/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/job-runs/${validatePathParam("jobRunId", request.jobRunId)}/stop`
+    },
+    unmarshalJobRun
+  );
+  /**
+   * Create a secret reference within a job definition.
+   *
+   * @param request - The request {@link CreateSecretsRequest}
+   * @returns A Promise of CreateSecretsResponse
+   */
+  createSecrets = (request) => this.client.fetch(
+    {
+      body: JSON.stringify(
+        marshalCreateSecretsRequest(request, this.client.settings)
+      ),
+      headers: jsonContentHeaders,
+      method: "POST",
+      path: `/serverless-jobs/v1alpha2/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/secrets`
+    },
+    unmarshalCreateSecretsResponse
+  );
+  /**
+   * Get a secret references within a job definition.
+   *
+   * @param request - The request {@link GetSecretRequest}
+   * @returns A Promise of Secret
+   */
+  getSecret = (request) => this.client.fetch(
+    {
+      method: "GET",
+      path: `/serverless-jobs/v1alpha2/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/secrets/${validatePathParam("secretId", request.secretId)}`
+    },
+    unmarshalSecret
+  );
+  /**
+   * List secrets references within a job definition.
+   *
+   * @param request - The request {@link ListSecretsRequest}
+   * @returns A Promise of ListSecretsResponse
+   */
+  listSecrets = (request) => this.client.fetch(
+    {
+      method: "GET",
+      path: `/serverless-jobs/v1alpha2/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/secrets`,
+      urlParams: urlParams(["job_definition_id", request.jobDefinitionId])
+    },
+    unmarshalListSecretsResponse
+  );
+  /**
+   * Update a secret reference within a job definition.
+   *
+   * @param request - The request {@link UpdateSecretRequest}
+   * @returns A Promise of Secret
+   */
+  updateSecret = (request) => this.client.fetch(
+    {
+      body: JSON.stringify(
+        marshalUpdateSecretRequest(request, this.client.settings)
+      ),
+      headers: jsonContentHeaders,
+      method: "PATCH",
+      path: `/serverless-jobs/v1alpha2/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/secrets/${validatePathParam("secretId", request.secretId)}`
+    },
+    unmarshalSecret
+  );
+  /**
+   * Delete a secret reference within a job definition.
+   *
+   * @param request - The request {@link DeleteSecretRequest}
+   */
+  deleteSecret = (request) => this.client.fetch({
+    method: "DELETE",
+    path: `/serverless-jobs/v1alpha2/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/secrets/${validatePathParam("secretId", request.secretId)}`
+  });
+  /**
+   * List job resources for the console.
+   *
+   * @param request - The request {@link ListJobResourcesRequest}
+   * @returns A Promise of ListJobResourcesResponse
+   */
+  listJobResources = (request = {}) => this.client.fetch(
+    {
+      method: "GET",
+      path: `/serverless-jobs/v1alpha2/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/job-resources`
+    },
+    unmarshalListJobResourcesResponse
+  );
+  /**
+   * Get job limits for the console.
+   *
+   * @param request - The request {@link GetJobLimitsRequest}
+   * @returns A Promise of JobLimits
+   */
+  getJobLimits = (request = {}) => this.client.fetch(
+    {
+      method: "GET",
+      path: `/serverless-jobs/v1alpha2/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/job-limits`
+    },
+    unmarshalJobLimits
+  );
+}
+export {
+  API
+};

package/dist/v1alpha2/content.gen.d.ts

@@ -0,0 +1,3 @@
+import type { JobRunState } from './types.gen.js';
+/** Lists transient statutes of the enum {@link JobRunState}. */
+export declare const JOB_RUN_TRANSIENT_STATUSES: JobRunState[];

package/dist/v1alpha2/content.gen.js

@@ -0,0 +1,10 @@
+const JOB_RUN_TRANSIENT_STATUSES = [
+  "initialized",
+  "validated",
+  "queued",
+  "running",
+  "interrupting"
+];
+export {
+  JOB_RUN_TRANSIENT_STATUSES
+};

package/dist/v1alpha2/index.gen.d.ts

@@ -0,0 +1,5 @@
+export { API } from './api.gen.js';
+export * from './content.gen.js';
+export * from './marshalling.gen.js';
+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';
+export * as ValidationRules from './validation-rules.gen.js';

package/dist/v1alpha2/index.gen.js

@@ -0,0 +1,24 @@
+import { API } from "./api.gen.js";
+import { JOB_RUN_TRANSIENT_STATUSES } from "./content.gen.js";
+import { marshalCreateJobDefinitionRequest, marshalCreateSecretsRequest, marshalStartJobDefinitionRequest, marshalUpdateJobDefinitionRequest, marshalUpdateSecretRequest, unmarshalCreateSecretsResponse, unmarshalJobDefinition, unmarshalJobLimits, unmarshalJobRun, unmarshalListJobDefinitionsResponse, unmarshalListJobResourcesResponse, unmarshalListJobRunsResponse, unmarshalListSecretsResponse, unmarshalSecret, unmarshalStartJobDefinitionResponse } from "./marshalling.gen.js";
+import * as validationRules_gen from "./validation-rules.gen.js";
+export {
+  API,
+  JOB_RUN_TRANSIENT_STATUSES,
+  validationRules_gen as ValidationRules,
+  marshalCreateJobDefinitionRequest,
+  marshalCreateSecretsRequest,
+  marshalStartJobDefinitionRequest,
+  marshalUpdateJobDefinitionRequest,
+  marshalUpdateSecretRequest,
+  unmarshalCreateSecretsResponse,
+  unmarshalJobDefinition,
+  unmarshalJobLimits,
+  unmarshalJobRun,
+  unmarshalListJobDefinitionsResponse,
+  unmarshalListJobResourcesResponse,
+  unmarshalListJobRunsResponse,
+  unmarshalListSecretsResponse,
+  unmarshalSecret,
+  unmarshalStartJobDefinitionResponse
+};

package/dist/v1alpha2/marshalling.gen.d.ts

@@ -0,0 +1,17 @@
+import type { DefaultValues } from '@scaleway/sdk-client';
+import type { CreateJobDefinitionRequest, CreateSecretsRequest, CreateSecretsResponse, JobDefinition, JobLimits, JobRun, ListJobDefinitionsResponse, ListJobResourcesResponse, ListJobRunsResponse, ListSecretsResponse, Secret, StartJobDefinitionRequest, StartJobDefinitionResponse, UpdateJobDefinitionRequest, UpdateSecretRequest } from './types.gen.js';
+export declare const unmarshalSecret: (data: unknown) => Secret;
+export declare const unmarshalJobDefinition: (data: unknown) => JobDefinition;
+export declare const unmarshalJobRun: (data: unknown) => JobRun;
+export declare const unmarshalCreateSecretsResponse: (data: unknown) => CreateSecretsResponse;
+export declare const unmarshalJobLimits: (data: unknown) => JobLimits;
+export declare const unmarshalListJobDefinitionsResponse: (data: unknown) => ListJobDefinitionsResponse;
+export declare const unmarshalListJobResourcesResponse: (data: unknown) => ListJobResourcesResponse;
+export declare const unmarshalListJobRunsResponse: (data: unknown) => ListJobRunsResponse;
+export declare const unmarshalListSecretsResponse: (data: unknown) => ListSecretsResponse;
+export declare const unmarshalStartJobDefinitionResponse: (data: unknown) => StartJobDefinitionResponse;
+export declare const marshalCreateJobDefinitionRequest: (request: CreateJobDefinitionRequest, defaults: DefaultValues) => Record<string, unknown>;
+export declare const marshalCreateSecretsRequest: (request: CreateSecretsRequest, defaults: DefaultValues) => Record<string, unknown>;
+export declare const marshalStartJobDefinitionRequest: (request: StartJobDefinitionRequest, defaults: DefaultValues) => Record<string, unknown>;
+export declare const marshalUpdateJobDefinitionRequest: (request: UpdateJobDefinitionRequest, defaults: DefaultValues) => Record<string, unknown>;
+export declare const marshalUpdateSecretRequest: (request: UpdateSecretRequest, defaults: DefaultValues) => Record<string, unknown>;