@planqk/planqk-api-sdk 1.1.0 → 1.3.0

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

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

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

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

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

@@ -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.1.0"
+version = "1.3.0"
 description = "SDK to interact with the official PLANQK API."
 authors = [
     { name = "Kipu Quantum GmbH", email = "info@kipu-quantum.com" },
@@ -28,6 +28,7 @@ dev = [
     "pylint>=3.3.5",
     "pytest>=8.3.5",
     "pytest-dotenv>=0.5.2",
+    "python-dotenv>=1.1.1",
 ]
 
 [project.urls]
@@ -49,8 +50,3 @@ 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/index.test.ts

@@ -1,15 +1,16 @@
 import process from 'node:process'
 import {test} from 'vitest'
 import 'dotenv/config'
-import {PlanqkApiClient} from "./Client";
+import {PlanqkApiClient} from "./sdk";
 
-test.skip('adds 1 + 2 to equal 3', {timeout: 5 * 60 * 1000}, async () => {
-  const accessToken = process.env.PLANQK_PERSONAL_ACCESS_TOKEN!
+test.skip('integration test: data pools', {timeout: 5 * 60 * 1000}, async () => {
   const baseUrl = process.env.PLANQK_API_BASE_URL!
+  const apiKey = process.env.PLANQK_PERSONAL_ACCESS_TOKEN!
+  const organizationId = process.env.PLANQK_ORGANIZATION_ID
 
-  const client = new PlanqkApiClient({baseUrl: baseUrl, apiKey: () => accessToken});
+  const client = new PlanqkApiClient({baseUrl, apiKey, organizationId})
 
-  const dataPools = await client.dataPools.getDataPools();
+  const dataPools = await client.dataPools.getDataPools()
   console.log(dataPools)
 
   const files = await client.dataPools.getDataPoolFiles(dataPools[0].id!)

package/src/index.ts

@@ -1,4 +1 @@
-export * as PlanqkApi from "./api/index.js";
-export { PlanqkApiError, PlanqkApiTimeoutError } from "./errors/index.js";
-export { PlanqkApiClient } from "./Client.js";
-export { PlanqkApiEnvironment } from "./environments.js";
+export * from "./sdk";

package/src/{Client.ts → sdk/Client.ts}

@@ -13,7 +13,8 @@ export declare namespace PlanqkApiClient {
         /** Specify a custom URL to connect the client to. */
         baseUrl?: core.Supplier<string>;
         apiKey: core.Supplier<string>;
-        organizationId?: 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>;
     }
@@ -25,6 +26,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>;
     }
@@ -39,10 +42,10 @@ export class PlanqkApiClient {
             ..._options,
             headers: mergeHeaders(
                 {
+                    "X-OrganizationId": _options?.organizationId,
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-Runtime": core.RUNTIME.type,
                     "X-Fern-Runtime-Version": core.RUNTIME.version,
-                    "X-OrganizationId": _options.organizationId,
                 },
                 _options?.headers,
             ),

package/src/{api → sdk/api}/resources/dataPools/client/Client.ts

@@ -15,6 +15,8 @@ export declare namespace DataPools {
         /** 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>;
     }
@@ -26,11 +28,16 @@ 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;
 
@@ -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/sdk/index.ts

@@ -0,0 +1,4 @@
+export * as PlanqkApi from "./api/index.js";
+export { PlanqkApiError, PlanqkApiTimeoutError } from "./errors/index.js";
+export { PlanqkApiClient } from "./Client.js";
+export { PlanqkApiEnvironment } from "./environments.js";