@planqk/planqk-api-sdk 1.1.0 → 1.2.0

package/dist/api/types/ServiceExecutionTokenPrincipal.js

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

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

@@ -0,0 +1,19 @@
+"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,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";

package/dist/api/types/index.js

@@ -17,3 +17,9 @@ 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/fern/fern.config.json

@@ -1,4 +1,4 @@
 {
   "organization": "planqk",
-  "version": "0.65.7"
+  "version": "0.65.25"
 }

package/fern/openapi/openapi.json

@@ -12,14 +12,26 @@
   },
   "servers": [
     {
-      "url": "https://34.90.225.20.nip.io/qc-catalog",
+      "url": "https://platform.planqk.de/qc-catalog",
       "description": "Generated server url"
     }
   ],
+  "tags": [
+    {
+      "name": "Authentication",
+      "description": "Endpoints for checking authentication and authorization."
+    },
+    {
+      "name": "Data Pools",
+      "description": "Manage data pools, which are organized collections of files that serve as reusable data sources for services."
+    }
+  ],
   "paths": {
     "/datapools/{id}": {
       "get": {
-        "tags": ["Data Pools"],
+        "tags": [
+          "Data Pools"
+        ],
         "description": "Get a specific data pool (identified by its ID).",
         "operationId": "getDataPool",
         "parameters": [
@@ -31,6 +43,14 @@
               "type": "string",
               "format": "uuid"
             }
+          },
+          {
+            "name": "X-OrganizationId",
+            "in": "header",
+            "description": "The ID of your organization in case you want to perform operations in this context. Leave it empty to operate in your personal account.",
+            "schema": {
+              "type": "string"
+            }
           }
         ],
         "responses": {
@@ -67,7 +87,9 @@
         ]
       },
       "put": {
-        "tags": ["Data Pools"],
+        "tags": [
+          "Data Pools"
+        ],
         "description": "Update an existing data pool (identified by its ID).",
         "operationId": "updateDataPool",
         "parameters": [
@@ -79,6 +101,14 @@
               "type": "string",
               "format": "uuid"
             }
+          },
+          {
+            "name": "X-OrganizationId",
+            "in": "header",
+            "description": "The ID of your organization in case you want to perform operations in this context. Leave it empty to operate in your personal account.",
+            "schema": {
+              "type": "string"
+            }
           }
         ],
         "requestBody": {
@@ -128,7 +158,9 @@
         ]
       },
       "delete": {
-        "tags": ["Data Pools"],
+        "tags": [
+          "Data Pools"
+        ],
         "description": "Delete a specific data pool (identified by its ID).",
         "operationId": "deleteDataPool",
         "parameters": [
@@ -140,6 +172,14 @@
               "type": "string",
               "format": "uuid"
             }
+          },
+          {
+            "name": "X-OrganizationId",
+            "in": "header",
+            "description": "The ID of your organization in case you want to perform operations in this context. Leave it empty to operate in your personal account.",
+            "schema": {
+              "type": "string"
+            }
           }
         ],
         "responses": {
@@ -171,9 +211,21 @@
     },
     "/datapools": {
       "get": {
-        "tags": ["Data Pools"],
+        "tags": [
+          "Data Pools"
+        ],
         "description": "Get a list of all data pools for the current user.",
         "operationId": "getDataPools",
+        "parameters": [
+          {
+            "name": "X-OrganizationId",
+            "in": "header",
+            "description": "The ID of your organization in case you want to perform operations in this context. Leave it empty to operate in your personal account.",
+            "schema": {
+              "type": "string"
+            }
+          }
+        ],
         "responses": {
           "200": {
             "description": "List of data pools",
@@ -211,9 +263,21 @@
         ]
       },
       "post": {
-        "tags": ["Data Pools"],
+        "tags": [
+          "Data Pools"
+        ],
         "description": "Create a new data pool.",
         "operationId": "createDataPool",
+        "parameters": [
+          {
+            "name": "X-OrganizationId",
+            "in": "header",
+            "description": "The ID of your organization in case you want to perform operations in this context. Leave it empty to operate in your personal account.",
+            "schema": {
+              "type": "string"
+            }
+          }
+        ],
         "requestBody": {
           "content": {
             "application/json": {
@@ -263,7 +327,9 @@
     },
     "/datapools/{id}/files": {
       "get": {
-        "tags": ["Data Pools"],
+        "tags": [
+          "Data Pools"
+        ],
         "description": "Get all files associated with a specific data pool (identified by its ID).",
         "operationId": "getDataPoolFiles",
         "parameters": [
@@ -275,6 +341,14 @@
               "type": "string",
               "format": "uuid"
             }
+          },
+          {
+            "name": "X-OrganizationId",
+            "in": "header",
+            "description": "The ID of your organization in case you want to perform operations in this context. Leave it empty to operate in your personal account.",
+            "schema": {
+              "type": "string"
+            }
           }
         ],
         "responses": {
@@ -314,7 +388,9 @@
         ]
       },
       "post": {
-        "tags": ["Data Pools"],
+        "tags": [
+          "Data Pools"
+        ],
         "description": "Add a new file to a specific data pool (identified by its ID).",
         "operationId": "addDataPoolFile",
         "parameters": [
@@ -334,6 +410,14 @@
             "schema": {
               "type": "string"
             }
+          },
+          {
+            "name": "X-OrganizationId",
+            "in": "header",
+            "description": "The ID of your organization in case you want to perform operations in this context. Leave it empty to operate in your personal account.",
+            "schema": {
+              "type": "string"
+            }
           }
         ],
         "requestBody": {
@@ -347,7 +431,9 @@
                     "format": "binary"
                   }
                 },
-                "required": ["file"]
+                "required": [
+                  "file"
+                ]
               }
             }
           }
