@planqk/planqk-api-sdk 1.2.0 → 1.3.1

package/dist/api/resources/authentication/client/Client.d.ts

@@ -1,55 +0,0 @@
-/**
- * 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 Authentication {
-    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 | undefined>;
-        /** 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 headers to include in the request. */
-        headers?: Record<string, string | core.Supplier<string | undefined> | undefined>;
-    }
-}
-/**
- * Endpoints for checking authentication and authorization.
- */
-export declare class Authentication {
-    protected readonly _options: Authentication.Options;
-    constructor(_options?: Authentication.Options);
-    /**
-     * Get the authenticated principal based on the provided token.
-     *
-     * @param {Authentication.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @throws {@link PlanqkApi.UnauthorizedError}
-     * @throws {@link PlanqkApi.ForbiddenError}
-     * @throws {@link PlanqkApi.NotFoundError}
-     * @throws {@link PlanqkApi.InternalServerError}
-     *
-     * @example
-     *     await client.authentication.authorize()
-     */
-    authorize(requestOptions?: Authentication.RequestOptions): core.HttpResponsePromise<PlanqkApi.AuthorizeResponse>;
-    private __authorize;
-    protected _getCustomAuthorizationHeaders(): Promise<{
-        "X-Auth-Token": string | undefined;
-    }>;
-}

package/dist/api/resources/authentication/client/Client.js

