qaas

type API struct {
	// contains filtered or unexported fields
}

type Application struct {
	// ID: unique ID of the application.
	ID string `json:"id"`

	// Name: name of the application.
	Name string `json:"name"`

	// Type: type of the application.
	// Default value: unknown_type
	Type ApplicationType `json:"type"`

	// CompatiblePlatformIDs: list of compatible platform (by IDs) able to run this application.
	CompatiblePlatformIDs []string `json:"compatible_platform_ids"`

	// InputTemplate: JSON format describing the expected input.
	InputTemplate string `json:"input_template"`
}

type ApplicationType string

type Booking struct {
	// ID: unique ID of the booking.
	ID string `json:"id"`

	// CreatedAt: time at which the booking was created.
	CreatedAt *time.Time `json:"created_at"`

	// StartedAt: time at which the booking starts.
	StartedAt *time.Time `json:"started_at"`

	// UpdatedAt: time at which the booking was updated.
	UpdatedAt *time.Time `json:"updated_at"`

	// FinishedAt: time at which the booking finishes.
	FinishedAt *time.Time `json:"finished_at"`

	// Status: status of the booking.
	// Default value: unknown_status
	Status BookingStatus `json:"status"`

	// Description: description of the booking slot.
	Description string `json:"description"`

	// ProgressMessage: any progress message of the booking.
	ProgressMessage string `json:"progress_message"`
}

type BookingStatus string

type CancelJobRequest struct {
	// JobID: unique ID of the job.
	JobID string `json:"-"`
}

type CancelProcessRequest struct {
	// ProcessID: unique ID of the process.
	ProcessID string `json:"-"`
}

type CreateJobRequest struct {
	// Name: name of the job.
	Name string `json:"name"`

	// Tags: tags of the job.
	Tags *[]string `json:"tags,omitempty"`

	// SessionID: session in which the job is executed.
	SessionID string `json:"session_id"`

	// Circuit: quantum circuit that should be executed.
	Circuit *JobCircuit `json:"circuit"`

	// MaxDuration: maximum duration of the job.
	MaxDuration *scw.Duration `json:"max_duration,omitempty"`

	// ModelID: computation model ID to be executed by the job.
	ModelID *string `json:"model_id,omitempty"`

	// Parameters: execution parameters for this job.
	Parameters *string `json:"parameters,omitempty"`
}

type CreateModelRequest struct {
	// ProjectID: project ID to attach this model.
	ProjectID string `json:"project_id"`

	// Payload: the serialized model data.
	Payload *string `json:"payload,omitempty"`
}

type CreateProcessRequest struct {
	// ProjectID: ID of the project in which the process was created.
	ProjectID string `json:"project_id"`

	// PlatformID: ID of the platform for which the process was created.
	PlatformID *string `json:"platform_id,omitempty"`

	// ApplicationID: ID of the application for which the process was created.
	ApplicationID *string `json:"application_id,omitempty"`

	// Name: name of the process.
	Name string `json:"name"`

	// Input: process parameters in JSON format.
	Input *string `json:"input,omitempty"`

	// Tags: tags of the process.
	Tags []string `json:"tags"`
}

type CreateSessionRequest struct {
	// ProjectID: ID of the Project in which the session was created.
	ProjectID string `json:"project_id"`

	// PlatformID: ID of the Platform for which the session was created.
	PlatformID string `json:"platform_id"`

	// Name: name of the session.
	Name *string `json:"name,omitempty"`

	// MaxIDleDuration: maximum idle duration before the session ends.
	MaxIDleDuration *scw.Duration `json:"max_idle_duration,omitempty"`

	// MaxDuration: maximum duration before the session ends.
	MaxDuration *scw.Duration `json:"max_duration,omitempty"`

	// Tags: tags of the session.
	Tags *[]string `json:"tags,omitempty"`

	// DeduplicationID: deduplication ID of the session.
	DeduplicationID *string `json:"deduplication_id,omitempty"`

	// BookingDemand: a booking demand to schedule the session, only applicable if the platform is bookable.
	BookingDemand *CreateSessionRequestBookingDemand `json:"booking_demand,omitempty"`

	// ModelID: default computation model ID to be executed by job assigned to this session.
	ModelID *string `json:"model_id,omitempty"`

	// Parameters: optional platform configuration parameters applied to this session.
	Parameters *string `json:"parameters,omitempty"`
}

