@quantum-hub/qhub-api 1.0.4

package/src/api/platform/api/resources/dataPools/client/index.ts

@@ -0,0 +1 @@
+export * from "./requests/index.js";

package/src/api/platform/api/resources/dataPools/client/requests/AddDataPoolFileRequest.ts

@@ -0,0 +1,16 @@
+// This file was auto-generated by Fern from our API Definition.
+
+import type * as core from "../../../../../core/index.js";
+
+/**
+ * @example
+ *     {
+ *         file: fs.createReadStream("/path/to/your/file"),
+ *         id: "id"
+ *     }
+ */
+export interface AddDataPoolFileRequest {
+    id: string;
+    filename?: string;
+    file: core.file.Uploadable;
+}

package/src/api/platform/api/resources/dataPools/client/requests/CreateDataPoolRequest.ts

@@ -0,0 +1,16 @@
+// This file was auto-generated by Fern from our API Definition.
+
+/**
+ * @example
+ *     {}
+ */
+export interface CreateDataPoolRequest {
+    /** The name of the data pool. Must be at least 3 characters and at most 255 characters long. */
+    name?: string;
+    /** A short description of the data pool. Must be at most 60 characters long. */
+    shortDescription?: string;
+    /** A description of the data pool and it's files. */
+    description?: string;
+    /** List of tags associated with the data pool. Tags are saved in lowercase and can be used for filtering and searching. */
+    tags?: string[];
+}

package/src/api/platform/api/resources/dataPools/client/requests/DeleteDataPoolFileRequest.ts

@@ -0,0 +1,13 @@
+// This file was auto-generated by Fern from our API Definition.
+
+/**
+ * @example
+ *     {
+ *         id: "id",
+ *         fileId: "fileId"
+ *     }
+ */
+export interface DeleteDataPoolFileRequest {
+    id: string;
+    fileId: string;
+}

package/src/api/platform/api/resources/dataPools/client/requests/DeleteDataPoolRequest.ts

@@ -0,0 +1,11 @@
+// This file was auto-generated by Fern from our API Definition.
+
+/**
+ * @example
+ *     {
+ *         id: "id"
+ *     }
+ */
+export interface DeleteDataPoolRequest {
+    id: string;
+}

package/src/api/platform/api/resources/dataPools/client/requests/GetDataPoolFileRequest.ts

@@ -0,0 +1,13 @@
+// This file was auto-generated by Fern from our API Definition.
+
+/**
+ * @example
+ *     {
+ *         id: "id",
+ *         fileId: "fileId"
+ *     }
+ */
+export interface GetDataPoolFileRequest {
+    id: string;
+    fileId: string;
+}

package/src/api/platform/api/resources/dataPools/client/requests/GetDataPoolFilesRequest.ts

@@ -0,0 +1,11 @@
+// This file was auto-generated by Fern from our API Definition.
+
+/**
+ * @example
+ *     {
+ *         id: "id"
+ *     }
+ */
+export interface GetDataPoolFilesRequest {
+    id: string;
+}

package/src/api/platform/api/resources/dataPools/client/requests/GetDataPoolRequest.ts

@@ -0,0 +1,11 @@
+// This file was auto-generated by Fern from our API Definition.
+
+/**
+ * @example
+ *     {
+ *         id: "id"
+ *     }
+ */
+export interface GetDataPoolRequest {
+    id: string;
+}

package/src/api/platform/api/resources/dataPools/client/requests/UpdateDataPoolRequest.ts

@@ -0,0 +1,19 @@
+// This file was auto-generated by Fern from our API Definition.
+
+/**
+ * @example
+ *     {
+ *         id: "id"
+ *     }
+ */
+export interface UpdateDataPoolRequest {
+    id: string;
+    /** The name of the data pool. Must be at least 3 characters and at most 255 characters long. */
+    name?: string;
+    /** Short description of the data pool. */
+    shortDescription?: string;
+    /** Detailed description of the data pool. */
+    description?: string;
+    /** List of tags associated with the data pool. Tags are saved in lowercase and can be used for filtering and searching. */
+    tags?: string[];
+}

