@scaleway/sdk 2.46.0 → 2.47.0

package/dist/api/qaas/v1alpha1/api.gen.js

@@ -0,0 +1,527 @@
+import { waitForResource } from "../../../internal/async/interval-retrier.js";
+import { API as API$1 } from "../../../scw/api.js";
+import { validatePathParam, urlParams, resolveOneOf } from "../../../helpers/marshalling.js";
+import "../../../vendor/base64/index.js";
+import { enrichForPagination } from "../../../scw/fetch/resource-paginator.js";
+import { JOB_TRANSIENT_STATUSES, SESSION_TRANSIENT_STATUSES, PROCESS_TRANSIENT_STATUSES } from "./content.gen.js";
+import { unmarshalJob, unmarshalListJobsResponse, unmarshalListJobResultsResponse, marshalCreateJobRequest, marshalUpdateJobRequest, unmarshalJobCircuit, unmarshalPlatform, unmarshalListPlatformsResponse, unmarshalSession, unmarshalListSessionsResponse, marshalCreateSessionRequest, marshalUpdateSessionRequest, unmarshalListSessionACLsResponse, marshalCreateProcessRequest, unmarshalProcess, unmarshalListProcessesResponse, marshalUpdateProcessRequest, unmarshalListProcessResultsResponse, unmarshalApplication, unmarshalListApplicationsResponse } from "./marshalling.gen.js";
+const jsonContentHeaders = {
+  "Content-Type": "application/json; charset=utf-8"
+};
+class API extends API$1 {
+  /**
+   * Get job information. Retrieve information about the provided **job ID**,
+   * such as status, payload, and result.
+   *
+   * @param request - The request {@link GetJobRequest}
+   * @returns A Promise of Job
+   */
+  getJob = (request) => this.client.fetch(
+    {
+      method: "GET",
+      path: `/qaas/v1alpha1/jobs/${validatePathParam("jobId", request.jobId)}`
+    },
+    unmarshalJob
+  );
+  /**
+   * Waits for {@link Job} to be in a final state.
+   *
+   * @param request - The request {@link GetJobRequest}
+   * @param options - The waiting options
+   * @returns A Promise of Job
+   */
+  waitForJob = (request, options) => waitForResource(
+    options?.stop ?? ((res) => Promise.resolve(!JOB_TRANSIENT_STATUSES.includes(res.status))),
+    this.getJob,
+    request,
+    options
+  );
+  pageOfListJobs = (request = {}) => this.client.fetch(
+    {
+      method: "GET",
+      path: `/qaas/v1alpha1/jobs`,
+      urlParams: urlParams(
+        ["order_by", request.orderBy],
+        ["page", request.page],
+        [
+          "page_size",
+          request.pageSize ?? this.client.settings.defaultPageSize
+        ],
+        ["tags", request.tags],
+        ...Object.entries(
+          resolveOneOf([
+            { param: "session_id", value: request.sessionId },
+            {
+              default: this.client.settings.defaultProjectId,
+              param: "project_id",
+              value: request.projectId
+            }
+          ])
+        )
+      )
+    },
+    unmarshalListJobsResponse
+  );
+  /**
+   * List all jobs within a project or session. Retrieve information about all
+   * jobs within a given project or session.
+   *
+   * @param request - The request {@link ListJobsRequest}
+   * @returns A Promise of ListJobsResponse
+   */
+  listJobs = (request = {}) => enrichForPagination("jobs", this.pageOfListJobs, request);
+  pageOfListJobResults = (request) => this.client.fetch(
+    {
+      method: "GET",
+      path: `/qaas/v1alpha1/jobs/${validatePathParam("jobId", request.jobId)}/results`,
+      urlParams: urlParams(
+        ["order_by", request.orderBy],
+        ["page", request.page],
+        [
+          "page_size",
+          request.pageSize ?? this.client.settings.defaultPageSize
+        ]
+      )
+    },
+    unmarshalListJobResultsResponse
+  );
+  /**
+   * List all results of a job. Retrieve all intermediate and final results of a
+   * job.
+   *
+   * @param request - The request {@link ListJobResultsRequest}
+   * @returns A Promise of ListJobResultsResponse
+   */
+  listJobResults = (request) => enrichForPagination("jobResults", this.pageOfListJobResults, request);
+  /**
+   * Create a job. Create a job to be executed inside a session.
+   *
+   * @param request - The request {@link CreateJobRequest}
+   * @returns A Promise of Job
+   */
+  createJob = (request) => this.client.fetch(
+    {
+      body: JSON.stringify(
+        marshalCreateJobRequest(request, this.client.settings)
+      ),
+      headers: jsonContentHeaders,
+      method: "POST",
+      path: `/qaas/v1alpha1/jobs`
+    },
+    unmarshalJob
+  );
+  /**
+   * Update job information. Update job information about the provided **job
+   * ID**.
+   *
+   * @param request - The request {@link UpdateJobRequest}
+   * @returns A Promise of Job
+   */
+  updateJob = (request) => this.client.fetch(
+    {
+      body: JSON.stringify(
+        marshalUpdateJobRequest(request, this.client.settings)
+      ),
+      headers: jsonContentHeaders,
+      method: "PATCH",
+      path: `/qaas/v1alpha1/jobs/${validatePathParam("jobId", request.jobId)}`
+    },
+    unmarshalJob
+  );
+  /**
+   * Cancel a job. Cancel the job corresponding to the provided **job ID**.
+   *
+   * @param request - The request {@link CancelJobRequest}
+   * @returns A Promise of Job
+   */
+  cancelJob = (request) => this.client.fetch(
+    {
+      body: "{}",
+      headers: jsonContentHeaders,
+      method: "POST",
+      path: `/qaas/v1alpha1/jobs/${validatePathParam("jobId", request.jobId)}/cancel`
+    },
+    unmarshalJob
+  );
+  /**
+   * Delete a job. Delete the job corresponding to the provided **job ID**.
+   *
+   * @param request - The request {@link DeleteJobRequest}
+   */
+  deleteJob = (request) => this.client.fetch({
+    method: "DELETE",
+    path: `/qaas/v1alpha1/jobs/${validatePathParam("jobId", request.jobId)}`
+  });
+  /**
+   * Get a job circuit. Retrieve the circuit of the provided **job ID**.
+   *
+   * @param request - The request {@link GetJobCircuitRequest}
+   * @returns A Promise of JobCircuit
+   */
+  getJobCircuit = (request) => this.client.fetch(
+    {
+      method: "GET",
+      path: `/qaas/v1alpha1/jobs/${validatePathParam("jobId", request.jobId)}/circuit`
+    },
+    unmarshalJobCircuit
+  );
+  /**
+   * Get platform information. Retrieve information about the provided
+   * **platform ID**, such as provider name, technology, and type.
+   *
+   * @param request - The request {@link GetPlatformRequest}
+   * @returns A Promise of Platform
+   */
+  getPlatform = (request) => this.client.fetch(
+    {
+      method: "GET",
+      path: `/qaas/v1alpha1/platforms/${validatePathParam("platformId", request.platformId)}`
+    },
+    unmarshalPlatform
+  );
+  pageOfListPlatforms = (request = {}) => this.client.fetch(
+    {
+      method: "GET",
+      path: `/qaas/v1alpha1/platforms`,
+      urlParams: urlParams(
+        ["backend_name", request.backendName],
+        ["name", request.name],
+        ["order_by", request.orderBy],
+        ["page", request.page],
+        [
+          "page_size",
+          request.pageSize ?? this.client.settings.defaultPageSize
+        ],
+        ["platform_technology", request.platformTechnology],
+        ["platform_type", request.platformType],
+        ["provider_name", request.providerName]
+      )
+    },
+    unmarshalListPlatformsResponse
+  );
+  /**
+   * List all available platforms. Retrieve information about all platforms.
+   *
+   * @param request - The request {@link ListPlatformsRequest}
+   * @returns A Promise of ListPlatformsResponse
+   */
+  listPlatforms = (request = {}) => enrichForPagination("platforms", this.pageOfListPlatforms, request);
+  /**
+   * Get session infrormation. Retrieve information about the provided **session
+   * ID**, such as name, status, and number of executed jobs.
+   *
+   * @param request - The request {@link GetSessionRequest}
+   * @returns A Promise of Session
+   */
+  getSession = (request) => this.client.fetch(
+    {
+      method: "GET",
+      path: `/qaas/v1alpha1/sessions/${validatePathParam("sessionId", request.sessionId)}`
+    },
+    unmarshalSession
+  );
+  /**
+   * Waits for {@link Session} to be in a final state.
+   *
+   * @param request - The request {@link GetSessionRequest}
+   * @param options - The waiting options
+   * @returns A Promise of Session
+   */
+  waitForSession = (request, options) => waitForResource(
+    options?.stop ?? ((res) => Promise.resolve(!SESSION_TRANSIENT_STATUSES.includes(res.status))),
+    this.getSession,
+    request,
+    options
+  );
+  pageOfListSessions = (request = {}) => this.client.fetch(
+    {
+      method: "GET",
+      path: `/qaas/v1alpha1/sessions`,
+      urlParams: urlParams(
+        ["order_by", request.orderBy],
+        ["page", request.page],
+        [
+          "page_size",
+          request.pageSize ?? this.client.settings.defaultPageSize
+        ],
+        ["platform_id", request.platformId],
+        [
+          "project_id",
+          request.projectId ?? this.client.settings.defaultProjectId
+        ],
+        ["tags", request.tags]
+      )
+    },
+    unmarshalListSessionsResponse
+  );
+  /**
+   * List all sessions. Retrieve information about all sessions.
+   *
+   * @param request - The request {@link ListSessionsRequest}
+   * @returns A Promise of ListSessionsResponse
+   */
+  listSessions = (request = {}) => enrichForPagination("sessions", this.pageOfListSessions, request);
+  /**
+   * Create a session. Create a dedicated session for the specified platform.
+   *
+   * @param request - The request {@link CreateSessionRequest}
+   * @returns A Promise of Session
+   */
+  createSession = (request) => this.client.fetch(
+    {
+      body: JSON.stringify(
+        marshalCreateSessionRequest(request, this.client.settings)
+      ),
+      headers: jsonContentHeaders,
+      method: "POST",
+      path: `/qaas/v1alpha1/sessions`
+    },
+    unmarshalSession
+  );
+  /**
+   * Update session information. Update session information of the provided
+   * **session ID**.
+   *
+   * @param request - The request {@link UpdateSessionRequest}
+   * @returns A Promise of Session
+   */
+  updateSession = (request) => this.client.fetch(
+    {
+      body: JSON.stringify(
+        marshalUpdateSessionRequest(request, this.client.settings)
+      ),
+      headers: jsonContentHeaders,
+      method: "PATCH",
+      path: `/qaas/v1alpha1/sessions/${validatePathParam("sessionId", request.sessionId)}`
+    },
+    unmarshalSession
+  );
+  /**
+   * Terminate an existing session. Terminate a session by its unique ID and
+   * cancel all its attached jobs.
+   *
+   * @param request - The request {@link TerminateSessionRequest}
+   * @returns A Promise of Session
+   */
+  terminateSession = (request) => this.client.fetch(
+    {
+      body: "{}",
+      headers: jsonContentHeaders,
+      method: "POST",
+      path: `/qaas/v1alpha1/sessions/${validatePathParam("sessionId", request.sessionId)}/terminate`
+    },
+    unmarshalSession
+  );
+  /**
+   * Delete an existing session. Delete a session by its unique ID and delete
+   * all its attached jobs.
+   *
+   * @param request - The request {@link DeleteSessionRequest}
+   */
+  deleteSession = (request) => this.client.fetch({
+    method: "DELETE",
+    path: `/qaas/v1alpha1/sessions/${validatePathParam("sessionId", request.sessionId)}`
+  });
+  pageOfListSessionACLs = (request) => this.client.fetch(
+    {
+      method: "GET",
+      path: `/qaas/v1alpha1/sessions/${validatePathParam("sessionId", request.sessionId)}/acls`,
+      urlParams: urlParams(
+        ["order_by", request.orderBy],
+        ["page", request.page],
+        [
+          "page_size",
+          request.pageSize ?? this.client.settings.defaultPageSize
+        ]
+      )
+    },
+    unmarshalListSessionACLsResponse
+  );
+  listSessionACLs = (request) => enrichForPagination("acls", this.pageOfListSessionACLs, request);
+  /**
+   * Create a process. Create a new process for the specified application on a
+   * specified platform.
+   *
+   * @param request - The request {@link CreateProcessRequest}
+   * @returns A Promise of Process
+   */
+  createProcess = (request) => this.client.fetch(
+    {
+      body: JSON.stringify(
+        marshalCreateProcessRequest(request, this.client.settings)
+      ),
+      headers: jsonContentHeaders,
+      method: "POST",
+      path: `/qaas/v1alpha1/processes`
+    },
+    unmarshalProcess
+  );
+  /**
+   * Get process infrormation. Retrieve information about the provided **process
+   * ID**, such as name, status and progress.
+   *
+   * @param request - The request {@link GetProcessRequest}
+   * @returns A Promise of Process
+   */
+  getProcess = (request) => this.client.fetch(
+    {
+      method: "GET",
+      path: `/qaas/v1alpha1/processes/${validatePathParam("processId", request.processId)}`
+    },
+    unmarshalProcess
+  );
+  /**
+   * Waits for {@link Process} to be in a final state.
+   *
+   * @param request - The request {@link GetProcessRequest}
+   * @param options - The waiting options
+   * @returns A Promise of Process
+   */
+  waitForProcess = (request, options) => waitForResource(
+    options?.stop ?? ((res) => Promise.resolve(!PROCESS_TRANSIENT_STATUSES.includes(res.status))),
+    this.getProcess,
+    request,
+    options
+  );
+  pageOfListProcesses = (request = {}) => this.client.fetch(
+    {
+      method: "GET",
+      path: `/qaas/v1alpha1/processes`,
+      urlParams: urlParams(
+        ["application_id", request.applicationId],
+        ["order_by", request.orderBy],
+        ["page", request.page],
+        [
+          "page_size",
+          request.pageSize ?? this.client.settings.defaultPageSize
+        ],
+        [
+          "project_id",
+          request.projectId ?? this.client.settings.defaultProjectId
+        ],
+        ["tags", request.tags]
+      )
+    },
+    unmarshalListProcessesResponse
+  );
+  /**
+   * List all processes. Retrieve information about all processes.
+   *
+   * @param request - The request {@link ListProcessesRequest}
+   * @returns A Promise of ListProcessesResponse
+   */
+  listProcesses = (request = {}) => enrichForPagination("processes", this.pageOfListProcesses, request);
+  /**
+   * Update process information. Update process information of the provided
+   * **process ID**.
+   *
+   * @param request - The request {@link UpdateProcessRequest}
+   * @returns A Promise of Process
+   */
+  updateProcess = (request) => this.client.fetch(
+    {
+      body: JSON.stringify(
+        marshalUpdateProcessRequest(request, this.client.settings)
+      ),
+      headers: jsonContentHeaders,
+      method: "PATCH",
+      path: `/qaas/v1alpha1/processes/${validatePathParam("processId", request.processId)}`
+    },
+    unmarshalProcess
+  );
+  /**
+   * Cancel a running process. Cancel a process by its unique ID. Intermediate
+   * results are still available.
+   *
+   * @param request - The request {@link CancelProcessRequest}
+   * @returns A Promise of Process
+   */
+  cancelProcess = (request) => this.client.fetch(
+    {
+      body: "{}",
+      headers: jsonContentHeaders,
+      method: "POST",
+      path: `/qaas/v1alpha1/processes/${validatePathParam("processId", request.processId)}/cancel`
+    },
+    unmarshalProcess
+  );
+  /**
+   * Delete an existing process. Delete a process by its unique ID and delete
+   * all its data.
+   *
+   * @param request - The request {@link DeleteProcessRequest}
+   */
+  deleteProcess = (request) => this.client.fetch({
+    method: "DELETE",
+    path: `/qaas/v1alpha1/processes/${validatePathParam("processId", request.processId)}`
+  });
+  pageOfListProcessResults = (request) => this.client.fetch(
+    {
+      method: "GET",
+      path: `/qaas/v1alpha1/processes/${validatePathParam("processId", request.processId)}/results`,
+      urlParams: urlParams(
+        ["order_by", request.orderBy],
+        ["page", request.page],
+        [
+          "page_size",
+          request.pageSize ?? this.client.settings.defaultPageSize
+        ]
+      )
+    },
+    unmarshalListProcessResultsResponse
+  );
+  /**
+   * List all results of a process. Retrieve all intermediate and final result
+   * of a process.
+   *
+   * @param request - The request {@link ListProcessResultsRequest}
+   * @returns A Promise of ListProcessResultsResponse
+   */
+  listProcessResults = (request) => enrichForPagination(
+    "processResults",
+    this.pageOfListProcessResults,
+    request
+  );
+  /**
+   * Get application information. Retrieve information about the provided
+   * **applcation ID**, such as name, type and compatible platforms.
+   *
+   * @param request - The request {@link GetApplicationRequest}
+   * @returns A Promise of Application
+   */
+  getApplication = (request) => this.client.fetch(
+    {
+      method: "GET",
+      path: `/qaas/v1alpha1/applications/${validatePathParam("applicationId", request.applicationId)}`
+    },
+    unmarshalApplication
+  );
+  pageOfListApplications = (request = {}) => this.client.fetch(
+    {
+      method: "GET",
+      path: `/qaas/v1alpha1/applications`,
+      urlParams: urlParams(
+        ["application_type", request.applicationType],
+        ["name", request.name],
+        ["order_by", request.orderBy],
+        ["page", request.page],
+        [
+          "page_size",
+          request.pageSize ?? this.client.settings.defaultPageSize
+        ]
+      )
+    },
+    unmarshalListApplicationsResponse
+  );
+  /**
+   * List all available applications. Retrieve information about all
+   * applications.
+   *
+   * @param request - The request {@link ListApplicationsRequest}
+   * @returns A Promise of ListApplicationsResponse
+   */
+  listApplications = (request = {}) => enrichForPagination("applications", this.pageOfListApplications, request);
+}
+export {
+  API
+};

