@scaleway/sdk-qaas 1.1.5 → 1.3.0

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

@@ -1,21 +1,42 @@
 import type { Money } from '@scaleway/sdk-client';
 export type ApplicationType = 'unknown_type' | 'vqe';
+export type BookingStatus = 'unknown_status' | 'waiting' | 'validating' | 'validated' | 'cancelling' | 'cancelled' | 'error';
 export type JobStatus = 'unknown_status' | 'waiting' | 'error' | 'running' | 'completed' | 'cancelling' | 'cancelled';
 export type ListApplicationsRequestOrderBy = 'name_asc' | 'name_desc' | 'type_asc' | 'type_desc';
+export type ListBookingsRequestOrderBy = 'created_at_desc' | 'created_at_asc' | 'started_at_desc' | 'started_at_asc';
 export type ListJobResultsRequestOrderBy = 'created_at_desc' | 'created_at_asc';
 export type ListJobsRequestOrderBy = 'created_at_desc' | 'created_at_asc' | 'status_asc' | 'status_desc' | 'platform_name_asc' | 'platform_name_desc' | 'name_asc' | 'name_desc' | 'session_name_asc' | 'session_name_desc';
+export type ListModelsRequestOrderBy = 'created_at_desc' | 'created_at_asc';
 export type ListPlatformsRequestOrderBy = 'name_asc' | 'name_desc' | 'provider_name_asc' | 'provider_name_desc' | 'type_asc' | 'type_desc' | 'technology_asc' | 'technology_desc' | 'backend_name_asc' | 'backend_name_desc';
 export type ListProcessResultsRequestOrderBy = 'created_at_desc' | 'created_at_asc';
 export type ListProcessesRequestOrderBy = 'created_at_desc' | 'created_at_asc' | 'name_asc' | 'name_desc' | 'started_at_asc' | 'started_at_desc' | 'status_asc' | 'status_desc';
 export type ListSessionACLsRequestOrderBy = 'access_asc' | 'access_desc';
 export type ListSessionsRequestOrderBy = 'name_asc' | 'name_desc' | 'started_at_asc' | 'started_at_desc' | 'status_asc' | 'status_desc' | 'created_at_desc' | 'created_at_asc';
 export type PlatformAvailability = 'unknown_availability' | 'available' | 'shortage' | 'scarce' | 'maintenance';
-export type PlatformTechnology = 'unknown_technology' | 'photonic' | 'general_purpose' | 'trapped_ion' | 'superconducting';
+export type PlatformTechnology = 'unknown_technology' | 'photonic' | 'general_purpose' | 'trapped_ion' | 'superconducting' | 'neutral_atom';
 export type PlatformType = 'unknown_type' | 'simulator' | 'qpu';
 export type ProcessStatus = 'unknown_status' | 'error' | 'starting' | 'running' | 'completed' | 'cancelling' | 'cancelled';
 export type SessionAccess = 'unknown_access' | 'full' | 'read_session' | 'read_write_session' | 'read_job_result' | 'read_job_circuit' | 'read_job' | 'read_write_job';
 export type SessionOriginType = 'unknown_origin_type' | 'customer' | 'process';
 export type SessionStatus = 'unknown_status' | 'running' | 'stopped' | 'starting' | 'stopping';
+export interface PlatformBookingRequirement {
+    /**
+     * Minimal duration of any booking based on this platform.
+     */
+    minDuration?: string;
+    /**
+     * Maximal duration of any bookings based on this platform.
+     */
+    maxDuration?: string;
+    /**
+     * Allowed time to cancel a booking attached to this platform before the beginning of the session.
+     */
+    maxCancellationDuration?: string;
+    /**
+     * Allowed planification time from now where the platform can be booked in the future.
+     */
+    maxPlanificationDuration?: string;
+}
 export interface PlatformHardware {
     /**
      * Product name of the hardware.
@@ -56,6 +77,11 @@ export interface JobCircuit {
      */
     qiskitCircuit?: string;
 }
