@scaleway/sdk 2.72.0 → 2.73.0

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

@@ -13,8 +13,7 @@ const jsonContentHeaders = {
 };
 class API extends api.API {
   /**
-   * Get job information. Retrieve information about the provided **job ID**,
-   * such as status, payload, and result.
+   * 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
@@ -66,8 +65,7 @@ class API extends api.API {
     marshalling_gen.unmarshalListJobsResponse
   );
   /**
-   * List all jobs within a project or session. Retrieve information about all
-   * jobs within a given project or session.
+   * 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
@@ -89,8 +87,7 @@ class API extends api.API {
     marshalling_gen.unmarshalListJobResultsResponse
   );
   /**
-   * List all results of a job. Retrieve all intermediate and final results of a
-   * job.
+   * 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
@@ -114,8 +111,7 @@ class API extends api.API {
     marshalling_gen.unmarshalJob
   );
   /**
-   * Update job information. Update job information about the provided **job
-   * ID**.
+   * Update job information. Update job information about the provided **job ID**.
    *
    * @param request - The request {@link UpdateJobRequest}
    * @returns A Promise of Job
@@ -169,8 +165,7 @@ class API extends api.API {
     marshalling_gen.unmarshalJobCircuit
   );
   /**
-   * Get platform information. Retrieve information about the provided
-   * **platform ID**, such as provider name, technology, and type.
+   * 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
@@ -210,8 +205,7 @@ class API extends api.API {
    */
   listPlatforms = (request = {}) => resourcePaginator.enrichForPagination("platforms", this.pageOfListPlatforms, request);
   /**
-   * Get session infrormation. Retrieve information about the provided **session
-   * ID**, such as name, status, and number of executed jobs.
+   * 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
@@ -284,8 +278,7 @@ class API extends api.API {
     marshalling_gen.unmarshalSession
   );
   /**
-   * Update session information. Update session information of the provided
-   * **session ID**.
+   * Update session information. Update session information of the provided **session ID**.
    *
    * @param request - The request {@link UpdateSessionRequest}
    * @returns A Promise of Session
@@ -302,8 +295,7 @@ class API extends api.API {
     marshalling_gen.unmarshalSession
   );
   /**
-   * Terminate an existing session. Terminate a session by its unique ID and
-   * cancel all its attached jobs.
+   * 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
@@ -318,8 +310,7 @@ class API extends api.API {
     marshalling_gen.unmarshalSession
   );
   /**
-   * Delete an existing session. Delete a session by its unique ID and delete
-   * all its attached jobs.
+   * Delete an existing session. Delete a session by its unique ID and delete all its attached jobs.
    *
    * @param request - The request {@link DeleteSessionRequest}
    */
@@ -344,8 +335,7 @@ class API extends api.API {
   );
   listSessionACLs = (request) => resourcePaginator.enrichForPagination("acls", this.pageOfListSessionACLs, request);
   /**
-   * Create a process. Create a new process for the specified application on a
-   * specified platform.
+   * 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
@@ -362,8 +352,7 @@ class API extends api.API {
     marshalling_gen.unmarshalProcess
   );
   /**
-   * Get process infrormation. Retrieve information about the provided **process
-   * ID**, such as name, status and progress.
+   * 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
@@ -419,8 +408,7 @@ class API extends api.API {
    */
   listProcesses = (request = {}) => resourcePaginator.enrichForPagination("processes", this.pageOfListProcesses, request);
   /**
-   * Update process information. Update process information of the provided
-   * **process ID**.
+   * Update process information. Update process information of the provided **process ID**.
    *
    * @param request - The request {@link UpdateProcessRequest}
    * @returns A Promise of Process
@@ -437,8 +425,7 @@ class API extends api.API {
     marshalling_gen.unmarshalProcess
   );
   /**
-   * Cancel a running process. Cancel a process by its unique ID. Intermediate
-   * results are still available.
+   * 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
@@ -453,8 +440,7 @@ class API extends api.API {
     marshalling_gen.unmarshalProcess
   );
   /**
-   * Delete an existing process. Delete a process by its unique ID and delete
-   * all its data.
+   * Delete an existing process. Delete a process by its unique ID and delete all its data.
    *
    * @param request - The request {@link DeleteProcessRequest}
    */
@@ -478,8 +464,7 @@ class API extends api.API {
     marshalling_gen.unmarshalListProcessResultsResponse
   );
   /**
-   * List all results of a process. Retrieve all intermediate and final result
-   * of a process.
+   * 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
@@ -490,8 +475,7 @@ class API extends api.API {
     request
   );
   /**
-   * Get application information. Retrieve information about the provided
-   * **applcation ID**, such as name, type and compatible platforms.
+   * 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
@@ -521,8 +505,7 @@ class API extends api.API {
     marshalling_gen.unmarshalListApplicationsResponse
   );
   /**
-   * List all available applications. Retrieve information about all
-   * applications.
+   * List all available applications. Retrieve information about all applications.
    *
    * @param request - The request {@link ListApplicationsRequest}
    * @returns A Promise of ListApplicationsResponse

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

@@ -3,13 +3,12 @@ import type { WaitForOptions } from '@scaleway/sdk-client';
 import type { Application, CancelJobRequest, CancelProcessRequest, CreateJobRequest, CreateProcessRequest, CreateSessionRequest, DeleteJobRequest, DeleteProcessRequest, DeleteSessionRequest, GetApplicationRequest, GetJobCircuitRequest, GetJobRequest, GetPlatformRequest, GetProcessRequest, GetSessionRequest, Job, JobCircuit, ListApplicationsRequest, ListApplicationsResponse, ListJobResultsRequest, ListJobResultsResponse, ListJobsRequest, ListJobsResponse, ListPlatformsRequest, ListPlatformsResponse, ListProcessResultsRequest, ListProcessResultsResponse, ListProcessesRequest, ListProcessesResponse, ListSessionACLsRequest, ListSessionACLsResponse, ListSessionsRequest, ListSessionsResponse, Platform, Process, Session, TerminateSessionRequest, UpdateJobRequest, UpdateProcessRequest, UpdateSessionRequest } from './types.gen';
 /**
  * Quantum as a Service API.
- *
- * This API allows you to manage Scaleway Quantum as a Service.
+
+This API allows you to manage Scaleway Quantum as a Service.
  */
 export declare class API extends ParentAPI {
     /**
-     * Get job information. Retrieve information about the provided **job ID**,
-     * such as status, payload, and result.
+     * 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
@@ -25,8 +24,7 @@ export declare class API extends ParentAPI {
     waitForJob: (request: Readonly<GetJobRequest>, options?: Readonly<WaitForOptions<Job>>) => Promise<Job>;
     protected pageOfListJobs: (request?: Readonly<ListJobsRequest>) => Promise<ListJobsResponse>;
     /**
-     * List all jobs within a project or session. Retrieve information about all
-     * jobs within a given project or session.
+     * 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
@@ -37,8 +35,7 @@ export declare class API extends ParentAPI {
     };
     protected pageOfListJobResults: (request: Readonly<ListJobResultsRequest>) => Promise<ListJobResultsResponse>;
     /**
-     * List all results of a job. Retrieve all intermediate and final results of a
-     * job.
+     * 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
@@ -55,8 +52,7 @@ export declare class API extends ParentAPI {
      */
     createJob: (request: Readonly<CreateJobRequest>) => Promise<Job>;
     /**
-     * Update job information. Update job information about the provided **job
-     * ID**.
+     * Update job information. Update job information about the provided **job ID**.
      *
      * @param request - The request {@link UpdateJobRequest}
      * @returns A Promise of Job
@@ -83,8 +79,7 @@ export declare class API extends ParentAPI {
      */
     getJobCircuit: (request: Readonly<GetJobCircuitRequest>) => Promise<JobCircuit>;
     /**
-     * Get platform information. Retrieve information about the provided
-     * **platform ID**, such as provider name, technology, and type.
+     * 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
@@ -102,8 +97,7 @@ export declare class API extends ParentAPI {
         [Symbol.asyncIterator]: () => AsyncGenerator<Platform[], void, void>;
     };
     /**
-     * Get session infrormation. Retrieve information about the provided **session
-     * ID**, such as name, status, and number of executed jobs.
+     * 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
@@ -136,24 +130,21 @@ export declare class API extends ParentAPI {
      */
     createSession: (request: Readonly<CreateSessionRequest>) => Promise<Session>;
     /**
-     * Update session information. Update session information of the provided
-     * **session ID**.
+     * Update session information. Update session information of the provided **session ID**.
      *
      * @param request - The request {@link UpdateSessionRequest}
      * @returns A Promise of Session
      */
     updateSession: (request: Readonly<UpdateSessionRequest>) => Promise<Session>;
     /**
-     * Terminate an existing session. Terminate a session by its unique ID and
-     * cancel all its attached jobs.
+     * 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: Readonly<TerminateSessionRequest>) => Promise<Session>;
     /**
-     * Delete an existing session. Delete a session by its unique ID and delete
-     * all its attached jobs.
+     * Delete an existing session. Delete a session by its unique ID and delete all its attached jobs.
      *
      * @param request - The request {@link DeleteSessionRequest}
      */
@@ -164,16 +155,14 @@ export declare class API extends ParentAPI {
         [Symbol.asyncIterator]: () => AsyncGenerator<import("./types.gen").SessionAccess[], void, void>;
     };
     /**
-     * Create a process. Create a new process for the specified application on a
-     * specified platform.
+     * 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: Readonly<CreateProcessRequest>) => Promise<Process>;
     /**
-     * Get process infrormation. Retrieve information about the provided **process
-     * ID**, such as name, status and progress.
+     * 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
@@ -199,32 +188,28 @@ export declare class API extends ParentAPI {
         [Symbol.asyncIterator]: () => AsyncGenerator<Process[], void, void>;
     };
     /**
-     * Update process information. Update process information of the provided
-     * **process ID**.
+     * Update process information. Update process information of the provided **process ID**.
      *
      * @param request - The request {@link UpdateProcessRequest}
      * @returns A Promise of Process
      */
     updateProcess: (request: Readonly<UpdateProcessRequest>) => Promise<Process>;
     /**
-     * Cancel a running process. Cancel a process by its unique ID. Intermediate
-     * results are still available.
+     * 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: Readonly<CancelProcessRequest>) => Promise<Process>;
     /**
-     * Delete an existing process. Delete a process by its unique ID and delete
-     * all its data.
+     * Delete an existing process. Delete a process by its unique ID and delete all its data.
      *
      * @param request - The request {@link DeleteProcessRequest}
      */
     deleteProcess: (request: Readonly<DeleteProcessRequest>) => Promise<void>;
     protected pageOfListProcessResults: (request: Readonly<ListProcessResultsRequest>) => Promise<ListProcessResultsResponse>;
     /**
-     * List all results of a process. Retrieve all intermediate and final result
-     * of a process.
+     * 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
@@ -234,8 +219,7 @@ export declare class API extends ParentAPI {
         [Symbol.asyncIterator]: () => AsyncGenerator<import("./types.gen").ProcessResult[], void, void>;
     };
     /**
-     * Get application information. Retrieve information about the provided
-     * **applcation ID**, such as name, type and compatible platforms.
+     * 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
@@ -243,8 +227,7 @@ export declare class API extends ParentAPI {
     getApplication: (request: Readonly<GetApplicationRequest>) => Promise<Application>;
     protected pageOfListApplications: (request?: Readonly<ListApplicationsRequest>) => Promise<ListApplicationsResponse>;
     /**
-     * List all available applications. Retrieve information about all
-     * applications.
+     * List all available applications. Retrieve information about all applications.
      *
      * @param request - The request {@link ListApplicationsRequest}
      * @returns A Promise of ListApplicationsResponse

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

@@ -11,8 +11,7 @@ const jsonContentHeaders = {
 };
 class API extends API$1 {
   /**
-   * Get job information. Retrieve information about the provided **job ID**,
-   * such as status, payload, and result.
+   * 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
@@ -64,8 +63,7 @@ class API extends API$1 {
     unmarshalListJobsResponse
   );
   /**
-   * List all jobs within a project or session. Retrieve information about all
-   * jobs within a given project or session.
+   * 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
@@ -87,8 +85,7 @@ class API extends API$1 {
     unmarshalListJobResultsResponse
   );
   /**
-   * List all results of a job. Retrieve all intermediate and final results of a
-   * job.
+   * 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
@@ -112,8 +109,7 @@ class API extends API$1 {
     unmarshalJob
   );
   /**
-   * Update job information. Update job information about the provided **job
-   * ID**.
+   * Update job information. Update job information about the provided **job ID**.
    *
    * @param request - The request {@link UpdateJobRequest}
    * @returns A Promise of Job
@@ -167,8 +163,7 @@ class API extends API$1 {
     unmarshalJobCircuit
   );
   /**
-   * Get platform information. Retrieve information about the provided
-   * **platform ID**, such as provider name, technology, and type.
+   * 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
@@ -208,8 +203,7 @@ class API extends API$1 {
    */
   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.
+   * 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
@@ -282,8 +276,7 @@ class API extends API$1 {
     unmarshalSession
   );
   /**
-   * Update session information. Update session information of the provided
-   * **session ID**.
+   * Update session information. Update session information of the provided **session ID**.
    *
    * @param request - The request {@link UpdateSessionRequest}
    * @returns A Promise of Session
@@ -300,8 +293,7 @@ class API extends API$1 {
     unmarshalSession
   );
   /**
-   * Terminate an existing session. Terminate a session by its unique ID and
-   * cancel all its attached jobs.
+   * 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
@@ -316,8 +308,7 @@ class API extends API$1 {
     unmarshalSession
   );
   /**
-   * Delete an existing session. Delete a session by its unique ID and delete
-   * all its attached jobs.
+   * Delete an existing session. Delete a session by its unique ID and delete all its attached jobs.
    *
    * @param request - The request {@link DeleteSessionRequest}
    */
@@ -342,8 +333,7 @@ class API extends API$1 {
   );
   listSessionACLs = (request) => enrichForPagination("acls", this.pageOfListSessionACLs, request);
   /**
-   * Create a process. Create a new process for the specified application on a
-   * specified platform.
+   * 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
@@ -360,8 +350,7 @@ class API extends API$1 {
     unmarshalProcess
   );
   /**
-   * Get process infrormation. Retrieve information about the provided **process
-   * ID**, such as name, status and progress.
+   * 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
@@ -417,8 +406,7 @@ class API extends API$1 {
    */
   listProcesses = (request = {}) => enrichForPagination("processes", this.pageOfListProcesses, request);
   /**
-   * Update process information. Update process information of the provided
-   * **process ID**.
+   * Update process information. Update process information of the provided **process ID**.
    *
    * @param request - The request {@link UpdateProcessRequest}
    * @returns A Promise of Process
@@ -435,8 +423,7 @@ class API extends API$1 {
     unmarshalProcess
   );
   /**
-   * Cancel a running process. Cancel a process by its unique ID. Intermediate
-   * results are still available.
+   * 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
@@ -451,8 +438,7 @@ class API extends API$1 {
     unmarshalProcess
   );
   /**
-   * Delete an existing process. Delete a process by its unique ID and delete
-   * all its data.
+   * Delete an existing process. Delete a process by its unique ID and delete all its data.
    *
    * @param request - The request {@link DeleteProcessRequest}
    */
@@ -476,8 +462,7 @@ class API extends API$1 {
     unmarshalListProcessResultsResponse
   );
   /**
-   * List all results of a process. Retrieve all intermediate and final result
-   * of a process.
+   * 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
@@ -488,8 +473,7 @@ class API extends API$1 {
     request
   );
   /**
-   * Get application information. Retrieve information about the provided
-   * **applcation ID**, such as name, type and compatible platforms.
+   * 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
@@ -519,8 +503,7 @@ class API extends API$1 {
     unmarshalListApplicationsResponse
   );
   /**
-   * List all available applications. Retrieve information about all
-   * applications.
+   * List all available applications. Retrieve information about all applications.
    *
    * @param request - The request {@link ListApplicationsRequest}
    * @returns A Promise of ListApplicationsResponse