@scaleway/sdk-qaas 1.5.0 → 2.2.0

package/README.md

@@ -0,0 +1,96 @@
+# @scaleway/sdk-qaas
+
+[![npm version](https://img.shields.io/npm/v/@scaleway/sdk-qaas.svg)](https://www.npmjs.com/package/@scaleway/sdk-qaas)
+[![npm downloads](https://img.shields.io/npm/dm/@scaleway/sdk-qaas.svg)](https://www.npmjs.com/package/@scaleway/sdk-qaas)
+[![license](https://img.shields.io/npm/l/@scaleway/sdk-qaas.svg)](https://github.com/scaleway/scaleway-sdk-js/blob/master/LICENSE)
+
+Scaleway SDK for Qaas 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-qaas @scaleway/sdk-client
+```
+
+or with pnpm:
+
+```bash
+pnpm add @scaleway/sdk-qaas @scaleway/sdk-client
+```
+
+or with yarn:
+
+```bash
+yarn add @scaleway/sdk-qaas @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 { Qaas } from '@scaleway/sdk-qaas'
+
+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 Qaas.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 { Qaas } from '@scaleway/sdk-qaas'
+
+const profile = loadProfileFromConfigurationFile()
+const client = createClient(profile)
+const api = new Qaas.v1.API(client)
+```
+
+## Documentation
+
+- 📚 [Scaleway SDK Reference Documentation](https://scaleway.github.io/scaleway-sdk-js)
+- 🌐 [Scaleway Qaas API Documentation](https://www.scaleway.com/en/developers/api/qaas/)
+- 📖 [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,14 +1,14 @@
-import { API as ParentAPI } from '@scaleway/sdk-client';
 import type { WaitForOptions } from '@scaleway/sdk-client';
-import type { Application, Booking, CancelJobRequest, CancelProcessRequest, CreateJobRequest, CreateModelRequest, CreateProcessRequest, CreateSessionRequest, DeleteJobRequest, DeleteProcessRequest, DeleteSessionRequest, GetApplicationRequest, GetBookingRequest, GetJobCircuitRequest, GetJobRequest, GetModelRequest, GetPlatformRequest, GetProcessRequest, GetSessionRequest, Job, JobCircuit, ListApplicationsRequest, ListApplicationsResponse, ListBookingsRequest, ListBookingsResponse, ListJobResultsRequest, ListJobResultsResponse, ListJobsRequest, ListJobsResponse, ListModelsRequest, ListModelsResponse, ListPlatformsRequest, ListPlatformsResponse, ListProcessResultsRequest, ListProcessResultsResponse, ListProcessesRequest, ListProcessesResponse, ListSessionACLsRequest, ListSessionACLsResponse, ListSessionsRequest, ListSessionsResponse, Model, Platform, Process, Session, TerminateSessionRequest, UpdateBookingRequest, UpdateJobRequest, UpdateProcessRequest, UpdateSessionRequest } from './types.gen.js';
+import { API as ParentAPI } from '@scaleway/sdk-client';
+import type { Application, Booking, CancelJobRequest, CancelProcessRequest, CreateJobRequest, CreateModelRequest, CreateProcessRequest, CreateSessionRequest, DeleteJobRequest, DeleteProcessRequest, DeleteSessionRequest, GetApplicationRequest, GetBookingRequest, GetJobCircuitRequest, GetJobRequest, GetModelRequest, GetPlatformRequest, GetProcessRequest, GetSessionRequest, Job, JobCircuit, ListApplicationsRequest, ListApplicationsResponse, ListBookingsRequest, ListBookingsResponse, ListJobResultsRequest, ListJobResultsResponse, ListJobsRequest, ListJobsResponse, ListModelsRequest, ListModelsResponse, ListPlatformsRequest, ListPlatformsResponse, ListProcessesRequest, ListProcessesResponse, ListProcessResultsRequest, ListProcessResultsResponse, ListSessionACLsRequest, ListSessionACLsResponse, ListSessionsRequest, ListSessionsResponse, Model, Platform, Process, Session, TerminateSessionRequest, UpdateBookingRequest, UpdateJobRequest, UpdateProcessRequest, UpdateSessionRequest } from './types.gen.js';
 /**
  * Quantum as a Service API.
 
-This API allows you to manage Scaleway Quantum as a Service.
+This API allows you to allocate and program Quantum Processing Units (QPUs) to run quantum algorithms.
  */
 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**, mainly used to get the current status.
      *
      * @param request - The request {@link GetJobRequest}
      * @returns A Promise of Job
@@ -24,7 +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 session.
      *
      * @param request - The request {@link ListJobsRequest}
      * @returns A Promise of ListJobsResponse
@@ -45,7 +45,7 @@ export declare class API extends ParentAPI {
         [Symbol.asyncIterator]: () => AsyncGenerator<import("./types.gen.js").JobResult[], void, void>;
     };
     /**
-     * Create a job. Create a job to be executed inside a session.
+     * Create a job. Create a job to be executed inside a QPU session.
      *
      * @param request - The request {@link CreateJobRequest}
      * @returns A Promise of Job
@@ -97,7 +97,7 @@ export declare class API extends ParentAPI {
         [Symbol.asyncIterator]: () => AsyncGenerator<Platform[], void, void>;
     };
     /**
-     * Get session information. Retrieve information about the provided **session ID**, such as name, status, and number of executed jobs.
+     * Get session information. Retrieve information about the provided **session ID**, such as name and status.
      *
      * @param request - The request {@link GetSessionRequest}
      * @returns A Promise of Session
@@ -113,7 +113,7 @@ export declare class API extends ParentAPI {
     waitForSession: (request: Readonly<GetSessionRequest>, options?: Readonly<WaitForOptions<Session>>) => Promise<Session>;
     protected pageOfListSessions: (request?: Readonly<ListSessionsRequest>) => Promise<ListSessionsResponse>;
     /**
-     * List all sessions. Retrieve information about all sessions.
+     * List all sessions. Retrieve information about all QPU sessions.
      *
      * @param request - The request {@link ListSessionsRequest}
      * @returns A Promise of ListSessionsResponse
@@ -123,7 +123,7 @@ export declare class API extends ParentAPI {
         [Symbol.asyncIterator]: () => AsyncGenerator<Session[], void, void>;
     };
     /**
-     * Create a session. Create a dedicated session for the specified platform.
+     * Create a session. Create a new QPU session for the specified platform. Once ready, jobs can be sent to this session.
      *
      * @param request - The request {@link CreateSessionRequest}
      * @returns A Promise of Session
@@ -137,14 +137,14 @@ export declare class API extends ParentAPI {
      */
     updateSession: (request: Readonly<UpdateSessionRequest>) => Promise<Session>;
     /**
-     * Terminate an existing session. Terminate a session by its unique ID and cancel all its attached jobs and booking.
+     * Terminate an existing session. Terminate a session by its unique ID and cancel all its attached jobs and bookings.
      *
      * @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 job and booking.
+     * Delete an existing session. Delete a session by its unique ID and delete all its attached jobs and bookings.
      *
      * @param request - The request {@link DeleteSessionRequest}
      */
@@ -219,7 +219,7 @@ export declare class API extends ParentAPI {
         [Symbol.asyncIterator]: () => AsyncGenerator<import("./types.gen.js").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 **application ID**, such as name, type and compatible platforms.
      *
      * @param request - The request {@link GetApplicationRequest}
      * @returns A Promise of Application

package/dist/v1alpha1/api.gen.js

@@ -6,7 +6,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**, mainly used to get the current status.
    *
    * @param request - The request {@link GetJobRequest}
    * @returns A Promise of Job
@@ -58,7 +58,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 session.
    *
    * @param request - The request {@link ListJobsRequest}
    * @returns A Promise of ListJobsResponse
@@ -87,7 +87,7 @@ class API extends API$1 {
    */
   listJobResults = (request) => enrichForPagination("jobResults", this.pageOfListJobResults, request);
   /**
-   * Create a job. Create a job to be executed inside a session.
+   * Create a job. Create a job to be executed inside a QPU session.
    *
    * @param request - The request {@link CreateJobRequest}
    * @returns A Promise of Job
@@ -198,7 +198,7 @@ class API extends API$1 {
    */
   listPlatforms = (request = {}) => enrichForPagination("platforms", this.pageOfListPlatforms, request);
   /**
-   * Get session information. Retrieve information about the provided **session ID**, such as name, status, and number of executed jobs.
+   * Get session information. Retrieve information about the provided **session ID**, such as name and status.
    *
    * @param request - The request {@link GetSessionRequest}
    * @returns A Promise of Session
@@ -247,14 +247,14 @@ class API extends API$1 {
     unmarshalListSessionsResponse
   );
   /**
-   * List all sessions. Retrieve information about all sessions.
+   * List all sessions. Retrieve information about all QPU 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.
+   * Create a session. Create a new QPU session for the specified platform. Once ready, jobs can be sent to this session.
    *
    * @param request - The request {@link CreateSessionRequest}
    * @returns A Promise of Session
@@ -288,7 +288,7 @@ class API extends API$1 {
     unmarshalSession
   );
   /**
-   * Terminate an existing session. Terminate a session by its unique ID and cancel all its attached jobs and booking.
+   * Terminate an existing session. Terminate a session by its unique ID and cancel all its attached jobs and bookings.
    *
    * @param request - The request {@link TerminateSessionRequest}
    * @returns A Promise of Session
@@ -303,7 +303,7 @@ class API extends API$1 {
     unmarshalSession
   );
   /**
-   * Delete an existing session. Delete a session by its unique ID and delete all its attached job and booking.
+   * Delete an existing session. Delete a session by its unique ID and delete all its attached jobs and bookings.
    *
    * @param request - The request {@link DeleteSessionRequest}
    */
@@ -468,7 +468,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 **application ID**, such as name, type and compatible platforms.
    *
    * @param request - The request {@link GetApplicationRequest}
    * @returns A Promise of Application

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

@@ -1,5 +1,5 @@
 export { API } from './api.gen.js';
 export * from './content.gen.js';
 export * from './marshalling.gen.js';
-export type { Application, ApplicationType, Booking, BookingStatus, CancelJobRequest, CancelProcessRequest, CreateJobRequest, CreateModelRequest, CreateProcessRequest, CreateSessionRequest, CreateSessionRequestBookingDemand, DeleteJobRequest, DeleteProcessRequest, DeleteSessionRequest, GetApplicationRequest, GetBookingRequest, GetJobCircuitRequest, GetJobRequest, GetModelRequest, GetPlatformRequest, GetProcessRequest, GetSessionRequest, Job, JobCircuit, JobResult, JobStatus, ListApplicationsRequest, ListApplicationsRequestOrderBy, ListApplicationsResponse, ListBookingsRequest, ListBookingsRequestOrderBy, ListBookingsResponse, ListJobResultsRequest, ListJobResultsRequestOrderBy, ListJobResultsResponse, ListJobsRequest, ListJobsRequestOrderBy, ListJobsResponse, ListModelsRequest, ListModelsRequestOrderBy, ListModelsResponse, ListPlatformsRequest, ListPlatformsRequestOrderBy, ListPlatformsResponse, ListProcessResultsRequest, ListProcessResultsRequestOrderBy, ListProcessResultsResponse, ListProcessesRequest, ListProcessesRequestOrderBy, ListProcessesResponse, ListSessionACLsRequest, ListSessionACLsRequestOrderBy, ListSessionACLsResponse, ListSessionsRequest, ListSessionsRequestOrderBy, ListSessionsResponse, Model, Platform, PlatformAvailability, PlatformBookingRequirement, PlatformHardware, PlatformTechnology, PlatformType, Process, ProcessResult, ProcessStatus, Session, SessionAccess, SessionOriginType, SessionStatus, TerminateSessionRequest, UpdateBookingRequest, UpdateJobRequest, UpdateProcessRequest, UpdateSessionRequest, } from './types.gen.js';
+export type { Application, ApplicationType, Booking, BookingStatus, CancelJobRequest, CancelProcessRequest, CreateJobRequest, CreateModelRequest, CreateProcessRequest, CreateSessionRequest, CreateSessionRequestBookingDemand, DeleteJobRequest, DeleteProcessRequest, DeleteSessionRequest, GetApplicationRequest, GetBookingRequest, GetJobCircuitRequest, GetJobRequest, GetModelRequest, GetPlatformRequest, GetProcessRequest, GetSessionRequest, Job, JobCircuit, JobResult, JobStatus, ListApplicationsRequest, ListApplicationsRequestOrderBy, ListApplicationsResponse, ListBookingsRequest, ListBookingsRequestOrderBy, ListBookingsResponse, ListJobResultsRequest, ListJobResultsRequestOrderBy, ListJobResultsResponse, ListJobsRequest, ListJobsRequestOrderBy, ListJobsResponse, ListModelsRequest, ListModelsRequestOrderBy, ListModelsResponse, ListPlatformsRequest, ListPlatformsRequestOrderBy, ListPlatformsResponse, ListProcessesRequest, ListProcessesRequestOrderBy, ListProcessesResponse, ListProcessResultsRequest, ListProcessResultsRequestOrderBy, ListProcessResultsResponse, ListSessionACLsRequest, ListSessionACLsRequestOrderBy, ListSessionACLsResponse, ListSessionsRequest, ListSessionsRequestOrderBy, ListSessionsResponse, Model, Platform, PlatformAvailability, PlatformBookingRequirement, PlatformHardware, PlatformTechnology, PlatformType, Process, ProcessResult, ProcessStatus, Session, SessionAccess, SessionOriginType, SessionStatus, TerminateSessionRequest, UpdateBookingRequest, UpdateJobRequest, UpdateProcessRequest, UpdateSessionRequest, } from './types.gen.js';
 export * as ValidationRules from './validation-rules.gen.js';

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

@@ -1,5 +1,5 @@
 import type { DefaultValues } from '@scaleway/sdk-client';
-import type { Application, Booking, CreateJobRequest, CreateModelRequest, CreateProcessRequest, CreateSessionRequest, Job, JobCircuit, ListApplicationsResponse, ListBookingsResponse, ListJobResultsResponse, ListJobsResponse, ListModelsResponse, ListPlatformsResponse, ListProcessResultsResponse, ListProcessesResponse, ListSessionACLsResponse, ListSessionsResponse, Model, Platform, Process, Session, UpdateBookingRequest, UpdateJobRequest, UpdateProcessRequest, UpdateSessionRequest } from './types.gen.js';
+import type { Application, Booking, CreateJobRequest, CreateModelRequest, CreateProcessRequest, CreateSessionRequest, Job, JobCircuit, ListApplicationsResponse, ListBookingsResponse, ListJobResultsResponse, ListJobsResponse, ListModelsResponse, ListPlatformsResponse, ListProcessesResponse, ListProcessResultsResponse, ListSessionACLsResponse, ListSessionsResponse, Model, Platform, Process, Session, UpdateBookingRequest, UpdateJobRequest, UpdateProcessRequest, UpdateSessionRequest } from './types.gen.js';
 export declare const unmarshalJobCircuit: (data: unknown) => JobCircuit;
 export declare const unmarshalApplication: (data: unknown) => Application;
 export declare const unmarshalBooking: (data: unknown) => Booking;

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

@@ -259,23 +259,23 @@ export interface Platform {
      */
     name: string;
     /**
-     * Provider name of the platform.
+     * Name of the technological provider of the platform in lowercase (quandela, pasqal...).
      */
     providerName: string;
     /**
-     * Name of the running backend over the platform (ascella, qsim, aer...).
+     * Name of the running emulation backend or QPU model of the platform in lowercase (mosaiq, qsim, aer...).
      */
     backendName: string;
     /**
-     * Type of the platform.
+     * Type of the platform (emulator or qpu).
      */
     type: PlatformType;
     /**
-     * Technology used by the platform.
+     * Quantum technology used by the platform (trapped-ion, photonic, superconducting qubits...).
      */
     technology: PlatformTechnology;
     /**
-     * Estimated maximum number of qubits supported by the platform.
+     * Maximum number of qubits supported by the platform (estimated for emulator).
      */
     maxQubitCount: number;
     /**

package/package.json

@@ -1,23 +1,20 @@
 {
   "name": "@scaleway/sdk-qaas",
-  "version": "1.5.0",
+  "version": "2.2.0",
   "description": "Scaleway SDK qaas",
   "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/qaas"
   },
   "engines": {
-    "node": ">=20.19.4"
+    "node": ">=20.19.6"
   },
   "dependencies": {
     "@scaleway/random-name": "5.1.2",
-    "@scaleway/sdk-std": "1.2.0"
+    "@scaleway/sdk-std": "2.1.0"
   },
   "peerDependencies": {
-    "@scaleway/sdk-client": "^1.3.3"
+    "@scaleway/sdk-client": "^2.1.0"
   },
   "devDependencies": {
-    "@scaleway/sdk-client": "^1.3.3"
+    "@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.Qaasv1alpha1 = index_gen;