@planqk/planqk-api-sdk 1.3.6 → 1.6.0

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

@@ -0,0 +1,581 @@
+/**
+ * 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 ServiceJobs {
+    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>;
+    }
+}
+
+/**
+ * Run your created services in a job-based manner. Service jobs allow you to execute services with specific parameters and track their execution status, costs, logs, metrics, and results.
+ */
+export class ServiceJobs {
+    protected readonly _options: ServiceJobs.Options;
+
+    constructor(_options: ServiceJobs.Options) {
+        this._options = _options;
+    }
+
+    /**
+     * Cancel a specific service job (identified by its ID). Only service jobs that are pending or currently running can be cancelled.
+     *
+     * @param {string} id
+     * @param {ServiceJobs.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link PlanqkApi.UnauthorizedError}
+     * @throws {@link PlanqkApi.ForbiddenError}
+     * @throws {@link PlanqkApi.NotFoundError}
+     * @throws {@link PlanqkApi.InternalServerError}
+     *
+     * @example
+     *     await client.serviceJobs.cancelServiceJob("id")
+     */
+    public cancelServiceJob(id: string, requestOptions?: ServiceJobs.RequestOptions): core.HttpResponsePromise<void> {
+        return core.HttpResponsePromise.fromPromise(this.__cancelServiceJob(id, requestOptions));
+    }
+
+    private async __cancelServiceJob(
+        id: string,
+        requestOptions?: ServiceJobs.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)) ??
+                    (await core.Supplier.get(this._options.environment)) ??
+                    environments.PlanqkApiEnvironment.Default,
+                `service-jobs/${encodeURIComponent(id)}/cancel`,
+            ),
+            method: "PUT",
+            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: undefined, 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 PUT /service-jobs/{id}/cancel.");
+            case "unknown":
+                throw new errors.PlanqkApiError({
+                    message: _response.error.errorMessage,
+                    rawResponse: _response.rawResponse,
+                });
+        }
+    }
+
+    /**
+     * Get a list of all service jobs for the current user or organization.
+     *
+     * @param {ServiceJobs.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link PlanqkApi.UnauthorizedError}
+     * @throws {@link PlanqkApi.ForbiddenError}
+     * @throws {@link PlanqkApi.NotFoundError}
+     * @throws {@link PlanqkApi.InternalServerError}
+     *
+     * @example
+     *     await client.serviceJobs.getServiceJobs()
+     */
+    public getServiceJobs(
+        requestOptions?: ServiceJobs.RequestOptions,
+    ): core.HttpResponsePromise<PlanqkApi.ServiceJobDto[]> {
+        return core.HttpResponsePromise.fromPromise(this.__getServiceJobs(requestOptions));
+    }
+
+    private async __getServiceJobs(
+        requestOptions?: ServiceJobs.RequestOptions,
+    ): Promise<core.WithRawResponse<PlanqkApi.ServiceJobDto[]>> {
+        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-jobs",
+            ),
+            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.ServiceJobDto[], 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-jobs.");
+            case "unknown":
+                throw new errors.PlanqkApiError({
+                    message: _response.error.errorMessage,
+                    rawResponse: _response.rawResponse,
+                });
+        }
+    }
+
+    /**
+     * Create and start a new service job.
+     *
+     * @param {PlanqkApi.CreateServiceJobRequest} request
+     * @param {ServiceJobs.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link PlanqkApi.BadRequestError}
+     * @throws {@link PlanqkApi.UnauthorizedError}
+     * @throws {@link PlanqkApi.ForbiddenError}
+     * @throws {@link PlanqkApi.NotFoundError}
+     * @throws {@link PlanqkApi.InternalServerError}
+     *
+     * @example
+     *     await client.serviceJobs.createServiceJob()
+     */
+    public createServiceJob(
+        request: PlanqkApi.CreateServiceJobRequest = {},
+        requestOptions?: ServiceJobs.RequestOptions,
+    ): core.HttpResponsePromise<PlanqkApi.ServiceJobDto> {
+        return core.HttpResponsePromise.fromPromise(this.__createServiceJob(request, requestOptions));
+    }
+
+    private async __createServiceJob(
+        request: PlanqkApi.CreateServiceJobRequest = {},
+        requestOptions?: ServiceJobs.RequestOptions,
+    ): Promise<core.WithRawResponse<PlanqkApi.ServiceJobDto>> {
+        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-jobs",
+            ),
+            method: "POST",
+            headers: _headers,
+            contentType: "application/json",
+            queryParameters: requestOptions?.queryParams,
+            requestType: "json",
+            body: request,
+            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.ServiceJobDto, rawResponse: _response.rawResponse };
+        }
+
+        if (_response.error.reason === "status-code") {
+            switch (_response.error.statusCode) {
+                case 400:
+                    throw new PlanqkApi.BadRequestError(_response.error.body as any, _response.rawResponse);
+                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 POST /service-jobs.");
+            case "unknown":
+                throw new errors.PlanqkApiError({
+                    message: _response.error.errorMessage,
+                    rawResponse: _response.rawResponse,
+                });
+        }
+    }
+
+    /**
+     * Get a specific service job (identified by its ID).
+     *
+     * @param {string} id
+     * @param {ServiceJobs.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link PlanqkApi.UnauthorizedError}
+     * @throws {@link PlanqkApi.ForbiddenError}
+     * @throws {@link PlanqkApi.NotFoundError}
+     * @throws {@link PlanqkApi.InternalServerError}
+     *
+     * @example
+     *     await client.serviceJobs.getServiceJob("id")
+     */
+    public getServiceJob(
+        id: string,
+        requestOptions?: ServiceJobs.RequestOptions,
+    ): core.HttpResponsePromise<PlanqkApi.ServiceJobDto> {
+        return core.HttpResponsePromise.fromPromise(this.__getServiceJob(id, requestOptions));
+    }
+
+    private async __getServiceJob(
+        id: string,
+        requestOptions?: ServiceJobs.RequestOptions,
+    ): Promise<core.WithRawResponse<PlanqkApi.ServiceJobDto>> {
+        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-jobs/${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 PlanqkApi.ServiceJobDto, 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-jobs/{id}.");
+            case "unknown":
+                throw new errors.PlanqkApiError({
+                    message: _response.error.errorMessage,
+                    rawResponse: _response.rawResponse,
+                });
+        }
+    }
+
+    /**
+     * Get the results for a specific service job (identified by its ID). If the service job has not completed yet or no results are available, a HTTP 204 (No Content) response is returned with a Retry-After header.
+     *
+     * @param {string} id
+     * @param {ServiceJobs.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link PlanqkApi.UnauthorizedError}
+     * @throws {@link PlanqkApi.ForbiddenError}
+     * @throws {@link PlanqkApi.NotFoundError}
+     * @throws {@link PlanqkApi.InternalServerError}
+     *
+     * @example
+     *     await client.serviceJobs.getServiceJobResults("id")
+     */
+    public getServiceJobResults(
+        id: string,
+        requestOptions?: ServiceJobs.RequestOptions,
+    ): core.HttpResponsePromise<Record<string, any>> {
+        return core.HttpResponsePromise.fromPromise(this.__getServiceJobResults(id, requestOptions));
+    }
+
+    private async __getServiceJobResults(
+        id: string,
+        requestOptions?: ServiceJobs.RequestOptions,
+    ): Promise<core.WithRawResponse<Record<string, any>>> {
+        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-jobs/${encodeURIComponent(id)}/results`,
+            ),
+            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 Record<string, any>, 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-jobs/{id}/results.");
+            case "unknown":
+                throw new errors.PlanqkApiError({
+                    message: _response.error.errorMessage,
+                    rawResponse: _response.rawResponse,
+                });
+        }
+    }
+
+    /**
+     * Get the logs for a specific service job (identified by its ID). If the service job has not started yet or no logs are available, a HTTP 204 (No Content) response is returned with a Retry-After header.
+     *
+     * @param {string} id
+     * @param {ServiceJobs.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link PlanqkApi.UnauthorizedError}
+     * @throws {@link PlanqkApi.ForbiddenError}
+     * @throws {@link PlanqkApi.NotFoundError}
+     * @throws {@link PlanqkApi.InternalServerError}
+     *
+     * @example
+     *     await client.serviceJobs.getServiceJobLogs("id")
+     */
+    public getServiceJobLogs(
+        id: string,
+        requestOptions?: ServiceJobs.RequestOptions,
+    ): core.HttpResponsePromise<PlanqkApi.ServiceExecutionLogs> {
+        return core.HttpResponsePromise.fromPromise(this.__getServiceJobLogs(id, requestOptions));
+    }
+
+    private async __getServiceJobLogs(
+        id: string,
+        requestOptions?: ServiceJobs.RequestOptions,
+    ): Promise<core.WithRawResponse<PlanqkApi.ServiceExecutionLogs>> {
+        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-jobs/${encodeURIComponent(id)}/logs`,
+            ),
+            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.ServiceExecutionLogs, 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-jobs/{id}/logs.");
+            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/serviceJobs/client/index.ts

