@scaleway/sdk-jobs 1.2.0 → 2.1.1

package/README.md

@@ -0,0 +1,96 @@
+# @scaleway/sdk-jobs
+
+[![npm version](https://img.shields.io/npm/v/@scaleway/sdk-jobs.svg)](https://www.npmjs.com/package/@scaleway/sdk-jobs)
+[![npm downloads](https://img.shields.io/npm/dm/@scaleway/sdk-jobs.svg)](https://www.npmjs.com/package/@scaleway/sdk-jobs)
+[![license](https://img.shields.io/npm/l/@scaleway/sdk-jobs.svg)](https://github.com/scaleway/scaleway-sdk-js/blob/master/LICENSE)
+
+Scaleway SDK for Jobs API.
+
+> **Note**  
+> This is an automatically generated package that is part of the [Scaleway SDK for JavaScript](https://github.com/scaleway/scaleway-sdk-js).
+
+## Installation
+
+```bash
+npm install @scaleway/sdk-jobs @scaleway/sdk-client
+```
+
+or with pnpm:
+
+```bash
+pnpm add @scaleway/sdk-jobs @scaleway/sdk-client
+```
+
+or with yarn:
+
+```bash
+yarn add @scaleway/sdk-jobs @scaleway/sdk-client
+```
+
+## Getting Started
+
+You'll need a pair of access and secret keys to connect to Scaleway API. Please check the [documentation](https://www.scaleway.com/en/docs/identity-and-access-management/iam/how-to/create-api-keys/) on how to retrieve them.
+
+### Basic Usage
+
+```typescript
+import { createClient } from '@scaleway/sdk-client'
+import { Jobs } from '@scaleway/sdk-jobs'
+
+const client = createClient({
+  accessKey: 'SCWXXXXXXXXXXXXXXXXX',
+  secretKey: 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx',
+  defaultProjectId: 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx',
+  defaultRegion: 'fr-par',
+  defaultZone: 'fr-par-1',
+})
+
+const api = new Jobs.v1.API(client)
+
+// Use the API
+// Example: await api.listServers()
+```
+
+### Using Configuration Loader
+
+For a simpler setup, you can load credentials from the configuration file or environment variables:
+
+```typescript
+import { createClient } from '@scaleway/sdk-client'
+import { loadProfileFromConfigurationFile } from '@scaleway/configuration-loader'
+import { Jobs } from '@scaleway/sdk-jobs'
+
+const profile = loadProfileFromConfigurationFile()
+const client = createClient(profile)
+const api = new Jobs.v1.API(client)
+```
+
+## Documentation
+
+- 📚 [Scaleway SDK Reference Documentation](https://scaleway.github.io/scaleway-sdk-js)
+- 🌐 [Scaleway Jobs API Documentation](https://www.scaleway.com/en/developers/api/jobs/)
+- 📖 [Main Repository](https://github.com/scaleway/scaleway-sdk-js)
+- 💡 [Example Projects](https://github.com/scaleway/scaleway-sdk-js/tree/master/examples)
+
+## Features
+
+- ✅ Full TypeScript support with complete type definitions
+- ✅ Promise-based API
+- ✅ Automatic pagination helpers
+- ✅ Built-in error handling
+- ✅ Compatible with Node.js ≥ 20
+
+## Support
+
+We love feedback! Feel free to reach us on:
+- [Scaleway Slack community](https://slack.scaleway.com/) - Join us on [#opensource](https://scaleway-community.slack.com/app_redirect?channel=opensource)
+- [GitHub Issues](https://github.com/scaleway/scaleway-sdk-js/issues)
+
+## Contributing
+
+This repository is at its early stage and is still in active development. If you are looking for a way to contribute, please read [CONTRIBUTING.md](https://github.com/scaleway/scaleway-sdk-js/blob/master/CONTRIBUTING.md).
+
+## License
+
+This project is Apache 2.0 licensed. See the [LICENSE](https://github.com/scaleway/scaleway-sdk-js/blob/master/LICENSE) file for details.
+

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

@@ -1,5 +1,5 @@
-import { API as ParentAPI } from '@scaleway/sdk-client';
 import type { ApiLocality } from '@scaleway/sdk-client';
+import { API as ParentAPI } from '@scaleway/sdk-client';
 import type { CreateJobDefinitionRequest, CreateJobDefinitionSecretsRequest, CreateJobDefinitionSecretsResponse, DeleteJobDefinitionRequest, DeleteJobDefinitionSecretRequest, GetJobDefinitionRequest, GetJobDefinitionSecretRequest, GetJobRunRequest, GetJobsLimitsRequest, JobDefinition, JobRun, JobsLimits, ListJobDefinitionSecretsRequest, ListJobDefinitionSecretsResponse, ListJobDefinitionsRequest, ListJobDefinitionsResponse, ListJobRunsRequest, ListJobRunsResponse, ListJobsResourcesRequest, ListJobsResourcesResponse, Secret, StartJobDefinitionRequest, StartJobDefinitionResponse, StopJobRunRequest, UpdateJobDefinitionRequest, UpdateJobDefinitionSecretRequest } from './types.gen.js';
 /**
  * Serverless Jobs API.
@@ -45,7 +45,7 @@ export declare class API extends ParentAPI {
      */
     updateJobDefinition: (request: Readonly<UpdateJobDefinitionRequest>) => Promise<JobDefinition>;
     /**
-     * Delete an exsisting job definition by its unique identifier.
+     * Delete an existing job definition by its unique identifier.
      *
      * @param request - The request {@link DeleteJobDefinitionRequest}
      */

package/dist/v1alpha1/api.gen.js

@@ -9,7 +9,11 @@ class API extends API$1 {
    * type ∈ {'zone','region','global','unspecified'}
    */
   static LOCALITY = toApiLocality({
-    regions: ["fr-par", "nl-ams", "pl-waw"]
+    regions: [
+      "fr-par",
+      "nl-ams",
+      "pl-waw"
+    ]
   });
   /**
    * Create a new job definition in a specified Project.
@@ -49,10 +53,7 @@ class API extends API$1 {
         ["order_by", request.orderBy],
         ["organization_id", request.organizationId],
         ["page", request.page],
-        [
-          "page_size",
-          request.pageSize ?? this.client.settings.defaultPageSize
-        ],
+        ["page_size", request.pageSize ?? this.client.settings.defaultPageSize],
         ["project_id", request.projectId]
       )
     },
@@ -64,11 +65,7 @@ class API extends API$1 {
    * @param request - The request {@link ListJobDefinitionsRequest}
    * @returns A Promise of ListJobDefinitionsResponse
    */
-  listJobDefinitions = (request = {}) => enrichForPagination(
-    "jobDefinitions",
-    this.pageOfListJobDefinitions,
-    request
-  );
+  listJobDefinitions = (request = {}) => enrichForPagination("jobDefinitions", this.pageOfListJobDefinitions, request);
   /**
    * Update an existing job definition associated with the specified unique identifier.
    *
@@ -87,14 +84,16 @@ class API extends API$1 {
     unmarshalJobDefinition
   );
   /**
-   * Delete an exsisting job definition by its unique identifier.
+   * 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/v1alpha1/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/job-definitions/${validatePathParam("jobDefinitionId", request.jobDefinitionId)}`
-  });
+  deleteJobDefinition = (request) => this.client.fetch(
+    {
+      method: "DELETE",
+      path: `/serverless-jobs/v1alpha1/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/job-definitions/${validatePathParam("jobDefinitionId", request.jobDefinitionId)}`
+    }
+  );
   /**
    * Run an existing job definition by its unique identifier. This will create a new job run.
    *
@@ -121,10 +120,7 @@ class API extends API$1 {
   createJobDefinitionSecrets = (request) => this.client.fetch(
     {
       body: JSON.stringify(
-        marshalCreateJobDefinitionSecretsRequest(
-          request,
-          this.client.settings
-        )
+        marshalCreateJobDefinitionSecretsRequest(request, this.client.settings)
       ),
       headers: jsonContentHeaders,
       method: "POST",
@@ -167,10 +163,7 @@ class API extends API$1 {
   updateJobDefinitionSecret = (request) => this.client.fetch(
     {
       body: JSON.stringify(
-        marshalUpdateJobDefinitionSecretRequest(
-          request,
-          this.client.settings
-        )
+        marshalUpdateJobDefinitionSecretRequest(request, this.client.settings)
       ),
       headers: jsonContentHeaders,
       method: "PATCH",
@@ -183,10 +176,12 @@ class API extends API$1 {
    *
    * @param request - The request {@link DeleteJobDefinitionSecretRequest}
    */
-  deleteJobDefinitionSecret = (request) => this.client.fetch({
-    method: "DELETE",
-    path: `/serverless-jobs/v1alpha1/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/job-definitions/${validatePathParam("jobDefinitionId", request.jobDefinitionId)}/secrets/${validatePathParam("secretId", request.secretId)}`
-  });
+  deleteJobDefinitionSecret = (request) => this.client.fetch(
+    {
+      method: "DELETE",
+      path: `/serverless-jobs/v1alpha1/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/job-definitions/${validatePathParam("jobDefinitionId", request.jobDefinitionId)}/secrets/${validatePathParam("secretId", request.secretId)}`
+    }
+  );
   /**
    * Get a job run by its unique identifier.
    *
@@ -224,10 +219,7 @@ class API extends API$1 {
         ["order_by", request.orderBy],
         ["organization_id", request.organizationId],
         ["page", request.page],
-        [
-          "page_size",
-          request.pageSize ?? this.client.settings.defaultPageSize
-        ],
+        ["page_size", request.pageSize ?? this.client.settings.defaultPageSize],
         ["project_id", request.projectId],
         ["state", request.state],
         ["states", request.states]

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

@@ -1,4 +1,4 @@
-export { API } from './api.gen.js';
+export { API, } from './api.gen.js';
 export * from './content.gen.js';
 export * from './marshalling.gen.js';
 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';

package/dist/v1alpha1/marshalling.gen.js

@@ -132,10 +132,7 @@ const unmarshalListJobDefinitionsResponse = (data) => {
     );
   }
   return {
-    jobDefinitions: unmarshalArrayOfObject(
-      data.job_definitions,
-      unmarshalJobDefinition
-    ),
+    jobDefinitions: unmarshalArrayOfObject(data.job_definitions, unmarshalJobDefinition),
     totalCount: data.total_count
   };
 };
@@ -188,9 +185,7 @@ const marshalCreateJobDefinitionRequestCronScheduleConfig = (request, defaults)
 const marshalCreateJobDefinitionRequest = (request, defaults) => ({
   command: request.command,
   cpu_limit: request.cpuLimit,
-  cron_schedule: request.cronSchedule !== void 0 ? marshalCreateJobDefinitionRequestCronScheduleConfig(
-    request.cronSchedule
-  ) : void 0,
+  cron_schedule: request.cronSchedule !== void 0 ? marshalCreateJobDefinitionRequestCronScheduleConfig(request.cronSchedule) : void 0,
   description: request.description,
   environment_variables: request.environmentVariables !== void 0 ? request.environmentVariables : void 0,
   image_uri: request.imageUri,
@@ -204,14 +199,18 @@ const marshalCreateJobDefinitionSecretsRequestSecretConfig = (request, defaults)
   secret_manager_id: request.secretManagerId,
   secret_manager_version: request.secretManagerVersion,
   ...resolveOneOf([
-    { param: "path", value: request.path },
-    { param: "env_var_name", value: request.envVarName }
+    {
+      param: "path",
+      value: request.path
+    },
+    {
+      param: "env_var_name",
+      value: request.envVarName
+    }
   ])
 });
 const marshalCreateJobDefinitionSecretsRequest = (request, defaults) => ({
-  secrets: request.secrets.map(
-    (elt) => marshalCreateJobDefinitionSecretsRequestSecretConfig(elt)
-  )
+  secrets: request.secrets.map((elt) => marshalCreateJobDefinitionSecretsRequestSecretConfig(elt))
 });
 const marshalStartJobDefinitionRequest = (request, defaults) => ({
   command: request.command,
@@ -225,9 +224,7 @@ const marshalUpdateJobDefinitionRequestCronScheduleConfig = (request, defaults)
 const marshalUpdateJobDefinitionRequest = (request, defaults) => ({
   command: request.command,
   cpu_limit: request.cpuLimit,
-  cron_schedule: request.cronSchedule !== void 0 ? marshalUpdateJobDefinitionRequestCronScheduleConfig(
-    request.cronSchedule
-  ) : void 0,
+  cron_schedule: request.cronSchedule !== void 0 ? marshalUpdateJobDefinitionRequestCronScheduleConfig(request.cronSchedule) : void 0,
   description: request.description,
   environment_variables: request.environmentVariables,
   image_uri: request.imageUri,
@@ -239,8 +236,14 @@ const marshalUpdateJobDefinitionRequest = (request, defaults) => ({
 const marshalUpdateJobDefinitionSecretRequest = (request, defaults) => ({
   secret_manager_version: request.secretManagerVersion,
   ...resolveOneOf([
-    { param: "path", value: request.path },
-    { param: "env_var_name", value: request.envVarName }
+    {
+      param: "path",
+      value: request.path
+    },
+    {
+      param: "env_var_name",
+      value: request.envVarName
+    }
   ])
 });
 export {

package/package.json

@@ -1,23 +1,20 @@
 {
   "name": "@scaleway/sdk-jobs",
-  "version": "1.2.0",
+  "version": "2.1.1",
   "description": "Scaleway SDK jobs",
   "license": "Apache-2.0",
   "files": [
+    "README.md",
     "dist"
   ],
   "type": "module",
   "exports": {
     ".": {
       "types": "./dist/index.gen.d.ts",
-      "import": "./dist/index.gen.js",
-      "require": "./dist/index.gen.cjs",
       "default": "./dist/index.gen.js"
     },
     "./*": {
       "types": "./dist/*/index.gen.d.ts",
-      "import": "./dist/*/index.gen.js",
-      "require": "./dist/*/index.gen.cjs",
       "default": "./dist/*/index.gen.js"
     }
   },
@@ -26,17 +23,17 @@
     "directory": "packages_generated/jobs"
   },
   "engines": {
-    "node": ">=20.19.4"
+    "node": ">=20.19.6"
   },
   "dependencies": {
     "@scaleway/random-name": "5.1.2",
-    "@scaleway/sdk-std": "1.1.0"
+    "@scaleway/sdk-std": "2.1.0"
   },
   "peerDependencies": {
-    "@scaleway/sdk-client": "^1.3.2"
+    "@scaleway/sdk-client": "^2.1.0"
   },
   "devDependencies": {
-    "@scaleway/sdk-client": "^1.3.2"
+    "@scaleway/sdk-client": "^2.1.0"
   },
   "scripts": {
     "package:check": "pnpm publint",

package/dist/index.gen.cjs

@@ -1,4 +0,0 @@
-"use strict";
-Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-const index_gen = require("./v1alpha1/index.gen.cjs");
-exports.Jobsv1alpha1 = index_gen;

package/dist/v1alpha1/api.gen.cjs

@@ -1,274 +0,0 @@
-"use strict";
-Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-const sdkClient = require("@scaleway/sdk-client");
-const marshalling_gen = require("./marshalling.gen.cjs");
-const jsonContentHeaders = {
-  "Content-Type": "application/json; charset=utf-8"
-};
-class API extends sdkClient.API {
-  /**
-   * Locality of this API.
-   * type ∈ {'zone','region','global','unspecified'}
-   */
-  static LOCALITY = sdkClient.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(
-        marshalling_gen.marshalCreateJobDefinitionRequest(request, this.client.settings)
-      ),
-      headers: jsonContentHeaders,
-      method: "POST",
-      path: `/serverless-jobs/v1alpha1/regions/${sdkClient.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/job-definitions`
-    },
-    marshalling_gen.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/v1alpha1/regions/${sdkClient.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/job-definitions/${sdkClient.validatePathParam("jobDefinitionId", request.jobDefinitionId)}`
-    },
-    marshalling_gen.unmarshalJobDefinition
-  );
-  pageOfListJobDefinitions = (request = {}) => this.client.fetch(
-    {
-      method: "GET",
-      path: `/serverless-jobs/v1alpha1/regions/${sdkClient.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/job-definitions`,
-      urlParams: sdkClient.urlParams(
-        ["order_by", request.orderBy],
-        ["organization_id", request.organizationId],
-        ["page", request.page],
-        [
-          "page_size",
-          request.pageSize ?? this.client.settings.defaultPageSize
-        ],
-        ["project_id", request.projectId]
-      )
-    },
-    marshalling_gen.unmarshalListJobDefinitionsResponse
-  );
-  /**
-   * List all your job definitions with filters.
-   *
-   * @param request - The request {@link ListJobDefinitionsRequest}
-   * @returns A Promise of ListJobDefinitionsResponse
-   */
-  listJobDefinitions = (request = {}) => sdkClient.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(
-        marshalling_gen.marshalUpdateJobDefinitionRequest(request, this.client.settings)
-      ),
-      headers: jsonContentHeaders,
-      method: "PATCH",
-      path: `/serverless-jobs/v1alpha1/regions/${sdkClient.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/job-definitions/${sdkClient.validatePathParam("jobDefinitionId", request.jobDefinitionId)}`
-    },
-    marshalling_gen.unmarshalJobDefinition
-  );
-  /**
-   * Delete an exsisting job definition by its unique identifier.
-   *
-   * @param request - The request {@link DeleteJobDefinitionRequest}
-   */
-  deleteJobDefinition = (request) => this.client.fetch({
-    method: "DELETE",
-    path: `/serverless-jobs/v1alpha1/regions/${sdkClient.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/job-definitions/${sdkClient.validatePathParam("jobDefinitionId", request.jobDefinitionId)}`
-  });
-  /**
-   * Run an existing job definition by its unique identifier. This will create a new job run.
-   *
-   * @param request - The request {@link StartJobDefinitionRequest}
-   * @returns A Promise of StartJobDefinitionResponse
-   */
-  startJobDefinition = (request) => this.client.fetch(
-    {
-      body: JSON.stringify(
-        marshalling_gen.marshalStartJobDefinitionRequest(request, this.client.settings)
-      ),
-      headers: jsonContentHeaders,
-      method: "POST",
-      path: `/serverless-jobs/v1alpha1/regions/${sdkClient.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/job-definitions/${sdkClient.validatePathParam("jobDefinitionId", request.jobDefinitionId)}/start`
-    },
-    marshalling_gen.unmarshalStartJobDefinitionResponse
-  );
-  /**
-   * Create a secret reference within a job definition.
-   *
-   * @param request - The request {@link CreateJobDefinitionSecretsRequest}
-   * @returns A Promise of CreateJobDefinitionSecretsResponse
-   */
-  createJobDefinitionSecrets = (request) => this.client.fetch(
-    {
-      body: JSON.stringify(
-        marshalling_gen.marshalCreateJobDefinitionSecretsRequest(
-          request,
-          this.client.settings
-        )
-      ),
-      headers: jsonContentHeaders,
-      method: "POST",
-      path: `/serverless-jobs/v1alpha1/regions/${sdkClient.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/job-definitions/${sdkClient.validatePathParam("jobDefinitionId", request.jobDefinitionId)}/secrets`
-    },
-    marshalling_gen.unmarshalCreateJobDefinitionSecretsResponse
-  );
-  /**
-   * Get a secret references within a job definition.
-   *
-   * @param request - The request {@link GetJobDefinitionSecretRequest}
-   * @returns A Promise of Secret
-   */
-  getJobDefinitionSecret = (request) => this.client.fetch(
-    {
-      method: "GET",
-      path: `/serverless-jobs/v1alpha1/regions/${sdkClient.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/job-definitions/${sdkClient.validatePathParam("jobDefinitionId", request.jobDefinitionId)}/secrets/${sdkClient.validatePathParam("secretId", request.secretId)}`
-    },
-    marshalling_gen.unmarshalSecret
-  );
-  /**
-   * List secrets references within a job definition.
-   *
-   * @param request - The request {@link ListJobDefinitionSecretsRequest}
-   * @returns A Promise of ListJobDefinitionSecretsResponse
-   */
-  listJobDefinitionSecrets = (request) => this.client.fetch(
-    {
-      method: "GET",
-      path: `/serverless-jobs/v1alpha1/regions/${sdkClient.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/job-definitions/${sdkClient.validatePathParam("jobDefinitionId", request.jobDefinitionId)}/secrets`
-    },
-    marshalling_gen.unmarshalListJobDefinitionSecretsResponse
-  );
-  /**
-   * Update a secret reference within a job definition.
-   *
-   * @param request - The request {@link UpdateJobDefinitionSecretRequest}
-   * @returns A Promise of Secret
-   */
-  updateJobDefinitionSecret = (request) => this.client.fetch(
-    {
-      body: JSON.stringify(
-        marshalling_gen.marshalUpdateJobDefinitionSecretRequest(
-          request,
-          this.client.settings
-        )
-      ),
-      headers: jsonContentHeaders,
-      method: "PATCH",
-      path: `/serverless-jobs/v1alpha1/regions/${sdkClient.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/job-definitions/${sdkClient.validatePathParam("jobDefinitionId", request.jobDefinitionId)}/secrets/${sdkClient.validatePathParam("secretId", request.secretId)}`
-    },
-    marshalling_gen.unmarshalSecret
-  );
-  /**
-   * Delete a secret reference within a job definition.
-   *
-   * @param request - The request {@link DeleteJobDefinitionSecretRequest}
-   */
-  deleteJobDefinitionSecret = (request) => this.client.fetch({
-    method: "DELETE",
-    path: `/serverless-jobs/v1alpha1/regions/${sdkClient.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/job-definitions/${sdkClient.validatePathParam("jobDefinitionId", request.jobDefinitionId)}/secrets/${sdkClient.validatePathParam("secretId", request.secretId)}`
-  });
-  /**
-   * 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/v1alpha1/regions/${sdkClient.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/job-runs/${sdkClient.validatePathParam("jobRunId", request.jobRunId)}`
-    },
-    marshalling_gen.unmarshalJobRun
-  );
-  /**
-   * Stop a job run by 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/v1alpha1/regions/${sdkClient.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/job-runs/${sdkClient.validatePathParam("jobRunId", request.jobRunId)}/stop`
-    },
-    marshalling_gen.unmarshalJobRun
-  );
-  pageOfListJobRuns = (request = {}) => this.client.fetch(
-    {
-      method: "GET",
-      path: `/serverless-jobs/v1alpha1/regions/${sdkClient.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/job-runs`,
-      urlParams: sdkClient.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],
-        ["state", request.state],
-        ["states", request.states]
-      )
-    },
-    marshalling_gen.unmarshalListJobRunsResponse
-  );
-  /**
-   * List all job runs with filters.
-   *
-   * @param request - The request {@link ListJobRunsRequest}
-   * @returns A Promise of ListJobRunsResponse
-   */
-  listJobRuns = (request = {}) => sdkClient.enrichForPagination("jobRuns", this.pageOfListJobRuns, request);
-  /**
-   * List jobs resources for the console.
-   *
-   * @param request - The request {@link ListJobsResourcesRequest}
-   * @returns A Promise of ListJobsResourcesResponse
-   */
-  listJobsResources = (request = {}) => this.client.fetch(
-    {
-      method: "GET",
-      path: `/serverless-jobs/v1alpha1/regions/${sdkClient.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/jobs-resources`
-    },
-    marshalling_gen.unmarshalListJobsResourcesResponse
-  );
-  /**
-   * Get jobs limits for the console.
-   *
-   * @param request - The request {@link GetJobsLimitsRequest}
-   * @returns A Promise of JobsLimits
-   */
-  getJobsLimits = (request = {}) => this.client.fetch(
-    {
-      method: "GET",
-      path: `/serverless-jobs/v1alpha1/regions/${sdkClient.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/jobs-limits`
-    },
-    marshalling_gen.unmarshalJobsLimits
-  );
-}
-exports.API = API;

package/dist/v1alpha1/content.gen.cjs

@@ -1,8 +0,0 @@
-"use strict";
-Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-const JOB_RUN_TRANSIENT_STATUSES = [
-  "queued",
-  "scheduled",
-  "running"
-];
-exports.JOB_RUN_TRANSIENT_STATUSES = JOB_RUN_TRANSIENT_STATUSES;

package/dist/v1alpha1/index.gen.cjs

@@ -1,24 +0,0 @@
-"use strict";
-Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-const api_gen = require("./api.gen.cjs");
-const content_gen = require("./content.gen.cjs");
-const marshalling_gen = require("./marshalling.gen.cjs");
-const validationRules_gen = require("./validation-rules.gen.cjs");
-exports.API = api_gen.API;
-exports.JOB_RUN_TRANSIENT_STATUSES = content_gen.JOB_RUN_TRANSIENT_STATUSES;
-exports.marshalCreateJobDefinitionRequest = marshalling_gen.marshalCreateJobDefinitionRequest;
-exports.marshalCreateJobDefinitionSecretsRequest = marshalling_gen.marshalCreateJobDefinitionSecretsRequest;
-exports.marshalStartJobDefinitionRequest = marshalling_gen.marshalStartJobDefinitionRequest;
-exports.marshalUpdateJobDefinitionRequest = marshalling_gen.marshalUpdateJobDefinitionRequest;
-exports.marshalUpdateJobDefinitionSecretRequest = marshalling_gen.marshalUpdateJobDefinitionSecretRequest;
-exports.unmarshalCreateJobDefinitionSecretsResponse = marshalling_gen.unmarshalCreateJobDefinitionSecretsResponse;
-exports.unmarshalJobDefinition = marshalling_gen.unmarshalJobDefinition;
-exports.unmarshalJobRun = marshalling_gen.unmarshalJobRun;
-exports.unmarshalJobsLimits = marshalling_gen.unmarshalJobsLimits;
-exports.unmarshalListJobDefinitionSecretsResponse = marshalling_gen.unmarshalListJobDefinitionSecretsResponse;
-exports.unmarshalListJobDefinitionsResponse = marshalling_gen.unmarshalListJobDefinitionsResponse;
-exports.unmarshalListJobRunsResponse = marshalling_gen.unmarshalListJobRunsResponse;
-exports.unmarshalListJobsResourcesResponse = marshalling_gen.unmarshalListJobsResourcesResponse;
-exports.unmarshalSecret = marshalling_gen.unmarshalSecret;
-exports.unmarshalStartJobDefinitionResponse = marshalling_gen.unmarshalStartJobDefinitionResponse;
-exports.ValidationRules = validationRules_gen;

package/dist/v1alpha1/marshalling.gen.cjs

@@ -1,262 +0,0 @@
-"use strict";
-Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-const randomName = require("@scaleway/random-name");
-const sdkClient = require("@scaleway/sdk-client");
-const unmarshalSecretEnvVar = (data) => {
-  if (!sdkClient.isJSONObject(data)) {
-    throw new TypeError(
-      `Unmarshalling the type 'SecretEnvVar' failed as data isn't a dictionary.`
-    );
-  }
-  return {
-    name: data.name
-  };
-};
-const unmarshalSecretFile = (data) => {
-  if (!sdkClient.isJSONObject(data)) {
-    throw new TypeError(
-      `Unmarshalling the type 'SecretFile' failed as data isn't a dictionary.`
-    );
-  }
-  return {
-    path: data.path
-  };
-};
-const unmarshalSecret = (data) => {
-  if (!sdkClient.isJSONObject(data)) {
-    throw new TypeError(
-      `Unmarshalling the type 'Secret' failed as data isn't a dictionary.`
-    );
-  }
-  return {
-    envVar: data.env_var ? unmarshalSecretEnvVar(data.env_var) : void 0,
-    file: data.file ? unmarshalSecretFile(data.file) : void 0,
-    secretId: data.secret_id,
-    secretManagerId: data.secret_manager_id,
-    secretManagerVersion: data.secret_manager_version
-  };
-};
-const unmarshalCronSchedule = (data) => {
-  if (!sdkClient.isJSONObject(data)) {
-    throw new TypeError(
-      `Unmarshalling the type 'CronSchedule' failed as data isn't a dictionary.`
-    );
-  }
-  return {
-    schedule: data.schedule,
-    timezone: data.timezone
-  };
-};
-const unmarshalJobDefinition = (data) => {
-  if (!sdkClient.isJSONObject(data)) {
-    throw new TypeError(
-      `Unmarshalling the type 'JobDefinition' failed as data isn't a dictionary.`
-    );
-  }
-  return {
-    command: data.command,
-    cpuLimit: data.cpu_limit,
-    createdAt: sdkClient.unmarshalDate(data.created_at),
-    cronSchedule: data.cron_schedule ? unmarshalCronSchedule(data.cron_schedule) : void 0,
-    description: data.description,
-    environmentVariables: data.environment_variables,
-    id: data.id,
-    imageUri: data.image_uri,
-    jobTimeout: data.job_timeout,
-    localStorageCapacity: data.local_storage_capacity,
-    memoryLimit: data.memory_limit,
-    name: data.name,
-    projectId: data.project_id,
-    region: data.region,
-    updatedAt: sdkClient.unmarshalDate(data.updated_at)
-  };
-};
-const unmarshalJobRun = (data) => {
-  if (!sdkClient.isJSONObject(data)) {
-    throw new TypeError(
-      `Unmarshalling the type 'JobRun' failed as data isn't a dictionary.`
-    );
-  }
-  return {
-    command: data.command,
-    cpuLimit: data.cpu_limit,
-    createdAt: sdkClient.unmarshalDate(data.created_at),
-    environmentVariables: data.environment_variables,
-    errorMessage: data.error_message,
-    exitCode: data.exit_code,
-    id: data.id,
-    jobDefinitionId: data.job_definition_id,
-    localStorageCapacity: data.local_storage_capacity,
-    memoryLimit: data.memory_limit,
-    region: data.region,
-    runDuration: data.run_duration,
-    startedAt: sdkClient.unmarshalDate(data.started_at),
-    state: data.state,
-    terminatedAt: sdkClient.unmarshalDate(data.terminated_at),
-    updatedAt: sdkClient.unmarshalDate(data.updated_at)
-  };
-};
-const unmarshalCreateJobDefinitionSecretsResponse = (data) => {
-  if (!sdkClient.isJSONObject(data)) {
-    throw new TypeError(
-      `Unmarshalling the type 'CreateJobDefinitionSecretsResponse' failed as data isn't a dictionary.`
-    );
-  }
-  return {
-    secrets: sdkClient.unmarshalArrayOfObject(data.secrets, unmarshalSecret)
-  };
-};
-const unmarshalJobsLimits = (data) => {
-  if (!sdkClient.isJSONObject(data)) {
-    throw new TypeError(
-      `Unmarshalling the type 'JobsLimits' failed as data isn't a dictionary.`
-    );
-  }
-  return {
-    secretsPerJobDefinition: data.secrets_per_job_definition
-  };
-};
-const unmarshalListJobDefinitionSecretsResponse = (data) => {
-  if (!sdkClient.isJSONObject(data)) {
-    throw new TypeError(
-      `Unmarshalling the type 'ListJobDefinitionSecretsResponse' failed as data isn't a dictionary.`
-    );
-  }
-  return {
-    secrets: sdkClient.unmarshalArrayOfObject(data.secrets, unmarshalSecret),
-    totalCount: data.total_count
-  };
-};
-const unmarshalListJobDefinitionsResponse = (data) => {
-  if (!sdkClient.isJSONObject(data)) {
-    throw new TypeError(
-      `Unmarshalling the type 'ListJobDefinitionsResponse' failed as data isn't a dictionary.`
-    );
-  }
-  return {
-    jobDefinitions: sdkClient.unmarshalArrayOfObject(
-      data.job_definitions,
-      unmarshalJobDefinition
-    ),
-    totalCount: data.total_count
-  };
-};
-const unmarshalListJobRunsResponse = (data) => {
-  if (!sdkClient.isJSONObject(data)) {
-    throw new TypeError(
-      `Unmarshalling the type 'ListJobRunsResponse' failed as data isn't a dictionary.`
-    );
-  }
-  return {
-    jobRuns: sdkClient.unmarshalArrayOfObject(data.job_runs, unmarshalJobRun),
-    totalCount: data.total_count
-  };
-};
-const unmarshalResource = (data) => {
-  if (!sdkClient.isJSONObject(data)) {
-    throw new TypeError(
-      `Unmarshalling the type 'Resource' failed as data isn't a dictionary.`
-    );
-  }
-  return {
-    cpuLimit: data.cpu_limit,
-    memoryLimit: data.memory_limit
-  };
-};
-const unmarshalListJobsResourcesResponse = (data) => {
-  if (!sdkClient.isJSONObject(data)) {
-    throw new TypeError(
-      `Unmarshalling the type 'ListJobsResourcesResponse' failed as data isn't a dictionary.`
-    );
-  }
-  return {
-    resources: sdkClient.unmarshalArrayOfObject(data.resources, unmarshalResource)
-  };
-};
-const unmarshalStartJobDefinitionResponse = (data) => {
-  if (!sdkClient.isJSONObject(data)) {
-    throw new TypeError(
-      `Unmarshalling the type 'StartJobDefinitionResponse' failed as data isn't a dictionary.`
-    );
-  }
-  return {
-    jobRuns: sdkClient.unmarshalArrayOfObject(data.job_runs, unmarshalJobRun)
-  };
-};
-const marshalCreateJobDefinitionRequestCronScheduleConfig = (request, defaults) => ({
-  schedule: request.schedule,
-  timezone: request.timezone
-});
-const marshalCreateJobDefinitionRequest = (request, defaults) => ({
-  command: request.command,
-  cpu_limit: request.cpuLimit,
-  cron_schedule: request.cronSchedule !== void 0 ? marshalCreateJobDefinitionRequestCronScheduleConfig(
-    request.cronSchedule
-  ) : void 0,
-  description: request.description,
-  environment_variables: request.environmentVariables !== void 0 ? request.environmentVariables : void 0,
-  image_uri: request.imageUri,
-  job_timeout: request.jobTimeout,
-  local_storage_capacity: request.localStorageCapacity,
-  memory_limit: request.memoryLimit,
-  name: request.name || randomName("job"),
-  project_id: request.projectId ?? defaults.defaultProjectId
-});
-const marshalCreateJobDefinitionSecretsRequestSecretConfig = (request, defaults) => ({
-  secret_manager_id: request.secretManagerId,
-  secret_manager_version: request.secretManagerVersion,
-  ...sdkClient.resolveOneOf([
-    { param: "path", value: request.path },
-    { param: "env_var_name", value: request.envVarName }
-  ])
-});
-const marshalCreateJobDefinitionSecretsRequest = (request, defaults) => ({
-  secrets: request.secrets.map(
-    (elt) => marshalCreateJobDefinitionSecretsRequestSecretConfig(elt)
-  )
-});
-const marshalStartJobDefinitionRequest = (request, defaults) => ({
-  command: request.command,
-  environment_variables: request.environmentVariables,
-  replicas: request.replicas
-});
-const marshalUpdateJobDefinitionRequestCronScheduleConfig = (request, defaults) => ({
-  schedule: request.schedule,
-  timezone: request.timezone
-});
-const marshalUpdateJobDefinitionRequest = (request, defaults) => ({
-  command: request.command,
-  cpu_limit: request.cpuLimit,
-  cron_schedule: request.cronSchedule !== void 0 ? marshalUpdateJobDefinitionRequestCronScheduleConfig(
-    request.cronSchedule
-  ) : void 0,
-  description: request.description,
-  environment_variables: request.environmentVariables,
-  image_uri: request.imageUri,
-  job_timeout: request.jobTimeout,
-  local_storage_capacity: request.localStorageCapacity,
-  memory_limit: request.memoryLimit,
-  name: request.name
-});
-const marshalUpdateJobDefinitionSecretRequest = (request, defaults) => ({
-  secret_manager_version: request.secretManagerVersion,
-  ...sdkClient.resolveOneOf([
-    { param: "path", value: request.path },
-    { param: "env_var_name", value: request.envVarName }
-  ])
-});
-exports.marshalCreateJobDefinitionRequest = marshalCreateJobDefinitionRequest;
-exports.marshalCreateJobDefinitionSecretsRequest = marshalCreateJobDefinitionSecretsRequest;
-exports.marshalStartJobDefinitionRequest = marshalStartJobDefinitionRequest;
-exports.marshalUpdateJobDefinitionRequest = marshalUpdateJobDefinitionRequest;
-exports.marshalUpdateJobDefinitionSecretRequest = marshalUpdateJobDefinitionSecretRequest;
-exports.unmarshalCreateJobDefinitionSecretsResponse = unmarshalCreateJobDefinitionSecretsResponse;
-exports.unmarshalJobDefinition = unmarshalJobDefinition;
-exports.unmarshalJobRun = unmarshalJobRun;
-exports.unmarshalJobsLimits = unmarshalJobsLimits;
-exports.unmarshalListJobDefinitionSecretsResponse = unmarshalListJobDefinitionSecretsResponse;
-exports.unmarshalListJobDefinitionsResponse = unmarshalListJobDefinitionsResponse;
-exports.unmarshalListJobRunsResponse = unmarshalListJobRunsResponse;
-exports.unmarshalListJobsResourcesResponse = unmarshalListJobsResourcesResponse;
-exports.unmarshalSecret = unmarshalSecret;
-exports.unmarshalStartJobDefinitionResponse = unmarshalStartJobDefinitionResponse;

package/dist/v1alpha1/validation-rules.gen.cjs

@@ -1,115 +0,0 @@
-"use strict";
-Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-const CreateJobDefinitionRequest = {
-  cpuLimit: {
-    greaterThan: 0
-  },
-  description: {
-    maxLength: 255
-  },
-  imageUri: {
-    pattern: /^((?:(?:(?:[a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9-]*[a-zA-Z0-9])(?:\.(?:[a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9-]*[a-zA-Z0-9]))*|\[(?:[a-fA-F0-9:]+)\])(?::[0-9]+)?\/)?[a-z0-9]+(?:(?:[._]|__|[-]+)[a-z0-9]+)*(?:\/[a-z0-9]+(?:(?:[._]|__|[-]+)[a-z0-9]+)*)*)(?::(\w[A-Za-z0-9_.-]{0,127}))?(?:@([A-Za-z][A-Za-z0-9]*(?:[-_+.][A-Za-z][A-Za-z0-9]*)*[:][[:xdigit:]]{32,}))?$/
-  },
-  localStorageCapacity: {
-    greaterThan: 0
-  },
-  memoryLimit: {
-    greaterThan: 0
-  },
-  name: {
-    pattern: /^[A-Za-z0-9-_]{3,50}$/
-  }
-};
-const CreateJobDefinitionRequestCronScheduleConfig = {
-  schedule: {
-    maxLength: 255,
-    minLength: 1
-  },
-  timezone: {
-    maxLength: 255,
-    minLength: 1
-  }
-};
-const CreateJobDefinitionSecretsRequestSecretConfig = {
-  secretManagerVersion: {
-    minLength: 1
-  }
-};
-const CronSchedule = {
-  schedule: {
-    maxLength: 255,
-    minLength: 1
-  },
-  timezone: {
-    maxLength: 255,
-    minLength: 1
-  }
-};
-const ListJobDefinitionsRequest = {
-  page: {
-    greaterThanOrEqual: 1
-  },
-  pageSize: {
-    greaterThanOrEqual: 1,
-    lessThanOrEqual: 1e3
-  }
-};
-const ListJobRunsRequest = {
-  page: {
-    greaterThanOrEqual: 1
-  },
-  pageSize: {
-    greaterThanOrEqual: 1,
-    lessThanOrEqual: 1e3
-  }
-};
-const StartJobDefinitionRequest = {
-  replicas: {
-    greaterThan: 0
-  }
-};
-const UpdateJobDefinitionRequest = {
-  cpuLimit: {
-    greaterThan: 0
-  },
-  description: {
-    maxLength: 255
-  },
-  imageUri: {
-    pattern: /^((?:(?:(?:[a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9-]*[a-zA-Z0-9])(?:\.(?:[a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9-]*[a-zA-Z0-9]))*|\[(?:[a-fA-F0-9:]+)\])(?::[0-9]+)?\/)?[a-z0-9]+(?:(?:[._]|__|[-]+)[a-z0-9]+)*(?:\/[a-z0-9]+(?:(?:[._]|__|[-]+)[a-z0-9]+)*)*)(?::(\w[A-Za-z0-9_.-]{0,127}))?(?:@([A-Za-z][A-Za-z0-9]*(?:[-_+.][A-Za-z][A-Za-z0-9]*)*[:][[:xdigit:]]{32,}))?$/
-  },
-  localStorageCapacity: {
-    greaterThan: 0
-  },
-  memoryLimit: {
-    greaterThan: 0
-  },
-  name: {
-    pattern: /^[A-Za-z0-9-_]{3,50}$/
-  }
-};
-const UpdateJobDefinitionRequestCronScheduleConfig = {
-  schedule: {
-    maxLength: 255,
-    minLength: 1
-  },
-  timezone: {
-    maxLength: 255,
-    minLength: 1
-  }
-};
-const UpdateJobDefinitionSecretRequest = {
-  secretManagerVersion: {
-    minLength: 1
-  }
-};
-exports.CreateJobDefinitionRequest = CreateJobDefinitionRequest;
-exports.CreateJobDefinitionRequestCronScheduleConfig = CreateJobDefinitionRequestCronScheduleConfig;
-exports.CreateJobDefinitionSecretsRequestSecretConfig = CreateJobDefinitionSecretsRequestSecretConfig;
-exports.CronSchedule = CronSchedule;
-exports.ListJobDefinitionsRequest = ListJobDefinitionsRequest;
-exports.ListJobRunsRequest = ListJobRunsRequest;
-exports.StartJobDefinitionRequest = StartJobDefinitionRequest;
-exports.UpdateJobDefinitionRequest = UpdateJobDefinitionRequest;
-exports.UpdateJobDefinitionRequestCronScheduleConfig = UpdateJobDefinitionRequestCronScheduleConfig;
-exports.UpdateJobDefinitionSecretRequest = UpdateJobDefinitionSecretRequest;