type CreateSessionRequestBookingDemand struct {
	StartedAt *time.Time `json:"started_at"`

	FinishedAt *time.Time `json:"finished_at"`

	Description *string `json:"description"`
}

type DeleteJobRequest struct {
	// JobID: unique ID of the job.
	JobID string `json:"-"`
}

type DeleteProcessRequest struct {
	// ProcessID: unique ID of the process.
	ProcessID string `json:"-"`
}

type DeleteSessionRequest struct {
	// SessionID: unique ID of the session.
	SessionID string `json:"-"`
}

type GetApplicationRequest struct {
	// ApplicationID: unique ID of the application.
	ApplicationID string `json:"-"`
}

type GetBookingRequest struct {
	// BookingID: unique ID of the booking.
	BookingID string `json:"-"`
}

type GetJobCircuitRequest struct {
	// JobID: unique ID of the job.
	JobID string `json:"-"`
}

type GetJobRequest struct {
	// JobID: unique ID of the job you want to get.
	JobID string `json:"-"`
}

type GetModelRequest struct {
	// ModelID: unique ID of the model.
	ModelID string `json:"-"`
}

type GetPlatformRequest struct {
	// PlatformID: unique ID of the platform.
	PlatformID string `json:"-"`
}

type GetProcessRequest struct {
	// ProcessID: unique ID of the process.
	ProcessID string `json:"-"`
}

type GetSessionRequest struct {
	// SessionID: unique ID of the session.
	SessionID string `json:"-"`
}

type Job struct {
	// ID: unique ID of the job.
	ID string `json:"id"`

	// Name: job name.
	Name string `json:"name"`

	// Tags: tags of the job.
	Tags *[]string `json:"tags"`

	// SessionID: session ID in which the job is executed.
	SessionID string `json:"session_id"`

	// CreatedAt: time at which the job was created.
	CreatedAt *time.Time `json:"created_at"`

	// StartedAt: time at which the job was started.
	StartedAt *time.Time `json:"started_at"`

	// UpdatedAt: time at which the job was updated.
	UpdatedAt *time.Time `json:"updated_at"`

	// Status: job status.
	// Default value: unknown_status
	Status JobStatus `json:"status"`

	// ProgressMessage: last progress message, if the job has started.
	ProgressMessage *string `json:"progress_message"`

	// JobDuration: duration of the job, if the job is finished.
	JobDuration *scw.Duration `json:"job_duration"`

	// ResultDistribution: result of the job, if the job is finished.
	ResultDistribution *string `json:"result_distribution"`

	// ModelID: computation model ID executed by the job.
	ModelID *string `json:"model_id"`

	// Parameters: execution parameters for this job.
	Parameters *string `json:"parameters"`
}

type JobCircuit struct {
	// PercevalCircuit: circuit generated by Perceval that should be executed.
	// Precisely one of PercevalCircuit, QiskitCircuit must be set.
	PercevalCircuit *string `json:"perceval_circuit,omitempty"`

	// QiskitCircuit: circuit generated by Qiskit that should be executed.
	// Precisely one of PercevalCircuit, QiskitCircuit must be set.
	QiskitCircuit *string `json:"qiskit_circuit,omitempty"`
}

type JobResult struct {
	// JobID: ID of the parent job.
	JobID string `json:"job_id"`

	// Result: result in JSON format.
	Result *string `json:"result"`

	// URL: URL to download a large result (optional).
	URL *string `json:"url"`

	// CreatedAt: creation time of the result.
	CreatedAt *time.Time `json:"created_at"`
}

type JobStatus string

type ListApplicationsRequest struct {
	// Name: list applications with this name.
	Name *string `json:"-"`

	// ApplicationType: list applications with this type.
	// Default value: unknown_type
	ApplicationType ApplicationType `json:"-"`

	// Page: page number.
	Page *int32 `json:"-"`

	// PageSize: maximum number of applications a to return per page.
	PageSize *uint32 `json:"-"`

	// OrderBy: sort order of the returned applications.
	// Default value: name_asc
	OrderBy ListApplicationsRequestOrderBy `json:"-"`
}