package/src/api/platform/api/resources/dataPools/client/requests/index.ts

@@ -0,0 +1,8 @@
+export type { AddDataPoolFileRequest } from "./AddDataPoolFileRequest.js";
+export type { CreateDataPoolRequest } from "./CreateDataPoolRequest.js";
+export type { DeleteDataPoolFileRequest } from "./DeleteDataPoolFileRequest.js";
+export type { DeleteDataPoolRequest } from "./DeleteDataPoolRequest.js";
+export type { GetDataPoolFileRequest } from "./GetDataPoolFileRequest.js";
+export type { GetDataPoolFilesRequest } from "./GetDataPoolFilesRequest.js";
+export type { GetDataPoolRequest } from "./GetDataPoolRequest.js";
+export type { UpdateDataPoolRequest } from "./UpdateDataPoolRequest.js";

package/src/api/platform/api/resources/dataPools/index.ts

@@ -0,0 +1 @@
+export * from "./client/index.js";

package/src/api/platform/api/resources/index.ts

@@ -0,0 +1,23 @@
+export * from "./applications/client/requests/index.js";
+export * as applications from "./applications/index.js";
+export * from "./dataPoolShares/client/requests/index.js";
+export * as dataPoolShares from "./dataPoolShares/index.js";
+export * from "./dataPoolShares/types/index.js";
+export * from "./dataPools/client/requests/index.js";
+export * as dataPools from "./dataPools/index.js";
+export * from "./organizations/client/requests/index.js";
+export * as organizations from "./organizations/index.js";
+export * from "./quantumJobs/client/requests/index.js";
+export * as quantumJobs from "./quantumJobs/index.js";
+export * from "./quantumWorkloads/client/requests/index.js";
+export * as quantumWorkloads from "./quantumWorkloads/index.js";
+export * from "./serviceExecutions/client/requests/index.js";
+export * as serviceExecutions from "./serviceExecutions/index.js";
+export * from "./serviceExecutions/types/index.js";
+export * from "./serviceJobs/client/requests/index.js";
+export * as serviceJobs from "./serviceJobs/index.js";
+export * from "./serviceShares/client/requests/index.js";
+export * as serviceShares from "./serviceShares/index.js";
+export * from "./serviceShares/types/index.js";
+export * from "./subscriptions/client/requests/index.js";
+export * as subscriptions from "./subscriptions/index.js";

package/src/api/platform/api/resources/organizations/client/Client.ts

