cyberdesk 2.1.21 → 2.2.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,5 +1,5 @@
1
1
  import type { Options as ClientOptions, TDataShape, Client } from '@hey-api/client-fetch';
2
- 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';
2
+ 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, DbPingInternalDebugDbPingGetData, RootGetData, HealthHealthGetData, HealthDbHealthDbGetData } from './types.gen';
3
3
  export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean> = ClientOptions<TData, ThrowOnError> & {
4
4
  /**
5
5
  * You can provide a client instance returned by `createClient()` instead of
@@ -433,7 +433,7 @@ export declare const getDisplayDimensionsV1ComputerMachineIdDisplayDimensionsGet
433
433
  export declare const keyboardTypeV1ComputerMachineIdInputKeyboardTypePost: <ThrowOnError extends boolean = false>(options: Options<KeyboardTypeV1ComputerMachineIdInputKeyboardTypePostData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<void, import("./types.gen").HttpValidationError, ThrowOnError>;
434
434
  /**
435
435
  * Send key combination
436
- * Send a key combination (e.g., 'ctrl+a', 'alt+tab'). Uses 'keys' field to match Piglet expectations.
436
+ * Send a key combination (e.g., 'ctrl+a', 'alt+tab').
437
437
  */
438
438
  export declare const keyboardKeyV1ComputerMachineIdInputKeyboardKeyPost: <ThrowOnError extends boolean = false>(options: Options<KeyboardKeyV1ComputerMachineIdInputKeyboardKeyPostData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<void, import("./types.gen").HttpValidationError, ThrowOnError>;
439
439
  /**
@@ -517,6 +517,13 @@ export declare const powershellSessionV1ComputerMachineIdShellPowershellSessionP
517
517
  export declare const dummyTestEndpointV1TestPost: <ThrowOnError extends boolean = false>(options?: Options<DummyTestEndpointV1TestPostData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<{
518
518
  [key: string]: unknown;
519
519
  }, unknown, ThrowOnError>;
520
+ /**
521
+ * Db Ping
522
+ * Execute a lightweight `SELECT 1` to validate DB connectivity and expose pool stats.
523
+ *
524
+ * Returns JSON payload with `ok` boolean, pool metrics, and optional error metadata.
525
+ */
526
+ export declare const dbPingInternalDebugDbPingGet: <ThrowOnError extends boolean = false>(options?: Options<DbPingInternalDebugDbPingGetData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<unknown, unknown, ThrowOnError>;
520
527
  /**
521
528
  * Root
522
529
  * Root endpoint with service information
@@ -2,7 +2,7 @@
2
2
  // This file is auto-generated by @hey-api/openapi-ts
3
3
  Object.defineProperty(exports, "__esModule", { value: true });
4
4
  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;
5
- 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;
5
+ exports.healthDbHealthDbGet = exports.healthHealthGet = exports.rootGet = exports.dbPingInternalDebugDbPingGet = 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;
6
6
  const client_gen_1 = require("./client.gen");
7
7
  /**
8
8
  * Health Check
@@ -914,7 +914,7 @@ const keyboardTypeV1ComputerMachineIdInputKeyboardTypePost = (options) => {
914
914
  exports.keyboardTypeV1ComputerMachineIdInputKeyboardTypePost = keyboardTypeV1ComputerMachineIdInputKeyboardTypePost;
915
915
  /**
916
916
  * Send key combination
917
- * Send a key combination (e.g., 'ctrl+a', 'alt+tab'). Uses 'keys' field to match Piglet expectations.
917
+ * Send a key combination (e.g., 'ctrl+a', 'alt+tab').
918
918
  */
919
919
  const keyboardKeyV1ComputerMachineIdInputKeyboardKeyPost = (options) => {
920
920
  var _a;
@@ -1101,6 +1101,17 @@ const dummyTestEndpointV1TestPost = (options) => {
1101
1101
  ], url: '/v1/test' }, options));
1102
1102
  };
1103
1103
  exports.dummyTestEndpointV1TestPost = dummyTestEndpointV1TestPost;
1104
+ /**
1105
+ * Db Ping
1106
+ * Execute a lightweight `SELECT 1` to validate DB connectivity and expose pool stats.
1107
+ *
1108
+ * Returns JSON payload with `ok` boolean, pool metrics, and optional error metadata.
1109
+ */
1110
+ const dbPingInternalDebugDbPingGet = (options) => {
1111
+ var _a;
1112
+ return ((_a = options === null || options === void 0 ? void 0 : options.client) !== null && _a !== void 0 ? _a : client_gen_1.client).get(Object.assign({ url: '/internal/debug/db-ping' }, options));
1113
+ };
1114
+ exports.dbPingInternalDebugDbPingGet = dbPingInternalDebugDbPingGet;
1104
1115
  /**
1105
1116
  * Root
1106
1117
  * Root endpoint with service information
@@ -166,6 +166,10 @@ export type MachineResponse = {
166
166
  is_available: boolean;
167
167
  reserved_session_id?: string | null;
168
168
  linked_keepalive_machine_id?: string | null;
169
+ /**
170
+ * Fly machine ID hosting the WebSocket connection
171
+ */
172
+ physical_server_id?: string | null;
169
173
  created_at: string;
