import type * as Extend from "../index"; /** * Edit run object. */ export interface EditRun { /** The type of object. Will always be `"edit_run"`. */ object: "edit_run"; /** * A unique identifier for the edit run. * * Example: `"edr_xK9mLPqRtN3vS8wF5hB2cQ"` */ id: string; /** The input file that was submitted for editing. */ file: Extend.FileSummary; /** * The status of the edit run: * * `"PROCESSING"` - The file is still being processed * * `"PROCESSED"` - The file was successfully edited * * `"FAILED"` - The editing failed (see `failureReason` for details) */ status: Extend.EditRunStatus; /** * The reason for failure. * * **Availability:** Present when `status` is `"FAILED"`. * * Possible values include: * * `UNABLE_TO_DOWNLOAD_FILE` - Failed to load the requested file * * `FILE_TYPE_NOT_SUPPORTED` - File type not supported. Edit runs currently require a PDF * * `FILE_SIZE_TOO_LARGE` - The file exceeds the maximum allowed size * * `CORRUPT_FILE` - The file appears to be corrupted and cannot be edited * * `FIELD_DETECTION_ERROR` - An error occurred during field detection * * `PASSWORD_PROTECTED_FILE` - The file is password protected and cannot be edited * * `FAILED_TO_CONVERT_TO_PDF` - The file could not be converted to PDF for processing * * `INTERNAL_ERROR` - An unexpected internal error occurred * * `INVALID_OPTIONS` - The provided configuration options are invalid * * `EMPTY_SCHEMA` - No schema was provided and no fields could be detected * * `OUT_OF_CREDITS` - Insufficient credits to process the file * * **Note:** Additional failure reasons may be added in the future. Your integration should handle unknown values gracefully. */ failureReason: string | null; /** * A human-readable description of the failure. * * **Availability:** Present when `status` is `"FAILED"`. */ failureMessage: string | null; /** The configuration used for this edit run, including any default values that were applied. */ config: Extend.EditConfig; /** * The output of the edit run. * * **Availability:** Present when `status` is `"PROCESSED"`. */ output: Extend.EditRunOutput | null; /** * Metrics about the editing process. * * **Availability:** Present when `status` is `"PROCESSED"`. */ metrics: Extend.EditRunMetrics | null; /** * Usage credits consumed by this edit run. * * **Availability:** Present when `status` is `"PROCESSED"`, the run was created after October 7, 2025, and the customer is on the current billing system. */ usage: Extend.RunUsage | null; }