@planqk/planqk-api-sdk 1.2.0 → 1.3.1

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

@@ -1,183 +0,0 @@
-# This file was auto-generated by Fern from our API Definition.
-
-import typing
-from json.decoder import JSONDecodeError
-
-from ..core.api_error import ApiError
-from ..core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
-from ..core.http_response import AsyncHttpResponse, HttpResponse
-from ..core.pydantic_utilities import parse_obj_as
-from ..core.request_options import RequestOptions
-from ..errors.forbidden_error import ForbiddenError
-from ..errors.internal_server_error import InternalServerError
-from ..errors.not_found_error import NotFoundError
-from ..errors.unauthorized_error import UnauthorizedError
-from .types.authorize_response import AuthorizeResponse
-
-
-class RawAuthenticationClient:
-    def __init__(self, *, client_wrapper: SyncClientWrapper):
-        self._client_wrapper = client_wrapper
-
-    def authorize(self, *, request_options: typing.Optional[RequestOptions] = None) -> HttpResponse[AuthorizeResponse]:
-        """
-        Get the authenticated principal based on the provided token.
-
-        Parameters
-        ----------
-        request_options : typing.Optional[RequestOptions]
-            Request-specific configuration.
-
-        Returns
-        -------
-        HttpResponse[AuthorizeResponse]
-            The scopes of the provided token.
-        """
-        _response = self._client_wrapper.httpx_client.request(
-            "authorize",
-            method="POST",
-            request_options=request_options,
-        )
-        try:
-            if 200 <= _response.status_code < 300:
-                _data = typing.cast(
-                    AuthorizeResponse,
-                    parse_obj_as(
-                        type_=AuthorizeResponse,  # type: ignore
-                        object_=_response.json(),
-                    ),
-                )
-                return HttpResponse(response=_response, data=_data)
-            if _response.status_code == 401:
-                raise UnauthorizedError(
-                    headers=dict(_response.headers),
-                    body=typing.cast(
-                        typing.Optional[typing.Any],
-                        parse_obj_as(
-                            type_=typing.Optional[typing.Any],  # type: ignore
-                            object_=_response.json(),
-                        ),
-                    ),
-                )
-            if _response.status_code == 403:
-                raise ForbiddenError(
-                    headers=dict(_response.headers),
-                    body=typing.cast(
-                        typing.Optional[typing.Any],
-                        parse_obj_as(
-                            type_=typing.Optional[typing.Any],  # type: ignore
-                            object_=_response.json(),
-                        ),
-                    ),
-                )
-            if _response.status_code == 404:
-                raise NotFoundError(
-                    headers=dict(_response.headers),
-                    body=typing.cast(
-                        typing.Optional[typing.Any],
-                        parse_obj_as(
-                            type_=typing.Optional[typing.Any],  # type: ignore
-                            object_=_response.json(),
-                        ),
-                    ),
-                )
-            if _response.status_code == 500:
-                raise InternalServerError(
-                    headers=dict(_response.headers),
-                    body=typing.cast(
-                        typing.Optional[typing.Any],
-                        parse_obj_as(
-                            type_=typing.Optional[typing.Any],  # type: ignore
-                            object_=_response.json(),
-                        ),
-                    ),
-                )
-            _response_json = _response.json()
-        except JSONDecodeError:
-            raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
-        raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
-
-
-class AsyncRawAuthenticationClient:
-    def __init__(self, *, client_wrapper: AsyncClientWrapper):
-        self._client_wrapper = client_wrapper
-
-    async def authorize(
-        self, *, request_options: typing.Optional[RequestOptions] = None
-    ) -> AsyncHttpResponse[AuthorizeResponse]:
-        """
-        Get the authenticated principal based on the provided token.
-
-        Parameters
-        ----------
-        request_options : typing.Optional[RequestOptions]
-            Request-specific configuration.
-
-        Returns
-        -------
-        AsyncHttpResponse[AuthorizeResponse]
-            The scopes of the provided token.
-        """
-        _response = await self._client_wrapper.httpx_client.request(
-            "authorize",
-            method="POST",
-            request_options=request_options,
-        )
-        try:
-            if 200 <= _response.status_code < 300:
-                _data = typing.cast(
-                    AuthorizeResponse,
-                    parse_obj_as(
-                        type_=AuthorizeResponse,  # type: ignore
-                        object_=_response.json(),
-                    ),
-                )
-                return AsyncHttpResponse(response=_response, data=_data)
-            if _response.status_code == 401:
-                raise UnauthorizedError(
-                    headers=dict(_response.headers),
-                    body=typing.cast(
-                        typing.Optional[typing.Any],
-                        parse_obj_as(
-                            type_=typing.Optional[typing.Any],  # type: ignore
-                            object_=_response.json(),
-                        ),
-                    ),
-                )
-            if _response.status_code == 403:
-                raise ForbiddenError(
-                    headers=dict(_response.headers),
-                    body=typing.cast(
-                        typing.Optional[typing.Any],
-                        parse_obj_as(
-                            type_=typing.Optional[typing.Any],  # type: ignore
-                            object_=_response.json(),
-                        ),
-                    ),
-                )
-            if _response.status_code == 404:
-                raise NotFoundError(
-                    headers=dict(_response.headers),
-                    body=typing.cast(
-                        typing.Optional[typing.Any],
-                        parse_obj_as(
-                            type_=typing.Optional[typing.Any],  # type: ignore
-                            object_=_response.json(),
-                        ),
-                    ),
-                )
-            if _response.status_code == 500:
-                raise InternalServerError(
-                    headers=dict(_response.headers),
-                    body=typing.cast(
-                        typing.Optional[typing.Any],
-                        parse_obj_as(
-                            type_=typing.Optional[typing.Any],  # type: ignore
-                            object_=_response.json(),
-                        ),
-                    ),
-                )
-            _response_json = _response.json()
-        except JSONDecodeError:
-            raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
-        raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)

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

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