package/dist/api/qaas/v1alpha1/content.gen.cjs

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const JOB_TRANSIENT_STATUSES = [
+  "waiting",
+  "running",
+  "cancelling"
+];
+const PROCESS_TRANSIENT_STATUSES = [
+  "starting",
+  "running",
+  "cancelling"
+];
+const SESSION_TRANSIENT_STATUSES = [
+  "starting",
+  "stopping"
+];
+exports.JOB_TRANSIENT_STATUSES = JOB_TRANSIENT_STATUSES;
+exports.PROCESS_TRANSIENT_STATUSES = PROCESS_TRANSIENT_STATUSES;
+exports.SESSION_TRANSIENT_STATUSES = SESSION_TRANSIENT_STATUSES;

package/dist/api/qaas/v1alpha1/content.gen.js

@@ -0,0 +1,19 @@
+const JOB_TRANSIENT_STATUSES = [
+  "waiting",
+  "running",
+  "cancelling"
+];
+const PROCESS_TRANSIENT_STATUSES = [
+  "starting",
+  "running",
+  "cancelling"
+];
+const SESSION_TRANSIENT_STATUSES = [
+  "starting",
+  "stopping"
+];
+export {
+  JOB_TRANSIENT_STATUSES,
+  PROCESS_TRANSIENT_STATUSES,
+  SESSION_TRANSIENT_STATUSES
+};

