@planqk/planqk-api-sdk 1.3.7 → 1.7.0

package/.env.template

@@ -1,3 +1,3 @@
-PLANQK_API_BASE_URL=https://platform.planqk.de/qc-catalog
-PLANQK_PERSONAL_ACCESS_TOKEN=
-PLANQK_ORGANIZATION_ID=
+KQH_BASE_URL=https://api.hub.kipu-quantum.com/qc-catalog
+KQH_PERSONAL_ACCESS_TOKEN=
+KQH_ORGANIZATION_ID=

package/.gitlab-ci.yml

@@ -10,11 +10,27 @@ variables:
 
 stages:
   - commit-test
-  - install
   - compliance
   - commit-release-check
   - release-package
 
+compile-node-sdk:
+  stage: commit-test
+  rules:
+    - if: '$CI_COMMIT_MESSAGE =~ /^chore\(release\):/'
+      when: never
+    - if: '$CI_PIPELINE_SOURCE == "web"'
+    - if: '$CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH'
+  image: node:lts
+  before_script:
+    - npm ci
+  script:
+    - npm run build
+  cache:
+    key: node_modules
+    paths:
+      - node_modules
+
 semantic-release:
   stage: commit-release-check
   rules:
@@ -37,22 +53,6 @@ semantic-release:
   script:
     - semantic-release
 
-install:
-  stage: install
-  rules:
-    - if: '$CI_COMMIT_TAG'
-  image: ghcr.io/astral-sh/uv:$UV_VERSION-python$PYTHON_VERSION-$BASE_LAYER
-  script:
-    - uv sync --frozen --no-dev
-    - uv export --format requirements-txt --no-dev --no-emit-project > requirements.txt
-    - uv export --format requirements-txt --dev --no-emit-project > requirements-dev.txt
-  artifacts:
-    expire_in: 1 hour
-    paths:
-      - .venv
-      - requirements.txt
-      - requirements-dev.txt
-
 oss-compliance-check:
   stage: compliance
   rules:
@@ -61,7 +61,6 @@ oss-compliance-check:
   before_script:
     - apt-get update && apt-get install -y --no-install-recommends ca-certificates curl
     - curl https://raw.githubusercontent.com/fossas/fossa-cli/master/install-latest.sh | bash
-    - source .venv/bin/activate
   script:
     - FOSSA_REVISION=$([ -z $CI_COMMIT_TAG ] && echo $CI_COMMIT_SHA || echo $CI_COMMIT_TAG)
     - FOSSA_BRANCH=$([ -z $CI_COMMIT_BRANCH ] && echo 'main' || echo $CI_COMMIT_BRANCH)
@@ -74,6 +73,8 @@ publish-python-sdk:
     - if: '$CI_COMMIT_TAG'
   image: ghcr.io/astral-sh/uv:$UV_VERSION-python$PYTHON_VERSION-$BASE_LAYER
   before_script:
+    - uv venv
+    - uv sync --frozen
     - source .venv/bin/activate
     - uv pip install twine
   script:
@@ -98,10 +99,6 @@ publish-node-sdk:
     - cp README-node.md README.md
     - npm run build
     - npm publish
-  artifacts:
-    expire_in: 1 hour
-    paths:
-      - dist
   cache:
     key: node_modules
     paths:

package/.releaserc.json

@@ -16,7 +16,8 @@
           "planqk/api/_version.py",
           "pyproject.toml",
           "package.json",
-          "package-lock.json"
+          "package-lock.json",
+          "requirements.txt"
         ],
         "message": "chore(release): v${nextRelease.version}\n\n${nextRelease.notes}"
       }

package/README-node.md

@@ -10,4 +10,4 @@ npm install @planqk/planqk-api-sdk
 
 ## Usage
 
-The usage docs are available at <https://docs.planqk.de/sdk-api-reference.html>.
+The usage docs are available at <https://docs.hub.kipu-quantum.com/sdk-api-reference.html>.

package/README-python.md

@@ -10,4 +10,4 @@ pip install --upgrade planqk-api-sdk
 
 ## Usage
 
-The usage docs are available at <https://docs.planqk.de/sdk-api-reference.html>.
+The usage docs are available at <https://docs.hub.kipu-quantum.com/sdk-api-reference.html>.

package/README.md

@@ -10,4 +10,4 @@ npm install @planqk/planqk-api-sdk
 
 ## Usage
 
-The usage docs are available at <https://docs.planqk.de/sdk-api-reference.html>.
+The usage docs are available at <https://docs.hub.kipu-quantum.com/sdk-api-reference.html>.

