mindee/src/parsing/v2/job.d.ts

Mindee Client Library for Node.js

import { StringDict } from "../common";
import { ErrorResponse } from "./errorResponse";
import { JobWebhook } from "./jobWebhook";
/**
 * Job information for a V2 polling attempt.
 */
export declare class Job {
    /**
     * Job ID.
     */
    id: string;
    /**
     * Error response if any.
     */
    error?: ErrorResponse;
    /**
     * Timestamp of the job creation.
     */
    createdAt: Date | null;
    /**
     * ID of the model.
     */
    modelId: string;
    /**
     * Name for the file.
     */
    filename: string;
    /**
     * Optional alias for the file.
     */
    alias: string;
    /**
     * Status of the job.
     */
    status?: string;
    /**
     * URL to poll for the job status.
     */
    pollingUrl: string;
    /**
     * URL to poll for the job result, redirects to the result if available.
     */
    resultUrl?: string;
    /**
     * ID of webhooks associated with the job.
     */
    webhooks: Array<JobWebhook>;
    constructor(serverResponse: StringDict);
}