@@ -0,0 +1,110 @@
+// This file was auto-generated by Fern from our API Definition.
+
+import type { BaseClientOptions, BaseRequestOptions } from "../../../../BaseClient.js";
+import { type NormalizedClientOptionsWithAuth, normalizeClientOptionsWithAuth } from "../../../../BaseClient.js";
+import { mergeHeaders, mergeOnlyDefinedHeaders } from "../../../../core/headers.js";
+import * as core from "../../../../core/index.js";
+import * as environments from "../../../../environments.js";
+import { handleNonStatusCodeError } from "../../../../errors/handleNonStatusCodeError.js";
+import * as errors from "../../../../errors/index.js";
+import * as HubPlatform from "../../../index.js";
+
+export declare namespace OrganizationsClient {
+    export type Options = BaseClientOptions;
+
+    export interface RequestOptions extends BaseRequestOptions {}
+}
+
+/**
+ * Manage organizations within the platform.
+ */
+export class OrganizationsClient {
+    protected readonly _options: NormalizedClientOptionsWithAuth<OrganizationsClient.Options>;
+
+    constructor(options: OrganizationsClient.Options) {
+        this._options = normalizeClientOptionsWithAuth(options);
+    }
+
+    /**
+     * Get a list of organizations based on the search query parameter. The search is performed against organization names and descriptions. Provide a query parameter 'q' with the search term. The query parameter is required and may contain alphanumeric values. Wildcards are supported while special characters are not. However, the search term must be at least 3 characters long and must contain at least one alphanumeric character.
+     *
+     * @param {HubPlatform.GetServiceExecutions1Request} request
+     * @param {OrganizationsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link HubPlatform.BadRequestError}
+     * @throws {@link HubPlatform.UnauthorizedError}
+     * @throws {@link HubPlatform.InternalServerError}
+     *
+     * @example
+     *     await client.organizations.getServiceExecutions1({
+     *         q: "q"
+     *     })
+     */
+    public getServiceExecutions1(
+        request: HubPlatform.GetServiceExecutions1Request,
+        requestOptions?: OrganizationsClient.RequestOptions,
+    ): core.HttpResponsePromise<HubPlatform.OrganizationSearchResultDto[]> {
+        return core.HttpResponsePromise.fromPromise(this.__getServiceExecutions1(request, requestOptions));
+    }
+
+    private async __getServiceExecutions1(
+        request: HubPlatform.GetServiceExecutions1Request,
+        requestOptions?: OrganizationsClient.RequestOptions,
+    ): Promise<core.WithRawResponse<HubPlatform.OrganizationSearchResultDto[]>> {
+        const { q } = request;
+        const _queryParams: Record<string, unknown> = {
+            q,
+        };
+        const _authRequest: core.AuthRequest = await this._options.authProvider.getAuthRequest();
+        const _headers: core.Fetcher.Args["headers"] = mergeHeaders(
+            _authRequest.headers,
+            this._options?.headers,
+            mergeOnlyDefinedHeaders({
+                "X-OrganizationId": requestOptions?.organizationId ?? this._options?.organizationId,
+            }),
+            requestOptions?.headers,
+        );
+        const _response = await core.fetcher({
+            url: core.url.join(
+                (await core.Supplier.get(this._options.baseUrl)) ??
+                    (await core.Supplier.get(this._options.environment)) ??
+                    environments.HubPlatformEnvironment.Default,
+                "organizations/search",
+            ),
+            method: "GET",
+            headers: _headers,
+            queryParameters: { ..._queryParams, ...requestOptions?.queryParams },
+            timeoutMs: (requestOptions?.timeoutInSeconds ?? this._options?.timeoutInSeconds ?? 60) * 1000,
+            maxRetries: requestOptions?.maxRetries ?? this._options?.maxRetries,
+            withCredentials: true,
+            abortSignal: requestOptions?.abortSignal,
+            fetchFn: this._options?.fetch,
+            logging: this._options.logging,
+        });
+        if (_response.ok) {
+            return {
+                data: _response.body as HubPlatform.OrganizationSearchResultDto[],
+                rawResponse: _response.rawResponse,
+            };
+        }
+
+        if (_response.error.reason === "status-code") {
+            switch (_response.error.statusCode) {
+                case 400:
+                    throw new HubPlatform.BadRequestError(_response.error.body as any, _response.rawResponse);
+                case 401:
+                    throw new HubPlatform.UnauthorizedError(_response.error.body as any, _response.rawResponse);
+                case 500:
+                    throw new HubPlatform.InternalServerError(_response.error.body as any, _response.rawResponse);
+                default:
+                    throw new errors.HubPlatformError({
+                        statusCode: _response.error.statusCode,
+                        body: _response.error.body,
+                        rawResponse: _response.rawResponse,
+                    });
+            }
+        }
+
+        return handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/organizations/search");
+    }
+}

package/src/api/platform/api/resources/organizations/client/index.ts

@@ -0,0 +1 @@
+export * from "./requests/index.js";

package/src/api/platform/api/resources/organizations/client/requests/GetServiceExecutions1Request.ts

@@ -0,0 +1,11 @@
+// This file was auto-generated by Fern from our API Definition.
+
+/**
+ * @example
+ *     {
+ *         q: "q"
+ *     }
+ */
+export interface GetServiceExecutions1Request {
+    q: string;
+}

package/src/api/platform/api/resources/organizations/client/requests/index.ts