type ListApplicationsRequestOrderBy string

type ListApplicationsResponse struct {
	// TotalCount: total number of applications.
	TotalCount uint64 `json:"total_count"`

	// Applications: list of applications.
	Applications []*Application `json:"applications"`
}

type ListBookingsRequest struct {
	// ProjectID: list bookings belonging to this project ID.
	ProjectID *string `json:"-"`

	// PlatformID: list bookings attached to this platform ID.
	PlatformID *string `json:"-"`

	// Page: page number.
	Page *int32 `json:"-"`

	// PageSize: maximum number of results to return per page.
	PageSize *uint32 `json:"-"`

	// OrderBy: sort order of the returned results.
	// Default value: created_at_desc
	OrderBy ListBookingsRequestOrderBy `json:"-"`
}

type ListBookingsRequestOrderBy string

type ListBookingsResponse struct {
	// TotalCount: total number of bookings.
	TotalCount uint64 `json:"total_count"`

	// Bookings: list of bookings.
	Bookings []*Booking `json:"bookings"`
}

type ListJobResultsRequest struct {
	// JobID: ID of the job.
	JobID string `json:"-"`

	// Page: page number.
	Page *int32 `json:"-"`

	// PageSize: maximum number of results to return per page.
	PageSize *uint32 `json:"-"`

	// OrderBy: sort order of the returned results.
	// Default value: created_at_desc
	OrderBy ListJobResultsRequestOrderBy `json:"-"`
}

type ListJobResultsRequestOrderBy string

type ListJobResultsResponse struct {
	// TotalCount: total number of results.
	TotalCount uint64 `json:"total_count"`

	// JobResults: list of results.
	JobResults []*JobResult `json:"job_results"`
}

type ListJobsRequest struct {
	// SessionID: list jobs with this session ID.
	// Precisely one of SessionID, ProjectID must be set.
	SessionID *string `json:"session_id,omitempty"`

	// ProjectID: list jobs with this project ID.
	// Precisely one of SessionID, ProjectID must be set.
	ProjectID *string `json:"project_id,omitempty"`

	// Tags: list jobs with these tags.
	Tags []string `json:"-"`

	// Page: page number.
	Page *int32 `json:"-"`

	// PageSize: maximum number of jobs to return per page.
	PageSize *uint32 `json:"-"`

	// OrderBy: sort order of the returned jobs.
	// Default value: created_at_desc
	OrderBy ListJobsRequestOrderBy `json:"-"`
}

type ListJobsRequestOrderBy string

type ListJobsResponse struct {
	// TotalCount: total number of jobs.
	TotalCount uint64 `json:"total_count"`

	// Jobs: list of jobs.
	Jobs []*Job `json:"jobs"`
}

type ListModelsRequest struct {
	// ProjectID: list models belonging to this project ID.
	ProjectID string `json:"-"`

	// Page: page number.
	Page *int32 `json:"-"`

	// PageSize: maximum number of results to return per page.
	PageSize *uint32 `json:"-"`

	// OrderBy: sort order of the returned results.
	// Default value: created_at_desc
	OrderBy ListModelsRequestOrderBy `json:"-"`
}

type ListModelsRequestOrderBy string

type ListModelsResponse struct {
	// TotalCount: total number of models.
	TotalCount uint64 `json:"total_count"`

	// Models: list of models.
	Models []*Model `json:"models"`
}

type ListPlatformsRequest struct {
	// ProviderName: list platforms with this provider name.
	ProviderName *string `json:"-"`

	// BackendName: list platforms with this backend name.
	BackendName *string `json:"-"`

	// Name: list platforms with this name.
	Name *string `json:"-"`

	// PlatformType: list platforms with this type.
	// Default value: unknown_type
	PlatformType PlatformType `json:"-"`

	// PlatformTechnology: list platforms with this technology.
	// Default value: unknown_technology
	PlatformTechnology PlatformTechnology `json:"-"`

	// Page: page number.
	Page *int32 `json:"-"`

	// PageSize: maximum number of platforms to return per page.
	PageSize *uint32 `json:"-"`

	// OrderBy: sort order of the returned platforms.
	// Default value: name_asc
	OrderBy ListPlatformsRequestOrderBy `json:"-"`
}

