cyberdesk 2.1.3 → 2.1.5

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, BulkCreateRunsV1RunsBulkPostData, 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, 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, BulkCreateRunsV1RunsBulkPostData, 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, FsListV1ComputerMachineIdFsListGetData, FsReadV1ComputerMachineIdFsReadGetData, FsWriteV1ComputerMachineIdFsWritePostData, PowershellExecV1ComputerMachineIdShellPowershellExecPostData, PowershellSessionV1ComputerMachineIdShellPowershellSessionPostData, DummyTestEndpointV1TestPostData, 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
@@ -427,6 +427,12 @@ export declare const mouseMoveV1ComputerMachineIdInputMouseMovePost: <ThrowOnErr
427
427
  * If coordinates are not provided, clicks at current position.
428
428
  */
429
429
  export declare const mouseClickV1ComputerMachineIdInputMouseClickPost: <ThrowOnError extends boolean = false>(options: Options<MouseClickV1ComputerMachineIdInputMouseClickPostData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<void, import("./types.gen").HttpValidationError, ThrowOnError>;
430
+ /**
431
+ * Scroll mouse wheel
432
+ * Scroll the mouse wheel in the specified direction by a number of steps.
433
+ * Optionally moves to (x, y) before scrolling.
434
+ */
435
+ export declare const mouseScrollV1ComputerMachineIdInputMouseScrollPost: <ThrowOnError extends boolean = false>(options: Options<MouseScrollV1ComputerMachineIdInputMouseScrollPostData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<void, import("./types.gen").HttpValidationError, ThrowOnError>;
430
436
  /**
431
437
  * List directory contents
432
438
  * List directory contents on the machine.
@@ -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.updateTrajectoryV1TrajectoriesTrajectoryIdPatch = exports.getTrajectoryV1TrajectoriesTrajectoryIdGet = 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.bulkCreateRunsV1RunsBulkPost = 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.mouseClickV1ComputerMachineIdInputMouseClickPost = exports.mouseMoveV1ComputerMachineIdInputMouseMovePost = exports.getMousePositionV1ComputerMachineIdInputMousePositionGet = exports.keyboardKeyV1ComputerMachineIdInputKeyboardKeyPost = exports.keyboardTypeV1ComputerMachineIdInputKeyboardTypePost = exports.getDisplayDimensionsV1ComputerMachineIdDisplayDimensionsGet = exports.getScreenshotV1ComputerMachineIdDisplayScreenshotGet = exports.getLatestTrajectoryForWorkflowV1WorkflowsWorkflowIdLatestTrajectoryGet = void 0;
5
+ exports.healthDbHealthDbGet = exports.healthHealthGet = exports.rootGet = exports.dummyTestEndpointV1TestPost = exports.powershellSessionV1ComputerMachineIdShellPowershellSessionPost = exports.powershellExecV1ComputerMachineIdShellPowershellExecPost = exports.fsWriteV1ComputerMachineIdFsWritePost = exports.fsReadV1ComputerMachineIdFsReadGet = exports.fsListV1ComputerMachineIdFsListGet = exports.mouseScrollV1ComputerMachineIdInputMouseScrollPost = exports.mouseClickV1ComputerMachineIdInputMouseClickPost = exports.mouseMoveV1ComputerMachineIdInputMouseMovePost = exports.getMousePositionV1ComputerMachineIdInputMousePositionGet = exports.keyboardKeyV1ComputerMachineIdInputKeyboardKeyPost = exports.keyboardTypeV1ComputerMachineIdInputKeyboardTypePost = exports.getDisplayDimensionsV1ComputerMachineIdDisplayDimensionsGet = exports.getScreenshotV1ComputerMachineIdDisplayScreenshotGet = exports.getLatestTrajectoryForWorkflowV1WorkflowsWorkflowIdLatestTrajectoryGet = void 0;
6
6
  const client_gen_1 = require("./client.gen");
7
7
  /**
8
8
  * Health Check
@@ -924,6 +924,21 @@ const mouseClickV1ComputerMachineIdInputMouseClickPost = (options) => {
924
924
  ], url: '/v1/computer/{machine_id}/input/mouse/click' }, options), { headers: Object.assign({ 'Content-Type': 'application/json' }, options === null || options === void 0 ? void 0 : options.headers) }));
925
925
  };
926
926
  exports.mouseClickV1ComputerMachineIdInputMouseClickPost = mouseClickV1ComputerMachineIdInputMouseClickPost;
927
+ /**
928
+ * Scroll mouse wheel
929
+ * Scroll the mouse wheel in the specified direction by a number of steps.
930
+ * Optionally moves to (x, y) before scrolling.
931
+ */
932
+ const mouseScrollV1ComputerMachineIdInputMouseScrollPost = (options) => {
933
+ var _a;
934
+ return ((_a = options.client) !== null && _a !== void 0 ? _a : client_gen_1.client).post(Object.assign(Object.assign({ security: [
935
+ {
936
+ scheme: 'bearer',
937
+ type: 'http'
938
+ }
939
+ ], url: '/v1/computer/{machine_id}/input/mouse/scroll' }, options), { headers: Object.assign({ 'Content-Type': 'application/json' }, options === null || options === void 0 ? void 0 : options.headers) }));
940
+ };
941
+ exports.mouseScrollV1ComputerMachineIdInputMouseScrollPost = mouseScrollV1ComputerMachineIdInputMouseScrollPost;
927
942
  /**
928
943
  * List directory contents
929
944
  * List directory contents on the machine.
@@ -146,6 +146,18 @@ export type MousePosition = {
146
146
  x: number;
147
147
  y: number;
148
148
  };
149
+ export type MouseScrollRequest = {
150
+ /**
151
+ * Scroll direction: 'up', 'down', 'left', or 'right'
152
+ */
153
+ direction: string;
154
+ /**
155
+ * Number of scroll steps (clicks); non-negative integer
156
+ */
157
+ amount: number;
158
+ x?: number | null;
159
+ y?: number | null;
160
+ };
149
161
  /**
150
162
  * Paginated response wrapper
151
163
  */
@@ -392,6 +404,12 @@ export type RunBulkCreate = {
392
404
  * Number of runs to create (max 1000)
393
405
  */
394
406
  count: number;
407
+ /**
408
+ * Sensitive input values to store in the secure vault per run. Not persisted in our database.
409
+ */
410
+ sensitive_input_values?: {
411
+ [key: string]: string;
412
+ } | null;
395
413
  };
396
414
  /**
397
415
  * Response for bulk run creation
@@ -401,6 +419,27 @@ export type RunBulkCreateResponse = {
401
419
  failed_count?: number;
402
420
  errors?: Array<string>;
403
421
  };
422
+ /**
423
+ * Payload sent for the run_complete webhook event.
424
+ */
425
+ export type RunCompletedEvent = {
426
+ /**
427
+ * Unique event identifier for idempotency
428
+ */
429
+ event_id?: string;
430
+ /**
431
+ * Event type key
432
+ */
433
+ event_type?: string;
434
+ /**
435
+ * Time the event occurred (UTC)
436
+ */
437
+ occurred_at?: string;
438
+ /**
439
+ * The completed run data
440
+ */
441
+ run: RunResponse;
442
+ };
404
443
  /**
405
444
  * Schema for creating a run
406
445
  */
@@ -424,6 +463,12 @@ export type RunCreate = {
424
463
  * Files to upload to the machine
425
464
  */
426
465
  file_inputs?: Array<FileInput> | null;
466
+ /**
467
+ * Sensitive input values. These are not stored and will be written to a secure vault and referenced by alias only.
468
+ */
469
+ sensitive_input_values?: {
470
+ [key: string]: string;
471
+ } | null;
427
472
  };
428
473
  /**
429
474
  * Run response schema
@@ -448,6 +493,9 @@ export type RunResponse = {
448
493
  [key: string]: unknown;
449
494
  } | null;
450
495
  pool_ids?: Array<string> | null;
496
+ sensitive_input_aliases?: {
497
+ [key: string]: string;
498
+ } | null;
451
499
  created_at: string;
452
500
  };
453
501
  export type RunStatus = 'scheduling' | 'running' | 'success' | 'cancelled' | 'error';
@@ -548,6 +596,10 @@ export type WorkflowCreate = {
548
596
  * Enable AI-based file export detection
549
597
  */
550
598
  includes_file_exports?: boolean;
599
+ /**
600
+ * Send webhook on run completion
601
+ */
602
+ is_webhooks_enabled?: boolean;
551
603
  };