package/dist/api/qaas/v1alpha1/index.gen.cjs

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const api_gen = require("./api.gen.cjs");
+const content_gen = require("./content.gen.cjs");
+const validationRules_gen = require("./validation-rules.gen.cjs");
+exports.API = api_gen.API;
+exports.JOB_TRANSIENT_STATUSES = content_gen.JOB_TRANSIENT_STATUSES;
+exports.PROCESS_TRANSIENT_STATUSES = content_gen.PROCESS_TRANSIENT_STATUSES;
+exports.SESSION_TRANSIENT_STATUSES = content_gen.SESSION_TRANSIENT_STATUSES;
+exports.ValidationRules = validationRules_gen;

package/dist/api/qaas/v1alpha1/index.gen.js

@@ -0,0 +1,10 @@
+import { API } from "./api.gen.js";
+import { JOB_TRANSIENT_STATUSES, PROCESS_TRANSIENT_STATUSES, SESSION_TRANSIENT_STATUSES } from "./content.gen.js";
+import * as validationRules_gen from "./validation-rules.gen.js";
+export {
+  API,
+  JOB_TRANSIENT_STATUSES,
+  PROCESS_TRANSIENT_STATUSES,
+  SESSION_TRANSIENT_STATUSES,
+  validationRules_gen as ValidationRules
+};