type ListPlatformsRequestOrderBy string

type ListPlatformsResponse struct {
	// TotalCount: total number of platforms.
	TotalCount uint64 `json:"total_count"`

	// Platforms: list of platforms.
	Platforms []*Platform `json:"platforms"`
}

type ListProcessResultsRequest struct {
	// ProcessID: ID of the process.
	ProcessID string `json:"-"`

	// Page: page number.
	Page *int32 `json:"-"`

	// PageSize: maximum number of results to return per page.
	PageSize *uint32 `json:"-"`

	// OrderBy: sort order of the returned results.
	// Default value: created_at_desc
	OrderBy ListProcessResultsRequestOrderBy `json:"-"`
}

type ListProcessResultsRequestOrderBy string

type ListProcessResultsResponse struct {
	// TotalCount: total number of results.
	TotalCount uint64 `json:"total_count"`

	// ProcessResults: list of results.
	ProcessResults []*ProcessResult `json:"process_results"`
}

type ListProcessesRequest struct {
	// ApplicationID: list processes that have been created for this application.
	ApplicationID *string `json:"-"`

	// Tags: list processes with these tags.
	Tags []string `json:"-"`

	// Page: page number.
	Page *int32 `json:"-"`

	// PageSize: maximum number of processes to return per page.
	PageSize *uint32 `json:"-"`

	// OrderBy: sort order of the returned processes.
	// Default value: created_at_desc
	OrderBy ListProcessesRequestOrderBy `json:"-"`

	// ProjectID: list processes belonging to this project ID.
	ProjectID string `json:"-"`
}

type ListProcessesRequestOrderBy string

type ListProcessesResponse struct {
	// TotalCount: total number of processes.
	TotalCount uint64 `json:"total_count"`

	// Processes: list of processes.
	Processes []*Process `json:"processes"`
}

type ListSessionACLsRequest struct {
	SessionID string `json:"-"`

	Page *int32 `json:"-"`

	PageSize *uint32 `json:"-"`

	// OrderBy: default value: access_asc
	OrderBy ListSessionACLsRequestOrderBy `json:"-"`
}

type ListSessionACLsRequestOrderBy string

type ListSessionACLsResponse struct {
	TotalCount uint64 `json:"total_count"`

	ACLs []SessionAccess `json:"acls"`
}

type ListSessionsRequest struct {
	// PlatformID: list sessions that have been created for this platform.
	PlatformID *string `json:"-"`

	// Tags: list sessions with these tags.
	Tags []string `json:"-"`

	// Page: page number.
	Page *int32 `json:"-"`

	// PageSize: maximum number of sessions to return per page.
	PageSize *uint32 `json:"-"`

	// OrderBy: sort order of the returned sessions.
	// Default value: name_asc
	OrderBy ListSessionsRequestOrderBy `json:"-"`

	// ProjectID: list sessions belonging to this project ID.
	ProjectID string `json:"-"`
}

type ListSessionsRequestOrderBy string

type ListSessionsResponse struct {
	// TotalCount: total number of sessions.
	TotalCount uint64 `json:"total_count"`

	// Sessions: list of sessions.
	Sessions []*Session `json:"sessions"`
}

type Model struct {
	// ID: unique ID of the model.
	ID string `json:"id"`

	// CreatedAt: time at which the model was created.
	CreatedAt *time.Time `json:"created_at"`

	// URL: storage URL of the model.
	URL *string `json:"url"`

	// ProjectID: project ID in which the model has been created.
	ProjectID string `json:"project_id"`
}

