@planqk/planqk-service-sdk 1.9.1 → 2.1.1

package/dist/client.js

@@ -1,98 +1,27 @@
 "use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.PlanqkServiceClient = void 0;
 const auth_1 = require("./auth");
 const sdk_1 = require("./sdk");
-const api_1 = require("./sdk/api");
 class PlanqkServiceClient {
+    _api;
     constructor(serviceEndpoint, consumerKey, consumerSecret, tokenEndpoint = auth_1.DEFAULT_TOKEN_ENDPOINT) {
         if (consumerKey && consumerSecret) {
             const auth = new auth_1.PlanqkServiceAuth(consumerKey, consumerSecret, tokenEndpoint);
             this._api = new sdk_1.PlanqkServiceApiClient({
                 environment: () => serviceEndpoint,
-                token: () => __awaiter(this, void 0, void 0, function* () { return auth.getAccessToken(); }),
+                token: async () => auth.getAccessToken(),
             });
         }
         else {
             this._api = new sdk_1.PlanqkServiceApiClient({
                 environment: () => serviceEndpoint,
-                token: () => __awaiter(this, void 0, void 0, function* () { return Math.random().toString(36).slice(2); }),
+                token: async () => Math.random().toString(36).slice(2),
             });
         }
     }
-    cancelExecution(jobId, requestOptions) {
-        return this._api.serviceApi.cancelExecution(jobId, requestOptions);
-    }
-    getInterimResults(jobId, request = {}, requestOptions) {
-        return this._api.serviceApi.getInterimResults(jobId, request, requestOptions);
-    }
-    getResult(jobId, requestOptions) {
-        return __awaiter(this, void 0, void 0, function* () {
-            yield this.waitForFinalState(jobId);
-            return this.doGetResultWithRetries(jobId, requestOptions);
-        });
-    }
-    getStatus(jobId, requestOptions) {
-        return this._api.serviceApi.getStatus(jobId, requestOptions);
-    }
-    healthCheck(requestOptions) {
-        return this._api.statusApi.healthCheck(requestOptions);
-    }
-    startExecution(request = {}, requestOptions) {
-        return this._api.serviceApi.startExecution(request, requestOptions);
-    }
-    doGetResultWithRetries(jobId, requestOptions, retries = 5, delay = 1000) {
-        return __awaiter(this, void 0, void 0, function* () {
-            try {
-                return yield this._api.serviceApi.getResult(jobId, requestOptions);
-            }
-            catch (error) {
-                if (error instanceof api_1.NotFoundError) {
-                    if (retries === 0)
-                        throw error;
-                    // Wait for the specified delay
-                    yield new Promise(resolve => {
-                        setTimeout(resolve, delay);
-                    });
-                    // Double the delay, but cap it at 16 seconds
-                    const newDelay = Math.min(delay * 2, 16000);
-                    return this.doGetResultWithRetries(jobId, requestOptions, retries - 1, newDelay);
-                }
-                throw error;
-            }
-        });
-    }
-    doWaitForFinalState(jobId, timeout, waitTime = 5, startTime = Date.now()) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const job = yield this.getStatus(jobId);
-            if (this.jobHasFinished(job))
-                return;
-            const elapsedTime = Date.now() - startTime;
-            if (timeout !== undefined && elapsedTime >= timeout * 1000) {
-                throw new Error(`Timeout while waiting for job '${jobId}'.`);
-            }
-            yield new Promise(resolve => {
-                setTimeout(resolve, waitTime * 1000);
-            });
-            yield this.doWaitForFinalState(jobId, timeout, waitTime, startTime);
-        });
-    }
-    jobHasFinished(job) {
-        return (job.status === api_1.JobStatus.Succeeded || job.status === api_1.JobStatus.Failed || job.status === api_1.JobStatus.Cancelled);
-    }
-    waitForFinalState(jobId, timeout, wait = 5) {
-        return __awaiter(this, void 0, void 0, function* () {
-            yield this.doWaitForFinalState(jobId, timeout, wait);
-        });
+    api() {
+        return this._api.serviceApi;
     }
 }
 exports.PlanqkServiceClient = PlanqkServiceClient;

