import type { Client, Options as Options2, TDataShape } from './client'; import type { MetaInfoData, MetaInfoResponses, PreviewHostCreateData, PreviewHostCreateResponses, PreviewHostListData, PreviewHostListResponses, PreviewHostUpdateData, PreviewHostUpdateResponses, PreviewTokenCreateData, PreviewTokenCreateResponses, PreviewTokenListData, PreviewTokenListResponses, PreviewTokenRevokeAllData, PreviewTokenRevokeAllResponses, PreviewTokenUpdateData, PreviewTokenUpdateResponses, SandboxCreateData, SandboxCreateResponses, SandboxForkData, SandboxForkResponses, SandboxGetData, SandboxGetResponses, SandboxListData, SandboxListResponses, TemplatesCreateData, TemplatesCreateResponses, TokenCreateData, TokenCreateResponses, TokenUpdateData, TokenUpdateResponses, VmAssignTagAliasData, VmAssignTagAliasResponses, VmCreateSessionData, VmCreateSessionResponses, VmCreateTagData, VmCreateTagResponses, VmDeleteData, VmDeleteResponses, VmHibernateData, VmHibernateResponses, VmListClustersData, VmListClustersResponses, VmListRunningVmsData, VmListRunningVmsResponses, VmShutdownData, VmShutdownResponses, VmStartData, VmStartResponses, VmUpdateHibernationTimeoutData, VmUpdateHibernationTimeoutResponses, VmUpdateSpecs2Data, VmUpdateSpecs2Responses, VmUpdateSpecsData, VmUpdateSpecsResponses, WorkspaceCreateData, WorkspaceCreateResponses } from './types.gen'; export type Options = Options2 & { /** * You can provide a client instance returned by `createClient()` instead of * individual options. This might be also useful if you want to implement a * custom client. */ client?: Client; /** * You can pass arbitrary values through the `meta` object. This can be * used to access values that aren't defined as part of the SDK function. */ meta?: Record; }; /** * Metadata about the API */ export declare const metaInfo: (options?: Options) => import("./client").RequestResult; /** * Create a Workspace * Create a new, empty, workspace in the current organization * */ export declare const workspaceCreate: (options?: Options) => import("./client").RequestResult; /** * Create an API Token * Create a new API token for a workspace that is part of the current organization. * */ export declare const tokenCreate: (options: Options) => import("./client").RequestResult; /** * Update an API Token * Update an API token for a workspace that is part of the current organization. * */ export declare const tokenUpdate: (options: Options) => import("./client").RequestResult; /** * List Sandboxes * List sandboxes from the current workspace with optional filters. * Results are limited to a maximum of 50 sandboxes per request. * */ export declare const sandboxList: (options?: Options) => import("./client").RequestResult; /** * Create a Sandbox * Create a new sandbox in the current workspace with file contents * */ export declare const sandboxCreate: (options?: Options) => import("./client").RequestResult; /** * Get a Sandbox * Retrieve a sandbox by its ID * */ export declare const sandboxGet: (options: Options) => import("./client").RequestResult; /** * Fork a Sandbox * Fork an existing sandbox to the current workspace * */ export declare const sandboxFork: (options: Options) => import("./client").RequestResult; /** * Revoke preview tokens * Immediately expires all active preview tokens associated with this sandbox * */ export declare const previewTokenRevokeAll: (options: Options) => import("./client").RequestResult; /** * List Preview Tokens * List information about the preview tokens associated with the current sandbox * */ export declare const previewTokenList: (options: Options) => import("./client").RequestResult; /** * Create a Preview Token * Create a new Preview token that allow access to a private sandbox * */ export declare const previewTokenCreate: (options: Options) => import("./client").RequestResult; /** * Update a Preview Token * Update a Preview token that allow access to a private sandbox * */ export declare const previewTokenUpdate: (options: Options) => import("./client").RequestResult; /** * Create a template * Create a new template in the current workspace (creates 3 sandboxes and tags them) * */ export declare const templatesCreate: (options?: Options) => import("./client").RequestResult; /** * Assign a tag alias to a VM tag * Assign a tag alias to a VM tag. * */ export declare const vmAssignTagAlias: (options: Options) => import("./client").RequestResult; /** * List all available clusters * List all available clusters. * */ export declare const vmListClusters: (options?: Options) => import("./client").RequestResult; /** * List information about currently running VMs * List information about currently running VMs. This information is updated roughly every 30 seconds, so this data is not guaranteed to be perfectly up-to-date. * */ export declare const vmListRunningVms: (options?: Options) => import("./client").RequestResult; /** * Create a new tag for a VM * Creates a new tag for a VM. * */ export declare const vmCreateTag: (options?: Options) => import("./client").RequestResult; /** * Delete a VM * Deletes a VM, permanently removing it from the system. * * This endpoint can only be used on VMs that belong to your team's workspace. * Deleting a VM is irreversible and will permanently delete all data associated with it. * */ export declare const vmDelete: (options: Options) => import("./client").RequestResult; /** * Hibernate a VM * Suspends a running VM, saving a snapshot of its memory and running processes * * This endpoint may take an extended amount of time to return (30 seconds). If the VM is not * currently running, it will return an error (404). * * Unless later shut down by request or due to inactivity, a hibernated VM can be resumed with * minimal latency. * */ export declare const vmHibernate: (options: Options) => import("./client").RequestResult; /** * Update VM Hibernation Timeout * Updates the hibernation timeout of a running VM. * * This endpoint can only be used on VMs that belong to your team's workspace. * The new timeout must be greater than 0 and less than or equal to 86400 seconds (24 hours). * */ export declare const vmUpdateHibernationTimeout: (options: Options) => import("./client").RequestResult; /** * Create a new session on a VM * Creates a new session on a running VM. A session represents an isolated Linux user, with their own container. * A session has a single use token that the user can use to connect to the VM. This token has specific permissions (currently, read or write). * The session is identified by a unique session ID, and the Linux username is based on the session ID. * * The Git user name and email can be configured via parameters. * * This endpoint requires the VM to be running. If the VM is not running, it will return a 404 error. * */ export declare const vmCreateSession: (options: Options) => import("./client").RequestResult; /** * Shutdown a VM * Stops a running VM, ending all currently running processes * * This endpoint may take an extended amount of time to return (30 seconds). If the VM is not * currently running, it will return an error (404). * * Shutdown VMs require additional time to start up. * */ export declare const vmShutdown: (options: Options) => import("./client").RequestResult; /** * Update VM Specs * Updates the specifications (CPU, memory, storage) of a running VM. * * This endpoint can only be used on VMs that belong to your team's workspace. * The new tier must not exceed your team's maximum allowed tier. * */ export declare const vmUpdateSpecs: (options: Options) => import("./client").RequestResult; /** * Start a VM * Start a virtual machine for the sandbox (devbox) with the given ID * * While the `sandbox:read` scope is required for this endpoint, the resulting VM will have * permissions according to the `sandbox:edit_code` scope. If present, the returned token will * have write permissions to the contents of the VM. Otherwise, the returned token will grant * only read-only permissions. * * This endpoint is subject to special rate limits related to concurrent VM usage. * */ export declare const vmStart: (options: Options) => import("./client").RequestResult; /** * Update VM Specs * Updates the specifications (CPU, memory, storage) of a running VM. * * This endpoint can only be used on VMs that belong to your team's workspace. * The new tier must not exceed your team's maximum allowed tier. * */ export declare const vmUpdateSpecs2: (options: Options) => import("./client").RequestResult; /** * List Preview Hosts * List all trusted preview hosts for the current team * */ export declare const previewHostList: (options?: Options) => import("./client").RequestResult; /** * Create Preview Hosts * Add one or more trusted domains that are allowed to access sandbox previews for this workspace. * */ export declare const previewHostCreate: (options?: Options) => import("./client").RequestResult; /** * Update Preview Hosts * Replace the list of trusted domains that are allowed to access sandbox previews for this workspace. * */ export declare const previewHostUpdate: (options?: Options) => import("./client").RequestResult;