type Platform struct {
	// ID: unique ID of the platform.
	ID string `json:"id"`

	// Version: version of the platform.
	Version string `json:"version"`

	// Name: name of the platform.
	Name string `json:"name"`

	// ProviderName: provider name of the platform.
	ProviderName string `json:"provider_name"`

	// BackendName: name of the running backend over the platform (ascella, qsim, aer...).
	BackendName string `json:"backend_name"`

	// Type: type of the platform.
	// Default value: unknown_type
	Type PlatformType `json:"type"`

	// Technology: technology used by the platform.
	// Default value: unknown_technology
	Technology PlatformTechnology `json:"technology"`

	// MaxQubitCount: estimated maximum number of qubits supported by the platform.
	MaxQubitCount uint32 `json:"max_qubit_count"`

	// MaxShotCount: maximum number of shots during a circuit execution.
	MaxShotCount uint32 `json:"max_shot_count"`

	// MaxCircuitCount: maximum number of circuit that can be executed in one call.
	MaxCircuitCount uint32 `json:"max_circuit_count"`

	// Availability: availability of the platform.
	// Default value: unknown_availability
	Availability PlatformAvailability `json:"availability"`

	// Metadata: metadata provided by the platform.
	Metadata string `json:"metadata"`

	// PricePerHour: price to be paid per hour (excluding free tiers).
	PricePerHour *scw.Money `json:"price_per_hour"`

	// PricePerShot: price to be paid per shot (excluding free tiers).
	PricePerShot *scw.Money `json:"price_per_shot"`

	// PricePerCircuit: price to be paid per circuit setup before its execution (excluding free tiers).
	PricePerCircuit *scw.Money `json:"price_per_circuit"`

	// Hardware: specifications of the underlying hardware.
	Hardware *PlatformHardware `json:"hardware"`

	// BookingRequirement: booking constraints to fit if the platform is bookable.
	BookingRequirement *PlatformBookingRequirement `json:"booking_requirement"`

	// Description: english description of the platform.
	Description string `json:"description"`

	// DocumentationURL: documentation link to external documentation to learn more on this platform.
	DocumentationURL string `json:"documentation_url"`

	// IsBookable: specify if the platform is bookable.
	IsBookable bool `json:"is_bookable"`
}

type PlatformAvailability string

type PlatformBookingRequirement struct {
	// MinDuration: minimal duration of any booking based on this platform.
	MinDuration *scw.Duration `json:"min_duration"`

	// MaxDuration: maximal duration of any bookings based on this platform.
	MaxDuration *scw.Duration `json:"max_duration"`

	// MaxCancellationDuration: allowed time to cancel a booking attached to this platform before the beginning of the session.
	MaxCancellationDuration *scw.Duration `json:"max_cancellation_duration"`

	// MaxPlanificationDuration: allowed planification time from now where the platform can be booked in the future.
	MaxPlanificationDuration *scw.Duration `json:"max_planification_duration"`
}

type PlatformHardware struct {
	// Name: product name of the hardware.
	Name string `json:"name"`

	// Vcpus: number of vCPUs available.
	Vcpus uint32 `json:"vcpus"`

	// Gpus: number of GPUs available (0 if no GPU).
	Gpus uint32 `json:"gpus"`

	// GpusNetwork: network topology of GPUs (PCIe, NVLink...).
	GpusNetwork string `json:"gpus_network"`

	// RAM: amount of RAM available in byte.
	RAM uint64 `json:"ram"`

	// Vram: amount of VRAM available in byte (0 if no GPU).
	Vram uint64 `json:"vram"`
}

type PlatformTechnology string

type PlatformType string

type Process struct {
	// ID: unique ID of the process.
	ID string `json:"id"`

	// Name: name of the process.
	Name string `json:"name"`

	// ApplicationID: application ID for which the process has been created.
	ApplicationID *string `json:"application_id"`

	// PlatformID: platform ID for which the process has been created.
	PlatformID *string `json:"platform_id"`

	// AttachedSessionIDs: list of sessions generated by the process.
	AttachedSessionIDs []string `json:"attached_session_ids"`

	// CreatedAt: time at which the process was created.
	CreatedAt *time.Time `json:"created_at"`

	// StartedAt: time at which the process started.
	StartedAt *time.Time `json:"started_at"`

	// UpdatedAt: time at which the process was updated.
	UpdatedAt *time.Time `json:"updated_at"`

	// FinishedAt: time at which the process was finished.
	FinishedAt *time.Time `json:"finished_at"`

	// Status: status of the process.
	// Default value: unknown_status
	Status ProcessStatus `json:"status"`

	// ProjectID: project ID in which the process has been created.
	ProjectID string `json:"project_id"`

	// Tags: tags of the process.
	Tags []string `json:"tags"`

	// Progress: progress of the process, from 0 to 1.
	Progress *uint32 `json:"progress"`

	// ProgressMessage: any progress of the process.
	ProgressMessage *string `json:"progress_message"`

	// Input: input payload of the process as JSON string.
	Input *string `json:"input"`
}

