@planqk/planqk-api-sdk 1.2.0 → 1.3.1

package/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "planqk-api-sdk"
-version = "1.2.0"
+version = "1.3.1"
 description = "SDK to interact with the official PLANQK API."
 authors = [
     { name = "Kipu Quantum GmbH", email = "info@kipu-quantum.com" },
@@ -18,6 +18,7 @@ license = { file = "LICENSE" }
 requires-python = ">=3.9"
 dependencies = [
     "authlib>=1.5.1",
+    "deprecated>=1.2.18",
     "httpx>=0.28.1",
     "pydantic>=2.5.0,<2.10",
 ]
@@ -28,6 +29,7 @@ dev = [
     "pylint>=3.3.5",
     "pytest>=8.3.5",
     "pytest-dotenv>=0.5.2",
+    "python-dotenv>=1.1.1",
 ]
 
 [project.urls]
@@ -49,8 +51,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}

@@ -6,14 +6,13 @@ 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 | undefined>;
+        apiKey: core.Supplier<string>;
         /** Override the X-OrganizationId header */
         organizationId?: core.Supplier<string | undefined>;
         /** Additional headers to include in requests. */
@@ -37,9 +36,8 @@ 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(
@@ -57,8 +55,4 @@ 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 → sdk/api}/resources/dataPools/client/Client.ts

@@ -14,7 +14,7 @@ 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 | undefined>;
+        apiKey: core.Supplier<string>;
         /** Override the X-OrganizationId header */
         organizationId?: core.Supplier<string | undefined>;
         /** Additional headers to include in requests. */
@@ -41,7 +41,7 @@ export declare namespace DataPools {
 export class DataPools {
     protected readonly _options: DataPools.Options;
 
-    constructor(_options: DataPools.Options = {}) {
+    constructor(_options: DataPools.Options) {
         this._options = _options;
     }
 

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

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

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

@@ -0,0 +1,3 @@
+export * from "./OauthScope.js";
+export * from "./DataPoolDto.js";
+export * from "./DataPoolFileDto.js";

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";