@uipath/uipath-typescript 1.0.0-beta.10

package/dist/services/action-center/tasks.d.ts

@@ -0,0 +1,254 @@
+import { BaseService } from '../base';
+import { Config } from '../../core/config/config';
+import { ExecutionContext } from '../../core/context/execution';
+import { TokenManager } from '../../core/auth/token-manager';
+import { TaskCreateOptions, TaskAssignmentOptions, TaskAssignmentResponse, TaskCompletionOptions, TaskType, TaskGetAllOptions, TaskGetByIdOptions, UserLoginInfo, TaskGetUsersOptions } from '../../models/action-center/tasks.types';
+import { TaskServiceModel, TaskGetResponse, TaskCreateResponse } from '../../models/action-center/tasks.models';
+import { OperationResponse } from '../../models/common/types';
+import { PaginatedResponse, NonPaginatedResponse, HasPaginationOptions } from '../../utils/pagination';
+/**
+ * Service for interacting with UiPath Tasks API
+ */
+export declare class TaskService extends BaseService implements TaskServiceModel {
+    /**
+     * @hideconstructor
+     */
+    constructor(config: Config, executionContext: ExecutionContext, tokenManager: TokenManager);
+    /**
+     * Creates a new task
+     * @param task - The task to be created
+     * @param folderId - Required folder ID
+     * @returns Promise resolving to the created task
+     *
+     * @example
+     * ```typescript
+     * const task = await sdk.tasks.create({
+     *   title: "My Task",
+     *   priority: TaskPriority.Medium,
+     *   data: { key: "value" }
+     * }, 123); // folderId is required
+     * ```
+     */
+    create(task: TaskCreateOptions, folderId: number): Promise<TaskCreateResponse>;
+    /**
+     * Gets users in the given folder who have Tasks.View and Tasks.Edit permissions
+     *
+     * The method returns either:
+     * - An array of users (when no pagination parameters are provided)
+     * - A paginated result with navigation cursors (when any pagination parameter is provided)
+     *
+     * @param folderId - The folder ID to get users from
+     * @param options - Optional query and pagination parameters
+     * @returns Promise resolving to an array of users or paginated result
+     *
+     * @example
+     * ```typescript
+     * // Standard array return
+     * const users = await sdk.tasks.getUsers(123);
+     *
+     * // Get users with filtering
+     * const users = await sdk.tasks.getUsers(123, {
+     *   filter: "name eq 'abc'"
+     * });
+     *
+     * // First page with pagination
+     * const page1 = await sdk.tasks.getUsers(123, { pageSize: 10 });
+     *
+     * // Navigate using cursor
+     * if (page1.hasNextPage) {
+     *   const page2 = await sdk.tasks.getUsers(123, { cursor: page1.nextCursor });
+     * }
+     *
+     * // Jump to specific page
+     * const page5 = await sdk.tasks.getUsers(123, {
+     *   jumpToPage: 5,
+     *   pageSize: 10
+     * });
+     * ```
+     */
+    getUsers<T extends TaskGetUsersOptions = TaskGetUsersOptions>(folderId: number, options?: T): Promise<T extends HasPaginationOptions<T> ? PaginatedResponse<UserLoginInfo> : NonPaginatedResponse<UserLoginInfo>>;
+    /**
+     * Gets tasks across folders with optional filtering and folder scoping
+     *
+     * The method returns either:
+     * - An array of tasks (when no pagination parameters are provided)
+     * - A paginated result with navigation cursors (when any pagination parameter is provided)
+     *
+     * @param options - Query options including optional folderId and pagination options
+     * @returns Promise resolving to an array of tasks or paginated result
+     *
+     * @example
+     * ```typescript
+     * // Standard array return
+     * const tasks = await sdk.tasks.getAll();
+     *
+     * // Get tasks within a specific folder
+     * const tasks = await sdk.tasks.getAll({
+     *   folderId: 123
+     * });
+     *
+     * // First page with pagination
+     * const page1 = await sdk.tasks.getAll({ pageSize: 10 });
+     *
+     * // Navigate using cursor
+     * if (page1.hasNextPage) {
+     *   const page2 = await sdk.tasks.getAll({ cursor: page1.nextCursor });
+     * }
+     *
+     * // Jump to specific page
+     * const page5 = await sdk.tasks.getAll({
+     *   jumpToPage: 5,
+     *   pageSize: 10
+     * });
+     * ```
+     */
+    getAll<T extends TaskGetAllOptions = TaskGetAllOptions>(options?: T): Promise<T extends HasPaginationOptions<T> ? PaginatedResponse<TaskGetResponse> : NonPaginatedResponse<TaskGetResponse>>;
+    /**
+     * Gets a task by ID
+     *
+     * @param id - The ID of the task to retrieve
+     * @param options - Optional query parameters
+     * @param folderId - Optional folder ID
+     * @returns Promise resolving to the task (form tasks will return form-specific data)
+     *
+     * @example
+     * ```typescript
+     * // Get task by ID
+     * const task = await sdk.tasks.getById(123);
+     *
+     * // If the task is a form task, it will automatically return form-specific data
+     * ```
+     */
+    getById(id: number, options?: TaskGetByIdOptions, folderId?: number): Promise<TaskGetResponse>;
+    /**
+     * Assigns tasks to users
+     *
+     * @param taskAssignments - Single task assignment or array of task assignments
+     * @param folderId - Optional folder ID
+     * @returns Promise resolving to array of task assignment results
+     *
+     * @example
+     * ```typescript
+     * // Assign a single task to a user by ID
+     * const result = await sdk.tasks.assign({
+     *   taskId: 123,
+     *   userId: 456
+     * });
+     *
+     * // Assign a single task to a user by email
+     * const result = await sdk.tasks.assign({
+     *   taskId: 123,
+     *   userNameOrEmail: "user@example.com"
+     * });
+     *
+     * // Assign multiple tasks
+     * const result = await sdk.tasks.assign([
+     *   {
+     *     taskId: 123,
+     *     userId: 456
+     *   },
+     *   {
+     *     taskId: 789,
+     *     userNameOrEmail: "user@example.com"
+     *   }
+     * ]);
+     * ```
+     */
+    assign(taskAssignments: TaskAssignmentOptions | TaskAssignmentOptions[], folderId?: number): Promise<OperationResponse<TaskAssignmentOptions[] | TaskAssignmentResponse[]>>;
+    /**
+     * Reassigns tasks to new users
+     *
+     * @param taskAssignments - Single task assignment or array of task assignments
+     * @param folderId - Optional folder ID
+     * @returns Promise resolving to array of task assignment results
+     *
+     * @example
+     * ```typescript
+     * // Reassign a single task to a user by ID
+     * const result = await sdk.tasks.reassign({
+     *   taskId: 123,
+     *   userId: 456
+     * });
+     *
+     * // Reassign a single task to a user by email
+     * const result = await sdk.tasks.reassign({
+     *   taskId: 123,
+     *   userNameOrEmail: "user@example.com"
+     * });
+     *
+     * // Reassign multiple tasks
+     * const result = await sdk.tasks.reassign([
+     *   {
+     *     taskId: 123,
+     *     userId: 456
+     *   },
+     *   {
+     *     taskId: 789,
+     *     userNameOrEmail: "user@example.com"
+     *   }
+     * ]);
+     * ```
+     */
+    reassign(taskAssignments: TaskAssignmentOptions | TaskAssignmentOptions[], folderId?: number): Promise<OperationResponse<TaskAssignmentOptions[] | TaskAssignmentResponse[]>>;
+    /**
+     * Unassigns tasks (removes current assignees)
+     *
+     * @param taskIds - Single task ID or array of task IDs to unassign
+     * @param folderId - Optional folder ID
+     * @returns Promise resolving to array of task assignment results
+     *
+     * @example
+     * ```typescript
+     * // Unassign a single task
+     * const result = await sdk.tasks.unassign(123);
+     *
+     * // Unassign multiple tasks
+     * const result = await sdk.tasks.unassign([123, 456, 789]);
+     * ```
+     */
+    unassign(taskIds: number | number[], folderId?: number): Promise<OperationResponse<{
+        taskId: number;
+    }[] | TaskAssignmentResponse[]>>;
+    /**
+     * Completes a task with the specified type and data
+     *
+     * @param completionType - The type of task (Form, App, or Generic)
+     * @param options - The completion options
+     * @param folderId - Required folder ID
+     * @returns Promise resolving to void
+     *
+     * @example
+     * ```typescript
+     * // Complete an app task
+     * await sdk.tasks.complete(TaskType.App, {
+     *   taskId: 456,
+     *   data: {},
+     *   action: "submit"
+     * }, 123); // folderId is required
+     *
+     * // Complete an external task
+     * await sdk.tasks.complete(TaskType.ExternalTask, {
+     *   taskId: 789
+     * }, 123); // folderId is required
+     * ```
+     */
+    complete(completionType: TaskType, options: TaskCompletionOptions, folderId: number): Promise<OperationResponse<TaskCompletionOptions>>;
+    /**
+     * Gets a form task by ID (private method)
+     *
+     * @param id - The ID of the form task to retrieve
+     * @param folderId - Required folder ID
+     * @param options - Optional query parameters
+     * @returns Promise resolving to the form task
+     */
+    private getFormTaskById;
+    /**
+     * Process parameters for task queries with folder filtering
+     * @param options - The REST API options to process
+     * @param folderId - Optional folder ID to filter by
+     * @returns Processed options with folder filtering applied if needed
+     * @private
+     */
+    private processTaskParameters;
+}
+//# sourceMappingURL=tasks.d.ts.map