package/planqk/api/sdk/authentication/types/authorize_response.py

@@ -1,8 +0,0 @@
-# This file was auto-generated by Fern from our API Definition.
-
-import typing
-
-from ...types.personal_access_token_principal import PersonalAccessTokenPrincipal
-from ...types.service_execution_token_principal import ServiceExecutionTokenPrincipal
-
-AuthorizeResponse = typing.Union[PersonalAccessTokenPrincipal, ServiceExecutionTokenPrincipal]

package/planqk/api/sdk/types/access_token.py

@@ -1,26 +0,0 @@
-# This file was auto-generated by Fern from our API Definition.
-
-import datetime as dt
-import typing
-
-import pydantic
-import typing_extensions
-from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
-from ..core.serialization import FieldMetadata
-
-
-class AccessToken(UniversalBaseModel):
-    id: typing.Optional[str] = None
-    name: typing.Optional[str] = None
-    created_at: typing_extensions.Annotated[typing.Optional[dt.datetime], FieldMetadata(alias="createdAt")] = None
-    used_at: typing_extensions.Annotated[typing.Optional[dt.datetime], FieldMetadata(alias="usedAt")] = None
-    expires_at: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="expiresAt")] = None
-
-    if IS_PYDANTIC_V2:
-        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
-    else:
-
-        class Config:
-            frozen = True
-            smart_union = True
-            extra = pydantic.Extra.allow

package/planqk/api/sdk/types/organization_membership.py

@@ -1,27 +0,0 @@
-# This file was auto-generated by Fern from our API Definition.
-
-import typing
-
-import pydantic
-import typing_extensions
-from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
-from ..core.serialization import FieldMetadata
-from .organization_membership_account_type import OrganizationMembershipAccountType
-from .organization_membership_role import OrganizationMembershipRole
-
-
-class OrganizationMembership(UniversalBaseModel):
-    id: typing.Optional[str] = None
-    account_type: typing_extensions.Annotated[
-        typing.Optional[OrganizationMembershipAccountType], FieldMetadata(alias="accountType")
-    ] = None
-    role: typing.Optional[OrganizationMembershipRole] = None
-
-    if IS_PYDANTIC_V2:
-        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
-    else:
-
-        class Config:
-            frozen = True
-            smart_union = True
-            extra = pydantic.Extra.allow

package/planqk/api/sdk/types/organization_membership_account_type.py

@@ -1,5 +0,0 @@
-# This file was auto-generated by Fern from our API Definition.
-
-import typing
-
-OrganizationMembershipAccountType = typing.Union[typing.Literal["BASIC", "PRO", "BUSINESS"], typing.Any]

package/planqk/api/sdk/types/organization_membership_role.py

@@ -1,5 +0,0 @@
-# This file was auto-generated by Fern from our API Definition.
-
-import typing
-
-OrganizationMembershipRole = typing.Union[typing.Literal["VIEWER", "MAINTAINER", "OWNER"], typing.Any]

package/planqk/api/sdk/types/personal_access_token_principal.py

