cyberdesk 2.2.36 → 2.2.37
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 +9 -18
- package/dist/client/sdk.gen.js +5 -30
- package/dist/client/types.gen.d.ts +232 -100
- package/dist/index.d.ts +14 -46
- package/dist/index.js +16 -41
- package/package.json +4 -7
package/dist/client/sdk.gen.d.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { type Options as ClientOptions, type TDataShape, type 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, BulkAddTagsToWorkflowsV1WorkflowsBulkTagsPostData, DeleteWorkflowV1WorkflowsWorkflowIdDeleteData, GetWorkflowV1WorkflowsWorkflowIdGetData, UpdateWorkflowV1WorkflowsWorkflowIdPatchData, DuplicateWorkflowV1WorkflowsWorkflowIdDuplicatePostData, MergeWorkflowV1WorkflowsWorkflowIdMergePostData, GetWorkflowVersionsV1WorkflowsWorkflowIdVersionsGetData, DeleteWorkflowPromptImageV1WorkflowsPromptImageDeleteData, UploadWorkflowPromptImageV1WorkflowsPromptImagePostData, ListWorkflowPromptImagesV1WorkflowsPromptImagesGetData, GetWorkflowPromptImageSignedUrlV1WorkflowsPromptImageSignedUrlGetData, GetWorkflowTagsV1WorkflowsWorkflowIdTagsGetData, AddTagsToWorkflowV1WorkflowsWorkflowIdTagsPostData, RemoveTagFromWorkflowV1WorkflowsWorkflowIdTagsTagIdDeleteData, ListTagsV1WorkflowTagsGetData, CreateTagV1WorkflowTagsPostData, DeleteTagV1WorkflowTagsTagIdDeleteData, GetTagV1WorkflowTagsTagIdGetData, UpdateTagV1WorkflowTagsTagIdPatchData, ArchiveTagV1WorkflowTagsTagIdArchivePostData, UnarchiveTagV1WorkflowTagsTagIdUnarchivePostData, ReorderTagsV1WorkflowTagsReorderPutData, ListTagGroupsV1WorkflowTagGroupsGetData, CreateTagGroupV1WorkflowTagGroupsPostData, DeleteTagGroupV1WorkflowTagGroupsGroupIdDeleteData, GetTagGroupV1WorkflowTagGroupsGroupIdGetData, UpdateTagGroupV1WorkflowTagGroupsGroupIdPatchData, ReorderTagGroupsV1WorkflowTagGroupsReorderPutData, ListModelConfigurationsV1ModelConfigurationsGetData, CreateModelConfigurationV1ModelConfigurationsPostData, DeleteModelConfigurationV1ModelConfigurationsModelConfigurationIdDeleteData, GetModelConfigurationV1ModelConfigurationsModelConfigurationIdGetData, UpdateModelConfigurationV1ModelConfigurationsModelConfigurationIdPatchData, ListRunsV1RunsGetData, CreateRunV1RunsPostData, DeleteRunV1RunsRunIdDeleteData, GetRunV1RunsRunIdGetData, UpdateRunV1RunsRunIdPatchData, GetRunTrajectoryV1RunsRunIdTrajectoryGetData, GenerateRunTrajectoryV1RunsRunIdGenerateTrajectoryPostData, 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, DuplicateTrajectoryV1TrajectoriesTrajectoryIdDuplicatePostData, GetLatestTrajectoryForWorkflowV1WorkflowsWorkflowIdLatestTrajectoryGetData, GetScreenshotV1ComputerMachineIdDisplayScreenshotGetData, GetDisplayDimensionsV1ComputerMachineIdDisplayDimensionsGetData,
|
|
2
|
+
import type { HealthCheckV1HealthGetData, DatabaseHealthCheckV1HealthDbGetData, ListMachinesV1MachinesGetData, CreateMachineV1MachinesPostData, DeleteMachineV1MachinesMachineIdDeleteData, GetMachineV1MachinesMachineIdGetData, UpdateMachineV1MachinesMachineIdPatchData, GetMachinePoolsV1MachinesMachineIdPoolsGetData, UpdateMachinePoolsV1MachinesMachineIdPoolsPutData, ListPoolsV1PoolsGetData, CreatePoolV1PoolsPostData, DeletePoolV1PoolsPoolIdDeleteData, GetPoolV1PoolsPoolIdGetData, UpdatePoolV1PoolsPoolIdPatchData, RemoveMachinesFromPoolV1PoolsPoolIdMachinesDeleteData, AddMachinesToPoolV1PoolsPoolIdMachinesPostData, ListWorkflowsV1WorkflowsGetData, CreateWorkflowV1WorkflowsPostData, BulkAddTagsToWorkflowsV1WorkflowsBulkTagsPostData, DeleteWorkflowV1WorkflowsWorkflowIdDeleteData, GetWorkflowV1WorkflowsWorkflowIdGetData, UpdateWorkflowV1WorkflowsWorkflowIdPatchData, DuplicateWorkflowV1WorkflowsWorkflowIdDuplicatePostData, MergeWorkflowV1WorkflowsWorkflowIdMergePostData, GetWorkflowVersionsV1WorkflowsWorkflowIdVersionsGetData, DeleteWorkflowPromptImageV1WorkflowsPromptImageDeleteData, UploadWorkflowPromptImageV1WorkflowsPromptImagePostData, ListWorkflowPromptImagesV1WorkflowsPromptImagesGetData, GetWorkflowPromptImageSignedUrlV1WorkflowsPromptImageSignedUrlGetData, GetWorkflowTagsV1WorkflowsWorkflowIdTagsGetData, AddTagsToWorkflowV1WorkflowsWorkflowIdTagsPostData, RemoveTagFromWorkflowV1WorkflowsWorkflowIdTagsTagIdDeleteData, ListTagsV1WorkflowTagsGetData, CreateTagV1WorkflowTagsPostData, DeleteTagV1WorkflowTagsTagIdDeleteData, GetTagV1WorkflowTagsTagIdGetData, UpdateTagV1WorkflowTagsTagIdPatchData, ArchiveTagV1WorkflowTagsTagIdArchivePostData, UnarchiveTagV1WorkflowTagsTagIdUnarchivePostData, ReorderTagsV1WorkflowTagsReorderPutData, ListTagGroupsV1WorkflowTagGroupsGetData, CreateTagGroupV1WorkflowTagGroupsPostData, DeleteTagGroupV1WorkflowTagGroupsGroupIdDeleteData, GetTagGroupV1WorkflowTagGroupsGroupIdGetData, UpdateTagGroupV1WorkflowTagGroupsGroupIdPatchData, ReorderTagGroupsV1WorkflowTagGroupsReorderPutData, ListModelConfigurationsV1ModelConfigurationsGetData, CreateModelConfigurationV1ModelConfigurationsPostData, DeleteModelConfigurationV1ModelConfigurationsModelConfigurationIdDeleteData, GetModelConfigurationV1ModelConfigurationsModelConfigurationIdGetData, UpdateModelConfigurationV1ModelConfigurationsModelConfigurationIdPatchData, ListRunsV1RunsGetData, CreateRunV1RunsPostData, DeleteRunV1RunsRunIdDeleteData, GetRunV1RunsRunIdGetData, UpdateRunV1RunsRunIdPatchData, GetRunTrajectoryV1RunsRunIdTrajectoryGetData, GenerateRunTrajectoryV1RunsRunIdGenerateTrajectoryPostData, 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, DuplicateTrajectoryV1TrajectoriesTrajectoryIdDuplicatePostData, GetLatestTrajectoryForWorkflowV1WorkflowsWorkflowIdLatestTrajectoryGetData, GetScreenshotV1ComputerMachineIdDisplayScreenshotGetData, GetDisplayDimensionsV1ComputerMachineIdDisplayDimensionsGetData, KeyboardTypeV1ComputerMachineIdInputKeyboardTypePostData, KeyboardKeyV1ComputerMachineIdInputKeyboardKeyPostData, CopyToClipboardV1ComputerMachineIdCopyToClipboardPostData, GetMousePositionV1ComputerMachineIdInputMousePositionGetData, MouseMoveV1ComputerMachineIdInputMouseMovePostData, MouseClickV1ComputerMachineIdInputMouseClickPostData, MouseScrollV1ComputerMachineIdInputMouseScrollPostData, MouseDragV1ComputerMachineIdInputMouseDragPostData, FsListV1ComputerMachineIdFsListGetData, FsReadV1ComputerMachineIdFsReadGetData, FsWriteV1ComputerMachineIdFsWritePostData, PowershellExecV1ComputerMachineIdShellPowershellExecPostData, PowershellSessionV1ComputerMachineIdShellPowershellSessionPostData, CyberdriverShutdownV1MachinesMachineIdCyberdriverShutdownPostData, GetUsageAggregateV1UsageAggregateGetData, RootGetData, HealthLiveHealthLiveGetData, HealthReadyHealthReadyGetData, HealthHealthGetData, HealthDbHealthDbGetData, HealthMachinesV1HealthMachinesGetData } 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
|
|
@@ -26,7 +26,7 @@ export declare const healthCheckV1HealthGet: <ThrowOnError extends boolean = fal
|
|
|
26
26
|
* Database Health Check
|
|
27
27
|
* Database health check endpoint.
|
|
28
28
|
*
|
|
29
|
-
* Verifies database connectivity
|
|
29
|
+
* Verifies database connectivity without authentication.
|
|
30
30
|
*/
|
|
31
31
|
export declare const databaseHealthCheckV1HealthDbGet: <ThrowOnError extends boolean = false>(options?: Options<DatabaseHealthCheckV1HealthDbGetData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<unknown, unknown, ThrowOnError>;
|
|
32
32
|
/**
|
|
@@ -139,9 +139,10 @@ export declare const addMachinesToPoolV1PoolsPoolIdMachinesPost: <ThrowOnError e
|
|
|
139
139
|
* Supports pagination and returns workflows ordered by updated_at descending.
|
|
140
140
|
*
|
|
141
141
|
* Use `tag_ids` to filter workflows that have ALL specified tags (AND logic).
|
|
142
|
-
* Use `
|
|
142
|
+
* Use `include=tags,post_run_checks` to include related workflow resources.
|
|
143
|
+
* Legacy `include_tags=true` remains supported, but `include` wins when both are provided.
|
|
143
144
|
*/
|
|
144
|
-
export declare const listWorkflowsV1WorkflowsGet: <ThrowOnError extends boolean = false>(options?: Options<ListWorkflowsV1WorkflowsGetData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen").
|
|
145
|
+
export declare const listWorkflowsV1WorkflowsGet: <ThrowOnError extends boolean = false>(options?: Options<ListWorkflowsV1WorkflowsGetData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen").PaginatedResponseWithIncludesWorkflowResponse, import("./types.gen").HttpValidationError, ThrowOnError>;
|
|
145
146
|
/**
|
|
146
147
|
* Create Workflow
|
|
147
148
|
* Create a new workflow.
|
|
@@ -171,7 +172,7 @@ export declare const deleteWorkflowV1WorkflowsWorkflowIdDelete: <ThrowOnError ex
|
|
|
171
172
|
*
|
|
172
173
|
* The workflow must belong to the authenticated organization.
|
|
173
174
|
*/
|
|
174
|
-
export declare const getWorkflowV1WorkflowsWorkflowIdGet: <ThrowOnError extends boolean = false>(options: Options<GetWorkflowV1WorkflowsWorkflowIdGetData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen").
|
|
175
|
+
export declare const getWorkflowV1WorkflowsWorkflowIdGet: <ThrowOnError extends boolean = false>(options: Options<GetWorkflowV1WorkflowsWorkflowIdGetData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen").WorkflowResponseWithIncludes, import("./types.gen").HttpValidationError, ThrowOnError>;
|
|
175
176
|
/**
|
|
176
177
|
* Update Workflow
|
|
177
178
|
* Update a workflow's prompts.
|
|
@@ -396,7 +397,7 @@ export declare const listRunsV1RunsGet: <ThrowOnError extends boolean = false>(o
|
|
|
396
397
|
* If machine_id is not provided, an available machine will be automatically selected.
|
|
397
398
|
* The run will be created with SCHEDULING status and a Temporal workflow will be started asynchronously.
|
|
398
399
|
*/
|
|
399
|
-
export declare const createRunV1RunsPost: <ThrowOnError extends boolean = false>(options: Options<CreateRunV1RunsPostData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen").
|
|
400
|
+
export declare const createRunV1RunsPost: <ThrowOnError extends boolean = false>(options: Options<CreateRunV1RunsPostData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen").RunResponseOutput, import("./types.gen").HttpValidationError, ThrowOnError>;
|
|
400
401
|
/**
|
|
401
402
|
* Delete Run
|
|
402
403
|
* Delete a run.
|
|
@@ -423,7 +424,7 @@ export declare const getRunV1RunsRunIdGet: <ThrowOnError extends boolean = false
|
|
|
423
424
|
* Only the fields provided in the request body will be updated.
|
|
424
425
|
* The run must belong to the authenticated organization.
|
|
425
426
|
*/
|
|
426
|
-
export declare const updateRunV1RunsRunIdPatch: <ThrowOnError extends boolean = false>(options: Options<UpdateRunV1RunsRunIdPatchData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen").
|
|
427
|
+
export declare const updateRunV1RunsRunIdPatch: <ThrowOnError extends boolean = false>(options: Options<UpdateRunV1RunsRunIdPatchData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen").RunResponseOutput, import("./types.gen").HttpValidationError, ThrowOnError>;
|
|
427
428
|
/**
|
|
428
429
|
* Get Run Trajectory
|
|
429
430
|
* Get the latest trajectory associated with a run.
|
|
@@ -479,7 +480,7 @@ export declare const bulkCreateRunsV1RunsBulkPost: <ThrowOnError extends boolean
|
|
|
479
480
|
* - Optionally overrides inputs, sensitive inputs, session/machine/pools.
|
|
480
481
|
* - Triggers immediate assignment attempt unless the session is busy.
|
|
481
482
|
*/
|
|
482
|
-
export declare const retryRunV1RunsRunIdRetryPost: <ThrowOnError extends boolean = false>(options: Options<RetryRunV1RunsRunIdRetryPostData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen").
|
|
483
|
+
export declare const retryRunV1RunsRunIdRetryPost: <ThrowOnError extends boolean = false>(options: Options<RetryRunV1RunsRunIdRetryPostData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen").RunResponseOutput, import("./types.gen").HttpValidationError, ThrowOnError>;
|
|
483
484
|
/**
|
|
484
485
|
* List Run Attachments
|
|
485
486
|
* List all run attachments for the authenticated organization.
|
|
@@ -683,16 +684,6 @@ export declare const getScreenshotV1ComputerMachineIdDisplayScreenshotGet: <Thro
|
|
|
683
684
|
* Get the display dimensions of the machine.
|
|
684
685
|
*/
|
|
685
686
|
export declare const getDisplayDimensionsV1ComputerMachineIdDisplayDimensionsGet: <ThrowOnError extends boolean = false>(options: Options<GetDisplayDimensionsV1ComputerMachineIdDisplayDimensionsGetData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen").DisplayDimensions, import("./types.gen").HttpValidationError, ThrowOnError>;
|
|
686
|
-
/**
|
|
687
|
-
* Create an ad hoc computer task
|
|
688
|
-
*/
|
|
689
|
-
export declare const createAdHocComputerTaskV1ComputerMachineIdTaskPost: <ThrowOnError extends boolean = false>(options: Options<CreateAdHocComputerTaskV1ComputerMachineIdTaskPostData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen").ComputerTaskAcceptedResponse, import("./types.gen").HttpValidationError, ThrowOnError>;
|
|
690
|
-
/**
|
|
691
|
-
* Notify Cyberdriver task completion
|
|
692
|
-
*/
|
|
693
|
-
export declare const notifyTaskDoneV1ComputerMachineIdTaskDonePost: <ThrowOnError extends boolean = false>(options: Options<NotifyTaskDoneV1ComputerMachineIdTaskDonePostData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<{
|
|
694
|
-
[key: string]: unknown;
|
|
695
|
-
}, import("./types.gen").HttpValidationError, ThrowOnError>;
|
|
696
687
|
/**
|
|
697
688
|
* Type text
|
|
698
689
|
* Type text on the machine's keyboard.
|
package/dist/client/sdk.gen.js
CHANGED
|
@@ -2,8 +2,8 @@
|
|
|
2
2
|
// This file is auto-generated by @hey-api/openapi-ts
|
|
3
3
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
4
|
exports.getModelConfigurationV1ModelConfigurationsModelConfigurationIdGet = exports.deleteModelConfigurationV1ModelConfigurationsModelConfigurationIdDelete = exports.createModelConfigurationV1ModelConfigurationsPost = exports.listModelConfigurationsV1ModelConfigurationsGet = exports.reorderTagGroupsV1WorkflowTagGroupsReorderPut = exports.updateTagGroupV1WorkflowTagGroupsGroupIdPatch = exports.getTagGroupV1WorkflowTagGroupsGroupIdGet = exports.deleteTagGroupV1WorkflowTagGroupsGroupIdDelete = exports.createTagGroupV1WorkflowTagGroupsPost = exports.listTagGroupsV1WorkflowTagGroupsGet = exports.reorderTagsV1WorkflowTagsReorderPut = exports.unarchiveTagV1WorkflowTagsTagIdUnarchivePost = exports.archiveTagV1WorkflowTagsTagIdArchivePost = exports.updateTagV1WorkflowTagsTagIdPatch = exports.getTagV1WorkflowTagsTagIdGet = exports.deleteTagV1WorkflowTagsTagIdDelete = exports.createTagV1WorkflowTagsPost = exports.listTagsV1WorkflowTagsGet = exports.removeTagFromWorkflowV1WorkflowsWorkflowIdTagsTagIdDelete = exports.addTagsToWorkflowV1WorkflowsWorkflowIdTagsPost = exports.getWorkflowTagsV1WorkflowsWorkflowIdTagsGet = exports.getWorkflowPromptImageSignedUrlV1WorkflowsPromptImageSignedUrlGet = exports.listWorkflowPromptImagesV1WorkflowsPromptImagesGet = exports.uploadWorkflowPromptImageV1WorkflowsPromptImagePost = exports.deleteWorkflowPromptImageV1WorkflowsPromptImageDelete = exports.getWorkflowVersionsV1WorkflowsWorkflowIdVersionsGet = exports.mergeWorkflowV1WorkflowsWorkflowIdMergePost = exports.duplicateWorkflowV1WorkflowsWorkflowIdDuplicatePost = exports.updateWorkflowV1WorkflowsWorkflowIdPatch = exports.getWorkflowV1WorkflowsWorkflowIdGet = exports.deleteWorkflowV1WorkflowsWorkflowIdDelete = exports.bulkAddTagsToWorkflowsV1WorkflowsBulkTagsPost = 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.fsWriteV1ComputerMachineIdFsWritePost = exports.fsReadV1ComputerMachineIdFsReadGet = exports.fsListV1ComputerMachineIdFsListGet = exports.mouseDragV1ComputerMachineIdInputMouseDragPost = exports.mouseScrollV1ComputerMachineIdInputMouseScrollPost = exports.mouseClickV1ComputerMachineIdInputMouseClickPost = exports.mouseMoveV1ComputerMachineIdInputMouseMovePost = exports.getMousePositionV1ComputerMachineIdInputMousePositionGet = exports.copyToClipboardV1ComputerMachineIdCopyToClipboardPost = exports.keyboardKeyV1ComputerMachineIdInputKeyboardKeyPost = exports.keyboardTypeV1ComputerMachineIdInputKeyboardTypePost = exports.
|
|
6
|
-
exports.healthMachinesV1HealthMachinesGet = exports.healthDbHealthDbGet = exports.healthHealthGet = exports.healthReadyHealthReadyGet = exports.healthLiveHealthLiveGet = exports.rootGet = exports.getUsageAggregateV1UsageAggregateGet = exports.cyberdriverShutdownV1MachinesMachineIdCyberdriverShutdownPost =
|
|
5
|
+
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.duplicateTrajectoryV1TrajectoriesTrajectoryIdDuplicatePost = 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.retryRunV1RunsRunIdRetryPost = exports.bulkCreateRunsV1RunsBulkPost = exports.createRunChainV1RunsChainPost = exports.generateRunTrajectoryV1RunsRunIdGenerateTrajectoryPost = exports.getRunTrajectoryV1RunsRunIdTrajectoryGet = exports.updateRunV1RunsRunIdPatch = exports.getRunV1RunsRunIdGet = exports.deleteRunV1RunsRunIdDelete = exports.createRunV1RunsPost = exports.listRunsV1RunsGet = exports.updateModelConfigurationV1ModelConfigurationsModelConfigurationIdPatch = void 0;
|
|
6
|
+
exports.healthMachinesV1HealthMachinesGet = exports.healthDbHealthDbGet = exports.healthHealthGet = exports.healthReadyHealthReadyGet = exports.healthLiveHealthLiveGet = exports.rootGet = exports.getUsageAggregateV1UsageAggregateGet = exports.cyberdriverShutdownV1MachinesMachineIdCyberdriverShutdownPost = void 0;
|
|
7
7
|
const client_fetch_1 = require("@hey-api/client-fetch");
|
|
8
8
|
const client_gen_1 = require("./client.gen");
|
|
9
9
|
/**
|
|
@@ -21,7 +21,7 @@ exports.healthCheckV1HealthGet = healthCheckV1HealthGet;
|
|
|
21
21
|
* Database Health Check
|
|
22
22
|
* Database health check endpoint.
|
|
23
23
|
*
|
|
24
|
-
* Verifies database connectivity
|
|
24
|
+
* Verifies database connectivity without authentication.
|
|
25
25
|
*/
|
|
26
26
|
const databaseHealthCheckV1HealthDbGet = (options) => {
|
|
27
27
|
var _a;
|
|
@@ -264,7 +264,8 @@ exports.addMachinesToPoolV1PoolsPoolIdMachinesPost = addMachinesToPoolV1PoolsPoo
|
|
|
264
264
|
* Supports pagination and returns workflows ordered by updated_at descending.
|
|
265
265
|
*
|
|
266
266
|
* Use `tag_ids` to filter workflows that have ALL specified tags (AND logic).
|
|
267
|
-
* Use `
|
|
267
|
+
* Use `include=tags,post_run_checks` to include related workflow resources.
|
|
268
|
+
* Legacy `include_tags=true` remains supported, but `include` wins when both are provided.
|
|
268
269
|
*/
|
|
269
270
|
const listWorkflowsV1WorkflowsGet = (options) => {
|
|
270
271
|
var _a;
|
|
@@ -1445,32 +1446,6 @@ const getDisplayDimensionsV1ComputerMachineIdDisplayDimensionsGet = (options) =>
|
|
|
1445
1446
|
], url: '/v1/computer/{machine_id}/display/dimensions' }, options));
|
|
1446
1447
|
};
|
|
1447
1448
|
exports.getDisplayDimensionsV1ComputerMachineIdDisplayDimensionsGet = getDisplayDimensionsV1ComputerMachineIdDisplayDimensionsGet;
|
|
1448
|
-
/**
|
|
1449
|
-
* Create an ad hoc computer task
|
|
1450
|
-
*/
|
|
1451
|
-
const createAdHocComputerTaskV1ComputerMachineIdTaskPost = (options) => {
|
|
1452
|
-
var _a;
|
|
1453
|
-
return ((_a = options.client) !== null && _a !== void 0 ? _a : client_gen_1.client).post(Object.assign(Object.assign({ security: [
|
|
1454
|
-
{
|
|
1455
|
-
scheme: 'bearer',
|
|
1456
|
-
type: 'http'
|
|
1457
|
-
}
|
|
1458
|
-
], url: '/v1/computer/{machine_id}/task' }, options), { headers: Object.assign({ 'Content-Type': 'application/json' }, options === null || options === void 0 ? void 0 : options.headers) }));
|
|
1459
|
-
};
|
|
1460
|
-
exports.createAdHocComputerTaskV1ComputerMachineIdTaskPost = createAdHocComputerTaskV1ComputerMachineIdTaskPost;
|
|
1461
|
-
/**
|
|
1462
|
-
* Notify Cyberdriver task completion
|
|
1463
|
-
*/
|
|
1464
|
-
const notifyTaskDoneV1ComputerMachineIdTaskDonePost = (options) => {
|
|
1465
|
-
var _a;
|
|
1466
|
-
return ((_a = options.client) !== null && _a !== void 0 ? _a : client_gen_1.client).post(Object.assign({ security: [
|
|
1467
|
-
{
|
|
1468
|
-
scheme: 'bearer',
|
|
1469
|
-
type: 'http'
|
|
1470
|
-
}
|
|
1471
|
-
], url: '/v1/computer/{machine_id}/task-done' }, options));
|
|
1472
|
-
};
|
|
1473
|
-
exports.notifyTaskDoneV1ComputerMachineIdTaskDonePost = notifyTaskDoneV1ComputerMachineIdTaskDonePost;
|
|
1474
1449
|
/**
|
|
1475
1450
|
* Type text
|
|
1476
1451
|
* Type text on the machine's keyboard.
|
|
@@ -49,14 +49,6 @@ export type ChainStep = {
|
|
|
49
49
|
[key: string]: unknown;
|
|
50
50
|
} | null;
|
|
51
51
|
};
|
|
52
|
-
export type ComputerTaskAcceptedResponse = {
|
|
53
|
-
task_id: string;
|
|
54
|
-
machine_id: string;
|
|
55
|
-
status?: string;
|
|
56
|
-
};
|
|
57
|
-
export type ComputerTaskObjectRequest = {
|
|
58
|
-
task: string;
|
|
59
|
-
};
|
|
60
52
|
/**
|
|
61
53
|
* Schema for creating a connection
|
|
62
54
|
*/
|
|
@@ -514,7 +506,7 @@ export type PaginatedResponseWithIncludesPoolResponse = {
|
|
|
514
506
|
included?: Array<IncludedResource> | null;
|
|
515
507
|
};
|
|
516
508
|
export type PaginatedResponseWithIncludesRunResponse = {
|
|
517
|
-
items: Array<
|
|
509
|
+
items: Array<RunResponseOutput>;
|
|
518
510
|
total: number;
|
|
519
511
|
skip: number;
|
|
520
512
|
limit: number;
|
|
@@ -533,20 +525,24 @@ export type PaginatedResponseWithIncludesTrajectoryResponse = {
|
|
|
533
525
|
*/
|
|
534
526
|
included?: Array<IncludedResource> | null;
|
|
535
527
|
};
|
|
536
|
-
export type
|
|
537
|
-
items: Array<
|
|
528
|
+
export type PaginatedResponseWithIncludesWorkflowResponse = {
|
|
529
|
+
items: Array<WorkflowResponse>;
|
|
538
530
|
total: number;
|
|
539
531
|
skip: number;
|
|
540
532
|
limit: number;
|
|
533
|
+
/**
|
|
534
|
+
* Related resources requested via the `include` query parameter
|
|
535
|
+
*/
|
|
536
|
+
included?: Array<IncludedResource> | null;
|
|
541
537
|
};
|
|
542
|
-
export type
|
|
543
|
-
items: Array<
|
|
538
|
+
export type PaginatedResponseConnectionResponse = {
|
|
539
|
+
items: Array<ConnectionResponse>;
|
|
544
540
|
total: number;
|
|
545
541
|
skip: number;
|
|
546
542
|
limit: number;
|
|
547
543
|
};
|
|
548
|
-
export type
|
|
549
|
-
items: Array<
|
|
544
|
+
export type PaginatedResponseRunAttachmentResponse = {
|
|
545
|
+
items: Array<RunAttachmentResponse>;
|
|
550
546
|
total: number;
|
|
551
547
|
skip: number;
|
|
552
548
|
limit: number;
|
|
@@ -619,6 +615,9 @@ export type PoolWithMachines = {
|
|
|
619
615
|
machine_count?: number | null;
|
|
620
616
|
machines?: Array<MachineResponse>;
|
|
621
617
|
};
|
|
618
|
+
export type PostRunCheckFileTargetMode = 'exact' | 'regex' | 'loop_items';
|
|
619
|
+
export type PostRunCheckStatus = 'pending' | 'running' | 'success' | 'failed' | 'infra_error' | 'cancelled';
|
|
620
|
+
export type PostRunCheckType = 'run_attachment_exists' | 'run_attachment_image_check' | 'output_data_passes_schema_validation' | 'output_data_agentic_check';
|
|
622
621
|
export type PowerShellExecRequest = {
|
|
623
622
|
/**
|
|
624
623
|
* PowerShell command to execute
|
|
@@ -801,7 +800,7 @@ export type RunBulkCreate = {
|
|
|
801
800
|
* Response for bulk run creation
|
|
802
801
|
*/
|
|
803
802
|
export type RunBulkCreateResponse = {
|
|
804
|
-
created_runs: Array<
|
|
803
|
+
created_runs: Array<RunResponseOutput>;
|
|
805
804
|
failed_count?: number;
|
|
806
805
|
errors?: Array<string>;
|
|
807
806
|
};
|
|
@@ -824,7 +823,7 @@ export type RunCompletedEvent = {
|
|
|
824
823
|
/**
|
|
825
824
|
* The completed run data
|
|
826
825
|
*/
|
|
827
|
-
run:
|
|
826
|
+
run: RunResponseInput;
|
|
828
827
|
};
|
|
829
828
|
/**
|
|
830
829
|
* Schema for creating a run
|
|
@@ -878,16 +877,41 @@ export type RunCreate = {
|
|
|
878
877
|
* These are optional fields beyond the essential identifiers that are always returned
|
|
879
878
|
* (id, workflow_id, machine_id, status, created_at).
|
|
880
879
|
*/
|
|
881
|
-
export type RunField = 'user_id' | 'organization_id' | '
|
|
882
|
-
export type RunKind = 'workflow' | 'ad_hoc';
|
|
880
|
+
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' | 'post_run_checks' | 'machine_id';
|
|
883
881
|
export type RunListSortMode = 'activity' | 'created_at_desc';
|
|
882
|
+
/**
|
|
883
|
+
* Version-tolerant run-level snapshot/result for one post-run check invocation.
|
|
884
|
+
*/
|
|
885
|
+
export type RunPostRunCheckSnapshot = {
|
|
886
|
+
id?: string | null;
|
|
887
|
+
post_run_check_id?: string | null;
|
|
888
|
+
snapshot_version?: number | null;
|
|
889
|
+
name?: string | null;
|
|
890
|
+
description?: string | null;
|
|
891
|
+
type?: PostRunCheckType | null;
|
|
892
|
+
order?: number | null;
|
|
893
|
+
file_target_mode?: PostRunCheckFileTargetMode | null;
|
|
894
|
+
file_names?: Array<string> | null;
|
|
895
|
+
file_name_regex?: string | null;
|
|
896
|
+
expected_match_count?: number | null;
|
|
897
|
+
expected_match_count_ref?: string | null;
|
|
898
|
+
loop_input?: string | null;
|
|
899
|
+
loop_item_filename_template?: string | null;
|
|
900
|
+
check_prompt?: string | null;
|
|
901
|
+
model?: string | null;
|
|
902
|
+
status: PostRunCheckStatus;
|
|
903
|
+
started_at?: string | null;
|
|
904
|
+
ended_at?: string | null;
|
|
905
|
+
error_message?: string | null;
|
|
906
|
+
messages?: Array<string> | null;
|
|
907
|
+
matched_filenames?: Array<string> | null;
|
|
908
|
+
[key: string]: unknown | (string | null) | (string | null) | (number | null) | (string | null) | (string | null) | (PostRunCheckType | null) | (number | null) | (PostRunCheckFileTargetMode | null) | (Array<string> | null) | (string | null) | (number | null) | (string | null) | (string | null) | (string | null) | (string | null) | (string | null) | PostRunCheckStatus | (string | null) | (string | null) | (string | null) | (Array<string> | null) | (Array<string> | null) | undefined;
|
|
909
|
+
};
|
|
884
910
|
/**
|
|
885
911
|
* Run response schema
|
|
886
912
|
*/
|
|
887
|
-
export type
|
|
888
|
-
workflow_id: string
|
|
889
|
-
run_kind: RunKind;
|
|
890
|
-
ad_hoc_task?: string | null;
|
|
913
|
+
export type RunResponseInput = {
|
|
914
|
+
workflow_id: string;
|
|
891
915
|
machine_id: string | null;
|
|
892
916
|
id: string;
|
|
893
917
|
user_id?: string | null;
|
|
@@ -915,6 +939,53 @@ export type RunResponse = {
|
|
|
915
939
|
usage_metadata?: {
|
|
916
940
|
[key: string]: unknown;
|
|
917
941
|
} | null;
|
|
942
|
+
/**
|
|
943
|
+
* Version-tolerant snapshot/results for the run's post-run checks.
|
|
944
|
+
*/
|
|
945
|
+
post_run_checks?: Array<RunPostRunCheckSnapshot> | null;
|
|
946
|
+
session_id?: string | null;
|
|
947
|
+
session_alias?: string | null;
|
|
948
|
+
release_session_after?: boolean | null;
|
|
949
|
+
created_at: string;
|
|
950
|
+
started_at?: string | null;
|
|
951
|
+
ended_at?: string | null;
|
|
952
|
+
};
|
|
953
|
+
/**
|
|
954
|
+
* Run response schema
|
|
955
|
+
*/
|
|
956
|
+
export type RunResponseOutput = {
|
|
957
|
+
workflow_id: string;
|
|
958
|
+
machine_id: string | null;
|
|
959
|
+
id: string;
|
|
960
|
+
user_id?: string | null;
|
|
961
|
+
organization_id?: string | null;
|
|
962
|
+
status: RunStatus;
|
|
963
|
+
error?: Array<string> | null;
|
|
964
|
+
output_data?: {
|
|
965
|
+
[key: string]: unknown;
|
|
966
|
+
} | null;
|
|
967
|
+
input_attachment_ids?: Array<string> | null;
|
|
968
|
+
output_attachment_ids?: Array<string> | null;
|
|
969
|
+
run_message_history?: Array<{
|
|
970
|
+
[key: string]: unknown;
|
|
971
|
+
}> | null;
|
|
972
|
+
input_values?: {
|
|
973
|
+
[key: string]: unknown;
|
|
974
|
+
} | null;
|
|
975
|
+
pool_ids?: Array<string> | null;
|
|
976
|
+
sensitive_input_aliases?: {
|
|
977
|
+
[key: string]: string;
|
|
978
|
+
} | null;
|
|
979
|
+
/**
|
|
980
|
+
* Arbitrary usage/billing metadata captured during a run (schema is flexible)
|
|
981
|
+
*/
|
|
982
|
+
usage_metadata?: {
|
|
983
|
+
[key: string]: unknown;
|
|
984
|
+
} | null;
|
|
985
|
+
/**
|
|
986
|
+
* Version-tolerant snapshot/results for the run's post-run checks.
|
|
987
|
+
*/
|
|
988
|
+
post_run_checks?: Array<RunPostRunCheckSnapshot> | null;
|
|
918
989
|
session_id?: string | null;
|
|
919
990
|
session_alias?: string | null;
|
|
920
991
|
release_session_after?: boolean | null;
|
|
@@ -932,9 +1003,7 @@ export type RunResponse = {
|
|
|
932
1003
|
*/
|
|
933
1004
|
export type RunResponseWithIncludes = {
|
|
934
1005
|
id: string;
|
|
935
|
-
workflow_id: string
|
|
936
|
-
run_kind: RunKind;
|
|
937
|
-
ad_hoc_task?: string | null;
|
|
1006
|
+
workflow_id: string;
|
|
938
1007
|
machine_id?: string | null;
|
|
939
1008
|
user_id?: string | null;
|
|
940
1009
|
organization_id?: string | null;
|
|
@@ -961,6 +1030,10 @@ export type RunResponseWithIncludes = {
|
|
|
961
1030
|
usage_metadata?: {
|
|
962
1031
|
[key: string]: unknown;
|
|
963
1032
|
} | null;
|
|
1033
|
+
/**
|
|
1034
|
+
* Version-tolerant snapshot/results for the run's post-run checks.
|
|
1035
|
+
*/
|
|
1036
|
+
post_run_checks?: Array<RunPostRunCheckSnapshot> | null;
|
|
964
1037
|
session_id?: string | null;
|
|
965
1038
|
session_alias?: string | null;
|
|
966
1039
|
release_session_after?: boolean | null;
|
|
@@ -1026,7 +1099,7 @@ export type RunRetry = {
|
|
|
1026
1099
|
*/
|
|
1027
1100
|
release_session_after?: boolean | null;
|
|
1028
1101
|
};
|
|
1029
|
-
export type RunStatus = 'scheduling' | 'running' | 'success' | 'cancelled' | 'task_failed' | 'error';
|
|
1102
|
+
export type RunStatus = 'scheduling' | 'running' | 'running_checks' | 'success' | 'cancelled' | 'task_failed' | 'error';
|
|
1030
1103
|
/**
|
|
1031
1104
|
* Schema for updating a run
|
|
1032
1105
|
*/
|
|
@@ -1046,6 +1119,7 @@ export type RunUpdate = {
|
|
|
1046
1119
|
usage_metadata?: {
|
|
1047
1120
|
[key: string]: unknown;
|
|
1048
1121
|
} | null;
|
|
1122
|
+
post_run_checks?: Array<RunPostRunCheckSnapshot> | null;
|
|
1049
1123
|
started_at?: string | null;
|
|
1050
1124
|
ended_at?: string | null;
|
|
1051
1125
|
release_session_after?: boolean | null;
|
|
@@ -1060,7 +1134,7 @@ export type RunUpdate = {
|
|
|
1060
1134
|
export type TrajectoryCreate = {
|
|
1061
1135
|
name?: string | null;
|
|
1062
1136
|
description?: string | null;
|
|
1063
|
-
workflow_id: string
|
|
1137
|
+
workflow_id: string;
|
|
1064
1138
|
/**
|
|
1065
1139
|
* Optional run that created this trajectory
|
|
1066
1140
|
*/
|
|
@@ -1091,7 +1165,7 @@ export type TrajectoryCreate = {
|
|
|
1091
1165
|
export type TrajectoryResponse = {
|
|
1092
1166
|
name?: string | null;
|
|
1093
1167
|
description?: string | null;
|
|
1094
|
-
workflow_id: string
|
|
1168
|
+
workflow_id: string;
|
|
1095
1169
|
/**
|
|
1096
1170
|
* Optional run that created this trajectory
|
|
1097
1171
|
*/
|
|
@@ -1124,7 +1198,7 @@ export type TrajectoryResponse = {
|
|
|
1124
1198
|
*/
|
|
1125
1199
|
export type TrajectoryResponseWithIncludes = {
|
|
1126
1200
|
id: string;
|
|
1127
|
-
workflow_id: string
|
|
1201
|
+
workflow_id: string;
|
|
1128
1202
|
run_id?: string | null;
|
|
1129
1203
|
user_id?: string | null;
|
|
1130
1204
|
organization_id?: string | null;
|
|
@@ -1248,6 +1322,10 @@ export type WorkflowCreate = {
|
|
|
1248
1322
|
* Optional workflow-level model configuration metadata (main agent, cache detection, and fallbacks).
|
|
1249
1323
|
*/
|
|
1250
1324
|
model_metadata?: WorkflowModelMetadata | null;
|
|
1325
|
+
/**
|
|
1326
|
+
* Workflow-managed post-run checks, reconciled on save.
|
|
1327
|
+
*/
|
|
1328
|
+
post_run_checks?: Array<WorkflowPostRunCheckUpsert> | null;
|
|
1251
1329
|
};
|
|
1252
1330
|
/**
|
|
1253
1331
|
* Schema for duplicating workflows.
|
|
@@ -1329,6 +1407,53 @@ export type WorkflowModelMetadata = {
|
|
|
1329
1407
|
*/
|
|
1330
1408
|
fallback_model_2_id?: string | null;
|
|
1331
1409
|
};
|
|
1410
|
+
/**
|
|
1411
|
+
* Workflow response shape for post-run checks, including workflow-specific order.
|
|
1412
|
+
*/
|
|
1413
|
+
export type WorkflowPostRunCheckResponse = {
|
|
1414
|
+
name: string;
|
|
1415
|
+
description?: string | null;
|
|
1416
|
+
type: PostRunCheckType;
|
|
1417
|
+
file_target_mode?: PostRunCheckFileTargetMode | null;
|
|
1418
|
+
file_names?: Array<string> | null;
|
|
1419
|
+
file_name_regex?: string | null;
|
|
1420
|
+
expected_match_count?: number | null;
|
|
1421
|
+
expected_match_count_ref?: string | null;
|
|
1422
|
+
loop_input?: string | null;
|
|
1423
|
+
loop_item_filename_template?: string | null;
|
|
1424
|
+
check_prompt?: string | null;
|
|
1425
|
+
/**
|
|
1426
|
+
* Optional ModelConfiguration id override for agentic post-run checks.
|
|
1427
|
+
*/
|
|
1428
|
+
model?: string | null;
|
|
1429
|
+
id: string;
|
|
1430
|
+
organization_id: string;
|
|
1431
|
+
user_id?: string | null;
|
|
1432
|
+
order: number;
|
|
1433
|
+
created_at: string;
|
|
1434
|
+
updated_at: string;
|
|
1435
|
+
};
|
|
1436
|
+
/**
|
|
1437
|
+
* Create/update payload for workflow-managed post-run checks.
|
|
1438
|
+
*/
|
|
1439
|
+
export type WorkflowPostRunCheckUpsert = {
|
|
1440
|
+
name: string;
|
|
1441
|
+
description?: string | null;
|
|
1442
|
+
type: PostRunCheckType;
|
|
1443
|
+
file_target_mode?: PostRunCheckFileTargetMode | null;
|
|
1444
|
+
file_names?: Array<string> | null;
|
|
1445
|
+
file_name_regex?: string | null;
|
|
1446
|
+
expected_match_count?: number | null;
|
|
1447
|
+
expected_match_count_ref?: string | null;
|
|
1448
|
+
loop_input?: string | null;
|
|
1449
|
+
loop_item_filename_template?: string | null;
|
|
1450
|
+
check_prompt?: string | null;
|
|
1451
|
+
/**
|
|
1452
|
+
* Optional ModelConfiguration id override for agentic post-run checks.
|
|
1453
|
+
*/
|
|
1454
|
+
model?: string | null;
|
|
1455
|
+
id?: string | null;
|
|
1456
|
+
};
|
|
1332
1457
|
/**
|
|
1333
1458
|
* Schema for an item in the workflow prompt images list
|
|
1334
1459
|
*/
|
|
@@ -1439,6 +1564,62 @@ export type WorkflowResponse = {
|
|
|
1439
1564
|
* Tags assigned to this workflow
|
|
1440
1565
|
*/
|
|
1441
1566
|
tags?: Array<WorkflowTagResponse> | null;
|
|
1567
|
+
/**
|
|
1568
|
+
* Post-run checks assigned to this workflow.
|
|
1569
|
+
*/
|
|
1570
|
+
post_run_checks?: Array<WorkflowPostRunCheckResponse> | null;
|
|
1571
|
+
};
|
|
1572
|
+
/**
|
|
1573
|
+
* Workflow response with optional included related resources.
|
|
1574
|
+
*/
|
|
1575
|
+
export type WorkflowResponseWithIncludes = {
|
|
1576
|
+
name?: string | null;
|
|
1577
|
+
main_prompt: string;
|
|
1578
|
+
/**
|
|
1579
|
+
* JSON schema for validating merged run inputs. Sensitive root keys are exposed with a '$' prefix in schema validation (for example sensitive_input_values.api_key -> '$api_key').
|
|
1580
|
+
*/
|
|
1581
|
+
input_schema?: string | null;
|
|
1582
|
+
/**
|
|
1583
|
+
* JSON schema for output data transformation
|
|
1584
|
+
*/
|
|
1585
|
+
output_schema?: string | null;
|
|
1586
|
+
/**
|
|
1587
|
+
* Enable AI-based file export detection
|
|
1588
|
+
*/
|
|
1589
|
+
includes_file_exports?: boolean;
|
|
1590
|
+
/**
|
|
1591
|
+
* Send webhook on run completion
|
|
1592
|
+
*/
|
|
1593
|
+
is_webhooks_enabled?: boolean;
|
|
1594
|
+
/**
|
|
1595
|
+
* Optional workflow-level model configuration metadata (main agent, cache detection, and fallbacks).
|
|
1596
|
+
*/
|
|
1597
|
+
model_metadata?: WorkflowModelMetadata | null;
|
|
1598
|
+
id: string;
|
|
1599
|
+
user_id?: string | null;
|
|
1600
|
+
organization_id?: string | null;
|
|
1601
|
+
includes_input_variables?: boolean;
|
|
1602
|
+
/**
|
|
1603
|
+
* Internal workflow metadata used for run/error tracking.
|
|
1604
|
+
*/
|
|
1605
|
+
workflow_metadata?: WorkflowInternalMetadata | null;
|
|
1606
|
+
old_versions?: Array<{
|
|
1607
|
+
[key: string]: unknown;
|
|
1608
|
+
}> | null;
|
|
1609
|
+
created_at: string;
|
|
1610
|
+
updated_at: string;
|
|
1611
|
+
/**
|
|
1612
|
+
* Tags assigned to this workflow
|
|
1613
|
+
*/
|
|
1614
|
+
tags?: Array<WorkflowTagResponse> | null;
|
|
1615
|
+
/**
|
|
1616
|
+
* Post-run checks assigned to this workflow.
|
|
1617
|
+
*/
|
|
1618
|
+
post_run_checks?: Array<WorkflowPostRunCheckResponse> | null;
|
|
1619
|
+
/**
|
|
1620
|
+
* Related resources requested via the `include` query parameter
|
|
1621
|
+
*/
|
|
1622
|
+
included?: Array<IncludedResource> | null;
|
|
1442
1623
|
};
|
|
1443
1624
|
/**
|
|
1444
1625
|
* Schema for creating a workflow tag
|
|
@@ -1559,6 +1740,10 @@ export type WorkflowUpdate = {
|
|
|
1559
1740
|
* Optional internal workflow metadata patch. Top-level null clears all workflow metadata. Omit this field to leave existing metadata unchanged. Set individual keys to null to remove only those keys.
|
|
1560
1741
|
*/
|
|
1561
1742
|
workflow_metadata?: WorkflowInternalMetadataUpdate | null;
|
|
1743
|
+
/**
|
|
1744
|
+
* Workflow-managed post-run checks, reconciled on save when present.
|
|
1745
|
+
*/
|
|
1746
|
+
post_run_checks?: Array<WorkflowPostRunCheckUpsert> | null;
|
|
1562
1747
|
};
|
|
1563
1748
|
export type HealthCheckV1HealthGetData = {
|
|
1564
1749
|
body?: never;
|
|
@@ -2017,6 +2202,10 @@ export type ListWorkflowsV1WorkflowsGetData = {
|
|
|
2017
2202
|
* Include tags in the response
|
|
2018
2203
|
*/
|
|
2019
2204
|
include_tags?: boolean;
|
|
2205
|
+
/**
|
|
2206
|
+
* Comma-separated list of related resources to include. Allowed values: tags, post_run_checks. If provided, overrides legacy include_tags.
|
|
2207
|
+
*/
|
|
2208
|
+
include?: string | null;
|
|
2020
2209
|
skip?: number;
|
|
2021
2210
|
limit?: number;
|
|
2022
2211
|
};
|
|
@@ -2033,7 +2222,7 @@ export type ListWorkflowsV1WorkflowsGetResponses = {
|
|
|
2033
2222
|
/**
|
|
2034
2223
|
* Successful Response
|
|
2035
2224
|
*/
|
|
2036
|
-
200:
|
|
2225
|
+
200: PaginatedResponseWithIncludesWorkflowResponse;
|
|
2037
2226
|
};
|
|
2038
2227
|
export type ListWorkflowsV1WorkflowsGetResponse = ListWorkflowsV1WorkflowsGetResponses[keyof ListWorkflowsV1WorkflowsGetResponses];
|
|
2039
2228
|
export type CreateWorkflowV1WorkflowsPostData = {
|
|
@@ -2121,7 +2310,12 @@ export type GetWorkflowV1WorkflowsWorkflowIdGetData = {
|
|
|
2121
2310
|
path: {
|
|
2122
2311
|
workflow_id: string;
|
|
2123
2312
|
};
|
|
2124
|
-
query?:
|
|
2313
|
+
query?: {
|
|
2314
|
+
/**
|
|
2315
|
+
* Comma-separated list of related resources to include. Allowed values: tags, post_run_checks. Defaults to tags and post_run_checks when omitted.
|
|
2316
|
+
*/
|
|
2317
|
+
include?: string | null;
|
|
2318
|
+
};
|
|
2125
2319
|
url: '/v1/workflows/{workflow_id}';
|
|
2126
2320
|
};
|
|
2127
2321
|
export type GetWorkflowV1WorkflowsWorkflowIdGetErrors = {
|
|
@@ -2135,7 +2329,7 @@ export type GetWorkflowV1WorkflowsWorkflowIdGetResponses = {
|
|
|
2135
2329
|
/**
|
|
2136
2330
|
* Successful Response
|
|
2137
2331
|
*/
|
|
2138
|
-
200:
|
|
2332
|
+
200: WorkflowResponseWithIncludes;
|
|
2139
2333
|
};
|
|
2140
2334
|
export type GetWorkflowV1WorkflowsWorkflowIdGetResponse = GetWorkflowV1WorkflowsWorkflowIdGetResponses[keyof GetWorkflowV1WorkflowsWorkflowIdGetResponses];
|
|
2141
2335
|
export type UpdateWorkflowV1WorkflowsWorkflowIdPatchData = {
|
|
@@ -2899,10 +3093,6 @@ export type ListRunsV1RunsGetData = {
|
|
|
2899
3093
|
* Filter by workflow ID
|
|
2900
3094
|
*/
|
|
2901
3095
|
workflow_id?: string | null;
|
|
2902
|
-
/**
|
|
2903
|
-
* Filter by run kind
|
|
2904
|
-
*/
|
|
2905
|
-
run_kind?: RunKind | null;
|
|
2906
3096
|
/**
|
|
2907
3097
|
* Filter by machine ID
|
|
2908
3098
|
*/
|
|
@@ -2936,7 +3126,7 @@ export type ListRunsV1RunsGetData = {
|
|
|
2936
3126
|
*/
|
|
2937
3127
|
deep_search?: boolean;
|
|
2938
3128
|
/**
|
|
2939
|
-
* Optional list of fields to include per run. Always includes: id, workflow_id,
|
|
3129
|
+
* Optional list of fields to include per run. Always includes: id, workflow_id, machine_id, status, created_at. Provide multiple 'fields=' params to include more.
|
|
2940
3130
|
*/
|
|
2941
3131
|
fields?: Array<RunField> | null;
|
|
2942
3132
|
/**
|
|
@@ -2985,7 +3175,7 @@ export type CreateRunV1RunsPostResponses = {
|
|
|
2985
3175
|
/**
|
|
2986
3176
|
* Successful Response
|
|
2987
3177
|
*/
|
|
2988
|
-
201:
|
|
3178
|
+
201: RunResponseOutput;
|
|
2989
3179
|
};
|
|
2990
3180
|
export type CreateRunV1RunsPostResponse = CreateRunV1RunsPostResponses[keyof CreateRunV1RunsPostResponses];
|
|
2991
3181
|
export type DeleteRunV1RunsRunIdDeleteData = {
|
|
@@ -3068,7 +3258,7 @@ export type UpdateRunV1RunsRunIdPatchResponses = {
|
|
|
3068
3258
|
/**
|
|
3069
3259
|
* Successful Response
|
|
3070
3260
|
*/
|
|
3071
|
-
200:
|
|
3261
|
+
200: RunResponseOutput;
|
|
3072
3262
|
};
|
|
3073
3263
|
export type UpdateRunV1RunsRunIdPatchResponse = UpdateRunV1RunsRunIdPatchResponses[keyof UpdateRunV1RunsRunIdPatchResponses];
|
|
3074
3264
|
export type GetRunTrajectoryV1RunsRunIdTrajectoryGetData = {
|
|
@@ -3198,7 +3388,7 @@ export type RetryRunV1RunsRunIdRetryPostResponses = {
|
|
|
3198
3388
|
/**
|
|
3199
3389
|
* Successful Response
|
|
3200
3390
|
*/
|
|
3201
|
-
200:
|
|
3391
|
+
200: RunResponseOutput;
|
|
3202
3392
|
};
|
|
3203
3393
|
export type RetryRunV1RunsRunIdRetryPostResponse = RetryRunV1RunsRunIdRetryPostResponses[keyof RetryRunV1RunsRunIdRetryPostResponses];
|
|
3204
3394
|
export type ListRunAttachmentsV1RunAttachmentsGetData = {
|
|
@@ -3924,64 +4114,6 @@ export type GetDisplayDimensionsV1ComputerMachineIdDisplayDimensionsGetResponses
|
|
|
3924
4114
|
200: DisplayDimensions;
|
|
3925
4115
|
};
|
|
3926
4116
|
export type GetDisplayDimensionsV1ComputerMachineIdDisplayDimensionsGetResponse = GetDisplayDimensionsV1ComputerMachineIdDisplayDimensionsGetResponses[keyof GetDisplayDimensionsV1ComputerMachineIdDisplayDimensionsGetResponses];
|
|
3927
|
-
export type CreateAdHocComputerTaskV1ComputerMachineIdTaskPostData = {
|
|
3928
|
-
body: string | ComputerTaskObjectRequest;
|
|
3929
|
-
headers?: {
|
|
3930
|
-
/**
|
|
3931
|
-
* Unique key for idempotent requests. If provided, the server ensures the request is processed at most once. Retries with the same key return the original response. SDKs auto-generate this for write requests.
|
|
3932
|
-
*/
|
|
3933
|
-
'Idempotency-Key'?: string;
|
|
3934
|
-
};
|
|
3935
|
-
path: {
|
|
3936
|
-
machine_id: string;
|
|
3937
|
-
};
|
|
3938
|
-
query?: never;
|
|
3939
|
-
url: '/v1/computer/{machine_id}/task';
|
|
3940
|
-
};
|
|
3941
|
-
export type CreateAdHocComputerTaskV1ComputerMachineIdTaskPostErrors = {
|
|
3942
|
-
/**
|
|
3943
|
-
* Validation Error
|
|
3944
|
-
*/
|
|
3945
|
-
422: HttpValidationError;
|
|
3946
|
-
};
|
|
3947
|
-
export type CreateAdHocComputerTaskV1ComputerMachineIdTaskPostError = CreateAdHocComputerTaskV1ComputerMachineIdTaskPostErrors[keyof CreateAdHocComputerTaskV1ComputerMachineIdTaskPostErrors];
|
|
3948
|
-
export type CreateAdHocComputerTaskV1ComputerMachineIdTaskPostResponses = {
|
|
3949
|
-
/**
|
|
3950
|
-
* Successful Response
|
|
3951
|
-
*/
|
|
3952
|
-
202: ComputerTaskAcceptedResponse;
|
|
3953
|
-
};
|
|
3954
|
-
export type CreateAdHocComputerTaskV1ComputerMachineIdTaskPostResponse = CreateAdHocComputerTaskV1ComputerMachineIdTaskPostResponses[keyof CreateAdHocComputerTaskV1ComputerMachineIdTaskPostResponses];
|
|
3955
|
-
export type NotifyTaskDoneV1ComputerMachineIdTaskDonePostData = {
|
|
3956
|
-
body?: never;
|
|
3957
|
-
headers?: {
|
|
3958
|
-
/**
|
|
3959
|
-
* Unique key for idempotent requests. If provided, the server ensures the request is processed at most once. Retries with the same key return the original response. SDKs auto-generate this for write requests.
|
|
3960
|
-
*/
|
|
3961
|
-
'Idempotency-Key'?: string;
|
|
3962
|
-
};
|
|
3963
|
-
path: {
|
|
3964
|
-
machine_id: string;
|
|
3965
|
-
};
|
|
3966
|
-
query?: never;
|
|
3967
|
-
url: '/v1/computer/{machine_id}/task-done';
|
|
3968
|
-
};
|
|
3969
|
-
export type NotifyTaskDoneV1ComputerMachineIdTaskDonePostErrors = {
|
|
3970
|
-
/**
|
|
3971
|
-
* Validation Error
|
|
3972
|
-
*/
|
|
3973
|
-
422: HttpValidationError;
|
|
3974
|
-
};
|
|
3975
|
-
export type NotifyTaskDoneV1ComputerMachineIdTaskDonePostError = NotifyTaskDoneV1ComputerMachineIdTaskDonePostErrors[keyof NotifyTaskDoneV1ComputerMachineIdTaskDonePostErrors];
|
|
3976
|
-
export type NotifyTaskDoneV1ComputerMachineIdTaskDonePostResponses = {
|
|
3977
|
-
/**
|
|
3978
|
-
* Successful Response
|
|
3979
|
-
*/
|
|
3980
|
-
200: {
|
|
3981
|
-
[key: string]: unknown;
|
|
3982
|
-
};
|
|
3983
|
-
};
|
|
3984
|
-
export type NotifyTaskDoneV1ComputerMachineIdTaskDonePostResponse = NotifyTaskDoneV1ComputerMachineIdTaskDonePostResponses[keyof NotifyTaskDoneV1ComputerMachineIdTaskDonePostResponses];
|
|
3985
4117
|
export type KeyboardTypeV1ComputerMachineIdInputKeyboardTypePostData = {
|
|
3986
4118
|
body: KeyboardTypeRequest;
|
|
3987
4119
|
headers?: {
|
|
@@ -4492,5 +4624,5 @@ export type HealthMachinesV1HealthMachinesGetResponses = {
|
|
|
4492
4624
|
};
|
|
4493
4625
|
export type HealthMachinesV1HealthMachinesGetResponse = HealthMachinesV1HealthMachinesGetResponses[keyof HealthMachinesV1HealthMachinesGetResponses];
|
|
4494
4626
|
export type ClientOptions = {
|
|
4495
|
-
baseUrl:
|
|
4627
|
+
baseUrl: string;
|
|
4496
4628
|
};
|
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 WorkflowModelMetadata, type WorkflowResponse, type
|
|
28
|
+
import { type MachineResponse, type MachinePoolUpdate, type PoolResponse, type PoolCreate, type PoolUpdate, type PoolWithMachines, type MachinePoolAssignment, type WorkflowModelMetadata, type WorkflowResponse, type WorkflowPostRunCheckResponse, type WorkflowPostRunCheckUpsert, type RunPostRunCheckSnapshot, type PostRunCheckType, type PostRunCheckStatus, type PostRunCheckFileTargetMode, type RunResponseOutput as RunResponse, type ConnectionResponse, type TrajectoryResponse, type PaginatedResponseWithIncludesMachineResponse, type PaginatedResponseWithIncludesPoolResponse, type PaginatedResponseWithIncludesWorkflowResponse as PaginatedResponseWorkflowResponse, type PaginatedResponseWithIncludesRunResponse, type PaginatedResponseConnectionResponse, type PaginatedResponseWithIncludesTrajectoryResponse, 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 IncludedResource, type PaginatedResponseRunAttachmentResponse, type RunRetry, type RunField, type RunListSortMode, type ModelConfigurationCreate, type ModelConfigurationUpdate, type ModelConfigurationResponse, type UsageAggregateResponse, type UsageMode, type WorkflowTagCreate, type WorkflowTagUpdate, type WorkflowTagResponse, type WorkflowTagGroupCreate, type WorkflowTagGroupUpdate, type WorkflowTagGroupResponse, type ReorderRequest, type AddTagsRequest, type BulkAddTagsRequest, type WorkflowDuplicateRequest } 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';
|
|
@@ -485,7 +485,9 @@ export declare function createCyberdeskClient(apiKey: string, baseUrl?: string,
|
|
|
485
485
|
* @param params.limit - Maximum number of items to return
|
|
486
486
|
* @param params.search - Search workflows by name (case-insensitive substring match)
|
|
487
487
|
* @param params.tag_ids - Comma-separated list of tag UUIDs. Returns workflows with ALL specified tags (AND logic)
|
|
488
|
-
* @param params.include_tags -
|
|
488
|
+
* @param params.include_tags - Legacy flag to include tags in the response
|
|
489
|
+
* @param params.include - Related resources to include. Use `["tags"]`, `["post_run_checks"]`,
|
|
490
|
+
* or both. When provided, this overrides `include_tags`.
|
|
489
491
|
* @returns Paginated list of workflows
|
|
490
492
|
*/
|
|
491
493
|
list: (params?: {
|
|
@@ -498,6 +500,7 @@ export declare function createCyberdeskClient(apiKey: string, baseUrl?: string,
|
|
|
498
500
|
updated_at_to?: string | Date;
|
|
499
501
|
tag_ids?: string;
|
|
500
502
|
include_tags?: boolean;
|
|
503
|
+
include?: string[];
|
|
501
504
|
}) => Promise<({
|
|
502
505
|
data: undefined;
|
|
503
506
|
error: import("./client/types.gen").HttpValidationError;
|
|
@@ -537,13 +540,19 @@ export declare function createCyberdeskClient(apiKey: string, baseUrl?: string,
|
|
|
537
540
|
* Get a specific workflow by ID
|
|
538
541
|
*
|
|
539
542
|
* @param workflowId - The ID of the workflow
|
|
543
|
+
* @param params - Optional parameters
|
|
544
|
+
* @param params.include - Related resources to include. Allowed values:
|
|
545
|
+
* `["tags"]`, `["post_run_checks"]`. When omitted,
|
|
546
|
+
* the backend currently defaults to both.
|
|
540
547
|
* @returns Workflow details
|
|
541
548
|
*/
|
|
542
|
-
get: (workflowId: string
|
|
549
|
+
get: (workflowId: string, params?: {
|
|
550
|
+
include?: string[];
|
|
551
|
+
}) => Promise<({
|
|
543
552
|
data: undefined;
|
|
544
553
|
error: import("./client/types.gen").HttpValidationError;
|
|
545
554
|
} | {
|
|
546
|
-
data:
|
|
555
|
+
data: import("./client/types.gen").WorkflowResponseWithIncludes;
|
|
547
556
|
error: undefined;
|
|
548
557
|
}) & {
|
|
549
558
|
request: Request;
|
|
@@ -1002,45 +1011,6 @@ export declare function createCyberdeskClient(apiKey: string, baseUrl?: string,
|
|
|
1002
1011
|
response: Response;
|
|
1003
1012
|
}>;
|
|
1004
1013
|
};
|
|
1005
|
-
computer: {
|
|
1006
|
-
/**
|
|
1007
|
-
* Create an ad hoc computer task for a connected machine.
|
|
1008
|
-
*
|
|
1009
|
-
* Accepts either the current desktop-compatible raw JSON string task body
|
|
1010
|
-
* or the forward-compatible object form `{ task: string }`.
|
|
1011
|
-
*/
|
|
1012
|
-
createAdHocTask: (machineId: string, task: string | ComputerTaskObjectRequest, params?: {
|
|
1013
|
-
idempotencyKey?: string;
|
|
1014
|
-
}) => Promise<({
|
|
1015
|
-
data: undefined;
|
|
1016
|
-
error: import("./client/types.gen").HttpValidationError;
|
|
1017
|
-
} | {
|
|
1018
|
-
data: ComputerTaskAcceptedResponse;
|
|
1019
|
-
error: undefined;
|
|
1020
|
-
}) & {
|
|
1021
|
-
request: Request;
|
|
1022
|
-
response: Response;
|
|
1023
|
-
}>;
|
|
1024
|
-
/**
|
|
1025
|
-
* Notify Cyberdriver that a task has completed.
|
|
1026
|
-
*
|
|
1027
|
-
* This is primarily useful for lower-level integrations and testing.
|
|
1028
|
-
*/
|
|
1029
|
-
notifyTaskDone: (machineId: string, params?: {
|
|
1030
|
-
idempotencyKey?: string;
|
|
1031
|
-
}) => Promise<({
|
|
1032
|
-
data: undefined;
|
|
1033
|
-
error: import("./client/types.gen").HttpValidationError;
|
|
1034
|
-
} | {
|
|
1035
|
-
data: {
|
|
1036
|
-
[key: string]: unknown;
|
|
1037
|
-
};
|
|
1038
|
-
error: undefined;
|
|
1039
|
-
}) & {
|
|
1040
|
-
request: Request;
|
|
1041
|
-
response: Response;
|
|
1042
|
-
}>;
|
|
1043
|
-
};
|
|
1044
1014
|
runs: {
|
|
1045
1015
|
/**
|
|
1046
1016
|
* List runs with optional filtering
|
|
@@ -1053,7 +1023,6 @@ export declare function createCyberdeskClient(apiKey: string, baseUrl?: string,
|
|
|
1053
1023
|
* @param params.limit - Maximum number of items to return
|
|
1054
1024
|
* @param params.status - Filter by run status (scheduling, running, success, cancelled, error)
|
|
1055
1025
|
* @param params.workflow_id - Filter by workflow ID
|
|
1056
|
-
* @param params.run_kind - Filter by run kind ("workflow" or "ad_hoc")
|
|
1057
1026
|
* @param params.machine_id - Filter by machine ID
|
|
1058
1027
|
* @param params.session_id - Filter by session ID
|
|
1059
1028
|
* @param params.search - Search runs by input_values, output_data, error, session_alias (case-insensitive)
|
|
@@ -1074,7 +1043,6 @@ export declare function createCyberdeskClient(apiKey: string, baseUrl?: string,
|
|
|
1074
1043
|
limit?: number;
|
|
1075
1044
|
status?: RunStatus;
|
|
1076
1045
|
workflow_id?: string;
|
|
1077
|
-
run_kind?: RunKind;
|
|
1078
1046
|
machine_id?: string;
|
|
1079
1047
|
session_id?: string;
|
|
1080
1048
|
search?: string;
|
|
@@ -1827,4 +1795,4 @@ export declare function createCyberdeskClient(apiKey: string, baseUrl?: string,
|
|
|
1827
1795
|
}>;
|
|
1828
1796
|
};
|
|
1829
1797
|
};
|
|
1830
|
-
export type { MachineResponse, MachinePoolUpdate, PoolResponse, PoolCreate, PoolUpdate, PoolWithMachines, MachinePoolAssignment, WorkflowModelMetadata, WorkflowResponse, RunResponse, RunBulkCreate, RunBulkCreateResponse, ConnectionResponse, TrajectoryResponse, RunAttachmentResponse, RunAttachmentDownloadUrlResponse, FileInput, AttachmentType, IncludedResource, PaginatedResponseWithIncludesMachineResponse, PaginatedResponseWithIncludesPoolResponse, PaginatedResponseWorkflowResponse, PaginatedResponseWithIncludesRunResponse, PaginatedResponseConnectionResponse, PaginatedResponseWithIncludesTrajectoryResponse, PaginatedResponseRunAttachmentResponse, ModelConfigurationCreate, ModelConfigurationUpdate, ModelConfigurationResponse, UsageAggregateResponse, UsageMode, WorkflowTagCreate, WorkflowTagUpdate, WorkflowTagResponse, WorkflowTagGroupCreate, WorkflowTagGroupUpdate, WorkflowTagGroupResponse, ReorderRequest, AddTagsRequest, BulkAddTagsRequest, };
|
|
1798
|
+
export type { MachineResponse, MachinePoolUpdate, PoolResponse, PoolCreate, PoolUpdate, PoolWithMachines, MachinePoolAssignment, WorkflowModelMetadata, WorkflowPostRunCheckResponse, WorkflowPostRunCheckUpsert, RunPostRunCheckSnapshot, PostRunCheckType, PostRunCheckStatus, PostRunCheckFileTargetMode, WorkflowResponse, RunResponse, RunBulkCreate, RunBulkCreateResponse, ConnectionResponse, TrajectoryResponse, RunAttachmentResponse, RunAttachmentDownloadUrlResponse, FileInput, AttachmentType, IncludedResource, PaginatedResponseWithIncludesMachineResponse, PaginatedResponseWithIncludesPoolResponse, PaginatedResponseWorkflowResponse, PaginatedResponseWithIncludesRunResponse, PaginatedResponseConnectionResponse, PaginatedResponseWithIncludesTrajectoryResponse, PaginatedResponseRunAttachmentResponse, ModelConfigurationCreate, ModelConfigurationUpdate, ModelConfigurationResponse, UsageAggregateResponse, UsageMode, WorkflowTagCreate, WorkflowTagUpdate, WorkflowTagResponse, WorkflowTagGroupCreate, WorkflowTagGroupUpdate, WorkflowTagGroupResponse, ReorderRequest, AddTagsRequest, BulkAddTagsRequest, };
|
package/dist/index.js
CHANGED
|
@@ -617,10 +617,13 @@ function createCyberdeskClient(apiKey, baseUrl, options) {
|
|
|
617
617
|
* @param params.limit - Maximum number of items to return
|
|
618
618
|
* @param params.search - Search workflows by name (case-insensitive substring match)
|
|
619
619
|
* @param params.tag_ids - Comma-separated list of tag UUIDs. Returns workflows with ALL specified tags (AND logic)
|
|
620
|
-
* @param params.include_tags -
|
|
620
|
+
* @param params.include_tags - Legacy flag to include tags in the response
|
|
621
|
+
* @param params.include - Related resources to include. Use `["tags"]`, `["post_run_checks"]`,
|
|
622
|
+
* or both. When provided, this overrides `include_tags`.
|
|
621
623
|
* @returns Paginated list of workflows
|
|
622
624
|
*/
|
|
623
625
|
list: (params) => __awaiter(this, void 0, void 0, function* () {
|
|
626
|
+
var _a;
|
|
624
627
|
const query = {
|
|
625
628
|
skip: params === null || params === void 0 ? void 0 : params.skip,
|
|
626
629
|
limit: params === null || params === void 0 ? void 0 : params.limit,
|
|
@@ -631,6 +634,7 @@ function createCyberdeskClient(apiKey, baseUrl, options) {
|
|
|
631
634
|
updated_at_to: toIsoUtc(params === null || params === void 0 ? void 0 : params.updated_at_to),
|
|
632
635
|
tag_ids: params === null || params === void 0 ? void 0 : params.tag_ids,
|
|
633
636
|
include_tags: params === null || params === void 0 ? void 0 : params.include_tags,
|
|
637
|
+
include: (_a = params === null || params === void 0 ? void 0 : params.include) === null || _a === void 0 ? void 0 : _a.join(','),
|
|
634
638
|
};
|
|
635
639
|
return (0, sdk_gen_1.listWorkflowsV1WorkflowsGet)({ client, query });
|
|
636
640
|
}),
|
|
@@ -659,12 +663,18 @@ function createCyberdeskClient(apiKey, baseUrl, options) {
|
|
|
659
663
|
* Get a specific workflow by ID
|
|
660
664
|
*
|
|
661
665
|
* @param workflowId - The ID of the workflow
|
|
666
|
+
* @param params - Optional parameters
|
|
667
|
+
* @param params.include - Related resources to include. Allowed values:
|
|
668
|
+
* `["tags"]`, `["post_run_checks"]`. When omitted,
|
|
669
|
+
* the backend currently defaults to both.
|
|
662
670
|
* @returns Workflow details
|
|
663
671
|
*/
|
|
664
|
-
get: (workflowId) => __awaiter(this, void 0, void 0, function* () {
|
|
672
|
+
get: (workflowId, params) => __awaiter(this, void 0, void 0, function* () {
|
|
673
|
+
var _a;
|
|
665
674
|
return (0, sdk_gen_1.getWorkflowV1WorkflowsWorkflowIdGet)({
|
|
666
675
|
client,
|
|
667
676
|
path: { workflow_id: workflowId },
|
|
677
|
+
query: { include: (_a = params === null || params === void 0 ? void 0 : params.include) === null || _a === void 0 ? void 0 : _a.join(',') },
|
|
668
678
|
});
|
|
669
679
|
}),
|
|
670
680
|
/**
|
|
@@ -1032,39 +1042,6 @@ function createCyberdeskClient(apiKey, baseUrl, options) {
|
|
|
1032
1042
|
});
|
|
1033
1043
|
}),
|
|
1034
1044
|
},
|
|
1035
|
-
// Computer endpoints
|
|
1036
|
-
computer: {
|
|
1037
|
-
/**
|
|
1038
|
-
* Create an ad hoc computer task for a connected machine.
|
|
1039
|
-
*
|
|
1040
|
-
* Accepts either the current desktop-compatible raw JSON string task body
|
|
1041
|
-
* or the forward-compatible object form `{ task: string }`.
|
|
1042
|
-
*/
|
|
1043
|
-
createAdHocTask: (machineId, task, params) => __awaiter(this, void 0, void 0, function* () {
|
|
1044
|
-
return (0, sdk_gen_1.createAdHocComputerTaskV1ComputerMachineIdTaskPost)({
|
|
1045
|
-
client,
|
|
1046
|
-
path: { machine_id: machineId },
|
|
1047
|
-
body: task,
|
|
1048
|
-
headers: (params === null || params === void 0 ? void 0 : params.idempotencyKey)
|
|
1049
|
-
? { "Idempotency-Key": params.idempotencyKey }
|
|
1050
|
-
: undefined,
|
|
1051
|
-
});
|
|
1052
|
-
}),
|
|
1053
|
-
/**
|
|
1054
|
-
* Notify Cyberdriver that a task has completed.
|
|
1055
|
-
*
|
|
1056
|
-
* This is primarily useful for lower-level integrations and testing.
|
|
1057
|
-
*/
|
|
1058
|
-
notifyTaskDone: (machineId, params) => __awaiter(this, void 0, void 0, function* () {
|
|
1059
|
-
return (0, sdk_gen_1.notifyTaskDoneV1ComputerMachineIdTaskDonePost)({
|
|
1060
|
-
client,
|
|
1061
|
-
path: { machine_id: machineId },
|
|
1062
|
-
headers: (params === null || params === void 0 ? void 0 : params.idempotencyKey)
|
|
1063
|
-
? { "Idempotency-Key": params.idempotencyKey }
|
|
1064
|
-
: undefined,
|
|
1065
|
-
});
|
|
1066
|
-
}),
|
|
1067
|
-
},
|
|
1068
1045
|
// Run endpoints
|
|
1069
1046
|
runs: {
|
|
1070
1047
|
/**
|
|
@@ -1078,7 +1055,6 @@ function createCyberdeskClient(apiKey, baseUrl, options) {
|
|
|
1078
1055
|
* @param params.limit - Maximum number of items to return
|
|
1079
1056
|
* @param params.status - Filter by run status (scheduling, running, success, cancelled, error)
|
|
1080
1057
|
* @param params.workflow_id - Filter by workflow ID
|
|
1081
|
-
* @param params.run_kind - Filter by run kind ("workflow" or "ad_hoc")
|
|
1082
1058
|
* @param params.machine_id - Filter by machine ID
|
|
1083
1059
|
* @param params.session_id - Filter by session ID
|
|
1084
1060
|
* @param params.search - Search runs by input_values, output_data, error, session_alias (case-insensitive)
|
|
@@ -1095,22 +1071,21 @@ function createCyberdeskClient(apiKey, baseUrl, options) {
|
|
|
1095
1071
|
* - included: Related resources (when include parameter is used)
|
|
1096
1072
|
*/
|
|
1097
1073
|
list: (params) => __awaiter(this, void 0, void 0, function* () {
|
|
1098
|
-
var _a, _b, _c, _d, _e
|
|
1074
|
+
var _a, _b, _c, _d, _e;
|
|
1099
1075
|
const query = {
|
|
1100
1076
|
skip: params === null || params === void 0 ? void 0 : params.skip,
|
|
1101
1077
|
limit: params === null || params === void 0 ? void 0 : params.limit,
|
|
1102
1078
|
status: (_a = params === null || params === void 0 ? void 0 : params.status) !== null && _a !== void 0 ? _a : undefined,
|
|
1103
1079
|
workflow_id: (_b = params === null || params === void 0 ? void 0 : params.workflow_id) !== null && _b !== void 0 ? _b : undefined,
|
|
1104
|
-
|
|
1105
|
-
|
|
1106
|
-
session_id: (_e = params === null || params === void 0 ? void 0 : params.session_id) !== null && _e !== void 0 ? _e : undefined,
|
|
1080
|
+
machine_id: (_c = params === null || params === void 0 ? void 0 : params.machine_id) !== null && _c !== void 0 ? _c : undefined,
|
|
1081
|
+
session_id: (_d = params === null || params === void 0 ? void 0 : params.session_id) !== null && _d !== void 0 ? _d : undefined,
|
|
1107
1082
|
search: params === null || params === void 0 ? void 0 : params.search,
|
|
1108
1083
|
deep_search: params === null || params === void 0 ? void 0 : params.deep_search,
|
|
1109
1084
|
sort_mode: params === null || params === void 0 ? void 0 : params.sort_mode,
|
|
1110
1085
|
created_at_from: toIsoUtc(params === null || params === void 0 ? void 0 : params.created_at_from),
|
|
1111
1086
|
created_at_to: toIsoUtc(params === null || params === void 0 ? void 0 : params.created_at_to),
|
|
1112
1087
|
fields: params === null || params === void 0 ? void 0 : params.fields,
|
|
1113
|
-
include: (
|
|
1088
|
+
include: (_e = params === null || params === void 0 ? void 0 : params.include) === null || _e === void 0 ? void 0 : _e.join(','),
|
|
1114
1089
|
};
|
|
1115
1090
|
return (0, sdk_gen_1.listRunsV1RunsGet)({ client, query });
|
|
1116
1091
|
}),
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "cyberdesk",
|
|
3
|
-
"version": "2.2.
|
|
3
|
+
"version": "2.2.37",
|
|
4
4
|
"description": "The official TypeScript SDK for Cyberdesk",
|
|
5
5
|
"main": "dist/index.js",
|
|
6
6
|
"types": "dist/index.d.ts",
|
|
@@ -10,7 +10,7 @@
|
|
|
10
10
|
"README.md"
|
|
11
11
|
],
|
|
12
12
|
"scripts": {
|
|
13
|
-
"generate": "openapi-ts",
|
|
13
|
+
"generate": "openapi-ts && node scripts/normalize-generated-client.js",
|
|
14
14
|
"build": "npm run generate && tsc",
|
|
15
15
|
"test": "vitest run",
|
|
16
16
|
"test:watch": "vitest",
|
|
@@ -28,15 +28,12 @@
|
|
|
28
28
|
"url": "https://github.com/cyberdesk-hq/cyberdesk/issues"
|
|
29
29
|
},
|
|
30
30
|
"homepage": "https://github.com/cyberdesk-hq/cyberdesk#readme",
|
|
31
|
-
"dependencies": {
|
|
32
|
-
"@hey-api/client-fetch": "^0.10.0"
|
|
33
|
-
},
|
|
34
31
|
"devDependencies": {
|
|
35
|
-
"@hey-api/openapi-ts": "^0.
|
|
32
|
+
"@hey-api/openapi-ts": "^0.94.4",
|
|
36
33
|
"@types/node": "^20.0.0",
|
|
37
34
|
"dotenv": "^16.0.0",
|
|
38
35
|
"svix": "^1.0.0",
|
|
39
36
|
"typescript": "^5.0.0",
|
|
40
|
-
"vitest": "^1.0
|
|
37
|
+
"vitest": "^4.1.0"
|
|
41
38
|
}
|
|
42
39
|
}
|