@daytonaio/api-client 0.130.0 → 0.131.0-alpha.1

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

@@ -13,7 +13,10 @@ 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
@@ -24,10 +27,20 @@ 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, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    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
@@ -35,6 +48,15 @@ export declare const RunnersApiAxiosParamCreator: (configuration?: Configuration
      * @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
@@ -54,18 +76,28 @@ export declare const RunnersApiAxiosParamCreator: (configuration?: Configuration
     /**
      *
      * @summary List all runners
+     * @param {string} [xDaytonaOrganizationID] Use with JWT to specify the organization ID
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    listRunners: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    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 scheduling status
-     * @param {string} 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}
      */
-    updateRunnerScheduling: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    updateRunnerScheduling: (id: string, xDaytonaOrganizationID?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
 };
 /**
  * RunnersApi - functional programming interface
@@ -76,17 +108,36 @@ 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}
      */
-    createRunner(createRunner: CreateRunner, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    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<Runner>>;
+    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
@@ -94,7 +145,7 @@ export declare const RunnersApiFp: (configuration?: Configuration) => {
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getRunnerBySandboxId(sandboxId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Runner>>;
+    getRunnerBySandboxId(sandboxId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RunnerFull>>;
     /**
      *
      * @summary Get runners by snapshot ref
@@ -106,18 +157,28 @@ export declare const RunnersApiFp: (configuration?: Configuration) => {
     /**
      *
      * @summary List all runners
+     * @param {string} [xDaytonaOrganizationID] Use with JWT to specify the organization ID
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    listRunners(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    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 scheduling status
-     * @param {string} 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}
      */
-    updateRunnerScheduling(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    updateRunnerScheduling(id: string, xDaytonaOrganizationID?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Runner>>;
 };
 /**
  * RunnersApi - factory interface
@@ -128,17 +189,36 @@ export declare const RunnersApiFactory: (configuration?: Configuration, basePath
      *
      * @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, options?: RawAxiosRequestConfig): AxiosPromise<void>;
+    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<Runner>;
+    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
@@ -146,7 +226,7 @@ export declare const RunnersApiFactory: (configuration?: Configuration, basePath
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getRunnerBySandboxId(sandboxId: string, options?: RawAxiosRequestConfig): AxiosPromise<Runner>;
+    getRunnerBySandboxId(sandboxId: string, options?: RawAxiosRequestConfig): AxiosPromise<RunnerFull>;
     /**
      *
      * @summary Get runners by snapshot ref
@@ -158,18 +238,28 @@ export declare const RunnersApiFactory: (configuration?: Configuration, basePath
     /**
      *
      * @summary List all runners
+     * @param {string} [xDaytonaOrganizationID] Use with JWT to specify the organization ID
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    listRunners(options?: RawAxiosRequestConfig): AxiosPromise<void>;
+    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 scheduling status
-     * @param {string} 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}
      */
-    updateRunnerScheduling(id: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
+    updateRunnerScheduling(id: string, xDaytonaOrganizationID?: string, options?: RawAxiosRequestConfig): AxiosPromise<Runner>;
 };
 /**
  * RunnersApi - object-oriented interface
@@ -182,11 +272,22 @@ 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, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
+    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
@@ -194,7 +295,17 @@ export declare class RunnersApi extends BaseAPI {
      * @throws {RequiredError}
      * @memberof RunnersApi
      */
-    getInfoForAuthenticatedRunner(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Runner, any>>;
+    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
@@ -203,7 +314,7 @@ export declare class RunnersApi extends BaseAPI {
      * @throws {RequiredError}
      * @memberof RunnersApi
      */
-    getRunnerBySandboxId(sandboxId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Runner, any>>;
+    getRunnerBySandboxId(sandboxId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<RunnerFull, any>>;
     /**
      *
      * @summary Get runners by snapshot ref
@@ -216,18 +327,29 @@ export declare class RunnersApi extends BaseAPI {
     /**
      *
      * @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
      */
-    listRunners(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
+    runnerHealthcheck(runnerHealthcheck: RunnerHealthcheck, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
     /**
      *
      * @summary Update runner scheduling status
-     * @param {string} 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
      */
-    updateRunnerScheduling(id: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
+    updateRunnerScheduling(id: string, xDaytonaOrganizationID?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Runner, any>>;
 }