/**
 * Top-level API response models used by the Textract Response Parser.
 *
 * These models/interfaces cover the top-level response structures as returned by Textract APIs
 */
import { ApiExpenseDocument } from "./expense";
import { ApiIdentityDocument } from "./id";
import { ApiBlock } from "./document";
/**
 * Enumeration of status messages reported for async API jobs
 */
export declare const enum ApiJobStatus {
    Failed = "FAILED",
    InProgress = "IN_PROGRESS",
    PartialSuccess = "PARTIAL_SUCCESS",
    Succeeded = "SUCCEEDED"
}
/**
 * Information about an input document
 *
 * See: https://docs.aws.amazon.com/textract/latest/dg/API_DocumentMetadata.html
 */
export interface ApiDocumentMetadata {
    Pages: number;
}
/**
 * Result data from an Amazon Textract expense analysis
 *
 * See: https://docs.aws.amazon.com/textract/latest/dg/API_AnalyzeExpense.html
 *
 * (Async GetExpenseAnalysis results share the structure but add fields)
 */
export interface ApiAnalyzeExpenseResponse {
    DocumentMetadata: ApiDocumentMetadata;
    ExpenseDocuments: ApiExpenseDocument[];
}
/**
 * Result data from an Amazon Textract identity document analysis
 *
 * See: https://docs.aws.amazon.com/textract/latest/dg/API_AnalyzeID.html
 */
export interface ApiAnalyzeIdResponse {
    readonly AnalyzeIDModelVersion: string;
    DocumentMetadata: ApiDocumentMetadata;
    IdentityDocuments: ApiIdentityDocument[];
}
export interface ApiResponseWithContent {
    Blocks: ApiBlock[];
    DocumentMetadata: ApiDocumentMetadata;
}
/**
 * Result data from an Amazon Textract general document analysis
 *
 * See: https://docs.aws.amazon.com/textract/latest/dg/API_GetDocumentAnalysis.html
 */
export interface ApiAnalyzeDocumentResponse extends ApiResponseWithContent {
    AnalyzeDocumentModelVersion: string;
    HumanLoopActivationOutput?: {
        HumanLoopActivationConditionsEvaluationResults: string;
        HumanLoopActivationReasons: string[];
        HumanLoopArn: string;
    };
}
/**
 * Result data from an Amazon Textract text detection job (OCR only, no analysis)
 *
 * See: https://docs.aws.amazon.com/textract/latest/dg/API_GetDocumentTextDetection.html
 */
export interface ApiDetectDocumentTextResponse extends ApiResponseWithContent {
    DetectDocumentTextModelVersion: string;
}
export interface ApiAsyncJobOutputInProgress {
    JobStatus: "IN_PROGRESS";
    StatusMessage?: string;
    Warnings?: [
        {
            ErrorCode: string;
            Pages: number[];
        }
    ];
}
/**
 * @deprecated Backward compatibility for typo: Please use ApiAsyncJobOutputInProgress
 */
export interface ApiAsyncJobOuputInProgress extends ApiAsyncJobOutputInProgress {
}
/**
 * Shared fields reported for Get*Analysis APIs concerning asynchronous jobs
 */
interface ApiAsyncJobOutputStatus {
    JobStatus: "IN_PROGRESS" | "SUCCEEDED" | "FAILED" | "PARTIAL_SUCCESS";
    /**
     * When present, a continuation token to fetch the next section of the response
     *
     * In some cases this field can be present but set to null, as raised in
     * https://github.com/aws-samples/amazon-textract-response-parser/issues/154
     */
    NextToken?: string | null;
    StatusMessage?: string;
    Warnings?: ApiResultWarning[];
}
export interface ApiResultWarning {
    ErrorCode: string;
    Pages: number[];
}
export interface ApiAsyncJobOuputSucceded extends ApiResponseWithContent, ApiAsyncJobOutputStatus {
    JobStatus: "SUCCEEDED";
}
export interface ApiAsyncJobOutputPartialSuccess extends ApiResponseWithContent, ApiAsyncJobOutputStatus {
    JobStatus: "PARTIAL_SUCCESS";
}
export interface ApiAsyncJobOutputFailed extends ApiAsyncJobOutputStatus {
    JobStatus: "FAILED";
}
export type ApiAsyncDocumentAnalysis = ApiAsyncJobOutputInProgress | ({
    AnalyzeDocumentModelVersion: string;
} & (ApiAsyncJobOutputFailed | ApiAsyncJobOutputPartialSuccess | ApiAsyncJobOuputSucceded));
export type ApiAsyncDocumentTextDetection = ApiAsyncJobOutputInProgress | ({
    DetectDocumentTextModelVersion: string;
} & (ApiAsyncJobOutputFailed | ApiAsyncJobOutputPartialSuccess | ApiAsyncJobOuputSucceded));
export type ApiResponsePage = ApiAnalyzeDocumentResponse | ApiAsyncDocumentAnalysis | ApiAsyncDocumentTextDetection | ApiDetectDocumentTextResponse;
export type ApiResponsePages = ApiAnalyzeDocumentResponse[] | ApiAsyncDocumentAnalysis[] | ApiAsyncDocumentTextDetection[] | ApiDetectDocumentTextResponse[];
export {};