@planqk/planqk-api-sdk 1.3.6 → 1.6.0

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

@@ -30,6 +30,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>;
     }
@@ -70,6 +72,14 @@ export class DataPools {
         id: string,
         requestOptions?: DataPools.RequestOptions,
     ): Promise<core.WithRawResponse<PlanqkApi.DataPoolDto>> {
+        let _headers: core.Fetcher.Args["headers"] = mergeHeaders(
+            this._options?.headers,
+            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)) ??
@@ -78,14 +88,8 @@ export class DataPools {
                 `datapools/${encodeURIComponent(id)}`,
             ),
             method: "GET",
-            headers: mergeHeaders(
-                this._options?.headers,
-                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,
@@ -160,6 +164,14 @@ export class DataPools {
         request: PlanqkApi.UpdateDataPoolRequest = {},
         requestOptions?: DataPools.RequestOptions,
     ): Promise<core.WithRawResponse<PlanqkApi.DataPoolDto>> {
+        let _headers: core.Fetcher.Args["headers"] = mergeHeaders(
+            this._options?.headers,
+            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)) ??
@@ -168,15 +180,9 @@ export class DataPools {
                 `datapools/${encodeURIComponent(id)}`,
             ),
             method: "PUT",
-            headers: mergeHeaders(
-                this._options?.headers,
-                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,
@@ -248,6 +254,14 @@ export class DataPools {
         id: string,
         requestOptions?: DataPools.RequestOptions,
     ): Promise<core.WithRawResponse<void>> {
+        let _headers: core.Fetcher.Args["headers"] = mergeHeaders(
+            this._options?.headers,
+            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)) ??
@@ -256,14 +270,8 @@ export class DataPools {
                 `datapools/${encodeURIComponent(id)}`,
             ),
             method: "DELETE",
-            headers: mergeHeaders(
-                this._options?.headers,
-                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,
@@ -310,7 +318,7 @@ export 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.
      *
@@ -329,6 +337,14 @@ export class DataPools {
     private async __getDataPools(
         requestOptions?: DataPools.RequestOptions,
     ): Promise<core.WithRawResponse<PlanqkApi.DataPoolDto[]>> {
+        let _headers: core.Fetcher.Args["headers"] = mergeHeaders(
+            this._options?.headers,
+            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)) ??
@@ -337,14 +353,8 @@ export class DataPools {
                 "datapools",
             ),
             method: "GET",
-            headers: mergeHeaders(
-                this._options?.headers,
-                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,
@@ -416,6 +426,14 @@ export class DataPools {
         request: PlanqkApi.CreateDataPoolRequest = {},
         requestOptions?: DataPools.RequestOptions,
     ): Promise<core.WithRawResponse<PlanqkApi.DataPoolDto>> {
+        let _headers: core.Fetcher.Args["headers"] = mergeHeaders(
+            this._options?.headers,
+            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)) ??
@@ -424,15 +442,9 @@ export class DataPools {
                 "datapools",
             ),
             method: "POST",
-            headers: mergeHeaders(
-                this._options?.headers,
-                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,
@@ -507,6 +519,14 @@ export class DataPools {
         id: string,
         requestOptions?: DataPools.RequestOptions,
     ): Promise<core.WithRawResponse<PlanqkApi.DataPoolFileDto[]>> {
+        let _headers: core.Fetcher.Args["headers"] = mergeHeaders(
+            this._options?.headers,
+            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)) ??
@@ -515,14 +535,8 @@ export class DataPools {
                 `datapools/${encodeURIComponent(id)}/files`,
             ),
             method: "GET",
-            headers: mergeHeaders(
-                this._options?.headers,
-                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,
@@ -582,6 +596,7 @@ export class DataPools {
      * @throws {@link PlanqkApi.InternalServerError}
      *
      * @example
+     *     import { createReadStream } from "fs";
      *     await client.dataPools.addDataPoolFile("id", {
      *         file: fs.createReadStream("/path/to/your/file")
      *     })
@@ -607,6 +622,15 @@ export class DataPools {
         const _request = await core.newFormData();
         await _request.appendFile("file", request.file);
         const _maybeEncodedRequest = await _request.getRequest();
+        let _headers: core.Fetcher.Args["headers"] = mergeHeaders(
+            this._options?.headers,
+            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)) ??
@@ -615,16 +639,8 @@ export class DataPools {
                 `datapools/${encodeURIComponent(id)}/files`,
             ),
             method: "POST",
-            headers: mergeHeaders(
-                this._options?.headers,
-                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,
@@ -695,6 +711,14 @@ export class DataPools {
         fileId: string,
         requestOptions?: DataPools.RequestOptions,
     ): Promise<core.WithRawResponse<core.BinaryResponse>> {
+        let _headers: core.Fetcher.Args["headers"] = mergeHeaders(
+            this._options?.headers,
+            mergeOnlyDefinedHeaders({
+                "X-OrganizationId": requestOptions?.organizationId ?? this._options?.organizationId,
+                ...(await this._getCustomAuthorizationHeaders()),
+            }),
+            requestOptions?.headers,
+        );
         const _response = await core.fetcher<core.BinaryResponse>({
             url: core.url.join(
                 (await core.Supplier.get(this._options.baseUrl)) ??
@@ -703,14 +727,8 @@ export class DataPools {
                 `datapools/${encodeURIComponent(id)}/files/${encodeURIComponent(fileId)}`,
             ),
             method: "GET",
-            headers: mergeHeaders(
-                this._options?.headers,
-                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,
@@ -787,6 +805,14 @@ export class DataPools {
         fileId: string,
         requestOptions?: DataPools.RequestOptions,
     ): Promise<core.WithRawResponse<void>> {
+        let _headers: core.Fetcher.Args["headers"] = mergeHeaders(
+            this._options?.headers,
+            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)) ??
@@ -795,14 +821,8 @@ export class DataPools {
                 `datapools/${encodeURIComponent(id)}/files/${encodeURIComponent(fileId)}`,
             ),
             method: "DELETE",
-            headers: mergeHeaders(
-                this._options?.headers,
-                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/src/sdk/api/resources/dataPools/client/requests/AddDataPoolFileRequest.ts

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

package/src/sdk/api/resources/dataPools/client/requests/CreateDataPoolRequest.ts

@@ -7,5 +7,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/src/sdk/api/resources/dataPools/client/requests/UpdateDataPoolRequest.ts

@@ -7,7 +7,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/src/sdk/api/resources/index.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/src/sdk/api/resources/serviceExecutions/client/Client.ts

@@ -0,0 +1,323 @@
+/**
+ * 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";
+import { mergeHeaders, mergeOnlyDefinedHeaders } from "../../../../core/headers.js";
+import * as errors from "../../../../errors/index.js";
+
+export declare namespace ServiceExecutions {
+    export 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>;
+    }
+
+    export 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 class ServiceExecutions {
+    protected readonly _options: ServiceExecutions.Options;
+
+    constructor(_options: ServiceExecutions.Options) {
+        this._options = _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")
+     */
+    public getServiceExecution(
+        id: string,
+        requestOptions?: ServiceExecutions.RequestOptions,
+    ): core.HttpResponsePromise<string> {
+        return core.HttpResponsePromise.fromPromise(this.__getServiceExecution(id, requestOptions));
+    }
+
+    private async __getServiceExecution(
+        id: string,
+        requestOptions?: ServiceExecutions.RequestOptions,
+    ): Promise<core.WithRawResponse<string>> {
+        let _headers: core.Fetcher.Args["headers"] = mergeHeaders(
+            this._options?.headers,
+            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,
+                `service-executions/v1/${encodeURIComponent(id)}`,
+            ),
+            method: "GET",
+            headers: _headers,
+            queryParameters: requestOptions?.queryParams,
+            timeoutMs: requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
+            maxRetries: requestOptions?.maxRetries,
+            withCredentials: true,
+            abortSignal: requestOptions?.abortSignal,
+        });
+        if (_response.ok) {
+            return { data: _response.body as string, rawResponse: _response.rawResponse };
+        }
+
+        if (_response.error.reason === "status-code") {
+            switch (_response.error.statusCode) {
+                case 401:
+                    throw new PlanqkApi.UnauthorizedError(_response.error.body as any, _response.rawResponse);
+                case 403:
+                    throw new PlanqkApi.ForbiddenError(_response.error.body as any, _response.rawResponse);
+                case 404:
+                    throw new PlanqkApi.NotFoundError(_response.error.body as any, _response.rawResponse);
+                case 500:
+                    throw new PlanqkApi.InternalServerError(_response.error.body as any, _response.rawResponse);
+                default:
+                    throw new errors.PlanqkApiError({
+                        statusCode: _response.error.statusCode,
+                        body: _response.error.body,
+                        rawResponse: _response.rawResponse,
+                    });
+            }
+        }
+
+        switch (_response.error.reason) {
+            case "non-json":
+                throw new errors.PlanqkApiError({
+                    statusCode: _response.error.statusCode,
+                    body: _response.error.rawBody,
+                    rawResponse: _response.rawResponse,
+                });
+            case "timeout":
+                throw new errors.PlanqkApiTimeoutError(
+                    "Timeout exceeded when calling GET /service-executions/v1/{id}.",
+                );
+            case "unknown":
+                throw new errors.PlanqkApiError({
+                    message: _response.error.errorMessage,
+                    rawResponse: _response.rawResponse,
+                });
+        }
+    }
+
+    /**
+     * 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")
+     */
+    public headServiceExecution(
+        id: string,
+        requestOptions?: ServiceExecutions.RequestOptions,
+    ): core.HttpResponsePromise<Headers> {
+        return core.HttpResponsePromise.fromPromise(this.__headServiceExecution(id, requestOptions));
+    }
+
+    private async __headServiceExecution(
+        id: string,
+        requestOptions?: ServiceExecutions.RequestOptions,
+    ): Promise<core.WithRawResponse<Headers>> {
+        let _headers: core.Fetcher.Args["headers"] = mergeHeaders(
+            this._options?.headers,
+            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,
+                `service-executions/v1/${encodeURIComponent(id)}`,
+            ),
+            method: "HEAD",
+            headers: _headers,
+            queryParameters: requestOptions?.queryParams,
+            timeoutMs: requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
+            maxRetries: requestOptions?.maxRetries,
+            withCredentials: true,
+            abortSignal: requestOptions?.abortSignal,
+        });
+        if (_response.ok) {
+            return { data: _response.rawResponse.headers, rawResponse: _response.rawResponse };
+        }
+
+        if (_response.error.reason === "status-code") {
+            switch (_response.error.statusCode) {
+                case 401:
+                    throw new PlanqkApi.UnauthorizedError(_response.error.body as any, _response.rawResponse);
+                case 403:
+                    throw new PlanqkApi.ForbiddenError(_response.error.body as any, _response.rawResponse);
+                case 404:
+                    throw new PlanqkApi.NotFoundError(_response.error.body as any, _response.rawResponse);
+                case 500:
+                    throw new PlanqkApi.InternalServerError(_response.error.body as any, _response.rawResponse);
+                default:
+                    throw new errors.PlanqkApiError({
+                        statusCode: _response.error.statusCode,
+                        body: _response.error.body,
+                        rawResponse: _response.rawResponse,
+                    });
+            }
+        }
+
+        switch (_response.error.reason) {
+            case "non-json":
+                throw new errors.PlanqkApiError({
+                    statusCode: _response.error.statusCode,
+                    body: _response.error.rawBody,
+                    rawResponse: _response.rawResponse,
+                });
+            case "timeout":
+                throw new errors.PlanqkApiTimeoutError(
+                    "Timeout exceeded when calling HEAD /service-executions/v1/{id}.",
+                );
+            case "unknown":
+                throw new errors.PlanqkApiError({
+                    message: _response.error.errorMessage,
+                    rawResponse: _response.rawResponse,
+                });
+        }
+    }
+
+    /**
+     * 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")
+     */
+    public getServiceExecutionMetrics(
+        id: string,
+        requestOptions?: ServiceExecutions.RequestOptions,
+    ): core.HttpResponsePromise<PlanqkApi.ServiceExecutionMetrics> {
+        return core.HttpResponsePromise.fromPromise(this.__getServiceExecutionMetrics(id, requestOptions));
+    }
+
+    private async __getServiceExecutionMetrics(
+        id: string,
+        requestOptions?: ServiceExecutions.RequestOptions,
+    ): Promise<core.WithRawResponse<PlanqkApi.ServiceExecutionMetrics>> {
+        let _headers: core.Fetcher.Args["headers"] = mergeHeaders(
+            this._options?.headers,
+            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,
+                `service-executions/v1/${encodeURIComponent(id)}/metrics`,
+            ),
+            method: "GET",
+            headers: _headers,
+            queryParameters: requestOptions?.queryParams,
+            timeoutMs: requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
+            maxRetries: requestOptions?.maxRetries,
+            withCredentials: true,
+            abortSignal: requestOptions?.abortSignal,
+        });
+        if (_response.ok) {
+            return { data: _response.body as PlanqkApi.ServiceExecutionMetrics, rawResponse: _response.rawResponse };
+        }
+
+        if (_response.error.reason === "status-code") {
+            switch (_response.error.statusCode) {
+                case 401:
+                    throw new PlanqkApi.UnauthorizedError(_response.error.body as any, _response.rawResponse);
+                case 403:
+                    throw new PlanqkApi.ForbiddenError(_response.error.body as any, _response.rawResponse);
+                case 404:
+                    throw new PlanqkApi.NotFoundError(_response.error.body as any, _response.rawResponse);
+                case 500:
+                    throw new PlanqkApi.InternalServerError(_response.error.body as any, _response.rawResponse);
+                default:
+                    throw new errors.PlanqkApiError({
+                        statusCode: _response.error.statusCode,
+                        body: _response.error.body,
+                        rawResponse: _response.rawResponse,
+                    });
+            }
+        }
+
+        switch (_response.error.reason) {
+            case "non-json":
+                throw new errors.PlanqkApiError({
+                    statusCode: _response.error.statusCode,
+                    body: _response.error.rawBody,
+                    rawResponse: _response.rawResponse,
+                });
+            case "timeout":
+                throw new errors.PlanqkApiTimeoutError(
+                    "Timeout exceeded when calling GET /service-executions/v1/{id}/metrics.",
+                );
+            case "unknown":
+                throw new errors.PlanqkApiError({
+                    message: _response.error.errorMessage,
+                    rawResponse: _response.rawResponse,
+                });
+        }
+    }
+
+    protected async _getCustomAuthorizationHeaders() {
+        const apiKeyValue = await core.Supplier.get(this._options.apiKey);
+        return { "X-Auth-Token": apiKeyValue };
+    }
+}

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

@@ -0,0 +1 @@
+export {};

package/src/sdk/api/resources/serviceExecutions/index.ts

@@ -0,0 +1 @@
+export * from "./client/index.js";