cyberdesk 2.1.15 → 2.1.17

package/README.md

@@ -46,6 +46,37 @@ if (status === 'success') {
 }
 ```
 
+## Desktop Parameters
+
+Configure machine-specific values that automatically populate workflows running on specific desktops:
+
+```typescript
+import { createCyberdeskClient } from 'cyberdesk';
+
+const client = createCyberdeskClient('your-api-key');
+
+// Set desktop parameters for a machine
+await client.machines.update('machine-id', {
+  machine_parameters: {
+    username: 'machine_specific_user',
+    api_url: 'https://api-region-east.example.com',
+    config_path: 'C:\\MachineA\\config.json'
+  },
+  machine_sensitive_parameters: {
+    password: 'actual_secret_value',  // Stored securely in Basis Theory
+    api_key: 'actual_api_key_123'
+  }
+});
+```
+
+Use in workflows with standard syntax:
+```
+Log in to {api_url} using {username} and password {$password}.
+Then open the config at {config_path}.
+```
+
+Desktop parameters automatically override run-level inputs and persist across runs. See the [Desktop Parameters docs](https://docs.cyberdesk.io/concepts/desktop-parameters) for more details.
+
 ## Full Documentation
 
 For complete documentation including advanced usage, error handling, and all available methods, visit:
@@ -111,6 +142,28 @@ const machines: { data?: PaginatedResponseMachineResponse } =
   await client.machines.list();
 ```
 
+## Testing
+
+```bash
+# Install dependencies
+npm install
+
+# Set up environment
+cp .env.example .env
+# Edit with your credentials
+
+# Run all tests
+npm test
+
+# Run only webhook tests
+npm run test:webhooks
+
+# Run only integration tests (real API calls)
+npm run test:integration
+```
+
+See [tests/README.md](./tests/README.md) for details.
+
 ## License
 
 MIT 

package/dist/client/sdk.gen.d.ts

@@ -1,5 +1,5 @@
 import type { Options as ClientOptions, TDataShape, Client } from '@hey-api/client-fetch';