package/dist/sdk/Client.d.ts

@@ -3,7 +3,6 @@
  */
 import * as environments from "./environments";
 import * as core from "./core";
-import { StatusApi } from "./api/resources/statusApi/client/Client";
 import { ServiceApi } from "./api/resources/serviceApi/client/Client";
 export declare namespace PlanqkServiceApiClient {
     interface Options {
@@ -11,15 +10,17 @@ export declare namespace PlanqkServiceApiClient {
         token: core.Supplier<core.BearerToken>;
     }
     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;
     }
 }
 export declare class PlanqkServiceApiClient {
     protected readonly _options: PlanqkServiceApiClient.Options;
     constructor(_options: PlanqkServiceApiClient.Options);
-    protected _statusApi: StatusApi | undefined;
-    get statusApi(): StatusApi;
     protected _serviceApi: ServiceApi | undefined;
     get serviceApi(): ServiceApi;
 }

package/dist/sdk/Client.js

@@ -4,19 +4,15 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.PlanqkServiceApiClient = void 0;
-const Client_1 = require("./api/resources/statusApi/client/Client");
-const Client_2 = require("./api/resources/serviceApi/client/Client");
+const Client_1 = require("./api/resources/serviceApi/client/Client");
 class PlanqkServiceApiClient {
+    _options;
     constructor(_options) {
         this._options = _options;
     }
-    get statusApi() {
-        var _a;
-        return ((_a = this._statusApi) !== null && _a !== void 0 ? _a : (this._statusApi = new Client_1.StatusApi(this._options)));
-    }
+    _serviceApi;
     get serviceApi() {
-        var _a;
-        return ((_a = this._serviceApi) !== null && _a !== void 0 ? _a : (this._serviceApi = new Client_2.ServiceApi(this._options)));
+        return (this._serviceApi ??= new Client_1.ServiceApi(this._options));
     }
 }
 exports.PlanqkServiceApiClient = PlanqkServiceApiClient;

package/dist/sdk/api/errors/BadRequestError.d.ts

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as errors from "../../errors";
+import * as errors from "../../errors/index";
 export declare class BadRequestError extends errors.PlanqkServiceApiError {
     constructor(body?: any);
 }

package/dist/sdk/api/errors/BadRequestError.js

