@planqk/planqk-service-sdk 1.9.0 → 2.1.0

package/src/sdk/api/resources/serviceApi/client/Client.ts

@@ -5,8 +5,9 @@
 import * as environments from "../../../../environments";
 import * as core from "../../../../core";
 import * as PlanqkServiceApi from "../../../index";
-import * as errors from "../../../../errors";
+import * as errors from "../../../../errors/index";
 import urlJoin from "url-join";
+import * as stream from "stream";
 
 export declare namespace ServiceApi {
     interface Options {
@@ -15,8 +16,12 @@ export declare namespace ServiceApi {
     }
 
     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;
     }
 }
 
@@ -24,7 +29,67 @@ export class ServiceApi {
     constructor(protected readonly _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()
+     */
+    public async healthCheck(
+        requestOptions?: ServiceApi.RequestOptions
+    ): Promise<PlanqkServiceApi.HealthCheckResponse> {
+        const _response = await core.fetcher({
+            url:
+                (await core.Supplier.get(this._options.environment)) ??
+                environments.PlanqkServiceApiEnvironment.Default,
+            method: "GET",
+            headers: {
+                Authorization: await this._getAuthorizationHeader(),
+                "X-Fern-Language": "JavaScript",
+                "X-Fern-Runtime": core.RUNTIME.type,
+                "X-Fern-Runtime-Version": core.RUNTIME.version,
+            },
+            contentType: "application/json",
+            requestType: "json",
+            timeoutMs: requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
+            maxRetries: requestOptions?.maxRetries,
+            withCredentials: true,
+            abortSignal: requestOptions?.abortSignal,
+        });
+        if (_response.ok) {
+            return _response.body as PlanqkServiceApi.HealthCheckResponse;
+        }
+
+        if (_response.error.reason === "status-code") {
+            throw new errors.PlanqkServiceApiError({
+                statusCode: _response.error.statusCode,
+                body: _response.error.body,
+            });
+        }
+
+        switch (_response.error.reason) {
+            case "non-json":
+                throw new errors.PlanqkServiceApiError({
+                    statusCode: _response.error.statusCode,
+                    body: _response.error.rawBody,
+                });
+            case "timeout":
+                throw new errors.PlanqkServiceApiTimeoutError();
+            case "unknown":
+                throw new errors.PlanqkServiceApiError({
+                    message: _response.error.errorMessage,
+                });
+        }
+    }
+
+    /**
+     * 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}
@@ -32,12 +97,16 @@ export class ServiceApi {
      * @throws {@link PlanqkServiceApi.InternalServerError}
      *
      * @example
-     *     await planqkServiceApi.serviceApi.startExecution({})
+     *     await client.serviceApi.execute({
+     *         "key": {
+     *             "key": "value"
+     *         }
+     *     })
      */
-    public async startExecution(
-        request: PlanqkServiceApi.StartExecutionRequest = {},
+    public async execute(
+        request: Record<string, Record<string, any>>,
         requestOptions?: ServiceApi.RequestOptions
-    ): Promise<PlanqkServiceApi.Job> {
+    ): Promise<PlanqkServiceApi.ServiceExecution> {
         const _response = await core.fetcher({
             url:
                 (await core.Supplier.get(this._options.environment)) ??
@@ -46,15 +115,19 @@ export class ServiceApi {
             headers: {
                 Authorization: await this._getAuthorizationHeader(),
                 "X-Fern-Language": "JavaScript",
+                "X-Fern-Runtime": core.RUNTIME.type,
+                "X-Fern-Runtime-Version": core.RUNTIME.version,
             },
             contentType: "application/json",
+            requestType: "json",
             body: request,
             timeoutMs: requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
             maxRetries: requestOptions?.maxRetries,
             withCredentials: true,
+            abortSignal: requestOptions?.abortSignal,
         });
         if (_response.ok) {
-            return _response.body as PlanqkServiceApi.Job;
+            return _response.body as PlanqkServiceApi.ServiceExecution;
         }
 
         if (_response.error.reason === "status-code") {
@@ -93,34 +166,45 @@ export class ServiceApi {
     }
 
     /**
-     * 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")
      */
-    public async getStatus(id: string, requestOptions?: ServiceApi.RequestOptions): Promise<PlanqkServiceApi.Job> {
+    public async getStatus(
+        id: string,
+        requestOptions?: ServiceApi.RequestOptions
+    ): Promise<PlanqkServiceApi.ServiceExecution> {
         const _response = await core.fetcher({
             url: urlJoin(
                 (await core.Supplier.get(this._options.environment)) ??
                     environments.PlanqkServiceApiEnvironment.Default,
-                `${id}`
+                `${encodeURIComponent(id)}`
             ),
             method: "GET",
             headers: {
                 Authorization: await this._getAuthorizationHeader(),
                 "X-Fern-Language": "JavaScript",
+                "X-Fern-Runtime": core.RUNTIME.type,
+                "X-Fern-Runtime-Version": core.RUNTIME.version,
             },
             contentType: "application/json",
+            requestType: "json",
             timeoutMs: requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
             maxRetries: requestOptions?.maxRetries,
             withCredentials: true,
+            abortSignal: requestOptions?.abortSignal,
         });
         if (_response.ok) {
-            return _response.body as PlanqkServiceApi.Job;
+            return _response.body as PlanqkServiceApi.ServiceExecution;
         }
 
         if (_response.error.reason === "status-code") {
@@ -157,11 +241,18 @@ export class ServiceApi {
     }
 
     /**
-     * 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")
      */
     public async getResult(
         id: string,
@@ -171,17 +262,21 @@ export class ServiceApi {
             url: urlJoin(
                 (await core.Supplier.get(this._options.environment)) ??
                     environments.PlanqkServiceApiEnvironment.Default,
-                `${id}/result`
+                `${encodeURIComponent(id)}/result`
             ),
             method: "GET",
             headers: {
                 Authorization: await this._getAuthorizationHeader(),
                 "X-Fern-Language": "JavaScript",
+                "X-Fern-Runtime": core.RUNTIME.type,
+                "X-Fern-Runtime-Version": core.RUNTIME.version,
             },
             contentType: "application/json",
+            requestType: "json",
             timeoutMs: requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
             maxRetries: requestOptions?.maxRetries,
             withCredentials: true,
+            abortSignal: requestOptions?.abortSignal,
         });
         if (_response.ok) {
             return _response.body as PlanqkServiceApi.GetResultResponse;
@@ -221,42 +316,112 @@ export class ServiceApi {
     }
 
     /**
-     * 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}
      */
-    public async getInterimResults(
+    public async getResultFile(
         id: string,
-        request: PlanqkServiceApi.GetInterimResultsRequest = {},
+        file: string,
         requestOptions?: ServiceApi.RequestOptions
-    ): Promise<PlanqkServiceApi.GetInterimResultsResponse> {
-        const { last } = request;
-        const _queryParams: Record<string, string | string[]> = {};
-        if (last != null) {
-            _queryParams["last"] = last.toString();
+    ): Promise<stream.Readable> {
+        const _response = await core.fetcher<stream.Readable>({
+            url: urlJoin(
+                (await core.Supplier.get(this._options.environment)) ??
+                    environments.PlanqkServiceApiEnvironment.Default,
+                `${encodeURIComponent(id)}/result/${encodeURIComponent(file)}`
+            ),
+            method: "GET",
+            headers: {
+                Authorization: await this._getAuthorizationHeader(),
+                "X-Fern-Language": "JavaScript",
+                "X-Fern-Runtime": core.RUNTIME.type,
+                "X-Fern-Runtime-Version": core.RUNTIME.version,
+            },
+            contentType: "application/json",
+            requestType: "json",
+            responseType: "streaming",
+            timeoutMs: requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
+            maxRetries: requestOptions?.maxRetries,
+            withCredentials: true,
+            abortSignal: requestOptions?.abortSignal,
+        });
+        if (_response.ok) {
+            return _response.body;
+        }
+
+        if (_response.error.reason === "status-code") {
+            switch (_response.error.statusCode) {
+                case 401:
+                    throw new PlanqkServiceApi.UnauthorizedError(_response.error.body as any);
+                case 403:
+                    throw new PlanqkServiceApi.ForbiddenError(_response.error.body as any);
+                case 404:
+                    throw new PlanqkServiceApi.NotFoundError(_response.error.body as any);
+                case 500:
+                    throw new PlanqkServiceApi.InternalServerError(_response.error.body as any);
+                default:
+                    throw new errors.PlanqkServiceApiError({
+                        statusCode: _response.error.statusCode,
+                        body: _response.error.body,
+                    });
+            }
         }
 
+        switch (_response.error.reason) {
+            case "non-json":
+                throw new errors.PlanqkServiceApiError({
+                    statusCode: _response.error.statusCode,
+                    body: _response.error.rawBody,
+                });
+            case "timeout":
+                throw new errors.PlanqkServiceApiTimeoutError();
+            case "unknown":
+                throw new errors.PlanqkServiceApiError({
+                    message: _response.error.errorMessage,
+                });
+        }
+    }
+
+    /**
+     * 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")
+     */
+    public async getLogs(id: string, requestOptions?: ServiceApi.RequestOptions): Promise<string[]> {
         const _response = await core.fetcher({
             url: urlJoin(
                 (await core.Supplier.get(this._options.environment)) ??
                     environments.PlanqkServiceApiEnvironment.Default,
-                `${id}/interim-results`
+                `${encodeURIComponent(id)}/log`
             ),
             method: "GET",
             headers: {
                 Authorization: await this._getAuthorizationHeader(),
                 "X-Fern-Language": "JavaScript",
+                "X-Fern-Runtime": core.RUNTIME.type,
+                "X-Fern-Runtime-Version": core.RUNTIME.version,
             },
             contentType: "application/json",
-            queryParameters: _queryParams,
+            requestType: "json",
             timeoutMs: requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
             maxRetries: requestOptions?.maxRetries,
             withCredentials: true,
+            abortSignal: requestOptions?.abortSignal,
         });
         if (_response.ok) {
-            return _response.body as PlanqkServiceApi.GetInterimResultsResponse;
+            return _response.body as string[];
         }
 
         if (_response.error.reason === "status-code") {
@@ -293,37 +458,45 @@ export class ServiceApi {
     }
 
     /**
-     * Cancels a running service execution.
+     * 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")
      */
-    public async cancelExecution(
+    public async cancel(
         id: string,
         requestOptions?: ServiceApi.RequestOptions
-    ): Promise<PlanqkServiceApi.Job> {
+    ): Promise<PlanqkServiceApi.ServiceExecution> {
         const _response = await core.fetcher({
             url: urlJoin(
                 (await core.Supplier.get(this._options.environment)) ??
                     environments.PlanqkServiceApiEnvironment.Default,
-                `${id}/cancel`
+                `${encodeURIComponent(id)}/cancel`
             ),
             method: "PUT",
             headers: {
                 Authorization: await this._getAuthorizationHeader(),
                 "X-Fern-Language": "JavaScript",
+                "X-Fern-Runtime": core.RUNTIME.type,
+                "X-Fern-Runtime-Version": core.RUNTIME.version,
             },
             contentType: "application/json",
+            requestType: "json",
             timeoutMs: requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
             maxRetries: requestOptions?.maxRetries,
             withCredentials: true,
+            abortSignal: requestOptions?.abortSignal,
         });
         if (_response.ok) {
-            return _response.body as PlanqkServiceApi.Job;
+            return _response.body as PlanqkServiceApi.ServiceExecution;
         }
 
         if (_response.error.reason === "status-code") {
@@ -359,7 +532,7 @@ export class ServiceApi {
         }
     }
 
-    protected async _getAuthorizationHeader() {
+    protected async _getAuthorizationHeader(): Promise<string> {
         return `Bearer ${await core.Supplier.get(this._options.token)}`;
     }
 }

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

@@ -1 +1 @@
-export * from "./requests";
+export {};

package/src/sdk/api/resources/serviceApi/types/GetResultResponse.ts

@@ -4,8 +4,7 @@
 
 import * as PlanqkServiceApi from "../../../index";
 
-export type GetResultResponse =
-    | PlanqkServiceApi.ObjectResponse
-    | PlanqkServiceApi.StringResponse
-    | PlanqkServiceApi.NumberResponse
-    | PlanqkServiceApi.ArrayResponse;
+export interface GetResultResponse {
+    _links?: PlanqkServiceApi.GetResultResponseLinks;
+    _embedded?: PlanqkServiceApi.GetResultResponseEmbedded;
+}

package/src/sdk/api/resources/serviceApi/types/GetResultResponseEmbedded.ts

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+
+import * as PlanqkServiceApi from "../../../index";
+
+export interface GetResultResponseEmbedded {
+    status?: PlanqkServiceApi.ServiceExecution;
+}

package/src/sdk/api/resources/serviceApi/types/GetResultResponseLinks.ts

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+
+import * as PlanqkServiceApi from "../../../index";
+
+export interface GetResultResponseLinks {
+    status?: PlanqkServiceApi.HalLink;
+}

package/src/sdk/api/resources/{statusApi → serviceApi}/types/HealthCheckResponse.ts

@@ -3,5 +3,6 @@
  */
 
 export interface HealthCheckResponse {
+    /** Status of the service */
     status?: string;
 }

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

@@ -1,2 +1,4 @@
+export * from "./HealthCheckResponse";
+export * from "./GetResultResponseLinks";
+export * from "./GetResultResponseEmbedded";
 export * from "./GetResultResponse";
-export * from "./GetInterimResultsResponse";

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

@@ -0,0 +1,22 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+
+export interface HalLink {
+    /** The URL of the link */
+    href?: string;
+    /** Whether the link is templated (optional) */
+    templated?: boolean;
+    /** The media type of the link (optional) */
+    type?: string;
+    /** A URL that provides further information about the deprecation of the link (optional) */
+    deprecation?: string;
+    /** The name of the link (optional) */
+    name?: string;
+    /** A URL that provides further information about the profile of the link (optional) */
+    profile?: string;
+    /** The title of the link (optional) */
+    title?: string;
+    /** The language of the link's target resource (optional) */
+    hreflang?: string;
+}

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

@@ -2,4 +2,4 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 
-export type InputData = Record<string, any>;
+export type InputData = Record<string, Record<string, any>>;

package/src/sdk/api/types/{InputRef.ts → InputDataRef.ts}

@@ -2,7 +2,7 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 
-export interface InputRef {
+export interface InputDataRef {
     dataPoolId: string;
     dataSourceDescriptorId: string;
     fileId: string;

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

@@ -2,4 +2,4 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 
-export type InputParams = Record<string, any>;
+export type InputParams = Record<string, Record<string, any>>;

package/src/sdk/api/types/{Job.ts → ServiceExecution.ts}

@@ -4,9 +4,9 @@
 
 import * as PlanqkServiceApi from "../index";
 
-export interface Job {
+export interface ServiceExecution {
     id?: string;
-    status?: PlanqkServiceApi.JobStatus;
+    status?: PlanqkServiceApi.ServiceExecutionStatus;
     createdAt?: string;
     startedAt?: string;
     endedAt?: string;

package/src/sdk/api/types/{JobStatus.ts → ServiceExecutionStatus.ts}

@@ -2,9 +2,9 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 
-export type JobStatus = "UNKNOWN" | "PENDING" | "RUNNING" | "SUCCEEDED" | "CANCELLED" | "FAILED";
+export type ServiceExecutionStatus = "UNKNOWN" | "PENDING" | "RUNNING" | "SUCCEEDED" | "CANCELLED" | "FAILED";
 
-export const JobStatus = {
+export const ServiceExecutionStatus = {
     Unknown: "UNKNOWN",
     Pending: "PENDING",
     Running: "RUNNING",

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

@@ -1,10 +1,6 @@
 export * from "./InputData";
 export * from "./InputParams";
-export * from "./InputRef";
-export * from "./InterimResultResponse";
-export * from "./ObjectResponse";
-export * from "./StringResponse";
-export * from "./NumberResponse";
-export * from "./ArrayResponse";
-export * from "./JobStatus";
-export * from "./Job";
+export * from "./InputDataRef";
+export * from "./ServiceExecutionStatus";
+export * from "./ServiceExecution";
+export * from "./HalLink";

package/src/sdk/core/fetcher/APIResponse.ts

@@ -3,6 +3,7 @@ export type APIResponse<Success, Failure> = SuccessfulResponse<Success> | Failed
 export interface SuccessfulResponse<T> {
     ok: true;
     body: T;
+    headers?: Record<string, any>;
 }
 
 export interface FailedResponse<T> {