@quantum-hub/qhub-api 1.0.4

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

@@ -0,0 +1,514 @@
+// 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 ApplicationsClient {
+    export type Options = BaseClientOptions;
+
+    export interface RequestOptions extends BaseRequestOptions {}
+}
+
+/**
+ * Manage applications that can access the services provided by the platform. Generate access tokens to access your subscribed services.
+ */
+export class ApplicationsClient {
+    protected readonly _options: NormalizedClientOptionsWithAuth<ApplicationsClient.Options>;
+
+    constructor(options: ApplicationsClient.Options) {
+        this._options = normalizeClientOptionsWithAuth(options);
+    }
+
+    /**
+     * Get a list of all applications for the current user or organization.
+     *
+     * @param {ApplicationsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link HubPlatform.UnauthorizedError}
+     * @throws {@link HubPlatform.ForbiddenError}
+     * @throws {@link HubPlatform.NotFoundError}
+     * @throws {@link HubPlatform.InternalServerError}
+     *
+     * @example
+     *     await client.applications.getApplications()
+     */
+    public getApplications(
+        requestOptions?: ApplicationsClient.RequestOptions,
+    ): core.HttpResponsePromise<HubPlatform.ApplicationDto[]> {
+        return core.HttpResponsePromise.fromPromise(this.__getApplications(requestOptions));
+    }
+
+    private async __getApplications(
+        requestOptions?: ApplicationsClient.RequestOptions,
+    ): Promise<core.WithRawResponse<HubPlatform.ApplicationDto[]>> {
+        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,
+                "applications",
+            ),
+            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.ApplicationDto[], 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", "/applications");
+    }
+
+    /**
+     * Create a new application.
+     *
+     * @param {HubPlatform.CreateApplicationRequest} request
+     * @param {ApplicationsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link HubPlatform.BadRequestError}
+     * @throws {@link HubPlatform.UnauthorizedError}
+     * @throws {@link HubPlatform.ForbiddenError}
+     * @throws {@link HubPlatform.NotFoundError}
+     * @throws {@link HubPlatform.InternalServerError}
+     *
+     * @example
+     *     await client.applications.createApplication()
+     */
+    public createApplication(
+        request: HubPlatform.CreateApplicationRequest = {},
+        requestOptions?: ApplicationsClient.RequestOptions,
+    ): core.HttpResponsePromise<HubPlatform.ApplicationDto> {
+        return core.HttpResponsePromise.fromPromise(this.__createApplication(request, requestOptions));
+    }
+
+    private async __createApplication(
+        request: HubPlatform.CreateApplicationRequest = {},
+        requestOptions?: ApplicationsClient.RequestOptions,
+    ): Promise<core.WithRawResponse<HubPlatform.ApplicationDto>> {
+        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,
+                "applications",
+            ),
+            method: "POST",
+            headers: _headers,
+            contentType: "application/json",
+            queryParameters: requestOptions?.queryParams,
+            requestType: "json",
+            body: request,
+            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.ApplicationDto, 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 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, "POST", "/applications");
+    }
+
+    /**
+     * Get a specific application (identified by its ID).
+     *
+     * @param {HubPlatform.GetApplicationRequest} request
+     * @param {ApplicationsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link HubPlatform.UnauthorizedError}
+     * @throws {@link HubPlatform.ForbiddenError}
+     * @throws {@link HubPlatform.NotFoundError}
+     * @throws {@link HubPlatform.InternalServerError}
+     *
+     * @example
+     *     await client.applications.getApplication({
+     *         id: "id"
+     *     })
+     */
+    public getApplication(
+        request: HubPlatform.GetApplicationRequest,
+        requestOptions?: ApplicationsClient.RequestOptions,
+    ): core.HttpResponsePromise<HubPlatform.ApplicationDto> {
+        return core.HttpResponsePromise.fromPromise(this.__getApplication(request, requestOptions));
+    }
+
+    private async __getApplication(
+        request: HubPlatform.GetApplicationRequest,
+        requestOptions?: ApplicationsClient.RequestOptions,
+    ): Promise<core.WithRawResponse<HubPlatform.ApplicationDto>> {
+        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,
+                `applications/${core.url.encodePathParam(id)}`,
+            ),
+            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.ApplicationDto, 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", "/applications/{id}");
+    }
+
+    /**
+     * Delete an application (identified by its ID).
+     *
+     * @param {HubPlatform.DeleteApplicationRequest} request
+     * @param {ApplicationsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link HubPlatform.UnauthorizedError}
+     * @throws {@link HubPlatform.ForbiddenError}
+     * @throws {@link HubPlatform.NotFoundError}
+     * @throws {@link HubPlatform.InternalServerError}
+     *
+     * @example
+     *     await client.applications.deleteApplication({
+     *         id: "id"
+     *     })
+     */
+    public deleteApplication(
+        request: HubPlatform.DeleteApplicationRequest,
+        requestOptions?: ApplicationsClient.RequestOptions,
+    ): core.HttpResponsePromise<void> {
+        return core.HttpResponsePromise.fromPromise(this.__deleteApplication(request, requestOptions));
+    }
+
+    private async __deleteApplication(
+        request: HubPlatform.DeleteApplicationRequest,
+        requestOptions?: ApplicationsClient.RequestOptions,
+    ): Promise<core.WithRawResponse<void>> {
+        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,
+                `applications/${core.url.encodePathParam(id)}`,
+            ),
+            method: "DELETE",
+            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: undefined, 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, "DELETE", "/applications/{id}");
+    }
+
+    /**
+     * List all subscriptions of an application.
+     *
+     * @param {HubPlatform.GetApplicationSubscriptionsRequest} request
+     * @param {ApplicationsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link HubPlatform.UnauthorizedError}
+     * @throws {@link HubPlatform.ForbiddenError}
+     * @throws {@link HubPlatform.NotFoundError}
+     * @throws {@link HubPlatform.InternalServerError}
+     *
+     * @example
+     *     await client.applications.getApplicationSubscriptions({
+     *         id: "id"
+     *     })
+     */
+    public getApplicationSubscriptions(
+        request: HubPlatform.GetApplicationSubscriptionsRequest,
+        requestOptions?: ApplicationsClient.RequestOptions,
+    ): core.HttpResponsePromise<HubPlatform.SubscriptionDto[]> {
+        return core.HttpResponsePromise.fromPromise(this.__getApplicationSubscriptions(request, requestOptions));
+    }
+
+    private async __getApplicationSubscriptions(
+        request: HubPlatform.GetApplicationSubscriptionsRequest,
+        requestOptions?: ApplicationsClient.RequestOptions,
+    ): Promise<core.WithRawResponse<HubPlatform.SubscriptionDto[]>> {
+        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,
+                `applications/${core.url.encodePathParam(id)}/subscriptions`,
+            ),
+            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.SubscriptionDto[], 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",
+            "/applications/{id}/subscriptions",
+        );
+    }
+
+    /**
+     * List of access keys for an application. Use these access keys to generate access tokens to authenticate service execution requests for subscribed services.
+     *
+     * @param {HubPlatform.GetApplicationAccessKeysRequest} request
+     * @param {ApplicationsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link HubPlatform.UnauthorizedError}
+     * @throws {@link HubPlatform.ForbiddenError}
+     * @throws {@link HubPlatform.NotFoundError}
+     * @throws {@link HubPlatform.InternalServerError}
+     *
+     * @example
+     *     await client.applications.getApplicationAccessKeys({
+     *         id: "id"
+     *     })
+     */
+    public getApplicationAccessKeys(
+        request: HubPlatform.GetApplicationAccessKeysRequest,
+        requestOptions?: ApplicationsClient.RequestOptions,
+    ): core.HttpResponsePromise<HubPlatform.AccessKey[]> {
+        return core.HttpResponsePromise.fromPromise(this.__getApplicationAccessKeys(request, requestOptions));
+    }
+
+    private async __getApplicationAccessKeys(
+        request: HubPlatform.GetApplicationAccessKeysRequest,
+        requestOptions?: ApplicationsClient.RequestOptions,
+    ): Promise<core.WithRawResponse<HubPlatform.AccessKey[]>> {
+        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,
+                `applications/${core.url.encodePathParam(id)}/access-keys`,
+            ),
+            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.AccessKey[], 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",
+            "/applications/{id}/access-keys",
+        );
+    }
+}

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

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

package/src/api/platform/api/resources/applications/client/requests/CreateApplicationRequest.ts

@@ -0,0 +1,9 @@
+// This file was auto-generated by Fern from our API Definition.
+
+/**
+ * @example
+ *     {}
+ */
+export interface CreateApplicationRequest {
+    name?: string;
+}

package/src/api/platform/api/resources/applications/client/requests/DeleteApplicationRequest.ts

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

package/src/api/platform/api/resources/applications/client/requests/GetApplicationAccessKeysRequest.ts

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

package/src/api/platform/api/resources/applications/client/requests/GetApplicationRequest.ts

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

package/src/api/platform/api/resources/applications/client/requests/GetApplicationSubscriptionsRequest.ts

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

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

@@ -0,0 +1,5 @@
+export type { CreateApplicationRequest } from "./CreateApplicationRequest.js";
+export type { DeleteApplicationRequest } from "./DeleteApplicationRequest.js";
+export type { GetApplicationAccessKeysRequest } from "./GetApplicationAccessKeysRequest.js";
+export type { GetApplicationRequest } from "./GetApplicationRequest.js";
+export type { GetApplicationSubscriptionsRequest } from "./GetApplicationSubscriptionsRequest.js";

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

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