@@ -18,16 +18,26 @@ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (
 }) : function(o, v) {
     o["default"] = v;
 });
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.BadRequestError = void 0;
-const errors = __importStar(require("../../errors"));
+const errors = __importStar(require("../../errors/index"));
 class BadRequestError extends errors.PlanqkServiceApiError {
     constructor(body) {
         super({

package/dist/sdk/api/errors/ForbiddenError.d.ts

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as errors from "../../errors";
+import * as errors from "../../errors/index";
 export declare class ForbiddenError extends errors.PlanqkServiceApiError {
     constructor(body?: any);
 }

package/dist/sdk/api/errors/ForbiddenError.js

@@ -18,16 +18,26 @@ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (
 }) : function(o, v) {
     o["default"] = v;
 });
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ForbiddenError = void 0;
-const errors = __importStar(require("../../errors"));
+const errors = __importStar(require("../../errors/index"));
 class ForbiddenError extends errors.PlanqkServiceApiError {
     constructor(body) {
         super({

package/dist/sdk/api/errors/InternalServerError.d.ts

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as errors from "../../errors";
+import * as errors from "../../errors/index";
 export declare class InternalServerError extends errors.PlanqkServiceApiError {
     constructor(body?: any);
 }

package/dist/sdk/api/errors/InternalServerError.js

@@ -18,16 +18,26 @@ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (
 }) : function(o, v) {
     o["default"] = v;
 });
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.InternalServerError = void 0;
-const errors = __importStar(require("../../errors"));
+const errors = __importStar(require("../../errors/index"));
 class InternalServerError extends errors.PlanqkServiceApiError {
     constructor(body) {
         super({

package/dist/sdk/api/errors/NotFoundError.d.ts

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as errors from "../../errors";
+import * as errors from "../../errors/index";
 export declare class NotFoundError extends errors.PlanqkServiceApiError {
     constructor(body?: any);
 }

package/dist/sdk/api/errors/NotFoundError.js

@@ -18,16 +18,26 @@ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (
 }) : function(o, v) {
     o["default"] = v;
 });
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.NotFoundError = void 0;
-const errors = __importStar(require("../../errors"));
+const errors = __importStar(require("../../errors/index"));
 class NotFoundError extends errors.PlanqkServiceApiError {
     constructor(body) {
         super({

package/dist/sdk/api/errors/UnauthorizedError.d.ts

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as errors from "../../errors";
+import * as errors from "../../errors/index";
 export declare class UnauthorizedError extends errors.PlanqkServiceApiError {
     constructor(body?: any);
 }

package/dist/sdk/api/errors/UnauthorizedError.js

@@ -18,16 +18,26 @@ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (
 }) : function(o, v) {
     o["default"] = v;
 });
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.UnauthorizedError = void 0;
-const errors = __importStar(require("../../errors"));
+const errors = __importStar(require("../../errors/index"));
 class UnauthorizedError extends errors.PlanqkServiceApiError {
     constructor(body) {
         super({

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

@@ -1,5 +1,2 @@
-export * as statusApi from "./statusApi";
-export * from "./statusApi/types";
 export * as serviceApi from "./serviceApi";
 export * from "./serviceApi/types";
-export * from "./serviceApi/client/requests";

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

@@ -15,20 +15,27 @@ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (
 }) : function(o, v) {
     o["default"] = v;
 });
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
 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.serviceApi = exports.statusApi = void 0;
-exports.statusApi = __importStar(require("./statusApi"));
-__exportStar(require("./statusApi/types"), exports);
+exports.serviceApi = void 0;
 exports.serviceApi = __importStar(require("./serviceApi"));
 __exportStar(require("./serviceApi/types"), exports);
-__exportStar(require("./serviceApi/client/requests"), exports);

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

@@ -4,21 +4,40 @@
 import * as environments from "../../../../environments";
 import * as core from "../../../../core";
 import * as PlanqkServiceApi from "../../../index";
+import * as stream from "stream";
 export declare namespace ServiceApi {
     interface Options {
         environment?: core.Supplier<environments.PlanqkServiceApiEnvironment | string>;
         token: core.Supplier<core.BearerToken>;
     }
     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;
     }
 }
 export declare class ServiceApi {
     protected readonly _options: ServiceApi.Options;
     constructor(_options: ServiceApi.Options);
     /**
-     * This method starts an execution of the service, which in turn is processed asynchronously by the platform. The location header of the response contains the URL which can be used to query the status and the result of the execution.
+     * This method checks the health of the service.
+     *
+     * @param {ServiceApi.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.serviceApi.healthCheck()
+     */
+    healthCheck(requestOptions?: ServiceApi.RequestOptions): Promise<PlanqkServiceApi.HealthCheckResponse>;
+    /**
+     * This method starts a service execution, which in turn is processed asynchronously by PLANQK.
+     * The location header of the response contains the URL which can be used to query the status and the result of the service execution.
+     *
+     * @param {Record<string, Record<string, any>>} request
+     * @param {ServiceApi.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link PlanqkServiceApi.BadRequestError}
      * @throws {@link PlanqkServiceApi.UnauthorizedError}
      * @throws {@link PlanqkServiceApi.ForbiddenError}
@@ -26,46 +45,80 @@ export declare class ServiceApi {
      * @throws {@link PlanqkServiceApi.InternalServerError}
      *
      * @example
-     *     await planqkServiceApi.serviceApi.startExecution({})
+     *     await client.serviceApi.execute({
+     *         "key": {
+     *             "key": "value"
+     *         }
+     *     })
      */
-    startExecution(request?: PlanqkServiceApi.StartExecutionRequest, requestOptions?: ServiceApi.RequestOptions): Promise<PlanqkServiceApi.Job>;
+    execute(request: Record<string, Record<string, any>>, requestOptions?: ServiceApi.RequestOptions): Promise<PlanqkServiceApi.ServiceExecution>;
     /**
-     * Checks the status of a service execution.
+     * This method checks the status of a service execution.
+     *
+     * @param {string} id - The id of a service execution
+     * @param {ServiceApi.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link PlanqkServiceApi.UnauthorizedError}
      * @throws {@link PlanqkServiceApi.ForbiddenError}
      * @throws {@link PlanqkServiceApi.NotFoundError}
      * @throws {@link PlanqkServiceApi.InternalServerError}
      *
      * @example
-     *     await planqkServiceApi.serviceApi.getStatus("id")
+     *     await client.serviceApi.getStatus("id")
      */
-    getStatus(id: string, requestOptions?: ServiceApi.RequestOptions): Promise<PlanqkServiceApi.Job>;
+    getStatus(id: string, requestOptions?: ServiceApi.RequestOptions): Promise<PlanqkServiceApi.ServiceExecution>;
     /**
-     * Gets the result of a service execution.
+     * This method retrieves the result of a service execution.
+     *
+     * @param {string} id - The id of a service execution
+     * @param {ServiceApi.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link PlanqkServiceApi.UnauthorizedError}
      * @throws {@link PlanqkServiceApi.ForbiddenError}
      * @throws {@link PlanqkServiceApi.NotFoundError}
      * @throws {@link PlanqkServiceApi.InternalServerError}
+     *
+     * @example
+     *     await client.serviceApi.getResult("id")
      */
     getResult(id: string, requestOptions?: ServiceApi.RequestOptions): Promise<PlanqkServiceApi.GetResultResponse>;
     /**
-     * Gets the last or a list of interim results of a service execution.
+     * This method downloads a result file of a service execution.
      * @throws {@link PlanqkServiceApi.UnauthorizedError}
      * @throws {@link PlanqkServiceApi.ForbiddenError}
      * @throws {@link PlanqkServiceApi.NotFoundError}
      * @throws {@link PlanqkServiceApi.InternalServerError}
      */
-    getInterimResults(id: string, request?: PlanqkServiceApi.GetInterimResultsRequest, requestOptions?: ServiceApi.RequestOptions): Promise<PlanqkServiceApi.GetInterimResultsResponse>;
+    getResultFile(id: string, file: string, requestOptions?: ServiceApi.RequestOptions): Promise<stream.Readable>;
     /**
-     * Cancels a running service execution.
+     * This method retrieves the log output of a service execution.
+     *
+     * @param {string} id - The id of a service execution
+     * @param {ServiceApi.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link PlanqkServiceApi.UnauthorizedError}
+     * @throws {@link PlanqkServiceApi.ForbiddenError}
+     * @throws {@link PlanqkServiceApi.NotFoundError}
+     * @throws {@link PlanqkServiceApi.InternalServerError}
+     *
+     * @example
+     *     await client.serviceApi.getLogs("id")
+     */
+    getLogs(id: string, requestOptions?: ServiceApi.RequestOptions): Promise<string[]>;
+    /**
+     * This method cancels a service execution.
+     *
+     * @param {string} id - The id of a service execution
+     * @param {ServiceApi.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link PlanqkServiceApi.UnauthorizedError}
      * @throws {@link PlanqkServiceApi.ForbiddenError}
      * @throws {@link PlanqkServiceApi.NotFoundError}
      * @throws {@link PlanqkServiceApi.InternalServerError}
      *
      * @example
-     *     await planqkServiceApi.serviceApi.cancelExecution("id")
+     *     await client.serviceApi.cancel("id")
      */
-    cancelExecution(id: string, requestOptions?: ServiceApi.RequestOptions): Promise<PlanqkServiceApi.Job>;
+    cancel(id: string, requestOptions?: ServiceApi.RequestOptions): Promise<PlanqkServiceApi.ServiceExecution>;
     protected _getAuthorizationHeader(): Promise<string>;
 }