package/dist/services/action-center/tasks.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"tasks.d.ts","sourceRoot":"","sources":["../../../src/services/action-center/tasks.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AACtC,OAAO,EAAE,MAAM,EAAE,MAAM,0BAA0B,CAAC;AAClD,OAAO,EAAE,gBAAgB,EAAE,MAAM,8BAA8B,CAAC;AAChE,OAAO,EAAE,YAAY,EAAE,MAAM,+BAA+B,CAAC;AAC7D,OAAO,EACL,iBAAiB,EACjB,qBAAqB,EACrB,sBAAsB,EAEtB,qBAAqB,EACrB,QAAQ,EACR,iBAAiB,EACjB,kBAAkB,EAClB,aAAa,EACb,mBAAmB,EACpB,MAAM,wCAAwC,CAAC;AAChD,OAAO,EACL,gBAAgB,EAChB,eAAe,EACf,kBAAkB,EAEnB,MAAM,yCAAyC,CAAC;AACjD,OAAO,EAAE,iBAAiB,EAAE,MAAM,2BAA2B,CAAC;AAO9D,OAAO,EAAE,iBAAiB,EAAE,oBAAoB,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AAOvG;;GAEG;AACH,qBAAa,WAAY,SAAQ,WAAY,YAAW,gBAAgB;IACtE;;OAEG;gBACS,MAAM,EAAE,MAAM,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,YAAY,EAAE,YAAY;IAI1F;;;;;;;;;;;;;;OAcG;IAEG,MAAM,CAAC,IAAI,EAAE,iBAAiB,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,kBAAkB,CAAC;IAmBpF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAmCG;IAEG,QAAQ,CAAC,CAAC,SAAS,mBAAmB,GAAG,mBAAmB,EAChE,QAAQ,EAAE,MAAM,EAChB,OAAO,CAAC,EAAE,CAAC,GACV,OAAO,CACR,CAAC,SAAS,oBAAoB,CAAC,CAAC,CAAC,GAC7B,iBAAiB,CAAC,aAAa,CAAC,GAChC,oBAAoB,CAAC,aAAa,CAAC,CACxC;IA0BD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;IAEG,MAAM,CAAC,CAAC,SAAS,iBAAiB,GAAG,iBAAiB,EAC1D,OAAO,CAAC,EAAE,CAAC,GACV,OAAO,CACR,CAAC,SAAS,oBAAoB,CAAC,CAAC,CAAC,GAC7B,iBAAiB,CAAC,eAAe,CAAC,GAClC,oBAAoB,CAAC,eAAe,CAAC,CAC1C;IA6BD;;;;;;;;;;;;;;;OAeG;IAEG,OAAO,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,GAAE,kBAAuB,EAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,eAAe,CAAC;IA4BxG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiCG;IAEG,MAAM,CAAC,eAAe,EAAE,qBAAqB,GAAG,qBAAqB,EAAE,EAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,iBAAiB,CAAC,qBAAqB,EAAE,GAAG,sBAAsB,EAAE,CAAC,CAAC;IA0BjL;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiCG;IAEG,QAAQ,CAAC,eAAe,EAAE,qBAAqB,GAAG,qBAAqB,EAAE,EAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,iBAAiB,CAAC,qBAAqB,EAAE,GAAG,sBAAsB,EAAE,CAAC,CAAC;IA0BnL;;;;;;;;;;;;;;;OAeG;IAEG,QAAQ,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,EAAE,EAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,iBAAiB,CAAC;QAAE,MAAM,EAAE,MAAM,CAAA;KAAE,EAAE,GAAG,sBAAsB,EAAE,CAAC,CAAC;IAwB1I;;;;;;;;;;;;;;;;;;;;;;OAsBG;IAEG,QAAQ,CAAC,cAAc,EAAE,QAAQ,EAAE,OAAO,EAAE,qBAAqB,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,iBAAiB,CAAC,qBAAqB,CAAC,CAAC;IA2B7I;;;;;;;OAOG;YACW,eAAe;IAoB7B;;;;;;OAMG;IACH,OAAO,CAAC,qBAAqB,CAW5B;CACF"}