import { APIResource } from "../../core/resource.js"; import * as InboundMailItemsAPI from "../inbound-mail-items.js"; import { APIPromise } from "../../core/api-promise.js"; import { RequestOptions } from "../../internal/request-options.js"; export declare class InboundMailItems extends APIResource { /** * Simulates an Inbound Mail Item to one of your Lockbox Addresses or Lockbox * Recipients, as if someone had mailed a physical check. Increase automatically * deposits a check mailed to a Lockbox Recipient into the recipient's Account. A * check mailed to a Lockbox Address must be deposited or ignored with the * [Action an Inbound Mail Item](#inbound-mail-items) endpoint. * * @example * ```ts * const inboundMailItem = * await client.simulations.inboundMailItems.create({ * amount: 1000, * }); * ``` */ create(body: InboundMailItemCreateParams, options?: RequestOptions): APIPromise; } export interface InboundMailItemCreateParams { /** * The amount of the check to be simulated, in cents. */ amount: number; /** * The file containing the PDF contents. If not present, a default check image file * will be used. */ contents_file_id?: string; /** * The identifier of the Lockbox Address to simulate inbound mail to. Exactly one * lockbox identifier parameter must be provided. */ lockbox_address_id?: string; /** * The identifier of the Lockbox Recipient to simulate inbound mail to. Exactly one * lockbox identifier parameter must be provided. */ lockbox_recipient_id?: string; [k: string]: unknown; } export declare namespace InboundMailItems { export { type InboundMailItemCreateParams as InboundMailItemCreateParams }; } //# sourceMappingURL=inbound-mail-items.d.ts.map