+export interface CreateSessionRequestBookingDemand {
+    startedAt?: Date;
+    finishedAt?: Date;
+    description?: string;
+}
 export interface Application {
     /**
      * Unique ID of the application.
@@ -78,6 +104,40 @@ export interface Application {
      */
     inputTemplate: string;
 }
+export interface Booking {
+    /**
+     * Unique ID of the booking.
+     */
+    id: string;
+    /**
+     * Time at which the booking was created.
+     */
+    createdAt?: Date;
+    /**
+     * Time at which the booking starts.
+     */
+    startedAt?: Date;
+    /**
+     * Time at which the booking was updated.
+     */
+    updatedAt?: Date;
+    /**
+     * Time at which the booking finishes.
+     */
+    finishedAt?: Date;
+    /**
+     * Status of the booking.
+     */
+    status: BookingStatus;
+    /**
+     * Description of the booking slot.
+     */
+    description: string;
+    /**
+     * Any progress message of the booking.
+     */
+    progressMessage: string;
+}
 export interface JobResult {
     /**
      * ID of the parent job.
@@ -141,6 +201,32 @@ export interface Job {
      * Result of the job, if the job is finished.
      */
     resultDistribution?: string;
+    /**
+     * Computation model ID executed by the job.
+     */
+    modelId?: string;
+    /**
+     * Execution parameters for this job.
+     */
+    parameters?: string;
+}
+export interface Model {
+    /**
+     * Unique ID of the model.
+     */
+    id: string;
+    /**
+     * Time at which the model was created.
+     */
+    createdAt?: Date;
+    /**
+     * Storage URL of the model.
+     */
+    url?: string;
+    /**
+     * Project ID in which the model has been created.
+     */
+    projectId: string;
 }
 export interface Platform {
     /**
@@ -207,6 +293,22 @@ export interface Platform {
      * Specifications of the underlying hardware.
      */
     hardware?: PlatformHardware;
+    /**
+     * Booking constraints to fit if the platform is bookable.
+     */
+    bookingRequirement?: PlatformBookingRequirement;
+    /**
+     * English description of the platform.
+     */
+    description: string;
+    /**
+     * Documentation link to external documentation to learn more on this platform.
+     */
+    documentationUrl: string;
+    /**
+     * Specify if the platform is bookable.
+     */
+    isBookable: boolean;
 }
 export interface ProcessResult {
     /**
@@ -244,7 +346,7 @@ export interface Process {
      */
     attachedSessionIds: string[];
     /**
-     * Tme at which the process was created.
+     * Time at which the process was created.
      */
     createdAt?: Date;
     /**
@@ -357,6 +459,18 @@ export interface Session {
      * Any progress of the session.
      */
     progressMessage?: string;
+    /**
+     * An optional booking unique ID of an attached booking.
+     */
+    bookingId?: string;
+    /**
+     * Default computation model ID to be executed by job assigned to this session.
+     */
+    modelId?: string;
+    /**
+     * Platform configuration parameters applied to this session.
+     */
+    parameters?: string;
 }
 export type CancelJobRequest = {
     /**
@@ -391,6 +505,24 @@ export type CreateJobRequest = {
      * Maximum duration of the job.
      */
     maxDuration?: string;
+    /**
+     * Computation model ID to be executed by the job.
+     */
+    modelId?: string;
+    /**
+     * Execution parameters for this job.
+     */
+    parameters?: string;
+};
+export type CreateModelRequest = {
+    /**
+     * Project ID to attach this model.
+     */
+    projectId?: string;
+    /**
+     * The serialized model data.
+     */
+    payload?: string;
 };
 export type CreateProcessRequest = {
     /**
@@ -447,6 +579,18 @@ export type CreateSessionRequest = {
      * Deduplication ID of the session.
      */
     deduplicationId?: string;
+    /**
+     * A booking demand to schedule the session, only applicable if the platform is bookable.
+     */
+    bookingDemand?: CreateSessionRequestBookingDemand;
+    /**
+     * Default computation model ID to be executed by job assigned to this session.
+     */
+    modelId?: string;
+    /**
+     * Optional platform configuration parameters applied to this session.
+     */
+    parameters?: string;
 };
 export type DeleteJobRequest = {
     /**
@@ -472,6 +616,12 @@ export type GetApplicationRequest = {
      */
     applicationId: string;
 };