package/dist/sdk/Client.d.ts

@@ -3,7 +3,9 @@
  */
 import * as environments from "./environments.js";
 import * as core from "./core/index.js";
+import { ServiceJobs } from "./api/resources/serviceJobs/client/Client.js";
 import { DataPools } from "./api/resources/dataPools/client/Client.js";
+import { ServiceExecutions } from "./api/resources/serviceExecutions/client/Client.js";
 export declare namespace PlanqkApiClient {
     interface Options {
         environment?: core.Supplier<environments.PlanqkApiEnvironment | string>;
@@ -24,13 +26,19 @@ export declare namespace PlanqkApiClient {
         abortSignal?: AbortSignal;
         /** Override the X-OrganizationId header */
         organizationId?: string | undefined;
+        /** Additional query string parameters to include in the request. */
+        queryParams?: Record<string, unknown>;
         /** Additional headers to include in the request. */
         headers?: Record<string, string | core.Supplier<string | undefined> | undefined>;
     }
 }
 export declare class PlanqkApiClient {
     protected readonly _options: PlanqkApiClient.Options;
+    protected _serviceJobs: ServiceJobs | undefined;
     protected _dataPools: DataPools | undefined;
+    protected _serviceExecutions: ServiceExecutions | undefined;
     constructor(_options: PlanqkApiClient.Options);
+    get serviceJobs(): ServiceJobs;
     get dataPools(): DataPools;
+    get serviceExecutions(): ServiceExecutions;
 }

package/dist/sdk/Client.js

@@ -39,10 +39,14 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.PlanqkApiClient = void 0;
 const core = __importStar(require("./core/index.js"));
 const headers_js_1 = require("./core/headers.js");
-const Client_js_1 = require("./api/resources/dataPools/client/Client.js");
+const Client_js_1 = require("./api/resources/serviceJobs/client/Client.js");
+const Client_js_2 = require("./api/resources/dataPools/client/Client.js");
+const Client_js_3 = require("./api/resources/serviceExecutions/client/Client.js");
 class PlanqkApiClient {
     _options;
+    _serviceJobs;
     _dataPools;
+    _serviceExecutions;
     constructor(_options) {
         this._options = {
             ..._options,
@@ -54,8 +58,14 @@ class PlanqkApiClient {
             }, _options?.headers),
         };
     }
+    get serviceJobs() {
+        return (this._serviceJobs ??= new Client_js_1.ServiceJobs(this._options));
+    }
     get dataPools() {
-        return (this._dataPools ??= new Client_js_1.DataPools(this._options));
+        return (this._dataPools ??= new Client_js_2.DataPools(this._options));
+    }
+    get serviceExecutions() {
+        return (this._serviceExecutions ??= new Client_js_3.ServiceExecutions(this._options));
     }
 }
 exports.PlanqkApiClient = PlanqkApiClient;

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

@@ -24,6 +24,8 @@ export declare namespace DataPools {
         abortSignal?: AbortSignal;
         /** Override the X-OrganizationId header */
         organizationId?: string | undefined;
+        /** Additional query string parameters to include in the request. */
+        queryParams?: Record<string, unknown>;
         /** Additional headers to include in the request. */
         headers?: Record<string, string | core.Supplier<string | undefined> | undefined>;
     }
