@trigger.dev/core 0.0.0-v3-prerelease-20241118124944 → 0.0.0-v3-prerelease-20241203112040

package/dist/esm/v3/apiClient/index.d.ts

@@ -1,13 +1,17 @@
 import { z } from "zod";
-import { AddTagsRequestBody, BatchTaskRunExecutionResult, BatchTriggerTaskRequestBody, CreateEnvironmentVariableRequestBody, CreateScheduleOptions, ListRunResponseItem, ListScheduleOptions, RescheduleRunRequestBody, TaskRunExecutionResult, TriggerTaskRequestBody, UpdateEnvironmentVariableRequestBody, UpdateMetadataRequestBody, UpdateScheduleOptions } from "../schemas/index.js";
+import { AddTagsRequestBody, BatchTaskRunExecutionResult, BatchTriggerTaskV2RequestBody, CreateEnvironmentVariableRequestBody, CreateScheduleOptions, ListRunResponseItem, ListScheduleOptions, RescheduleRunRequestBody, TaskRunExecutionResult, TriggerTaskRequestBody, UpdateEnvironmentVariableRequestBody, UpdateMetadataRequestBody, UpdateScheduleOptions } from "../schemas/index.js";
+import { AnyRunTypes, TriggerJwtOptions } from "../types/tasks.js";
 import { ApiRequestOptions, CursorPagePromise, ZodFetchOptions, isRequestOptions } from "./core.js";
-import { RunShape, AnyRunShape, RunStreamCallback, RunSubscription, TaskRunShape } from "./runStream.js";
+import { AnyRunShape, RealtimeRun, AnyRealtimeRun, RunShape, RunStreamCallback, RunSubscription, TaskRunShape } from "./runStream.js";
 import { CreateEnvironmentVariableParams, ImportEnvironmentVariablesParams, ListProjectRunsQueryParams, ListRunsQueryParams, SubscribeToRunsQueryParams, UpdateEnvironmentVariableParams } from "./types.js";