@@ -0,0 +1,2 @@
+export {};
+export * from "./requests/index.js";

package/src/sdk/api/resources/serviceJobs/client/requests/CreateServiceJobRequest.ts

@@ -0,0 +1,16 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+
+/**
+ * @example
+ *     {}
+ */
+export interface CreateServiceJobRequest {
+    /** The ID fo the service for which the job is created. */
+    serviceId?: string;
+    /** Input data for the service job. This can be any JSON object that the service expects as input. The structure and content of this object depend on the specific service being executed. */
+    input?: Record<string, any>;
+    /** List of tags associated with the service job. Tags are saved in lowercase and can be used for filtering and searching. */
+    tags?: string[];
+}

package/src/sdk/api/resources/serviceJobs/client/requests/index.ts

@@ -0,0 +1 @@
+export { type CreateServiceJobRequest } from "./CreateServiceJobRequest.js";

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

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

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

@@ -0,0 +1,22 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+
+export interface ActivityInstance {
+    id?: string;
+    modelId?: string;
+    name?: string;
+    type?: string;
+    startTime?: string;
+    endTime?: string;
+    state?: ActivityInstance.State;
+}
+
+export namespace ActivityInstance {
+    export type State = "PENDING" | "RUNNING" | "COMPLETED";
+    export const State = {
+        Pending: "PENDING",
+        Running: "RUNNING",
+        Completed: "COMPLETED",
+    } as const;
+}

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

@@ -5,10 +5,15 @@
 export interface DataPoolDto {
     /** The access permission role for this entity of the current user */
     currentUserPermission?: DataPoolDto.CurrentUserPermission;
+    /** Unique identifier of the data pool. */
     id?: string;
+    /** Name of the data pool. */
     name?: string;
+    /** Short description of the data pool. */
     shortDescription?: string;
+    /** Detailed description of the data pool. */
     description?: string;
+    /** Timestamp when the data pool was created. */
     createdAt?: string;
 }
 

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

@@ -3,11 +3,18 @@
  */
 
 export interface DataPoolFileDto {
+    /** Unique identifier of the data pool file. */
     id?: string;
+    /** Unique identifier of the data pool. */
     dataPoolId?: string;
+    /** The name of the file. */
     name?: string;
+    /** The full path of the file in the data pool. */
     fullPath?: string;
+    /** The content type of the file. */
     contentType?: string;
+    /** The size of the file in bytes. */
     contentLength?: number;
+    /** Timestamp when the file was created. */
     createdAt?: string;
 }