postgrid-node 0.4.2 → 0.6.1

package/resources/print-mail/boxes.d.mts

@@ -1,7 +1,5 @@
 import { APIResource } from "../../core/resource.mjs";
-import * as BoxesAPI from "./boxes.mjs";
 import * as ContactsAPI from "./contacts.mjs";
-import * as PrintMailAPI from "./print-mail.mjs";
 import { APIPromise } from "../../core/api-promise.mjs";
 import { PagePromise, SkipLimit, type SkipLimitParams } from "../../core/pagination.mjs";
 import { RequestOptions } from "../../internal/request-options.mjs";
@@ -41,7 +39,7 @@ export declare class Boxes extends APIResource {
      * });
      * ```
      */
-    create(body: BoxCreateParams, options?: RequestOptions): APIPromise<Box>;
+    create(body: BoxCreateParams, options?: RequestOptions): APIPromise<BoxCreateResponse>;
     /**
      * Retrieve a box by ID.
      *
@@ -50,19 +48,19 @@ export declare class Boxes extends APIResource {
      * const box = await client.printMail.boxes.retrieve('id');
      * ```
      */
-    retrieve(id: string, options?: RequestOptions): APIPromise<Box>;
+    retrieve(id: string, options?: RequestOptions): APIPromise<BoxRetrieveResponse>;
     /**
      * List all boxes.
      *
      * @example
      * ```ts
      * // Automatically fetches more pages as needed.
-     * for await (const box of client.printMail.boxes.list()) {
+     * for await (const boxListResponse of client.printMail.boxes.list()) {
      *   // ...
      * }
      * ```
      */
-    list(query?: BoxListParams | null | undefined, options?: RequestOptions): PagePromise<BoxesSkipLimit, Box>;
+    list(query?: BoxListParams | null | undefined, options?: RequestOptions): PagePromise<BoxListResponsesSkipLimit, BoxListResponse>;
     /**
      * Cancel a box by ID (cannot be undone).
      *
@@ -71,10 +69,26 @@ export declare class Boxes extends APIResource {
      * const box = await client.printMail.boxes.delete('id');
      * ```
      */
-    delete(id: string, options?: RequestOptions): APIPromise<Box>;
+    delete(id: string, options?: RequestOptions): APIPromise<BoxDeleteResponse>;
+    /**
+     * Progresses a box's `status` to the next stage. This is only available in test
+     * mode and can be used to simulate how a live order would progress through the
+     * different statuses.
+     *
+     * Note: this will fail with an `invalid_progression_error` if the status is one of
+     * `completed` or `cancelled`.
+     *
+     * @example
+     * ```ts
+     * const response = await client.printMail.boxes.progressions(
+     *   'id',
+     * );
+     * ```
+     */
+    progressions(id: string, options?: RequestOptions): APIPromise<BoxProgressionsResponse>;
 }