@@ -0,0 +1 @@
+export type { GetServiceExecutions1Request } from "./GetServiceExecutions1Request.js";

package/src/api/platform/api/resources/organizations/index.ts

@@ -0,0 +1 @@
+export * from "./client/index.js";

package/src/api/platform/api/resources/quantumJobs/client/Client.ts

@@ -0,0 +1,104 @@
+// This file was auto-generated by Fern from our API Definition.
+
+import type { BaseClientOptions, BaseRequestOptions } from "../../../../BaseClient.js";
+import { type NormalizedClientOptionsWithAuth, normalizeClientOptionsWithAuth } from "../../../../BaseClient.js";
+import { mergeHeaders, mergeOnlyDefinedHeaders } from "../../../../core/headers.js";
+import * as core from "../../../../core/index.js";
+import * as environments from "../../../../environments.js";
+import { handleNonStatusCodeError } from "../../../../errors/handleNonStatusCodeError.js";
+import * as errors from "../../../../errors/index.js";
+import * as HubPlatform from "../../../index.js";
+
+export declare namespace QuantumJobsClient {
+    export type Options = BaseClientOptions;
+
+    export interface RequestOptions extends BaseRequestOptions {}
+}
+
+export class QuantumJobsClient {
+    protected readonly _options: NormalizedClientOptionsWithAuth<QuantumJobsClient.Options>;
+
+    constructor(options: QuantumJobsClient.Options) {
+        this._options = normalizeClientOptionsWithAuth(options);
+    }
+
+    /**
+     * Get the costs for a specific quantum job (identified by its ID). If the quantum job has not started yet or no costs are available, a HTTP 204 (No Content) response is returned with a "Retry-After" header.
+     *
+     * @param {HubPlatform.GetQuantumJobCostsRequest} request
+     * @param {QuantumJobsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link HubPlatform.UnauthorizedError}
+     * @throws {@link HubPlatform.ForbiddenError}
+     * @throws {@link HubPlatform.NotFoundError}
+     * @throws {@link HubPlatform.InternalServerError}
+     *
+     * @example
+     *     await client.quantumJobs.getQuantumJobCosts({
+     *         id: "id"
+     *     })
+     */
+    public getQuantumJobCosts(
+        request: HubPlatform.GetQuantumJobCostsRequest,
+        requestOptions?: QuantumJobsClient.RequestOptions,
+    ): core.HttpResponsePromise<HubPlatform.QuantumJobCosts> {
+        return core.HttpResponsePromise.fromPromise(this.__getQuantumJobCosts(request, requestOptions));
+    }
+
+    private async __getQuantumJobCosts(
+        request: HubPlatform.GetQuantumJobCostsRequest,
+        requestOptions?: QuantumJobsClient.RequestOptions,
+    ): Promise<core.WithRawResponse<HubPlatform.QuantumJobCosts>> {
+        const { id } = request;
+        const _authRequest: core.AuthRequest = await this._options.authProvider.getAuthRequest();
+        const _headers: core.Fetcher.Args["headers"] = mergeHeaders(
+            _authRequest.headers,
+            this._options?.headers,
+            mergeOnlyDefinedHeaders({
+                "X-OrganizationId": requestOptions?.organizationId ?? this._options?.organizationId,
+            }),
+            requestOptions?.headers,
+        );
+        const _response = await core.fetcher({
+            url: core.url.join(
+                (await core.Supplier.get(this._options.baseUrl)) ??
+                    (await core.Supplier.get(this._options.environment)) ??
+                    environments.HubPlatformEnvironment.Default,
+                `quantum-jobs/${core.url.encodePathParam(id)}/costs`,
+            ),
+            method: "GET",
+            headers: _headers,
+            queryParameters: requestOptions?.queryParams,
+            timeoutMs: (requestOptions?.timeoutInSeconds ?? this._options?.timeoutInSeconds ?? 60) * 1000,
+            maxRetries: requestOptions?.maxRetries ?? this._options?.maxRetries,
+            withCredentials: true,
+            abortSignal: requestOptions?.abortSignal,
+            fetchFn: this._options?.fetch,
+            logging: this._options.logging,
+        });
+        if (_response.ok) {
+            return { data: _response.body as HubPlatform.QuantumJobCosts, rawResponse: _response.rawResponse };
+        }
+
+        if (_response.error.reason === "status-code") {
+            switch (_response.error.statusCode) {
+                case 401:
+                    throw new HubPlatform.UnauthorizedError(_response.error.body as any, _response.rawResponse);
+                case 403:
+                    throw new HubPlatform.ForbiddenError(_response.error.body as any, _response.rawResponse);
+                case 404:
+                    throw new HubPlatform.NotFoundError(_response.error.body as any, _response.rawResponse);
+                case 500:
+                    throw new HubPlatform.InternalServerError(_response.error.body as any, _response.rawResponse);
+                default:
+                    throw new errors.HubPlatformError({
+                        statusCode: _response.error.statusCode,
+                        body: _response.error.body,
+                        rawResponse: _response.rawResponse,
+                    });
+            }
+        }
+
+        return handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/quantum-jobs/{id}/costs");
+    }
+}