@@ -389,9 +475,62 @@
         ]
       }
     },
+    "/authorize": {
+      "post": {
+        "tags": [
+          "Authentication"
+        ],
+        "description": "Get the authenticated principal based on the provided token.",
+        "operationId": "authorize",
+        "parameters": [
+          {
+            "name": "X-Auth-Token",
+            "in": "header",
+            "required": false,
+            "schema": {
+              "type": "string"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "The scopes of the provided token.",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "oneOf": [
+                    {
+                      "$ref": "#/components/schemas/PersonalAccessTokenPrincipal"
+                    },
+                    {
+                      "$ref": "#/components/schemas/ServiceExecutionTokenPrincipal"
+                    }
+                  ]
+                }
+              }
+            }
+          },
+          "401": {
+            "description": "Unauthorized"
+          },
+          "403": {
+            "description": "Forbidden"
+          },
+          "404": {
+            "description": "Not Found"
+          },
+          "500": {
+            "description": "Internal Server Error"
+          }
+        }
+      }
+    },
     "/datapools/{id}/files/{fileId}": {
       "get": {
-        "tags": ["Data Pools"],
+        "tags": [
+          "Data Pools"
+        ],
         "description": "Get the content of a specific file from a data pool (both file and data pool identified by their ID).",
         "operationId": "getDataPoolFile",
         "parameters": [
@@ -412,6 +551,14 @@
               "type": "string",
               "format": "uuid"
             }
+          },
+          {
+            "name": "X-OrganizationId",
+            "in": "header",
+            "description": "The ID of your organization in case you want to perform operations in this context. Leave it empty to operate in your personal account.",
+            "schema": {
+              "type": "string"
+            }
           }
         ],
         "responses": {
@@ -452,7 +599,9 @@
         ]
       },
       "delete": {
-        "tags": ["Data Pools"],
+        "tags": [
+          "Data Pools"
+        ],
         "description": "Delete a specific file from a data pool (both file and data pool identified by their IDs).",
         "operationId": "deleteDataPoolFile",
         "parameters": [
@@ -473,6 +622,14 @@
               "type": "string",
               "format": "uuid"
             }
+          },
+          {
+            "name": "X-OrganizationId",
+            "in": "header",
+            "description": "The ID of your organization in case you want to perform operations in this context. Leave it empty to operate in your personal account.",
+            "schema": {
+              "type": "string"
+            }
           }
         ],
         "responses": {
@@ -525,7 +682,11 @@
           "currentUserPermission": {
             "type": "string",
             "description": "The access permission role for this entity of the current user",
-            "enum": ["VIEWER", "MAINTAINER", "OWNER"],
+            "enum": [
+              "VIEWER",
+              "MAINTAINER",
+              "OWNER"
+            ],
             "example": "OWNER",
             "readOnly": true
           },
@@ -585,6 +746,151 @@
             "pattern": "^\\d{4}\\-\\d{2}\\-\\d{2}\\s{1}\\d{2}\\:\\d{2}\\:\\d{2}$"
           }
         }
