import { APIResource } from "../core/resource.js";
import { APIPromise } from "../core/api-promise.js";
import { Page, type PageParams, PagePromise } from "../core/pagination.js";
import { RequestOptions } from "../internal/request-options.js";
export declare class InboundMailItems extends APIResource {
    /**
     * Retrieve an Inbound Mail Item
     *
     * @example
     * ```ts
     * const inboundMailItem =
     *   await client.inboundMailItems.retrieve(
     *     'inbound_mail_item_q6rrg7mmqpplx80zceev',
     *   );
     * ```
     */
    retrieve(inboundMailItemID: string, options?: RequestOptions): APIPromise<InboundMailItem>;
    /**
     * List Inbound Mail Items
     *
     * @example
     * ```ts
     * // Automatically fetches more pages as needed.
     * for await (const inboundMailItem of client.inboundMailItems.list()) {
     *   // ...
     * }
     * ```
     */
    list(query?: InboundMailItemListParams | null | undefined, options?: RequestOptions): PagePromise<InboundMailItemsPage, InboundMailItem>;
    /**
     * Deposits or ignores each check contained in a pending Inbound Mail Item.
     * Depositing a check creates a [Check Deposit](#check-deposits) into the Account
     * you specify.
     *
     * @example
     * ```ts
     * const inboundMailItem =
     *   await client.inboundMailItems.action(
     *     'inbound_mail_item_q6rrg7mmqpplx80zceev',
     *     {
     *       checks: [{ action: 'deposit' }, { action: 'ignore' }],
     *     },
     *   );
     * ```
     */
    action(inboundMailItemID: string, body: InboundMailItemActionParams, options?: RequestOptions): APIPromise<InboundMailItem>;
}
export type InboundMailItemsPage = Page<InboundMailItem>;
/**
 * Inbound Mail Items represent pieces of physical mail delivered to a Lockbox
 * Address. Increase automatically deposits checks mailed to a Lockbox Recipient
 * into the recipient's Account. Checks that are not matched to a Lockbox Recipient
 * must be deposited or ignored using the Action an Inbound Mail Item endpoint.
 */
export interface InboundMailItem {
    /**
     * The Inbound Mail Item identifier.
     */
    id: string;
    /**
     * The checks in the mail item.
     */
    checks: Array<InboundMailItem.Check>;
    /**
     * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Inbound
     * Mail Item was created.
     */
    created_at: string;
    /**
     * The identifier for the File containing the scanned contents of the mail item.
     */
    file_id: string;
    /**
     * The identifier for the Lockbox Address that received this mail item.
     */
    lockbox_address_id: string;
    /**
     * The identifier for the Lockbox Recipient that received this mail item. For mail
     * items that could not be routed to a Lockbox Recipient, this will be null.
     */
    lockbox_recipient_id: string | null;
    /**
     * The recipient name as written on the mail item.
     */
    recipient_name: string | null;
    /**
     * If the mail item has been rejected, why it was rejected.
     *
     * - `no_matching_lockbox` - The mail item does not match any lockbox.
     * - `no_check` - The mail item does not contain a check.
     * - `lockbox_not_active` - The Lockbox or its associated Account is not active.
     * - `lockbox_address_not_active` - The Lockbox Address is not active.
     * - `lockbox_recipient_not_active` - The Lockbox Recipient or its associated
     *   Account is not active.
     */
    rejection_reason: 'no_matching_lockbox' | 'no_check' | 'lockbox_not_active' | 'lockbox_address_not_active' | 'lockbox_recipient_not_active' | null;
    /**
     * If the mail item has been processed.
     *
     * - `pending` - The mail item is pending processing.
     * - `processed` - The mail item has been processed.
     * - `rejected` - The mail item has been rejected.
     */
    status: 'pending' | 'processed' | 'rejected';
    /**
     * A constant representing the object's type. For this resource it will always be
     * `inbound_mail_item`.
     */
    type: 'inbound_mail_item';
    [k: string]: unknown;
}
export declare namespace InboundMailItem {
    /**
     * Inbound Mail Item Checks represent the checks in an Inbound Mail Item.
     */
    interface Check {
        /**
         * The amount of the check.
         */
        amount: number;
        /**
         * The identifier for the File containing the back of the check.
         */
        back_file_id: string | null;
        /**
         * The identifier of the Check Deposit if this check was deposited.
         */
        check_deposit_id: string | null;
        /**
         * The identifier for the File containing the front of the check.
         */
        front_file_id: string | null;
        /**
         * The status of the Inbound Mail Item Check.
         *
         * - `pending` - The check is pending processing.
         * - `deposited` - The check has been deposited.
         * - `ignored` - The check has been ignored.
         */
        status: 'pending' | 'deposited' | 'ignored' | null;
    }
}
export interface InboundMailItemListParams extends PageParams {
    created_at?: InboundMailItemListParams.CreatedAt;
    /**
     * Filter Inbound Mail Items to ones sent to the provided Lockbox Address.
     */
    lockbox_address_id?: string;
    /**
     * Filter Inbound Mail Items to ones sent to the provided Lockbox Recipient.
     */
    lockbox_recipient_id?: string;
}
export declare namespace InboundMailItemListParams {
    interface CreatedAt {
        /**
         * Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
         * timestamp.
         */
        after?: string;
        /**
         * Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
         * timestamp.
         */
        before?: string;
        /**
         * Return results on or after this
         * [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
         */
        on_or_after?: string;
        /**
         * Return results on or before this
         * [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
         */
        on_or_before?: string;
    }
}
export interface InboundMailItemActionParams {
    /**
     * The actions to perform on the Inbound Mail Item.
     */
    checks: Array<InboundMailItemActionParams.Check>;
}
export declare namespace InboundMailItemActionParams {
    interface Check {
        /**
         * The action to perform on the Inbound Mail Item.
         *
         * - `deposit` - The check will be deposited.
         * - `ignore` - The check will be ignored.
         */
        action: 'deposit' | 'ignore';
        /**
         * The identifier of the Account to deposit the check into.
         */
        account_id?: string;
    }
}
export declare namespace InboundMailItems {
    export { type InboundMailItem as InboundMailItem, type InboundMailItemsPage as InboundMailItemsPage, type InboundMailItemListParams as InboundMailItemListParams, type InboundMailItemActionParams as InboundMailItemActionParams, };
}
//# sourceMappingURL=inbound-mail-items.d.ts.map