@uipath/uipath-typescript 1.3.2 → 1.3.4

package/dist/jobs/index.d.ts

@@ -621,6 +621,13 @@ interface RawJobGetResponse extends FolderProperties {
     /** Error details for the job, or null if the job has no errors */
     jobError: JobError | null;
 }
+/**
+ * Options for resuming a suspended job
+ */
+interface JobResumeOptions {
+    /** Input arguments to pass to the resumed job */
+    inputArguments?: Record<string, unknown>;
+}
 /**
  * Options for getting all jobs
  */
@@ -635,6 +642,18 @@ type JobGetAllOptions = RequestOptions & PaginationOptions & {
  */
 interface JobGetByIdOptions extends BaseOptions {
 }
+/**
+ * Options for stopping jobs
+ */
+interface JobStopOptions {
+    /**
+     * The stop strategy to use.
+     * - `SoftStop` — requests graceful cancellation; the job completes its current activity before stopping
+     * - `Kill` — requests immediate termination of the job
+     * @default StopStrategy.SoftStop
+     */
+    strategy?: StopStrategy;
+}
 
 /** Combined response type for job data with bound methods. */
 type JobGetResponse = RawJobGetResponse & JobMethods;
@@ -757,6 +776,85 @@ interface JobServiceModel {
      * ```
      */
     getOutput(jobKey: string, folderId: number): Promise<Record<string, unknown> | null>;
+    /**
+     * Stops one or more jobs by their UUID keys.
+     *
+     * Sends a stop request for the specified jobs to the Orchestrator. Throws if any keys cannot be resolved.
+     *
+     * @param jobKeys - Array of job UUID keys to stop (e.g., from {@link JobGetResponse}.key)
+     * @param folderId - The folder ID where the jobs reside (required)
+     * @param options - Optional {@link JobStopOptions} including stop strategy
+     * @returns Promise that resolves when the jobs are stopped successfully, or rejects on failure
+     *
+     * @example
+     * ```typescript
+     * // Stop a single job with default soft stop
+     * await jobs.stop([<jobKey>], <folderId>);
+     * ```
+     *
+     * @example
+     * ```typescript
+     * import { StopStrategy } from '@uipath/uipath-typescript/jobs';
+     *
+     * // Force-kill multiple jobs
+     * await jobs.stop(
+     *   [<jobKey1>, <jobKey2>],
+     *   <folderId>,
+     *   { strategy: StopStrategy.Kill }
+     * );
+     * ```
+     */
+    stop(jobKeys: string[], folderId: number, options?: JobStopOptions): Promise<void>;
+    /**
+     * Resumes a suspended job.
+     *
+     * Sends a resume request to a job that is currently in the `Suspended` state.
+     * The job transitions to `Resumed` and then to `Running` as it continues execution. Optionally pass
+     * input arguments to provide data for the resumed workflow.
+     *
+     * @param jobKey - The unique key (GUID) of the suspended job to resume
+     * @param folderId - The folder ID where the job resides
+     * @param options - Optional parameters including input arguments
+     * @returns Promise that resolves when the job is resumed successfully, or rejects on failure
+     *
+     * @example
+     * ```typescript
+     * // Resume a suspended job
+     * await jobs.resume(<jobKey>, <folderId>);
+     * ```
+     *
+     * @example
+     * ```typescript
+     * // Resume with input arguments
+     * await jobs.resume(<jobKey>, <folderId>, {
+     *   inputArguments: { approved: true }
+     * });
+     * ```
+     */
+    resume(jobKey: string, folderId: number, options?: JobResumeOptions): Promise<void>;
+    /**
+     * Restarts a job in a final state (Successful, Faulted, or Stopped).
+     *
+     * Creates a **new** job execution from a previously successful, faulted, or stopped job.
+     * The new job has its own unique `key`, starts in `Pending` state, and uses
+     * the same process and input arguments as the original job.
+     *
+     * To monitor the new job's progress, poll with {@link getById}
+     * using the returned job's key until the state reaches a final value.
+     *
+     * @param jobKey - The unique key (GUID) of the job to restart
+     * @param folderId - The folder ID where the job resides
+     * @returns Promise resolving to the new {@link JobGetResponse} with full job details
+     *
+     * @example
+     * ```typescript
+     * // Restart a faulted job
+     * const newJob = await jobs.restart(<jobKey>, <folderId>);
+     * console.log(newJob.state); // 'Pending'
+     * console.log(newJob.key);   // new job key (different from original)
+     * ```
+     */
+    restart(jobKey: string, folderId: number): Promise<JobGetResponse>;
 }
 /**
  * Methods available on job response objects.
@@ -783,6 +881,38 @@ interface JobMethods {
      * ```
      */
     getOutput(): Promise<Record<string, unknown> | null>;
+    /**
+     * Stops this job.
+     *
+     * Sends a stop request for this job to the Orchestrator.
+     *
+     * @param options - Optional {@link JobStopOptions} including stop strategy (defaults to SoftStop)
+     * @returns Promise that resolves when the jobs are stopped successfully, or rejects on failure
+     *
+     * @example
+     * ```typescript
+     * const allJobs = await jobs.getAll({ folderId: <folderId> });
+     * const runningJob = allJobs.items.find(j => j.state === JobState.Running);
+     *
+     * if (runningJob) {
+     *   await runningJob.stop();
+     * }
+     * ```
+     */
+    stop(options?: JobStopOptions): Promise<void>;
+    /**
+     * Resumes this suspended job.
+     *
+     * @param options - Optional parameters including input arguments
+     * @returns Promise that resolves when the job is resumed successfully, or rejects on failure
+     */
+    resume(options?: JobResumeOptions): Promise<void>;
+    /**
+     * Restarts this job, creating a new execution with a new key.
+     *
+     * @returns Promise resolving to the new {@link JobGetResponse} with full job details
+     */
+    restart(): Promise<JobGetResponse>;
 }
 /**
  * Creates a job response with bound methods.
@@ -906,6 +1036,85 @@ declare class JobService extends FolderScopedService implements JobServiceModel
      * ```
      */
     getOutput(jobKey: string, folderId: number): Promise<Record<string, unknown> | null>;
+    /**
+     * Stops one or more jobs by their UUID keys.
+     *
+     * Sends a stop request for the specified jobs to the Orchestrator. Throws if any keys cannot be resolved.
+     *
+     * @param jobKeys - Array of job UUID keys to stop (e.g., from {@link JobGetResponse}.key)
+     * @param folderId - The folder ID where the jobs reside (required)
+     * @param options - Optional {@link JobStopOptions} including stop strategy
+     * @returns Promise that resolves when the jobs are stopped successfully, or rejects on failure
+     *
+     * @example
+     * ```typescript
+     * // Stop a single job with default soft stop
+     * await jobs.stop([<jobKey>], <folderId>);
+     * ```
+     *
+     * @example
+     * ```typescript
+     * import { StopStrategy } from '@uipath/uipath-typescript/jobs';
+     *
+     * // Force-kill multiple jobs
+     * await jobs.stop(
+     *   [<jobKey1>, <jobKey2>],
+     *   <folderId>,
+     *   { strategy: StopStrategy.Kill }
+     * );
+     * ```
+     */
+    stop(jobKeys: string[], folderId: number, options?: JobStopOptions): Promise<void>;
+    /**
+     * Resumes a suspended job.
+     *
+     * Sends a resume request to a job that is currently in the `Suspended` state.
+     * The job transitions to `Resumed` and then to `Running` as it continues execution. Optionally pass
+     * input arguments to provide data for the resumed workflow.
+     *
+     * @param jobKey - The unique key (GUID) of the suspended job to resume
+     * @param folderId - The folder ID where the job resides
+     * @param options - Optional parameters including input arguments
+     * @returns Promise that resolves when the job is resumed successfully, or rejects on failure
+     *
+     * @example
+     * ```typescript
+     * // Resume a suspended job
+     * await jobs.resume(<jobKey>, <folderId>);
+     * ```
+     *
+     * @example
+     * ```typescript
+     * // Resume with input arguments
+     * await jobs.resume(<jobKey>, <folderId>, {
+     *   inputArguments: { approved: true }
+     * });
+     * ```
+     */
+    resume(jobKey: string, folderId: number, options?: JobResumeOptions): Promise<void>;
+    /**
+     * Restarts a job in a final state (Successful, Faulted, or Stopped).
+     *
+     * Creates a **new** job execution from a previously successful, faulted, or stopped job.
+     * The new job has its own unique `key`, starts in `Pending` state, and uses
+     * the same process and input arguments as the original job.
+     *
+     * To monitor the new job's progress, poll with {@link getById}
+     * using the returned job's key until the state reaches a final value.
+     *
+     * @param jobKey - The unique key (GUID) of the job to restart
+     * @param folderId - The folder ID where the job resides
+     * @returns Promise resolving to the new {@link JobGetResponse} with full job details
+     *
+     * @example
+     * ```typescript
+     * // Restart a faulted job
+     * const newJob = await jobs.restart(<jobKey>, <folderId>);
+     * console.log(newJob.state); // 'Pending'
+     * console.log(newJob.key);   // new job key (different from original)
+     * ```
+     */
+    restart(jobKey: string, folderId: number): Promise<JobGetResponse>;
     /**
      * Downloads the output file content via the Attachments API.
      * 1. Fetches blob access info from the attachment using AttachmentService
@@ -913,7 +1122,16 @@ declare class JobService extends FolderScopedService implements JobServiceModel
      * 3. Parses and returns the JSON content
      */
     private downloadOutputFile;
+    /**
+     * Resolves job UUID keys to integer IDs via the getAll method.
+     * Chunks keys into batches to avoid URL length limits.
+     */
+    private resolveJobKeys;
+    /**
+     * Calls the StopJobs OData action with resolved integer IDs.
+     */
+    private stopJobsByIds;
 }
 
-export { JobService, JobState, JobSubState, JobService as Jobs, ServerlessJobType, createJobWithMethods };
-export type { JobGetAllOptions, JobGetByIdOptions, JobGetResponse, JobMethods, JobServiceModel, ProcessMetadata, RawJobGetResponse };
+export { JobService, JobState, JobSubState, JobService as Jobs, ServerlessJobType, StopStrategy, createJobWithMethods };
+export type { JobGetAllOptions, JobGetByIdOptions, JobGetResponse, JobMethods, JobResumeOptions, JobServiceModel, JobStopOptions, ProcessMetadata, RawJobGetResponse };