package/src/api/platform/api/resources/quantumJobs/client/index.ts

@@ -0,0 +1 @@
+export * from "./requests/index.js";

package/src/api/platform/api/resources/quantumJobs/client/requests/GetQuantumJobCostsRequest.ts

@@ -0,0 +1,11 @@
+// This file was auto-generated by Fern from our API Definition.
+
+/**
+ * @example
+ *     {
+ *         id: "id"
+ *     }
+ */
+export interface GetQuantumJobCostsRequest {
+    id: string;
+}

package/src/api/platform/api/resources/quantumJobs/client/requests/index.ts

@@ -0,0 +1 @@
+export type { GetQuantumJobCostsRequest } from "./GetQuantumJobCostsRequest.js";

package/src/api/platform/api/resources/quantumJobs/index.ts

@@ -0,0 +1 @@
+export * from "./client/index.js";

package/src/api/platform/api/resources/quantumWorkloads/client/Client.ts

@@ -0,0 +1,104 @@
+// This file was auto-generated by Fern from our API Definition.
+
+import type { BaseClientOptions, BaseRequestOptions } from "../../../../BaseClient.js";
+import { type NormalizedClientOptionsWithAuth, normalizeClientOptionsWithAuth } from "../../../../BaseClient.js";
+import { mergeHeaders, mergeOnlyDefinedHeaders } from "../../../../core/headers.js";
+import * as core from "../../../../core/index.js";
+import * as environments from "../../../../environments.js";
+import { handleNonStatusCodeError } from "../../../../errors/handleNonStatusCodeError.js";
+import * as errors from "../../../../errors/index.js";
+import * as HubPlatform from "../../../index.js";
+
+export declare namespace QuantumWorkloadsClient {
+    export type Options = BaseClientOptions;
+
+    export interface RequestOptions extends BaseRequestOptions {}
+}
+
+export class QuantumWorkloadsClient {
+    protected readonly _options: NormalizedClientOptionsWithAuth<QuantumWorkloadsClient.Options>;
+
+    constructor(options: QuantumWorkloadsClient.Options) {
+        this._options = normalizeClientOptionsWithAuth(options);
+    }
+
+    /**
+     * Get the aggregated total cost for a specific quantum workload (job or session) identified by its ID. If no costs are available yet, a HTTP 204 (No Content) response is returned with a "Retry-After" header.
+     *
+     * @param {HubPlatform.GetQuantumWorkloadCostsRequest} request
+     * @param {QuantumWorkloadsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link HubPlatform.UnauthorizedError}
+     * @throws {@link HubPlatform.ForbiddenError}
+     * @throws {@link HubPlatform.NotFoundError}
+     * @throws {@link HubPlatform.InternalServerError}
+     *
+     * @example
+     *     await client.quantumWorkloads.getQuantumWorkloadCosts({
+     *         id: "id"
+     *     })
+     */
+    public getQuantumWorkloadCosts(
+        request: HubPlatform.GetQuantumWorkloadCostsRequest,
+        requestOptions?: QuantumWorkloadsClient.RequestOptions,
+    ): core.HttpResponsePromise<HubPlatform.QuantumWorkloadCosts> {
+        return core.HttpResponsePromise.fromPromise(this.__getQuantumWorkloadCosts(request, requestOptions));
+    }
+
+    private async __getQuantumWorkloadCosts(
+        request: HubPlatform.GetQuantumWorkloadCostsRequest,
+        requestOptions?: QuantumWorkloadsClient.RequestOptions,
+    ): Promise<core.WithRawResponse<HubPlatform.QuantumWorkloadCosts>> {
+        const { id } = request;
+        const _authRequest: core.AuthRequest = await this._options.authProvider.getAuthRequest();
+        const _headers: core.Fetcher.Args["headers"] = mergeHeaders(
+            _authRequest.headers,
+            this._options?.headers,
+            mergeOnlyDefinedHeaders({
+                "X-OrganizationId": requestOptions?.organizationId ?? this._options?.organizationId,
+            }),
+            requestOptions?.headers,
+        );
+        const _response = await core.fetcher({
+            url: core.url.join(
+                (await core.Supplier.get(this._options.baseUrl)) ??
+                    (await core.Supplier.get(this._options.environment)) ??
+                    environments.HubPlatformEnvironment.Default,
+                `quantum-workloads/${core.url.encodePathParam(id)}/costs`,
+            ),
+            method: "GET",
+            headers: _headers,
+            queryParameters: requestOptions?.queryParams,
+            timeoutMs: (requestOptions?.timeoutInSeconds ?? this._options?.timeoutInSeconds ?? 60) * 1000,
+            maxRetries: requestOptions?.maxRetries ?? this._options?.maxRetries,
+            withCredentials: true,
+            abortSignal: requestOptions?.abortSignal,
+            fetchFn: this._options?.fetch,
+            logging: this._options.logging,
+        });
+        if (_response.ok) {
+            return { data: _response.body as HubPlatform.QuantumWorkloadCosts, rawResponse: _response.rawResponse };
+        }
+
+        if (_response.error.reason === "status-code") {
+            switch (_response.error.statusCode) {
+                case 401:
+                    throw new HubPlatform.UnauthorizedError(_response.error.body as any, _response.rawResponse);
+                case 403:
+                    throw new HubPlatform.ForbiddenError(_response.error.body as any, _response.rawResponse);
+                case 404:
+                    throw new HubPlatform.NotFoundError(_response.error.body as any, _response.rawResponse);
+                case 500:
+                    throw new HubPlatform.InternalServerError(_response.error.body as any, _response.rawResponse);
+                default:
+                    throw new errors.HubPlatformError({
+                        statusCode: _response.error.statusCode,
+                        body: _response.error.body,
+                        rawResponse: _response.rawResponse,
+                    });
+            }
+        }
+
+        return handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/quantum-workloads/{id}/costs");
+    }
+}

package/src/api/platform/api/resources/quantumWorkloads/client/index.ts

@@ -0,0 +1 @@
+export * from "./requests/index.js";

package/src/api/platform/api/resources/quantumWorkloads/client/requests/GetQuantumWorkloadCostsRequest.ts

@@ -0,0 +1,11 @@
+// This file was auto-generated by Fern from our API Definition.
+
+/**
+ * @example
+ *     {
+ *         id: "id"
+ *     }
+ */
+export interface GetQuantumWorkloadCostsRequest {
+    id: string;
+}

package/src/api/platform/api/resources/quantumWorkloads/client/requests/index.ts

@@ -0,0 +1 @@
+export type { GetQuantumWorkloadCostsRequest } from "./GetQuantumWorkloadCostsRequest.js";

package/src/api/platform/api/resources/quantumWorkloads/index.ts

@@ -0,0 +1 @@
+export * from "./client/index.js";