@rearray/sdk 0.1.0

package/dist/index.d.ts

@@ -0,0 +1,833 @@
+/**
+ * This file was auto-generated by openapi-typescript.
+ * Do not make direct changes to the file.
+ */
+interface paths {
+    "/executions": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /** List executions */
+        get: {
+            parameters: {
+                query?: {
+                    status?: string;
+                    task_id?: string;
+                    agent_id?: string;
+                    reference?: string;
+                    from?: string;
+                    to?: string;
+                    cursor?: string;
+                    limit?: number;
+                };
+                header?: never;
+                path?: never;
+                cookie?: never;
+            };
+            requestBody?: never;
+            responses: {
+                /** @description OK */
+                200: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            data?: components["schemas"]["Execution"][];
+                            next_cursor?: string | null;
+                            request_id?: string;
+                        };
+                    };
+                };
+            };
+        };
+        put?: never;
+        /** Create execution */
+        post: {
+            parameters: {
+                query?: {
+                    validate_only?: boolean;
+                };
+                header?: {
+                    "Idempotency-Key"?: string;
+                };
+                path?: never;
+                cookie?: never;
+            };
+            requestBody: {
+                content: {
+                    "application/json": components["schemas"]["CreateExecutionRequest"];
+                };
+            };
+            responses: {
+                /** @description Idempotent replay or validate_only response. */
+                200: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["CreateExecutionResponse"];
+                    };
+                };
+                /** @description Execution queued. */
+                201: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["CreateExecutionResponse"];
+                    };
+                };
+                /** @description Validation error. */
+                422: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["Error"];
+                    };
+                };
+            };
+        };
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/executions/{id}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                id: string;
+            };
+            cookie?: never;
+        };
+        /** Get execution by id */
+        get: {
+            parameters: {
+                query?: never;
+                header?: never;
+                path: {
+                    id: string;
+                };
+                cookie?: never;
+            };
+            requestBody?: never;
+            responses: {
+                /** @description OK */
+                200: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["ExecutionDetail"];
+                    };
+                };
+                /** @description Not found. */
+                404: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["Error"];
+                    };
+                };
+            };
+        };
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/executions/{id}/cancel": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                id: string;
+            };
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /** Cancel execution */
+        post: {
+            parameters: {
+                query?: never;
+                header?: never;
+                path: {
+                    id: string;
+                };
+                cookie?: never;
+            };
+            requestBody?: never;
+            responses: {
+                /** @description Cancelled. */
+                200: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["CancelExecutionResponse"];
+                    };
+                };
+            };
+        };
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/executions/{id}/artifacts": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                id: string;
+            };
+            cookie?: never;
+        };
+        /** List execution artifacts (videos, downloads, prints, screenshots) */
+        get: {
+            parameters: {
+                query?: never;
+                header?: never;
+                path: {
+                    id: string;
+                };
+                cookie?: never;
+            };
+            requestBody?: never;
+            responses: {
+                /** @description Signed video URLs and protected file links. */
+                200: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["ArtifactsResponse"];
+                    };
+                };
+                /** @description Not found. */
+                404: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["Error"];
+                    };
+                };
+            };
+        };
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/executions/{id}/files/{fileId}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                id: string;
+                fileId: string;
+            };
+            cookie?: never;
+        };
+        /** Download one execution file */
+        get: {
+            parameters: {
+                query?: never;
+                header?: never;
+                path: {
+                    id: string;
+                    fileId: string;
+                };
+                cookie?: never;
+            };
+            requestBody?: never;
+            responses: {
+                /** @description Redirect to short-lived signed storage URL. */
+                302: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content?: never;
+                };
+            };
+        };
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/tasks": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /** List runnable tasks for this API key */
+        get: {
+            parameters: {
+                query?: never;
+                header?: never;
+                path?: never;
+                cookie?: never;
+            };
+            requestBody?: never;
+            responses: {
+                /** @description OK */
+                200: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["TaskListResponse"];
+                    };
+                };
+            };
+        };
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/tasks/{id}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                id: string;
+            };
+            cookie?: never;
+        };
+        /** Get task */
+        get: {
+            parameters: {
+                query?: never;
+                header?: never;
+                path: {
+                    id: string;
+                };
+                cookie?: never;
+            };
+            requestBody?: never;
+            responses: {
+                /** @description OK */
+                200: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["TaskDetail"];
+                    };
+                };
+                /** @description Not found. */
+                404: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["Error"];
+                    };
+                };
+            };
+        };
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/tasks/{id}/params-schema": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                id: string;
+            };
+            cookie?: never;
+        };
+        /** Get params schema for a task version */
+        get: {
+            parameters: {
+                query?: {
+                    version?: string;
+                };
+                header?: never;
+                path: {
+                    id: string;
+                };
+                cookie?: never;
+            };
+            requestBody?: never;
+            responses: {
+                /** @description OK */
+                200: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["ParamsSchemaResponse"];
+                    };
+                };
+                /** @description Not found. */
+                404: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["Error"];
+                    };
+                };
+            };
+        };
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/agents": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /** List agents available to this API key */
+        get: {
+            parameters: {
+                query?: never;
+                header?: never;
+                path?: never;
+                cookie?: never;
+            };
+            requestBody?: never;
+            responses: {
+                /** @description OK */
+                200: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["AgentListResponse"];
+                    };
+                };
+            };
+        };
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/webhooks/test": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /** Send a test webhook to a target URL */
+        post: {
+            parameters: {
+                query?: never;
+                header?: never;
+                path?: never;
+                cookie?: never;
+            };
+            requestBody: {
+                content: {
+                    "application/json": components["schemas"]["WebhookTestRequest"];
+                };
+            };
+            responses: {
+                /** @description Enqueued. */
+                202: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["WebhookTestResponse"];
+                    };
+                };
+            };
+        };
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+}
+interface components {
+    schemas: {
+        Error: {
+            error: {
+                /** @enum {string} */
+                code: "unauthorized" | "forbidden" | "ip_not_allowed" | "rate_limited" | "concurrency_limit_reached" | "idempotency_conflict" | "invalid_params" | "invalid_request" | "task_not_runnable" | "agent_unavailable" | "version_not_found" | "not_found" | "method_not_allowed" | "payload_too_large" | "internal_error";
+                message: string;
+                details?: unknown;
+                request_id?: string;
+            };
+        };
+        Execution: {
+            /** Format: uuid */
+            id?: string;
+            status?: string;
+            /** Format: uuid */
+            task_id?: string;
+            /** Format: uuid */
+            task_version_id?: string | null;
+            /** Format: uuid */
+            agent_id?: string;
+            reference?: string | null;
+            metadata?: {
+                [key: string]: unknown;
+            } | null;
+            params?: {
+                [key: string]: unknown;
+            } | null;
+            result?: unknown;
+            error_message?: string | null;
+            /** Format: date-time */
+            started_at?: string | null;
+            /** Format: date-time */
+            stopped_at?: string | null;
+            /** Format: date-time */
+            created_at?: string;
+            /** Format: date-time */
+            updated_at?: string;
+            /** Format: date-time */
+            scheduled_at?: string | null;
+            priority?: number;
+            downloads?: components["schemas"]["ExecutionFile"][];
+            prints?: components["schemas"]["ExecutionFile"][];
+            screenshots?: components["schemas"]["ExecutionFile"][];
+        };
+        ExecutionDetail: {
+            /** Format: uuid */
+            execution_id?: string;
+            status?: string;
+            /** Format: uuid */
+            task_id?: string;
+            /** Format: uuid */
+            task_version_id?: string | null;
+            /** Format: uuid */
+            agent_id?: string;
+            reference?: string | null;
+            metadata?: {
+                [key: string]: unknown;
+            } | null;
+            params?: {
+                [key: string]: unknown;
+            } | null;
+            result?: unknown;
+            error_message?: string | null;
+            /** Format: date-time */
+            started_at?: string | null;
+            /** Format: date-time */
+            stopped_at?: string | null;
+            /** Format: date-time */
+            created_at?: string;
+            /** Format: date-time */
+            updated_at?: string;
+            /** Format: date-time */
+            scheduled_at?: string | null;
+            priority?: number;
+            downloads?: components["schemas"]["ExecutionFile"][];
+            prints?: components["schemas"]["ExecutionFile"][];
+            screenshots?: components["schemas"]["ExecutionFile"][];
+            request_id?: string;
+        };
+        ExecutionFile: {
+            /** Format: uuid */
+            id?: string;
+            file_name?: string;
+            content_type?: string;
+            size_bytes?: number;
+            /** Format: uri */
+            url?: string;
+        };
+        ExecutionVideo: {
+            platform_id?: string | null;
+            handler?: string | null;
+            started_offset_ms?: number;
+            storage_key?: string;
+            /** Format: uri */
+            signed_url?: string | null;
+            expires_in_seconds?: number;
+            error?: string | null;
+        };
+        Task: {
+            /** Format: uuid */
+            id?: string;
+            name?: string | null;
+            description?: string | null;
+            /** Format: uuid */
+            current_version_id?: string | null;
+            /** Format: date-time */
+            created_at?: string;
+            /** Format: date-time */
+            updated_at?: string;
+        };
+        TaskDetail: {
+            /** Format: uuid */
+            id?: string;
+            name?: string | null;
+            description?: string | null;
+            current_version?: {
+                /** Format: uuid */
+                id?: string;
+                version_number?: number;
+                tag?: string | null;
+                params_schema?: unknown;
+                /** Format: date-time */
+                created_at?: string;
+            } | null;
+            platform_ids?: string[];
+            /** Format: date-time */
+            created_at?: string;
+            /** Format: date-time */
+            updated_at?: string;
+            request_id?: string;
+        };
+        TaskVersionSummary: {
+            /** Format: uuid */
+            id?: string;
+            version_number?: number;
+            tag?: string | null;
+            params_schema?: unknown;
+            /** Format: date-time */
+            created_at?: string;
+        };
+        Agent: {
+            /** Format: uuid */
+            id?: string;
+            name?: string | null;
+            description?: string | null;
+            enabled?: boolean;
+            /** Format: date-time */
+            created_at?: string;
+            /** Format: date-time */
+            updated_at?: string;
+        };
+        CreateExecutionRequest: {
+            /** Format: uuid */
+            task_id?: string;
+            /** Format: uuid */
+            task_version_id?: string;
+            /** Format: uuid */
+            agent_id: string;
+            params?: {
+                [key: string]: unknown;
+            };
+            version?: string;
+            reference?: string;
+            metadata?: {
+                [key: string]: unknown;
+            };
+            /** Format: uri */
+            callback_url?: string;
+            /** Format: date-time */
+            scheduled_at?: string;
+            priority?: number;
+        };
+        CreateExecutionResponse: {
+            /** Format: uuid */
+            execution_id?: string | null;
+            status?: string;
+            reference?: string | null;
+            metadata?: {
+                [key: string]: unknown;
+            } | null;
+            /** Format: uuid */
+            task_id?: string;
+            /** Format: uuid */
+            task_version_id?: string | null;
+            /** Format: date-time */
+            scheduled_at?: string | null;
+            priority?: number;
+            request_id?: string;
+            idempotent_replay?: boolean;
+            would_create?: boolean;
+        };
+        CancelExecutionResponse: {
+            /** Format: uuid */
+            execution_id?: string;
+            status?: string;
+            request_id?: string;
+        };
+        ArtifactsResponse: {
+            /** Format: uuid */
+            execution_id?: string;
+            status?: string;
+            /** Format: date-time */
+            started_at?: string | null;
+            /** Format: date-time */
+            stopped_at?: string | null;
+            videos?: components["schemas"]["ExecutionVideo"][];
+            downloads?: components["schemas"]["ExecutionFile"][];
+            prints?: components["schemas"]["ExecutionFile"][];
+            screenshots?: components["schemas"]["ExecutionFile"][];
+            request_id?: string;
+        };
+        ParamsSchemaResponse: {
+            version?: {
+                /** Format: uuid */
+                id?: string;
+                version_number?: number;
+                tag?: string | null;
+                /** Format: date-time */
+                created_at?: string;
+            };
+            params_schema?: unknown;
+            store_schema?: unknown;
+            request_id?: string;
+        };
+        TaskListResponse: {
+            data?: components["schemas"]["Task"][];
+            request_id?: string;
+        };
+        AgentListResponse: {
+            data?: components["schemas"]["Agent"][];
+            request_id?: string;
+        };
+        WebhookTestRequest: {
+            /** Format: uri */
+            callback_url: string;
+        };
+        WebhookTestResponse: {
+            delivery_id?: unknown;
+            /** Format: uuid */
+            event_id?: string;
+            request_id?: string;
+        };
+    };
+    responses: never;
+    parameters: never;
+    requestBodies: never;
+    headers: never;
+    pathItems: never;
+}
+
+/** Webhook callback payload (not yet in OpenAPI). */
+type WebhookEvent = {
+    event_id: string;
+    type: string;
+    occurred_at: string;
+    request_id?: string;
+    reference?: string | null;
+    metadata?: Record<string, unknown>;
+    execution?: Record<string, unknown> | null;
+    message?: string;
+};
+type CreateExecutionRequest = components['schemas']['CreateExecutionRequest'];
+type CreateExecutionResponse = components['schemas']['CreateExecutionResponse'];
+type Execution$1 = components['schemas']['Execution'];
+type ExecutionDetail = components['schemas']['ExecutionDetail'];
+type ArtifactsResponse = components['schemas']['ArtifactsResponse'];
+type Task = components['schemas']['Task'];
+type TaskDetail = components['schemas']['TaskDetail'];
+type ParamsSchemaResponse = components['schemas']['ParamsSchemaResponse'];
+type Agent = components['schemas']['Agent'];
+type ListExecutionsParams$1 = NonNullable<paths['/executions']['get']['parameters']['query']>;
+type ListExecutionsResponse$1 = paths['/executions']['get']['responses'][200]['content']['application/json'];
+type CreateExecutionOptions = {
+    idempotencyKey?: string;
+    validateOnly?: boolean;
+};
+type GetTaskParamsSchemaOptions = {
+    version?: string;
+};
+type RearrayClientOptions = {
+    apiKey: string;
+    baseUrl?: string;
+    fetch?: typeof fetch;
+};
+declare class RearrayClient {
+    private readonly apiKey;
+    private readonly baseUrl;
+    private readonly fetchFn;
+    constructor(options: RearrayClientOptions);
+    createExecution(body: CreateExecutionRequest, options?: CreateExecutionOptions): Promise<CreateExecutionResponse>;
+    listExecutions(params?: ListExecutionsParams$1): Promise<ListExecutionsResponse$1>;
+    iterateExecutions(params?: ListExecutionsParams$1): AsyncGenerator<Execution$1, void, undefined>;
+    getExecution(id: string): Promise<ExecutionDetail>;
+    cancelExecution(id: string): Promise<components['schemas']['CancelExecutionResponse']>;
+    getExecutionArtifacts(id: string): Promise<ArtifactsResponse>;
+    listTasks(): Promise<{
+        data?: Task[];
+        request_id?: string;
+    }>;
+    getTask(id: string): Promise<TaskDetail>;
+    getTaskParamsSchema(id: string, options?: GetTaskParamsSchemaOptions): Promise<ParamsSchemaResponse>;
+    listAgents(): Promise<{
+        data?: Agent[];
+        request_id?: string;
+    }>;
+    testWebhook(callbackUrl: string): Promise<components['schemas']['WebhookTestResponse']>;
+    private request;
+}
+
+type RearrayErrorCode = components['schemas']['Error']['error']['code'];
+type RearrayErrorBody = components['schemas']['Error'];
+declare class RearrayApiError extends Error {
+    readonly code: RearrayErrorCode;
+    readonly status: number;
+    readonly requestId?: string;
+    readonly details?: unknown;
+    constructor(code: RearrayErrorCode, message: string, status: number, requestId?: string, details?: unknown);
+    static fromBody(body: RearrayErrorBody, status: number): RearrayApiError;
+}
+declare function isRearrayApiError(error: unknown): error is RearrayApiError;
+declare function parseErrorBody(body: unknown): RearrayErrorBody | null;
+
+type Execution = components['schemas']['Execution'];
+type ListExecutionsParams = NonNullable<paths['/executions']['get']['parameters']['query']>;
+type ListExecutionsResponse = paths['/executions']['get']['responses'][200]['content']['application/json'];
+type ExecutionLister = {
+    listExecutions(params?: ListExecutionsParams): Promise<ListExecutionsResponse>;
+};
+declare function iterateExecutions(client: ExecutionLister, params?: ListExecutionsParams): AsyncGenerator<Execution, void, undefined>;
+
+type VerifyWebhookSignatureOptions = {
+    payload: string;
+    timestamp: string;
+    signature: string;
+    secret: string;
+    /** Reject timestamps older than this many seconds (default: 300). Set to 0 to skip. */
+    toleranceSeconds?: number;
+};
+declare function verifyWebhookSignature(options: VerifyWebhookSignatureOptions): Promise<boolean>;
+
+export { type Agent, type ArtifactsResponse, type CreateExecutionOptions, type CreateExecutionRequest, type CreateExecutionResponse, type Execution$1 as Execution, type ExecutionDetail, type ExecutionLister, type GetTaskParamsSchemaOptions, type ListExecutionsParams$1 as ListExecutionsParams, type ListExecutionsResponse$1 as ListExecutionsResponse, type ParamsSchemaResponse, RearrayApiError, RearrayClient, type RearrayClientOptions, type RearrayErrorBody, type RearrayErrorCode, type Task, type TaskDetail, type VerifyWebhookSignatureOptions, type WebhookEvent, type components, isRearrayApiError, iterateExecutions, parseErrorBody, type paths, verifyWebhookSignature };