@planqk/planqk-service-sdk 1.9.0 → 2.1.0

package/.eslintignore

@@ -1,3 +0,0 @@
-dist
-sdk
-jest.config.js

package/.eslintrc

@@ -1,7 +0,0 @@
-{
-  "extends": [
-    "oclif",
-    "oclif-typescript"
-  ],
-  "rules": {}
-}

package/dist/sdk/api/resources/serviceApi/client/requests/GetInterimResultsRequest.d.ts

@@ -1,9 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-export interface GetInterimResultsRequest {
-    /**
-     * Either true or false to show only the last or all interim results (default: false).
-     */
-    last?: boolean;
-}

package/dist/sdk/api/resources/serviceApi/client/requests/StartExecutionRequest.d.ts

@@ -1,13 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as PlanqkServiceApi from "../../../../index";
-/**
- * @example
- *     {}
- */
-export interface StartExecutionRequest {
-    data?: PlanqkServiceApi.InputData;
-    dataRef?: PlanqkServiceApi.InputRef;
-    params?: PlanqkServiceApi.InputParams;
-}

package/dist/sdk/api/resources/serviceApi/client/requests/index.d.ts

@@ -1,2 +0,0 @@
-export { StartExecutionRequest } from "./StartExecutionRequest";
-export { GetInterimResultsRequest } from "./GetInterimResultsRequest";

package/dist/sdk/api/resources/serviceApi/client/requests/index.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -1,28 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as environments from "../../../../environments";
-import * as core from "../../../../core";
-import * as PlanqkServiceApi from "../../../index";
-export declare namespace StatusApi {
-    interface Options {
-        environment?: core.Supplier<environments.PlanqkServiceApiEnvironment | string>;
-        token: core.Supplier<core.BearerToken>;
-    }
-    interface RequestOptions {
-        timeoutInSeconds?: number;
-        maxRetries?: number;
-    }
-}
-export declare class StatusApi {
-    protected readonly _options: StatusApi.Options;
-    constructor(_options: StatusApi.Options);
-    /**
-     * Checks the health of the service.
-     *
-     * @example
-     *     await planqkServiceApi.statusApi.healthCheck()
-     */
-    healthCheck(requestOptions?: StatusApi.RequestOptions): Promise<PlanqkServiceApi.HealthCheckResponse>;
-    protected _getAuthorizationHeader(): Promise<string>;
-}

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