+export type GetBookingRequest = {
+    /**
+     * Unique ID of the booking.
+     */
+    bookingId: string;
+};
 export type GetJobCircuitRequest = {
     /**
      * Unique ID of the job.
@@ -484,6 +634,12 @@ export type GetJobRequest = {
      */
     jobId: string;
 };
+export type GetModelRequest = {
+    /**
+     * Unique ID of the model.
+     */
+    modelId: string;
+};
 export type GetPlatformRequest = {
     /**
      * Unique ID of the platform.
@@ -534,6 +690,38 @@ export interface ListApplicationsResponse {
      */
     applications: Application[];
 }
+export type ListBookingsRequest = {
+    /**
+     * List bookings belonging to this project ID.
+     */
+    projectId?: string;
+    /**
+     * List bookings attached to this platform ID.
+     */
+    platformId?: string;
+    /**
+     * Page number.
+     */
+    page?: number;
+    /**
+     * Maximum number of results to return per page.
+     */
+    pageSize?: number;
+    /**
+     * Sort order of the returned results.
+     */
+    orderBy?: ListBookingsRequestOrderBy;
+};
+export interface ListBookingsResponse {
+    /**
+     * Total number of bookings.
+     */
+    totalCount: number;
+    /**
+     * List of bookings.
+     */
+    bookings: Booking[];
+}
 export type ListJobResultsRequest = {
     /**
      * ID of the job.
@@ -602,6 +790,34 @@ export interface ListJobsResponse {
      */
     jobs: Job[];
 }
+export type ListModelsRequest = {
+    /**
+     * List models belonging to this project ID.
+     */
+    projectId?: string;
+    /**
+     * Page number.
+     */
+    page?: number;
+    /**
+     * Maximum number of results to return per page.
+     */
+    pageSize?: number;
+    /**
+     * Sort order of the returned results.
+     */
+    orderBy?: ListModelsRequestOrderBy;
+};
+export interface ListModelsResponse {
+    /**
+     * Total number of models.
+     */
+    totalCount: number;
+    /**
+     * List of models.
+     */
+    models: Model[];
+}
 export type ListPlatformsRequest = {
     /**
      * List platforms with this provider name.
@@ -762,6 +978,16 @@ export type TerminateSessionRequest = {
      */
     sessionId: string;
 };
+export type UpdateBookingRequest = {
+    /**
+     * Unique ID of the booking.
+     */
+    bookingId: string;
+    /**
+     * Description of the booking slot.
+     */
+    description?: string;
+};
 export type UpdateJobRequest = {
     /**
      * Unique ID of the job.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@scaleway/sdk-qaas",
-  "version": "1.1.5",
+  "version": "1.3.0",
   "description": "Scaleway SDK qaas",
   "license": "Apache-2.0",
   "files": [
@@ -26,17 +26,17 @@
     "directory": "packages_generated/qaas"
   },
   "engines": {
-    "node": ">=20.19.1"
+    "node": ">=20.19.4"
   },
   "dependencies": {
-    "@scaleway/random-name": "5.1.1",
-    "@scaleway/sdk-std": "1.0.5"
+    "@scaleway/random-name": "5.1.2",
+    "@scaleway/sdk-std": "1.0.6"
   },
   "peerDependencies": {
-    "@scaleway/sdk-client": "^1.3.0"
+    "@scaleway/sdk-client": "^1.3.1"
   },
   "devDependencies": {
-    "@scaleway/sdk-client": "^1.3.0"
+    "@scaleway/sdk-client": "^1.3.1"
   },
   "scripts": {
     "package:check": "pnpm publint",