cyberdesk 2.1.4 → 2.1.6
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.
- package/dist/client/sdk.gen.d.ts +16 -1
- package/dist/client/sdk.gen.js +35 -2
- package/dist/client/types.gen.d.ts +143 -0
- package/dist/index.d.ts +41 -1
- package/dist/index.js +34 -0
- package/package.json +1 -1
package/dist/client/sdk.gen.d.ts
CHANGED
|
@@ -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, CreateRunChainV1RunsChainPostData, 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
|
|
@@ -203,6 +203,15 @@ export declare const getRunV1RunsRunIdGet: <ThrowOnError extends boolean = false
|
|
|
203
203
|
* The run must belong to the authenticated organization.
|
|
204
204
|
*/
|
|
205
205
|
export declare const updateRunV1RunsRunIdPatch: <ThrowOnError extends boolean = false>(options: Options<UpdateRunV1RunsRunIdPatchData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen").RunResponse, import("./types.gen").HttpValidationError, ThrowOnError>;
|
|
206
|
+
/**
|
|
207
|
+
* Create Run Chain
|
|
208
|
+
* Create a multi-step chain that runs on a single reserved session/machine.
|
|
209
|
+
*
|
|
210
|
+
* - Starts a new session unless session_id is provided (then runs on existing session).
|
|
211
|
+
* - Accepts shared_inputs/sensitive/file_inputs and per-step file_inputs.
|
|
212
|
+
* - machine_id > pool_id when starting a new session; both ignored if session_id provided.
|
|
213
|
+
*/
|
|
214
|
+
export declare const createRunChainV1RunsChainPost: <ThrowOnError extends boolean = false>(options: Options<CreateRunChainV1RunsChainPostData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen").WorkflowChainResponse, import("./types.gen").HttpValidationError, ThrowOnError>;
|
|
206
215
|
/**
|
|
207
216
|
* Bulk Create Runs
|
|
208
217
|
* Create multiple runs with the same configuration.
|
|
@@ -427,6 +436,12 @@ export declare const mouseMoveV1ComputerMachineIdInputMouseMovePost: <ThrowOnErr
|
|
|
427
436
|
* If coordinates are not provided, clicks at current position.
|
|
428
437
|
*/
|
|
429
438
|
export declare const mouseClickV1ComputerMachineIdInputMouseClickPost: <ThrowOnError extends boolean = false>(options: Options<MouseClickV1ComputerMachineIdInputMouseClickPostData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<void, import("./types.gen").HttpValidationError, ThrowOnError>;
|
|
439
|
+
/**
|
|
440
|
+
* Scroll mouse wheel
|
|
441
|
+
* Scroll the mouse wheel in the specified direction by a number of steps.
|
|
442
|
+
* Optionally moves to (x, y) before scrolling.
|
|
443
|
+
*/
|
|
444
|
+
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
445
|
/**
|
|
431
446
|
* List directory contents
|
|
432
447
|
* List directory contents on the machine.
|
package/dist/client/sdk.gen.js
CHANGED
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
// This file is auto-generated by @hey-api/openapi-ts
|
|
3
3
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
|
-
exports.
|
|
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;
|
|
4
|
+
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.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.mouseScrollV1ComputerMachineIdInputMouseScrollPost = exports.mouseClickV1ComputerMachineIdInputMouseClickPost = exports.mouseMoveV1ComputerMachineIdInputMouseMovePost = exports.getMousePositionV1ComputerMachineIdInputMousePositionGet = exports.keyboardKeyV1ComputerMachineIdInputKeyboardKeyPost = exports.keyboardTypeV1ComputerMachineIdInputKeyboardTypePost = exports.getDisplayDimensionsV1ComputerMachineIdDisplayDimensionsGet = exports.getScreenshotV1ComputerMachineIdDisplayScreenshotGet = exports.getLatestTrajectoryForWorkflowV1WorkflowsWorkflowIdLatestTrajectoryGet = exports.updateTrajectoryV1TrajectoriesTrajectoryIdPatch = void 0;
|
|
6
6
|
const client_gen_1 = require("./client.gen");
|
|
7
7
|
/**
|
|
8
8
|
* Health Check
|
|
@@ -421,6 +421,24 @@ const updateRunV1RunsRunIdPatch = (options) => {
|
|
|
421
421
|
], url: '/v1/runs/{run_id}' }, options), { headers: Object.assign({ 'Content-Type': 'application/json' }, options === null || options === void 0 ? void 0 : options.headers) }));
|
|
422
422
|
};
|
|
423
423
|
exports.updateRunV1RunsRunIdPatch = updateRunV1RunsRunIdPatch;
|
|
424
|
+
/**
|
|
425
|
+
* Create Run Chain
|
|
426
|
+
* Create a multi-step chain that runs on a single reserved session/machine.
|
|
427
|
+
*
|
|
428
|
+
* - Starts a new session unless session_id is provided (then runs on existing session).
|
|
429
|
+
* - Accepts shared_inputs/sensitive/file_inputs and per-step file_inputs.
|
|
430
|
+
* - machine_id > pool_id when starting a new session; both ignored if session_id provided.
|
|
431
|
+
*/
|
|
432
|
+
const createRunChainV1RunsChainPost = (options) => {
|
|
433
|
+
var _a;
|
|
434
|
+
return ((_a = options.client) !== null && _a !== void 0 ? _a : client_gen_1.client).post(Object.assign(Object.assign({ security: [
|
|
435
|
+
{
|
|
436
|
+
scheme: 'bearer',
|
|
437
|
+
type: 'http'
|
|
438
|
+
}
|
|
439
|
+
], url: '/v1/runs/chain' }, options), { headers: Object.assign({ 'Content-Type': 'application/json' }, options === null || options === void 0 ? void 0 : options.headers) }));
|
|
440
|
+
};
|
|
441
|
+
exports.createRunChainV1RunsChainPost = createRunChainV1RunsChainPost;
|
|
424
442
|
/**
|
|
425
443
|
* Bulk Create Runs
|
|
426
444
|
* Create multiple runs with the same configuration.
|
|
@@ -924,6 +942,21 @@ const mouseClickV1ComputerMachineIdInputMouseClickPost = (options) => {
|
|
|
924
942
|
], 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
943
|
};
|
|
926
944
|
exports.mouseClickV1ComputerMachineIdInputMouseClickPost = mouseClickV1ComputerMachineIdInputMouseClickPost;
|
|
945
|
+
/**
|
|
946
|
+
* Scroll mouse wheel
|
|
947
|
+
* Scroll the mouse wheel in the specified direction by a number of steps.
|
|
948
|
+
* Optionally moves to (x, y) before scrolling.
|
|
949
|
+
*/
|
|
950
|
+
const mouseScrollV1ComputerMachineIdInputMouseScrollPost = (options) => {
|
|
951
|
+
var _a;
|
|
952
|
+
return ((_a = options.client) !== null && _a !== void 0 ? _a : client_gen_1.client).post(Object.assign(Object.assign({ security: [
|
|
953
|
+
{
|
|
954
|
+
scheme: 'bearer',
|
|
955
|
+
type: 'http'
|
|
956
|
+
}
|
|
957
|
+
], 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) }));
|
|
958
|
+
};
|
|
959
|
+
exports.mouseScrollV1ComputerMachineIdInputMouseScrollPost = mouseScrollV1ComputerMachineIdInputMouseScrollPost;
|
|
927
960
|
/**
|
|
928
961
|
* List directory contents
|
|
929
962
|
* List directory contents on the machine.
|
|
@@ -1,4 +1,20 @@
|
|
|
1
1
|
export type AttachmentType = 'input' | 'output';
|
|
2
|
+
/**
|
|
3
|
+
* One step within a chain
|
|
4
|
+
*/
|
|
5
|
+
export type ChainStep = {
|
|
6
|
+
workflow_id: string;
|
|
7
|
+
/**
|
|
8
|
+
* Alias to persist this step's outputs within the session
|
|
9
|
+
*/
|
|
10
|
+
session_alias?: string | null;
|
|
11
|
+
/**
|
|
12
|
+
* Step-specific inputs; values must be string or {$ref: 'alias.outputs.path'}
|
|
13
|
+
*/
|
|
14
|
+
inputs?: {
|
|
15
|
+
[key: string]: string | RefValue;
|
|
16
|
+
} | null;
|
|
17
|
+
};
|
|
2
18
|
/**
|
|
3
19
|
* Schema for creating a connection
|
|
4
20
|
*/
|
|
@@ -112,6 +128,7 @@ export type MachineResponse = {
|
|
|
112
128
|
unkey_key_id: string;
|
|
113
129
|
status: MachineStatus;
|
|
114
130
|
is_available: boolean;
|
|
131
|
+
reserved_session_id?: string | null;
|
|
115
132
|
created_at: string;
|
|
116
133
|
last_seen: string;
|
|
117
134
|
pools?: Array<PoolResponse> | null;
|
|
@@ -128,6 +145,10 @@ export type MachineUpdate = {
|
|
|
128
145
|
status?: MachineStatus | null;
|
|
129
146
|
is_available?: boolean | null;
|
|
130
147
|
last_seen?: string | null;
|
|
148
|
+
/**
|
|
149
|
+
* Set to null to clear reservation; server will cancel queued/running session runs and clear
|
|
150
|
+
*/
|
|
151
|
+
reserved_session_id?: string | null;
|
|
131
152
|
};
|
|
132
153
|
export type MouseClickRequest = {
|
|
133
154
|
x?: number | null;
|
|
@@ -146,6 +167,18 @@ export type MousePosition = {
|
|
|
146
167
|
x: number;
|
|
147
168
|
y: number;
|
|
148
169
|
};
|
|
170
|
+
export type MouseScrollRequest = {
|
|
171
|
+
/**
|
|
172
|
+
* Scroll direction: 'up', 'down', 'left', or 'right'
|
|
173
|
+
*/
|
|
174
|
+
direction: string;
|
|
175
|
+
/**
|
|
176
|
+
* Number of scroll steps (clicks); non-negative integer
|
|
177
|
+
*/
|
|
178
|
+
amount: number;
|
|
179
|
+
x?: number | null;
|
|
180
|
+
y?: number | null;
|
|
181
|
+
};
|
|
149
182
|
/**
|
|
150
183
|
* Paginated response wrapper
|
|
151
184
|
*/
|
|
@@ -270,6 +303,13 @@ export type PowerShellSessionRequest = {
|
|
|
270
303
|
*/
|
|
271
304
|
session_id?: string | null;
|
|
272
305
|
};
|
|
306
|
+
/**
|
|
307
|
+
* Reference to a prior step's output within the same session.
|
|
308
|
+
* The wire shape is {"$ref": "alias.outputs.path"}.
|
|
309
|
+
*/
|
|
310
|
+
export type RefValue = {
|
|
311
|
+
$ref: string;
|
|
312
|
+
};
|
|
273
313
|
/**
|
|
274
314
|
* Schema for creating a request log
|
|
275
315
|
*/
|
|
@@ -392,6 +432,20 @@ export type RunBulkCreate = {
|
|
|
392
432
|
* Number of runs to create (max 1000)
|
|
393
433
|
*/
|
|
394
434
|
count: number;
|
|
435
|
+
/**
|
|
436
|
+
* Sensitive input values to store in the secure vault per run. Not persisted in our database.
|
|
437
|
+
*/
|
|
438
|
+
sensitive_input_values?: {
|
|
439
|
+
[key: string]: string;
|
|
440
|
+
} | null;
|
|
441
|
+
/**
|
|
442
|
+
* Join an existing session; overrides machine_id/pool_ids for all runs
|
|
443
|
+
*/
|
|
444
|
+
session_id?: string | null;
|
|
445
|
+
/**
|
|
446
|
+
* Start a new session for these runs; a new UUID will be generated and set on all runs. The first run will attempt to reserve a machine.
|
|
447
|
+
*/
|
|
448
|
+
start_session?: boolean | null;
|
|
395
449
|
};
|
|
396
450
|
/**
|
|
397
451
|
* Response for bulk run creation
|
|
@@ -445,6 +499,24 @@ export type RunCreate = {
|
|
|
445
499
|
* Files to upload to the machine
|
|
446
500
|
*/
|
|
447
501
|
file_inputs?: Array<FileInput> | null;
|
|
502
|
+
/**
|
|
503
|
+
* Sensitive input values. These are not stored and will be written to a secure vault and referenced by alias only.
|
|
504
|
+
*/
|
|
505
|
+
sensitive_input_values?: {
|
|
506
|
+
[key: string]: string;
|
|
507
|
+
} | null;
|
|
508
|
+
/**
|
|
509
|
+
* Join an existing session; overrides machine_id/pool_ids
|
|
510
|
+
*/
|
|
511
|
+
session_id?: string | null;
|
|
512
|
+
/**
|
|
513
|
+
* Start a new session on the machine used by this run. Session ID will be this run's ID.
|
|
514
|
+
*/
|
|
515
|
+
start_session?: boolean | null;
|
|
516
|
+
/**
|
|
517
|
+
* Persist outputs under this alias for $ref in this session
|
|
518
|
+
*/
|
|
519
|
+
session_alias?: string | null;
|
|
448
520
|
};
|
|
449
521
|
/**
|
|
450
522
|
* Run response schema
|
|
@@ -469,6 +541,11 @@ export type RunResponse = {
|
|
|
469
541
|
[key: string]: unknown;
|
|
470
542
|
} | null;
|
|
471
543
|
pool_ids?: Array<string> | null;
|
|
544
|
+
sensitive_input_aliases?: {
|
|
545
|
+
[key: string]: string;
|
|
546
|
+
} | null;
|
|
547
|
+
session_id?: string | null;
|
|
548
|
+
session_alias?: string | null;
|
|
472
549
|
created_at: string;
|
|
473
550
|
};
|
|
474
551
|
export type RunStatus = 'scheduling' | 'running' | 'success' | 'cancelled' | 'error';
|
|
@@ -555,6 +632,30 @@ export type ValidationError = {
|
|
|
555
632
|
msg: string;
|
|
556
633
|
type: string;
|
|
557
634
|
};
|
|
635
|
+
/**
|
|
636
|
+
* Request to create and run a multi-step chain on a single reserved session/machine
|
|
637
|
+
*/
|
|
638
|
+
export type WorkflowChainCreate = {
|
|
639
|
+
steps: Array<ChainStep>;
|
|
640
|
+
shared_inputs?: {
|
|
641
|
+
[key: string]: unknown;
|
|
642
|
+
} | null;
|
|
643
|
+
shared_sensitive_inputs?: {
|
|
644
|
+
[key: string]: string;
|
|
645
|
+
} | null;
|
|
646
|
+
shared_file_inputs?: Array<FileInput> | null;
|
|
647
|
+
keep_session_after_completion?: boolean | null;
|
|
648
|
+
machine_id?: string | null;
|
|
649
|
+
pool_id?: string | null;
|
|
650
|
+
session_id?: string | null;
|
|
651
|
+
};
|
|
652
|
+
/**
|
|
653
|
+
* Response for chain creation
|
|
654
|
+
*/
|
|
655
|
+
export type WorkflowChainResponse = {
|
|
656
|
+
session_id: string;
|
|
657
|
+
run_ids: Array<string>;
|
|
658
|
+
};
|
|
558
659
|
/**
|
|
559
660
|
* Schema for creating a workflow
|
|
560
661
|
*/
|
|
@@ -1252,6 +1353,26 @@ export type UpdateRunV1RunsRunIdPatchResponses = {
|
|
|
1252
1353
|
200: RunResponse;
|
|
1253
1354
|
};
|
|
1254
1355
|
export type UpdateRunV1RunsRunIdPatchResponse = UpdateRunV1RunsRunIdPatchResponses[keyof UpdateRunV1RunsRunIdPatchResponses];
|
|
1356
|
+
export type CreateRunChainV1RunsChainPostData = {
|
|
1357
|
+
body: WorkflowChainCreate;
|
|
1358
|
+
path?: never;
|
|
1359
|
+
query?: never;
|
|
1360
|
+
url: '/v1/runs/chain';
|
|
1361
|
+
};
|
|
1362
|
+
export type CreateRunChainV1RunsChainPostErrors = {
|
|
1363
|
+
/**
|
|
1364
|
+
* Validation Error
|
|
1365
|
+
*/
|
|
1366
|
+
422: HttpValidationError;
|
|
1367
|
+
};
|
|
1368
|
+
export type CreateRunChainV1RunsChainPostError = CreateRunChainV1RunsChainPostErrors[keyof CreateRunChainV1RunsChainPostErrors];
|
|
1369
|
+
export type CreateRunChainV1RunsChainPostResponses = {
|
|
1370
|
+
/**
|
|
1371
|
+
* Successful Response
|
|
1372
|
+
*/
|
|
1373
|
+
201: WorkflowChainResponse;
|
|
1374
|
+
};
|
|
1375
|
+
export type CreateRunChainV1RunsChainPostResponse = CreateRunChainV1RunsChainPostResponses[keyof CreateRunChainV1RunsChainPostResponses];
|
|
1255
1376
|
export type BulkCreateRunsV1RunsBulkPostData = {
|
|
1256
1377
|
body: RunBulkCreate;
|
|
1257
1378
|
path?: never;
|
|
@@ -1979,6 +2100,28 @@ export type MouseClickV1ComputerMachineIdInputMouseClickPostResponses = {
|
|
|
1979
2100
|
204: void;
|
|
1980
2101
|
};
|
|
1981
2102
|
export type MouseClickV1ComputerMachineIdInputMouseClickPostResponse = MouseClickV1ComputerMachineIdInputMouseClickPostResponses[keyof MouseClickV1ComputerMachineIdInputMouseClickPostResponses];
|
|
2103
|
+
export type MouseScrollV1ComputerMachineIdInputMouseScrollPostData = {
|
|
2104
|
+
body: MouseScrollRequest;
|
|
2105
|
+
path: {
|
|
2106
|
+
machine_id: string;
|
|
2107
|
+
};
|
|
2108
|
+
query?: never;
|
|
2109
|
+
url: '/v1/computer/{machine_id}/input/mouse/scroll';
|
|
2110
|
+
};
|
|
2111
|
+
export type MouseScrollV1ComputerMachineIdInputMouseScrollPostErrors = {
|
|
2112
|
+
/**
|
|
2113
|
+
* Validation Error
|
|
2114
|
+
*/
|
|
2115
|
+
422: HttpValidationError;
|
|
2116
|
+
};
|
|
2117
|
+
export type MouseScrollV1ComputerMachineIdInputMouseScrollPostError = MouseScrollV1ComputerMachineIdInputMouseScrollPostErrors[keyof MouseScrollV1ComputerMachineIdInputMouseScrollPostErrors];
|
|
2118
|
+
export type MouseScrollV1ComputerMachineIdInputMouseScrollPostResponses = {
|
|
2119
|
+
/**
|
|
2120
|
+
* Successful Response
|
|
2121
|
+
*/
|
|
2122
|
+
204: void;
|
|
2123
|
+
};
|
|
2124
|
+
export type MouseScrollV1ComputerMachineIdInputMouseScrollPostResponse = MouseScrollV1ComputerMachineIdInputMouseScrollPostResponses[keyof MouseScrollV1ComputerMachineIdInputMouseScrollPostResponses];
|
|
1982
2125
|
export type FsListV1ComputerMachineIdFsListGetData = {
|
|
1983
2126
|
body?: never;
|
|
1984
2127
|
path: {
|
package/dist/index.d.ts
CHANGED
|
@@ -25,7 +25,7 @@
|
|
|
25
25
|
* });
|
|
26
26
|
* ```
|
|
27
27
|
*/
|
|
28
|
-
import { type MachineResponse, type MachinePoolUpdate, type PoolResponse, type PoolCreate, type PoolUpdate, type PoolWithMachines, type MachinePoolAssignment, type WorkflowResponse, type RunResponse, type ConnectionResponse, type TrajectoryResponse, type PaginatedResponseMachineResponse, type PaginatedResponsePoolResponse, type PaginatedResponseWorkflowResponse, type PaginatedResponseRunResponse, type PaginatedResponseConnectionResponse, type PaginatedResponseTrajectoryResponse, type MachineStatus, type RunStatus, type ConnectionStatus, type MachineCreate, type WorkflowCreate, type RunCreate, type RunBulkCreate, type RunBulkCreateResponse, type FileInput, type ConnectionCreate, type TrajectoryCreate, type MachineUpdate, type WorkflowUpdate, type RunUpdate, type TrajectoryUpdate, type RunAttachmentCreate, type RunAttachmentUpdate, type RunAttachmentResponse, type RunAttachmentDownloadUrlResponse, type AttachmentType, type PaginatedResponseRunAttachmentResponse } from './client/types.gen';
|
|
28
|
+
import { type MachineResponse, type MachinePoolUpdate, type PoolResponse, type PoolCreate, type PoolUpdate, type PoolWithMachines, type MachinePoolAssignment, type WorkflowResponse, type RunResponse, type ConnectionResponse, type TrajectoryResponse, type PaginatedResponseMachineResponse, type PaginatedResponsePoolResponse, type PaginatedResponseWorkflowResponse, type PaginatedResponseRunResponse, type PaginatedResponseConnectionResponse, type PaginatedResponseTrajectoryResponse, type MachineStatus, type RunStatus, type ConnectionStatus, type MachineCreate, type WorkflowCreate, type RunCreate, type RunBulkCreate, type RunBulkCreateResponse, type WorkflowChainCreate, type WorkflowChainResponse, type FileInput, type ConnectionCreate, type TrajectoryCreate, type MachineUpdate, type WorkflowUpdate, type RunUpdate, type TrajectoryUpdate, type RunAttachmentCreate, type RunAttachmentUpdate, type RunAttachmentResponse, type RunAttachmentDownloadUrlResponse, type AttachmentType, type PaginatedResponseRunAttachmentResponse } from './client/types.gen';
|
|
29
29
|
export * from './client/types.gen';
|
|
30
30
|
export * from './client/sdk.gen';
|
|
31
31
|
export * from './client/client.gen';
|
|
@@ -112,6 +112,24 @@ export declare function createCyberdeskClient(apiKey: string, baseUrl?: string):
|
|
|
112
112
|
data?: MachineResponse;
|
|
113
113
|
error?: any;
|
|
114
114
|
}>;
|
|
115
|
+
/**
|
|
116
|
+
* Clear any reserved session on the machine.
|
|
117
|
+
*
|
|
118
|
+
* Sends reserved_session_id=null; backend will cancel queued/running session runs
|
|
119
|
+
* and then clear the reservation per API contract.
|
|
120
|
+
*
|
|
121
|
+
* @param machineId - The ID of the machine
|
|
122
|
+
*/
|
|
123
|
+
clearSession: (machineId: string) => Promise<({
|
|
124
|
+
data: undefined;
|
|
125
|
+
error: import("./client/types.gen").HttpValidationError;
|
|
126
|
+
} | {
|
|
127
|
+
data: MachineResponse;
|
|
128
|
+
error: undefined;
|
|
129
|
+
}) & {
|
|
130
|
+
request: Request;
|
|
131
|
+
response: Response;
|
|
132
|
+
}>;
|
|
115
133
|
/**
|
|
116
134
|
* Delete a machine
|
|
117
135
|
*
|
|
@@ -447,6 +465,8 @@ export declare function createCyberdeskClient(apiKey: string, baseUrl?: string):
|
|
|
447
465
|
* @param data.pool_ids - Optional list of pool IDs (machine must be in ALL specified pools)
|
|
448
466
|
* @param data.input_values - Optional input values for workflow variables
|
|
449
467
|
* @param data.file_inputs - Optional files to upload to the machine
|
|
468
|
+
* @param data.start_session - Optional: start a new machine session for this run
|
|
469
|
+
* @param data.session_id - Optional: join an existing session; ignores machine_id/pool_ids
|
|
450
470
|
* @returns Created run details
|
|
451
471
|
*
|
|
452
472
|
* @example
|
|
@@ -489,6 +509,8 @@ export declare function createCyberdeskClient(apiKey: string, baseUrl?: string):
|
|
|
489
509
|
* @param data.pool_ids - Optional list of pool IDs (machine must be in ALL specified pools)
|
|
490
510
|
* @param data.input_values - Optional input values for workflow variables
|
|
491
511
|
* @param data.file_inputs - Optional files to upload to the machine
|
|
512
|
+
* @param data.start_session - Optional: start a new session for all created runs
|
|
513
|
+
* @param data.session_id - Optional: join an existing session for all runs
|
|
492
514
|
* @returns Details about created runs and any failures
|
|
493
515
|
*
|
|
494
516
|
* @example
|
|
@@ -522,6 +544,24 @@ export declare function createCyberdeskClient(apiKey: string, baseUrl?: string):
|
|
|
522
544
|
request: Request;
|
|
523
545
|
response: Response;
|
|
524
546
|
}>;
|
|
547
|
+
/**
|
|
548
|
+
* Create a chained run sequence on a single reserved machine session.
|
|
549
|
+
*
|
|
550
|
+
* @param data - WorkflowChainCreate with steps (session_alias, inputs),
|
|
551
|
+
* optional shared inputs/sensitive/file inputs, and either
|
|
552
|
+
* session_id to join or machine_id/pool_id to start a session.
|
|
553
|
+
* @returns WorkflowChainResponse containing session_id and run_ids
|
|
554
|
+
*/
|
|
555
|
+
chain: (data: WorkflowChainCreate) => Promise<({
|
|
556
|
+
data: undefined;
|
|
557
|
+
error: import("./client/types.gen").HttpValidationError;
|
|
558
|
+
} | {
|
|
559
|
+
data: WorkflowChainResponse;
|
|
560
|
+
error: undefined;
|
|
561
|
+
}) & {
|
|
562
|
+
request: Request;
|
|
563
|
+
response: Response;
|
|
564
|
+
}>;
|
|
525
565
|
/**
|
|
526
566
|
* Get a specific run by ID
|
|
527
567
|
*
|
package/dist/index.js
CHANGED
|
@@ -160,6 +160,22 @@ function createCyberdeskClient(apiKey, baseUrl) {
|
|
|
160
160
|
body: data,
|
|
161
161
|
});
|
|
162
162
|
}),
|
|
163
|
+
/**
|
|
164
|
+
* Clear any reserved session on the machine.
|
|
165
|
+
*
|
|
166
|
+
* Sends reserved_session_id=null; backend will cancel queued/running session runs
|
|
167
|
+
* and then clear the reservation per API contract.
|
|
168
|
+
*
|
|
169
|
+
* @param machineId - The ID of the machine
|
|
170
|
+
*/
|
|
171
|
+
clearSession: (machineId) => __awaiter(this, void 0, void 0, function* () {
|
|
172
|
+
const update = { reserved_session_id: null };
|
|
173
|
+
return (0, sdk_gen_1.updateMachineV1MachinesMachineIdPatch)({
|
|
174
|
+
client,
|
|
175
|
+
path: { machine_id: machineId },
|
|
176
|
+
body: update,
|
|
177
|
+
});
|
|
178
|
+
}),
|
|
163
179
|
/**
|
|
164
180
|
* Delete a machine
|
|
165
181
|
*
|
|
@@ -434,6 +450,8 @@ function createCyberdeskClient(apiKey, baseUrl) {
|
|
|
434
450
|
* @param data.pool_ids - Optional list of pool IDs (machine must be in ALL specified pools)
|
|
435
451
|
* @param data.input_values - Optional input values for workflow variables
|
|
436
452
|
* @param data.file_inputs - Optional files to upload to the machine
|
|
453
|
+
* @param data.start_session - Optional: start a new machine session for this run
|
|
454
|
+
* @param data.session_id - Optional: join an existing session; ignores machine_id/pool_ids
|
|
437
455
|
* @returns Created run details
|
|
438
456
|
*
|
|
439
457
|
* @example
|
|
@@ -472,6 +490,8 @@ function createCyberdeskClient(apiKey, baseUrl) {
|
|
|
472
490
|
* @param data.pool_ids - Optional list of pool IDs (machine must be in ALL specified pools)
|
|
473
491
|
* @param data.input_values - Optional input values for workflow variables
|
|
474
492
|
* @param data.file_inputs - Optional files to upload to the machine
|
|
493
|
+
* @param data.start_session - Optional: start a new session for all created runs
|
|
494
|
+
* @param data.session_id - Optional: join an existing session for all runs
|
|
475
495
|
* @returns Details about created runs and any failures
|
|
476
496
|
*
|
|
477
497
|
* @example
|
|
@@ -501,6 +521,20 @@ function createCyberdeskClient(apiKey, baseUrl) {
|
|
|
501
521
|
body: data,
|
|
502
522
|
});
|
|
503
523
|
}),
|
|
524
|
+
/**
|
|
525
|
+
* Create a chained run sequence on a single reserved machine session.
|
|
526
|
+
*
|
|
527
|
+
* @param data - WorkflowChainCreate with steps (session_alias, inputs),
|
|
528
|
+
* optional shared inputs/sensitive/file inputs, and either
|
|
529
|
+
* session_id to join or machine_id/pool_id to start a session.
|
|
530
|
+
* @returns WorkflowChainResponse containing session_id and run_ids
|
|
531
|
+
*/
|
|
532
|
+
chain: (data) => __awaiter(this, void 0, void 0, function* () {
|
|
533
|
+
return (0, sdk_gen_1.createRunChainV1RunsChainPost)({
|
|
534
|
+
client,
|
|
535
|
+
body: data,
|
|
536
|
+
});
|
|
537
|
+
}),
|
|
504
538
|
/**
|
|
505
539
|
* Get a specific run by ID
|
|
506
540
|
*
|