@@ -1,97 +0,0 @@
-"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 (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.StatusApi = void 0;
-const environments = __importStar(require("../../../../environments"));
-const core = __importStar(require("../../../../core"));
-const errors = __importStar(require("../../../../errors"));
-class StatusApi {
-    constructor(_options) {
-        this._options = _options;
-    }
-    /**
-     * Checks the health of the service.
-     *
-     * @example
-     *     await planqkServiceApi.statusApi.healthCheck()
-     */
-    healthCheck(requestOptions) {
-        var _a;
-        return __awaiter(this, void 0, void 0, function* () {
-            const _response = yield core.fetcher({
-                url: (_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.PlanqkServiceApiEnvironment.Default,
-                method: "GET",
-                headers: {
-                    Authorization: yield this._getAuthorizationHeader(),
-                    "X-Fern-Language": "JavaScript",
-                },
-                contentType: "application/json",
-                timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
-                maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
-                withCredentials: true,
-            });
-            if (_response.ok) {
-                return _response.body;
-            }
-            if (_response.error.reason === "status-code") {
-                throw new errors.PlanqkServiceApiError({
-                    statusCode: _response.error.statusCode,
-                    body: _response.error.body,
-                });
-            }
-            switch (_response.error.reason) {
-                case "non-json":
-                    throw new errors.PlanqkServiceApiError({
-                        statusCode: _response.error.statusCode,
-                        body: _response.error.rawBody,
-                    });
-                case "timeout":
-                    throw new errors.PlanqkServiceApiTimeoutError();
-                case "unknown":
-                    throw new errors.PlanqkServiceApiError({
-                        message: _response.error.errorMessage,
-                    });
-            }
-        });
-    }
-    _getAuthorizationHeader() {
-        return __awaiter(this, void 0, void 0, function* () {
-            return `Bearer ${yield core.Supplier.get(this._options.token)}`;
-        });
-    }
-}
-exports.StatusApi = StatusApi;

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

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

package/dist/sdk/api/resources/statusApi/client/index.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -1,2 +0,0 @@
-export * from "./types";
-export * from "./client";

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

@@ -1,18 +0,0 @@
-"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("./types"), exports);
-__exportStar(require("./client"), exports);

package/dist/sdk/api/resources/statusApi/types/index.d.ts

@@ -1 +0,0 @@
-export * from "./HealthCheckResponse";

package/dist/sdk/api/resources/statusApi/types/index.js

@@ -1,17 +0,0 @@
-"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("./HealthCheckResponse"), exports);

package/dist/sdk/api/types/ArrayResponse.d.ts

@@ -1,4 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-export type ArrayResponse = Record<string, any>[];

package/dist/sdk/api/types/InterimResultResponse.d.ts

@@ -1,4 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-export type InterimResultResponse = Record<string, any>;

package/dist/sdk/api/types/InterimResultResponse.js

@@ -1,5 +0,0 @@
-"use strict";
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/sdk/api/types/Job.js

@@ -1,5 +0,0 @@
-"use strict";
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/sdk/api/types/NumberResponse.d.ts

@@ -1,4 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-export type NumberResponse = number;

package/dist/sdk/api/types/NumberResponse.js

@@ -1,5 +0,0 @@
-"use strict";
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/sdk/api/types/ObjectResponse.d.ts

@@ -1,4 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-export type ObjectResponse = Record<string, any>;

package/dist/sdk/api/types/ObjectResponse.js

@@ -1,5 +0,0 @@
-"use strict";
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/sdk/api/types/StringResponse.d.ts

@@ -1,4 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-export type StringResponse = string;

package/dist/sdk/api/types/StringResponse.js

@@ -1,5 +0,0 @@
-"use strict";
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-Object.defineProperty(exports, "__esModule", { value: true });

package/jest.config.js

@@ -1,12 +0,0 @@
-require('dotenv').config();
-
-module.exports = {
-  moduleFileExtensions: ['ts', 'tsx', 'js', 'jsx', 'json', 'node'],
-  preset: 'ts-jest',
-  roots: ['<rootDir>'],
-  testEnvironment: 'node',
-  testRegex: './.*\\.(test|spec)?\\.ts$',
-  transform: {
-    '^.+\\.ts?$': 'ts-jest',
-  },
-}

package/src/sdk/api/resources/serviceApi/client/requests/GetInterimResultsRequest.ts

@@ -1,10 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-
-export interface GetInterimResultsRequest {
-    /**
-     * Either true or false to show only the last or all interim results (default: false).
-     */
-    last?: boolean;
-}

package/src/sdk/api/resources/serviceApi/client/requests/StartExecutionRequest.ts

@@ -1,15 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-
-import * as PlanqkServiceApi from "../../../../index";
-
-/**
- * @example
- *     {}
- */
-export interface StartExecutionRequest {
-    data?: PlanqkServiceApi.InputData;
-    dataRef?: PlanqkServiceApi.InputRef;
-    params?: PlanqkServiceApi.InputParams;
-}

package/src/sdk/api/resources/serviceApi/client/requests/index.ts

@@ -1,2 +0,0 @@
-export { StartExecutionRequest } from "./StartExecutionRequest";
-export { GetInterimResultsRequest } from "./GetInterimResultsRequest";

package/src/sdk/api/resources/serviceApi/types/GetInterimResultsResponse.ts

@@ -1,9 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-
-import * as PlanqkServiceApi from "../../../index";
-
-export type GetInterimResultsResponse =
-    | PlanqkServiceApi.InterimResultResponse[]
-    | PlanqkServiceApi.InterimResultResponse;

package/src/sdk/api/resources/statusApi/client/Client.ts

@@ -1,75 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-
-import * as environments from "../../../../environments";
-import * as core from "../../../../core";
-import * as PlanqkServiceApi from "../../../index";
-import * as errors from "../../../../errors";
-
-export declare namespace StatusApi {
-    interface Options {
-        environment?: core.Supplier<environments.PlanqkServiceApiEnvironment | string>;
-        token: core.Supplier<core.BearerToken>;
-    }
-
-    interface RequestOptions {
-        timeoutInSeconds?: number;
-        maxRetries?: number;
-    }
-}
-
-export class StatusApi {
-    constructor(protected readonly _options: StatusApi.Options) {}
-
-    /**
-     * Checks the health of the service.
-     *
-     * @example
-     *     await planqkServiceApi.statusApi.healthCheck()
-     */
-    public async healthCheck(requestOptions?: StatusApi.RequestOptions): Promise<PlanqkServiceApi.HealthCheckResponse> {
-        const _response = await core.fetcher({
-            url:
-                (await core.Supplier.get(this._options.environment)) ??
-                environments.PlanqkServiceApiEnvironment.Default,
-            method: "GET",
-            headers: {
-                Authorization: await this._getAuthorizationHeader(),
-                "X-Fern-Language": "JavaScript",
-            },
-            contentType: "application/json",
-            timeoutMs: requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
-            maxRetries: requestOptions?.maxRetries,
-            withCredentials: true,
-        });
-        if (_response.ok) {
-            return _response.body as PlanqkServiceApi.HealthCheckResponse;
-        }
-
-        if (_response.error.reason === "status-code") {
-            throw new errors.PlanqkServiceApiError({
-                statusCode: _response.error.statusCode,
-                body: _response.error.body,
-            });
-        }
-
-        switch (_response.error.reason) {
-            case "non-json":
-                throw new errors.PlanqkServiceApiError({
-                    statusCode: _response.error.statusCode,
-                    body: _response.error.rawBody,
-                });
-            case "timeout":
-                throw new errors.PlanqkServiceApiTimeoutError();
-            case "unknown":
-                throw new errors.PlanqkServiceApiError({
-                    message: _response.error.errorMessage,
-                });
-        }
-    }
-
-    protected async _getAuthorizationHeader() {
-        return `Bearer ${await core.Supplier.get(this._options.token)}`;
-    }
-}

package/src/sdk/api/resources/statusApi/client/index.ts

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

package/src/sdk/api/resources/statusApi/index.ts

@@ -1,2 +0,0 @@
-export * from "./types";
-export * from "./client";

package/src/sdk/api/resources/statusApi/types/index.ts

@@ -1 +0,0 @@
-export * from "./HealthCheckResponse";

package/src/sdk/api/types/ArrayResponse.ts

@@ -1,5 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-
-export type ArrayResponse = Record<string, any>[];

package/src/sdk/api/types/InterimResultResponse.ts

@@ -1,5 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-
-export type InterimResultResponse = Record<string, any>;

package/src/sdk/api/types/NumberResponse.ts

@@ -1,5 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-
-export type NumberResponse = number;

package/src/sdk/api/types/ObjectResponse.ts

@@ -1,5 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-
-export type ObjectResponse = Record<string, any>;

package/src/sdk/api/types/StringResponse.ts

@@ -1,5 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-
-export type StringResponse = string;