@@ -1,126 +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 () {
-    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.Authentication = 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"));
-/**
- * Endpoints for checking authentication and authorization.
- */
-class Authentication {
-    _options;
-    constructor(_options = {}) {
-        this._options = _options;
-    }
-    /**
-     * Get the authenticated principal based on the provided token.
-     *
-     * @param {Authentication.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @throws {@link PlanqkApi.UnauthorizedError}
-     * @throws {@link PlanqkApi.ForbiddenError}
-     * @throws {@link PlanqkApi.NotFoundError}
-     * @throws {@link PlanqkApi.InternalServerError}
-     *
-     * @example
-     *     await client.authentication.authorize()
-     */
-    authorize(requestOptions) {
-        return core.HttpResponsePromise.fromPromise(this.__authorize(requestOptions));
-    }
-    async __authorize(requestOptions) {
-        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, "authorize"),
-            method: "POST",
-            headers: (0, headers_js_1.mergeHeaders)(this._options?.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({
-                "X-OrganizationId": requestOptions?.organizationId,
-                ...(await this._getCustomAuthorizationHeaders()),
-            }), requestOptions?.headers),
-            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 POST /authorize.");
-            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.Authentication = Authentication;

package/dist/api/resources/authentication/client/index.d.ts

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

package/dist/api/resources/authentication/index.d.ts

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

package/dist/api/resources/authentication/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/index.js"), exports);
-__exportStar(require("./client/index.js"), exports);

package/dist/api/resources/authentication/types/AuthorizeResponse.d.ts

@@ -1,5 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as PlanqkApi from "../../../index.js";
-export type AuthorizeResponse = PlanqkApi.PersonalAccessTokenPrincipal | PlanqkApi.ServiceExecutionTokenPrincipal;

package/dist/api/resources/authentication/types/AuthorizeResponse.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/api/resources/authentication/types/index.d.ts

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

package/dist/api/resources/dataPools/client/requests/index.js

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

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

@@ -1,4 +0,0 @@
-export * as authentication from "./authentication/index.js";
-export * from "./authentication/types/index.js";
-export * as dataPools from "./dataPools/index.js";
-export * from "./dataPools/client/requests/index.js";

package/dist/api/types/AccessToken.d.ts

@@ -1,10 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-export interface AccessToken {
-    id?: string;
-    name?: string;
-    createdAt?: string;
-    usedAt?: string;
-    expiresAt?: string;
-}

package/dist/api/types/AccessToken.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/api/types/OrganizationMembership.d.ts

@@ -1,22 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-export interface OrganizationMembership {
-    id?: string;
-    accountType?: OrganizationMembership.AccountType;
-    role?: OrganizationMembership.Role;
-}
-export declare namespace OrganizationMembership {
-    type AccountType = "BASIC" | "PRO" | "BUSINESS";
-    const AccountType: {
-        readonly Basic: "BASIC";
-        readonly Pro: "PRO";
-        readonly Business: "BUSINESS";
-    };
-    type Role = "VIEWER" | "MAINTAINER" | "OWNER";
-    const Role: {
-        readonly Viewer: "VIEWER";
-        readonly Maintainer: "MAINTAINER";
-        readonly Owner: "OWNER";
-    };
-}

package/dist/api/types/OrganizationMembership.js

@@ -1,19 +0,0 @@
-"use strict";
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.OrganizationMembership = void 0;
-var OrganizationMembership;
-(function (OrganizationMembership) {
-    OrganizationMembership.AccountType = {
-        Basic: "BASIC",
-        Pro: "PRO",
-        Business: "BUSINESS",
-    };
-    OrganizationMembership.Role = {
-        Viewer: "VIEWER",
-        Maintainer: "MAINTAINER",
-        Owner: "OWNER",
-    };
-})(OrganizationMembership || (exports.OrganizationMembership = OrganizationMembership = {}));

package/dist/api/types/PersonalAccessTokenPrincipal.d.ts

@@ -1,18 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as PlanqkApi from "../index.js";
-export interface PersonalAccessTokenPrincipal {
-    id?: string;
-    accessToken?: PlanqkApi.AccessToken;
-    accountType?: PersonalAccessTokenPrincipal.AccountType;
-    organizationMemberships?: PlanqkApi.OrganizationMembership[];
-}
-export declare namespace PersonalAccessTokenPrincipal {
-    type AccountType = "BASIC" | "PRO" | "BUSINESS";
-    const AccountType: {
-        readonly Basic: "BASIC";
-        readonly Pro: "PRO";
-        readonly Business: "BUSINESS";
-    };
-}

package/dist/api/types/PersonalAccessTokenPrincipal.js

@@ -1,14 +0,0 @@
-"use strict";
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.PersonalAccessTokenPrincipal = void 0;
-var PersonalAccessTokenPrincipal;
-(function (PersonalAccessTokenPrincipal) {
-    PersonalAccessTokenPrincipal.AccountType = {
-        Basic: "BASIC",
-        Pro: "PRO",
-        Business: "BUSINESS",
-    };
-})(PersonalAccessTokenPrincipal || (exports.PersonalAccessTokenPrincipal = PersonalAccessTokenPrincipal = {}));

package/dist/api/types/ServiceExecution.d.ts

@@ -1,20 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-export interface ServiceExecution {
-    id?: string;
-    createdAt?: string;
-    startedAt?: string;
-    endedAt?: string;
-    status?: ServiceExecution.Status;
-}
-export declare namespace ServiceExecution {
-    type Status = "UNKNOWN" | "PENDING" | "RUNNING" | "SUCCEEDED" | "FAILED";
-    const Status: {
-        readonly Unknown: "UNKNOWN";
-        readonly Pending: "PENDING";
-        readonly Running: "RUNNING";
-        readonly Succeeded: "SUCCEEDED";
-        readonly Failed: "FAILED";
-    };
-}

package/dist/api/types/ServiceExecution.js

@@ -1,16 +0,0 @@
-"use strict";
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ServiceExecution = void 0;
-var ServiceExecution;
-(function (ServiceExecution) {
-    ServiceExecution.Status = {
-        Unknown: "UNKNOWN",
-        Pending: "PENDING",
-        Running: "RUNNING",
-        Succeeded: "SUCCEEDED",
-        Failed: "FAILED",
-    };
-})(ServiceExecution || (exports.ServiceExecution = ServiceExecution = {}));

package/dist/api/types/ServiceExecutionTokenPrincipal.d.ts

@@ -1,8 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as PlanqkApi from "../index.js";
-export interface ServiceExecutionTokenPrincipal {
-    serviceExecution?: PlanqkApi.ServiceExecution;
-    serviceProvider?: PlanqkApi.UserContext;
-}

package/dist/api/types/ServiceExecutionTokenPrincipal.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/api/types/UserContext.d.ts

@@ -1,24 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as PlanqkApi from "../index.js";
-export interface UserContext {
-    id?: string;
-    contextType?: UserContext.ContextType;
-    accountType?: UserContext.AccountType;
-    parent?: PlanqkApi.UserContext;
-}
-export declare namespace UserContext {
-    type ContextType = "USER" | "ORGANIZATION" | "SERVICE_EXECUTION";
-    const ContextType: {
-        readonly User: "USER";
-        readonly Organization: "ORGANIZATION";
-        readonly ServiceExecution: "SERVICE_EXECUTION";
-    };
-    type AccountType = "BASIC" | "PRO" | "BUSINESS";
-    const AccountType: {
-        readonly Basic: "BASIC";
-        readonly Pro: "PRO";
-        readonly Business: "BUSINESS";
-    };
-}

package/dist/api/types/UserContext.js

@@ -1,19 +0,0 @@
-"use strict";
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.UserContext = void 0;
-var UserContext;
-(function (UserContext) {
-    UserContext.ContextType = {
-        User: "USER",
-        Organization: "ORGANIZATION",
-        ServiceExecution: "SERVICE_EXECUTION",
-    };
-    UserContext.AccountType = {
-        Basic: "BASIC",
-        Pro: "PRO",
-        Business: "BUSINESS",
-    };
-})(UserContext || (exports.UserContext = UserContext = {}));

package/dist/api/types/index.d.ts

@@ -1,9 +0,0 @@
-export * from "./OauthScope.js";
-export * from "./DataPoolDto.js";
-export * from "./DataPoolFileDto.js";
-export * from "./AccessToken.js";
-export * from "./OrganizationMembership.js";
-export * from "./PersonalAccessTokenPrincipal.js";
-export * from "./ServiceExecution.js";
-export * from "./ServiceExecutionTokenPrincipal.js";
-export * from "./UserContext.js";

package/dist/api/types/index.js

@@ -1,25 +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("./OauthScope.js"), exports);
-__exportStar(require("./DataPoolDto.js"), exports);
-__exportStar(require("./DataPoolFileDto.js"), exports);
-__exportStar(require("./AccessToken.js"), exports);
-__exportStar(require("./OrganizationMembership.js"), exports);
-__exportStar(require("./PersonalAccessTokenPrincipal.js"), exports);
-__exportStar(require("./ServiceExecution.js"), exports);
-__exportStar(require("./ServiceExecutionTokenPrincipal.js"), exports);
-__exportStar(require("./UserContext.js"), exports);

package/planqk/api/sdk/authentication/__init__.py

@@ -1,7 +0,0 @@
-# This file was auto-generated by Fern from our API Definition.
-
-# isort: skip_file
-
-from .types import AuthorizeResponse
-
-__all__ = ["AuthorizeResponse"]

package/planqk/api/sdk/authentication/client.py

@@ -1,102 +0,0 @@
-# This file was auto-generated by Fern from our API Definition.
-
-import typing
-
-from ..core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
-from ..core.request_options import RequestOptions
-from .raw_client import AsyncRawAuthenticationClient, RawAuthenticationClient
-from .types.authorize_response import AuthorizeResponse
-
-
-class AuthenticationClient:
-    def __init__(self, *, client_wrapper: SyncClientWrapper):
-        self._raw_client = RawAuthenticationClient(client_wrapper=client_wrapper)
-
-    @property
-    def with_raw_response(self) -> RawAuthenticationClient:
-        """
-        Retrieves a raw implementation of this client that returns raw responses.
-
-        Returns
-        -------
-        RawAuthenticationClient
-        """
-        return self._raw_client
-
-    def authorize(self, *, request_options: typing.Optional[RequestOptions] = None) -> AuthorizeResponse:
-        """
-        Get the authenticated principal based on the provided token.
-
-        Parameters
-        ----------
-        request_options : typing.Optional[RequestOptions]
-            Request-specific configuration.
-
-        Returns
-        -------
-        AuthorizeResponse
-            The scopes of the provided token.
-
-        Examples
-        --------
-        from planqk import PlanqkApi
-
-        client = PlanqkApi(
-            organization_id="YOUR_ORGANIZATION_ID",
-            api_key="YOUR_API_KEY",
-        )
-        client.authentication.authorize()
-        """
-        _response = self._raw_client.authorize(request_options=request_options)
-        return _response.data
-
-
-class AsyncAuthenticationClient:
-    def __init__(self, *, client_wrapper: AsyncClientWrapper):
-        self._raw_client = AsyncRawAuthenticationClient(client_wrapper=client_wrapper)
-
-    @property
-    def with_raw_response(self) -> AsyncRawAuthenticationClient:
-        """
-        Retrieves a raw implementation of this client that returns raw responses.
-
-        Returns
-        -------
-        AsyncRawAuthenticationClient
-        """
-        return self._raw_client
-
-    async def authorize(self, *, request_options: typing.Optional[RequestOptions] = None) -> AuthorizeResponse:
-        """
-        Get the authenticated principal based on the provided token.
-
-        Parameters
-        ----------
-        request_options : typing.Optional[RequestOptions]
-            Request-specific configuration.
-
-        Returns
-        -------
-        AuthorizeResponse
-            The scopes of the provided token.
-
-        Examples
-        --------
-        import asyncio
-
-        from planqk import AsyncPlanqkApi
-
-        client = AsyncPlanqkApi(
-            organization_id="YOUR_ORGANIZATION_ID",
-            api_key="YOUR_API_KEY",
-        )
-
-
-        async def main() -> None:
-            await client.authentication.authorize()
-
-
-        asyncio.run(main())
-        """
-        _response = await self._raw_client.authorize(request_options=request_options)
-        return _response.data