@daytona/api-client 0.161.0-alpha.2

package/src/api/runners-api.d.ts

@@ -0,0 +1,425 @@
+/**
+ * Daytona
+ * Daytona AI platform API Docs
+ *
+ * The version of the OpenAPI document: 1.0
+ * Contact: support@daytona.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { Configuration } from '../configuration';
+import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
+import { type RequestArgs, BaseAPI } from '../base';
+import type { CreateRunner } from '../models';
+import type { CreateRunnerResponse } from '../models';
+import type { Runner } from '../models';
+import type { RunnerFull } from '../models';
+import type { RunnerHealthcheck } from '../models';
+import type { RunnerSnapshotDto } from '../models';
+/**
+ * RunnersApi - axios parameter creator
+ * @export
+ */
+export declare const RunnersApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     *
+     * @summary Create runner
+     * @param {CreateRunner} createRunner
+     * @param {string} [xDaytonaOrganizationID] Use with JWT to specify the organization ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createRunner: (createRunner: CreateRunner, xDaytonaOrganizationID?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Delete runner
+     * @param {string} id Runner ID
+     * @param {string} [xDaytonaOrganizationID] Use with JWT to specify the organization ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteRunner: (id: string, xDaytonaOrganizationID?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Get info for authenticated runner
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getInfoForAuthenticatedRunner: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Get runner by ID
+     * @param {string} id Runner ID
+     * @param {string} [xDaytonaOrganizationID] Use with JWT to specify the organization ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getRunnerById: (id: string, xDaytonaOrganizationID?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Get runner by sandbox ID
+     * @param {string} sandboxId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getRunnerBySandboxId: (sandboxId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Get runner by ID
+     * @param {string} id Runner ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getRunnerFullById: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Get runners by snapshot ref
+     * @param {string} ref Snapshot ref
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getRunnersBySnapshotRef: (ref: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary List all runners
+     * @param {string} [xDaytonaOrganizationID] Use with JWT to specify the organization ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listRunners: (xDaytonaOrganizationID?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Endpoint for version 2 runners to send healthcheck and metrics. Updates lastChecked timestamp and runner metrics.
+     * @summary Runner healthcheck
+     * @param {RunnerHealthcheck} runnerHealthcheck
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    runnerHealthcheck: (runnerHealthcheck: RunnerHealthcheck, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Update runner draining status
+     * @param {string} id Runner ID
+     * @param {string} [xDaytonaOrganizationID] Use with JWT to specify the organization ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateRunnerDraining: (id: string, xDaytonaOrganizationID?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Update runner scheduling status
+     * @param {string} id Runner ID
+     * @param {string} [xDaytonaOrganizationID] Use with JWT to specify the organization ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateRunnerScheduling: (id: string, xDaytonaOrganizationID?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * RunnersApi - functional programming interface
+ * @export
+ */
+export declare const RunnersApiFp: (configuration?: Configuration) => {
+    /**
+     *
+     * @summary Create runner
+     * @param {CreateRunner} createRunner
+     * @param {string} [xDaytonaOrganizationID] Use with JWT to specify the organization ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createRunner(createRunner: CreateRunner, xDaytonaOrganizationID?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateRunnerResponse>>;
+    /**
+     *
+     * @summary Delete runner
+     * @param {string} id Runner ID
+     * @param {string} [xDaytonaOrganizationID] Use with JWT to specify the organization ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteRunner(id: string, xDaytonaOrganizationID?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    /**
+     *
+     * @summary Get info for authenticated runner
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getInfoForAuthenticatedRunner(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RunnerFull>>;
+    /**
+     *
+     * @summary Get runner by ID
+     * @param {string} id Runner ID
+     * @param {string} [xDaytonaOrganizationID] Use with JWT to specify the organization ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getRunnerById(id: string, xDaytonaOrganizationID?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Runner>>;
+    /**
+     *
+     * @summary Get runner by sandbox ID
+     * @param {string} sandboxId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getRunnerBySandboxId(sandboxId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RunnerFull>>;
+    /**
+     *
+     * @summary Get runner by ID
+     * @param {string} id Runner ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getRunnerFullById(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RunnerFull>>;
+    /**
+     *
+     * @summary Get runners by snapshot ref
+     * @param {string} ref Snapshot ref
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getRunnersBySnapshotRef(ref: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<RunnerSnapshotDto>>>;
+    /**
+     *
+     * @summary List all runners
+     * @param {string} [xDaytonaOrganizationID] Use with JWT to specify the organization ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listRunners(xDaytonaOrganizationID?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Runner>>>;
+    /**
+     * Endpoint for version 2 runners to send healthcheck and metrics. Updates lastChecked timestamp and runner metrics.
+     * @summary Runner healthcheck
+     * @param {RunnerHealthcheck} runnerHealthcheck
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    runnerHealthcheck(runnerHealthcheck: RunnerHealthcheck, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    /**
+     *
+     * @summary Update runner draining status
+     * @param {string} id Runner ID
+     * @param {string} [xDaytonaOrganizationID] Use with JWT to specify the organization ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateRunnerDraining(id: string, xDaytonaOrganizationID?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Runner>>;
+    /**
+     *
+     * @summary Update runner scheduling status
+     * @param {string} id Runner ID
+     * @param {string} [xDaytonaOrganizationID] Use with JWT to specify the organization ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateRunnerScheduling(id: string, xDaytonaOrganizationID?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Runner>>;
+};
+/**
+ * RunnersApi - factory interface
+ * @export
+ */
+export declare const RunnersApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     *
+     * @summary Create runner
+     * @param {CreateRunner} createRunner
+     * @param {string} [xDaytonaOrganizationID] Use with JWT to specify the organization ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createRunner(createRunner: CreateRunner, xDaytonaOrganizationID?: string, options?: RawAxiosRequestConfig): AxiosPromise<CreateRunnerResponse>;
+    /**
+     *
+     * @summary Delete runner
+     * @param {string} id Runner ID
+     * @param {string} [xDaytonaOrganizationID] Use with JWT to specify the organization ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteRunner(id: string, xDaytonaOrganizationID?: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
+    /**
+     *
+     * @summary Get info for authenticated runner
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getInfoForAuthenticatedRunner(options?: RawAxiosRequestConfig): AxiosPromise<RunnerFull>;
+    /**
+     *
+     * @summary Get runner by ID
+     * @param {string} id Runner ID
+     * @param {string} [xDaytonaOrganizationID] Use with JWT to specify the organization ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getRunnerById(id: string, xDaytonaOrganizationID?: string, options?: RawAxiosRequestConfig): AxiosPromise<Runner>;
+    /**
+     *
+     * @summary Get runner by sandbox ID
+     * @param {string} sandboxId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getRunnerBySandboxId(sandboxId: string, options?: RawAxiosRequestConfig): AxiosPromise<RunnerFull>;
+    /**
+     *
+     * @summary Get runner by ID
+     * @param {string} id Runner ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getRunnerFullById(id: string, options?: RawAxiosRequestConfig): AxiosPromise<RunnerFull>;
+    /**
+     *
+     * @summary Get runners by snapshot ref
+     * @param {string} ref Snapshot ref
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getRunnersBySnapshotRef(ref: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<RunnerSnapshotDto>>;
+    /**
+     *
+     * @summary List all runners
+     * @param {string} [xDaytonaOrganizationID] Use with JWT to specify the organization ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listRunners(xDaytonaOrganizationID?: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<Runner>>;
+    /**
+     * Endpoint for version 2 runners to send healthcheck and metrics. Updates lastChecked timestamp and runner metrics.
+     * @summary Runner healthcheck
+     * @param {RunnerHealthcheck} runnerHealthcheck
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    runnerHealthcheck(runnerHealthcheck: RunnerHealthcheck, options?: RawAxiosRequestConfig): AxiosPromise<void>;
+    /**
+     *
+     * @summary Update runner draining status
+     * @param {string} id Runner ID
+     * @param {string} [xDaytonaOrganizationID] Use with JWT to specify the organization ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateRunnerDraining(id: string, xDaytonaOrganizationID?: string, options?: RawAxiosRequestConfig): AxiosPromise<Runner>;
+    /**
+     *
+     * @summary Update runner scheduling status
+     * @param {string} id Runner ID
+     * @param {string} [xDaytonaOrganizationID] Use with JWT to specify the organization ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateRunnerScheduling(id: string, xDaytonaOrganizationID?: string, options?: RawAxiosRequestConfig): AxiosPromise<Runner>;
+};
+/**
+ * RunnersApi - object-oriented interface
+ * @export
+ * @class RunnersApi
+ * @extends {BaseAPI}
+ */
+export declare class RunnersApi extends BaseAPI {
+    /**
+     *
+     * @summary Create runner
+     * @param {CreateRunner} createRunner
+     * @param {string} [xDaytonaOrganizationID] Use with JWT to specify the organization ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof RunnersApi
+     */
+    createRunner(createRunner: CreateRunner, xDaytonaOrganizationID?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateRunnerResponse, any, {}>>;
+    /**
+     *
+     * @summary Delete runner
+     * @param {string} id Runner ID
+     * @param {string} [xDaytonaOrganizationID] Use with JWT to specify the organization ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof RunnersApi
+     */
+    deleteRunner(id: string, xDaytonaOrganizationID?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
+    /**
+     *
+     * @summary Get info for authenticated runner
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof RunnersApi
+     */
+    getInfoForAuthenticatedRunner(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<RunnerFull, any, {}>>;
+    /**
+     *
+     * @summary Get runner by ID
+     * @param {string} id Runner ID
+     * @param {string} [xDaytonaOrganizationID] Use with JWT to specify the organization ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof RunnersApi
+     */
+    getRunnerById(id: string, xDaytonaOrganizationID?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Runner, any, {}>>;
+    /**
+     *
+     * @summary Get runner by sandbox ID
+     * @param {string} sandboxId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof RunnersApi
+     */
+    getRunnerBySandboxId(sandboxId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<RunnerFull, any, {}>>;
+    /**
+     *
+     * @summary Get runner by ID
+     * @param {string} id Runner ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof RunnersApi
+     */
+    getRunnerFullById(id: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<RunnerFull, any, {}>>;
+    /**
+     *
+     * @summary Get runners by snapshot ref
+     * @param {string} ref Snapshot ref
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof RunnersApi
+     */
+    getRunnersBySnapshotRef(ref: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<RunnerSnapshotDto[], any, {}>>;
+    /**
+     *
+     * @summary List all runners
+     * @param {string} [xDaytonaOrganizationID] Use with JWT to specify the organization ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof RunnersApi
+     */
+    listRunners(xDaytonaOrganizationID?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Runner[], any, {}>>;
+    /**
+     * Endpoint for version 2 runners to send healthcheck and metrics. Updates lastChecked timestamp and runner metrics.
+     * @summary Runner healthcheck
+     * @param {RunnerHealthcheck} runnerHealthcheck
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof RunnersApi
+     */
+    runnerHealthcheck(runnerHealthcheck: RunnerHealthcheck, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
+    /**
+     *
+     * @summary Update runner draining status
+     * @param {string} id Runner ID
+     * @param {string} [xDaytonaOrganizationID] Use with JWT to specify the organization ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof RunnersApi
+     */
+    updateRunnerDraining(id: string, xDaytonaOrganizationID?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Runner, any, {}>>;
+    /**
+     *
+     * @summary Update runner scheduling status
+     * @param {string} id Runner ID
+     * @param {string} [xDaytonaOrganizationID] Use with JWT to specify the organization ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof RunnersApi
+     */
+    updateRunnerScheduling(id: string, xDaytonaOrganizationID?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Runner, any, {}>>;
+}