+      },
+      "AccessToken": {
+        "type": "object",
+        "properties": {
+          "id": {
+            "type": "string",
+            "format": "uuid"
+          },
+          "name": {
+            "type": "string"
+          },
+          "createdAt": {
+            "type": "string",
+            "format": "date-time"
+          },
+          "usedAt": {
+            "type": "string",
+            "format": "date-time"
+          },
+          "expiresAt": {
+            "type": "string",
+            "format": "date"
+          }
+        }
+      },
+      "OrganizationMembership": {
+        "type": "object",
+        "properties": {
+          "id": {
+            "type": "string",
+            "format": "uuid"
+          },
+          "accountType": {
+            "type": "string",
+            "enum": [
+              "BASIC",
+              "PRO",
+              "BUSINESS"
+            ]
+          },
+          "role": {
+            "type": "string",
+            "enum": [
+              "VIEWER",
+              "MAINTAINER",
+              "OWNER"
+            ]
+          }
+        }
+      },
+      "PersonalAccessTokenPrincipal": {
+        "type": "object",
+        "properties": {
+          "id": {
+            "type": "string",
+            "format": "uuid"
+          },
+          "accessToken": {
+            "$ref": "#/components/schemas/AccessToken"
+          },
+          "accountType": {
+            "type": "string",
+            "enum": [
+              "BASIC",
+              "PRO",
+              "BUSINESS"
+            ]
+          },
+          "organizationMemberships": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/OrganizationMembership"
+            }
+          }
+        }
+      },
+      "ServiceExecution": {
+        "type": "object",
+        "properties": {
+          "id": {
+            "type": "string",
+            "format": "uuid"
+          },
+          "createdAt": {
+            "type": "string",
+            "format": "date-time"
+          },
+          "startedAt": {
+            "type": "string",
+            "format": "date-time"
+          },
+          "endedAt": {
+            "type": "string",
+            "format": "date-time"
+          },
+          "status": {
+            "type": "string",
+            "enum": [
+              "UNKNOWN",
+              "PENDING",
+              "RUNNING",
+              "SUCCEEDED",
+              "FAILED"
+            ]
+          }
+        }
+      },
+      "ServiceExecutionTokenPrincipal": {
+        "type": "object",
+        "properties": {
+          "serviceExecution": {
+            "$ref": "#/components/schemas/ServiceExecution"
+          },
+          "serviceProvider": {
+            "$ref": "#/components/schemas/UserContext"
+          }
+        }
+      },
+      "UserContext": {
+        "type": "object",
+        "properties": {
+          "id": {
+            "type": "string",
+            "format": "uuid"
+          },
+          "contextType": {
+            "type": "string",
+            "enum": [
+              "USER",
+              "ORGANIZATION",
+              "SERVICE_EXECUTION"
+            ]
+          },
+          "accountType": {
+            "type": "string",
+            "enum": [
+              "BASIC",
+              "PRO",
+              "BUSINESS"
+            ]
+          },
+          "parent": {
+            "$ref": "#/components/schemas/UserContext"
+          }
+        }
       }
     },
     "securitySchemes": {
@@ -597,8 +903,8 @@
         "type": "oauth2",
         "flows": {
           "password": {
-            "tokenUrl": "https://login.34.90.225.20.nip.io/realms/planqk/protocol/openid-connect/token",
-            "refreshUrl": "https://login.34.90.225.20.nip.io/realms/planqk/protocol/openid-connect/token",
+            "tokenUrl": "https://login.platform.planqk.de/realms/planqk/protocol/openid-connect/token",
+            "refreshUrl": "https://login.platform.planqk.de/realms/planqk/protocol/openid-connect/token",
             "scopes": {
               "profile": ""
             }
@@ -607,4 +913,4 @@
       }
     }
   }