552
604
  /**
553
605
  * Workflow response schema
@@ -563,6 +615,10 @@ export type WorkflowResponse = {
563
615
  * Enable AI-based file export detection
564
616
  */
565
617
  includes_file_exports?: boolean;
618
+ /**
619
+ * Send webhook on run completion
620
+ */
621
+ is_webhooks_enabled?: boolean;
566
622
  id: string;
567
623
  user_id?: string | null;
568
624
  organization_id?: string | null;
@@ -587,6 +643,10 @@ export type WorkflowUpdate = {
587
643
  * Enable AI-based file export detection
588
644
  */
589
645
  includes_file_exports?: boolean | null;
646
+ /**
647
+ * Send webhook on run completion
648
+ */
649
+ is_webhooks_enabled?: boolean | null;
590
650
  };
591
651
  export type HealthCheckV1HealthGetData = {
592
652
  body?: never;
@@ -1946,6 +2006,28 @@ export type MouseClickV1ComputerMachineIdInputMouseClickPostResponses = {
1946
2006
  204: void;
1947
2007
  };
1948
2008
  export type MouseClickV1ComputerMachineIdInputMouseClickPostResponse = MouseClickV1ComputerMachineIdInputMouseClickPostResponses[keyof MouseClickV1ComputerMachineIdInputMouseClickPostResponses];
2009
+ export type MouseScrollV1ComputerMachineIdInputMouseScrollPostData = {
2010
+ body: MouseScrollRequest;
2011
+ path: {
2012
+ machine_id: string;
2013
+ };
2014
+ query?: never;
2015
+ url: '/v1/computer/{machine_id}/input/mouse/scroll';
2016
+ };
2017
+ export type MouseScrollV1ComputerMachineIdInputMouseScrollPostErrors = {
2018
+ /**
2019
+ * Validation Error
2020
+ */
2021
+ 422: HttpValidationError;
2022
+ };
2023
+ export type MouseScrollV1ComputerMachineIdInputMouseScrollPostError = MouseScrollV1ComputerMachineIdInputMouseScrollPostErrors[keyof MouseScrollV1ComputerMachineIdInputMouseScrollPostErrors];
2024
+ export type MouseScrollV1ComputerMachineIdInputMouseScrollPostResponses = {
2025
+ /**
2026
+ * Successful Response
2027
+ */
2028
+ 204: void;
2029
+ };
2030
+ export type MouseScrollV1ComputerMachineIdInputMouseScrollPostResponse = MouseScrollV1ComputerMachineIdInputMouseScrollPostResponses[keyof MouseScrollV1ComputerMachineIdInputMouseScrollPostResponses];
1949
2031
  export type FsListV1ComputerMachineIdFsListGetData = {
1950
2032
  body?: never;
1951
2033
  path: {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "cyberdesk",
3
- "version": "2.1.3",
3
+ "version": "2.1.5",
4
4
  "description": "The official TypeScript SDK for Cyberdesk",
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/index.d.ts",