@daytonaio/api-client 0.108.0-rc1 → 0.108.1-rc.1

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

@@ -13,7 +13,9 @@ import type { Configuration } from '../configuration';
 import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
 import { type RequestArgs, BaseAPI } from '../base';
 import type { CreateSandbox } from '../models';
+import type { PaginatedSandboxes } from '../models';
 import type { PortPreviewUrl } from '../models';
+import type { Region } from '../models';
 import type { Sandbox } from '../models';
 import type { SandboxLabels } from '../models';
 import type { SshAccessDto } from '../models';
@@ -65,12 +67,11 @@ export declare const SandboxApiAxiosParamCreator: (configuration?: Configuration
      *
      * @summary Delete sandbox
      * @param {string} sandboxId ID of the sandbox
-     * @param {boolean} force
      * @param {string} [xDaytonaOrganizationID] Use with JWT to specify the organization ID
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    deleteSandbox: (sandboxId: string, force: boolean, xDaytonaOrganizationID?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    deleteSandbox: (sandboxId: string, xDaytonaOrganizationID?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      *
      * @summary Get build logs
@@ -101,6 +102,14 @@ export declare const SandboxApiAxiosParamCreator: (configuration?: Configuration
      * @throws {RequiredError}
      */
     getSandbox: (sandboxId: string, xDaytonaOrganizationID?: string, verbose?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary List all regions where sandboxes have been created
+     * @param {string} [xDaytonaOrganizationID] Use with JWT to specify the organization ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getSandboxRegions: (xDaytonaOrganizationID?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      *
      * @summary Get sandboxes for the authenticated runner
@@ -122,6 +131,32 @@ export declare const SandboxApiAxiosParamCreator: (configuration?: Configuration
      * @throws {RequiredError}
      */
     listSandboxes: (xDaytonaOrganizationID?: string, verbose?: boolean, labels?: string, includeErroredDeleted?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary List all sandboxes paginated
+     * @param {string} [xDaytonaOrganizationID] Use with JWT to specify the organization ID
+     * @param {number} [page] Page number of the results
+     * @param {number} [limit] Number of results per page
+     * @param {string} [id] Filter by partial ID match
+     * @param {string} [labels] JSON encoded labels to filter by
+     * @param {boolean} [includeErroredDeleted] Include results with errored state and deleted desired state
+     * @param {Array<ListSandboxesPaginatedStatesEnum>} [states] List of states to filter by
+     * @param {Array<string>} [snapshots] List of snapshot names to filter by
+     * @param {Array<string>} [regions] List of regions to filter by
+     * @param {number} [minCpu] Minimum CPU
+     * @param {number} [maxCpu] Maximum CPU
+     * @param {number} [minMemoryGiB] Minimum memory in GiB
+     * @param {number} [maxMemoryGiB] Maximum memory in GiB
+     * @param {number} [minDiskGiB] Minimum disk space in GiB
+     * @param {number} [maxDiskGiB] Maximum disk space in GiB
+     * @param {Date} [lastEventAfter] Include items with last event after this timestamp
+     * @param {Date} [lastEventBefore] Include items with last event before this timestamp
+     * @param {ListSandboxesPaginatedSortEnum} [sort] Field to sort by
+     * @param {ListSandboxesPaginatedOrderEnum} [order] Direction to sort by
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listSandboxesPaginated: (xDaytonaOrganizationID?: string, page?: number, limit?: number, id?: string, labels?: string, includeErroredDeleted?: boolean, states?: Array<ListSandboxesPaginatedStatesEnum>, snapshots?: Array<string>, regions?: Array<string>, minCpu?: number, maxCpu?: number, minMemoryGiB?: number, maxMemoryGiB?: number, minDiskGiB?: number, maxDiskGiB?: number, lastEventAfter?: Date, lastEventBefore?: Date, sort?: ListSandboxesPaginatedSortEnum, order?: ListSandboxesPaginatedOrderEnum, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      *
      * @summary Replace sandbox labels
@@ -266,12 +301,11 @@ export declare const SandboxApiFp: (configuration?: Configuration) => {
      *
      * @summary Delete sandbox
      * @param {string} sandboxId ID of the sandbox
-     * @param {boolean} force
      * @param {string} [xDaytonaOrganizationID] Use with JWT to specify the organization ID
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    deleteSandbox(sandboxId: string, force: boolean, xDaytonaOrganizationID?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    deleteSandbox(sandboxId: string, xDaytonaOrganizationID?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
     /**
      *
      * @summary Get build logs
@@ -302,6 +336,14 @@ export declare const SandboxApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     getSandbox(sandboxId: string, xDaytonaOrganizationID?: string, verbose?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Sandbox>>;
+    /**
+     *
+     * @summary List all regions where sandboxes have been created
+     * @param {string} [xDaytonaOrganizationID] Use with JWT to specify the organization ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getSandboxRegions(xDaytonaOrganizationID?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Region>>>;
     /**
      *
      * @summary Get sandboxes for the authenticated runner
@@ -323,6 +365,32 @@ export declare const SandboxApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     listSandboxes(xDaytonaOrganizationID?: string, verbose?: boolean, labels?: string, includeErroredDeleted?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Sandbox>>>;
+    /**
+     *
+     * @summary List all sandboxes paginated
+     * @param {string} [xDaytonaOrganizationID] Use with JWT to specify the organization ID
+     * @param {number} [page] Page number of the results
+     * @param {number} [limit] Number of results per page
+     * @param {string} [id] Filter by partial ID match
+     * @param {string} [labels] JSON encoded labels to filter by
+     * @param {boolean} [includeErroredDeleted] Include results with errored state and deleted desired state
+     * @param {Array<ListSandboxesPaginatedStatesEnum>} [states] List of states to filter by
+     * @param {Array<string>} [snapshots] List of snapshot names to filter by
+     * @param {Array<string>} [regions] List of regions to filter by
+     * @param {number} [minCpu] Minimum CPU
+     * @param {number} [maxCpu] Maximum CPU
+     * @param {number} [minMemoryGiB] Minimum memory in GiB
+     * @param {number} [maxMemoryGiB] Maximum memory in GiB
+     * @param {number} [minDiskGiB] Minimum disk space in GiB
+     * @param {number} [maxDiskGiB] Maximum disk space in GiB
+     * @param {Date} [lastEventAfter] Include items with last event after this timestamp
+     * @param {Date} [lastEventBefore] Include items with last event before this timestamp
+     * @param {ListSandboxesPaginatedSortEnum} [sort] Field to sort by
+     * @param {ListSandboxesPaginatedOrderEnum} [order] Direction to sort by
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listSandboxesPaginated(xDaytonaOrganizationID?: string, page?: number, limit?: number, id?: string, labels?: string, includeErroredDeleted?: boolean, states?: Array<ListSandboxesPaginatedStatesEnum>, snapshots?: Array<string>, regions?: Array<string>, minCpu?: number, maxCpu?: number, minMemoryGiB?: number, maxMemoryGiB?: number, minDiskGiB?: number, maxDiskGiB?: number, lastEventAfter?: Date, lastEventBefore?: Date, sort?: ListSandboxesPaginatedSortEnum, order?: ListSandboxesPaginatedOrderEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaginatedSandboxes>>;
     /**
      *
      * @summary Replace sandbox labels
@@ -467,12 +535,11 @@ export declare const SandboxApiFactory: (configuration?: Configuration, basePath
      *
      * @summary Delete sandbox
      * @param {string} sandboxId ID of the sandbox
-     * @param {boolean} force
      * @param {string} [xDaytonaOrganizationID] Use with JWT to specify the organization ID
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    deleteSandbox(sandboxId: string, force: boolean, xDaytonaOrganizationID?: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
+    deleteSandbox(sandboxId: string, xDaytonaOrganizationID?: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
     /**
      *
      * @summary Get build logs
@@ -503,6 +570,14 @@ export declare const SandboxApiFactory: (configuration?: Configuration, basePath
      * @throws {RequiredError}
      */
     getSandbox(sandboxId: string, xDaytonaOrganizationID?: string, verbose?: boolean, options?: RawAxiosRequestConfig): AxiosPromise<Sandbox>;
+    /**
+     *
+     * @summary List all regions where sandboxes have been created
+     * @param {string} [xDaytonaOrganizationID] Use with JWT to specify the organization ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getSandboxRegions(xDaytonaOrganizationID?: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<Region>>;
     /**
      *
      * @summary Get sandboxes for the authenticated runner
@@ -524,6 +599,32 @@ export declare const SandboxApiFactory: (configuration?: Configuration, basePath
      * @throws {RequiredError}
      */
     listSandboxes(xDaytonaOrganizationID?: string, verbose?: boolean, labels?: string, includeErroredDeleted?: boolean, options?: RawAxiosRequestConfig): AxiosPromise<Array<Sandbox>>;
+    /**
+     *
+     * @summary List all sandboxes paginated
+     * @param {string} [xDaytonaOrganizationID] Use with JWT to specify the organization ID
+     * @param {number} [page] Page number of the results
+     * @param {number} [limit] Number of results per page
+     * @param {string} [id] Filter by partial ID match
+     * @param {string} [labels] JSON encoded labels to filter by
+     * @param {boolean} [includeErroredDeleted] Include results with errored state and deleted desired state
+     * @param {Array<ListSandboxesPaginatedStatesEnum>} [states] List of states to filter by
+     * @param {Array<string>} [snapshots] List of snapshot names to filter by
+     * @param {Array<string>} [regions] List of regions to filter by
+     * @param {number} [minCpu] Minimum CPU
+     * @param {number} [maxCpu] Maximum CPU
+     * @param {number} [minMemoryGiB] Minimum memory in GiB
+     * @param {number} [maxMemoryGiB] Maximum memory in GiB
+     * @param {number} [minDiskGiB] Minimum disk space in GiB
+     * @param {number} [maxDiskGiB] Maximum disk space in GiB
+     * @param {Date} [lastEventAfter] Include items with last event after this timestamp
+     * @param {Date} [lastEventBefore] Include items with last event before this timestamp
+     * @param {ListSandboxesPaginatedSortEnum} [sort] Field to sort by
+     * @param {ListSandboxesPaginatedOrderEnum} [order] Direction to sort by
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listSandboxesPaginated(xDaytonaOrganizationID?: string, page?: number, limit?: number, id?: string, labels?: string, includeErroredDeleted?: boolean, states?: Array<ListSandboxesPaginatedStatesEnum>, snapshots?: Array<string>, regions?: Array<string>, minCpu?: number, maxCpu?: number, minMemoryGiB?: number, maxMemoryGiB?: number, minDiskGiB?: number, maxDiskGiB?: number, lastEventAfter?: Date, lastEventBefore?: Date, sort?: ListSandboxesPaginatedSortEnum, order?: ListSandboxesPaginatedOrderEnum, options?: RawAxiosRequestConfig): AxiosPromise<PaginatedSandboxes>;
     /**
      *
      * @summary Replace sandbox labels
@@ -674,13 +775,12 @@ export declare class SandboxApi extends BaseAPI {
      *
      * @summary Delete sandbox
      * @param {string} sandboxId ID of the sandbox
-     * @param {boolean} force
      * @param {string} [xDaytonaOrganizationID] Use with JWT to specify the organization ID
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof SandboxApi
      */
-    deleteSandbox(sandboxId: string, force: boolean, xDaytonaOrganizationID?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
+    deleteSandbox(sandboxId: string, xDaytonaOrganizationID?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
     /**
      *
      * @summary Get build logs
@@ -714,6 +814,15 @@ export declare class SandboxApi extends BaseAPI {
      * @memberof SandboxApi
      */
     getSandbox(sandboxId: string, xDaytonaOrganizationID?: string, verbose?: boolean, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Sandbox, any, {}>>;
+    /**
+     *
+     * @summary List all regions where sandboxes have been created
+     * @param {string} [xDaytonaOrganizationID] Use with JWT to specify the organization ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SandboxApi
+     */
+    getSandboxRegions(xDaytonaOrganizationID?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Region[], any, {}>>;
     /**
      *
      * @summary Get sandboxes for the authenticated runner
@@ -737,6 +846,33 @@ export declare class SandboxApi extends BaseAPI {
      * @memberof SandboxApi
      */
     listSandboxes(xDaytonaOrganizationID?: string, verbose?: boolean, labels?: string, includeErroredDeleted?: boolean, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Sandbox[], any, {}>>;
+    /**
+     *
+     * @summary List all sandboxes paginated
+     * @param {string} [xDaytonaOrganizationID] Use with JWT to specify the organization ID
+     * @param {number} [page] Page number of the results
+     * @param {number} [limit] Number of results per page
+     * @param {string} [id] Filter by partial ID match
+     * @param {string} [labels] JSON encoded labels to filter by
+     * @param {boolean} [includeErroredDeleted] Include results with errored state and deleted desired state
+     * @param {Array<ListSandboxesPaginatedStatesEnum>} [states] List of states to filter by
+     * @param {Array<string>} [snapshots] List of snapshot names to filter by
+     * @param {Array<string>} [regions] List of regions to filter by
+     * @param {number} [minCpu] Minimum CPU
+     * @param {number} [maxCpu] Maximum CPU
+     * @param {number} [minMemoryGiB] Minimum memory in GiB
+     * @param {number} [maxMemoryGiB] Maximum memory in GiB
+     * @param {number} [minDiskGiB] Minimum disk space in GiB
+     * @param {number} [maxDiskGiB] Maximum disk space in GiB
+     * @param {Date} [lastEventAfter] Include items with last event after this timestamp
+     * @param {Date} [lastEventBefore] Include items with last event before this timestamp
+     * @param {ListSandboxesPaginatedSortEnum} [sort] Field to sort by
+     * @param {ListSandboxesPaginatedOrderEnum} [order] Direction to sort by
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SandboxApi
+     */
+    listSandboxesPaginated(xDaytonaOrganizationID?: string, page?: number, limit?: number, id?: string, labels?: string, includeErroredDeleted?: boolean, states?: Array<ListSandboxesPaginatedStatesEnum>, snapshots?: Array<string>, regions?: Array<string>, minCpu?: number, maxCpu?: number, minMemoryGiB?: number, maxMemoryGiB?: number, minDiskGiB?: number, maxDiskGiB?: number, lastEventAfter?: Date, lastEventBefore?: Date, sort?: ListSandboxesPaginatedSortEnum, order?: ListSandboxesPaginatedOrderEnum, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PaginatedSandboxes, any, {}>>;
     /**
      *
      * @summary Replace sandbox labels
@@ -845,3 +981,44 @@ export declare class SandboxApi extends BaseAPI {
      */
     validateSshAccess(token: string, xDaytonaOrganizationID?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<SshAccessValidationDto, any, {}>>;
 }
+/**
+ * @export
+ */
+export declare const ListSandboxesPaginatedStatesEnum: {
+    readonly CREATING: "creating";
+    readonly RESTORING: "restoring";
+    readonly DESTROYING: "destroying";
+    readonly STARTED: "started";
+    readonly STOPPED: "stopped";
+    readonly STARTING: "starting";
+    readonly STOPPING: "stopping";
+    readonly ERROR: "error";
+    readonly BUILD_FAILED: "build_failed";
+    readonly PENDING_BUILD: "pending_build";
+    readonly BUILDING_SNAPSHOT: "building_snapshot";
+    readonly UNKNOWN: "unknown";
+    readonly PULLING_SNAPSHOT: "pulling_snapshot";
+    readonly ARCHIVED: "archived";
+    readonly ARCHIVING: "archiving";
+};
+export type ListSandboxesPaginatedStatesEnum = (typeof ListSandboxesPaginatedStatesEnum)[keyof typeof ListSandboxesPaginatedStatesEnum];
+/**
+ * @export
+ */
+export declare const ListSandboxesPaginatedSortEnum: {
+    readonly ID: "id";
+    readonly STATE: "state";
+    readonly SNAPSHOT: "snapshot";
+    readonly REGION: "region";
+    readonly UPDATED_AT: "updatedAt";
+    readonly CREATED_AT: "createdAt";
+};
+export type ListSandboxesPaginatedSortEnum = (typeof ListSandboxesPaginatedSortEnum)[keyof typeof ListSandboxesPaginatedSortEnum];
+/**
+ * @export
+ */
+export declare const ListSandboxesPaginatedOrderEnum: {
+    readonly ASC: "asc";
+    readonly DESC: "desc";
+};
+export type ListSandboxesPaginatedOrderEnum = (typeof ListSandboxesPaginatedOrderEnum)[keyof typeof ListSandboxesPaginatedOrderEnum];