-}
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@planqk/planqk-api-sdk",
-  "version": "1.1.0",
+  "version": "1.2.0",
   "description": "SDK to interact with official PLANQK API.",
   "author": "Kipu Quantum GmbH",
   "contributors": [

package/planqk/api/_version.py

@@ -1 +1 @@
-__version__ = "1.1.0"
+__version__ = "1.2.0"

package/planqk/api/client.py

@@ -13,11 +13,7 @@ class PlanqkApiClient:
         base_url = os.environ.get(_PLANQK_API_BASE_URL_NAME, "https://platform.planqk.de/qc-catalog")
         credentials_provider = DefaultCredentialsProvider(access_token)
 
-        headers = None
-        if organization_id:
-            headers = {"X-OrganizationId": organization_id}
-
-        self._api = PlanqkApi(base_url=base_url, api_key=credentials_provider.get_access_token(), headers=headers)
+        self._api = PlanqkApi(base_url=base_url, api_key=credentials_provider.get_access_token(), organization_id=organization_id)
 
     @property
     def data_pools(self) -> DataPoolsClient:

package/planqk/api/sdk/__init__.py

@@ -2,14 +2,34 @@
 
 # isort: skip_file
 
-from .types import DataPoolDto, DataPoolDtoCurrentUserPermission, DataPoolFileDto, OauthScope
+from .types import (
+    AccessToken,
+    DataPoolDto,
+    DataPoolDtoCurrentUserPermission,
+    DataPoolFileDto,
+    OauthScope,
+    OrganizationMembership,
+    OrganizationMembershipAccountType,
+    OrganizationMembershipRole,
+    PersonalAccessTokenPrincipal,
+    PersonalAccessTokenPrincipalAccountType,
+    ServiceExecution,
+    ServiceExecutionStatus,
+    ServiceExecutionTokenPrincipal,
+    UserContext,
+    UserContextAccountType,
+    UserContextContextType,
+)
 from .errors import BadRequestError, ForbiddenError, InternalServerError, NotFoundError, UnauthorizedError
-from . import data_pools
+from . import authentication, data_pools
+from .authentication import AuthorizeResponse
 from .client import AsyncPlanqkApi, PlanqkApi
 from .environment import PlanqkApiEnvironment
 
 __all__ = [
+    "AccessToken",
     "AsyncPlanqkApi",
+    "AuthorizeResponse",
     "BadRequestError",
     "DataPoolDto",
     "DataPoolDtoCurrentUserPermission",
@@ -18,8 +38,20 @@ __all__ = [
     "InternalServerError",
     "NotFoundError",
     "OauthScope",
+    "OrganizationMembership",
+    "OrganizationMembershipAccountType",
+    "OrganizationMembershipRole",
+    "PersonalAccessTokenPrincipal",
+    "PersonalAccessTokenPrincipalAccountType",
     "PlanqkApi",
     "PlanqkApiEnvironment",
+    "ServiceExecution",
+    "ServiceExecutionStatus",
+    "ServiceExecutionTokenPrincipal",
     "UnauthorizedError",
+    "UserContext",
+    "UserContextAccountType",
+    "UserContextContextType",
+    "authentication",
     "data_pools",
 ]

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

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