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

Mindee Client Library for Node.js

import { StringDict } from "../../../parsing/index.js";
import { ErrorResponse } from "../../../v2/index.js";
import { JobWebhook } from "./jobWebhook.js";
/**
 * Job information for a V2 polling attempt.
 */
export declare class Job {
    /**
     * Job ID.
     */
    id: string;
    /**
     * Error response if any.
     */
    error?: ErrorResponse;
    /**
     * Date and time of the Job creation.
     */
    createdAt: Date | null;
    /**
     * Date and time of the Job completion. Filled once processing is finished.
     */
    completedAt: Date | null | undefined;
    /**
     * 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);
}