@scaleway/sdk 2.72.0 → 2.73.0

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

@@ -17,393 +17,681 @@ export type SessionAccess = 'unknown_access' | 'full' | 'read_session' | 'read_w
 export type SessionOriginType = 'unknown_origin_type' | 'customer' | 'process';
 export type SessionStatus = 'unknown_status' | 'running' | 'stopped' | 'starting' | 'stopping';
 export interface PlatformHardware {
-    /** Product name of the hardware. */
+    /**
+     * Product name of the hardware.
+     */
     name: string;
-    /** Number of vCPUs available. */
+    /**
+     * Number of vCPUs available.
+     */
     vcpus: number;
-    /** Number of GPUs available (0 if no GPU). */
+    /**
+     * Number of GPUs available (0 if no GPU).
+     */
     gpus: number;
-    /** Network topology of GPUs (PCIe, NVLink...). */
+    /**
+     * Network topology of GPUs (PCIe, NVLink...).
+     */
     gpusNetwork: string;
-    /** Amount of RAM available in byte. */
+    /**
+     * Amount of RAM available in byte.
+     */
     ram: number;
-    /** Amount of VRAM available in byte (0 if no GPU). */
+    /**
+     * Amount of VRAM available in byte (0 if no GPU).
+     */
     vram: number;
 }
 export interface JobCircuit {
     /**
      * Circuit generated by Perceval that should be executed.
      *
-     * One-of ('circuitSerialization'): at most one of 'percevalCircuit',
-     * 'qiskitCircuit' could be set.
+     * One-of ('circuitSerialization'): at most one of 'percevalCircuit', 'qiskitCircuit' could be set.
      */
     percevalCircuit?: string;
     /**
      * Circuit generated by Qiskit that should be executed.
      *
-     * One-of ('circuitSerialization'): at most one of 'percevalCircuit',
-     * 'qiskitCircuit' could be set.
+     * One-of ('circuitSerialization'): at most one of 'percevalCircuit', 'qiskitCircuit' could be set.
      */
     qiskitCircuit?: string;
 }
 export interface Application {
-    /** Unique ID of the application. */
+    /**
+     * Unique ID of the application.
+     */
     id: string;
-    /** Name of the application. */
+    /**
+     * Name of the application.
+     */
     name: string;
-    /** Type of the application. */
+    /**
+     * Type of the application.
+     */
     type: ApplicationType;
-    /** List of compatible platform (by IDs) able to run this application. */
+    /**
+     * List of compatible platform (by IDs) able to run this application.
+     */
     compatiblePlatformIds: string[];
-    /** JSON format describing the expected input. */
+    /**
+     * JSON format describing the expected input.
+     */
     inputTemplate: string;
 }
 export interface JobResult {
-    /** ID of the parent job. */
+    /**
+     * ID of the parent job.
+     */
     jobId: string;
-    /** Result in JSON format. */
+    /**
+     * Result in JSON format.
+     */
     result?: string;
-    /** URL to download a large result (optional). */
+    /**
+     * URL to download a large result (optional).
+     */
     url?: string;
-    /** Creation time of the result. */
+    /**
+     * Creation time of the result.
+     */
     createdAt?: Date;
 }
 export interface Job {
-    /** Unique ID of the job. */
+    /**
+     * Unique ID of the job.
+     */
     id: string;
-    /** Job name. */
+    /**
+     * Job name.
+     */
     name: string;
-    /** Tags of the job. */
+    /**
+     * Tags of the job.
+     */
     tags?: string[];
-    /** Session ID in which the job is executed. */
+    /**
+     * Session ID in which the job is executed.
+     */
     sessionId: string;
-    /** Time at which the job was created. */
+    /**
+     * Time at which the job was created.
+     */
     createdAt?: Date;
-    /** Time at which the job was started. */
+    /**
+     * Time at which the job was started.
+     */
     startedAt?: Date;
-    /** Time at which the job was updated. */
+    /**
+     * Time at which the job was updated.
+     */
     updatedAt?: Date;
-    /** Job status. */
+    /**
+     * Job status.
+     */
     status: JobStatus;
-    /** Last progress message, if the job has started. */
+    /**
+     * Last progress message, if the job has started.
+     */
     progressMessage?: string;
-    /** Duration of the job, if the job is finished. */
+    /**
+     * Duration of the job, if the job is finished.
+     */
     jobDuration?: string;
-    /** Result of the job, if the job is finished. */
+    /**
+     * Result of the job, if the job is finished.
+     */
     resultDistribution?: string;
 }
 export interface Platform {
-    /** Unique ID of the platform. */
+    /**
+     * Unique ID of the platform.
+     */
     id: string;
-    /** Verison of the platform. */
+    /**
+     * Verison of the platform.
+     */
     version: string;
-    /** Name of the platform. */
+    /**
+     * Name of the platform.
+     */
     name: string;
-    /** Provider name of the platform. */
+    /**
+     * Provider name of the platform.
+     */
     providerName: string;
-    /** Name of the running backend over the platform (ascella, qsim, aer...). */
+    /**
+     * Name of the running backend over the platform (ascella, qsim, aer...).
+     */
     backendName: string;
-    /** Type of the platform. */
+    /**
+     * Type of the platform.
+     */
     type: PlatformType;
-    /** Technology used by the platform. */
+    /**
+     * Technology used by the platform.
+     */
     technology: PlatformTechnology;
-    /** Estimated maximum number of qubits supported by the platform. */
+    /**
+     * Estimated maximum number of qubits supported by the platform.
+     */
     maxQubitCount: number;
-    /** Availability of the platform. */
+    /**
+     * Availability of the platform.
+     */
     availability: PlatformAvailability;
-    /** Metadata provided by the platform. */
+    /**
+     * Metadata provided by the platform.
+     */
     metadata: string;
-    /** Price to be payed per hour (excluding free tiers). */
+    /**
+     * Price to be payed per hour (excluding free tiers).
+     */
     pricePerHour?: Money;
-    /** Specifications of the underlying hardware. */
+    /**
+     * Specifications of the underlying hardware.
+     */
     hardware?: PlatformHardware;
 }
 export interface ProcessResult {
-    /** ID of the parent process. */
+    /**
+     * ID of the parent process.
+     */
     processId: string;
-    /** Result in JSON format. */
+    /**
+     * Result in JSON format.
+     */
     result: string;
-    /** Creation time of the result. */
+    /**
+     * Creation time of the result.
+     */
     createdAt?: Date;
 }
 export interface Process {
-    /** Unique ID of the process. */
+    /**
+     * Unique ID of the process.
+     */
     id: string;
-    /** Name of the process. */
+    /**
+     * Name of the process.
+     */
     name: string;
-    /** Application ID for which the process has been created. */
+    /**
+     * Application ID for which the process has been created.
+     */
     applicationId?: string;
-    /** Platform ID for which the process has been created. */
+    /**
+     * Platform ID for which the process has been created.
+     */
     platformId?: string;
-    /** List of sessions generated by the process. */
+    /**
+     * List of sessions generated by the process.
+     */
     attachedSessionIds: string[];
-    /** Tme at which the process was created. */
+    /**
+     * Tme at which the process was created.
+     */
     createdAt?: Date;
-    /** Time at which the process started. */
+    /**
+     * Time at which the process started.
+     */
     startedAt?: Date;
-    /** Time at which the process was updated. */
+    /**
+     * Time at which the process was updated.
+     */
     updatedAt?: Date;
-    /** Time at which the process was finished. */
+    /**
+     * Time at which the process was finished.
+     */
     finishedAt?: Date;
-    /** Status of the process. */
+    /**
+     * Status of the process.
+     */
     status: ProcessStatus;
-    /** Project ID in which the process has been created. */
+    /**
+     * Project ID in which the process has been created.
+     */
     projectId: string;
-    /** Tags of the process. */
+    /**
+     * Tags of the process.
+     */
     tags: string[];
-    /** Progress of the process, from 0 to 1. */
+    /**
+     * Progress of the process, from 0 to 1.
+     */
     progress?: number;
-    /** Any progress of the process. */
+    /**
+     * Any progress of the process.
+     */
     progressMessage?: string;
-    /** Input payload of the process as JSON string. */
+    /**
+     * Input payload of the process as JSON string.
+     */
     input?: string;
 }
 export interface Session {
-    /** Unique ID of the session. */
+    /**
+     * Unique ID of the session.
+     */
     id: string;
-    /** Name of the session. */
+    /**
+     * Name of the session.
+     */
     name: string;
-    /** Platform ID for which the session has been created. */
+    /**
+     * Platform ID for which the session has been created.
+     */
     platformId: string;
-    /** The time at which the session was created. */
+    /**
+     * The time at which the session was created.
+     */
     createdAt?: Date;
-    /** The time at which the session started. */
+    /**
+     * The time at which the session started.
+     */
     startedAt?: Date;
-    /** The time at which the session was updated. */
+    /**
+     * The time at which the session was updated.
+     */
     updatedAt?: Date;
-    /** The time at which the session was terminated. */
+    /**
+     * The time at which the session was terminated.
+     */
     terminatedAt?: Date;
-    /** Maximum idle time before the session ends. */
+    /**
+     * Maximum idle time before the session ends.
+     */
     maxIdleDuration?: string;
-    /** Maximum duration before the session ends. */
+    /**
+     * Maximum duration before the session ends.
+     */
     maxDuration?: string;
-    /** Number of waiting jobs linked to the session. */
+    /**
+     * Number of waiting jobs linked to the session.
+     */
     waitingJobCount: number;
-    /** Number of finished jobs linked to the session. */
+    /**
+     * Number of finished jobs linked to the session.
+     */
     finishedJobCount: number;
-    /** Status of the session. */
+    /**
+     * Status of the session.
+     */
     status: SessionStatus;
-    /** Project ID in which the session has been created. */
+    /**
+     * Project ID in which the session has been created.
+     */
     projectId: string;
-    /** Tags of the session. */
+    /**
+     * Tags of the session.
+     */
     tags?: string[];
-    /** Deduplication ID of the session. */
+    /**
+     * Deduplication ID of the session.
+     */
     deduplicationId: string;
-    /** Resource type that creates the session. */
+    /**
+     * Resource type that creates the session.
+     */
     originType: SessionOriginType;
-    /** Unique ID of the session's origin resource (if exists). */
+    /**
+     * Unique ID of the session's origin resource (if exists).
+     */
     originId?: string;
-    /** Any progress of the session. */
+    /**
+     * Any progress of the session.
+     */
     progressMessage?: string;
 }
 export type CancelJobRequest = {
-    /** Unique ID of the job. */
+    /**
+     * Unique ID of the job.
+     */
     jobId: string;
 };
 export type CancelProcessRequest = {
-    /** Unique ID of the process. */
+    /**
+     * Unique ID of the process.
+     */
     processId: string;
 };
 export type CreateJobRequest = {
-    /** Name of the job. */
+    /**
+     * Name of the job.
+     */
     name: string;
-    /** Tags of the job. */
+    /**
+     * Tags of the job.
+     */
     tags?: string[];
-    /** Session in which the job is executed. */
+    /**
+     * Session in which the job is executed.
+     */
     sessionId: string;
-    /** Quantum circuit that should be executed. */
+    /**
+     * Quantum circuit that should be executed.
+     */
     circuit: JobCircuit;
-    /** Maximum duration of the job. */
+    /**
+     * Maximum duration of the job.
+     */
     maxDuration?: string;
 };
 export type CreateProcessRequest = {
-    /** ID of the project in which the process was created. */
+    /**
+     * ID of the project in which the process was created.
+     */
     projectId?: string;
-    /** ID of the platform for which the process was created. */
+    /**
+     * ID of the platform for which the process was created.
+     */
     platformId?: string;
-    /** ID of the application for which the process was created. */
+    /**
+     * ID of the application for which the process was created.
+     */
     applicationId?: string;
-    /** Name of the process. */
+    /**
+     * Name of the process.
+     */
     name: string;
-    /** Process parameters in JSON format. */
+    /**
+     * Process parameters in JSON format.
+     */
     input?: string;
-    /** Tags of the process. */
+    /**
+     * Tags of the process.
+     */
     tags?: string[];
 };
 export type CreateSessionRequest = {
-    /** ID of the Project in which the session was created. */
+    /**
+     * ID of the Project in which the session was created.
+     */
     projectId?: string;
-    /** ID of the Platform for which the session was created. */
+    /**
+     * ID of the Platform for which the session was created.
+     */
     platformId: string;
-    /** Name of the session. */
+    /**
+     * Name of the session.
+     */
     name?: string;
-    /** Maximum idle duration before the session ends. */
+    /**
+     * Maximum idle duration before the session ends.
+     */
     maxIdleDuration?: string;
-    /** Maximum duration before the session ends. */
+    /**
+     * Maximum duration before the session ends.
+     */
     maxDuration?: string;
-    /** Tags of the session. */
+    /**
+     * Tags of the session.
+     */
     tags?: string[];
-    /** Deduplication ID of the session. */
+    /**
+     * Deduplication ID of the session.
+     */
     deduplicationId?: string;
 };
 export type DeleteJobRequest = {
-    /** Unique ID of the job. */
+    /**
+     * Unique ID of the job.
+     */
     jobId: string;
 };
 export type DeleteProcessRequest = {
-    /** Unique ID of the process. */
+    /**
+     * Unique ID of the process.
+     */
     processId: string;
 };
 export type DeleteSessionRequest = {
-    /** Unique ID of the session. */
+    /**
+     * Unique ID of the session.
+     */
     sessionId: string;
 };
 export type GetApplicationRequest = {
-    /** Unique ID of the application. */
+    /**
+     * Unique ID of the application.
+     */
     applicationId: string;
 };
 export type GetJobCircuitRequest = {
-    /** Unique ID of the job. */
+    /**
+     * Unique ID of the job.
+     */
     jobId: string;
 };
 export type GetJobRequest = {
-    /** Unique ID of the job you want to get. */
+    /**
+     * Unique ID of the job you want to get.
+     */
     jobId: string;
 };
 export type GetPlatformRequest = {
-    /** Unique ID of the platform. */
+    /**
+     * Unique ID of the platform.
+     */
     platformId: string;
 };
 export type GetProcessRequest = {
-    /** Unique ID of the process. */
+    /**
+     * Unique ID of the process.
+     */
     processId: string;
 };
 export type GetSessionRequest = {
-    /** Unique ID of the session. */
+    /**
+     * Unique ID of the session.
+     */
     sessionId: string;
 };
 export type ListApplicationsRequest = {
-    /** List applications with this name. */
+    /**
+     * List applications with this name.
+     */
     name?: string;
-    /** List applications with this type. */
+    /**
+     * List applications with this type.
+     */
     applicationType?: ApplicationType;
-    /** Page number. */
+    /**
+     * Page number.
+     */
     page?: number;
-    /** Maximum number of applications a to return per page. */
+    /**
+     * Maximum number of applications a to return per page.
+     */
     pageSize?: number;
-    /** Sort order of the returned applications. */
+    /**
+     * Sort order of the returned applications.
+     */
     orderBy?: ListApplicationsRequestOrderBy;
 };
 export interface ListApplicationsResponse {
-    /** Total number of applications. */
+    /**
+     * Total number of applications.
+     */
     totalCount: number;
-    /** List of applications. */
+    /**
+     * List of applications.
+     */
     applications: Application[];
 }
 export type ListJobResultsRequest = {
-    /** ID of the job. */
+    /**
+     * ID of the job.
+     */
     jobId: string;
-    /** Page number. */
+    /**
+     * Page number.
+     */
     page?: number;
-    /** Maximum number of results to return per page. */
+    /**
+     * Maximum number of results to return per page.
+     */
     pageSize?: number;
-    /** Sort order of the returned results. */
+    /**
+     * Sort order of the returned results.
+     */
     orderBy?: ListJobResultsRequestOrderBy;
 };
 export interface ListJobResultsResponse {
-    /** Total number of results. */
+    /**
+     * Total number of results.
+     */
     totalCount: number;
-    /** List of results. */
+    /**
+     * List of results.
+     */
     jobResults: JobResult[];
 }
 export type ListJobsRequest = {
     /**
      * List jobs with this session ID.
      *
-     * One-of ('resourceId'): at most one of 'sessionId', 'projectId' could be
-     * set.
+     * One-of ('resourceId'): at most one of 'sessionId', 'projectId' could be set.
      */
     sessionId?: string;
     /**
      * List jobs with this project ID.
      *
-     * One-of ('resourceId'): at most one of 'sessionId', 'projectId' could be
-     * set.
+     * One-of ('resourceId'): at most one of 'sessionId', 'projectId' could be set.
      */
     projectId?: string;
-    /** List jobs with these tags. */
+    /**
+     * List jobs with these tags.
+     */
     tags?: string[];
-    /** Page number. */
+    /**
+     * Page number.
+     */
     page?: number;
-    /** Maximum number of jobs to return per page. */
+    /**
+     * Maximum number of jobs to return per page.
+     */
     pageSize?: number;
-    /** Sort order of the returned jobs. */
+    /**
+     * Sort order of the returned jobs.
+     */
     orderBy?: ListJobsRequestOrderBy;
 };
 export interface ListJobsResponse {
-    /** Total number of jobs. */
+    /**
+     * Total number of jobs.
+     */
     totalCount: number;
-    /** List of jobs. */
+    /**
+     * List of jobs.
+     */
     jobs: Job[];
 }
 export type ListPlatformsRequest = {
-    /** List platforms with this provider name. */
+    /**
+     * List platforms with this provider name.
+     */
     providerName?: string;
-    /** List platforms with this backend name. */
+    /**
+     * List platforms with this backend name.
+     */
     backendName?: string;
-    /** List platforms with this name. */
+    /**
+     * List platforms with this name.
+     */
     name?: string;
-    /** List platforms with this type. */
+    /**
+     * List platforms with this type.
+     */
     platformType?: PlatformType;
-    /** List platforms with this technology. */
+    /**
+     * List platforms with this technology.
+     */
     platformTechnology?: PlatformTechnology;
-    /** Page number. */
+    /**
+     * Page number.
+     */
     page?: number;
-    /** Maximum number of platforms to return per page. */
+    /**
+     * Maximum number of platforms to return per page.
+     */
     pageSize?: number;
-    /** Sort order of the returned platforms. */
+    /**
+     * Sort order of the returned platforms.
+     */
     orderBy?: ListPlatformsRequestOrderBy;
 };
 export interface ListPlatformsResponse {
-    /** Total number of platforms. */
+    /**
+     * Total number of platforms.
+     */
     totalCount: number;
-    /** List of platforms. */
+    /**
+     * List of platforms.
+     */
     platforms: Platform[];
 }
 export type ListProcessResultsRequest = {
-    /** ID of the process. */
+    /**
+     * ID of the process.
+     */
     processId: string;
-    /** Page number. */
+    /**
+     * Page number.
+     */
     page?: number;
-    /** Maximum number of results to return per page. */
+    /**
+     * Maximum number of results to return per page.
+     */
     pageSize?: number;
-    /** Sort order of the returned results. */
+    /**
+     * Sort order of the returned results.
+     */
     orderBy?: ListProcessResultsRequestOrderBy;
 };
 export interface ListProcessResultsResponse {
-    /** Total number of results. */
+    /**
+     * Total number of results.
+     */
     totalCount: number;
-    /** List of results. */
+    /**
+     * List of results.
+     */
     processResults: ProcessResult[];
 }
 export type ListProcessesRequest = {
-    /** List processes that have been created for this application. */
+    /**
+     * List processes that have been created for this application.
+     */
     applicationId?: string;
-    /** List processes with these tags. */
+    /**
+     * List processes with these tags.
+     */
     tags?: string[];
-    /** Page number. */
+    /**
+     * Page number.
+     */
     page?: number;
-    /** Maximum number of processes to return per page. */
+    /**
+     * Maximum number of processes to return per page.
+     */
     pageSize?: number;
-    /** Sort order of the returned processes. */
+    /**
+     * Sort order of the returned processes.
+     */
     orderBy?: ListProcessesRequestOrderBy;
-    /** List processes belonging to this project ID. */
+    /**
+     * List processes belonging to this project ID.
+     */
     projectId?: string;
 };
 export interface ListProcessesResponse {
-    /** Total number of processes. */
+    /**
+     * Total number of processes.
+     */
     totalCount: number;
-    /** List of processes. */
+    /**
+     * List of processes.
+     */
     processes: Process[];
 }
 export type ListSessionACLsRequest = {
@@ -417,54 +705,94 @@ export interface ListSessionACLsResponse {
     acls: SessionAccess[];
 }
 export type ListSessionsRequest = {
-    /** List sessions that have been created for this platform. */
+    /**
+     * List sessions that have been created for this platform.
+     */
     platformId?: string;
-    /** List sessions with these tags. */
+    /**
+     * List sessions with these tags.
+     */
     tags?: string[];
-    /** Page number. */
+    /**
+     * Page number.
+     */
     page?: number;
-    /** Maximum number of sessions to return per page. */
+    /**
+     * Maximum number of sessions to return per page.
+     */
     pageSize?: number;
-    /** Sort order of the returned sessions. */
+    /**
+     * Sort order of the returned sessions.
+     */
     orderBy?: ListSessionsRequestOrderBy;
-    /** List sessions belonging to this project ID. */
+    /**
+     * List sessions belonging to this project ID.
+     */
     projectId?: string;
 };
 export interface ListSessionsResponse {
-    /** Total number of sessions. */
+    /**
+     * Total number of sessions.
+     */
     totalCount: number;
-    /** List of sessions. */
+    /**
+     * List of sessions.
+     */
     sessions: Session[];
 }
 export type TerminateSessionRequest = {
-    /** Unique ID of the session. */
+    /**
+     * Unique ID of the session.
+     */
     sessionId: string;
 };
 export type UpdateJobRequest = {
-    /** Unique ID of the job. */
+    /**
+     * Unique ID of the job.
+     */
     jobId: string;
-    /** Name of the job. */
+    /**
+     * Name of the job.
+     */
     name?: string;
-    /** Tags of the job. */
+    /**
+     * Tags of the job.
+     */
     tags?: string[];
 };
 export type UpdateProcessRequest = {
-    /** Unique ID of the process. */
+    /**
+     * Unique ID of the process.
+     */
     processId: string;
-    /** Name of the process. */
+    /**
+     * Name of the process.
+     */
     name?: string;
-    /** Tags of the process. */
+    /**
+     * Tags of the process.
+     */
     tags?: string[];
 };
 export type UpdateSessionRequest = {
-    /** Unique ID of the session. */
+    /**
+     * Unique ID of the session.
+     */
     sessionId: string;
-    /** Name of the session. */
+    /**
+     * Name of the session.
+     */
     name?: string;
-    /** Maximum idle duration before the session ends. */
+    /**
+     * Maximum idle duration before the session ends.
+     */
     maxIdleDuration?: string;
-    /** Maximum time before the session ends. */
+    /**
+     * Maximum time before the session ends.
+     */
     maxDuration?: string;
-    /** Tags of the session. */
+    /**
+     * Tags of the session.
+     */
     tags?: string[];
 };