@planqk/planqk-api-sdk 1.3.7 → 1.7.0

package/dist/sdk/api/resources/serviceExecutions/client/Client.js

@@ -0,0 +1,271 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ServiceExecutions = void 0;
+const environments = __importStar(require("../../../../environments.js"));
+const core = __importStar(require("../../../../core/index.js"));
+const PlanqkApi = __importStar(require("../../../index.js"));
+const headers_js_1 = require("../../../../core/headers.js");
+const errors = __importStar(require("../../../../errors/index.js"));
+/**
+ * Track status, costs, logs, metrics, and results of your service executions.
+ */
+class ServiceExecutions {
+    _options;
+    constructor(_options) {
+        this._options = _options;
+    }
+    /**
+     * Get a specific service execution (identified by its ID).
+     *
+     * @param {string} id
+     * @param {ServiceExecutions.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link PlanqkApi.UnauthorizedError}
+     * @throws {@link PlanqkApi.ForbiddenError}
+     * @throws {@link PlanqkApi.NotFoundError}
+     * @throws {@link PlanqkApi.InternalServerError}
+     *
+     * @example
+     *     await client.serviceExecutions.getServiceExecution("id")
+     */
+    getServiceExecution(id, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__getServiceExecution(id, requestOptions));
+    }
+    async __getServiceExecution(id, requestOptions) {
+        let _headers = (0, headers_js_1.mergeHeaders)(this._options?.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({
+            "X-OrganizationId": requestOptions?.organizationId ?? this._options?.organizationId,
+            ...(await this._getCustomAuthorizationHeaders()),
+        }), 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.PlanqkApiEnvironment.Default, `service-executions/v1/${encodeURIComponent(id)}`),
+            method: "GET",
+            headers: _headers,
+            queryParameters: requestOptions?.queryParams,
+            timeoutMs: requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
+            maxRetries: requestOptions?.maxRetries,
+            withCredentials: true,
+            abortSignal: requestOptions?.abortSignal,
+        });
+        if (_response.ok) {
+            return { data: _response.body, rawResponse: _response.rawResponse };
+        }
+        if (_response.error.reason === "status-code") {
+            switch (_response.error.statusCode) {
+                case 401:
+                    throw new PlanqkApi.UnauthorizedError(_response.error.body, _response.rawResponse);
+                case 403:
+                    throw new PlanqkApi.ForbiddenError(_response.error.body, _response.rawResponse);
+                case 404:
+                    throw new PlanqkApi.NotFoundError(_response.error.body, _response.rawResponse);
+                case 500:
+                    throw new PlanqkApi.InternalServerError(_response.error.body, _response.rawResponse);
+                default:
+                    throw new errors.PlanqkApiError({
+                        statusCode: _response.error.statusCode,
+                        body: _response.error.body,
+                        rawResponse: _response.rawResponse,
+                    });
+            }
+        }
+        switch (_response.error.reason) {
+            case "non-json":
+                throw new errors.PlanqkApiError({
+                    statusCode: _response.error.statusCode,
+                    body: _response.error.rawBody,
+                    rawResponse: _response.rawResponse,
+                });
+            case "timeout":
+                throw new errors.PlanqkApiTimeoutError("Timeout exceeded when calling GET /service-executions/v1/{id}.");
+            case "unknown":
+                throw new errors.PlanqkApiError({
+                    message: _response.error.errorMessage,
+                    rawResponse: _response.rawResponse,
+                });
+        }
+    }
+    /**
+     * Check if the tenant has view permission for a specific service execution (identified by its ID).
+     *
+     * @param {string} id
+     * @param {ServiceExecutions.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link PlanqkApi.UnauthorizedError}
+     * @throws {@link PlanqkApi.ForbiddenError}
+     * @throws {@link PlanqkApi.NotFoundError}
+     * @throws {@link PlanqkApi.InternalServerError}
+     *
+     * @example
+     *     await client.serviceExecutions.headServiceExecution("id")
+     */
+    headServiceExecution(id, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__headServiceExecution(id, requestOptions));
+    }
+    async __headServiceExecution(id, requestOptions) {
+        let _headers = (0, headers_js_1.mergeHeaders)(this._options?.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({
+            "X-OrganizationId": requestOptions?.organizationId ?? this._options?.organizationId,
+            ...(await this._getCustomAuthorizationHeaders()),
+        }), 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.PlanqkApiEnvironment.Default, `service-executions/v1/${encodeURIComponent(id)}`),
+            method: "HEAD",
+            headers: _headers,
+            queryParameters: requestOptions?.queryParams,
+            timeoutMs: requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
+            maxRetries: requestOptions?.maxRetries,
+            withCredentials: true,
+            abortSignal: requestOptions?.abortSignal,
+        });
+        if (_response.ok) {
+            return { data: _response.rawResponse.headers, rawResponse: _response.rawResponse };
+        }
+        if (_response.error.reason === "status-code") {
+            switch (_response.error.statusCode) {
+                case 401:
+                    throw new PlanqkApi.UnauthorizedError(_response.error.body, _response.rawResponse);
+                case 403:
+                    throw new PlanqkApi.ForbiddenError(_response.error.body, _response.rawResponse);
+                case 404:
+                    throw new PlanqkApi.NotFoundError(_response.error.body, _response.rawResponse);
+                case 500:
+                    throw new PlanqkApi.InternalServerError(_response.error.body, _response.rawResponse);
+                default:
+                    throw new errors.PlanqkApiError({
+                        statusCode: _response.error.statusCode,
+                        body: _response.error.body,
+                        rawResponse: _response.rawResponse,
+                    });
+            }
+        }
+        switch (_response.error.reason) {
+            case "non-json":
+                throw new errors.PlanqkApiError({
+                    statusCode: _response.error.statusCode,
+                    body: _response.error.rawBody,
+                    rawResponse: _response.rawResponse,
+                });
+            case "timeout":
+                throw new errors.PlanqkApiTimeoutError("Timeout exceeded when calling HEAD /service-executions/v1/{id}.");
+            case "unknown":
+                throw new errors.PlanqkApiError({
+                    message: _response.error.errorMessage,
+                    rawResponse: _response.rawResponse,
+                });
+        }
+    }
+    /**
+     * Get resource usage metrics for a specific service execution (identified by its ID).
+     *
+     * @param {string} id
+     * @param {ServiceExecutions.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link PlanqkApi.UnauthorizedError}
+     * @throws {@link PlanqkApi.ForbiddenError}
+     * @throws {@link PlanqkApi.NotFoundError}
+     * @throws {@link PlanqkApi.InternalServerError}
+     *
+     * @example
+     *     await client.serviceExecutions.getServiceExecutionMetrics("id")
+     */
+    getServiceExecutionMetrics(id, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__getServiceExecutionMetrics(id, requestOptions));
+    }
+    async __getServiceExecutionMetrics(id, requestOptions) {
+        let _headers = (0, headers_js_1.mergeHeaders)(this._options?.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({
+            "X-OrganizationId": requestOptions?.organizationId ?? this._options?.organizationId,
+            ...(await this._getCustomAuthorizationHeaders()),
+        }), 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.PlanqkApiEnvironment.Default, `service-executions/v1/${encodeURIComponent(id)}/metrics`),
+            method: "GET",
+            headers: _headers,
+            queryParameters: requestOptions?.queryParams,
+            timeoutMs: requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
+            maxRetries: requestOptions?.maxRetries,
+            withCredentials: true,
+            abortSignal: requestOptions?.abortSignal,
+        });
+        if (_response.ok) {
+            return { data: _response.body, rawResponse: _response.rawResponse };
+        }
+        if (_response.error.reason === "status-code") {
+            switch (_response.error.statusCode) {
+                case 401:
+                    throw new PlanqkApi.UnauthorizedError(_response.error.body, _response.rawResponse);
+                case 403:
+                    throw new PlanqkApi.ForbiddenError(_response.error.body, _response.rawResponse);
+                case 404:
+                    throw new PlanqkApi.NotFoundError(_response.error.body, _response.rawResponse);
+                case 500:
+                    throw new PlanqkApi.InternalServerError(_response.error.body, _response.rawResponse);
+                default:
+                    throw new errors.PlanqkApiError({
+                        statusCode: _response.error.statusCode,
+                        body: _response.error.body,
+                        rawResponse: _response.rawResponse,
+                    });
+            }
+        }
+        switch (_response.error.reason) {
+            case "non-json":
+                throw new errors.PlanqkApiError({
+                    statusCode: _response.error.statusCode,
+                    body: _response.error.rawBody,
+                    rawResponse: _response.rawResponse,
+                });
+            case "timeout":
+                throw new errors.PlanqkApiTimeoutError("Timeout exceeded when calling GET /service-executions/v1/{id}/metrics.");
+            case "unknown":
+                throw new errors.PlanqkApiError({
+                    message: _response.error.errorMessage,
+                    rawResponse: _response.rawResponse,
+                });
+        }
+    }
+    async _getCustomAuthorizationHeaders() {
+        const apiKeyValue = await core.Supplier.get(this._options.apiKey);
+        return { "X-Auth-Token": apiKeyValue };
+    }
+}
+exports.ServiceExecutions = ServiceExecutions;