@@ -85,7 +87,7 @@ export declare class DataPools {
     deleteDataPool(id: string, requestOptions?: DataPools.RequestOptions): core.HttpResponsePromise<void>;
     private __deleteDataPool;
     /**
-     * Get a list of all data pools for the current user.
+     * Get a list of all data pools for the current user or organization.
      *
      * @param {DataPools.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -146,6 +148,7 @@ export declare class DataPools {
      * @throws {@link PlanqkApi.InternalServerError}
      *
      * @example
+     *     import { createReadStream } from "fs";
      *     await client.dataPools.addDataPoolFile("id", {
      *         file: fs.createReadStream("/path/to/your/file")
      *     })

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

@@ -68,15 +68,17 @@ class DataPools {
         return core.HttpResponsePromise.fromPromise(this.__getDataPool(id, requestOptions));
     }
     async __getDataPool(id, requestOptions) {
+        let _headers = (0, headers_js_1.mergeHeaders)(this._options?.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({
+            "X-OrganizationId": requestOptions?.organizationId ?? this._options?.organizationId,
+            ...(await this._getCustomAuthorizationHeaders()),
+        }), requestOptions?.headers);
         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, `datapools/${encodeURIComponent(id)}`),
             method: "GET",
-            headers: (0, headers_js_1.mergeHeaders)(this._options?.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({
-                "X-OrganizationId": requestOptions?.organizationId,
-                ...(await this._getCustomAuthorizationHeaders()),
-            }), requestOptions?.headers),
+            headers: _headers,
+            queryParameters: requestOptions?.queryParams,
             timeoutMs: requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
             maxRetries: requestOptions?.maxRetries,
             withCredentials: true,
@@ -139,16 +141,18 @@ class DataPools {
         return core.HttpResponsePromise.fromPromise(this.__updateDataPool(id, request, requestOptions));
     }
     async __updateDataPool(id, request = {}, requestOptions) {
+        let _headers = (0, headers_js_1.mergeHeaders)(this._options?.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({
+            "X-OrganizationId": requestOptions?.organizationId ?? this._options?.organizationId,
+            ...(await this._getCustomAuthorizationHeaders()),
+        }), requestOptions?.headers);
         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, `datapools/${encodeURIComponent(id)}`),
             method: "PUT",
-            headers: (0, headers_js_1.mergeHeaders)(this._options?.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({
-                "X-OrganizationId": requestOptions?.organizationId,
-                ...(await this._getCustomAuthorizationHeaders()),
-            }), requestOptions?.headers),
+            headers: _headers,
             contentType: "application/json",
+            queryParameters: requestOptions?.queryParams,
             requestType: "json",
             body: request,
             timeoutMs: requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
@@ -213,15 +217,17 @@ class DataPools {
         return core.HttpResponsePromise.fromPromise(this.__deleteDataPool(id, requestOptions));
     }
     async __deleteDataPool(id, requestOptions) {
+        let _headers = (0, headers_js_1.mergeHeaders)(this._options?.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({
+            "X-OrganizationId": requestOptions?.organizationId ?? this._options?.organizationId,
+            ...(await this._getCustomAuthorizationHeaders()),
+        }), requestOptions?.headers);
         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, `datapools/${encodeURIComponent(id)}`),
             method: "DELETE",
-            headers: (0, headers_js_1.mergeHeaders)(this._options?.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({
-                "X-OrganizationId": requestOptions?.organizationId,
-                ...(await this._getCustomAuthorizationHeaders()),
-            }), requestOptions?.headers),
+            headers: _headers,
+            queryParameters: requestOptions?.queryParams,
             timeoutMs: requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
             maxRetries: requestOptions?.maxRetries,
             withCredentials: true,
@@ -265,7 +271,7 @@ class DataPools {
         }
     }
     /**
-     * Get a list of all data pools for the current user.
+     * Get a list of all data pools for the current user or organization.
      *
      * @param {DataPools.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -281,15 +287,17 @@ class DataPools {
         return core.HttpResponsePromise.fromPromise(this.__getDataPools(requestOptions));
     }
     async __getDataPools(requestOptions) {
+        let _headers = (0, headers_js_1.mergeHeaders)(this._options?.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({
+            "X-OrganizationId": requestOptions?.organizationId ?? this._options?.organizationId,
+            ...(await this._getCustomAuthorizationHeaders()),
+        }), requestOptions?.headers);
         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, "datapools"),
             method: "GET",
-            headers: (0, headers_js_1.mergeHeaders)(this._options?.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({
-                "X-OrganizationId": requestOptions?.organizationId,
-                ...(await this._getCustomAuthorizationHeaders()),
-            }), requestOptions?.headers),
+            headers: _headers,
+            queryParameters: requestOptions?.queryParams,
             timeoutMs: requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
             maxRetries: requestOptions?.maxRetries,
             withCredentials: true,
@@ -351,16 +359,18 @@ class DataPools {
         return core.HttpResponsePromise.fromPromise(this.__createDataPool(request, requestOptions));
     }
     async __createDataPool(request = {}, requestOptions) {
+        let _headers = (0, headers_js_1.mergeHeaders)(this._options?.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({
+            "X-OrganizationId": requestOptions?.organizationId ?? this._options?.organizationId,
+            ...(await this._getCustomAuthorizationHeaders()),
+        }), requestOptions?.headers);
         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, "datapools"),
             method: "POST",
-            headers: (0, headers_js_1.mergeHeaders)(this._options?.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({
-                "X-OrganizationId": requestOptions?.organizationId,
-                ...(await this._getCustomAuthorizationHeaders()),
-            }), requestOptions?.headers),
+            headers: _headers,
             contentType: "application/json",
+            queryParameters: requestOptions?.queryParams,
             requestType: "json",
             body: request,
             timeoutMs: requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
@@ -425,15 +435,17 @@ class DataPools {
         return core.HttpResponsePromise.fromPromise(this.__getDataPoolFiles(id, requestOptions));
     }
     async __getDataPoolFiles(id, requestOptions) {
+        let _headers = (0, headers_js_1.mergeHeaders)(this._options?.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({
+            "X-OrganizationId": requestOptions?.organizationId ?? this._options?.organizationId,
+            ...(await this._getCustomAuthorizationHeaders()),
+        }), requestOptions?.headers);
         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, `datapools/${encodeURIComponent(id)}/files`),
             method: "GET",
-            headers: (0, headers_js_1.mergeHeaders)(this._options?.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({
-                "X-OrganizationId": requestOptions?.organizationId,
-                ...(await this._getCustomAuthorizationHeaders()),
-            }), requestOptions?.headers),
+            headers: _headers,
+            queryParameters: requestOptions?.queryParams,
             timeoutMs: requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
             maxRetries: requestOptions?.maxRetries,
             withCredentials: true,
@@ -490,6 +502,7 @@ class DataPools {
      * @throws {@link PlanqkApi.InternalServerError}
      *
      * @example
+     *     import { createReadStream } from "fs";
      *     await client.dataPools.addDataPoolFile("id", {
      *         file: fs.createReadStream("/path/to/your/file")
      *     })
@@ -505,17 +518,18 @@ class DataPools {
         const _request = await core.newFormData();
         await _request.appendFile("file", request.file);
         const _maybeEncodedRequest = await _request.getRequest();
+        let _headers = (0, headers_js_1.mergeHeaders)(this._options?.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({
+            "X-OrganizationId": requestOptions?.organizationId ?? this._options?.organizationId,
+            ...(await this._getCustomAuthorizationHeaders()),
+            ..._maybeEncodedRequest.headers,
+        }), requestOptions?.headers);
         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, `datapools/${encodeURIComponent(id)}/files`),
             method: "POST",
-            headers: (0, headers_js_1.mergeHeaders)(this._options?.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({
-                "X-OrganizationId": requestOptions?.organizationId,
-                ...(await this._getCustomAuthorizationHeaders()),
-                ..._maybeEncodedRequest.headers,
-            }), requestOptions?.headers),
-            queryParameters: _queryParams,
+            headers: _headers,
+            queryParameters: { ..._queryParams, ...requestOptions?.queryParams },
             requestType: "file",
             duplex: _maybeEncodedRequest.duplex,
             body: _maybeEncodedRequest.body,
@@ -574,15 +588,17 @@ class DataPools {
         return core.HttpResponsePromise.fromPromise(this.__getDataPoolFile(id, fileId, requestOptions));
     }
     async __getDataPoolFile(id, fileId, requestOptions) {
+        let _headers = (0, headers_js_1.mergeHeaders)(this._options?.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({
+            "X-OrganizationId": requestOptions?.organizationId ?? this._options?.organizationId,
+            ...(await this._getCustomAuthorizationHeaders()),
+        }), requestOptions?.headers);
         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, `datapools/${encodeURIComponent(id)}/files/${encodeURIComponent(fileId)}`),
             method: "GET",
-            headers: (0, headers_js_1.mergeHeaders)(this._options?.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({
-                "X-OrganizationId": requestOptions?.organizationId,
-                ...(await this._getCustomAuthorizationHeaders()),
-            }), requestOptions?.headers),
+            headers: _headers,
+            queryParameters: requestOptions?.queryParams,
             responseType: "binary-response",
             timeoutMs: requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
             maxRetries: requestOptions?.maxRetries,
@@ -645,15 +661,17 @@ class DataPools {
         return core.HttpResponsePromise.fromPromise(this.__deleteDataPoolFile(id, fileId, requestOptions));
     }
     async __deleteDataPoolFile(id, fileId, requestOptions) {
+        let _headers = (0, headers_js_1.mergeHeaders)(this._options?.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({
+            "X-OrganizationId": requestOptions?.organizationId ?? this._options?.organizationId,
+            ...(await this._getCustomAuthorizationHeaders()),
+        }), requestOptions?.headers);
         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, `datapools/${encodeURIComponent(id)}/files/${encodeURIComponent(fileId)}`),
             method: "DELETE",
-            headers: (0, headers_js_1.mergeHeaders)(this._options?.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({
-                "X-OrganizationId": requestOptions?.organizationId,
-                ...(await this._getCustomAuthorizationHeaders()),
-            }), requestOptions?.headers),
+            headers: _headers,
+            queryParameters: requestOptions?.queryParams,
             timeoutMs: requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
             maxRetries: requestOptions?.maxRetries,
             withCredentials: true,

package/dist/sdk/api/resources/dataPools/client/requests/AddDataPoolFileRequest.d.ts

@@ -10,5 +10,5 @@ import * as core from "../../../../../core/index.js";
  */
 export interface AddDataPoolFileRequest {
     filename?: string;
-    file: core.FileLike;
+    file: core.file.Uploadable.FileLike;
 }

package/dist/sdk/api/resources/dataPools/client/requests/CreateDataPoolRequest.d.ts

@@ -6,5 +6,6 @@
  *     {}
  */
 export interface CreateDataPoolRequest {
+    /** The name of the data pool. Must be at least 3 characters and at most 255 characters long. */
     name?: string;
 }

package/dist/sdk/api/resources/dataPools/client/requests/UpdateDataPoolRequest.d.ts

@@ -6,7 +6,10 @@
  *     {}
  */
 export interface UpdateDataPoolRequest {
+    /** The name of the data pool. Must be at least 3 characters and at most 255 characters long. */
     name?: string;
+    /** Short description of the data pool. */
     shortDescription?: string;
+    /** Detailed description of the data pool. */
     description?: string;
 }

package/dist/sdk/api/resources/index.d.ts

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

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

@@ -36,6 +36,9 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.dataPools = void 0;
+exports.serviceExecutions = exports.dataPools = exports.serviceJobs = void 0;
+exports.serviceJobs = __importStar(require("./serviceJobs/index.js"));
 exports.dataPools = __importStar(require("./dataPools/index.js"));
+exports.serviceExecutions = __importStar(require("./serviceExecutions/index.js"));
+__exportStar(require("./serviceJobs/client/requests/index.js"), exports);
 __exportStar(require("./dataPools/client/requests/index.js"), exports);

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

@@ -0,0 +1,90 @@
+/**
+ * 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";
+export declare namespace ServiceExecutions {
+    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>;
+        /** 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>;
+    }
+    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 query string parameters to include in the request. */
+        queryParams?: Record<string, unknown>;
+        /** Additional headers to include in the request. */
+        headers?: Record<string, string | core.Supplier<string | undefined> | undefined>;
+    }
+}
+/**
+ * Track status, costs, logs, metrics, and results of your service executions.
+ */
+export declare class ServiceExecutions {
+    protected readonly _options: ServiceExecutions.Options;
+    constructor(_options: ServiceExecutions.Options);
+    /**
+     * Get a specific service execution (identified by its ID).
+     *
+     * @param {string} id
+     * @param {ServiceExecutions.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link PlanqkApi.UnauthorizedError}
+     * @throws {@link PlanqkApi.ForbiddenError}
+     * @throws {@link PlanqkApi.NotFoundError}
+     * @throws {@link PlanqkApi.InternalServerError}
+     *
+     * @example
+     *     await client.serviceExecutions.getServiceExecution("id")
+     */
+    getServiceExecution(id: string, requestOptions?: ServiceExecutions.RequestOptions): core.HttpResponsePromise<string>;
+    private __getServiceExecution;
+    /**
+     * Check if the tenant has view permission for a specific service execution (identified by its ID).
+     *
+     * @param {string} id
+     * @param {ServiceExecutions.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link PlanqkApi.UnauthorizedError}
+     * @throws {@link PlanqkApi.ForbiddenError}
+     * @throws {@link PlanqkApi.NotFoundError}
+     * @throws {@link PlanqkApi.InternalServerError}
+     *
+     * @example
+     *     await client.serviceExecutions.headServiceExecution("id")
+     */
+    headServiceExecution(id: string, requestOptions?: ServiceExecutions.RequestOptions): core.HttpResponsePromise<Headers>;
+    private __headServiceExecution;
+    /**
+     * Get resource usage metrics for a specific service execution (identified by its ID).
+     *
+     * @param {string} id
+     * @param {ServiceExecutions.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link PlanqkApi.UnauthorizedError}
+     * @throws {@link PlanqkApi.ForbiddenError}
+     * @throws {@link PlanqkApi.NotFoundError}
+     * @throws {@link PlanqkApi.InternalServerError}
+     *
+     * @example
+     *     await client.serviceExecutions.getServiceExecutionMetrics("id")
+     */
+    getServiceExecutionMetrics(id: string, requestOptions?: ServiceExecutions.RequestOptions): core.HttpResponsePromise<PlanqkApi.ServiceExecutionMetrics>;
+    private __getServiceExecutionMetrics;
+    protected _getCustomAuthorizationHeaders(): Promise<{
+        "X-Auth-Token": string;
+    }>;
+}