@@ -1,31 +0,0 @@
-# This file was auto-generated by Fern from our API Definition.
-
-import typing
-
-import pydantic
-import typing_extensions
-from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
-from ..core.serialization import FieldMetadata
-from .access_token import AccessToken
-from .organization_membership import OrganizationMembership
-from .personal_access_token_principal_account_type import PersonalAccessTokenPrincipalAccountType
-
-
-class PersonalAccessTokenPrincipal(UniversalBaseModel):
-    id: typing.Optional[str] = None
-    access_token: typing_extensions.Annotated[typing.Optional[AccessToken], FieldMetadata(alias="accessToken")] = None
-    account_type: typing_extensions.Annotated[
-        typing.Optional[PersonalAccessTokenPrincipalAccountType], FieldMetadata(alias="accountType")
-    ] = None
-    organization_memberships: typing_extensions.Annotated[
-        typing.Optional[typing.List[OrganizationMembership]], FieldMetadata(alias="organizationMemberships")
-    ] = None
-
-    if IS_PYDANTIC_V2:
-        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
-    else:
-
-        class Config:
-            frozen = True
-            smart_union = True
-            extra = pydantic.Extra.allow

package/planqk/api/sdk/types/personal_access_token_principal_account_type.py

@@ -1,5 +0,0 @@
-# This file was auto-generated by Fern from our API Definition.
-
-import typing
-
-PersonalAccessTokenPrincipalAccountType = typing.Union[typing.Literal["BASIC", "PRO", "BUSINESS"], typing.Any]

package/planqk/api/sdk/types/service_execution.py

@@ -1,27 +0,0 @@
-# This file was auto-generated by Fern from our API Definition.
-
-import datetime as dt
-import typing
-
-import pydantic
-import typing_extensions
-from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
-from ..core.serialization import FieldMetadata
-from .service_execution_status import ServiceExecutionStatus
-
-
-class ServiceExecution(UniversalBaseModel):
-    id: typing.Optional[str] = None
-    created_at: typing_extensions.Annotated[typing.Optional[dt.datetime], FieldMetadata(alias="createdAt")] = None
-    started_at: typing_extensions.Annotated[typing.Optional[dt.datetime], FieldMetadata(alias="startedAt")] = None
-    ended_at: typing_extensions.Annotated[typing.Optional[dt.datetime], FieldMetadata(alias="endedAt")] = None
-    status: typing.Optional[ServiceExecutionStatus] = None
-
-    if IS_PYDANTIC_V2:
-        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
-    else:
-
-        class Config:
-            frozen = True
-            smart_union = True
-            extra = pydantic.Extra.allow

package/planqk/api/sdk/types/service_execution_status.py

@@ -1,7 +0,0 @@
-# This file was auto-generated by Fern from our API Definition.
-
-import typing
-
-ServiceExecutionStatus = typing.Union[
-    typing.Literal["UNKNOWN", "PENDING", "RUNNING", "SUCCEEDED", "FAILED"], typing.Any
-]

package/planqk/api/sdk/types/service_execution_token_principal.py

@@ -1,34 +0,0 @@
-# This file was auto-generated by Fern from our API Definition.
-
-from __future__ import annotations
-
-import typing
-
-import pydantic
-import typing_extensions
-from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel, update_forward_refs
-from ..core.serialization import FieldMetadata
-from .service_execution import ServiceExecution
-
-
-class ServiceExecutionTokenPrincipal(UniversalBaseModel):
-    service_execution: typing_extensions.Annotated[
-        typing.Optional[ServiceExecution], FieldMetadata(alias="serviceExecution")
-    ] = None
-    service_provider: typing_extensions.Annotated[
-        typing.Optional["UserContext"], FieldMetadata(alias="serviceProvider")
-    ] = None
-
-    if IS_PYDANTIC_V2:
-        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
-    else:
-
-        class Config:
-            frozen = True
-            smart_union = True
-            extra = pydantic.Extra.allow
-
-
-from .user_context import UserContext  # noqa: E402, F401, I001
-
-update_forward_refs(ServiceExecutionTokenPrincipal)

package/planqk/api/sdk/types/user_context.py