package/dist/sdk/api/resources/serviceExecutions/client/index.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/sdk/api/resources/serviceExecutions/index.d.ts

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

package/dist/sdk/api/resources/serviceExecutions/index.js

@@ -0,0 +1,17 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./client/index.js"), exports);

package/dist/sdk/api/resources/serviceJobs/client/Client.d.ts

@@ -0,0 +1,138 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as environments from "../../../../environments.js";
+import * as core from "../../../../core/index.js";
+import * as PlanqkApi from "../../../index.js";
+export declare namespace ServiceJobs {
+    interface Options {
+        environment?: core.Supplier<environments.PlanqkApiEnvironment | string>;
+        /** Specify a custom URL to connect the client to. */
+        baseUrl?: core.Supplier<string>;
+        apiKey: core.Supplier<string>;
+        /** Override the X-OrganizationId header */
+        organizationId?: core.Supplier<string | undefined>;
+        /** Additional headers to include in requests. */
+        headers?: Record<string, string | core.Supplier<string | undefined> | undefined>;
+    }
+    interface RequestOptions {
+        /** The maximum time to wait for a response in seconds. */
+        timeoutInSeconds?: number;
+        /** The number of times to retry the request. Defaults to 2. */
+        maxRetries?: number;
+        /** A hook to abort the request. */
+        abortSignal?: AbortSignal;
+        /** Override the X-OrganizationId header */
+        organizationId?: string | undefined;
+        /** Additional query string parameters to include in the request. */
+        queryParams?: Record<string, unknown>;
+        /** Additional headers to include in the request. */
+        headers?: Record<string, string | core.Supplier<string | undefined> | undefined>;
+    }
+}
+/**
+ * Run your created services in a job-based manner. Service jobs allow you to execute services with specific parameters and track their execution status, costs, logs, metrics, and results.
+ */
+export declare class ServiceJobs {
+    protected readonly _options: ServiceJobs.Options;
+    constructor(_options: ServiceJobs.Options);
+    /**
+     * Cancel a specific service job (identified by its ID). Only service jobs that are pending or currently running can be cancelled.
+     *
+     * @param {string} id
+     * @param {ServiceJobs.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link PlanqkApi.UnauthorizedError}
+     * @throws {@link PlanqkApi.ForbiddenError}
+     * @throws {@link PlanqkApi.NotFoundError}
+     * @throws {@link PlanqkApi.InternalServerError}
+     *
+     * @example
+     *     await client.serviceJobs.cancelServiceJob("id")
+     */
+    cancelServiceJob(id: string, requestOptions?: ServiceJobs.RequestOptions): core.HttpResponsePromise<void>;
+    private __cancelServiceJob;
+    /**
+     * Get a list of all service jobs for the current user or organization.
+     *
+     * @param {ServiceJobs.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link PlanqkApi.UnauthorizedError}
+     * @throws {@link PlanqkApi.ForbiddenError}
+     * @throws {@link PlanqkApi.NotFoundError}
+     * @throws {@link PlanqkApi.InternalServerError}
+     *
+     * @example
+     *     await client.serviceJobs.getServiceJobs()
+     */
+    getServiceJobs(requestOptions?: ServiceJobs.RequestOptions): core.HttpResponsePromise<PlanqkApi.ServiceJobDto[]>;
+    private __getServiceJobs;
+    /**
+     * Create and start a new service job.
+     *
+     * @param {PlanqkApi.CreateServiceJobRequest} request
+     * @param {ServiceJobs.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link PlanqkApi.BadRequestError}
+     * @throws {@link PlanqkApi.UnauthorizedError}
+     * @throws {@link PlanqkApi.ForbiddenError}
+     * @throws {@link PlanqkApi.NotFoundError}
+     * @throws {@link PlanqkApi.InternalServerError}
+     *
+     * @example
+     *     await client.serviceJobs.createServiceJob()
+     */
+    createServiceJob(request?: PlanqkApi.CreateServiceJobRequest, requestOptions?: ServiceJobs.RequestOptions): core.HttpResponsePromise<PlanqkApi.ServiceJobDto>;
+    private __createServiceJob;
+    /**
+     * Get a specific service job (identified by its ID).
+     *
+     * @param {string} id
+     * @param {ServiceJobs.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link PlanqkApi.UnauthorizedError}
+     * @throws {@link PlanqkApi.ForbiddenError}
+     * @throws {@link PlanqkApi.NotFoundError}
+     * @throws {@link PlanqkApi.InternalServerError}
+     *
+     * @example
+     *     await client.serviceJobs.getServiceJob("id")
+     */
+    getServiceJob(id: string, requestOptions?: ServiceJobs.RequestOptions): core.HttpResponsePromise<PlanqkApi.ServiceJobDto>;
+    private __getServiceJob;
+    /**
+     * Get the results for a specific service job (identified by its ID). If the service job has not completed yet or no results are available, a HTTP 204 (No Content) response is returned with a Retry-After header.
+     *
+     * @param {string} id
+     * @param {ServiceJobs.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link PlanqkApi.UnauthorizedError}
+     * @throws {@link PlanqkApi.ForbiddenError}
+     * @throws {@link PlanqkApi.NotFoundError}
+     * @throws {@link PlanqkApi.InternalServerError}
+     *
+     * @example
+     *     await client.serviceJobs.getServiceJobResults("id")
+     */
+    getServiceJobResults(id: string, requestOptions?: ServiceJobs.RequestOptions): core.HttpResponsePromise<Record<string, any>>;
+    private __getServiceJobResults;
+    /**
+     * Get the logs for a specific service job (identified by its ID). If the service job has not started yet or no logs are available, a HTTP 204 (No Content) response is returned with a Retry-After header.
+     *
+     * @param {string} id
+     * @param {ServiceJobs.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link PlanqkApi.UnauthorizedError}
+     * @throws {@link PlanqkApi.ForbiddenError}
+     * @throws {@link PlanqkApi.NotFoundError}
+     * @throws {@link PlanqkApi.InternalServerError}
+     *
+     * @example
+     *     await client.serviceJobs.getServiceJobLogs("id")
+     */
+    getServiceJobLogs(id: string, requestOptions?: ServiceJobs.RequestOptions): core.HttpResponsePromise<PlanqkApi.ServiceExecutionLogs>;
+    private __getServiceJobLogs;
+    protected _getCustomAuthorizationHeaders(): Promise<{
+        "X-Auth-Token": string;
+    }>;
+}