@uipath/uipath-typescript 1.3.9 → 1.3.10

package/dist/index.d.ts

@@ -2478,6 +2478,8 @@ declare class EntityService extends BaseService implements EntityServiceModel {
  * Only exposes essential fields to SDK users
  */
 interface ChoiceSetGetAllResponse {
+    /** UUID of the choice set */
+    id: string;
     /** Name identifier of the choice set */
     name: string;
     /** Human-readable display name of the choice set*/
@@ -2522,6 +2524,46 @@ interface ChoiceSetGetResponse {
  * Options for getting choice set values by choice set ID
  */
 type ChoiceSetGetByIdOptions = PaginationOptions;
+/**
+ * Options for creating a new choice set
+ */
+interface ChoiceSetCreateOptions {
+    /** Human-readable display name */
+    displayName?: string;
+    /** Optional choice set description */
+    description?: string;
+    /** UUID of the folder to place the choice set in (defaults to the tenant-level folder) */
+    folderKey?: string;
+}
+/**
+ * Options for updating an existing choice set's metadata
+ */
+interface ChoiceSetUpdateOptions {
+    /** New display name for the choice set */
+    displayName?: string;
+    /** New description for the choice set */
+    description?: string;
+}
+/**
+ * Optional fields when inserting a single value into a choice set.
+ *
+ * The required `name` identifier is passed as a positional argument to
+ * `insertValueById`.
+ */
+interface ChoiceSetValueInsertOptions {
+    /** Human-readable display name */
+    displayName?: string;
+}
+/**
+ * Response returned after inserting a choice-set value — the full value object.
+ */
+interface ChoiceSetValueInsertResponse extends ChoiceSetGetResponse {
+}
+/**
+ * Response returned after updating a choice-set value — the full value object.
+ */
+interface ChoiceSetValueUpdateResponse extends ChoiceSetGetResponse {
+}
 
 /**
  * Service for managing UiPath Data Fabric Choice Sets
@@ -2604,6 +2646,134 @@ interface ChoiceSetServiceModel {
      * ```
      */
     getById<T extends ChoiceSetGetByIdOptions = ChoiceSetGetByIdOptions>(choiceSetId: string, options?: T): Promise<T extends HasPaginationOptions<T> ? PaginatedResponse<ChoiceSetGetResponse> : NonPaginatedResponse<ChoiceSetGetResponse>>;
+    /**
+     * Creates a new Data Fabric choice set
+     *
+     * @param name - Choice set name. Must start with a
+     *   letter, may contain only letters, numbers, and underscores, length
+     *   3–100 characters (e.g., `"expenseTypes"`).
+     * @param options - Optional choice-set-level settings ({@link ChoiceSetCreateOptions})
+     * @returns Promise resolving to the UUID of the created choice set
+     *
+     * @example
+     * ```typescript
+     * // Minimal create
+     * const expenseTypesId = await choicesets.create("expense_types");
+     *
+     * // With display name and description
+     * const priorityLevelsId = await choicesets.create("priority_levels", {
+     *   displayName: "Priority Levels",
+     *   description: "Ticket priority categories",
+     * });
+     * ```
+     * @internal
+     */
+    create(name: string, options?: ChoiceSetCreateOptions): Promise<string>;
+    /**
+     * Updates an existing choice set's metadata (display name and/or description).
+     *
+     * **At least one of `displayName` or `description` must be provided** —
+     * the call throws `ValidationError` if both are omitted.
+     *
+     * @param choiceSetId - UUID of the choice set to update
+     * @param options - Metadata fields to change ({@link ChoiceSetUpdateOptions})
+     * @returns Promise resolving when the update is complete
+     *
+     * @example
+     * ```typescript
+     * // First, get the choice set ID using getAll()
+     * const allChoiceSets = await choicesets.getAll();
+     * const expenseTypes = allChoiceSets.find(cs => cs.name === 'expense_types');
+     *
+     * await choicesets.updateById(expenseTypes.id, {
+     *   displayName: "Expense Categories",
+     *   description: "Updated description",
+     * });
+     * ```
+     * @internal
+     */
+    updateById(choiceSetId: string, options: ChoiceSetUpdateOptions): Promise<void>;
+    /**
+     * Deletes a Data Fabric choice set and all its values.
+     *
+     * @param choiceSetId - UUID of the choice set to delete
+     * @returns Promise resolving when the choice set is deleted
+     *
+     * @example
+     * ```typescript
+     * // First, get the choice set ID using getAll()
+     * const allChoiceSets = await choicesets.getAll();
+     * const expenseTypes = allChoiceSets.find(cs => cs.name === 'expense_types');
+     *
+     * await choicesets.deleteById(expenseTypes.id);
+     * ```
+     * @internal
+     */
+    deleteById(choiceSetId: string): Promise<void>;
+    /**
+     * Inserts a single value into a choice set.
+     *
+     * @param choiceSetId - UUID of the parent choice set
+     * @param name - Identifier name of the new value (e.g., `"TRAVEL"`)
+     * @param options - Optional fields ({@link ChoiceSetValueInsertOptions})
+     * @returns Promise resolving to the inserted value ({@link ChoiceSetValueInsertResponse})
+     *
+     * @example
+     * ```typescript
+     * // First, get the choice set ID using getAll()
+     * const allChoiceSets = await choicesets.getAll();
+     * const expenseTypes = allChoiceSets.find(cs => cs.name === 'expense_types');
+     *
+     * const inserted = await choicesets.insertValueById(expenseTypes.id, 'TRAVEL', {
+     *   displayName: 'Travel',
+     * });
+     * console.log(inserted.id);
+     * ```
+     * @internal
+     */
+    insertValueById(choiceSetId: string, name: string, options?: ChoiceSetValueInsertOptions): Promise<ChoiceSetValueInsertResponse>;
+    /**
+     * Updates an existing choice-set value's display name.
+     *
+     * Only `displayName` is mutable; the value's `name` (identifier) is fixed at
+     * insert time and cannot be changed.
+     *
+     * @param choiceSetId - UUID of the parent choice set
+     * @param valueId - UUID of the value to update
+     * @param displayName - New human-readable display name for the value
+     * @returns Promise resolving to the updated value ({@link ChoiceSetValueUpdateResponse})
+     *
+     * @example
+     * ```typescript
+     * // Get the choice set ID from getAll() and the value ID from getById()
+     * const allChoiceSets = await choicesets.getAll();
+     * const expenseTypes = allChoiceSets.find(cs => cs.name === 'expense_types');
+     * const values = await choicesets.getById(expenseTypes.id);
+     * const travel = values.items.find(v => v.name === 'TRAVEL');
+     *
+     * await choicesets.updateValueById(expenseTypes.id, travel.id, 'Business Travel');
+     * ```
+     * @internal
+     */
+    updateValueById(choiceSetId: string, valueId: string, displayName: string): Promise<ChoiceSetValueUpdateResponse>;
+    /**
+     * Deletes one or more values from a choice set.
+     *
+     * @param choiceSetId - UUID of the parent choice set
+     * @param valueIds - Array of value UUIDs to delete
+     * @returns Promise resolving when the values are deleted
+     *
+     * @example
+     * ```typescript
+     * // Get the value IDs from getById()
+     * const values = await choicesets.getById('<choiceSetId>');
+     * const idsToDelete = values.items.slice(0, 2).map(v => v.id);
+     *
+     * await choicesets.deleteValuesById('<choiceSetId>', idsToDelete);
+     * ```
+     * @internal
+     */
+    deleteValuesById(choiceSetId: string, valueIds: string[]): Promise<void>;
 }
 
 declare class ChoiceSetService extends BaseService implements ChoiceSetServiceModel {
@@ -2642,7 +2812,7 @@ declare class ChoiceSetService extends BaseService implements ChoiceSetServiceMo
      *
      * @example
      * ```typescript
-     * import { ChoiceSets } from '@uipath/uipath-typescript/choicesets';
+     * import { ChoiceSets } from '@uipath/uipath-typescript/entities';
      *
      * const choiceSets = new ChoiceSets(sdk);
      *
@@ -2669,6 +2839,139 @@ declare class ChoiceSetService extends BaseService implements ChoiceSetServiceMo
      * ```
      */
     getById<T extends ChoiceSetGetByIdOptions = ChoiceSetGetByIdOptions>(choiceSetId: string, options?: T): Promise<T extends HasPaginationOptions<T> ? PaginatedResponse<ChoiceSetGetResponse> : NonPaginatedResponse<ChoiceSetGetResponse>>;
+    /**
+     * Creates a new Data Fabric choice set
+     *
+     * @param name - Choice set name. Must start with a
+     *   letter, may contain only letters, numbers, and underscores, length
+     *   3–100 characters (e.g., `"expenseTypes"`).
+     * @param options - Optional choice-set-level settings ({@link ChoiceSetCreateOptions})
+     * @returns Promise resolving to the UUID of the created choice set
+     *
+     * @example
+     * ```typescript
+     * import { ChoiceSets } from '@uipath/uipath-typescript/entities';
+     *
+     * const choicesets = new ChoiceSets(sdk);
+     *
+     * // Minimal create
+     * const expenseTypesId = await choicesets.create("expense_types");
+     *
+     * // With display name and description
+     * const priorityLevelsId = await choicesets.create("priority_levels", {
+     *   displayName: "Priority Levels",
+     *   description: "Ticket priority categories",
+     * });
+     * ```
+     * @internal
+     */
+    create(name: string, options?: ChoiceSetCreateOptions): Promise<string>;
+    /**
+     * Updates an existing choice set's metadata (display name and/or description).
+     *
+     * **At least one of `displayName` or `description` must be provided** —
+     * the call throws `ValidationError` if both are omitted.
+     *
+     * @param choiceSetId - UUID of the choice set to update
+     * @param options - Metadata fields to change ({@link ChoiceSetUpdateOptions})
+     * @returns Promise resolving when the update is complete
+     *
+     * @example
+     * ```typescript
+     * // First, get the choice set ID using getAll()
+     * const allChoiceSets = await choicesets.getAll();
+     * const expenseTypes = allChoiceSets.find(cs => cs.name === 'expense_types');
+     *
+     * await choicesets.updateById(expenseTypes.id, {
+     *   displayName: "Expense Categories",
+     *   description: "Updated description",
+     * });
+     * ```
+     * @internal
+     */
+    updateById(choiceSetId: string, options: ChoiceSetUpdateOptions): Promise<void>;
+    /**
+     * Deletes a Data Fabric choice set and all its values.
+     *
+     * @param choiceSetId - UUID of the choice set to delete
+     * @returns Promise resolving when the choice set is deleted
+     *
+     * @example
+     * ```typescript
+     * // First, get the choice set ID using getAll()
+     * const allChoiceSets = await choicesets.getAll();
+     * const expenseTypes = allChoiceSets.find(cs => cs.name === 'expense_types');
+     *
+     * await choicesets.deleteById(expenseTypes.id);
+     * ```
+     * @internal
+     */
+    deleteById(choiceSetId: string): Promise<void>;
+    /**
+     * Inserts a single value into a choice set.
+     *
+     * @param choiceSetId - UUID of the parent choice set
+     * @param name - Identifier name of the new value (e.g., `"TRAVEL"`)
+     * @param options - Optional fields ({@link ChoiceSetValueInsertOptions})
+     * @returns Promise resolving to the inserted value ({@link ChoiceSetValueInsertResponse})
+     *
+     * @example
+     * ```typescript
+     * // First, get the choice set ID using getAll()
+     * const allChoiceSets = await choicesets.getAll();
+     * const expenseTypes = allChoiceSets.find(cs => cs.name === 'expense_types');
+     *
+     * const inserted = await choicesets.insertValueById(expenseTypes.id, 'TRAVEL', {
+     *   displayName: 'Travel',
+     * });
+     * console.log(inserted.id);
+     * ```
+     * @internal
+     */
+    insertValueById(choiceSetId: string, name: string, options?: ChoiceSetValueInsertOptions): Promise<ChoiceSetValueInsertResponse>;
+    /**
+     * Updates an existing choice-set value's display name.
+     *
+     * Only `displayName` is mutable; the value's `name` (identifier) is fixed at
+     * insert time and cannot be changed.
+     *
+     * @param choiceSetId - UUID of the parent choice set
+     * @param valueId - UUID of the value to update
+     * @param displayName - New human-readable display name for the value
+     * @returns Promise resolving to the updated value ({@link ChoiceSetValueUpdateResponse})
+     *
+     * @example
+     * ```typescript
+     * // Get the choice set ID from getAll() and the value ID from getById()
+     * const allChoiceSets = await choicesets.getAll();
+     * const expenseTypes = allChoiceSets.find(cs => cs.name === 'expense_types');
+     * const values = await choicesets.getById(expenseTypes.id);
+     * const travel = values.items.find(v => v.name === 'TRAVEL');
+     *
+     * await choicesets.updateValueById(expenseTypes.id, travel.id, 'Business Travel');
+     * ```
+     * @internal
+     */
+    updateValueById(choiceSetId: string, valueId: string, displayName: string): Promise<ChoiceSetValueUpdateResponse>;
+    /**
+     * Deletes one or more values from a choice set.
+     *
+     * @param choiceSetId - UUID of the parent choice set
+     * @param valueIds - Array of value UUIDs to delete
+     * @returns Promise resolving when the values are deleted
+     *
+     * @example
+     * ```typescript
+     * // Get the value IDs from getById()
+     * const values = await choicesets.getById('<choiceSetId>');
+     * const idsToDelete = values.items.slice(0, 2).map(v => v.id);
+     *
+     * await choicesets.deleteValuesById('<choiceSetId>', idsToDelete);
+     * ```
+     * @internal
+     */
+    deleteValuesById(choiceSetId: string, valueIds: string[]): Promise<void>;
+    private resolveChoiceSetName;
 }
 
 /**
@@ -6402,6 +6705,45 @@ interface BlobItem {
      */
     lastModified: string | null;
 }
+/**
+ * Represents a file or directory entry in a bucket
+ */
+interface BucketFile {
+    /**
+     * Full path to the file or directory
+     */
+    path: string;
+    /**
+     * Content type of the file (empty for directories)
+     */
+    contentType: string;
+    /**
+     * Size of the file in bytes
+     */
+    size: number;
+    /**
+     * Whether the entry is a directory
+     */
+    isDirectory: boolean;
+    /**
+     * Identifier of the file, when available
+     */
+    id: string | null;
+}
+/**
+ * Options for listing files in a bucket directory
+ */
+type BucketGetFilesOptions = RequestOptions & PaginationOptions & FolderScopedOptions & {
+    /**
+     * Regex pattern to filter file names (e.g., '.*\\.pdf$')
+     */
+    fileNameRegex?: string;
+};
+/**
+ * Options for deleting a file from a bucket
+ */
+interface BucketDeleteFileOptions extends FolderScopedOptions {
+}
 /**
  * Options for uploading files to a bucket
  */
@@ -6607,6 +6949,64 @@ interface BucketServiceModel {
      * ```
      */
     uploadFile(options: BucketUploadFileOptions): Promise<BucketUploadResponse>;
+    /**
+     * Deletes a file from a bucket
+     *
+     * @param bucketId - The ID of the bucket
+     * @param path - The full path to the file to delete
+     * @param options - Folder scoping (`folderId` / `folderKey` / `folderPath`)
+     * @returns Promise resolving when the file is deleted
+     * @example
+     * ```typescript
+     * // Delete a file from a bucket
+     * await buckets.deleteFile(<bucketId>, '/folder/file.pdf', { folderId: <folderId> });
+     * ```
+     */
+    deleteFile(bucketId: number, path: string, options?: BucketDeleteFileOptions): Promise<void>;
+    /**
+     * Lists all files in a bucket.
+     *
+     * Returns a flat, recursive listing of all files in the bucket. Supports regex filtering
+     * and filter / orderby / select / expand. {@link BucketFile} entries include
+     * `isDirectory` so callers can distinguish folders from files.
+     *
+     * The method returns either:
+     * - A NonPaginatedResponse with items array (when no pagination parameters are provided)
+     * - A PaginatedResponse with navigation cursors (when any pagination parameter is provided)
+     *
+     * @param bucketId - The ID of the bucket
+     * @param options - Folder scoping (`folderId` / `folderKey` / `folderPath`) and optional parameters for regex filtering, query options, and pagination
+     * {@link BucketGetFilesOptions}
+     * @returns Promise resolving to either an array of files NonPaginatedResponse<BucketFile> or a PaginatedResponse<BucketFile> when pagination options are used.
+     * {@link BucketFile}
+     * @example
+     * ```typescript
+     * // List all files in the bucket
+     * const files = await buckets.getFiles(<bucketId>, { folderId: <folderId> });
+     *
+     * // Filter by regex pattern
+     * const pdfs = await buckets.getFiles(<bucketId>, {
+     *   folderId: <folderId>,
+     *   fileNameRegex: '.*\\.pdf$'
+     * });
+     *
+     * // First page with pagination
+     * const page1 = await buckets.getFiles(<bucketId>, { folderId: <folderId>, pageSize: 10 });
+     *
+     * // Navigate using cursor
+     * if (page1.hasNextPage) {
+     *   const page2 = await buckets.getFiles(<bucketId>, { folderId: <folderId>, cursor: page1.nextCursor });
+     * }
+     *
+     * // Jump to specific page
+     * const page5 = await buckets.getFiles(<bucketId>, {
+     *   folderId: <folderId>,
+     *   jumpToPage: 5,
+     *   pageSize: 10
+     * });
+     * ```
+     */
+    getFiles<T extends BucketGetFilesOptions = BucketGetFilesOptions>(bucketId: number, options?: T): Promise<T extends HasPaginationOptions<T> ? PaginatedResponse<BucketFile> : NonPaginatedResponse<BucketFile>>;
 }
 
 declare class BucketService extends FolderScopedService implements BucketServiceModel {
@@ -6803,6 +7203,72 @@ declare class BucketService extends FolderScopedService implements BucketService
      * @returns Promise resolving to blob file access information
      */
     private _getUri;
+    /**
+     * Lists all files in a bucket.
+     *
+     * Returns a flat, recursive listing of all files in the bucket. Supports regex filtering
+     * and filter / orderby / select / expand. {@link BucketFile} entries include
+     * `isDirectory` so callers can distinguish folders from files.
+     *
+     * The method returns either:
+     * - A NonPaginatedResponse with items array (when no pagination parameters are provided)
+     * - A PaginatedResponse with navigation cursors (when any pagination parameter is provided)
+     *
+     * @param bucketId - The ID of the bucket
+     * @param options - Folder scoping (`folderId` / `folderKey` / `folderPath`) and optional parameters for regex filtering, query options, and pagination
+     * @returns Promise resolving to either an array of files NonPaginatedResponse<BucketFile> or a PaginatedResponse<BucketFile> when pagination options are used.
+     *
+     * @example
+     * ```typescript
+     * import { Buckets } from '@uipath/uipath-typescript/buckets';
+     *
+     * const buckets = new Buckets(sdk);
+     *
+     * // List all files in the bucket
+     * const files = await buckets.getFiles(<bucketId>, { folderId: <folderId> });
+     *
+     * // Filter by regex pattern
+     * const pdfs = await buckets.getFiles(<bucketId>, {
+     *   folderId: <folderId>,
+     *   fileNameRegex: '.*\\.pdf$'
+     * });
+     *
+     * // First page with pagination
+     * const page1 = await buckets.getFiles(<bucketId>, { folderId: <folderId>, pageSize: 10 });
+     *
+     * // Navigate using cursor
+     * if (page1.hasNextPage) {
+     *   const page2 = await buckets.getFiles(<bucketId>, { folderId: <folderId>, cursor: page1.nextCursor });
+     * }
+     *
+     * // Jump to specific page
+     * const page5 = await buckets.getFiles(<bucketId>, {
+     *   folderId: <folderId>,
+     *   jumpToPage: 5,
+     *   pageSize: 10
+     * });
+     * ```
+     */
+    getFiles<T extends BucketGetFilesOptions = BucketGetFilesOptions>(bucketId: number, options?: T): Promise<T extends HasPaginationOptions<T> ? PaginatedResponse<BucketFile> : NonPaginatedResponse<BucketFile>>;
+    /**
+     * Deletes a file from a bucket
+     *
+     * @param bucketId - The ID of the bucket
+     * @param path - The full path to the file to delete
+     * @param options - Folder scoping (`folderId` / `folderKey` / `folderPath`)
+     * @returns Promise resolving when the file is deleted
+     *
+     * @example
+     * ```typescript
+     * import { Buckets } from '@uipath/uipath-typescript/buckets';
+     *
+     * const buckets = new Buckets(sdk);
+     *
+     * // Delete a file from a bucket
+     * await buckets.deleteFile(<bucketId>, '/folder/file.pdf', { folderId: <folderId> });
+     * ```
+     */
+    deleteFile(bucketId: number, path: string, options?: BucketDeleteFileOptions): Promise<void>;
     /**
      * Gets a direct upload URL for a file in the bucket
      *
@@ -7171,6 +7637,17 @@ interface ProcessGetByIdOptions extends BaseOptions {
  */
 interface ProcessGetByNameOptions extends FolderScopedOptions {
 }
+/**
+ * Options for starting a process. Combines folder scoping
+ * (`folderId` / `folderKey` / `folderPath`) with the OData query options
+ * (`expand`, `select`, `filter`, `orderby`) accepted by the start endpoint.
+ *
+ * Folder scoping is optional in the type — the SDK falls back to the
+ * init-time folderKey (e.g. `<meta name="uipath:folder-key">` in coded-app
+ * deployments). A `ValidationError` is raised when neither is provided.
+ */
+interface ProcessStartOptions extends FolderScopedOptions, RequestOptions {
+}
 
 /**
  * Enum for job sub-state
@@ -7707,26 +8184,45 @@ interface ProcessServiceModel {
      */
     getByName(name: string, options?: ProcessGetByNameOptions): Promise<ProcessGetResponse>;
     /**
-     * Starts a process with the specified configuration
+     * Starts a process with the specified configuration.
+     *
+     * Folder context can be supplied as `folderId`, `folderKey`, or `folderPath`
+     * inside the options.
      *
      * @param request - Process start configuration
-     * @param folderId - Required folder ID
-     * @param options - Optional request options
+     * @param options - Folder scoping (`folderId` / `folderKey` / `folderPath`) and optional query parameters (`expand`, `select`, `filter`, `orderby`)
      * @returns Promise resolving to array of started process instances
      * {@link ProcessStartResponse}
      * @example
      * ```typescript
-     * // Start a process by process key
-     * const result = await processes.start({
-     *   processKey: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
-     * }, <folderId>); // folderId is required
+     * // By folder ID
+     * await processes.start({ processKey: '<processKey>' }, { folderId: <folderId> });
      *
-     * // Start a process by name with specific robots
-     * const result = await processes.start({
-     *   processName: "MyProcess"
-     * }, <folderId>); // folderId is required
+     * // By folder key (GUID)
+     * await processes.start({ processKey: '<processKey>' }, { folderKey: '5f6dadf1-3677-49dc-8aca-c2999dd4b3ba' });
+     *
+     * // By folder path
+     * await processes.start({ processKey: '<processKey>' }, { folderPath: 'Shared/Finance' });
+     *
+     * // Start by process name (instead of processKey)
+     * await processes.start({ processName: 'MyProcess' }, { folderId: <folderId> });
+     *
+     * // With additional options
+     * await processes.start({ processKey: '<processKey>' }, { folderId: <folderId>, expand: 'Robot' });
      * ```
      */
+    start(request: ProcessStartRequest, options?: ProcessStartOptions): Promise<ProcessStartResponse[]>;
+    /**
+     * Starts a process — positional `folderId` form.
+     *
+     * @deprecated Use the options-object form: `start(request, { folderId })`. See {@link ProcessStartOptions} for the supported options.
+     *
+     * @param request - Process start configuration
+     * @param folderId - Required folder ID (numeric)
+     * @param options - Optional request options
+     * @returns Promise resolving to array of started process instances
+     * {@link ProcessStartResponse}
+     */
     start(request: ProcessStartRequest, folderId: number, options?: RequestOptions): Promise<ProcessStartResponse[]>;
 }
 
@@ -7780,12 +8276,15 @@ declare class ProcessService extends FolderScopedService implements ProcessServi
      */
     getAll<T extends ProcessGetAllOptions = ProcessGetAllOptions>(options?: T): Promise<T extends HasPaginationOptions<T> ? PaginatedResponse<ProcessGetResponse> : NonPaginatedResponse<ProcessGetResponse>>;
     /**
-     * Starts a process execution (job)
+     * Starts a process with the specified configuration.
      *
-     * @param request - Process start request body
-     * @param folderId - Required folder ID
-     * @param options - Optional query parameters
-     * @returns Promise resolving to the created jobs
+     * Folder context can be supplied as `folderId`, `folderKey`, or `folderPath`
+     * inside the options.
+     *
+     * @param request - Process start configuration
+     * @param options - Folder scoping (`folderId` / `folderKey` / `folderPath`) and optional query parameters (`expand`, `select`, `filter`, `orderby`)
+     * @returns Promise resolving to array of started process instances
+     * {@link ProcessStartResponse}
      *
      * @example
      * ```typescript
@@ -7793,17 +8292,34 @@ declare class ProcessService extends FolderScopedService implements ProcessServi
      *
      * const processes = new Processes(sdk);
      *
-     * // Start a process by process key
-     * const jobs = await processes.start({
-     *   processKey: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
-     * }, 123); // folderId is required
+     * // By folder ID
+     * await processes.start({ processKey: '<processKey>' }, { folderId: <folderId> });
      *
-     * // Start a process by name with specific robots
-     * const jobs = await processes.start({
-     *   processName: "MyProcess"
-     * }, 123); // folderId is required
+     * // By folder key (GUID)
+     * await processes.start({ processKey: '<processKey>' }, { folderKey: '5f6dadf1-3677-49dc-8aca-c2999dd4b3ba' });
+     *
+     * // By folder path
+     * await processes.start({ processKey: '<processKey>' }, { folderPath: 'Shared/Finance' });
+     *
+     * // Start by process name (instead of processKey)
+     * await processes.start({ processName: 'MyProcess' }, { folderId: <folderId> });
+     *
+     * // With additional options
+     * await processes.start({ processKey: '<processKey>' }, { folderId: <folderId>, expand: 'Robot' });
      * ```
      */
+    start(request: ProcessStartRequest, options?: ProcessStartOptions): Promise<ProcessStartResponse[]>;
+    /**
+     * Starts a process — positional `folderId` form.
+     *
+     * @deprecated Use the options-object form: `start(request, { folderId })`. See {@link ProcessStartOptions} for the supported options.
+     *
+     * @param request - Process start configuration
+     * @param folderId - Required folder ID (numeric)
+     * @param options - Optional request options
+     * @returns Promise resolving to array of started process instances
+     * {@link ProcessStartResponse}
+     */
     start(request: ProcessStartRequest, folderId: number, options?: RequestOptions): Promise<ProcessStartResponse[]>;
     /**
      * Gets a single process by ID
@@ -15034,4 +15550,4 @@ declare const telemetryClient: {
 };
 
 export { AgentMap, AssetValueScope, AssetValueType, AuthenticationError, AuthorizationError, BucketOptions, CitationErrorType, ConversationGetAllFilterMap, ConversationMap, DEFAULT_ITEMS_FIELD, DEFAULT_PAGE_SIZE, DEFAULT_TOTAL_COUNT_FIELD, DataDirectionType, DebugMode, index as DuFramework, EntityAggregateFunction, EntityFieldDataType, EntityType, ErrorType, EscalationActionType, EscalationRecipientScope, EscalationTriggerType, ExchangeMap, FeedbackRating, FeedbackStatus, FieldDisplayType, HttpStatus, InputStreamSpeechSensitivity, InstanceFinalStatus, InstanceStatus, InterruptType, JobPriority, JobSourceType, JobState, JobSubState, JobType, JoinType, LogicalOperator$1 as LogicalOperator, MAX_PAGE_SIZE, MessageMap, MessageRole, NetworkError, NotFoundError, PackageSourceType, PackageType, ProcessIncidentSeverity, ProcessIncidentStatus, ProcessIncidentType, QueryFilterOperator, RateLimitError, ReferenceType, RemoteControlAccess, RobotSize, RuntimeType, SLADurationUnit, ServerError, ServerlessJobType, SlaSummaryStatus, SortOrder, StageTaskType, StartStrategy, StopStrategy, TargetFramework, TaskActivityType, TaskPriority, TaskSlaCriteria, TaskSlaStatus, TaskSourceName, TaskStatus, TaskType, TaskUserType, TimeInterval, UiPath, UiPathError, UiPathMetaTags, UserSettingsMap, ValidationError, createAgentWithMethods, createCaseInstanceWithMethods, createConversationWithMethods, createEntityWithMethods, createJobWithMethods, createProcessInstanceWithMethods, createProcessWithMethods, createTaskWithMethods, getAppBase, getAsset, getErrorDetails, getLimitedPageSize, isAuthenticationError, isAuthorizationError, isNetworkError, isNotFoundError, isRateLimitError, isServerError, isUiPathError, isValidationError, loadFromMetaTags, telemetryClient, track, trackEvent };
-export type { AgentAppearance, AgentConversationServiceModel, AgentCreateConversationOptions, AgentGetByIdResponse, AgentGetResponse, AgentInput, AgentMethods, AgentStartingPrompt, ArgumentMetadata, AssetGetAllOptions, AssetGetByIdOptions, AssetGetByNameOptions, AssetGetResponse, AssetServiceModel, AsyncInputStream, AsyncInputStreamChunkEvent, AsyncInputStreamEndEvent, AsyncInputStreamEvent, AsyncInputStreamStartEvent, AsyncToolCallStream, AttachmentGetByIdOptions, AttachmentResponse, AttachmentServiceModel, BaseConfig, BaseOptions, BaseProcessStartRequest, BlobItem, BodyOptions, BpmnXmlString, BucketGetAllOptions, BucketGetByIdOptions, BucketGetByNameOptions, BucketGetFileMetaDataOptions, BucketGetFileMetaDataResponse, BucketGetFileMetaDataWithPaginationOptions, BucketGetReadUriOptions, BucketGetResponse, BucketGetUriOptions, BucketGetUriResponse, BucketServiceModel, BucketUploadFileOptions, BucketUploadResponse, CaseAppConfig, CaseAppOverview, CaseGetAllResponse, CaseGetStageResponse, CaseGetTopDurationResponse, CaseGetTopFaultedCountResponse, CaseGetTopRunCountResponse, CaseInstanceExecutionHistoryResponse, CaseInstanceGetAllOptions, CaseInstanceGetAllWithPaginationOptions, CaseInstanceGetResponse, CaseInstanceMethods, CaseInstanceOperationOptions, CaseInstanceOperationResponse, CaseInstanceReopenOptions, CaseInstanceRun, CaseInstanceSlaSummaryOptions, CaseInstanceStageSLAOptions, CaseInstanceStageSLAResponse, CaseInstanceStageSLAStage, CaseInstancesServiceModel, CasesServiceModel, ChoiceSetGetAllResponse, ChoiceSetGetByIdOptions, ChoiceSetGetResponse, ChoiceSetServiceModel, Citation, CitationEndEvent, CitationError, CitationEvent, CitationOptions, CitationSource, CitationSourceBase, CitationSourceMedia, CitationSourceUrl, CitationStartEvent, CollectionResponse, CompletedContentPart, CompletedMessage, CompletedToolCall, ContentPart, ContentPartChunkEvent, ContentPartData, ContentPartEndEvent, ContentPartEvent, ContentPartGetResponse, ContentPartInterrupted, ContentPartStartEvent, ContentPartStartMetaData, ContentPartStream, ConversationAttachmentCreateResponse, ConversationAttachmentUploadResponse, ConversationCreateOptions, ConversationCreateResponse, ConversationDeleteResponse, ConversationEvent, ConversationExchangeServiceModel, ConversationGetAllOptions, ConversationGetResponse, ConversationJobStartOverrides, ConversationMethods, ConversationServiceModel, ConversationSessionMethods, ConversationSessionOptions, ConversationUpdateOptions, ConversationUpdateResponse, ConversationalAgentOptions, ConversationalAgentServiceModel, CreateFeedbackOptions, CustomKeyValuePair, ElementExecutionMetadata, ElementMetaData, ElementRunMetadata, EntityAggregate, EntityBatchInsertOptions, EntityBatchInsertResponse, EntityCreateFieldOptions, EntityCreateOptions, EntityDeleteAttachmentResponse, EntityDeleteOptions, EntityDeleteRecordsOptions, EntityDeleteResponse, EntityFieldBase, EntityFieldUpdateOptions, EntityFileType, EntityGetAllRecordsOptions, EntityGetRecordByIdOptions, EntityGetRecordsByIdOptions, EntityGetResponse, EntityImportRecordsResponse, EntityInsertOptions, EntityInsertRecordOptions, EntityInsertRecordsOptions, EntityInsertResponse, EntityMethods, EntityOperationOptions, EntityOperationResponse, EntityQueryFilter, EntityQueryFilterGroup, EntityQueryRecordsOptions, EntityQueryRecordsResponse, EntityQuerySortOption, EntityRecord, EntityRemoveFieldOptions, EntityServiceModel, EntityUpdateByIdOptions, EntityUpdateOptions, EntityUpdateRecordOptions, EntityUpdateRecordResponse, EntityUpdateRecordsOptions, EntityUpdateResponse, EntityUploadAttachmentOptions, EntityUploadAttachmentResponse, ErrorEndEvent, ErrorEvent, ErrorStartEvent, EscalationAction, EscalationRecipient, EscalationRule, EscalationTriggerMetadata, Exchange, ExchangeEndEvent, ExchangeEvent, ExchangeGetAllOptions, ExchangeGetByIdOptions, ExchangeGetResponse, ExchangeServiceModel, ExchangeStartEvent, ExchangeStream, ExternalConnection, ExternalField, ExternalFieldMapping, ExternalObject, ExternalSourceFields, ExternalValue, FailureRecord, FeatureFlags, FeedbackCategory, FeedbackCategoryInput, FeedbackCategoryResponse, FeedbackCreateCategoryOptions, FeedbackCreateResponse, FeedbackDeleteCategoryOptions, FeedbackGetAllOptions, FeedbackGetCategoriesOptions, FeedbackGetResponse, FeedbackOptions, FeedbackResponse, FeedbackServiceModel, FeedbackSubmitOptions, FeedbackUpdateOptions, Field$1 as Field, FieldDataType, FieldMetaData, FileUploadAccess, FolderProperties, FolderScopedOptions, GenericInterruptStartEvent, GetTopBaseResponse, GetTopDurationResponse, GetTopFaultedCountResponse, GetTopRunCountResponse, GlobalVariableMetaData, HasPaginationOptions, Headers, HttpMethod, InlineOrExternalValue, InlineValue, InstanceStatusTimelineResponse, Interrupt, InterruptEndEvent, InterruptEvent, InterruptStartEvent, JSONArray, JSONObject, JSONPrimitive, JSONValue, JobAttachment, JobError, JobGetAllOptions, JobGetByIdOptions, JobGetResponse, JobMethods, JobResumeOptions, JobServiceModel, JobStopOptions, LabelUpdatedEvent, Machine, MaestroProcessGetAllResponse, MaestroProcessesServiceModel, MakeOptional, MakeRequired, Message, MessageEndEvent, MessageEvent, MessageGetResponse, MessageServiceModel, MessageStartEvent, MessageStream, MetaData, MetaEvent, NonPaginatedResponse, OAuthFields, OperationResponse, PaginatedResponse, PaginationCursor, PaginationMetadata, PaginationMethodUnion, PaginationOptions, PartialUiPathConfig, ProcessGetAllOptions, ProcessGetByIdOptions, ProcessGetByNameOptions, ProcessGetResponse, ProcessGetTopDurationResponse, ProcessGetTopFaultedCountResponse, ProcessGetTopRunCountResponse, ProcessIncidentGetAllResponse, ProcessIncidentGetResponse, ProcessIncidentsServiceModel, ProcessInstanceExecutionHistoryResponse, ProcessInstanceGetAllOptions, ProcessInstanceGetAllWithPaginationOptions, ProcessInstanceGetResponse, ProcessInstanceGetVariablesOptions, ProcessInstanceGetVariablesResponse, ProcessInstanceMethods, ProcessInstanceOperationOptions, ProcessInstanceOperationResponse, ProcessInstanceRun, ProcessInstancesServiceModel, ProcessMetadata, ProcessMethods, ProcessProperties, ProcessServiceModel, ProcessStartRequest, ProcessStartRequestWithKey, ProcessStartRequestWithName, ProcessStartResponse, QueryParams, QueueGetAllOptions, QueueGetByIdOptions, QueueGetResponse, QueueServiceModel, RawAgentGetByIdResponse, RawAgentGetResponse, RawCaseInstanceGetResponse, RawConversationGetResponse, RawEntityGetResponse, RawJobGetResponse, RawMaestroProcessGetAllResponse, RawProcessInstanceGetResponse, RawTaskCreateResponse, RawTaskGetResponse, RequestOptions, RequestSpec, ResponseDictionary, ResponseType, RetryOptions, RobotMetadata, SessionCapabilities, SessionEndEvent, SessionEndingEvent, SessionStartEvent, SessionStartedEvent, SessionStream, Simplify, SlaSummaryResponse, SourceJoinCriteria, SqlType, StageSLA, StageTask, Tag, TaskActivity, TaskAssignOptions, TaskAssignment, TaskAssignmentOptions, TaskAssignmentResponse, TaskBaseResponse, TaskCompleteOptions, TaskCompletionOptions, TaskCreateOptions, TaskCreateResponse, TaskGetAllOptions, TaskGetByIdOptions, TaskGetResponse, TaskGetUsersOptions, TaskMethods, TaskServiceModel, TaskSlaDetail, TaskSource, TasksUnassignOptions, TimelineOptions, TimeoutOptions, ToolCall, ToolCallConfirmationEndValue, ToolCallConfirmationEvent, ToolCallConfirmationInterruptStartEvent, ToolCallConfirmationValue, ToolCallEndEvent, ToolCallEvent, ToolCallInputValue, ToolCallOutputValue, ToolCallResult, ToolCallStartEvent, ToolCallStream, TopQueryOptions, UiPathSDKConfig, UserLoginInfo, UserSettingsGetResponse, UserSettingsServiceModel, UserSettingsUpdateOptions, UserSettingsUpdateResponse };
+export type { AgentAppearance, AgentConversationServiceModel, AgentCreateConversationOptions, AgentGetByIdResponse, AgentGetResponse, AgentInput, AgentMethods, AgentStartingPrompt, ArgumentMetadata, AssetGetAllOptions, AssetGetByIdOptions, AssetGetByNameOptions, AssetGetResponse, AssetServiceModel, AsyncInputStream, AsyncInputStreamChunkEvent, AsyncInputStreamEndEvent, AsyncInputStreamEvent, AsyncInputStreamStartEvent, AsyncToolCallStream, AttachmentGetByIdOptions, AttachmentResponse, AttachmentServiceModel, BaseConfig, BaseOptions, BaseProcessStartRequest, BlobItem, BodyOptions, BpmnXmlString, BucketDeleteFileOptions, BucketFile, BucketGetAllOptions, BucketGetByIdOptions, BucketGetByNameOptions, BucketGetFileMetaDataOptions, BucketGetFileMetaDataResponse, BucketGetFileMetaDataWithPaginationOptions, BucketGetFilesOptions, BucketGetReadUriOptions, BucketGetResponse, BucketGetUriOptions, BucketGetUriResponse, BucketServiceModel, BucketUploadFileOptions, BucketUploadResponse, CaseAppConfig, CaseAppOverview, CaseGetAllResponse, CaseGetStageResponse, CaseGetTopDurationResponse, CaseGetTopFaultedCountResponse, CaseGetTopRunCountResponse, CaseInstanceExecutionHistoryResponse, CaseInstanceGetAllOptions, CaseInstanceGetAllWithPaginationOptions, CaseInstanceGetResponse, CaseInstanceMethods, CaseInstanceOperationOptions, CaseInstanceOperationResponse, CaseInstanceReopenOptions, CaseInstanceRun, CaseInstanceSlaSummaryOptions, CaseInstanceStageSLAOptions, CaseInstanceStageSLAResponse, CaseInstanceStageSLAStage, CaseInstancesServiceModel, CasesServiceModel, ChoiceSetCreateOptions, ChoiceSetGetAllResponse, ChoiceSetGetByIdOptions, ChoiceSetGetResponse, ChoiceSetServiceModel, ChoiceSetUpdateOptions, ChoiceSetValueInsertOptions, ChoiceSetValueInsertResponse, ChoiceSetValueUpdateResponse, Citation, CitationEndEvent, CitationError, CitationEvent, CitationOptions, CitationSource, CitationSourceBase, CitationSourceMedia, CitationSourceUrl, CitationStartEvent, CollectionResponse, CompletedContentPart, CompletedMessage, CompletedToolCall, ContentPart, ContentPartChunkEvent, ContentPartData, ContentPartEndEvent, ContentPartEvent, ContentPartGetResponse, ContentPartInterrupted, ContentPartStartEvent, ContentPartStartMetaData, ContentPartStream, ConversationAttachmentCreateResponse, ConversationAttachmentUploadResponse, ConversationCreateOptions, ConversationCreateResponse, ConversationDeleteResponse, ConversationEvent, ConversationExchangeServiceModel, ConversationGetAllOptions, ConversationGetResponse, ConversationJobStartOverrides, ConversationMethods, ConversationServiceModel, ConversationSessionMethods, ConversationSessionOptions, ConversationUpdateOptions, ConversationUpdateResponse, ConversationalAgentOptions, ConversationalAgentServiceModel, CreateFeedbackOptions, CustomKeyValuePair, ElementExecutionMetadata, ElementMetaData, ElementRunMetadata, EntityAggregate, EntityBatchInsertOptions, EntityBatchInsertResponse, EntityCreateFieldOptions, EntityCreateOptions, EntityDeleteAttachmentResponse, EntityDeleteOptions, EntityDeleteRecordsOptions, EntityDeleteResponse, EntityFieldBase, EntityFieldUpdateOptions, EntityFileType, EntityGetAllRecordsOptions, EntityGetRecordByIdOptions, EntityGetRecordsByIdOptions, EntityGetResponse, EntityImportRecordsResponse, EntityInsertOptions, EntityInsertRecordOptions, EntityInsertRecordsOptions, EntityInsertResponse, EntityMethods, EntityOperationOptions, EntityOperationResponse, EntityQueryFilter, EntityQueryFilterGroup, EntityQueryRecordsOptions, EntityQueryRecordsResponse, EntityQuerySortOption, EntityRecord, EntityRemoveFieldOptions, EntityServiceModel, EntityUpdateByIdOptions, EntityUpdateOptions, EntityUpdateRecordOptions, EntityUpdateRecordResponse, EntityUpdateRecordsOptions, EntityUpdateResponse, EntityUploadAttachmentOptions, EntityUploadAttachmentResponse, ErrorEndEvent, ErrorEvent, ErrorStartEvent, EscalationAction, EscalationRecipient, EscalationRule, EscalationTriggerMetadata, Exchange, ExchangeEndEvent, ExchangeEvent, ExchangeGetAllOptions, ExchangeGetByIdOptions, ExchangeGetResponse, ExchangeServiceModel, ExchangeStartEvent, ExchangeStream, ExternalConnection, ExternalField, ExternalFieldMapping, ExternalObject, ExternalSourceFields, ExternalValue, FailureRecord, FeatureFlags, FeedbackCategory, FeedbackCategoryInput, FeedbackCategoryResponse, FeedbackCreateCategoryOptions, FeedbackCreateResponse, FeedbackDeleteCategoryOptions, FeedbackGetAllOptions, FeedbackGetCategoriesOptions, FeedbackGetResponse, FeedbackOptions, FeedbackResponse, FeedbackServiceModel, FeedbackSubmitOptions, FeedbackUpdateOptions, Field$1 as Field, FieldDataType, FieldMetaData, FileUploadAccess, FolderProperties, FolderScopedOptions, GenericInterruptStartEvent, GetTopBaseResponse, GetTopDurationResponse, GetTopFaultedCountResponse, GetTopRunCountResponse, GlobalVariableMetaData, HasPaginationOptions, Headers, HttpMethod, InlineOrExternalValue, InlineValue, InstanceStatusTimelineResponse, Interrupt, InterruptEndEvent, InterruptEvent, InterruptStartEvent, JSONArray, JSONObject, JSONPrimitive, JSONValue, JobAttachment, JobError, JobGetAllOptions, JobGetByIdOptions, JobGetResponse, JobMethods, JobResumeOptions, JobServiceModel, JobStopOptions, LabelUpdatedEvent, Machine, MaestroProcessGetAllResponse, MaestroProcessesServiceModel, MakeOptional, MakeRequired, Message, MessageEndEvent, MessageEvent, MessageGetResponse, MessageServiceModel, MessageStartEvent, MessageStream, MetaData, MetaEvent, NonPaginatedResponse, OAuthFields, OperationResponse, PaginatedResponse, PaginationCursor, PaginationMetadata, PaginationMethodUnion, PaginationOptions, PartialUiPathConfig, ProcessGetAllOptions, ProcessGetByIdOptions, ProcessGetByNameOptions, ProcessGetResponse, ProcessGetTopDurationResponse, ProcessGetTopFaultedCountResponse, ProcessGetTopRunCountResponse, ProcessIncidentGetAllResponse, ProcessIncidentGetResponse, ProcessIncidentsServiceModel, ProcessInstanceExecutionHistoryResponse, ProcessInstanceGetAllOptions, ProcessInstanceGetAllWithPaginationOptions, ProcessInstanceGetResponse, ProcessInstanceGetVariablesOptions, ProcessInstanceGetVariablesResponse, ProcessInstanceMethods, ProcessInstanceOperationOptions, ProcessInstanceOperationResponse, ProcessInstanceRun, ProcessInstancesServiceModel, ProcessMetadata, ProcessMethods, ProcessProperties, ProcessServiceModel, ProcessStartOptions, ProcessStartRequest, ProcessStartRequestWithKey, ProcessStartRequestWithName, ProcessStartResponse, QueryParams, QueueGetAllOptions, QueueGetByIdOptions, QueueGetResponse, QueueServiceModel, RawAgentGetByIdResponse, RawAgentGetResponse, RawCaseInstanceGetResponse, RawConversationGetResponse, RawEntityGetResponse, RawJobGetResponse, RawMaestroProcessGetAllResponse, RawProcessInstanceGetResponse, RawTaskCreateResponse, RawTaskGetResponse, RequestOptions, RequestSpec, ResponseDictionary, ResponseType, RetryOptions, RobotMetadata, SessionCapabilities, SessionEndEvent, SessionEndingEvent, SessionStartEvent, SessionStartedEvent, SessionStream, Simplify, SlaSummaryResponse, SourceJoinCriteria, SqlType, StageSLA, StageTask, Tag, TaskActivity, TaskAssignOptions, TaskAssignment, TaskAssignmentOptions, TaskAssignmentResponse, TaskBaseResponse, TaskCompleteOptions, TaskCompletionOptions, TaskCreateOptions, TaskCreateResponse, TaskGetAllOptions, TaskGetByIdOptions, TaskGetResponse, TaskGetUsersOptions, TaskMethods, TaskServiceModel, TaskSlaDetail, TaskSource, TasksUnassignOptions, TimelineOptions, TimeoutOptions, ToolCall, ToolCallConfirmationEndValue, ToolCallConfirmationEvent, ToolCallConfirmationInterruptStartEvent, ToolCallConfirmationValue, ToolCallEndEvent, ToolCallEvent, ToolCallInputValue, ToolCallOutputValue, ToolCallResult, ToolCallStartEvent, ToolCallStream, TopQueryOptions, UiPathSDKConfig, UserLoginInfo, UserSettingsGetResponse, UserSettingsServiceModel, UserSettingsUpdateOptions, UserSettingsUpdateResponse };