cyberdesk 1.11.0 → 2.1.0

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

@@ -79,6 +79,24 @@ export type MachineCreate = {
     os_info?: string | null;
     unkey_key_id: string;
 };
+/**
+ * Schema for assigning machines to pools
+ */
+export type MachinePoolAssignment = {
+    /**
+     * List of machine IDs to assign to the pool
+     */
+    machine_ids: Array<string>;
+};
+/**
+ * Schema for updating a machine's pool assignments
+ */
+export type MachinePoolUpdate = {
+    /**
+     * List of pool IDs to assign the machine to
+     */
+    pool_ids: Array<string>;
+};
 /**
  * Machine response schema
  */
@@ -89,12 +107,14 @@ export type MachineResponse = {
     hostname?: string | null;
     os_info?: string | null;
     id: string;
-    user_id: string;
+    user_id?: string | null;
+    organization_id?: string | null;
     unkey_key_id: string;
     status: MachineStatus;
     is_available: boolean;
     created_at: string;
     last_seen: string;
+    pools?: Array<PoolResponse> | null;
 };
 export type MachineStatus = 'connected' | 'disconnected' | 'error';
 /**
@@ -147,6 +167,12 @@ export type PaginatedResponseMachineResponse = {
     skip: number;
     limit: number;
 };
+export type PaginatedResponsePoolResponse = {
+    items: Array<PoolResponse>;
+    total: number;
+    skip: number;
+    limit: number;
+};
 export type PaginatedResponseRunAttachmentResponse = {
     items: Array<RunAttachmentResponse>;
     total: number;
@@ -171,6 +197,51 @@ export type PaginatedResponseWorkflowResponse = {
     skip: number;
     limit: number;
 };
+/**
+ * Schema for creating a pool
+ */
+export type PoolCreate = {
+    name: string;
+    description?: string | null;
+};
+/**
+ * Pool response schema
+ */
+export type PoolResponse = {
+    name: string;
+    description?: string | null;
+    id: string;
+    organization_id: string;
+    created_at: string;
+    updated_at: string;
+    /**
+     * Number of machines in this pool
+     */
+    machine_count?: number | null;
+};
+/**
+ * Schema for updating a pool
+ */
+export type PoolUpdate = {
+    name?: string | null;
+    description?: string | null;
+};
+/**
+ * Pool response with machines included
+ */
+export type PoolWithMachines = {
+    name: string;
+    description?: string | null;
+    id: string;
+    organization_id: string;
+    created_at: string;
+    updated_at: string;
+    /**
+     * Number of machines in this pool
+     */
+    machine_count?: number | null;
+    machines?: Array<MachineResponse>;
+};
 export type PowerShellExecRequest = {
     /**
      * PowerShell command to execute
@@ -227,6 +298,7 @@ export type RequestLogResponse = {
     error_message?: string | null;
     id: string;
     machine_id: string;
+    organization_id?: string | null;
     created_at: string;
     completed_at: string | null;
 };
@@ -279,7 +351,8 @@ export type RunAttachmentResponse = {
     target_path?: string | null;
     cleanup_imports_after_run?: boolean;
     id: string;
-    user_id: string;
+    user_id?: string | null;
+    organization_id?: string | null;
     run_id: string;
     size_bytes: number;
     storage_path: string;
@@ -301,6 +374,10 @@ export type RunBulkCreate = {
      * Machine ID. If not provided, an available machine will be automatically selected.
      */
     machine_id?: string | null;
+    /**
+     * Pool IDs to filter available machines. Machine must belong to at least one of these pools.
+     */
+    pool_ids?: Array<string> | null;
     /**
      * Input values for workflow variables
      */
@@ -333,6 +410,10 @@ export type RunCreate = {
      * Machine ID. If not provided, an available machine will be automatically selected.
      */
     machine_id?: string | null;
+    /**
+     * Pool IDs to filter available machines. Machine must belong to at least one of these pools.
+     */
+    pool_ids?: Array<string> | null;
     /**
      * Input values for workflow variables
      */
@@ -351,7 +432,8 @@ export type RunResponse = {
     workflow_id: string;
     machine_id: string | null;
     id: string;
-    user_id: string;
+    user_id?: string | null;
+    organization_id?: string | null;
     status: RunStatus;
     error: Array<string> | null;
     output_data: {
@@ -365,6 +447,7 @@ export type RunResponse = {
     input_values: {
         [key: string]: unknown;
     } | null;
+    pool_ids?: Array<string> | null;
     created_at: string;
 };
 export type RunStatus = 'scheduling' | 'running' | 'success' | 'cancelled' | 'error';
@@ -427,7 +510,8 @@ export type TrajectoryResponse = {
         [key: string]: unknown;
     } | null;
     id: string;
-    user_id: string;
+    user_id?: string | null;
+    organization_id?: string | null;
     created_at: string;
     updated_at: string;
 };
@@ -474,7 +558,8 @@ export type WorkflowResponse = {
      */
     includes_file_exports?: boolean;
     id: string;
-    user_id: string;
+    user_id?: string | null;
+    organization_id?: string | null;
     includes_input_variables?: boolean;
     old_versions?: Array<{
         [key: string]: unknown;
@@ -640,6 +725,208 @@ export type UpdateMachineV1MachinesMachineIdPatchResponses = {
     200: MachineResponse;
 };
 export type UpdateMachineV1MachinesMachineIdPatchResponse = UpdateMachineV1MachinesMachineIdPatchResponses[keyof UpdateMachineV1MachinesMachineIdPatchResponses];
+export type GetMachinePoolsV1MachinesMachineIdPoolsGetData = {
+    body?: never;
+    path: {
+        machine_id: string;
+    };
+    query?: never;
+    url: '/v1/machines/{machine_id}/pools';
+};
+export type GetMachinePoolsV1MachinesMachineIdPoolsGetErrors = {
+    /**
+     * Validation Error
+     */
+    422: HttpValidationError;
+};
+export type GetMachinePoolsV1MachinesMachineIdPoolsGetError = GetMachinePoolsV1MachinesMachineIdPoolsGetErrors[keyof GetMachinePoolsV1MachinesMachineIdPoolsGetErrors];
+export type GetMachinePoolsV1MachinesMachineIdPoolsGetResponses = {
+    /**
+     * Successful Response
+     */
+    200: Array<PoolResponse>;
+};
+export type GetMachinePoolsV1MachinesMachineIdPoolsGetResponse = GetMachinePoolsV1MachinesMachineIdPoolsGetResponses[keyof GetMachinePoolsV1MachinesMachineIdPoolsGetResponses];
+export type UpdateMachinePoolsV1MachinesMachineIdPoolsPutData = {
+    body: MachinePoolUpdate;
+    path: {
+        machine_id: string;
+    };
+    query?: never;
+    url: '/v1/machines/{machine_id}/pools';
+};
+export type UpdateMachinePoolsV1MachinesMachineIdPoolsPutErrors = {
+    /**
+     * Validation Error
+     */
+    422: HttpValidationError;
+};
+export type UpdateMachinePoolsV1MachinesMachineIdPoolsPutError = UpdateMachinePoolsV1MachinesMachineIdPoolsPutErrors[keyof UpdateMachinePoolsV1MachinesMachineIdPoolsPutErrors];
+export type UpdateMachinePoolsV1MachinesMachineIdPoolsPutResponses = {
+    /**
+     * Successful Response
+     */
+    200: MachineResponse;
+};
+export type UpdateMachinePoolsV1MachinesMachineIdPoolsPutResponse = UpdateMachinePoolsV1MachinesMachineIdPoolsPutResponses[keyof UpdateMachinePoolsV1MachinesMachineIdPoolsPutResponses];
+export type ListPoolsV1PoolsGetData = {
+    body?: never;
+    path?: never;
+    query?: {
+        skip?: number;
+        limit?: number;
+    };
+    url: '/v1/pools';
+};
+export type ListPoolsV1PoolsGetErrors = {
+    /**
+     * Validation Error
+     */
+    422: HttpValidationError;
+};
+export type ListPoolsV1PoolsGetError = ListPoolsV1PoolsGetErrors[keyof ListPoolsV1PoolsGetErrors];
+export type ListPoolsV1PoolsGetResponses = {
+    /**
+     * Successful Response
+     */
+    200: PaginatedResponsePoolResponse;
+};
+export type ListPoolsV1PoolsGetResponse = ListPoolsV1PoolsGetResponses[keyof ListPoolsV1PoolsGetResponses];
+export type CreatePoolV1PoolsPostData = {
+    body: PoolCreate;
+    path?: never;
+    query?: never;
+    url: '/v1/pools';
+};
+export type CreatePoolV1PoolsPostErrors = {
+    /**
+     * Validation Error
+     */
+    422: HttpValidationError;
+};
+export type CreatePoolV1PoolsPostError = CreatePoolV1PoolsPostErrors[keyof CreatePoolV1PoolsPostErrors];
+export type CreatePoolV1PoolsPostResponses = {
+    /**
+     * Successful Response
+     */
+    201: PoolResponse;
+};
+export type CreatePoolV1PoolsPostResponse = CreatePoolV1PoolsPostResponses[keyof CreatePoolV1PoolsPostResponses];
+export type DeletePoolV1PoolsPoolIdDeleteData = {
+    body?: never;
+    path: {
+        pool_id: string;
+    };
+    query?: never;
+    url: '/v1/pools/{pool_id}';
+};
+export type DeletePoolV1PoolsPoolIdDeleteErrors = {
+    /**
+     * Validation Error
+     */
+    422: HttpValidationError;
+};
+export type DeletePoolV1PoolsPoolIdDeleteError = DeletePoolV1PoolsPoolIdDeleteErrors[keyof DeletePoolV1PoolsPoolIdDeleteErrors];
+export type DeletePoolV1PoolsPoolIdDeleteResponses = {
+    /**
+     * Successful Response
+     */
+    204: void;
+};
+export type DeletePoolV1PoolsPoolIdDeleteResponse = DeletePoolV1PoolsPoolIdDeleteResponses[keyof DeletePoolV1PoolsPoolIdDeleteResponses];
+export type GetPoolV1PoolsPoolIdGetData = {
+    body?: never;
+    path: {
+        pool_id: string;
+    };
+    query?: {
+        /**
+         * Include full machine details
+         */
+        include_machines?: boolean;
+    };
+    url: '/v1/pools/{pool_id}';
+};
+export type GetPoolV1PoolsPoolIdGetErrors = {
+    /**
+     * Validation Error
+     */
+    422: HttpValidationError;
+};
+export type GetPoolV1PoolsPoolIdGetError = GetPoolV1PoolsPoolIdGetErrors[keyof GetPoolV1PoolsPoolIdGetErrors];
+export type GetPoolV1PoolsPoolIdGetResponses = {
+    /**
+     * Successful Response
+     */
+    200: PoolWithMachines;
+};
+export type GetPoolV1PoolsPoolIdGetResponse = GetPoolV1PoolsPoolIdGetResponses[keyof GetPoolV1PoolsPoolIdGetResponses];
+export type UpdatePoolV1PoolsPoolIdPatchData = {
+    body: PoolUpdate;
+    path: {
+        pool_id: string;
+    };
+    query?: never;
+    url: '/v1/pools/{pool_id}';
+};
+export type UpdatePoolV1PoolsPoolIdPatchErrors = {
+    /**
+     * Validation Error
+     */
+    422: HttpValidationError;
+};
+export type UpdatePoolV1PoolsPoolIdPatchError = UpdatePoolV1PoolsPoolIdPatchErrors[keyof UpdatePoolV1PoolsPoolIdPatchErrors];
+export type UpdatePoolV1PoolsPoolIdPatchResponses = {
+    /**
+     * Successful Response
+     */
+    200: PoolResponse;
+};
+export type UpdatePoolV1PoolsPoolIdPatchResponse = UpdatePoolV1PoolsPoolIdPatchResponses[keyof UpdatePoolV1PoolsPoolIdPatchResponses];
+export type RemoveMachinesFromPoolV1PoolsPoolIdMachinesDeleteData = {
+    body: MachinePoolAssignment;
+    path: {
+        pool_id: string;
+    };
+    query?: never;
+    url: '/v1/pools/{pool_id}/machines';
+};
+export type RemoveMachinesFromPoolV1PoolsPoolIdMachinesDeleteErrors = {
+    /**
+     * Validation Error
+     */
+    422: HttpValidationError;
+};
+export type RemoveMachinesFromPoolV1PoolsPoolIdMachinesDeleteError = RemoveMachinesFromPoolV1PoolsPoolIdMachinesDeleteErrors[keyof RemoveMachinesFromPoolV1PoolsPoolIdMachinesDeleteErrors];
+export type RemoveMachinesFromPoolV1PoolsPoolIdMachinesDeleteResponses = {
+    /**
+     * Successful Response
+     */
+    204: void;
+};
+export type RemoveMachinesFromPoolV1PoolsPoolIdMachinesDeleteResponse = RemoveMachinesFromPoolV1PoolsPoolIdMachinesDeleteResponses[keyof RemoveMachinesFromPoolV1PoolsPoolIdMachinesDeleteResponses];
+export type AddMachinesToPoolV1PoolsPoolIdMachinesPostData = {
+    body: MachinePoolAssignment;
+    path: {
+        pool_id: string;
+    };
+    query?: never;
+    url: '/v1/pools/{pool_id}/machines';
+};
+export type AddMachinesToPoolV1PoolsPoolIdMachinesPostErrors = {
+    /**
+     * Validation Error
+     */
+    422: HttpValidationError;
+};
+export type AddMachinesToPoolV1PoolsPoolIdMachinesPostError = AddMachinesToPoolV1PoolsPoolIdMachinesPostErrors[keyof AddMachinesToPoolV1PoolsPoolIdMachinesPostErrors];
+export type AddMachinesToPoolV1PoolsPoolIdMachinesPostResponses = {
+    /**
+     * Successful Response
+     */
+    200: PoolWithMachines;
+};
+export type AddMachinesToPoolV1PoolsPoolIdMachinesPostResponse = AddMachinesToPoolV1PoolsPoolIdMachinesPostResponses[keyof AddMachinesToPoolV1PoolsPoolIdMachinesPostResponses];
 export type ListWorkflowsV1WorkflowsGetData = {
     body?: never;
     path?: never;

package/dist/index.d.ts

@@ -25,7 +25,7 @@
  * });
  * ```
  */
-import { type MachineResponse, type WorkflowResponse, type RunResponse, type ConnectionResponse, type TrajectoryResponse, type PaginatedResponseMachineResponse, 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';
+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';
 export * from './client/types.gen';
 export * from './client/sdk.gen';
 export * from './client/client.gen';
@@ -107,6 +107,144 @@ export declare function createCyberdeskClient(apiKey: string, baseUrl?: string):
             request: Request;
             response: Response;
         }>;
+        /**
+         * Get all pools that a machine belongs to
+         *
+         * @param machineId - The ID of the machine
+         * @returns List of pools the machine belongs to
+         */
+        getPools: (machineId: string) => Promise<{
+            data?: PoolResponse[];
+            error?: any;
+        }>;
+        /**
+         * Update a machine's pool assignments
+         *
+         * This replaces all existing pool assignments with the new ones.
+         *
+         * @param machineId - The ID of the machine
+         * @param data - MachinePoolUpdate with pool_ids list
+         * @returns Updated machine details
+         */
+        updatePools: (machineId: string, data: MachinePoolUpdate) => Promise<{
+            data?: MachineResponse;
+            error?: any;
+        }>;
+    };
+    pools: {
+        /**
+         * List pools for the organization
+         *
+         * @param params - Optional query parameters
+         * @param params.skip - Number of items to skip (for pagination)
+         * @param params.limit - Maximum number of items to return
+         * @returns Paginated list of pools
+         */
+        list: (params?: {
+            skip?: number;
+            limit?: number;
+        }) => Promise<{
+            data?: PaginatedResponsePoolResponse;
+            error?: any;
+        }>;
+        /**
+         * Create a new pool
+         *
+         * @param data - Pool configuration
+         * @returns Created pool details
+         *
+         * @example
+         * ```typescript
+         * const pool = await client.pools.create({
+         *   name: 'Customer A',
+         *   description: 'All Customer A machines'
+         * });
+         * ```
+         */
+        create: (data: PoolCreate) => Promise<{
+            data?: PoolResponse;
+            error?: any;
+        }>;
+        /**
+         * Get a specific pool by ID
+         *
+         * @param poolId - The ID of the pool
+         * @param includeMachines - Whether to include full machine details
+         * @returns Pool details, optionally with machine list
+         */
+        get: (poolId: string, includeMachines?: boolean) => Promise<{
+            data?: PoolResponse | PoolWithMachines;
+            error?: any;
+        }>;
+        /**
+         * Update a pool's details
+         *
+         * @param poolId - The ID of the pool to update
+         * @param data - Update data (name, description)
+         * @returns Updated pool details
+         */
+        update: (poolId: string, data: PoolUpdate) => Promise<{
+            data?: PoolResponse;
+            error?: any;
+        }>;
+        /**
+         * Delete a pool
+         *
+         * This will not delete the machines in the pool.
+         *
+         * @param poolId - The ID of the pool to delete
+         */
+        delete: (poolId: string) => Promise<({
+            data: undefined;
+            error: import("./client/types.gen").HttpValidationError;
+        } | {
+            data: void;
+            error: undefined;
+        }) & {
+            request: Request;
+            response: Response;
+        }>;
+        /**
+         * Add machines to a pool
+         *
+         * @param poolId - The ID of the pool
+         * @param data - MachinePoolAssignment with machine_ids list
+         * @returns Pool with updated machine list
+         *
+         * @example
+         * ```typescript
+         * await client.pools.addMachines('pool-id', {
+         *   machine_ids: ['machine1-id', 'machine2-id']
+         * });
+         * ```
+         */
+        addMachines: (poolId: string, data: MachinePoolAssignment) => Promise<{
+            data?: PoolWithMachines;
+            error?: any;
+        }>;
+        /**
+         * Remove machines from a pool
+         *
+         * @param poolId - The ID of the pool
+         * @param data - MachinePoolAssignment with machine_ids list
+         *
+         * @example
+         * ```typescript
+         * await client.pools.removeMachines('pool-id', {
+         *   machine_ids: ['machine1-id']
+         * });
+         * ```
+         */
+        removeMachines: (poolId: string, data: MachinePoolAssignment) => Promise<({
+            data: undefined;
+            error: import("./client/types.gen").HttpValidationError;
+        } | {
+            data: void;
+            error: undefined;
+        }) & {
+            request: Request;
+            response: Response;
+        }>;
     };
     workflows: {
         /**
@@ -208,6 +346,7 @@ export declare function createCyberdeskClient(apiKey: string, baseUrl?: string):
          * @param data - Run configuration
          * @param data.workflow_id - The workflow to run
          * @param data.machine_id - Optional machine ID (auto-selected if not provided)
+         * @param data.pool_ids - Optional list of pool IDs (machine must be in ALL specified pools)
          * @param data.input_values - Optional input values for workflow variables
          * @param data.file_inputs - Optional files to upload to the machine
          * @returns Created run details
@@ -216,6 +355,7 @@ export declare function createCyberdeskClient(apiKey: string, baseUrl?: string):
          * ```typescript
          * const run = await client.runs.create({
          *   workflow_id: 'workflow-id',
+         *   pool_ids: ['pool1-id', 'pool2-id'], // Machine must be in both pools
          *   input_values: { prompt: 'Hello' },
          *   file_inputs: [{
          *     filename: 'data.txt',
@@ -242,6 +382,7 @@ export declare function createCyberdeskClient(apiKey: string, baseUrl?: string):
          * @param data.count - Number of runs to create (1-1000)
          * @param data.workflow_id - The workflow to run
          * @param data.machine_id - Optional machine ID (auto-selected if not provided)
+         * @param data.pool_ids - Optional list of pool IDs (machine must be in ALL specified pools)
          * @param data.input_values - Optional input values for workflow variables
          * @param data.file_inputs - Optional files to upload to the machine
          * @returns Details about created runs and any failures
@@ -251,6 +392,7 @@ export declare function createCyberdeskClient(apiKey: string, baseUrl?: string):
          * const result = await client.runs.bulkCreate({
          *   count: 100,
          *   workflow_id: 'workflow-id',
+         *   pool_ids: ['pool1-id'], // All runs require machines in this pool
          *   input_values: { prompt: 'Bulk task' },
          *   file_inputs: [{
          *     filename: 'data.txt',
@@ -534,4 +676,4 @@ export declare function createCyberdeskClient(apiKey: string, baseUrl?: string):
         }>;
     };
 };
-export type { MachineResponse, WorkflowResponse, RunResponse, RunBulkCreate, RunBulkCreateResponse, ConnectionResponse, TrajectoryResponse, RunAttachmentResponse, RunAttachmentDownloadUrlResponse, FileInput, AttachmentType, PaginatedResponseMachineResponse, PaginatedResponseWorkflowResponse, PaginatedResponseRunResponse, PaginatedResponseConnectionResponse, PaginatedResponseTrajectoryResponse, PaginatedResponseRunAttachmentResponse, };
+export type { MachineResponse, MachinePoolUpdate, PoolResponse, PoolCreate, PoolUpdate, PoolWithMachines, MachinePoolAssignment, WorkflowResponse, RunResponse, RunBulkCreate, RunBulkCreateResponse, ConnectionResponse, TrajectoryResponse, RunAttachmentResponse, RunAttachmentDownloadUrlResponse, FileInput, AttachmentType, PaginatedResponseMachineResponse, PaginatedResponsePoolResponse, PaginatedResponseWorkflowResponse, PaginatedResponseRunResponse, PaginatedResponseConnectionResponse, PaginatedResponseTrajectoryResponse, PaginatedResponseRunAttachmentResponse, };