@@ -1,35 +0,0 @@
-# This file was auto-generated by Fern from our API Definition.
-
-from __future__ import annotations
-
-import typing
-
-import pydantic
-import typing_extensions
-from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel, update_forward_refs
-from ..core.serialization import FieldMetadata
-from .user_context_account_type import UserContextAccountType
-from .user_context_context_type import UserContextContextType
-
-
-class UserContext(UniversalBaseModel):
-    id: typing.Optional[str] = None
-    context_type: typing_extensions.Annotated[
-        typing.Optional[UserContextContextType], FieldMetadata(alias="contextType")
-    ] = None
-    account_type: typing_extensions.Annotated[
-        typing.Optional[UserContextAccountType], FieldMetadata(alias="accountType")
-    ] = None
-    parent: typing.Optional["UserContext"] = None
-
-    if IS_PYDANTIC_V2:
-        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
-    else:
-
-        class Config:
-            frozen = True
-            smart_union = True
-            extra = pydantic.Extra.allow
-
-
-update_forward_refs(UserContext)

package/planqk/api/sdk/types/user_context_account_type.py

@@ -1,5 +0,0 @@
-# This file was auto-generated by Fern from our API Definition.
-
-import typing
-
-UserContextAccountType = typing.Union[typing.Literal["BASIC", "PRO", "BUSINESS"], typing.Any]

package/planqk/api/sdk/types/user_context_context_type.py

@@ -1,5 +0,0 @@
-# This file was auto-generated by Fern from our API Definition.
-
-import typing
-
-UserContextContextType = typing.Union[typing.Literal["USER", "ORGANIZATION", "SERVICE_EXECUTION"], typing.Any]

package/src/api/resources/authentication/client/Client.ts

@@ -1,134 +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";
-import { mergeHeaders, mergeOnlyDefinedHeaders } from "../../../../core/headers.js";
-import * as errors from "../../../../errors/index.js";
-
-export declare namespace Authentication {
-    export 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>;
-    }
-
-    export 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 class Authentication {
-    protected readonly _options: Authentication.Options;
-
-    constructor(_options: Authentication.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()
-     */
-    public authorize(
-        requestOptions?: Authentication.RequestOptions,
-    ): core.HttpResponsePromise<PlanqkApi.AuthorizeResponse> {
-        return core.HttpResponsePromise.fromPromise(this.__authorize(requestOptions));
-    }
-
-    private async __authorize(
-        requestOptions?: Authentication.RequestOptions,
-    ): Promise<core.WithRawResponse<PlanqkApi.AuthorizeResponse>> {
-        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: mergeHeaders(
-                this._options?.headers,
-                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 as PlanqkApi.AuthorizeResponse, rawResponse: _response.rawResponse };
-        }
-
-        if (_response.error.reason === "status-code") {
-            switch (_response.error.statusCode) {
-                case 401:
-                    throw new PlanqkApi.UnauthorizedError(_response.error.body as any, _response.rawResponse);
-                case 403:
-                    throw new PlanqkApi.ForbiddenError(_response.error.body as any, _response.rawResponse);
-                case 404:
-                    throw new PlanqkApi.NotFoundError(_response.error.body as any, _response.rawResponse);
-                case 500:
-                    throw new PlanqkApi.InternalServerError(_response.error.body as any, _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,
-                });
-        }
-    }
-
-    protected async _getCustomAuthorizationHeaders() {
-        const apiKeyValue = await core.Supplier.get(this._options.apiKey);
-        return { "X-Auth-Token": apiKeyValue };
-    }
-}

package/src/api/resources/authentication/client/index.ts

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

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

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

package/src/api/resources/authentication/types/AuthorizeResponse.ts

@@ -1,7 +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/src/api/resources/authentication/types/index.ts

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

package/src/api/resources/index.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/src/api/types/AccessToken.ts

@@ -1,11 +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/src/api/types/OrganizationMembership.ts

@@ -1,24 +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 namespace OrganizationMembership {
-    export type AccountType = "BASIC" | "PRO" | "BUSINESS";
-    export const AccountType = {
-        Basic: "BASIC",
-        Pro: "PRO",
-        Business: "BUSINESS",
-    } as const;
-    export type Role = "VIEWER" | "MAINTAINER" | "OWNER";
-    export const Role = {
-        Viewer: "VIEWER",
-        Maintainer: "MAINTAINER",
-        Owner: "OWNER",
-    } as const;
-}

package/src/api/types/PersonalAccessTokenPrincipal.ts

@@ -1,21 +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 namespace PersonalAccessTokenPrincipal {
-    export type AccountType = "BASIC" | "PRO" | "BUSINESS";
-    export const AccountType = {
-        Basic: "BASIC",
-        Pro: "PRO",
-        Business: "BUSINESS",
-    } as const;
-}