@scaleway/sdk-qaas 2.7.0 → 2.8.0

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

@@ -0,0 +1,28 @@
+import type { DefaultValues } from '@scaleway/sdk-client';
+import type { JobCircuit, Application, Booking, Job, Model, Platform, Process, Session, ListApplicationsResponse, ListBookingsResponse, ListJobResultsResponse, ListJobsResponse, ListModelsResponse, ListPlatformsResponse, ListProcessResultsResponse, ListProcessesResponse, ListSessionACLsResponse, ListSessionsResponse, CreateJobRequest, CreateModelRequest, CreateProcessRequest, CreateSessionRequest, 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;
+export declare const unmarshalJob: (data: unknown) => Job;
+export declare const unmarshalModel: (data: unknown) => Model;
+export declare const unmarshalPlatform: (data: unknown) => Platform;
+export declare const unmarshalProcess: (data: unknown) => Process;
+export declare const unmarshalSession: (data: unknown) => Session;
+export declare const unmarshalListApplicationsResponse: (data: unknown) => ListApplicationsResponse;
+export declare const unmarshalListBookingsResponse: (data: unknown) => ListBookingsResponse;
+export declare const unmarshalListJobResultsResponse: (data: unknown) => ListJobResultsResponse;
+export declare const unmarshalListJobsResponse: (data: unknown) => ListJobsResponse;
+export declare const unmarshalListModelsResponse: (data: unknown) => ListModelsResponse;
+export declare const unmarshalListPlatformsResponse: (data: unknown) => ListPlatformsResponse;
+export declare const unmarshalListProcessResultsResponse: (data: unknown) => ListProcessResultsResponse;
+export declare const unmarshalListProcessesResponse: (data: unknown) => ListProcessesResponse;
+export declare const unmarshalListSessionACLsResponse: (data: unknown) => ListSessionACLsResponse;
+export declare const unmarshalListSessionsResponse: (data: unknown) => ListSessionsResponse;
+export declare const marshalCreateJobRequest: (request: CreateJobRequest, defaults: DefaultValues) => Record<string, unknown>;
+export declare const marshalCreateModelRequest: (request: CreateModelRequest, defaults: DefaultValues) => Record<string, unknown>;
+export declare const marshalCreateProcessRequest: (request: CreateProcessRequest, defaults: DefaultValues) => Record<string, unknown>;
+export declare const marshalCreateSessionRequest: (request: CreateSessionRequest, defaults: DefaultValues) => Record<string, unknown>;
+export declare const marshalUpdateBookingRequest: (request: UpdateBookingRequest, defaults: DefaultValues) => Record<string, unknown>;
+export declare const marshalUpdateJobRequest: (request: UpdateJobRequest, defaults: DefaultValues) => Record<string, unknown>;
+export declare const marshalUpdateProcessRequest: (request: UpdateProcessRequest, defaults: DefaultValues) => Record<string, unknown>;
+export declare const marshalUpdateSessionRequest: (request: UpdateSessionRequest, defaults: DefaultValues) => Record<string, unknown>;

package/dist/v1alpha1/marshalling.gen.js

@@ -0,0 +1,304 @@
+import { isJSONObject, resolveOneOf, unmarshalArrayOfObject, unmarshalDate, unmarshalMoney } from "@scaleway/sdk-client";
+//#region src/v1alpha1/marshalling.gen.ts
+const unmarshalJobCircuit = (data) => {
+	if (!isJSONObject(data)) throw new TypeError(`Unmarshalling the type 'JobCircuit' failed as data isn't a dictionary.`);
+	return {
+		percevalCircuit: data.perceval_circuit,
+		qiskitCircuit: data.qiskit_circuit
+	};
+};
+const unmarshalApplication = (data) => {
+	if (!isJSONObject(data)) throw new TypeError(`Unmarshalling the type 'Application' failed as data isn't a dictionary.`);
+	return {
+		compatiblePlatformIds: data.compatible_platform_ids,
+		id: data.id,
+		inputTemplate: data.input_template,
+		name: data.name,
+		type: data.type
+	};
+};
+const unmarshalBooking = (data) => {
+	if (!isJSONObject(data)) throw new TypeError(`Unmarshalling the type 'Booking' failed as data isn't a dictionary.`);
+	return {
+		createdAt: unmarshalDate(data.created_at),
+		description: data.description,
+		finishedAt: unmarshalDate(data.finished_at),
+		id: data.id,
+		progressMessage: data.progress_message,
+		startedAt: unmarshalDate(data.started_at),
+		status: data.status,
+		timeZone: data.time_zone,
+		updatedAt: unmarshalDate(data.updated_at)
+	};
+};
+const unmarshalJob = (data) => {
+	if (!isJSONObject(data)) throw new TypeError(`Unmarshalling the type 'Job' failed as data isn't a dictionary.`);
+	return {
+		createdAt: unmarshalDate(data.created_at),
+		id: data.id,
+		jobDuration: data.job_duration,
+		modelId: data.model_id,
+		name: data.name,
+		parameters: data.parameters,
+		progressMessage: data.progress_message,
+		resultDistribution: data.result_distribution,
+		sessionId: data.session_id,
+		startedAt: unmarshalDate(data.started_at),
+		status: data.status,
+		tags: data.tags,
+		updatedAt: unmarshalDate(data.updated_at)
+	};
+};
+const unmarshalModel = (data) => {
+	if (!isJSONObject(data)) throw new TypeError(`Unmarshalling the type 'Model' failed as data isn't a dictionary.`);
+	return {
+		createdAt: unmarshalDate(data.created_at),
+		id: data.id,
+		projectId: data.project_id,
+		url: data.url
+	};
+};
+const unmarshalPlatformBookingRequirement = (data) => {
+	if (!isJSONObject(data)) throw new TypeError(`Unmarshalling the type 'PlatformBookingRequirement' failed as data isn't a dictionary.`);
+	return {
+		maxBookingPerDay: data.max_booking_per_day,
+		maxBookingPerWeek: data.max_booking_per_week,
+		maxCancellationDuration: data.max_cancellation_duration,
+		maxDuration: data.max_duration,
+		maxPlanificationDuration: data.max_planification_duration,
+		minDuration: data.min_duration,
+		minPlanificationDuration: data.min_planification_duration
+	};
+};
+const unmarshalPlatformHardware = (data) => {
+	if (!isJSONObject(data)) throw new TypeError(`Unmarshalling the type 'PlatformHardware' failed as data isn't a dictionary.`);
+	return {
+		gpus: data.gpus,
+		gpusNetwork: data.gpus_network,
+		name: data.name,
+		ram: data.ram,
+		vcpus: data.vcpus,
+		vram: data.vram
+	};
+};
+const unmarshalPlatform = (data) => {
+	if (!isJSONObject(data)) throw new TypeError(`Unmarshalling the type 'Platform' failed as data isn't a dictionary.`);
+	return {
+		availability: data.availability,
+		backendName: data.backend_name,
+		bookingRequirement: data.booking_requirement ? unmarshalPlatformBookingRequirement(data.booking_requirement) : void 0,
+		description: data.description,
+		documentationUrl: data.documentation_url,
+		hardware: data.hardware ? unmarshalPlatformHardware(data.hardware) : void 0,
+		id: data.id,
+		isBookable: data.is_bookable,
+		maxCircuitCount: data.max_circuit_count,
+		maxQubitCount: data.max_qubit_count,
+		maxShotCount: data.max_shot_count,
+		metadata: data.metadata,
+		name: data.name,
+		pricePerCircuit: data.price_per_circuit ? unmarshalMoney(data.price_per_circuit) : void 0,
+		pricePerHour: data.price_per_hour ? unmarshalMoney(data.price_per_hour) : void 0,
+		pricePerShot: data.price_per_shot ? unmarshalMoney(data.price_per_shot) : void 0,
+		providerName: data.provider_name,
+		technology: data.technology,
+		type: data.type,
+		version: data.version
+	};
+};
+const unmarshalProcess = (data) => {
+	if (!isJSONObject(data)) throw new TypeError(`Unmarshalling the type 'Process' failed as data isn't a dictionary.`);
+	return {
+		applicationId: data.application_id,
+		attachedSessionIds: data.attached_session_ids,
+		createdAt: unmarshalDate(data.created_at),
+		finishedAt: unmarshalDate(data.finished_at),
+		id: data.id,
+		input: data.input,
+		name: data.name,
+		platformId: data.platform_id,
+		progress: data.progress,
+		progressMessage: data.progress_message,
+		projectId: data.project_id,
+		startedAt: unmarshalDate(data.started_at),
+		status: data.status,
+		tags: data.tags,
+		updatedAt: unmarshalDate(data.updated_at)
+	};
+};
+const unmarshalSession = (data) => {
+	if (!isJSONObject(data)) throw new TypeError(`Unmarshalling the type 'Session' failed as data isn't a dictionary.`);
+	return {
+		bookingId: data.booking_id,
+		createdAt: unmarshalDate(data.created_at),
+		deduplicationId: data.deduplication_id,
+		finishedJobCount: data.finished_job_count,
+		id: data.id,
+		maxDuration: data.max_duration,
+		maxIdleDuration: data.max_idle_duration,
+		modelId: data.model_id,
+		name: data.name,
+		originId: data.origin_id,
+		originType: data.origin_type,
+		parameters: data.parameters,
+		platformId: data.platform_id,
+		progressMessage: data.progress_message,
+		projectId: data.project_id,
+		startedAt: unmarshalDate(data.started_at),
+		status: data.status,
+		tags: data.tags,
+		terminatedAt: unmarshalDate(data.terminated_at),
+		updatedAt: unmarshalDate(data.updated_at),
+		waitingJobCount: data.waiting_job_count
+	};
+};
+const unmarshalListApplicationsResponse = (data) => {
+	if (!isJSONObject(data)) throw new TypeError(`Unmarshalling the type 'ListApplicationsResponse' failed as data isn't a dictionary.`);
+	return {
+		applications: unmarshalArrayOfObject(data.applications, unmarshalApplication),
+		totalCount: data.total_count
+	};
+};
+const unmarshalListBookingsResponse = (data) => {
+	if (!isJSONObject(data)) throw new TypeError(`Unmarshalling the type 'ListBookingsResponse' failed as data isn't a dictionary.`);
+	return {
+		bookings: unmarshalArrayOfObject(data.bookings, unmarshalBooking),
+		totalCount: data.total_count
+	};
+};
+const unmarshalJobResult = (data) => {
+	if (!isJSONObject(data)) throw new TypeError(`Unmarshalling the type 'JobResult' failed as data isn't a dictionary.`);
+	return {
+		createdAt: unmarshalDate(data.created_at),
+		jobId: data.job_id,
+		result: data.result,
+		url: data.url
+	};
+};
+const unmarshalListJobResultsResponse = (data) => {
+	if (!isJSONObject(data)) throw new TypeError(`Unmarshalling the type 'ListJobResultsResponse' failed as data isn't a dictionary.`);
+	return {
+		jobResults: unmarshalArrayOfObject(data.job_results, unmarshalJobResult),
+		totalCount: data.total_count
+	};
+};
+const unmarshalListJobsResponse = (data) => {
+	if (!isJSONObject(data)) throw new TypeError(`Unmarshalling the type 'ListJobsResponse' failed as data isn't a dictionary.`);
+	return {
+		jobs: unmarshalArrayOfObject(data.jobs, unmarshalJob),
+		totalCount: data.total_count
+	};
+};
+const unmarshalListModelsResponse = (data) => {
+	if (!isJSONObject(data)) throw new TypeError(`Unmarshalling the type 'ListModelsResponse' failed as data isn't a dictionary.`);
+	return {
+		models: unmarshalArrayOfObject(data.models, unmarshalModel),
+		totalCount: data.total_count
+	};
+};
+const unmarshalListPlatformsResponse = (data) => {
+	if (!isJSONObject(data)) throw new TypeError(`Unmarshalling the type 'ListPlatformsResponse' failed as data isn't a dictionary.`);
+	return {
+		platforms: unmarshalArrayOfObject(data.platforms, unmarshalPlatform),
+		totalCount: data.total_count
+	};
+};
+const unmarshalProcessResult = (data) => {
+	if (!isJSONObject(data)) throw new TypeError(`Unmarshalling the type 'ProcessResult' failed as data isn't a dictionary.`);
+	return {
+		createdAt: unmarshalDate(data.created_at),
+		processId: data.process_id,
+		result: data.result
+	};
+};
+const unmarshalListProcessResultsResponse = (data) => {
+	if (!isJSONObject(data)) throw new TypeError(`Unmarshalling the type 'ListProcessResultsResponse' failed as data isn't a dictionary.`);
+	return {
+		processResults: unmarshalArrayOfObject(data.process_results, unmarshalProcessResult),
+		totalCount: data.total_count
+	};
+};
+const unmarshalListProcessesResponse = (data) => {
+	if (!isJSONObject(data)) throw new TypeError(`Unmarshalling the type 'ListProcessesResponse' failed as data isn't a dictionary.`);
+	return {
+		processes: unmarshalArrayOfObject(data.processes, unmarshalProcess),
+		totalCount: data.total_count
+	};
+};
+const unmarshalListSessionACLsResponse = (data) => {
+	if (!isJSONObject(data)) throw new TypeError(`Unmarshalling the type 'ListSessionACLsResponse' failed as data isn't a dictionary.`);
+	return {
+		acls: data.acls,
+		totalCount: data.total_count
+	};
+};
+const unmarshalListSessionsResponse = (data) => {
+	if (!isJSONObject(data)) throw new TypeError(`Unmarshalling the type 'ListSessionsResponse' failed as data isn't a dictionary.`);
+	return {
+		sessions: unmarshalArrayOfObject(data.sessions, unmarshalSession),
+		totalCount: data.total_count
+	};
+};
+const marshalJobCircuit = (request, defaults) => ({ ...resolveOneOf([{
+	param: "perceval_circuit",
+	value: request.percevalCircuit
+}, {
+	param: "qiskit_circuit",
+	value: request.qiskitCircuit
+}]) });
+const marshalCreateJobRequest = (request, defaults) => ({
+	circuit: marshalJobCircuit(request.circuit, defaults),
+	max_duration: request.maxDuration,
+	model_id: request.modelId,
+	name: request.name,
+	parameters: request.parameters,
+	session_id: request.sessionId,
+	tags: request.tags
+});
+const marshalCreateModelRequest = (request, defaults) => ({
+	payload: request.payload,
+	project_id: request.projectId ?? defaults.defaultProjectId
+});
+const marshalCreateProcessRequest = (request, defaults) => ({
+	application_id: request.applicationId,
+	input: request.input,
+	name: request.name,
+	platform_id: request.platformId,
+	project_id: request.projectId ?? defaults.defaultProjectId,
+	tags: request.tags
+});
+const marshalCreateSessionRequestBookingDemand = (request, defaults) => ({
+	description: request.description,
+	finished_at: request.finishedAt,
+	started_at: request.startedAt,
+	time_zone: request.timeZone
+});
+const marshalCreateSessionRequest = (request, defaults) => ({
+	booking_demand: request.bookingDemand !== void 0 ? marshalCreateSessionRequestBookingDemand(request.bookingDemand, defaults) : void 0,
+	deduplication_id: request.deduplicationId,
+	max_duration: request.maxDuration,
+	max_idle_duration: request.maxIdleDuration,
+	model_id: request.modelId,
+	name: request.name,
+	parameters: request.parameters,
+	platform_id: request.platformId,
+	project_id: request.projectId ?? defaults.defaultProjectId,
+	tags: request.tags
+});
+const marshalUpdateBookingRequest = (request, defaults) => ({ description: request.description });
+const marshalUpdateJobRequest = (request, defaults) => ({
+	name: request.name,
+	tags: request.tags
+});
+const marshalUpdateProcessRequest = (request, defaults) => ({
+	name: request.name,
+	tags: request.tags
+});
+const marshalUpdateSessionRequest = (request, defaults) => ({
+	max_duration: request.maxDuration,
+	max_idle_duration: request.maxIdleDuration,
+	name: request.name,
+	tags: request.tags
+});
+//#endregion
+export { marshalCreateJobRequest, marshalCreateModelRequest, marshalCreateProcessRequest, marshalCreateSessionRequest, marshalUpdateBookingRequest, marshalUpdateJobRequest, marshalUpdateProcessRequest, marshalUpdateSessionRequest, unmarshalApplication, unmarshalBooking, unmarshalJob, unmarshalJobCircuit, unmarshalListApplicationsResponse, unmarshalListBookingsResponse, unmarshalListJobResultsResponse, unmarshalListJobsResponse, unmarshalListModelsResponse, unmarshalListPlatformsResponse, unmarshalListProcessResultsResponse, unmarshalListProcessesResponse, unmarshalListSessionACLsResponse, unmarshalListSessionsResponse, unmarshalModel, unmarshalPlatform, unmarshalProcess, unmarshalSession };

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

@@ -0,0 +1,196 @@
+export declare const queriesMetadata: {
+    readonly namespace: 'qaas';
+    readonly version: 'v1alpha1';
+    readonly folderName: 'qaasv1alpha1';
+    readonly services: readonly [{
+        readonly apiClass: 'API';
+        readonly methods: readonly [{
+            readonly methodName: 'getJob';
+            readonly protoName: 'GetJob';
+            readonly paramsType: 'GetJobRequest';
+            readonly returnType: 'Job';
+            readonly isList: false;
+            readonly paginationType: 'none';
+            readonly isPrivate: false;
+            readonly description: '"';
+            readonly hasWaiter: true;
+        }, {
+            readonly methodName: 'listJobs';
+            readonly protoName: 'ListJobs';
+            readonly paramsType: 'ListJobsRequest';
+            readonly returnType: 'ListJobsResponse';
+            readonly isList: true;
+            readonly paginationType: 'offset';
+            readonly pageParamKey: 'page';
+            readonly listItemType: 'Job';
+            readonly isPrivate: false;
+            readonly description: '"';
+        }, {
+            readonly methodName: 'listJobResults';
+            readonly protoName: 'ListJobResults';
+            readonly paramsType: 'ListJobResultsRequest';
+            readonly returnType: 'ListJobResultsResponse';
+            readonly isList: true;
+            readonly paginationType: 'offset';
+            readonly pageParamKey: 'page';
+            readonly listItemType: 'JobResult';
+            readonly isPrivate: false;
+            readonly description: '"';
+        }, {
+            readonly methodName: 'getJobCircuit';
+            readonly protoName: 'GetJobCircuit';
+            readonly paramsType: 'GetJobCircuitRequest';
+            readonly returnType: 'JobCircuit';
+            readonly isList: false;
+            readonly paginationType: 'none';
+            readonly isPrivate: false;
+            readonly description: '"';
+        }, {
+            readonly methodName: 'getPlatform';
+            readonly protoName: 'GetPlatform';
+            readonly paramsType: 'GetPlatformRequest';
+            readonly returnType: 'Platform';
+            readonly isList: false;
+            readonly paginationType: 'none';
+            readonly isPrivate: false;
+            readonly description: '"';
+        }, {
+            readonly methodName: 'listPlatforms';
+            readonly protoName: 'ListPlatforms';
+            readonly paramsType: 'ListPlatformsRequest';
+            readonly returnType: 'ListPlatformsResponse';
+            readonly isList: true;
+            readonly paginationType: 'offset';
+            readonly pageParamKey: 'page';
+            readonly listItemType: 'Platform';
+            readonly isPrivate: false;
+            readonly description: '"';
+        }, {
+            readonly methodName: 'getSession';
+            readonly protoName: 'GetSession';
+            readonly paramsType: 'GetSessionRequest';
+            readonly returnType: 'Session';
+            readonly isList: false;
+            readonly paginationType: 'none';
+            readonly isPrivate: false;
+            readonly description: '"';
+            readonly hasWaiter: true;
+        }, {
+            readonly methodName: 'listSessions';
+            readonly protoName: 'ListSessions';
+            readonly paramsType: 'ListSessionsRequest';
+            readonly returnType: 'ListSessionsResponse';
+            readonly isList: true;
+            readonly paginationType: 'offset';
+            readonly pageParamKey: 'page';
+            readonly listItemType: 'Session';
+            readonly isPrivate: false;
+            readonly description: '"';
+        }, {
+            readonly methodName: 'listSessionACLs';
+            readonly protoName: 'ListSessionACLs';
+            readonly paramsType: 'ListSessionACLsRequest';
+            readonly returnType: 'ListSessionACLsResponse';
+            readonly isList: true;
+            readonly paginationType: 'offset';
+            readonly pageParamKey: 'page';
+            readonly listItemType: 'SessionAccess';
+            readonly isPrivate: false;
+            readonly description: '"';
+        }, {
+            readonly methodName: 'getProcess';
+            readonly protoName: 'GetProcess';
+            readonly paramsType: 'GetProcessRequest';
+            readonly returnType: 'Process';
+            readonly isList: false;
+            readonly paginationType: 'none';
+            readonly isPrivate: false;
+            readonly description: '"';
+            readonly hasWaiter: true;
+        }, {
+            readonly methodName: 'listProcesses';
+            readonly protoName: 'ListProcesses';
+            readonly paramsType: 'ListProcessesRequest';
+            readonly returnType: 'ListProcessesResponse';
+            readonly isList: true;
+            readonly paginationType: 'offset';
+            readonly pageParamKey: 'page';
+            readonly listItemType: 'Process';
+            readonly isPrivate: false;
+            readonly description: '"';
+        }, {
+            readonly methodName: 'listProcessResults';
+            readonly protoName: 'ListProcessResults';
+            readonly paramsType: 'ListProcessResultsRequest';
+            readonly returnType: 'ListProcessResultsResponse';
+            readonly isList: true;
+            readonly paginationType: 'offset';
+            readonly pageParamKey: 'page';
+            readonly listItemType: 'ProcessResult';
+            readonly isPrivate: false;
+            readonly description: '"';
+        }, {
+            readonly methodName: 'getApplication';
+            readonly protoName: 'GetApplication';
+            readonly paramsType: 'GetApplicationRequest';
+            readonly returnType: 'Application';
+            readonly isList: false;
+            readonly paginationType: 'none';
+            readonly isPrivate: false;
+            readonly description: '"';
+        }, {
+            readonly methodName: 'listApplications';
+            readonly protoName: 'ListApplications';
+            readonly paramsType: 'ListApplicationsRequest';
+            readonly returnType: 'ListApplicationsResponse';
+            readonly isList: true;
+            readonly paginationType: 'offset';
+            readonly pageParamKey: 'page';
+            readonly listItemType: 'Application';
+            readonly isPrivate: false;
+            readonly description: '"';
+        }, {
+            readonly methodName: 'getBooking';
+            readonly protoName: 'GetBooking';
+            readonly paramsType: 'GetBookingRequest';
+            readonly returnType: 'Booking';
+            readonly isList: false;
+            readonly paginationType: 'none';
+            readonly isPrivate: false;
+            readonly description: '"';
+            readonly hasWaiter: true;
+        }, {
+            readonly methodName: 'listBookings';
+            readonly protoName: 'ListBookings';
+            readonly paramsType: 'ListBookingsRequest';
+            readonly returnType: 'ListBookingsResponse';
+            readonly isList: true;
+            readonly paginationType: 'offset';
+            readonly pageParamKey: 'page';
+            readonly listItemType: 'Booking';
+            readonly isPrivate: false;
+            readonly description: '"';
+        }, {
+            readonly methodName: 'getModel';
+            readonly protoName: 'GetModel';
+            readonly paramsType: 'GetModelRequest';
+            readonly returnType: 'Model';
+            readonly isList: false;
+            readonly paginationType: 'none';
+            readonly isPrivate: false;
+            readonly description: '"';
+        }, {
+            readonly methodName: 'listModels';
+            readonly protoName: 'ListModels';
+            readonly paramsType: 'ListModelsRequest';
+            readonly returnType: 'ListModelsResponse';
+            readonly isList: true;
+            readonly paginationType: 'offset';
+            readonly pageParamKey: 'page';
+            readonly listItemType: 'Model';
+            readonly isPrivate: false;
+            readonly description: '"';
+        }];
+    }];
+};
+export type QueriesMetadata = typeof queriesMetadata;