-import type { HealthCheckV1HealthGetData, DatabaseHealthCheckV1HealthDbGetData, ListMachinesV1MachinesGetData, CreateMachineV1MachinesPostData, DeleteMachineV1MachinesMachineIdDeleteData, GetMachineV1MachinesMachineIdGetData, UpdateMachineV1MachinesMachineIdPatchData, GetMachinePoolsV1MachinesMachineIdPoolsGetData, UpdateMachinePoolsV1MachinesMachineIdPoolsPutData, ListPoolsV1PoolsGetData, CreatePoolV1PoolsPostData, DeletePoolV1PoolsPoolIdDeleteData, GetPoolV1PoolsPoolIdGetData, UpdatePoolV1PoolsPoolIdPatchData, RemoveMachinesFromPoolV1PoolsPoolIdMachinesDeleteData, AddMachinesToPoolV1PoolsPoolIdMachinesPostData, ListWorkflowsV1WorkflowsGetData, CreateWorkflowV1WorkflowsPostData, DeleteWorkflowV1WorkflowsWorkflowIdDeleteData, GetWorkflowV1WorkflowsWorkflowIdGetData, UpdateWorkflowV1WorkflowsWorkflowIdPatchData, GetWorkflowVersionsV1WorkflowsWorkflowIdVersionsGetData, ListRunsV1RunsGetData, CreateRunV1RunsPostData, DeleteRunV1RunsRunIdDeleteData, GetRunV1RunsRunIdGetData, UpdateRunV1RunsRunIdPatchData, CreateRunChainV1RunsChainPostData, BulkCreateRunsV1RunsBulkPostData, RetryRunV1RunsRunIdRetryPostData, ListRunAttachmentsV1RunAttachmentsGetData, CreateRunAttachmentV1RunAttachmentsPostData, DeleteRunAttachmentV1RunAttachmentsAttachmentIdDeleteData, GetRunAttachmentV1RunAttachmentsAttachmentIdGetData, UpdateRunAttachmentV1RunAttachmentsAttachmentIdPutData, GetRunAttachmentDownloadUrlV1RunAttachmentsAttachmentIdDownloadUrlGetData, DownloadRunAttachmentV1RunAttachmentsAttachmentIdDownloadGetData, ListConnectionsV1ConnectionsGetData, CreateConnectionV1ConnectionsPostData, DeleteConnectionV1ConnectionsConnectionIdDeleteData, GetConnectionV1ConnectionsConnectionIdGetData, UpdateConnectionV1ConnectionsConnectionIdPatchData, ListRequestLogsV1RequestLogsGetData, CreateRequestLogV1RequestLogsPostData, DeleteRequestLogV1RequestLogsLogIdDeleteData, GetRequestLogV1RequestLogsLogIdGetData, UpdateRequestLogV1RequestLogsLogIdPatchData, ListTrajectoriesV1TrajectoriesGetData, CreateTrajectoryV1TrajectoriesPostData, DeleteTrajectoryV1TrajectoriesTrajectoryIdDeleteData, GetTrajectoryV1TrajectoriesTrajectoryIdGetData, UpdateTrajectoryV1TrajectoriesTrajectoryIdPatchData, GetLatestTrajectoryForWorkflowV1WorkflowsWorkflowIdLatestTrajectoryGetData, GetScreenshotV1ComputerMachineIdDisplayScreenshotGetData, GetDisplayDimensionsV1ComputerMachineIdDisplayDimensionsGetData, KeyboardTypeV1ComputerMachineIdInputKeyboardTypePostData, KeyboardKeyV1ComputerMachineIdInputKeyboardKeyPostData, GetMousePositionV1ComputerMachineIdInputMousePositionGetData, MouseMoveV1ComputerMachineIdInputMouseMovePostData, MouseClickV1ComputerMachineIdInputMouseClickPostData, MouseScrollV1ComputerMachineIdInputMouseScrollPostData, MouseDragV1ComputerMachineIdInputMouseDragPostData, FsListV1ComputerMachineIdFsListGetData, FsReadV1ComputerMachineIdFsReadGetData, FsWriteV1ComputerMachineIdFsWritePostData, PowershellExecV1ComputerMachineIdShellPowershellExecPostData, PowershellSessionV1ComputerMachineIdShellPowershellSessionPostData, DummyTestEndpointV1TestPostData, RootGetData, HealthHealthGetData, HealthDbHealthDbGetData } from './types.gen';
+import type { HealthCheckV1HealthGetData, DatabaseHealthCheckV1HealthDbGetData, ListMachinesV1MachinesGetData, CreateMachineV1MachinesPostData, DeleteMachineV1MachinesMachineIdDeleteData, GetMachineV1MachinesMachineIdGetData, UpdateMachineV1MachinesMachineIdPatchData, GetMachinePoolsV1MachinesMachineIdPoolsGetData, UpdateMachinePoolsV1MachinesMachineIdPoolsPutData, ListPoolsV1PoolsGetData, CreatePoolV1PoolsPostData, DeletePoolV1PoolsPoolIdDeleteData, GetPoolV1PoolsPoolIdGetData, UpdatePoolV1PoolsPoolIdPatchData, RemoveMachinesFromPoolV1PoolsPoolIdMachinesDeleteData, AddMachinesToPoolV1PoolsPoolIdMachinesPostData, ListWorkflowsV1WorkflowsGetData, CreateWorkflowV1WorkflowsPostData, DeleteWorkflowV1WorkflowsWorkflowIdDeleteData, GetWorkflowV1WorkflowsWorkflowIdGetData, UpdateWorkflowV1WorkflowsWorkflowIdPatchData, GetWorkflowVersionsV1WorkflowsWorkflowIdVersionsGetData, ListRunsV1RunsGetData, CreateRunV1RunsPostData, DeleteRunV1RunsRunIdDeleteData, GetRunV1RunsRunIdGetData, UpdateRunV1RunsRunIdPatchData, CreateRunChainV1RunsChainPostData, BulkCreateRunsV1RunsBulkPostData, RetryRunV1RunsRunIdRetryPostData, ListRunAttachmentsV1RunAttachmentsGetData, CreateRunAttachmentV1RunAttachmentsPostData, DeleteRunAttachmentV1RunAttachmentsAttachmentIdDeleteData, GetRunAttachmentV1RunAttachmentsAttachmentIdGetData, UpdateRunAttachmentV1RunAttachmentsAttachmentIdPutData, GetRunAttachmentDownloadUrlV1RunAttachmentsAttachmentIdDownloadUrlGetData, DownloadRunAttachmentV1RunAttachmentsAttachmentIdDownloadGetData, ListConnectionsV1ConnectionsGetData, CreateConnectionV1ConnectionsPostData, DeleteConnectionV1ConnectionsConnectionIdDeleteData, GetConnectionV1ConnectionsConnectionIdGetData, UpdateConnectionV1ConnectionsConnectionIdPatchData, ListRequestLogsV1RequestLogsGetData, CreateRequestLogV1RequestLogsPostData, DeleteRequestLogV1RequestLogsLogIdDeleteData, GetRequestLogV1RequestLogsLogIdGetData, UpdateRequestLogV1RequestLogsLogIdPatchData, ListTrajectoriesV1TrajectoriesGetData, CreateTrajectoryV1TrajectoriesPostData, DeleteTrajectoryV1TrajectoriesTrajectoryIdDeleteData, GetTrajectoryV1TrajectoriesTrajectoryIdGetData, UpdateTrajectoryV1TrajectoriesTrajectoryIdPatchData, GetLatestTrajectoryForWorkflowV1WorkflowsWorkflowIdLatestTrajectoryGetData, GetScreenshotV1ComputerMachineIdDisplayScreenshotGetData, GetDisplayDimensionsV1ComputerMachineIdDisplayDimensionsGetData, KeyboardTypeV1ComputerMachineIdInputKeyboardTypePostData, KeyboardKeyV1ComputerMachineIdInputKeyboardKeyPostData, CopyToClipboardV1ComputerMachineIdCopyToClipboardPostData, GetMousePositionV1ComputerMachineIdInputMousePositionGetData, MouseMoveV1ComputerMachineIdInputMouseMovePostData, MouseClickV1ComputerMachineIdInputMouseClickPostData, MouseScrollV1ComputerMachineIdInputMouseScrollPostData, MouseDragV1ComputerMachineIdInputMouseDragPostData, FsListV1ComputerMachineIdFsListGetData, FsReadV1ComputerMachineIdFsReadGetData, FsWriteV1ComputerMachineIdFsWritePostData, PowershellExecV1ComputerMachineIdShellPowershellExecPostData, PowershellSessionV1ComputerMachineIdShellPowershellSessionPostData, DummyTestEndpointV1TestPostData, RootGetData, HealthHealthGetData, HealthDbHealthDbGetData } from './types.gen';
 export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean> = ClientOptions<TData, ThrowOnError> & {
     /**
      * You can provide a client instance returned by `createClient()` instead of
@@ -26,11 +26,9 @@ export declare const healthCheckV1HealthGet: <ThrowOnError extends boolean = fal
  * Database Health Check
  * Database health check endpoint.
  *
- * Verifies database connectivity without authentication.
+ * Verifies database connectivity and pool status without authentication.
  */
-export declare const databaseHealthCheckV1HealthDbGet: <ThrowOnError extends boolean = false>(options?: Options<DatabaseHealthCheckV1HealthDbGetData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<{
-    [key: string]: string;
-}, unknown, ThrowOnError>;
+export declare const databaseHealthCheckV1HealthDbGet: <ThrowOnError extends boolean = false>(options?: Options<DatabaseHealthCheckV1HealthDbGetData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<unknown, unknown, ThrowOnError>;
 /**
  * List Machines
  * List all machines for the authenticated organization.
@@ -49,7 +47,10 @@ export declare const createMachineV1MachinesPost: <ThrowOnError extends boolean
  * Delete Machine
  * Delete a machine.
  *
- * This will also delete all associated connections, request logs, and runs.
+ * Associated runs are PRESERVED with machine_id set to NULL.
+ * This ensures run history is never lost when a machine is deleted.
+ * Connections and request logs are cascade deleted.
+ *
  * The machine must belong to the authenticated organization.
  */
 export declare const deleteMachineV1MachinesMachineIdDelete: <ThrowOnError extends boolean = false>(options: Options<DeleteMachineV1MachinesMachineIdDeleteData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<void, import("./types.gen").HttpValidationError, ThrowOnError>;
@@ -66,6 +67,9 @@ export declare const getMachineV1MachinesMachineIdGet: <ThrowOnError extends boo
  *
  * Only the fields provided in the request body will be updated.
  * The machine must belong to the authenticated organization.
+ *
+ * For machine_sensitive_parameters: provide actual secret values and they will be
+ * stored in Basis Theory. Only aliases will be stored in the database.
  */
 export declare const updateMachineV1MachinesMachineIdPatch: <ThrowOnError extends boolean = false>(options: Options<UpdateMachineV1MachinesMachineIdPatchData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen").MachineResponse, import("./types.gen").HttpValidationError, ThrowOnError>;
 /**
@@ -432,6 +436,13 @@ export declare const keyboardTypeV1ComputerMachineIdInputKeyboardTypePost: <Thro
  * Send a key combination (e.g., 'ctrl+a', 'alt+tab'). Uses 'keys' field to match Piglet expectations.
  */
 export declare const keyboardKeyV1ComputerMachineIdInputKeyboardKeyPost: <ThrowOnError extends boolean = false>(options: Options<KeyboardKeyV1ComputerMachineIdInputKeyboardKeyPostData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<void, import("./types.gen").HttpValidationError, ThrowOnError>;
+/**
+ * Copy to clipboard via Ctrl+C
+ * Execute Ctrl+C and return clipboard contents with the specified key name.
+ */
+export declare const copyToClipboardV1ComputerMachineIdCopyToClipboardPost: <ThrowOnError extends boolean = false>(options: Options<CopyToClipboardV1ComputerMachineIdCopyToClipboardPostData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<{
+    [key: string]: unknown;
+}, import("./types.gen").HttpValidationError, ThrowOnError>;
 /**
  * Get mouse position
  * Get the current mouse cursor position.

package/dist/client/sdk.gen.js

@@ -2,7 +2,7 @@
 // This file is auto-generated by @hey-api/openapi-ts
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.deleteTrajectoryV1TrajectoriesTrajectoryIdDelete = exports.createTrajectoryV1TrajectoriesPost = exports.listTrajectoriesV1TrajectoriesGet = exports.updateRequestLogV1RequestLogsLogIdPatch = exports.getRequestLogV1RequestLogsLogIdGet = exports.deleteRequestLogV1RequestLogsLogIdDelete = exports.createRequestLogV1RequestLogsPost = exports.listRequestLogsV1RequestLogsGet = exports.updateConnectionV1ConnectionsConnectionIdPatch = exports.getConnectionV1ConnectionsConnectionIdGet = exports.deleteConnectionV1ConnectionsConnectionIdDelete = exports.createConnectionV1ConnectionsPost = exports.listConnectionsV1ConnectionsGet = exports.downloadRunAttachmentV1RunAttachmentsAttachmentIdDownloadGet = exports.getRunAttachmentDownloadUrlV1RunAttachmentsAttachmentIdDownloadUrlGet = exports.updateRunAttachmentV1RunAttachmentsAttachmentIdPut = exports.getRunAttachmentV1RunAttachmentsAttachmentIdGet = exports.deleteRunAttachmentV1RunAttachmentsAttachmentIdDelete = exports.createRunAttachmentV1RunAttachmentsPost = exports.listRunAttachmentsV1RunAttachmentsGet = exports.retryRunV1RunsRunIdRetryPost = exports.bulkCreateRunsV1RunsBulkPost = exports.createRunChainV1RunsChainPost = exports.updateRunV1RunsRunIdPatch = exports.getRunV1RunsRunIdGet = exports.deleteRunV1RunsRunIdDelete = exports.createRunV1RunsPost = exports.listRunsV1RunsGet = exports.getWorkflowVersionsV1WorkflowsWorkflowIdVersionsGet = exports.updateWorkflowV1WorkflowsWorkflowIdPatch = exports.getWorkflowV1WorkflowsWorkflowIdGet = exports.deleteWorkflowV1WorkflowsWorkflowIdDelete = exports.createWorkflowV1WorkflowsPost = exports.listWorkflowsV1WorkflowsGet = exports.addMachinesToPoolV1PoolsPoolIdMachinesPost = exports.removeMachinesFromPoolV1PoolsPoolIdMachinesDelete = exports.updatePoolV1PoolsPoolIdPatch = exports.getPoolV1PoolsPoolIdGet = exports.deletePoolV1PoolsPoolIdDelete = exports.createPoolV1PoolsPost = exports.listPoolsV1PoolsGet = exports.updateMachinePoolsV1MachinesMachineIdPoolsPut = exports.getMachinePoolsV1MachinesMachineIdPoolsGet = exports.updateMachineV1MachinesMachineIdPatch = exports.getMachineV1MachinesMachineIdGet = exports.deleteMachineV1MachinesMachineIdDelete = exports.createMachineV1MachinesPost = exports.listMachinesV1MachinesGet = exports.databaseHealthCheckV1HealthDbGet = exports.healthCheckV1HealthGet = void 0;
-exports.healthDbHealthDbGet = exports.healthHealthGet = exports.rootGet = exports.dummyTestEndpointV1TestPost = exports.powershellSessionV1ComputerMachineIdShellPowershellSessionPost = exports.powershellExecV1ComputerMachineIdShellPowershellExecPost = exports.fsWriteV1ComputerMachineIdFsWritePost = exports.fsReadV1ComputerMachineIdFsReadGet = exports.fsListV1ComputerMachineIdFsListGet = exports.mouseDragV1ComputerMachineIdInputMouseDragPost = exports.mouseScrollV1ComputerMachineIdInputMouseScrollPost = exports.mouseClickV1ComputerMachineIdInputMouseClickPost = exports.mouseMoveV1ComputerMachineIdInputMouseMovePost = exports.getMousePositionV1ComputerMachineIdInputMousePositionGet = exports.keyboardKeyV1ComputerMachineIdInputKeyboardKeyPost = exports.keyboardTypeV1ComputerMachineIdInputKeyboardTypePost = exports.getDisplayDimensionsV1ComputerMachineIdDisplayDimensionsGet = exports.getScreenshotV1ComputerMachineIdDisplayScreenshotGet = exports.getLatestTrajectoryForWorkflowV1WorkflowsWorkflowIdLatestTrajectoryGet = exports.updateTrajectoryV1TrajectoriesTrajectoryIdPatch = exports.getTrajectoryV1TrajectoriesTrajectoryIdGet = void 0;
+exports.healthDbHealthDbGet = exports.healthHealthGet = exports.rootGet = exports.dummyTestEndpointV1TestPost = exports.powershellSessionV1ComputerMachineIdShellPowershellSessionPost = exports.powershellExecV1ComputerMachineIdShellPowershellExecPost = exports.fsWriteV1ComputerMachineIdFsWritePost = exports.fsReadV1ComputerMachineIdFsReadGet = exports.fsListV1ComputerMachineIdFsListGet = exports.mouseDragV1ComputerMachineIdInputMouseDragPost = exports.mouseScrollV1ComputerMachineIdInputMouseScrollPost = exports.mouseClickV1ComputerMachineIdInputMouseClickPost = exports.mouseMoveV1ComputerMachineIdInputMouseMovePost = exports.getMousePositionV1ComputerMachineIdInputMousePositionGet = exports.copyToClipboardV1ComputerMachineIdCopyToClipboardPost = exports.keyboardKeyV1ComputerMachineIdInputKeyboardKeyPost = exports.keyboardTypeV1ComputerMachineIdInputKeyboardTypePost = exports.getDisplayDimensionsV1ComputerMachineIdDisplayDimensionsGet = exports.getScreenshotV1ComputerMachineIdDisplayScreenshotGet = exports.getLatestTrajectoryForWorkflowV1WorkflowsWorkflowIdLatestTrajectoryGet = exports.updateTrajectoryV1TrajectoriesTrajectoryIdPatch = exports.getTrajectoryV1TrajectoriesTrajectoryIdGet = void 0;
 const client_gen_1 = require("./client.gen");
 /**
  * Health Check
@@ -19,7 +19,7 @@ exports.healthCheckV1HealthGet = healthCheckV1HealthGet;
  * Database Health Check
  * Database health check endpoint.
  *
- * Verifies database connectivity without authentication.
+ * Verifies database connectivity and pool status without authentication.
  */
 const databaseHealthCheckV1HealthDbGet = (options) => {
     var _a;
@@ -62,7 +62,10 @@ exports.createMachineV1MachinesPost = createMachineV1MachinesPost;
  * Delete Machine
  * Delete a machine.
  *
- * This will also delete all associated connections, request logs, and runs.
+ * Associated runs are PRESERVED with machine_id set to NULL.
+ * This ensures run history is never lost when a machine is deleted.
+ * Connections and request logs are cascade deleted.
+ *
  * The machine must belong to the authenticated organization.
  */
 const deleteMachineV1MachinesMachineIdDelete = (options) => {
@@ -97,6 +100,9 @@ exports.getMachineV1MachinesMachineIdGet = getMachineV1MachinesMachineIdGet;
  *
  * Only the fields provided in the request body will be updated.
  * The machine must belong to the authenticated organization.
+ *
+ * For machine_sensitive_parameters: provide actual secret values and they will be
+ * stored in Basis Theory. Only aliases will be stored in the database.
  */
 const updateMachineV1MachinesMachineIdPatch = (options) => {
     var _a;
@@ -920,6 +926,20 @@ const keyboardKeyV1ComputerMachineIdInputKeyboardKeyPost = (options) => {
         ], url: '/v1/computer/{machine_id}/input/keyboard/key' }, options), { headers: Object.assign({ 'Content-Type': 'application/json' }, options === null || options === void 0 ? void 0 : options.headers) }));
 };
 exports.keyboardKeyV1ComputerMachineIdInputKeyboardKeyPost = keyboardKeyV1ComputerMachineIdInputKeyboardKeyPost;
+/**
+ * Copy to clipboard via Ctrl+C
+ * Execute Ctrl+C and return clipboard contents with the specified key name.
+ */
+const copyToClipboardV1ComputerMachineIdCopyToClipboardPost = (options) => {
+    var _a;
+    return ((_a = options.client) !== null && _a !== void 0 ? _a : client_gen_1.client).post(Object.assign(Object.assign({ security: [
+            {
+                scheme: 'bearer',
+                type: 'http'
+            }
+        ], url: '/v1/computer/{machine_id}/copy_to_clipboard' }, options), { headers: Object.assign({ 'Content-Type': 'application/json' }, options === null || options === void 0 ? void 0 : options.headers) }));
+};
+exports.copyToClipboardV1ComputerMachineIdCopyToClipboardPost = copyToClipboardV1ComputerMachineIdCopyToClipboardPost;
 /**
  * Get mouse position
  * Get the current mouse cursor position.

package/dist/client/types.gen.d.ts

@@ -45,6 +45,12 @@ export type ConnectionResponse = {
     status: ConnectionStatus;
 };
 export type ConnectionStatus = 'connected' | 'disconnected' | 'error';
+export type CopyToClipboardRequest = {
+    /**
+     * Key name for the copied data
+     */
+    text: string;
+};
 export type DisplayDimensions = {
     width: number;
     height: number;
@@ -99,6 +105,18 @@ export type MachineCreate = {
     version?: string | null;
     hostname?: string | null;
     os_info?: string | null;
+    /**
+     * Machine-specific input values that auto-populate runs
+     */
+    machine_parameters?: {
+        [key: string]: unknown;
+    } | null;
+    /**
+     * Machine-specific sensitive input aliases (stored in Basis Theory)
+     */
+    machine_sensitive_parameters?: {
+        [key: string]: string;
+    } | null;
     unkey_key_id: string;
 };
 /**
@@ -128,6 +146,18 @@ export type MachineResponse = {
     version?: string | null;
     hostname?: string | null;
     os_info?: string | null;
+    /**
+     * Machine-specific input values that auto-populate runs
+     */
+    machine_parameters?: {
+        [key: string]: unknown;
+    } | null;
+    /**
+     * Machine-specific sensitive input aliases (stored in Basis Theory)
+     */
+    machine_sensitive_parameters?: {
+        [key: string]: string;
+    } | null;
     id: string;
     user_id?: string | null;
     organization_id?: string | null;
@@ -156,6 +186,18 @@ export type MachineUpdate = {
      * Set to null to clear reservation; server will cancel queued/running session runs and clear
      */
     reserved_session_id?: string | null;
+    /**
+     * Machine-specific input values. Provide empty dict {} to clear all.
+     */
+    machine_parameters?: {
+        [key: string]: unknown;
+    } | null;
+    /**
+     * Machine-specific sensitive input values (will be stored in Basis Theory). Provide empty dict {} to clear all.
+     */
+    machine_sensitive_parameters?: {
+        [key: string]: string;
+    } | null;
 };
 export type MouseClickRequest = {
     x?: number | null;
@@ -835,11 +877,8 @@ export type DatabaseHealthCheckV1HealthDbGetResponses = {
     /**
      * Successful Response
      */
-    200: {
-        [key: string]: string;
-    };
+    200: unknown;
 };
-export type DatabaseHealthCheckV1HealthDbGetResponse = DatabaseHealthCheckV1HealthDbGetResponses[keyof DatabaseHealthCheckV1HealthDbGetResponses];
 export type ListMachinesV1MachinesGetData = {
     body?: never;
     path?: never;
@@ -2156,6 +2195,30 @@ export type KeyboardKeyV1ComputerMachineIdInputKeyboardKeyPostResponses = {
     204: void;
 };
 export type KeyboardKeyV1ComputerMachineIdInputKeyboardKeyPostResponse = KeyboardKeyV1ComputerMachineIdInputKeyboardKeyPostResponses[keyof KeyboardKeyV1ComputerMachineIdInputKeyboardKeyPostResponses];
+export type CopyToClipboardV1ComputerMachineIdCopyToClipboardPostData = {
+    body: CopyToClipboardRequest;
+    path: {
+        machine_id: string;
+    };
+    query?: never;
+    url: '/v1/computer/{machine_id}/copy_to_clipboard';
+};
+export type CopyToClipboardV1ComputerMachineIdCopyToClipboardPostErrors = {
+    /**
+     * Validation Error
+     */
+    422: HttpValidationError;
+};
+export type CopyToClipboardV1ComputerMachineIdCopyToClipboardPostError = CopyToClipboardV1ComputerMachineIdCopyToClipboardPostErrors[keyof CopyToClipboardV1ComputerMachineIdCopyToClipboardPostErrors];
+export type CopyToClipboardV1ComputerMachineIdCopyToClipboardPostResponses = {
+    /**
+     * Successful Response
+     */
+    200: {
+        [key: string]: unknown;
+    };
+};
+export type CopyToClipboardV1ComputerMachineIdCopyToClipboardPostResponse = CopyToClipboardV1ComputerMachineIdCopyToClipboardPostResponses[keyof CopyToClipboardV1ComputerMachineIdCopyToClipboardPostResponses];
 export type GetMousePositionV1ComputerMachineIdInputMousePositionGetData = {
     body?: never;
     path: {

package/dist/index.d.ts

@@ -51,7 +51,8 @@ export declare function createCyberdeskClient(apiKey: string, baseUrl?: string):
          * @param params.skip - Number of items to skip (for pagination)
          * @param params.limit - Maximum number of items to return
          * @param params.status - Filter by machine status
-         * @returns Paginated list of machines
+         * @returns Paginated list of machines. Each machine includes desktop parameters
+         *          (machine_parameters, machine_sensitive_parameters) if configured.
          */
         list: (params?: {
             skip?: number;
@@ -73,6 +74,12 @@ export declare function createCyberdeskClient(apiKey: string, baseUrl?: string):
          * Create a new machine
          *
          * @param data - Machine configuration
+         * @param data.fingerprint - Unique machine fingerprint
+         * @param data.unkey_key_id - API key ID for authentication
+         * @param data.name - Optional machine name
+         * @param data.machine_parameters - Optional dict of desktop parameters
+         * @param data.machine_sensitive_parameters - Optional dict of sensitive desktop parameters
+         *                                            (provide actual values, they'll be stored in Basis Theory)
          * @returns Created machine details
          */
         create: (data: MachineCreate) => Promise<({
@@ -89,7 +96,11 @@ export declare function createCyberdeskClient(apiKey: string, baseUrl?: string):
          * Get a specific machine by ID
          *
          * @param machineId - The ID of the machine
-         * @returns Machine details
+         * @returns Machine details including:
+         *          - Basic info: id, name, status, fingerprint, etc.
+         *          - machine_parameters: Dict of desktop parameters (if configured)
+         *          - machine_sensitive_parameters: Dict of sensitive parameter aliases (if configured)
+         *          - pools: List of pools this machine belongs to
          */
         get: (machineId: string) => Promise<({
             data: undefined;
@@ -105,12 +116,40 @@ export declare function createCyberdeskClient(apiKey: string, baseUrl?: string):
          * Update a machine
          *
          * @param machineId - The ID of the machine to update
-         * @param data - Update data (name, status, availability, etc.)
+         * @param data - Update data with fields:
+         *   - name: Optional machine name
+         *   - machine_parameters: Optional dict of machine-specific input values that
+         *     automatically populate runs on this desktop. Use {} to clear all.
+         *   - machine_sensitive_parameters: Optional dict of sensitive parameters
+         *     (provide actual values, they'll be stored in Basis Theory). Use {} to clear all.
+         *   - status, is_available, hostname, os_info, version: Other machine fields
+         *   - reserved_session_id: Set to null to clear reservation
+         *
+         * Desktop Parameters:
+         *   Machine parameters automatically merge into runs assigned to this machine,
+         *   overriding run-level input values. Use {param_name} or {$sensitive_param}
+         *   syntax in workflow prompts.
          *
-         * Note: linked_keepalive_machine_id is not writable; it is managed by
-         * Cyberdriver link events and will be set/cleared automatically by the
-         * platform.
          * @returns Updated machine details
+         *
+         * @example
+         * ```typescript
+         * await client.machines.update('machine-id', {
+         *   machine_parameters: {
+         *     username: 'machine_specific_user',
+         *     api_url: 'https://api.example.com'
+         *   },
+         *   machine_sensitive_parameters: {
+         *     password: 'actual_secret_value'  // Stored securely in Basis Theory
+         *   }
+         * });
+         * ```
+         *
+         * @remarks
+         * - linked_keepalive_machine_id is not writable; it is managed by
+         *   Cyberdriver link events and will be set/cleared automatically.
+         * - For machine_sensitive_parameters, provide actual secret values.
+         *   They will be stored securely in Basis Theory and only aliases stored in DB.
          */
         update: (machineId: string, data: MachineUpdate) => Promise<{
             data?: MachineResponse;
@@ -137,6 +176,12 @@ export declare function createCyberdeskClient(apiKey: string, baseUrl?: string):
         /**
          * Delete a machine
          *
+         * Associated runs are preserved with machine_id set to NULL to maintain run history.
+         * Connections and request logs are cascade deleted.
+         *
+         * If the machine has desktop sensitive parameters, they will be automatically
+         * cleaned up from Basis Theory before deletion.
+         *
          * @param machineId - The ID of the machine to delete
          */
         delete: (machineId: string) => Promise<({

package/dist/index.js

@@ -110,7 +110,8 @@ function createCyberdeskClient(apiKey, baseUrl) {
              * @param params.skip - Number of items to skip (for pagination)
              * @param params.limit - Maximum number of items to return
              * @param params.status - Filter by machine status
-             * @returns Paginated list of machines
+             * @returns Paginated list of machines. Each machine includes desktop parameters
+             *          (machine_parameters, machine_sensitive_parameters) if configured.
              */
             list: (params) => __awaiter(this, void 0, void 0, function* () {
                 const query = {
@@ -126,6 +127,12 @@ function createCyberdeskClient(apiKey, baseUrl) {
              * Create a new machine
              *
              * @param data - Machine configuration
+             * @param data.fingerprint - Unique machine fingerprint
+             * @param data.unkey_key_id - API key ID for authentication
+             * @param data.name - Optional machine name
+             * @param data.machine_parameters - Optional dict of desktop parameters
+             * @param data.machine_sensitive_parameters - Optional dict of sensitive desktop parameters
+             *                                            (provide actual values, they'll be stored in Basis Theory)
              * @returns Created machine details
              */
             create: (data) => __awaiter(this, void 0, void 0, function* () {
@@ -138,7 +145,11 @@ function createCyberdeskClient(apiKey, baseUrl) {
              * Get a specific machine by ID
              *
              * @param machineId - The ID of the machine
-             * @returns Machine details
+             * @returns Machine details including:
+             *          - Basic info: id, name, status, fingerprint, etc.
+             *          - machine_parameters: Dict of desktop parameters (if configured)
+             *          - machine_sensitive_parameters: Dict of sensitive parameter aliases (if configured)
+             *          - pools: List of pools this machine belongs to
              */
             get: (machineId) => __awaiter(this, void 0, void 0, function* () {
                 return (0, sdk_gen_1.getMachineV1MachinesMachineIdGet)({
@@ -150,12 +161,40 @@ function createCyberdeskClient(apiKey, baseUrl) {
              * Update a machine
              *
              * @param machineId - The ID of the machine to update
-             * @param data - Update data (name, status, availability, etc.)
+             * @param data - Update data with fields:
+             *   - name: Optional machine name
+             *   - machine_parameters: Optional dict of machine-specific input values that
+             *     automatically populate runs on this desktop. Use {} to clear all.
+             *   - machine_sensitive_parameters: Optional dict of sensitive parameters
+             *     (provide actual values, they'll be stored in Basis Theory). Use {} to clear all.
+             *   - status, is_available, hostname, os_info, version: Other machine fields
+             *   - reserved_session_id: Set to null to clear reservation
+             *
+             * Desktop Parameters:
+             *   Machine parameters automatically merge into runs assigned to this machine,
+             *   overriding run-level input values. Use {param_name} or {$sensitive_param}
+             *   syntax in workflow prompts.
              *
-             * Note: linked_keepalive_machine_id is not writable; it is managed by
-             * Cyberdriver link events and will be set/cleared automatically by the
-             * platform.
              * @returns Updated machine details
+             *
+             * @example
+             * ```typescript
+             * await client.machines.update('machine-id', {
+             *   machine_parameters: {
+             *     username: 'machine_specific_user',
+             *     api_url: 'https://api.example.com'
+             *   },
+             *   machine_sensitive_parameters: {
+             *     password: 'actual_secret_value'  // Stored securely in Basis Theory
+             *   }
+             * });
+             * ```
+             *
+             * @remarks
+             * - linked_keepalive_machine_id is not writable; it is managed by
+             *   Cyberdriver link events and will be set/cleared automatically.
+             * - For machine_sensitive_parameters, provide actual secret values.
+             *   They will be stored securely in Basis Theory and only aliases stored in DB.
              */
             update: (machineId, data) => __awaiter(this, void 0, void 0, function* () {
                 return (0, sdk_gen_1.updateMachineV1MachinesMachineIdPatch)({
@@ -183,6 +222,12 @@ function createCyberdeskClient(apiKey, baseUrl) {
             /**
              * Delete a machine
              *
+             * Associated runs are preserved with machine_id set to NULL to maintain run history.
+             * Connections and request logs are cascade deleted.
+             *
+             * If the machine has desktop sensitive parameters, they will be automatically
+             * cleaned up from Basis Theory before deletion.
+             *
              * @param machineId - The ID of the machine to delete
              */
             delete: (machineId) => __awaiter(this, void 0, void 0, function* () {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cyberdesk",
-  "version": "2.1.15",
+  "version": "2.1.17",
   "description": "The official TypeScript SDK for Cyberdesk",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -12,6 +12,10 @@
   "scripts": {
     "generate": "openapi-ts",
     "build": "npm run generate && tsc",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "test:webhooks": "vitest run tests/webhooks",
+    "test:integration": "vitest run tests/integration",
     "prepublishOnly": "npm run build"
   },
   "repository": {
@@ -29,6 +33,10 @@
   },
   "devDependencies": {
     "@hey-api/openapi-ts": "^0.66.6",
-    "typescript": "^5.0.0"
+    "@types/node": "^20.0.0",
+    "dotenv": "^16.0.0",
+    "svix": "^1.0.0",
+    "typescript": "^5.0.0",
+    "vitest": "^1.0.0"
   }
 }