170
174
  last_seen: string;
171
175
  pools?: Array<PoolResponse> | null;
@@ -592,7 +596,7 @@ export type RunCreate = {
592
596
  * These are optional fields beyond the essential identifiers that are always returned
593
597
  * (id, workflow_id, machine_id, status, created_at).
594
598
  */
595
- export type RunField = 'user_id' | 'organization_id' | 'error' | 'output_data' | 'input_attachment_ids' | 'output_attachment_ids' | 'run_message_history' | 'input_values' | 'pool_ids' | 'sensitive_input_aliases' | 'session_id' | 'session_alias' | 'release_session_after' | 'started_at' | 'ended_at' | 'machine_id';
599
+ export type RunField = 'user_id' | 'organization_id' | 'error' | 'output_data' | 'input_attachment_ids' | 'output_attachment_ids' | 'run_message_history' | 'input_values' | 'pool_ids' | 'sensitive_input_aliases' | 'usage_metadata' | 'session_id' | 'session_alias' | 'release_session_after' | 'started_at' | 'ended_at' | 'machine_id';
596
600
  /**
597
601
  * Run response schema
598
602
  */
@@ -619,6 +623,12 @@ export type RunResponse = {
619
623
  sensitive_input_aliases?: {
620
624
  [key: string]: string;
621
625
  } | null;
626
+ /**
627
+ * Arbitrary usage/billing metadata captured during a run (schema is flexible)
628
+ */
629
+ usage_metadata?: {
630
+ [key: string]: unknown;
631
+ } | null;
622
632
  session_id?: string | null;
623
633
  session_alias?: string | null;
624
634
  release_session_after?: boolean | null;
@@ -689,8 +699,18 @@ export type RunUpdate = {
689
699
  input_values?: {
690
700
  [key: string]: unknown;
691
701
  } | null;
702
+ /**
703
+ * Arbitrary usage/billing metadata captured during a run (schema is flexible)
704
+ */
705
+ usage_metadata?: {
706
+ [key: string]: unknown;
707
+ } | null;
692
708
  started_at?: string | null;
693
709
  ended_at?: string | null;
710
+ /**
711
+ * Set to True to indicate this run released the session
712
+ */
713
+ release_session_after?: boolean | null;
694
714
  };
695
715
  /**
696
716
  * Schema for creating a trajectory
@@ -2477,6 +2497,18 @@ export type DummyTestEndpointV1TestPostResponses = {
2477
2497
  };
2478
2498
  };
2479
2499
  export type DummyTestEndpointV1TestPostResponse = DummyTestEndpointV1TestPostResponses[keyof DummyTestEndpointV1TestPostResponses];
2500
+ export type DbPingInternalDebugDbPingGetData = {
2501
+ body?: never;
2502
+ path?: never;
2503
+ query?: never;
2504
+ url: '/internal/debug/db-ping';
2505
+ };
2506
+ export type DbPingInternalDebugDbPingGetResponses = {
2507
+ /**
2508
+ * Successful Response
2509
+ */
2510
+ 200: unknown;
2511
+ };
2480
2512
  export type RootGetData = {
2481
2513
  body?: never;
2482
2514
  path?: never;
package/dist/index.d.ts CHANGED
@@ -52,7 +52,8 @@ export declare function createCyberdeskClient(apiKey: string, baseUrl?: string):
52
52
  * @param params.limit - Maximum number of items to return
53
53
  * @param params.status - Filter by machine status
54
54
  * @returns Paginated list of machines. Each machine includes desktop parameters
55
- * (machine_parameters, machine_sensitive_parameters) if configured.
55
+ * (machine_parameters, machine_sensitive_parameters) if configured,
56
+ * plus the current physical_server_id when connected to WebSockets.
56
57
  */
57
58
  list: (params?: {
58
59
  skip?: number;
@@ -100,6 +101,7 @@ export declare function createCyberdeskClient(apiKey: string, baseUrl?: string):
100
101
  * - Basic info: id, name, status, fingerprint, etc.
101
102
  * - machine_parameters: Dict of desktop parameters (if configured)
102
103
  * - machine_sensitive_parameters: Dict of sensitive parameter aliases (if configured)
104
+ * - physical_server_id: Fly machine ID currently hosting the WebSocket connection
103
105
  * - pools: List of pools this machine belongs to
104
106
  */
105
107
  get: (machineId: string) => Promise<({
@@ -148,6 +150,8 @@ export declare function createCyberdeskClient(apiKey: string, baseUrl?: string):
148
150
  * @remarks
149
151
  * - linked_keepalive_machine_id is not writable; it is managed by
150
152
  * Cyberdriver link events and will be set/cleared automatically.
153
+ * - physical_server_id is read-only; it is set automatically when the machine
154
+ * connects to a WebSocket server and cleared on disconnect.
151
155
  * - For machine_sensitive_parameters, provide actual secret values.
152
156
  * They will be stored securely in Basis Theory and only aliases stored in DB.
153
157
  */
@@ -490,7 +494,7 @@ export declare function createCyberdeskClient(apiKey: string, baseUrl?: string):
490
494
  * @param params.machine_id - Filter by machine ID
491
495
  * @param params.session_id - Filter by session ID
492
496
  * @param params.fields - Optional list of fields to include per run (projection). Available fields include:
493
- * started_at, ended_at, error, output_data, input_values, and more.
497
+ * started_at, ended_at, error, output_data, input_values, usage_metadata, and more.
494
498
  * @returns Paginated list of runs including timing fields:
495
499
  * - created_at: When run was created
496
500
  * - started_at: When run execution started (null for SCHEDULING runs)
@@ -649,7 +653,7 @@ export declare function createCyberdeskClient(apiKey: string, baseUrl?: string):
649
653
  * Update a run
650
654
  *
651
655
  * @param runId - The ID of the run to update
652
- * @param data - Update data (status, output_data, error messages, etc.)
656
+ * @param data - Update data (status, output_data, error messages, usage_metadata, etc.)
653
657
  * @returns Updated run details
654
658
  */
655
659
  update: (runId: string, data: RunUpdate) => Promise<({
package/dist/index.js CHANGED
@@ -111,7 +111,8 @@ function createCyberdeskClient(apiKey, baseUrl) {
111
111
  * @param params.limit - Maximum number of items to return
112
112
  * @param params.status - Filter by machine status
113
113
  * @returns Paginated list of machines. Each machine includes desktop parameters
114
- * (machine_parameters, machine_sensitive_parameters) if configured.
114
+ * (machine_parameters, machine_sensitive_parameters) if configured,
115
+ * plus the current physical_server_id when connected to WebSockets.
115
116
  */
116
117
  list: (params) => __awaiter(this, void 0, void 0, function* () {
117
118
  const query = {
@@ -149,6 +150,7 @@ function createCyberdeskClient(apiKey, baseUrl) {
149
150
  * - Basic info: id, name, status, fingerprint, etc.
150
151
  * - machine_parameters: Dict of desktop parameters (if configured)
151
152
  * - machine_sensitive_parameters: Dict of sensitive parameter aliases (if configured)
153
+ * - physical_server_id: Fly machine ID currently hosting the WebSocket connection
152
154
  * - pools: List of pools this machine belongs to
153
155
  */
154
156
  get: (machineId) => __awaiter(this, void 0, void 0, function* () {
@@ -193,6 +195,8 @@ function createCyberdeskClient(apiKey, baseUrl) {
193
195
  * @remarks
194
196
  * - linked_keepalive_machine_id is not writable; it is managed by
195
197
  * Cyberdriver link events and will be set/cleared automatically.
198
+ * - physical_server_id is read-only; it is set automatically when the machine
199
+ * connects to a WebSocket server and cleared on disconnect.
196
200
  * - For machine_sensitive_parameters, provide actual secret values.
197
201
  * They will be stored securely in Basis Theory and only aliases stored in DB.
198
202
  */
@@ -480,7 +484,7 @@ function createCyberdeskClient(apiKey, baseUrl) {
480
484
  * @param params.machine_id - Filter by machine ID
481
485
  * @param params.session_id - Filter by session ID
482
486
  * @param params.fields - Optional list of fields to include per run (projection). Available fields include:
483
- * started_at, ended_at, error, output_data, input_values, and more.
487
+ * started_at, ended_at, error, output_data, input_values, usage_metadata, and more.
484
488
  * @returns Paginated list of runs including timing fields:
485
489
  * - created_at: When run was created
486
490
  * - started_at: When run execution started (null for SCHEDULING runs)
@@ -618,7 +622,7 @@ function createCyberdeskClient(apiKey, baseUrl) {
618
622
  * Update a run
619
623
  *
620
624
  * @param runId - The ID of the run to update
621
- * @param data - Update data (status, output_data, error messages, etc.)
625
+ * @param data - Update data (status, output_data, error messages, usage_metadata, etc.)
622
626
  * @returns Updated run details
623
627
  */
624
628
  update: (runId, data) => __awaiter(this, void 0, void 0, function* () {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "cyberdesk",
3
- "version": "2.1.21",
3
+ "version": "2.2.1",
4
4
  "description": "The official TypeScript SDK for Cyberdesk",
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/index.d.ts",