@planqk/planqk-api-sdk 1.0.2 → 1.2.0

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

@@ -0,0 +1,31 @@
+# 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

@@ -0,0 +1,5 @@
+# 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

@@ -0,0 +1,27 @@
+# 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

@@ -0,0 +1,7 @@
+# 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

@@ -0,0 +1,34 @@
+# 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

@@ -0,0 +1,35 @@
+# 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

@@ -0,0 +1,5 @@
+# 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

@@ -0,0 +1,5 @@
+# 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/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "planqk-api-sdk"
-version = "1.0.2"
+version = "1.2.0"
 description = "SDK to interact with the official PLANQK API."
 authors = [
     { name = "Kipu Quantum GmbH", email = "info@kipu-quantum.com" },
@@ -49,3 +49,8 @@ include = ["planqk*"]
 ignore-paths = '^planqk/api/sdk/.*$'
 max-line-length = 120
 disable = ['missing-module-docstring', 'missing-class-docstring', 'missing-function-docstring']
+
+[tool.uv.workspace]
+members = [
+    "python-test-app",
+]

package/src/Client.ts

@@ -6,13 +6,16 @@ import * as environments from "./environments.js";
 import * as core from "./core/index.js";
 import { mergeHeaders } from "./core/headers.js";
 import { DataPools } from "./api/resources/dataPools/client/Client.js";
+import { Authentication } from "./api/resources/authentication/client/Client.js";
 
 export declare namespace PlanqkApiClient {
     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>;
+        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>;
     }
@@ -24,6 +27,8 @@ export declare namespace PlanqkApiClient {
         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>;
     }
@@ -32,12 +37,14 @@ export declare namespace PlanqkApiClient {
 export class PlanqkApiClient {
     protected readonly _options: PlanqkApiClient.Options;
     protected _dataPools: DataPools | undefined;
+    protected _authentication: Authentication | undefined;
 
-    constructor(_options: PlanqkApiClient.Options) {
+    constructor(_options: PlanqkApiClient.Options = {}) {
         this._options = {
             ..._options,
             headers: mergeHeaders(
                 {
+                    "X-OrganizationId": _options?.organizationId,
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-Runtime": core.RUNTIME.type,
                     "X-Fern-Runtime-Version": core.RUNTIME.version,
@@ -50,4 +57,8 @@ export class PlanqkApiClient {
     public get dataPools(): DataPools {
         return (this._dataPools ??= new DataPools(this._options));
     }
+
+    public get authentication(): Authentication {
+        return (this._authentication ??= new Authentication(this._options));
+    }
 }

package/src/api/index.ts

@@ -1,3 +1,3 @@
+export * from "./resources/index.js";
 export * from "./types/index.js";
 export * from "./errors/index.js";
-export * from "./resources/index.js";

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

@@ -0,0 +1,134 @@
+/**
+ * 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

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

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

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

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

@@ -0,0 +1,7 @@
+/**
+ * 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

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

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

@@ -14,7 +14,9 @@ export declare namespace DataPools {
         environment?: core.Supplier<environments.PlanqkApiEnvironment | string>;
         /** Specify a custom URL to connect the client to. */
         baseUrl?: core.Supplier<string>;
-        apiKey: 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>;
     }
@@ -26,15 +28,20 @@ export declare namespace DataPools {
         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>;
     }
 }
 
+/**
+ * Manage data pools, which are organized collections of files that serve as reusable data sources for services.
+ */
 export class DataPools {
     protected readonly _options: DataPools.Options;
 
-    constructor(_options: DataPools.Options) {
+    constructor(_options: DataPools.Options = {}) {
         this._options = _options;
     }
 
@@ -73,7 +80,10 @@ export class DataPools {
             method: "GET",
             headers: mergeHeaders(
                 this._options?.headers,
-                mergeOnlyDefinedHeaders({ ...(await this._getCustomAuthorizationHeaders()) }),
+                mergeOnlyDefinedHeaders({
+                    "X-OrganizationId": requestOptions?.organizationId,
+                    ...(await this._getCustomAuthorizationHeaders()),
+                }),
                 requestOptions?.headers,
             ),
             timeoutMs: requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
@@ -160,7 +170,10 @@ export class DataPools {
             method: "PUT",
             headers: mergeHeaders(
                 this._options?.headers,
-                mergeOnlyDefinedHeaders({ ...(await this._getCustomAuthorizationHeaders()) }),
+                mergeOnlyDefinedHeaders({
+                    "X-OrganizationId": requestOptions?.organizationId,
+                    ...(await this._getCustomAuthorizationHeaders()),
+                }),
                 requestOptions?.headers,
             ),
             contentType: "application/json",
@@ -245,7 +258,10 @@ export class DataPools {
             method: "DELETE",
             headers: mergeHeaders(
                 this._options?.headers,
-                mergeOnlyDefinedHeaders({ ...(await this._getCustomAuthorizationHeaders()) }),
+                mergeOnlyDefinedHeaders({
+                    "X-OrganizationId": requestOptions?.organizationId,
+                    ...(await this._getCustomAuthorizationHeaders()),
+                }),
                 requestOptions?.headers,
             ),
             timeoutMs: requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
@@ -323,7 +339,10 @@ export class DataPools {
             method: "GET",
             headers: mergeHeaders(
                 this._options?.headers,
-                mergeOnlyDefinedHeaders({ ...(await this._getCustomAuthorizationHeaders()) }),
+                mergeOnlyDefinedHeaders({
+                    "X-OrganizationId": requestOptions?.organizationId,
+                    ...(await this._getCustomAuthorizationHeaders()),
+                }),
                 requestOptions?.headers,
             ),
             timeoutMs: requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
@@ -407,7 +426,10 @@ export class DataPools {
             method: "POST",
             headers: mergeHeaders(
                 this._options?.headers,
-                mergeOnlyDefinedHeaders({ ...(await this._getCustomAuthorizationHeaders()) }),
+                mergeOnlyDefinedHeaders({
+                    "X-OrganizationId": requestOptions?.organizationId,
+                    ...(await this._getCustomAuthorizationHeaders()),
+                }),
                 requestOptions?.headers,
             ),
             contentType: "application/json",
@@ -495,7 +517,10 @@ export class DataPools {
             method: "GET",
             headers: mergeHeaders(
                 this._options?.headers,
-                mergeOnlyDefinedHeaders({ ...(await this._getCustomAuthorizationHeaders()) }),
+                mergeOnlyDefinedHeaders({
+                    "X-OrganizationId": requestOptions?.organizationId,
+                    ...(await this._getCustomAuthorizationHeaders()),
+                }),
                 requestOptions?.headers,
             ),
             timeoutMs: requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
@@ -593,6 +618,7 @@ export class DataPools {
             headers: mergeHeaders(
                 this._options?.headers,
                 mergeOnlyDefinedHeaders({
+                    "X-OrganizationId": requestOptions?.organizationId,
                     ...(await this._getCustomAuthorizationHeaders()),
                     ..._maybeEncodedRequest.headers,
                 }),
@@ -679,7 +705,10 @@ export class DataPools {
             method: "GET",
             headers: mergeHeaders(
                 this._options?.headers,
-                mergeOnlyDefinedHeaders({ ...(await this._getCustomAuthorizationHeaders()) }),
+                mergeOnlyDefinedHeaders({
+                    "X-OrganizationId": requestOptions?.organizationId,
+                    ...(await this._getCustomAuthorizationHeaders()),
+                }),
                 requestOptions?.headers,
             ),
             responseType: "binary-response",
@@ -768,7 +797,10 @@ export class DataPools {
             method: "DELETE",
             headers: mergeHeaders(
                 this._options?.headers,
-                mergeOnlyDefinedHeaders({ ...(await this._getCustomAuthorizationHeaders()) }),
+                mergeOnlyDefinedHeaders({
+                    "X-OrganizationId": requestOptions?.organizationId,
+                    ...(await this._getCustomAuthorizationHeaders()),
+                }),
                 requestOptions?.headers,
             ),
             timeoutMs: requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000,

package/src/api/resources/index.ts

@@ -1,2 +1,4 @@
+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

@@ -0,0 +1,11 @@
+/**
+ * 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

@@ -0,0 +1,24 @@
+/**
+ * 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

@@ -0,0 +1,21 @@
+/**
+ * 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;
+}

package/src/api/types/ServiceExecution.ts

@@ -0,0 +1,22 @@
+/**
+ * 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 namespace ServiceExecution {
+    export type Status = "UNKNOWN" | "PENDING" | "RUNNING" | "SUCCEEDED" | "FAILED";
+    export const Status = {
+        Unknown: "UNKNOWN",
+        Pending: "PENDING",
+        Running: "RUNNING",
+        Succeeded: "SUCCEEDED",
+        Failed: "FAILED",
+    } as const;
+}

package/src/api/types/ServiceExecutionTokenPrincipal.ts

@@ -0,0 +1,10 @@
+/**
+ * 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/src/api/types/UserContext.ts

@@ -0,0 +1,27 @@
+/**
+ * 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 namespace UserContext {
+    export type ContextType = "USER" | "ORGANIZATION" | "SERVICE_EXECUTION";
+    export const ContextType = {
+        User: "USER",
+        Organization: "ORGANIZATION",
+        ServiceExecution: "SERVICE_EXECUTION",
+    } as const;
+    export type AccountType = "BASIC" | "PRO" | "BUSINESS";
+    export const AccountType = {
+        Basic: "BASIC",
+        Pro: "PRO",
+        Business: "BUSINESS",
+    } as const;
+}

package/src/api/types/index.ts

@@ -1,3 +1,9 @@
 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";