-import { AnyRunTypes, TriggerJwtOptions } from "../types/tasks.js";
-export type { CreateEnvironmentVariableParams, ImportEnvironmentVariablesParams, UpdateEnvironmentVariableParams, SubscribeToRunsQueryParams, };
-export type TriggerOptions = {
+export type { CreateEnvironmentVariableParams, ImportEnvironmentVariablesParams, SubscribeToRunsQueryParams, UpdateEnvironmentVariableParams, };
+export type ClientTriggerOptions = {
     spanParentAsLink?: boolean;
 };
+export type ClientBatchTriggerOptions = ClientTriggerOptions & {
+    idempotencyKey?: string;
+    idempotencyKeyTTL?: string;
+};
 export type TriggerRequestOptions = ZodFetchOptions & {
     publicAccessToken?: TriggerJwtOptions;
 };
@@ -15,8 +19,7 @@ export type TriggerApiRequestOptions = ApiRequestOptions & {
     publicAccessToken?: TriggerJwtOptions;
 };
 export { isRequestOptions };
-export type { ApiRequestOptions };
-export type { RunShape, AnyRunShape, TaskRunShape, RunStreamCallback, RunSubscription };
+export type { AnyRunShape, ApiRequestOptions, RealtimeRun, AnyRealtimeRun, RunShape, RunStreamCallback, RunSubscription, TaskRunShape, };
 /**
  * Trigger.dev v3 API client
  */
@@ -29,14 +32,21 @@ export declare class ApiClient {
     get fetchClient(): typeof fetch;
     getRunResult(runId: string, requestOptions?: ZodFetchOptions): Promise<TaskRunExecutionResult | undefined>;
     getBatchResults(batchId: string, requestOptions?: ZodFetchOptions): Promise<BatchTaskRunExecutionResult | undefined>;
-    triggerTask(taskId: string, body: TriggerTaskRequestBody, options?: TriggerOptions, requestOptions?: TriggerRequestOptions): Promise<{
+    triggerTask(taskId: string, body: TriggerTaskRequestBody, clientOptions?: ClientTriggerOptions, requestOptions?: TriggerRequestOptions): Promise<{
         publicAccessToken: string;
         id: string;
     }>;
-    batchTriggerTask(taskId: string, body: BatchTriggerTaskRequestBody, options?: TriggerOptions, requestOptions?: TriggerRequestOptions): Promise<{
+    batchTriggerV2(body: BatchTriggerTaskV2RequestBody, clientOptions?: ClientBatchTriggerOptions, requestOptions?: TriggerRequestOptions): Promise<{
         publicAccessToken: string;
-        batchId: string;
-        runs: string[];
+        id: string;
+        runs: {
+            id: string;
+            taskIdentifier: string;
+            isCached: boolean;
+            idempotencyKey?: string | undefined;
+        }[];
+        isCached: boolean;
+        idempotencyKey?: string | undefined;
     }>;
     createUploadPayloadUrl(filename: string, requestOptions?: ZodFetchOptions): import("./core.js").ApiPromise<{
         presignedUrl: string;
@@ -45,155 +55,155 @@ export declare class ApiClient {
         presignedUrl: string;
     }>;
     retrieveRun(runId: string, requestOptions?: ZodFetchOptions): import("./core.js").ApiPromise<{
-        status: "CANCELED" | "COMPLETED" | "FAILED" | "TIMED_OUT" | "WAITING_FOR_DEPLOY" | "QUEUED" | "EXECUTING" | "REATTEMPTING" | "FROZEN" | "CRASHED" | "INTERRUPTED" | "SYSTEM_FAILURE" | "DELAYED" | "EXPIRED";
+        status: "COMPLETED" | "CANCELED" | "QUEUED" | "TIMED_OUT" | "EXECUTING" | "WAITING_FOR_DEPLOY" | "REATTEMPTING" | "FROZEN" | "FAILED" | "CRASHED" | "INTERRUPTED" | "SYSTEM_FAILURE" | "DELAYED" | "EXPIRED";
         id: string;
-        tags: string[];
+        attempts: ({
+            status: "PENDING" | "COMPLETED" | "CANCELED" | "EXECUTING" | "FAILED" | "PAUSED";
+            id: string;
+            updatedAt: Date;
+            createdAt: Date;
+            startedAt?: Date | undefined;
+            completedAt?: Date | undefined;
+            error?: {
+                message: string;
+                name?: string | undefined;
+                stackTrace?: string | undefined;
+            } | undefined;
+        } | undefined)[];
+        updatedAt: Date;
         isTest: boolean;
         createdAt: Date;
+        tags: string[];
         durationMs: number;
         costInCents: number;
         baseCostInCents: number;
-        depth: number;
-        triggerFunction: "triggerAndWait" | "trigger" | "batchTriggerAndWait" | "batchTrigger";
         taskIdentifier: string;
-        isQueued: boolean;
-        isExecuting: boolean;
-        isCompleted: boolean;
-        isSuccess: boolean;
-        isFailed: boolean;
-        isCancelled: boolean;
-        updatedAt: Date;
         relatedRuns: {
             root?: {
-                status: "CANCELED" | "COMPLETED" | "FAILED" | "TIMED_OUT" | "WAITING_FOR_DEPLOY" | "QUEUED" | "EXECUTING" | "REATTEMPTING" | "FROZEN" | "CRASHED" | "INTERRUPTED" | "SYSTEM_FAILURE" | "DELAYED" | "EXPIRED";
+                status: "COMPLETED" | "CANCELED" | "QUEUED" | "TIMED_OUT" | "EXECUTING" | "WAITING_FOR_DEPLOY" | "REATTEMPTING" | "FROZEN" | "FAILED" | "CRASHED" | "INTERRUPTED" | "SYSTEM_FAILURE" | "DELAYED" | "EXPIRED";
                 id: string;
-                tags: string[];
+                updatedAt: Date;
                 isTest: boolean;
                 createdAt: Date;
+                tags: string[];
                 durationMs: number;
                 costInCents: number;
                 baseCostInCents: number;
-                depth: number;
-                triggerFunction: "triggerAndWait" | "trigger" | "batchTriggerAndWait" | "batchTrigger";
                 taskIdentifier: string;
+                depth: number;
+                triggerFunction: "trigger" | "batchTrigger" | "triggerAndWait" | "batchTriggerAndWait";
                 isQueued: boolean;
                 isExecuting: boolean;
                 isCompleted: boolean;
                 isSuccess: boolean;
                 isFailed: boolean;
                 isCancelled: boolean;
-                updatedAt: Date;
-                batchId?: string | undefined;
-                idempotencyKey?: string | undefined;
                 version?: string | undefined;
+                metadata?: Record<string, any> | undefined;
                 startedAt?: Date | undefined;
+                idempotencyKey?: string | undefined;
+                ttl?: string | undefined;
+                batchId?: string | undefined;
                 finishedAt?: Date | undefined;
                 delayedUntil?: Date | undefined;
-                ttl?: string | undefined;
                 expiredAt?: Date | undefined;
-                metadata?: Record<string, any> | undefined;
             } | undefined;
             parent?: {
-                status: "CANCELED" | "COMPLETED" | "FAILED" | "TIMED_OUT" | "WAITING_FOR_DEPLOY" | "QUEUED" | "EXECUTING" | "REATTEMPTING" | "FROZEN" | "CRASHED" | "INTERRUPTED" | "SYSTEM_FAILURE" | "DELAYED" | "EXPIRED";
+                status: "COMPLETED" | "CANCELED" | "QUEUED" | "TIMED_OUT" | "EXECUTING" | "WAITING_FOR_DEPLOY" | "REATTEMPTING" | "FROZEN" | "FAILED" | "CRASHED" | "INTERRUPTED" | "SYSTEM_FAILURE" | "DELAYED" | "EXPIRED";
                 id: string;
-                tags: string[];
+                updatedAt: Date;
                 isTest: boolean;
                 createdAt: Date;
+                tags: string[];
                 durationMs: number;
                 costInCents: number;
                 baseCostInCents: number;
-                depth: number;
-                triggerFunction: "triggerAndWait" | "trigger" | "batchTriggerAndWait" | "batchTrigger";
                 taskIdentifier: string;
+                depth: number;
+                triggerFunction: "trigger" | "batchTrigger" | "triggerAndWait" | "batchTriggerAndWait";
                 isQueued: boolean;
                 isExecuting: boolean;
                 isCompleted: boolean;
                 isSuccess: boolean;
                 isFailed: boolean;
                 isCancelled: boolean;
-                updatedAt: Date;
-                batchId?: string | undefined;
-                idempotencyKey?: string | undefined;
                 version?: string | undefined;
+                metadata?: Record<string, any> | undefined;
                 startedAt?: Date | undefined;
+                idempotencyKey?: string | undefined;
+                ttl?: string | undefined;
+                batchId?: string | undefined;
                 finishedAt?: Date | undefined;
                 delayedUntil?: Date | undefined;
-                ttl?: string | undefined;
                 expiredAt?: Date | undefined;
-                metadata?: Record<string, any> | undefined;
             } | undefined;
             children?: {
-                status: "CANCELED" | "COMPLETED" | "FAILED" | "TIMED_OUT" | "WAITING_FOR_DEPLOY" | "QUEUED" | "EXECUTING" | "REATTEMPTING" | "FROZEN" | "CRASHED" | "INTERRUPTED" | "SYSTEM_FAILURE" | "DELAYED" | "EXPIRED";
+                status: "COMPLETED" | "CANCELED" | "QUEUED" | "TIMED_OUT" | "EXECUTING" | "WAITING_FOR_DEPLOY" | "REATTEMPTING" | "FROZEN" | "FAILED" | "CRASHED" | "INTERRUPTED" | "SYSTEM_FAILURE" | "DELAYED" | "EXPIRED";
                 id: string;
-                tags: string[];
+                updatedAt: Date;
                 isTest: boolean;
                 createdAt: Date;
+                tags: string[];
                 durationMs: number;
                 costInCents: number;
                 baseCostInCents: number;
-                depth: number;
-                triggerFunction: "triggerAndWait" | "trigger" | "batchTriggerAndWait" | "batchTrigger";
                 taskIdentifier: string;
+                depth: number;
+                triggerFunction: "trigger" | "batchTrigger" | "triggerAndWait" | "batchTriggerAndWait";
                 isQueued: boolean;
                 isExecuting: boolean;
                 isCompleted: boolean;
                 isSuccess: boolean;
                 isFailed: boolean;
                 isCancelled: boolean;
-                updatedAt: Date;
-                batchId?: string | undefined;
-                idempotencyKey?: string | undefined;
                 version?: string | undefined;
+                metadata?: Record<string, any> | undefined;
                 startedAt?: Date | undefined;
+                idempotencyKey?: string | undefined;
+                ttl?: string | undefined;
+                batchId?: string | undefined;
                 finishedAt?: Date | undefined;
                 delayedUntil?: Date | undefined;
-                ttl?: string | undefined;
                 expiredAt?: Date | undefined;
-                metadata?: Record<string, any> | undefined;
             }[] | undefined;
         };
-        attempts: ({
-            status: "PENDING" | "CANCELED" | "COMPLETED" | "FAILED" | "EXECUTING" | "PAUSED";
-            id: string;
-            createdAt: Date;
-            updatedAt: Date;
-            startedAt?: Date | undefined;
-            completedAt?: Date | undefined;
-            error?: {
-                message: string;
-                name?: string | undefined;
-                stackTrace?: string | undefined;
-            } | undefined;
-        } | undefined)[];
+        depth: number;
+        triggerFunction: "trigger" | "batchTrigger" | "triggerAndWait" | "batchTriggerAndWait";
+        isQueued: boolean;
+        isExecuting: boolean;
+        isCompleted: boolean;
+        isSuccess: boolean;
+        isFailed: boolean;
+        isCancelled: boolean;
         attemptCount: number;
         payload?: any;
-        payloadPresignedUrl?: string | undefined;
+        version?: string | undefined;
+        metadata?: Record<string, any> | undefined;
+        startedAt?: Date | undefined;
         output?: any;
-        outputPresignedUrl?: string | undefined;
         error?: {
             message: string;
             name?: string | undefined;
             stackTrace?: string | undefined;
         } | undefined;
+        idempotencyKey?: string | undefined;
         schedule?: {
             id: string;
             generator: {
                 type: "CRON";
-                expression: string;
                 description: string;
+                expression: string;
             };
             externalId?: string | undefined;
             deduplicationKey?: string | undefined;
         } | undefined;
+        ttl?: string | undefined;
+        payloadPresignedUrl?: string | undefined;
+        outputPresignedUrl?: string | undefined;
         batchId?: string | undefined;
-        idempotencyKey?: string | undefined;
-        version?: string | undefined;
-        startedAt?: Date | undefined;
         finishedAt?: Date | undefined;
         delayedUntil?: Date | undefined;
-        ttl?: string | undefined;
         expiredAt?: Date | undefined;
-        metadata?: Record<string, any> | undefined;
     }>;
     listRuns(query?: ListRunsQueryParams, requestOptions?: ZodFetchOptions): CursorPagePromise<typeof ListRunResponseItem>;
     listProjectRuns(projectRef: string, query?: ListProjectRunsQueryParams, requestOptions?: ZodFetchOptions): CursorPagePromise<typeof ListRunResponseItem>;
@@ -204,155 +214,155 @@ export declare class ApiClient {
         id: string;
     }>;
     rescheduleRun(runId: string, body: RescheduleRunRequestBody, requestOptions?: ZodFetchOptions): import("./core.js").ApiPromise<{
-        status: "CANCELED" | "COMPLETED" | "FAILED" | "TIMED_OUT" | "WAITING_FOR_DEPLOY" | "QUEUED" | "EXECUTING" | "REATTEMPTING" | "FROZEN" | "CRASHED" | "INTERRUPTED" | "SYSTEM_FAILURE" | "DELAYED" | "EXPIRED";
+        status: "COMPLETED" | "CANCELED" | "QUEUED" | "TIMED_OUT" | "EXECUTING" | "WAITING_FOR_DEPLOY" | "REATTEMPTING" | "FROZEN" | "FAILED" | "CRASHED" | "INTERRUPTED" | "SYSTEM_FAILURE" | "DELAYED" | "EXPIRED";
         id: string;
-        tags: string[];
+        attempts: ({
+            status: "PENDING" | "COMPLETED" | "CANCELED" | "EXECUTING" | "FAILED" | "PAUSED";
+            id: string;
+            updatedAt: Date;
+            createdAt: Date;
+            startedAt?: Date | undefined;
+            completedAt?: Date | undefined;
+            error?: {
+                message: string;
+                name?: string | undefined;
+                stackTrace?: string | undefined;
+            } | undefined;
+        } | undefined)[];
+        updatedAt: Date;
         isTest: boolean;
         createdAt: Date;
+        tags: string[];
         durationMs: number;
         costInCents: number;
         baseCostInCents: number;
-        depth: number;
-        triggerFunction: "triggerAndWait" | "trigger" | "batchTriggerAndWait" | "batchTrigger";
         taskIdentifier: string;
-        isQueued: boolean;
-        isExecuting: boolean;
-        isCompleted: boolean;
-        isSuccess: boolean;
-        isFailed: boolean;
-        isCancelled: boolean;
-        updatedAt: Date;
         relatedRuns: {
             root?: {
-                status: "CANCELED" | "COMPLETED" | "FAILED" | "TIMED_OUT" | "WAITING_FOR_DEPLOY" | "QUEUED" | "EXECUTING" | "REATTEMPTING" | "FROZEN" | "CRASHED" | "INTERRUPTED" | "SYSTEM_FAILURE" | "DELAYED" | "EXPIRED";
+                status: "COMPLETED" | "CANCELED" | "QUEUED" | "TIMED_OUT" | "EXECUTING" | "WAITING_FOR_DEPLOY" | "REATTEMPTING" | "FROZEN" | "FAILED" | "CRASHED" | "INTERRUPTED" | "SYSTEM_FAILURE" | "DELAYED" | "EXPIRED";
                 id: string;
-                tags: string[];
+                updatedAt: Date;
                 isTest: boolean;
                 createdAt: Date;
+                tags: string[];
                 durationMs: number;
                 costInCents: number;
                 baseCostInCents: number;
-                depth: number;
-                triggerFunction: "triggerAndWait" | "trigger" | "batchTriggerAndWait" | "batchTrigger";
                 taskIdentifier: string;
+                depth: number;
+                triggerFunction: "trigger" | "batchTrigger" | "triggerAndWait" | "batchTriggerAndWait";
                 isQueued: boolean;
                 isExecuting: boolean;
                 isCompleted: boolean;
                 isSuccess: boolean;
                 isFailed: boolean;
                 isCancelled: boolean;
-                updatedAt: Date;
-                batchId?: string | undefined;
-                idempotencyKey?: string | undefined;
                 version?: string | undefined;
+                metadata?: Record<string, any> | undefined;
                 startedAt?: Date | undefined;
+                idempotencyKey?: string | undefined;
+                ttl?: string | undefined;
+                batchId?: string | undefined;
                 finishedAt?: Date | undefined;
                 delayedUntil?: Date | undefined;
-                ttl?: string | undefined;
                 expiredAt?: Date | undefined;
-                metadata?: Record<string, any> | undefined;
             } | undefined;
             parent?: {
-                status: "CANCELED" | "COMPLETED" | "FAILED" | "TIMED_OUT" | "WAITING_FOR_DEPLOY" | "QUEUED" | "EXECUTING" | "REATTEMPTING" | "FROZEN" | "CRASHED" | "INTERRUPTED" | "SYSTEM_FAILURE" | "DELAYED" | "EXPIRED";
+                status: "COMPLETED" | "CANCELED" | "QUEUED" | "TIMED_OUT" | "EXECUTING" | "WAITING_FOR_DEPLOY" | "REATTEMPTING" | "FROZEN" | "FAILED" | "CRASHED" | "INTERRUPTED" | "SYSTEM_FAILURE" | "DELAYED" | "EXPIRED";
                 id: string;
-                tags: string[];
+                updatedAt: Date;
                 isTest: boolean;
                 createdAt: Date;
+                tags: string[];
                 durationMs: number;
                 costInCents: number;
                 baseCostInCents: number;
-                depth: number;
-                triggerFunction: "triggerAndWait" | "trigger" | "batchTriggerAndWait" | "batchTrigger";
                 taskIdentifier: string;
+                depth: number;
+                triggerFunction: "trigger" | "batchTrigger" | "triggerAndWait" | "batchTriggerAndWait";
                 isQueued: boolean;
                 isExecuting: boolean;
                 isCompleted: boolean;
                 isSuccess: boolean;
                 isFailed: boolean;
                 isCancelled: boolean;
-                updatedAt: Date;
-                batchId?: string | undefined;
-                idempotencyKey?: string | undefined;
                 version?: string | undefined;
+                metadata?: Record<string, any> | undefined;
                 startedAt?: Date | undefined;
+                idempotencyKey?: string | undefined;
+                ttl?: string | undefined;
+                batchId?: string | undefined;
                 finishedAt?: Date | undefined;
                 delayedUntil?: Date | undefined;
-                ttl?: string | undefined;
                 expiredAt?: Date | undefined;
-                metadata?: Record<string, any> | undefined;
             } | undefined;
             children?: {
-                status: "CANCELED" | "COMPLETED" | "FAILED" | "TIMED_OUT" | "WAITING_FOR_DEPLOY" | "QUEUED" | "EXECUTING" | "REATTEMPTING" | "FROZEN" | "CRASHED" | "INTERRUPTED" | "SYSTEM_FAILURE" | "DELAYED" | "EXPIRED";
+                status: "COMPLETED" | "CANCELED" | "QUEUED" | "TIMED_OUT" | "EXECUTING" | "WAITING_FOR_DEPLOY" | "REATTEMPTING" | "FROZEN" | "FAILED" | "CRASHED" | "INTERRUPTED" | "SYSTEM_FAILURE" | "DELAYED" | "EXPIRED";
                 id: string;
-                tags: string[];
+                updatedAt: Date;
                 isTest: boolean;
                 createdAt: Date;
+                tags: string[];
                 durationMs: number;
                 costInCents: number;
                 baseCostInCents: number;
-                depth: number;
-                triggerFunction: "triggerAndWait" | "trigger" | "batchTriggerAndWait" | "batchTrigger";
                 taskIdentifier: string;
+                depth: number;
+                triggerFunction: "trigger" | "batchTrigger" | "triggerAndWait" | "batchTriggerAndWait";
                 isQueued: boolean;
                 isExecuting: boolean;
                 isCompleted: boolean;
                 isSuccess: boolean;
                 isFailed: boolean;
                 isCancelled: boolean;
-                updatedAt: Date;
-                batchId?: string | undefined;
-                idempotencyKey?: string | undefined;
                 version?: string | undefined;
+                metadata?: Record<string, any> | undefined;
                 startedAt?: Date | undefined;
+                idempotencyKey?: string | undefined;
+                ttl?: string | undefined;
+                batchId?: string | undefined;
                 finishedAt?: Date | undefined;
                 delayedUntil?: Date | undefined;
-                ttl?: string | undefined;
                 expiredAt?: Date | undefined;
-                metadata?: Record<string, any> | undefined;
             }[] | undefined;
         };
-        attempts: ({
-            status: "PENDING" | "CANCELED" | "COMPLETED" | "FAILED" | "EXECUTING" | "PAUSED";
-            id: string;
-            createdAt: Date;
-            updatedAt: Date;
-            startedAt?: Date | undefined;
-            completedAt?: Date | undefined;
-            error?: {
-                message: string;
-                name?: string | undefined;
-                stackTrace?: string | undefined;
-            } | undefined;
-        } | undefined)[];
+        depth: number;
+        triggerFunction: "trigger" | "batchTrigger" | "triggerAndWait" | "batchTriggerAndWait";
+        isQueued: boolean;
+        isExecuting: boolean;
+        isCompleted: boolean;
+        isSuccess: boolean;
+        isFailed: boolean;
+        isCancelled: boolean;
         attemptCount: number;
         payload?: any;
-        payloadPresignedUrl?: string | undefined;
+        version?: string | undefined;
+        metadata?: Record<string, any> | undefined;
+        startedAt?: Date | undefined;
         output?: any;
-        outputPresignedUrl?: string | undefined;
         error?: {
             message: string;
             name?: string | undefined;
             stackTrace?: string | undefined;
         } | undefined;
+        idempotencyKey?: string | undefined;
         schedule?: {
             id: string;
             generator: {
                 type: "CRON";
-                expression: string;
                 description: string;
+                expression: string;
             };
             externalId?: string | undefined;
             deduplicationKey?: string | undefined;
         } | undefined;
+        ttl?: string | undefined;
+        payloadPresignedUrl?: string | undefined;
+        outputPresignedUrl?: string | undefined;
         batchId?: string | undefined;
-        idempotencyKey?: string | undefined;
-        version?: string | undefined;
-        startedAt?: Date | undefined;
         finishedAt?: Date | undefined;
         delayedUntil?: Date | undefined;
-        ttl?: string | undefined;
         expiredAt?: Date | undefined;
-        metadata?: Record<string, any> | undefined;
     }>;
     addTags(runId: string, body: AddTagsRequestBody, requestOptions?: ZodFetchOptions): import("./core.js").ApiPromise<{
         message: string;
@@ -360,21 +370,21 @@ export declare class ApiClient {
     createSchedule(options: CreateScheduleOptions, requestOptions?: ZodFetchOptions): import("./core.js").ApiPromise<{
         type: "DECLARATIVE" | "IMPERATIVE";
         id: string;
+        active: boolean;
         task: string;
         timezone: string;
-        active: boolean;
         generator: {
             type: "CRON";
-            expression: string;
             description: string;
+            expression: string;
         };
         environments: {
             type: string;
             id: string;
             userName?: string | null | undefined;
         }[];
-        deduplicationKey?: string | null | undefined;
         externalId?: string | null | undefined;
+        deduplicationKey?: string | null | undefined;
         nextRun?: Date | null | undefined;
     }>;
     listSchedules(options?: ListScheduleOptions, requestOptions?: ZodFetchOptions): import("./core.js").OffsetLimitPagePromise<z.ZodObject<{
@@ -390,12 +400,12 @@ export declare class ApiClient {
             description: z.ZodString;
         }, "strip", z.ZodTypeAny, {
             type: "CRON";
-            expression: string;
             description: string;
+            expression: string;
         }, {
             type: "CRON";
-            expression: string;
             description: string;
+            expression: string;
         }>;
         timezone: z.ZodString;
         nextRun: z.ZodOptional<z.ZodNullable<z.ZodDate>>;
@@ -415,120 +425,120 @@ export declare class ApiClient {
     }, "strip", z.ZodTypeAny, {
         type: "DECLARATIVE" | "IMPERATIVE";
         id: string;
+        active: boolean;
         task: string;
         timezone: string;
-        active: boolean;
         generator: {
             type: "CRON";
-            expression: string;
             description: string;
+            expression: string;
         };
         environments: {
             type: string;
             id: string;
             userName?: string | null | undefined;
         }[];
-        deduplicationKey?: string | null | undefined;
         externalId?: string | null | undefined;
+        deduplicationKey?: string | null | undefined;
         nextRun?: Date | null | undefined;
     }, {
         type: "DECLARATIVE" | "IMPERATIVE";
         id: string;
+        active: boolean;
         task: string;
         timezone: string;
-        active: boolean;
         generator: {
             type: "CRON";
-            expression: string;
             description: string;
+            expression: string;
         };
         environments: {
             type: string;
             id: string;
             userName?: string | null | undefined;
         }[];
-        deduplicationKey?: string | null | undefined;
         externalId?: string | null | undefined;
+        deduplicationKey?: string | null | undefined;
         nextRun?: Date | null | undefined;
     }>>;
     retrieveSchedule(scheduleId: string, requestOptions?: ZodFetchOptions): import("./core.js").ApiPromise<{
         type: "DECLARATIVE" | "IMPERATIVE";
         id: string;
+        active: boolean;
         task: string;
         timezone: string;
-        active: boolean;
         generator: {
             type: "CRON";
-            expression: string;
             description: string;
+            expression: string;
         };
         environments: {
             type: string;
             id: string;
             userName?: string | null | undefined;
         }[];
-        deduplicationKey?: string | null | undefined;
         externalId?: string | null | undefined;
+        deduplicationKey?: string | null | undefined;
         nextRun?: Date | null | undefined;
     }>;
     updateSchedule(scheduleId: string, options: UpdateScheduleOptions, requestOptions?: ZodFetchOptions): import("./core.js").ApiPromise<{
         type: "DECLARATIVE" | "IMPERATIVE";
         id: string;
+        active: boolean;
         task: string;
         timezone: string;
-        active: boolean;
         generator: {
             type: "CRON";
-            expression: string;
             description: string;
+            expression: string;
         };
         environments: {
             type: string;
             id: string;
             userName?: string | null | undefined;
         }[];
-        deduplicationKey?: string | null | undefined;
         externalId?: string | null | undefined;
+        deduplicationKey?: string | null | undefined;
         nextRun?: Date | null | undefined;
     }>;
     deactivateSchedule(scheduleId: string, requestOptions?: ZodFetchOptions): import("./core.js").ApiPromise<{
         type: "DECLARATIVE" | "IMPERATIVE";
         id: string;
+        active: boolean;
         task: string;
         timezone: string;
-        active: boolean;
         generator: {
             type: "CRON";
-            expression: string;
             description: string;
+            expression: string;
         };
         environments: {
             type: string;
             id: string;
             userName?: string | null | undefined;
         }[];
-        deduplicationKey?: string | null | undefined;
         externalId?: string | null | undefined;
+        deduplicationKey?: string | null | undefined;
         nextRun?: Date | null | undefined;
     }>;
     activateSchedule(scheduleId: string, requestOptions?: ZodFetchOptions): import("./core.js").ApiPromise<{
         type: "DECLARATIVE" | "IMPERATIVE";
         id: string;
+        active: boolean;
         task: string;
         timezone: string;
-        active: boolean;
         generator: {
             type: "CRON";
-            expression: string;
             description: string;
+            expression: string;
         };
         environments: {
             type: string;
             id: string;
             userName?: string | null | undefined;
         }[];
-        deduplicationKey?: string | null | undefined;
         externalId?: string | null | undefined;
+        deduplicationKey?: string | null | undefined;
         nextRun?: Date | null | undefined;
     }>;
     deleteSchedule(scheduleId: string, requestOptions?: ZodFetchOptions): import("./core.js").ApiPromise<{
@@ -556,9 +566,23 @@ export declare class ApiClient {
     updateRunMetadata(runId: string, body: UpdateMetadataRequestBody, requestOptions?: ZodFetchOptions): import("./core.js").ApiPromise<{
         metadata: Record<string, import("../../index.js").DeserializedJson>;
     }>;
-    subscribeToRun<TRunTypes extends AnyRunTypes>(runId: string): RunSubscription<TRunTypes>;
-    subscribeToRunsWithTag<TRunTypes extends AnyRunTypes>(tag: string | string[]): RunSubscription<TRunTypes>;
-    subscribeToBatch<TRunTypes extends AnyRunTypes>(batchId: string): RunSubscription<TRunTypes>;
+    subscribeToRun<TRunTypes extends AnyRunTypes>(runId: string, options?: {
+        signal?: AbortSignal;
+    }): RunSubscription<TRunTypes>;
+    subscribeToRunsWithTag<TRunTypes extends AnyRunTypes>(tag: string | string[], options?: {
+        signal?: AbortSignal;
+    }): RunSubscription<TRunTypes>;
+    subscribeToBatch<TRunTypes extends AnyRunTypes>(batchId: string, options?: {
+        signal?: AbortSignal;
+    }): RunSubscription<TRunTypes>;
     generateJWTClaims(requestOptions?: ZodFetchOptions): Promise<Record<string, any>>;
+    retrieveBatch(batchId: string, requestOptions?: ZodFetchOptions): import("./core.js").ApiPromise<{
+        status: "PENDING" | "COMPLETED";
+        id: string;
+        updatedAt: Date;
+        createdAt: Date;
+        runCount: number;
+        idempotencyKey?: string | undefined;
+    }>;
 }
 export declare function mergeRequestOptions(defaultOptions: ZodFetchOptions, options?: ApiRequestOptions): ZodFetchOptions;