@planqk/planqk-service-sdk 2.6.2 → 2.7.0

package/dist/sdk/Client.d.ts

@@ -9,7 +9,7 @@ export declare namespace PlanqkServiceApiClient {
         environment?: core.Supplier<environments.PlanqkServiceApiEnvironment | string>;
         /** Specify a custom URL to connect the client to. */
         baseUrl?: core.Supplier<string>;
-        token: core.Supplier<core.BearerToken>;
+        token?: core.Supplier<core.BearerToken | undefined>;
         /** Additional headers to include in requests. */
         headers?: Record<string, string | core.Supplier<string | undefined> | undefined>;
     }
@@ -27,6 +27,6 @@ export declare namespace PlanqkServiceApiClient {
 export declare class PlanqkServiceApiClient {
     protected readonly _options: PlanqkServiceApiClient.Options;
     protected _serviceApi: ServiceApi | undefined;
-    constructor(_options: PlanqkServiceApiClient.Options);
+    constructor(_options?: PlanqkServiceApiClient.Options);
     get serviceApi(): ServiceApi;
 }

package/dist/sdk/Client.js

@@ -43,7 +43,7 @@ const Client_js_1 = require("./api/resources/serviceApi/client/Client.js");
 class PlanqkServiceApiClient {
     _options;
     _serviceApi;
-    constructor(_options) {
+    constructor(_options = {}) {
         this._options = {
             ..._options,
             headers: (0, headers_js_1.mergeHeaders)({

package/dist/sdk/api/resources/serviceApi/client/Client.d.ts

@@ -9,7 +9,7 @@ export declare namespace ServiceApi {
         environment?: core.Supplier<environments.PlanqkServiceApiEnvironment | string>;
         /** Specify a custom URL to connect the client to. */
         baseUrl?: core.Supplier<string>;
-        token: core.Supplier<core.BearerToken>;
+        token?: core.Supplier<core.BearerToken | undefined>;
         /** Additional headers to include in requests. */
         headers?: Record<string, string | core.Supplier<string | undefined> | undefined>;
     }
@@ -26,7 +26,7 @@ export declare namespace ServiceApi {
 }
 export declare class ServiceApi {
     protected readonly _options: ServiceApi.Options;
-    constructor(_options: ServiceApi.Options);
+    constructor(_options?: ServiceApi.Options);
     /**
      * Retrieves a list of all service executions.
      * The response includes links to each service execution, allowing for further queries on their status and results.
@@ -93,7 +93,7 @@ export declare class ServiceApi {
      * @example
      *     await client.serviceApi.getLogs("id")
      */
-    getLogs(id: string, requestOptions?: ServiceApi.RequestOptions): core.HttpResponsePromise<string[]>;
+    getLogs(id: string, requestOptions?: ServiceApi.RequestOptions): core.HttpResponsePromise<PlanqkServiceApi.LogEntry[]>;
     private __getLogs;
     /**
      * Cancel a pending or running service execution.
@@ -106,5 +106,5 @@ export declare class ServiceApi {
      */
     cancelExecution(id: string, requestOptions?: ServiceApi.RequestOptions): core.HttpResponsePromise<PlanqkServiceApi.ServiceExecution>;
     private __cancelExecution;
-    protected _getAuthorizationHeader(): Promise<string>;
+    protected _getAuthorizationHeader(): Promise<string | undefined>;
 }

package/dist/sdk/api/resources/serviceApi/client/Client.js

@@ -43,7 +43,7 @@ const headers_js_1 = require("../../../../core/headers.js");
 const errors = __importStar(require("../../../../errors/index.js"));
 class ServiceApi {
     _options;
-    constructor(_options) {
+    constructor(_options = {}) {
         this._options = _options;
     }
     /**
@@ -403,7 +403,11 @@ class ServiceApi {
         }
     }
     async _getAuthorizationHeader() {
-        return `Bearer ${await core.Supplier.get(this._options.token)}`;
+        const bearer = await core.Supplier.get(this._options.token);
+        if (bearer != null) {
+            return `Bearer ${bearer}`;
+        }
+        return undefined;
     }
 }
 exports.ServiceApi = ServiceApi;

package/dist/sdk/api/types/LogEntry.d.ts

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface LogEntry {
+    message?: string;
+    severity?: string;
+    timestamp?: string;
+}

package/dist/sdk/api/types/LogEntry.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/sdk/api/types/index.d.ts

@@ -1,2 +1,3 @@
 export * from "./ServiceExecution.js";
+export * from "./LogEntry.js";
 export * from "./HalLink.js";

package/dist/sdk/api/types/index.js

@@ -15,4 +15,5 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./ServiceExecution.js"), exports);
+__exportStar(require("./LogEntry.js"), exports);
 __exportStar(require("./HalLink.js"), exports);

package/fern/fern.config.json

@@ -1,4 +1,4 @@
 {
   "organization": "planqk-service",
-  "version": "0.65.35"
+  "version": "0.86.2"
 }

package/fern/generators.yml

@@ -6,8 +6,8 @@ default-group: local
 groups:
   local:
     generators:
-      - name: fernapi/fern-typescript-node-sdk
-        version: 2.4.6
+      - name: fernapi/fern-typescript-sdk
+        version: 3.7.1
         output:
           location: local-file-system
           path: ../generated/typescript
@@ -18,8 +18,10 @@ groups:
           skipResponseValidation: true
           noSerdeLayer: true
       - name: fernapi/fern-python-sdk
-        version: 4.25.0
+        version: 4.31.0
         output:
           location: local-file-system
           path: ../generated/python
-        config: {}
+        config:
+          pydantic_config:
+            skip_validation: true

package/fern/openapi/openapi.yml

@@ -4,6 +4,105 @@ info:
   title: PLANQK Service API
   description: |
     API description for a managed PLANQK Service.
+components:
+  schemas:
+    RequestBody:
+      type: object
+      additionalProperties: true
+      #
+      # Define the schema of your service execution input here
+      #
+    ResultResponse:
+      type: object
+      additionalProperties: true
+      properties:
+        #
+        # Add the schema of your result response here
+        #
+
+        # DO NOT REMOVE THE FOLLOWING LINES
+        _links:
+          type: object
+          properties:
+            status:
+              $ref: '#/components/schemas/HALLink'
+          additionalProperties:
+            $ref: '#/components/schemas/HALLink'
+        _embedded:
+          type: object
+          properties:
+            status:
+              $ref: '#/components/schemas/ServiceExecution'
+    ServiceExecution:
+      type: object
+      properties:
+        id:
+          type: string
+          examples: [ 87cb778e-ac43-11ec-b909-0242ac120002 ]
+        status:
+          type: string
+          enum: [ UNKNOWN, PENDING, RUNNING, SUCCEEDED, CANCELLED, FAILED ]
+          examples: [ SUCCEEDED ]
+        createdAt:
+          type: string
+          examples: [ "2022-01-01 22:38:08" ]
+        startedAt:
+          type: string
+          examples: [ "2022-01-01 22:39:08" ]
+        endedAt:
+          type: string
+          examples: [ "2022-01-01 22:40:08" ]
+    LogEntry:
+      type: object
+      properties:
+        message:
+          type: string
+        severity:
+          type: string
+        timestamp:
+          type: string
+          format: date-time
+    # Representation of link as defined in HAL: https://datatracker.ietf.org/doc/html/draft-kelly-json-hal-11
+    HALLink:
+      type: object
+      properties:
+        href:
+          type: string
+          description: The URL of the link
+        templated:
+          type: boolean
+          description: Whether the link is templated (optional)
+          default: false
+        type:
+          type: string
+          description: The media type of the link (optional)
+        deprecation:
+          type: string
+          description: A URL that provides further information about the deprecation of the link (optional)
+        name:
+          type: string
+          description: The name of the link (optional)
+        profile:
+          type: string
+          description: A URL that provides further information about the profile of the link (optional)
+        title:
+          type: string
+          description: The title of the link (optional)
+        hreflang:
+          type: string
+          description: The language of the link's target resource (optional)
+  securitySchemes:
+    ApplicationCredentials:
+      type: oauth2
+      flows:
+        clientCredentials:
+          tokenUrl: https://gateway.platform.planqk.de/token
+          scopes: {}
+security:
+  - ApplicationCredentials: []
+servers:
+  - url: https://gateway.platform.planqk.de/<context>/<service>/<version>
+    description: The service endpoint
 paths:
   /:
     get:
@@ -36,8 +135,7 @@ paths:
         content:
           application/json:
             schema:
-              type: object
-              additionalProperties: true
+              $ref: "#/components/schemas/RequestBody"
       responses:
         "201":
           description: Service execution is submitted
@@ -96,21 +194,7 @@ paths:
           content:
             application/json:
               schema:
-                type: object
-                additionalProperties: true
-                properties:
-                  _links:
-                    type: object
-                    properties:
-                      status:
-                        $ref: '#/components/schemas/HALLink'
-                    additionalProperties:
-                      $ref: '#/components/schemas/HALLink'
-                  _embedded:
-                    type: object
-                    properties:
-                      status:
-                        $ref: '#/components/schemas/ServiceExecution'
+                $ref: "#/components/schemas/ResultResponse"
   /{id}/result/{file}:
     get:
       tags:
@@ -165,7 +249,9 @@ paths:
               schema:
                 type: array
                 items:
-                  type: string
+                  $ref: "#/components/schemas/LogEntry"
+        "204":
+          description: No log entries available
   /{id}/cancel:
     put:
       tags:
@@ -188,65 +274,3 @@ paths:
             application/json:
               schema:
                 $ref: "#/components/schemas/ServiceExecution"
-components:
-  schemas:
-    ServiceExecution:
-      type: object
-      properties:
-        id:
-          type: string
-          examples: [ 87cb778e-ac43-11ec-b909-0242ac120002 ]
-        status:
-          type: string
-          enum: [ UNKNOWN, PENDING, RUNNING, SUCCEEDED, CANCELLED, FAILED ]
-          examples: [ SUCCEEDED ]
-        createdAt:
-          type: string
-          examples: [ "2022-01-01 22:38:08" ]
-        startedAt:
-          type: string
-          examples: [ "2022-01-01 22:39:08" ]
-        endedAt:
-          type: string
-          examples: [ "2022-01-01 22:40:08" ]
-    # Representation of link as defined in HAL: https://datatracker.ietf.org/doc/html/draft-kelly-json-hal-11
-    HALLink:
-      type: object
-      properties:
-        href:
-          type: string
-          description: The URL of the link
-        templated:
-          type: boolean
-          description: Whether the link is templated (optional)
-          default: false
-        type:
-          type: string
-          description: The media type of the link (optional)
-        deprecation:
-          type: string
-          description: A URL that provides further information about the deprecation of the link (optional)
-        name:
-          type: string
-          description: The name of the link (optional)
-        profile:
-          type: string
-          description: A URL that provides further information about the profile of the link (optional)
-        title:
-          type: string
-          description: The title of the link (optional)
-        hreflang:
-          type: string
-          description: The language of the link's target resource (optional)
-  securitySchemes:
-    ApplicationCredentials:
-      type: oauth2
-      flows:
-        clientCredentials:
-          tokenUrl: https://gateway.platform.planqk.de/token
-          scopes: {}
-security:
-  - ApplicationCredentials: []
-servers:
-  - url: https://gateway.platform.planqk.de/<context>/<service>/<version>
-    description: The service endpoint

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@planqk/planqk-service-sdk",
-  "version": "2.6.2",
+  "version": "2.7.0",
   "description": "SDK to interact with PLANQK Managed Services.",
   "author": "Kipu Quantum GmbH",
   "contributors": [

package/planqk/service/_version.py

@@ -1 +1 @@
-__version__ = "2.6.2"
+__version__ = "2.7.0"

package/planqk/service/client.py

@@ -5,7 +5,7 @@ import time
 import typing
 
 from planqk.service.auth import DEFAULT_TOKEN_ENDPOINT, PlanqkServiceAuth
-from planqk.service.sdk import PlanqkServiceApi, ServiceExecution, GetResultResponse
+from planqk.service.sdk import PlanqkServiceApi, ServiceExecution, LogEntry, ResultResponse
 from planqk.service.sdk.service_api.client import ServiceApiClient
 from planqk.service.sdk.types.service_execution_status import ServiceExecutionStatus
 
@@ -61,7 +61,7 @@ class PlanqkServiceExecution:
     def refresh(self):
         self._service_execution = self._client.api.get_status(id=self.id)
 
-    def result(self) -> GetResultResponse:
+    def result(self) -> ResultResponse:
         self.wait_for_final_state()
         delay = 1  # Start with a small delay
         max_delay = 16  # Maximum delay
@@ -105,7 +105,7 @@ class PlanqkServiceExecution:
     def cancel(self) -> None:
         self._client.api.cancel_execution(id=self.id)
 
-    def logs(self) -> typing.List[str]:
+    def logs(self) -> typing.List[LogEntry]:
         return self._client.api.get_logs(id=self.id)
 
 

package/planqk/service/sdk/__init__.py

@@ -2,20 +2,70 @@
 
 # isort: skip_file
 
-from .types import HalLink, ServiceExecution, ServiceExecutionStatus
-from . import service_api
-from .client import AsyncPlanqkServiceApi, PlanqkServiceApi
-from .environment import PlanqkServiceApiEnvironment
-from .service_api import GetResultResponse, GetResultResponseEmbedded, GetResultResponseLinks
+import typing
+from importlib import import_module
+
+if typing.TYPE_CHECKING:
+    from .types import (
+        HalLink,
+        LogEntry,
+        RequestBody,
+        ResultResponse,
+        ResultResponseEmbedded,
+        ResultResponseLinks,
+        ServiceExecution,
+        ServiceExecutionStatus,
+    )
+    from . import service_api
+    from .client import AsyncPlanqkServiceApi, PlanqkServiceApi
+    from .environment import PlanqkServiceApiEnvironment
+_dynamic_imports: typing.Dict[str, str] = {
+    "AsyncPlanqkServiceApi": ".client",
+    "HalLink": ".types",
+    "LogEntry": ".types",
+    "PlanqkServiceApi": ".client",
+    "PlanqkServiceApiEnvironment": ".environment",
+    "RequestBody": ".types",
+    "ResultResponse": ".types",
+    "ResultResponseEmbedded": ".types",
+    "ResultResponseLinks": ".types",
+    "ServiceExecution": ".types",
+    "ServiceExecutionStatus": ".types",
+    "service_api": ".service_api",
+}
+
+
+def __getattr__(attr_name: str) -> typing.Any:
+    module_name = _dynamic_imports.get(attr_name)
+    if module_name is None:
+        raise AttributeError(f"No {attr_name} found in _dynamic_imports for module name -> {__name__}")
+    try:
+        module = import_module(module_name, __package__)
+        if module_name == f".{attr_name}":
+            return module
+        else:
+            return getattr(module, attr_name)
+    except ImportError as e:
+        raise ImportError(f"Failed to import {attr_name} from {module_name}: {e}") from e
+    except AttributeError as e:
+        raise AttributeError(f"Failed to get {attr_name} from {module_name}: {e}") from e
+
+
+def __dir__():
+    lazy_attrs = list(_dynamic_imports.keys())
+    return sorted(lazy_attrs)
+
 
 __all__ = [
     "AsyncPlanqkServiceApi",
-    "GetResultResponse",
-    "GetResultResponseEmbedded",
-    "GetResultResponseLinks",
     "HalLink",
+    "LogEntry",
     "PlanqkServiceApi",
     "PlanqkServiceApiEnvironment",
+    "RequestBody",
+    "ResultResponse",
+    "ResultResponseEmbedded",
+    "ResultResponseLinks",
     "ServiceExecution",
     "ServiceExecutionStatus",
     "service_api",

package/planqk/service/sdk/client.py

@@ -1,11 +1,15 @@
 # This file was auto-generated by Fern from our API Definition.
 
+from __future__ import annotations
+
 import typing
 
 import httpx
 from .core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
 from .environment import PlanqkServiceApiEnvironment
-from .service_api.client import AsyncServiceApiClient, ServiceApiClient
+
+if typing.TYPE_CHECKING:
+    from .service_api.client import AsyncServiceApiClient, ServiceApiClient
 
 
 class PlanqkServiceApi:
@@ -26,7 +30,7 @@ class PlanqkServiceApi:
 
 
 
-    token : typing.Union[str, typing.Callable[[], str]]
+    token : typing.Optional[typing.Union[str, typing.Callable[[], str]]]
     headers : typing.Optional[typing.Dict[str, str]]
         Additional headers to send with every request.
 
@@ -53,7 +57,7 @@ class PlanqkServiceApi:
         *,
         base_url: typing.Optional[str] = None,
         environment: PlanqkServiceApiEnvironment = PlanqkServiceApiEnvironment.DEFAULT,
-        token: typing.Union[str, typing.Callable[[], str]],
+        token: typing.Optional[typing.Union[str, typing.Callable[[], str]]] = None,
         headers: typing.Optional[typing.Dict[str, str]] = None,
         timeout: typing.Optional[float] = None,
         follow_redirects: typing.Optional[bool] = True,
@@ -73,7 +77,15 @@ class PlanqkServiceApi:
             else httpx.Client(timeout=_defaulted_timeout),
             timeout=_defaulted_timeout,
         )
-        self.service_api = ServiceApiClient(client_wrapper=self._client_wrapper)
+        self._service_api: typing.Optional[ServiceApiClient] = None
+
+    @property
+    def service_api(self):
+        if self._service_api is None:
+            from .service_api.client import ServiceApiClient  # noqa: E402
+
+            self._service_api = ServiceApiClient(client_wrapper=self._client_wrapper)
+        return self._service_api
 
 
 class AsyncPlanqkServiceApi:
@@ -94,7 +106,7 @@ class AsyncPlanqkServiceApi:
 
 
 
-    token : typing.Union[str, typing.Callable[[], str]]
+    token : typing.Optional[typing.Union[str, typing.Callable[[], str]]]
     headers : typing.Optional[typing.Dict[str, str]]
         Additional headers to send with every request.
 
@@ -121,7 +133,7 @@ class AsyncPlanqkServiceApi:
         *,
         base_url: typing.Optional[str] = None,
         environment: PlanqkServiceApiEnvironment = PlanqkServiceApiEnvironment.DEFAULT,
-        token: typing.Union[str, typing.Callable[[], str]],
+        token: typing.Optional[typing.Union[str, typing.Callable[[], str]]] = None,
         headers: typing.Optional[typing.Dict[str, str]] = None,
         timeout: typing.Optional[float] = None,
         follow_redirects: typing.Optional[bool] = True,
@@ -141,7 +153,15 @@ class AsyncPlanqkServiceApi:
             else httpx.AsyncClient(timeout=_defaulted_timeout),
             timeout=_defaulted_timeout,
         )
-        self.service_api = AsyncServiceApiClient(client_wrapper=self._client_wrapper)
+        self._service_api: typing.Optional[AsyncServiceApiClient] = None
+
+    @property
+    def service_api(self):
+        if self._service_api is None:
+            from .service_api.client import AsyncServiceApiClient  # noqa: E402
+
+            self._service_api = AsyncServiceApiClient(client_wrapper=self._client_wrapper)
+        return self._service_api
 
 
 def _get_base_url(*, base_url: typing.Optional[str] = None, environment: PlanqkServiceApiEnvironment) -> str:

package/planqk/service/sdk/core/__init__.py

@@ -2,26 +2,83 @@
 
 # isort: skip_file
 
-from .api_error import ApiError
-from .client_wrapper import AsyncClientWrapper, BaseClientWrapper, SyncClientWrapper
-from .datetime_utils import serialize_datetime
-from .file import File, convert_file_dict_to_httpx_tuples, with_content_type
-from .http_client import AsyncHttpClient, HttpClient
-from .http_response import AsyncHttpResponse, HttpResponse
-from .jsonable_encoder import jsonable_encoder
-from .pydantic_utilities import (
-    IS_PYDANTIC_V2,
-    UniversalBaseModel,
-    UniversalRootModel,
-    parse_obj_as,
-    universal_field_validator,
-    universal_root_validator,
-    update_forward_refs,
-)
-from .query_encoder import encode_query
-from .remove_none_from_dict import remove_none_from_dict
-from .request_options import RequestOptions
-from .serialization import FieldMetadata, convert_and_respect_annotation_metadata
+import typing
+from importlib import import_module
+
+if typing.TYPE_CHECKING:
+    from .api_error import ApiError
+    from .client_wrapper import AsyncClientWrapper, BaseClientWrapper, SyncClientWrapper
+    from .datetime_utils import serialize_datetime
+    from .file import File, convert_file_dict_to_httpx_tuples, with_content_type
+    from .http_client import AsyncHttpClient, HttpClient
+    from .http_response import AsyncHttpResponse, HttpResponse
+    from .jsonable_encoder import jsonable_encoder
+    from .pydantic_utilities import (
+        IS_PYDANTIC_V2,
+        UniversalBaseModel,
+        UniversalRootModel,
+        parse_obj_as,
+        universal_field_validator,
+        universal_root_validator,
+        update_forward_refs,
+    )
+    from .query_encoder import encode_query
+    from .remove_none_from_dict import remove_none_from_dict
+    from .request_options import RequestOptions
+    from .serialization import FieldMetadata, convert_and_respect_annotation_metadata
+    from .unchecked_base_model import UncheckedBaseModel, UnionMetadata, construct_type
+_dynamic_imports: typing.Dict[str, str] = {
+    "ApiError": ".api_error",
+    "AsyncClientWrapper": ".client_wrapper",
+    "AsyncHttpClient": ".http_client",
+    "AsyncHttpResponse": ".http_response",
+    "BaseClientWrapper": ".client_wrapper",
+    "FieldMetadata": ".serialization",
+    "File": ".file",
+    "HttpClient": ".http_client",
+    "HttpResponse": ".http_response",
+    "IS_PYDANTIC_V2": ".pydantic_utilities",
+    "RequestOptions": ".request_options",
+    "SyncClientWrapper": ".client_wrapper",
+    "UncheckedBaseModel": ".unchecked_base_model",
+    "UnionMetadata": ".unchecked_base_model",
+    "UniversalBaseModel": ".pydantic_utilities",
+    "UniversalRootModel": ".pydantic_utilities",
+    "construct_type": ".unchecked_base_model",
+    "convert_and_respect_annotation_metadata": ".serialization",
+    "convert_file_dict_to_httpx_tuples": ".file",
+    "encode_query": ".query_encoder",
+    "jsonable_encoder": ".jsonable_encoder",
+    "parse_obj_as": ".pydantic_utilities",
+    "remove_none_from_dict": ".remove_none_from_dict",
+    "serialize_datetime": ".datetime_utils",
+    "universal_field_validator": ".pydantic_utilities",
+    "universal_root_validator": ".pydantic_utilities",
+    "update_forward_refs": ".pydantic_utilities",
+    "with_content_type": ".file",
+}
+
+
+def __getattr__(attr_name: str) -> typing.Any:
+    module_name = _dynamic_imports.get(attr_name)
+    if module_name is None:
+        raise AttributeError(f"No {attr_name} found in _dynamic_imports for module name -> {__name__}")
+    try:
+        module = import_module(module_name, __package__)
+        if module_name == f".{attr_name}":
+            return module
+        else:
+            return getattr(module, attr_name)
+    except ImportError as e:
+        raise ImportError(f"Failed to import {attr_name} from {module_name}: {e}") from e
+    except AttributeError as e:
+        raise AttributeError(f"Failed to get {attr_name} from {module_name}: {e}") from e
+
+
+def __dir__():
+    lazy_attrs = list(_dynamic_imports.keys())
+    return sorted(lazy_attrs)
+
 
 __all__ = [
     "ApiError",
@@ -36,8 +93,11 @@ __all__ = [
     "IS_PYDANTIC_V2",
     "RequestOptions",
     "SyncClientWrapper",
+    "UncheckedBaseModel",
+    "UnionMetadata",
     "UniversalBaseModel",
     "UniversalRootModel",
+    "construct_type",
     "convert_and_respect_annotation_metadata",
     "convert_file_dict_to_httpx_tuples",
     "encode_query",