-export type BoxesSkipLimit = SkipLimit<Box>;
-export interface Box {
+export type BoxListResponsesSkipLimit = SkipLimit<BoxListResponse>;
+export interface BoxCreateResponse {
     /**
      * A unique ID prefixed with box\_
      */
@@ -82,7 +96,7 @@ export interface Box {
     /**
      * The cheques inside this box (in read mode).
      */
-    cheques: Array<Box.Cheque>;
+    cheques: Array<BoxCreateResponse.Cheque>;
     /**
      * The UTC time at which this resource was created.
      */
@@ -99,7 +113,7 @@ export interface Box {
      * The mailing class of this order. This determines the speed and cost of delivery.
      * See `OrderMailingClass` for more details.
      */
-    mailingClass: OrderMailingClass;
+    mailingClass: 'first_class' | 'standard_class' | 'express' | 'certified' | 'certified_return_receipt' | 'registered' | 'usps_first_class' | 'usps_standard_class' | 'usps_eddm' | 'usps_express_2_day' | 'usps_express_3_day' | 'usps_first_class_certified' | 'usps_first_class_certified_return_receipt' | 'usps_first_class_registered' | 'usps_express_3_day_signature_confirmation' | 'usps_express_3_day_certified' | 'usps_express_3_day_certified_return_receipt' | 'ca_post_lettermail' | 'ca_post_personalized' | 'ca_post_neighbourhood_mail' | 'ups_express_overnight' | 'ups_express_2_day' | 'ups_express_3_day' | 'royal_mail_first_class' | 'royal_mail_second_class' | 'au_post_second_class';
     /**
      * Always "box".
      */
@@ -113,7 +127,7 @@ export interface Box {
     /**
      * See `OrderStatus` for more details on the status of this order.
      */
-    status: OrderStatus;
+    status: 'ready' | 'printing' | 'processed_for_delivery' | 'completed' | 'cancelled';
     /**
      * The recipient of this order. This will be provided even if you delete the
      * underlying contact.
@@ -127,7 +141,7 @@ export interface Box {
      * The cancellation details of this order. Populated if the order has been
      * cancelled.
      */
-    cancellation?: Cancellation;
+    cancellation?: BoxCreateResponse.Cancellation;
     /**
      * An optional string describing this resource. Will be visible in the API and the
      * dashboard.
@@ -142,7 +156,7 @@ export interface Box {
      * US-printed and US-destined orders. This is the most detailed way to track
      * non-express/certified orders.
      */
-    imbStatus?: OrderImbStatus;
+    imbStatus?: 'entered_mail_stream' | 'out_for_delivery' | 'returned_to_sender';
     /**
      * The most recent ZIP code of the USPS facility that the order has been processed
      * through. Only populated when an `imbStatus` is present.
@@ -180,70 +194,705 @@ export interface Box {
      */
     url?: string;
 }
-export declare namespace Box {
+export declare namespace BoxCreateResponse {
+    interface Cheque {
+        /**
+         * The amount on the cheque.
+         */
+        amount: number;
+        /**
+         * The bank account (ID or reference) from which the cheque amount is drawn.
+         */
+        bankAccount: string;
+        from: ContactsAPI.Contact;
+        /**
+         * The cheque number.
+         */
+        number: number;
+        to: ContactsAPI.Contact;
+        /**
+         * A URL to a logo for the cheque (optional).
+         */
+        logoURL?: string;
+        /**
+         * The memo text on the cheque (optional).
+         */
+        memo?: string;
+        /**
+         * A set of dynamic merge variables for customizing the cheque or accompanying
+         * documents (optional).
+         */
+        mergeVariables?: {
+            [key: string]: unknown;
+        };
+        /**
+         * An optional message template to be printed on or with the cheque.
+         */
+        messageTemplate?: string;
+    }
+    /**
+     * The cancellation details of this order. Populated if the order has been
+     * cancelled.
+     */
+    interface Cancellation {
+        /**
+         * The reason for the cancellation.
+         */
+        reason: 'user_initiated' | 'invalid_content' | 'invalid_order_mailing_class';
+        /**
+         * The user ID who cancelled the order.
+         */
+        cancelledByUser?: string;
+        /**
+         * An optional note provided by the user who cancelled the order.
+         */
+        note?: string;
+    }
+}
+export interface BoxRetrieveResponse {
+    /**
+     * A unique ID prefixed with box\_
+     */
+    id: string;
+    /**
+     * The cheques inside this box (in read mode).
+     */
+    cheques: Array<BoxRetrieveResponse.Cheque>;
+    /**
+     * The UTC time at which this resource was created.
+     */
+    createdAt: string;
+    /**
+     * The contact of the 'from' field in read mode should be a fully expanded Contact.
+     */
+    from: ContactsAPI.Contact;
+    /**
+     * `true` if this is a live mode resource else `false`.
+     */
+    live: boolean;
+    /**
+     * The mailing class of this order. This determines the speed and cost of delivery.
+     * See `OrderMailingClass` for more details.
+     */
+    mailingClass: 'first_class' | 'standard_class' | 'express' | 'certified' | 'certified_return_receipt' | 'registered' | 'usps_first_class' | 'usps_standard_class' | 'usps_eddm' | 'usps_express_2_day' | 'usps_express_3_day' | 'usps_first_class_certified' | 'usps_first_class_certified_return_receipt' | 'usps_first_class_registered' | 'usps_express_3_day_signature_confirmation' | 'usps_express_3_day_certified' | 'usps_express_3_day_certified_return_receipt' | 'ca_post_lettermail' | 'ca_post_personalized' | 'ca_post_neighbourhood_mail' | 'ups_express_overnight' | 'ups_express_2_day' | 'ups_express_3_day' | 'royal_mail_first_class' | 'royal_mail_second_class' | 'au_post_second_class';
+    /**
+     * Always "box".
+     */
+    object: 'box';
+    /**
+     * This order will transition from `ready` to `printing` on the day after this
+     * date. For example, if this is a date on Tuesday, the order will transition to
+     * `printing` on Wednesday at midnight eastern time.
+     */
+    sendDate: string;
+    /**
+     * See `OrderStatus` for more details on the status of this order.
+     */
+    status: 'ready' | 'printing' | 'processed_for_delivery' | 'completed' | 'cancelled';
+    /**
+     * The recipient of this order. This will be provided even if you delete the
+     * underlying contact.
+     */
+    to: ContactsAPI.Contact;
+    /**
+     * The UTC time at which this resource was last updated.
+     */
+    updatedAt: string;
     /**
-     * Model representing a single cheque in "read" mode.
+     * The cancellation details of this order. Populated if the order has been
+     * cancelled.
+     */
+    cancellation?: BoxRetrieveResponse.Cancellation;
+    /**
+     * An optional string describing this resource. Will be visible in the API and the
+     * dashboard.
+     */
+    description?: string;
+    /**
+     * The last date that the IMB status was updated. See `imbStatus` for more details.
+     */
+    imbDate?: string;
+    /**
+     * The Intelligent Mail Barcode (IMB) status of this order. Only populated for
+     * US-printed and US-destined orders. This is the most detailed way to track
+     * non-express/certified orders.
+     */
+    imbStatus?: 'entered_mail_stream' | 'out_for_delivery' | 'returned_to_sender';
+    /**
+     * The most recent ZIP code of the USPS facility that the order has been processed
+     * through. Only populated when an `imbStatus` is present.
+     */
+    imbZIPCode?: string;
+    /**
+     * These will be merged with the variables in the template or HTML you create this
+     * order with. The keys in this object should match the variable names in the
+     * template _exactly_ as they are case-sensitive. Note that these _do not_ apply to
+     * PDFs uploaded with the order.
+     */
+    mergeVariables?: {
+        [key: string]: unknown;
+    };
+    /**
+     * See the section on Metadata.
+     */
+    metadata?: {
+        [key: string]: unknown;
+    };
+    /**
+     * The tracking number of this order. Populated after an express/certified order
+     * has been processed for delivery.
+     */
+    trackingNumber?: string;
+    /**
+     * PostGrid renders a PDF preview for all orders. This should be inspected to
+     * ensure that the order is correct before it is sent out because it shows what
+     * will be printed and mailed to the recipient. Once the PDF preview is generated,
+     * this field will be returned by all `GET` endpoints which produce this order.
      *
-     * - The "from" and "to" should be fully expanded Contact objects once created.
+     * This URL is a signed link to the PDF preview. It will expire after a short
+     * period of time. If you need to access this URL after it has expired, you can
+     * regenerate it by calling the `GET` endpoint again.
      */
-    interface Cheque extends BoxesAPI.BoxChequeBase {
+    url?: string;
+}
+export declare namespace BoxRetrieveResponse {
+    interface Cheque {
+        /**
+         * The amount on the cheque.
+         */
+        amount: number;
+        /**
+         * The bank account (ID or reference) from which the cheque amount is drawn.
+         */
+        bankAccount: string;
         from: ContactsAPI.Contact;
+        /**
+         * The cheque number.
+         */
+        number: number;
         to: ContactsAPI.Contact;
+        /**
+         * A URL to a logo for the cheque (optional).
+         */
+        logoURL?: string;
+        /**
+         * The memo text on the cheque (optional).
+         */
+        memo?: string;
+        /**
+         * A set of dynamic merge variables for customizing the cheque or accompanying
+         * documents (optional).
+         */
+        mergeVariables?: {
+            [key: string]: unknown;
+        };
+        /**
+         * An optional message template to be printed on or with the cheque.
+         */
+        messageTemplate?: string;
+    }
+    /**
+     * The cancellation details of this order. Populated if the order has been
+     * cancelled.
+     */
+    interface Cancellation {
+        /**
+         * The reason for the cancellation.
+         */
+        reason: 'user_initiated' | 'invalid_content' | 'invalid_order_mailing_class';
+        /**
+         * The user ID who cancelled the order.
+         */
+        cancelledByUser?: string;
+        /**
+         * An optional note provided by the user who cancelled the order.
+         */
+        note?: string;
     }
 }
-/**
- * Base fields that both reading and creating a cheque might share.
- */
-export interface BoxChequeBase {
+export interface BoxListResponse {
+    /**
+     * A unique ID prefixed with box\_
+     */
+    id: string;
+    /**
+     * The cheques inside this box (in read mode).
+     */
+    cheques: Array<BoxListResponse.Cheque>;
+    /**
+     * The UTC time at which this resource was created.
+     */
+    createdAt: string;
+    /**
+     * The contact of the 'from' field in read mode should be a fully expanded Contact.
+     */
+    from: ContactsAPI.Contact;
+    /**
+     * `true` if this is a live mode resource else `false`.
+     */
+    live: boolean;
+    /**
+     * The mailing class of this order. This determines the speed and cost of delivery.
+     * See `OrderMailingClass` for more details.
+     */
+    mailingClass: 'first_class' | 'standard_class' | 'express' | 'certified' | 'certified_return_receipt' | 'registered' | 'usps_first_class' | 'usps_standard_class' | 'usps_eddm' | 'usps_express_2_day' | 'usps_express_3_day' | 'usps_first_class_certified' | 'usps_first_class_certified_return_receipt' | 'usps_first_class_registered' | 'usps_express_3_day_signature_confirmation' | 'usps_express_3_day_certified' | 'usps_express_3_day_certified_return_receipt' | 'ca_post_lettermail' | 'ca_post_personalized' | 'ca_post_neighbourhood_mail' | 'ups_express_overnight' | 'ups_express_2_day' | 'ups_express_3_day' | 'royal_mail_first_class' | 'royal_mail_second_class' | 'au_post_second_class';
+    /**
+     * Always "box".
+     */
+    object: 'box';
+    /**
+     * This order will transition from `ready` to `printing` on the day after this
+     * date. For example, if this is a date on Tuesday, the order will transition to
+     * `printing` on Wednesday at midnight eastern time.
+     */
+    sendDate: string;
+    /**
+     * See `OrderStatus` for more details on the status of this order.
+     */
+    status: 'ready' | 'printing' | 'processed_for_delivery' | 'completed' | 'cancelled';
+    /**
+     * The recipient of this order. This will be provided even if you delete the
+     * underlying contact.
+     */
+    to: ContactsAPI.Contact;
     /**
-     * The amount on the cheque.
+     * The UTC time at which this resource was last updated.
      */
-    amount: number;
+    updatedAt: string;
     /**
-     * The bank account (ID or reference) from which the cheque amount is drawn.
+     * The cancellation details of this order. Populated if the order has been
+     * cancelled.
      */
-    bankAccount: string;
+    cancellation?: BoxListResponse.Cancellation;
     /**
-     * The cheque number.
+     * An optional string describing this resource. Will be visible in the API and the
+     * dashboard.
      */
-    number: number;
+    description?: string;
     /**
-     * A URL to a logo for the cheque (optional).
+     * The last date that the IMB status was updated. See `imbStatus` for more details.
      */
-    logoURL?: string;
+    imbDate?: string;
     /**
-     * The memo text on the cheque (optional).
+     * The Intelligent Mail Barcode (IMB) status of this order. Only populated for
+     * US-printed and US-destined orders. This is the most detailed way to track
+     * non-express/certified orders.
      */
-    memo?: string;
+    imbStatus?: 'entered_mail_stream' | 'out_for_delivery' | 'returned_to_sender';
     /**
-     * A set of dynamic merge variables for customizing the cheque or accompanying
-     * documents (optional).
+     * The most recent ZIP code of the USPS facility that the order has been processed
+     * through. Only populated when an `imbStatus` is present.
+     */
+    imbZIPCode?: string;
+    /**
+     * These will be merged with the variables in the template or HTML you create this
+     * order with. The keys in this object should match the variable names in the
+     * template _exactly_ as they are case-sensitive. Note that these _do not_ apply to
+     * PDFs uploaded with the order.
      */
     mergeVariables?: {
         [key: string]: unknown;
     };
     /**
-     * An optional message template to be printed on or with the cheque.
+     * See the section on Metadata.
      */
-    messageTemplate?: string;
+    metadata?: {
+        [key: string]: unknown;
+    };
+    /**
+     * The tracking number of this order. Populated after an express/certified order
+     * has been processed for delivery.
+     */
+    trackingNumber?: string;
+    /**
+     * PostGrid renders a PDF preview for all orders. This should be inspected to
+     * ensure that the order is correct before it is sent out because it shows what
+     * will be printed and mailed to the recipient. Once the PDF preview is generated,
+     * this field will be returned by all `GET` endpoints which produce this order.
+     *
+     * This URL is a signed link to the PDF preview. It will expire after a short
+     * period of time. If you need to access this URL after it has expired, you can
+     * regenerate it by calling the `GET` endpoint again.
+     */
+    url?: string;
 }
-export interface Cancellation {
+export declare namespace BoxListResponse {
+    interface Cheque {
+        /**
+         * The amount on the cheque.
+         */
+        amount: number;
+        /**
+         * The bank account (ID or reference) from which the cheque amount is drawn.
+         */
+        bankAccount: string;
+        from: ContactsAPI.Contact;
+        /**
+         * The cheque number.
+         */
+        number: number;
+        to: ContactsAPI.Contact;
+        /**
+         * A URL to a logo for the cheque (optional).
+         */
+        logoURL?: string;
+        /**
+         * The memo text on the cheque (optional).
+         */
+        memo?: string;
+        /**
+         * A set of dynamic merge variables for customizing the cheque or accompanying
+         * documents (optional).
+         */
+        mergeVariables?: {
+            [key: string]: unknown;
+        };
+        /**
+         * An optional message template to be printed on or with the cheque.
+         */
+        messageTemplate?: string;
+    }
     /**
-     * The reason for the cancellation.
+     * The cancellation details of this order. Populated if the order has been
+     * cancelled.
      */
-    reason: 'user_initiated' | 'invalid_content' | 'invalid_order_mailing_class';
+    interface Cancellation {
+        /**
+         * The reason for the cancellation.
+         */
+        reason: 'user_initiated' | 'invalid_content' | 'invalid_order_mailing_class';
+        /**
+         * The user ID who cancelled the order.
+         */
+        cancelledByUser?: string;
+        /**
+         * An optional note provided by the user who cancelled the order.
+         */
+        note?: string;
+    }
+}
+export interface BoxDeleteResponse {
     /**
-     * The user ID who cancelled the order.
+     * A unique ID prefixed with box\_
      */
-    cancelledByUser?: string;
+    id: string;
     /**
-     * An optional note provided by the user who cancelled the order.
+     * The cheques inside this box (in read mode).
      */
-    note?: string;
+    cheques: Array<BoxDeleteResponse.Cheque>;
+    /**
+     * The UTC time at which this resource was created.
+     */
+    createdAt: string;
+    /**
+     * The contact of the 'from' field in read mode should be a fully expanded Contact.
+     */
+    from: ContactsAPI.Contact;
+    /**
+     * `true` if this is a live mode resource else `false`.
+     */
+    live: boolean;
+    /**
+     * The mailing class of this order. This determines the speed and cost of delivery.
+     * See `OrderMailingClass` for more details.
+     */
+    mailingClass: 'first_class' | 'standard_class' | 'express' | 'certified' | 'certified_return_receipt' | 'registered' | 'usps_first_class' | 'usps_standard_class' | 'usps_eddm' | 'usps_express_2_day' | 'usps_express_3_day' | 'usps_first_class_certified' | 'usps_first_class_certified_return_receipt' | 'usps_first_class_registered' | 'usps_express_3_day_signature_confirmation' | 'usps_express_3_day_certified' | 'usps_express_3_day_certified_return_receipt' | 'ca_post_lettermail' | 'ca_post_personalized' | 'ca_post_neighbourhood_mail' | 'ups_express_overnight' | 'ups_express_2_day' | 'ups_express_3_day' | 'royal_mail_first_class' | 'royal_mail_second_class' | 'au_post_second_class';
+    /**
+     * Always "box".
+     */
+    object: 'box';
+    /**
+     * This order will transition from `ready` to `printing` on the day after this
+     * date. For example, if this is a date on Tuesday, the order will transition to
+     * `printing` on Wednesday at midnight eastern time.
+     */
+    sendDate: string;
+    /**
+     * See `OrderStatus` for more details on the status of this order.
+     */
+    status: 'ready' | 'printing' | 'processed_for_delivery' | 'completed' | 'cancelled';
+    /**
+     * The recipient of this order. This will be provided even if you delete the
+     * underlying contact.
+     */
+    to: ContactsAPI.Contact;
+    /**
+     * The UTC time at which this resource was last updated.
+     */
+    updatedAt: string;
+    /**
+     * The cancellation details of this order. Populated if the order has been
+     * cancelled.
+     */
+    cancellation?: BoxDeleteResponse.Cancellation;
+    /**
+     * An optional string describing this resource. Will be visible in the API and the
+     * dashboard.
+     */
+    description?: string;
+    /**
+     * The last date that the IMB status was updated. See `imbStatus` for more details.
+     */
+    imbDate?: string;
+    /**
+     * The Intelligent Mail Barcode (IMB) status of this order. Only populated for
+     * US-printed and US-destined orders. This is the most detailed way to track
+     * non-express/certified orders.
+     */
+    imbStatus?: 'entered_mail_stream' | 'out_for_delivery' | 'returned_to_sender';
+    /**
+     * The most recent ZIP code of the USPS facility that the order has been processed
+     * through. Only populated when an `imbStatus` is present.
+     */
+    imbZIPCode?: string;
+    /**
+     * These will be merged with the variables in the template or HTML you create this
+     * order with. The keys in this object should match the variable names in the
+     * template _exactly_ as they are case-sensitive. Note that these _do not_ apply to
+     * PDFs uploaded with the order.
+     */
+    mergeVariables?: {
+        [key: string]: unknown;
+    };
+    /**
+     * See the section on Metadata.
+     */
+    metadata?: {
+        [key: string]: unknown;
+    };
+    /**
+     * The tracking number of this order. Populated after an express/certified order
+     * has been processed for delivery.
+     */
+    trackingNumber?: string;
+    /**
+     * PostGrid renders a PDF preview for all orders. This should be inspected to
+     * ensure that the order is correct before it is sent out because it shows what
+     * will be printed and mailed to the recipient. Once the PDF preview is generated,
+     * this field will be returned by all `GET` endpoints which produce this order.
+     *
+     * This URL is a signed link to the PDF preview. It will expire after a short
+     * period of time. If you need to access this URL after it has expired, you can
+     * regenerate it by calling the `GET` endpoint again.
+     */
+    url?: string;
+}
+export declare namespace BoxDeleteResponse {
+    interface Cheque {
+        /**
+         * The amount on the cheque.
+         */
+        amount: number;
+        /**
+         * The bank account (ID or reference) from which the cheque amount is drawn.
+         */
+        bankAccount: string;
+        from: ContactsAPI.Contact;
+        /**
+         * The cheque number.
+         */
+        number: number;
+        to: ContactsAPI.Contact;
+        /**
+         * A URL to a logo for the cheque (optional).
+         */
+        logoURL?: string;
+        /**
+         * The memo text on the cheque (optional).
+         */
+        memo?: string;
+        /**
+         * A set of dynamic merge variables for customizing the cheque or accompanying
+         * documents (optional).
+         */
+        mergeVariables?: {
+            [key: string]: unknown;
+        };
+        /**
+         * An optional message template to be printed on or with the cheque.
+         */
+        messageTemplate?: string;
+    }
+    /**
+     * The cancellation details of this order. Populated if the order has been
+     * cancelled.
+     */
+    interface Cancellation {
+        /**
+         * The reason for the cancellation.
+         */
+        reason: 'user_initiated' | 'invalid_content' | 'invalid_order_mailing_class';
+        /**
+         * The user ID who cancelled the order.
+         */
+        cancelledByUser?: string;
+        /**
+         * An optional note provided by the user who cancelled the order.
+         */
+        note?: string;
+    }
+}
+export interface BoxProgressionsResponse {
+    /**
+     * A unique ID prefixed with box\_
+     */
+    id: string;
+    /**
+     * The cheques inside this box (in read mode).
+     */
+    cheques: Array<BoxProgressionsResponse.Cheque>;
+    /**
+     * The UTC time at which this resource was created.
+     */
+    createdAt: string;
+    /**
+     * The contact of the 'from' field in read mode should be a fully expanded Contact.
+     */
+    from: ContactsAPI.Contact;
+    /**
+     * `true` if this is a live mode resource else `false`.
+     */
+    live: boolean;
+    /**
+     * The mailing class of this order. This determines the speed and cost of delivery.
+     * See `OrderMailingClass` for more details.
+     */
+    mailingClass: 'first_class' | 'standard_class' | 'express' | 'certified' | 'certified_return_receipt' | 'registered' | 'usps_first_class' | 'usps_standard_class' | 'usps_eddm' | 'usps_express_2_day' | 'usps_express_3_day' | 'usps_first_class_certified' | 'usps_first_class_certified_return_receipt' | 'usps_first_class_registered' | 'usps_express_3_day_signature_confirmation' | 'usps_express_3_day_certified' | 'usps_express_3_day_certified_return_receipt' | 'ca_post_lettermail' | 'ca_post_personalized' | 'ca_post_neighbourhood_mail' | 'ups_express_overnight' | 'ups_express_2_day' | 'ups_express_3_day' | 'royal_mail_first_class' | 'royal_mail_second_class' | 'au_post_second_class';
+    /**
+     * Always "box".
+     */
+    object: 'box';
+    /**
+     * This order will transition from `ready` to `printing` on the day after this
+     * date. For example, if this is a date on Tuesday, the order will transition to
+     * `printing` on Wednesday at midnight eastern time.
+     */
+    sendDate: string;
+    /**
+     * See `OrderStatus` for more details on the status of this order.
+     */
+    status: 'ready' | 'printing' | 'processed_for_delivery' | 'completed' | 'cancelled';
+    /**
+     * The recipient of this order. This will be provided even if you delete the
+     * underlying contact.
+     */
+    to: ContactsAPI.Contact;
+    /**
+     * The UTC time at which this resource was last updated.
+     */
+    updatedAt: string;
+    /**
+     * The cancellation details of this order. Populated if the order has been
+     * cancelled.
+     */
+    cancellation?: BoxProgressionsResponse.Cancellation;
+    /**
+     * An optional string describing this resource. Will be visible in the API and the
+     * dashboard.
+     */
+    description?: string;
+    /**
+     * The last date that the IMB status was updated. See `imbStatus` for more details.
+     */
+    imbDate?: string;
+    /**
+     * The Intelligent Mail Barcode (IMB) status of this order. Only populated for
+     * US-printed and US-destined orders. This is the most detailed way to track
+     * non-express/certified orders.
+     */
+    imbStatus?: 'entered_mail_stream' | 'out_for_delivery' | 'returned_to_sender';
+    /**
+     * The most recent ZIP code of the USPS facility that the order has been processed
+     * through. Only populated when an `imbStatus` is present.
+     */
+    imbZIPCode?: string;
+    /**
+     * These will be merged with the variables in the template or HTML you create this
+     * order with. The keys in this object should match the variable names in the
+     * template _exactly_ as they are case-sensitive. Note that these _do not_ apply to
+     * PDFs uploaded with the order.
+     */
+    mergeVariables?: {
+        [key: string]: unknown;
+    };
+    /**
+     * See the section on Metadata.
+     */
+    metadata?: {
+        [key: string]: unknown;
+    };
+    /**
+     * The tracking number of this order. Populated after an express/certified order
+     * has been processed for delivery.
+     */
+    trackingNumber?: string;
+    /**
+     * PostGrid renders a PDF preview for all orders. This should be inspected to
+     * ensure that the order is correct before it is sent out because it shows what
+     * will be printed and mailed to the recipient. Once the PDF preview is generated,
+     * this field will be returned by all `GET` endpoints which produce this order.
+     *
+     * This URL is a signed link to the PDF preview. It will expire after a short
+     * period of time. If you need to access this URL after it has expired, you can
+     * regenerate it by calling the `GET` endpoint again.
+     */
+    url?: string;
+}
+export declare namespace BoxProgressionsResponse {
+    interface Cheque {
+        /**
+         * The amount on the cheque.
+         */
+        amount: number;
+        /**
+         * The bank account (ID or reference) from which the cheque amount is drawn.
+         */
+        bankAccount: string;
+        from: ContactsAPI.Contact;
+        /**
+         * The cheque number.
+         */
+        number: number;
+        to: ContactsAPI.Contact;
+        /**
+         * A URL to a logo for the cheque (optional).
+         */
+        logoURL?: string;
+        /**
+         * The memo text on the cheque (optional).
+         */
+        memo?: string;
+        /**
+         * A set of dynamic merge variables for customizing the cheque or accompanying
+         * documents (optional).
+         */
+        mergeVariables?: {
+            [key: string]: unknown;
+        };
+        /**
+         * An optional message template to be printed on or with the cheque.
+         */
+        messageTemplate?: string;
+    }
+    /**
+     * The cancellation details of this order. Populated if the order has been
+     * cancelled.
+     */
+    interface Cancellation {
+        /**
+         * The reason for the cancellation.
+         */
+        reason: 'user_initiated' | 'invalid_content' | 'invalid_order_mailing_class';
+        /**
+         * The user ID who cancelled the order.
+         */
+        cancelledByUser?: string;
+        /**
+         * An optional note provided by the user who cancelled the order.
+         */
+        note?: string;
+    }
 }
-export type OrderImbStatus = 'entered_mail_stream' | 'out_for_delivery' | 'returned_to_sender';
-export type OrderMailingClass = 'first_class' | 'standard_class' | 'express' | 'certified' | 'certified_return_receipt' | 'registered' | 'usps_first_class' | 'usps_standard_class' | 'usps_eddm' | 'usps_express_2_day' | 'usps_express_3_day' | 'usps_first_class_certified' | 'usps_first_class_certified_return_receipt' | 'usps_first_class_registered' | 'usps_express_3_day_signature_confirmation' | 'usps_express_3_day_certified' | 'usps_express_3_day_certified_return_receipt' | 'ca_post_lettermail' | 'ca_post_personalized' | 'ca_post_neighbourhood_mail' | 'ups_express_overnight' | 'ups_express_2_day' | 'ups_express_3_day' | 'royal_mail_first_class' | 'royal_mail_second_class' | 'au_post_second_class';
-export type OrderStatus = 'ready' | 'printing' | 'processed_for_delivery' | 'completed' | 'cancelled';
 export interface BoxCreateParams {
     /**
      * The cheques to be mailed in the box. Only 100 cheques can be included in a box
@@ -254,14 +903,14 @@ export interface BoxCreateParams {
      * The 'from' (sender) of the entire box. Accepts inline ContactCreate or a
      * contactID.
      */
-    from: PrintMailAPI.ContactCreateWithFirstName | PrintMailAPI.ContactCreateWithCompanyName | string;
+    from: ContactsAPI.ContactCreateWithFirstName | ContactsAPI.ContactCreateWithCompanyName | string;
     /**
      * The recipient of this order. You can either supply the contact information
      * inline here or provide a contact ID. PostGrid will automatically deduplicate
      * contacts regardless of whether you provide the information inline here or call
      * the contact creation endpoint.
      */
-    to: PrintMailAPI.ContactCreateWithFirstName | PrintMailAPI.ContactCreateWithCompanyName | string;
+    to: ContactsAPI.ContactCreateWithFirstName | ContactsAPI.ContactCreateWithCompanyName | string;
     /**
      * An optional string describing this resource. Will be visible in the API and the
      * dashboard.
@@ -271,7 +920,7 @@ export interface BoxCreateParams {
      * The mailing class of this order. If not provided, automatically set to
      * `first_class`.
      */
-    mailingClass?: OrderMailingClass;
+    mailingClass?: 'first_class' | 'standard_class' | 'express' | 'certified' | 'certified_return_receipt' | 'registered' | 'usps_first_class' | 'usps_standard_class' | 'usps_eddm' | 'usps_express_2_day' | 'usps_express_3_day' | 'usps_first_class_certified' | 'usps_first_class_certified_return_receipt' | 'usps_first_class_registered' | 'usps_express_3_day_signature_confirmation' | 'usps_express_3_day_certified' | 'usps_express_3_day_certified_return_receipt' | 'ca_post_lettermail' | 'ca_post_personalized' | 'ca_post_neighbourhood_mail' | 'ups_express_overnight' | 'ups_express_2_day' | 'ups_express_3_day' | 'royal_mail_first_class' | 'royal_mail_second_class' | 'au_post_second_class';
     /**
      * These will be merged with the variables in the template or HTML you create this
      * order with. The keys in this object should match the variable names in the
@@ -294,15 +943,40 @@ export interface BoxCreateParams {
     sendDate?: string;
 }
 export declare namespace BoxCreateParams {
-    /**
-     * Model representing a single cheque in "create" mode.
-     *
-     * - The "from" and "to" can be ContactCreate objects (inline) or string
-     *   contactIDs.
-     */
-    interface Cheque extends BoxesAPI.BoxChequeBase {
-        from: PrintMailAPI.ContactCreateWithFirstName | PrintMailAPI.ContactCreateWithCompanyName | string;
-        to: PrintMailAPI.ContactCreateWithFirstName | PrintMailAPI.ContactCreateWithCompanyName | string;
+    interface Cheque {
+        /**
+         * The amount on the cheque.
+         */
+        amount: number;
+        /**
+         * The bank account (ID or reference) from which the cheque amount is drawn.
+         */
+        bankAccount: string;
+        from: ContactsAPI.ContactCreateWithFirstName | ContactsAPI.ContactCreateWithCompanyName | string;
+        /**
+         * The cheque number.
+         */
+        number: number;
+        to: ContactsAPI.ContactCreateWithFirstName | ContactsAPI.ContactCreateWithCompanyName | string;
+        /**
+         * A URL to a logo for the cheque (optional).
+         */
+        logoURL?: string;
+        /**
+         * The memo text on the cheque (optional).
+         */
+        memo?: string;
+        /**
+         * A set of dynamic merge variables for customizing the cheque or accompanying
+         * documents (optional).
+         */
+        mergeVariables?: {
+            [key: string]: unknown;
+        };
+        /**
+         * An optional message template to be printed on or with the cheque.
+         */
+        messageTemplate?: string;
     }
 }
 export interface BoxListParams extends SkipLimitParams {
@@ -316,6 +990,6 @@ export interface BoxListParams extends SkipLimitParams {
     search?: string;
 }
 export declare namespace Boxes {
-    export { type Box as Box, type BoxChequeBase as BoxChequeBase, type Cancellation as Cancellation, type OrderImbStatus as OrderImbStatus, type OrderMailingClass as OrderMailingClass, type OrderStatus as OrderStatus, type BoxesSkipLimit as BoxesSkipLimit, type BoxCreateParams as BoxCreateParams, type BoxListParams as BoxListParams, };
+    export { type BoxCreateResponse as BoxCreateResponse, type BoxRetrieveResponse as BoxRetrieveResponse, type BoxListResponse as BoxListResponse, type BoxDeleteResponse as BoxDeleteResponse, type BoxProgressionsResponse as BoxProgressionsResponse, type BoxListResponsesSkipLimit as BoxListResponsesSkipLimit, type BoxCreateParams as BoxCreateParams, type BoxListParams as BoxListParams, };
 }
 //# sourceMappingURL=boxes.d.mts.map