type ProcessResult struct {
	// ProcessID: ID of the parent process.
	ProcessID string `json:"process_id"`

	// Result: result in JSON format.
	Result string `json:"result"`

	// CreatedAt: creation time of the result.
	CreatedAt *time.Time `json:"created_at"`
}

type ProcessStatus string

type Session struct {
	// ID: unique ID of the session.
	ID string `json:"id"`

	// Name: name of the session.
	Name string `json:"name"`

	// PlatformID: platform ID for which the session has been created.
	PlatformID string `json:"platform_id"`

	// CreatedAt: the time at which the session was created.
	CreatedAt *time.Time `json:"created_at"`

	// StartedAt: the time at which the session started.
	StartedAt *time.Time `json:"started_at"`

	// UpdatedAt: the time at which the session was updated.
	UpdatedAt *time.Time `json:"updated_at"`

	// TerminatedAt: the time at which the session was terminated.
	TerminatedAt *time.Time `json:"terminated_at"`

	// MaxIDleDuration: maximum idle time before the session ends.
	MaxIDleDuration *scw.Duration `json:"max_idle_duration"`

	// MaxDuration: maximum duration before the session ends.
	MaxDuration *scw.Duration `json:"max_duration"`

	// WaitingJobCount: number of waiting jobs linked to the session.
	WaitingJobCount uint64 `json:"waiting_job_count"`

	// FinishedJobCount: number of finished jobs linked to the session.
	FinishedJobCount uint64 `json:"finished_job_count"`

	// Status: status of the session.
	// Default value: unknown_status
	Status SessionStatus `json:"status"`

	// ProjectID: project ID in which the session has been created.
	ProjectID string `json:"project_id"`

	// Tags: tags of the session.
	Tags *[]string `json:"tags"`

	// DeduplicationID: deduplication ID of the session.
	DeduplicationID string `json:"deduplication_id"`

	// OriginType: resource type that creates the session.
	// Default value: unknown_origin_type
	OriginType SessionOriginType `json:"origin_type"`

	// OriginID: unique ID of the session's origin resource (if exists).
	OriginID *string `json:"origin_id"`

	// ProgressMessage: any progress of the session.
	ProgressMessage *string `json:"progress_message"`

	// BookingID: an optional booking unique ID of an attached booking.
	BookingID *string `json:"booking_id"`

	// ModelID: default computation model ID to be executed by job assigned to this session.
	ModelID *string `json:"model_id"`

	// Parameters: platform configuration parameters applied to this session.
	Parameters *string `json:"parameters"`
}

type SessionAccess string

type SessionOriginType string

type SessionStatus string

type TerminateSessionRequest struct {
	// SessionID: unique ID of the session.
	SessionID string `json:"-"`
}

type UpdateBookingRequest struct {
	// BookingID: unique ID of the booking.
	BookingID string `json:"-"`

	// Description: description of the booking slot.
	Description *string `json:"description,omitempty"`
}

type UpdateJobRequest struct {
	// JobID: unique ID of the job.
	JobID string `json:"-"`

	// Name: name of the job.
	Name *string `json:"name,omitempty"`

	// Tags: tags of the job.
	Tags *[]string `json:"tags,omitempty"`
}

type UpdateProcessRequest struct {
	// ProcessID: unique ID of the process.
	ProcessID string `json:"-"`

	// Name: name of the process.
	Name *string `json:"name,omitempty"`

	// Tags: tags of the process.
	Tags *[]string `json:"tags,omitempty"`
}

type UpdateSessionRequest struct {
	// SessionID: unique ID of the session.
	SessionID string `json:"-"`

	// Name: name of the session.
	Name *string `json:"name,omitempty"`

	// MaxIDleDuration: maximum idle duration before the session ends.
	MaxIDleDuration *scw.Duration `json:"max_idle_duration,omitempty"`

	// MaxDuration: maximum time before the session ends.
	MaxDuration *scw.Duration `json:"max_duration,omitempty"`

	// Tags: tags of the session.
	Tags *[]string `json:"tags,omitempty"`
}