postgrid-node 0.4.2 → 0.6.1

package/resources/print-mail/self-mailers.d.mts

@@ -1,8 +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 * as OrderProfilesSelfMailersAPI from "./order-profiles/self-mailers.mjs";
 import { APIPromise } from "../../core/api-promise.mjs";
 import { PagePromise, SkipLimit, type SkipLimitParams } from "../../core/pagination.mjs";
 import { RequestOptions } from "../../internal/request-options.mjs";
@@ -61,6 +58,21 @@ export declare class SelfMailers extends APIResource {
      * ```
      */
     delete(id: string, options?: RequestOptions): APIPromise<SelfMailer>;
+    /**
+     * Progresses a self-mailer'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 selfMailer =
+     *   await client.printMail.selfMailers.progress('id');
+     * ```
+     */
+    progress(id: string, options?: RequestOptions): APIPromise<SelfMailer>;
     /**
      * Retrieve a self-mailer preview URL.
      *
@@ -99,7 +111,7 @@ export interface SelfMailer {
      * The mailing class of this order. This determines the speed and cost of delivery.
      * See `OrderMailingClass` for more details.
      */
-    mailingClass: BoxesAPI.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 `self_mailer`.
      */
@@ -113,11 +125,11 @@ export interface SelfMailer {
     /**
      * Enum representing the supported self-mailer sizes.
      */
-    size: OrderProfilesSelfMailersAPI.SelfMailerSize;
+    size: '8.5x11_bifold' | '8.5x11_trifold' | '9.5x16_trifold';
     /**
      * See `OrderStatus` for more details on the status of this order.
      */
-    status: BoxesAPI.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.
@@ -131,7 +143,7 @@ export interface SelfMailer {
      * The cancellation details of this order. Populated if the order has been
      * cancelled.
      */
-    cancellation?: BoxesAPI.Cancellation;
+    cancellation?: SelfMailer.Cancellation;
     /**
      * An optional string describing this resource. Will be visible in the API and the
      * dashboard.
@@ -146,7 +158,7 @@ export interface SelfMailer {
      * US-printed and US-destined orders. This is the most detailed way to track
      * non-express/certified orders.
      */
-    imbStatus?: BoxesAPI.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.
@@ -184,6 +196,26 @@ export interface SelfMailer {
      */
     url?: string;
 }
+export declare namespace SelfMailer {
+    /**
+     * 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 SelfMailerRetrieveURLResponse {
     /**
      * A unique ID prefixed with self*mailer*
@@ -203,7 +235,7 @@ export declare namespace SelfMailerCreateParams {
          * The contact information of the sender. You can pass contact information inline
          * here just like you can for the `to`.
          */
-        from: PrintMailAPI.ContactCreateWithFirstName | PrintMailAPI.ContactCreateWithCompanyName | string;
+        from: ContactsAPI.ContactCreateWithFirstName | ContactsAPI.ContactCreateWithCompanyName | string;
         /**
          * The HTML content for the inside of the self-mailer. You can supply _either_ this
          * or `insideTemplate` but not both.
@@ -217,14 +249,14 @@ export declare namespace SelfMailerCreateParams {
         /**
          * Enum representing the supported self-mailer sizes.
          */
-        size: OrderProfilesSelfMailersAPI.SelfMailerSize;
+        size: '8.5x11_bifold' | '8.5x11_trifold' | '9.5x16_trifold';
         /**
          * 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.
@@ -234,7 +266,7 @@ export declare namespace SelfMailerCreateParams {
          * The mailing class of this order. If not provided, automatically set to
          * `first_class`.
          */
-        mailingClass?: BoxesAPI.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
@@ -273,7 +305,7 @@ export declare namespace SelfMailerCreateParams {
          * The contact information of the sender. You can pass contact information inline
          * here just like you can for the `to`.
          */
-        from: PrintMailAPI.ContactCreateWithFirstName | PrintMailAPI.ContactCreateWithCompanyName | string;
+        from: ContactsAPI.ContactCreateWithFirstName | ContactsAPI.ContactCreateWithCompanyName | string;
         /**
          * A URL pointing to a 2 page PDF file. The first page is the inside of the
          * self-mailer and the second page is the outside (where the address will be
@@ -283,14 +315,14 @@ export declare namespace SelfMailerCreateParams {
         /**
          * Enum representing the supported self-mailer sizes.
          */
-        size: OrderProfilesSelfMailersAPI.SelfMailerSize;
+        size: '8.5x11_bifold' | '8.5x11_trifold' | '9.5x16_trifold';
         /**
          * 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.
@@ -300,7 +332,7 @@ export declare namespace SelfMailerCreateParams {
          * The mailing class of this order. If not provided, automatically set to
          * `first_class`.
          */
-        mailingClass?: BoxesAPI.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
@@ -327,7 +359,7 @@ export declare namespace SelfMailerCreateParams {
          * The contact information of the sender. You can pass contact information inline
          * here just like you can for the `to`.
          */
-        from: PrintMailAPI.ContactCreateWithFirstName | PrintMailAPI.ContactCreateWithCompanyName | string;
+        from: ContactsAPI.ContactCreateWithFirstName | ContactsAPI.ContactCreateWithCompanyName | string;
         /**
          * A 2 page PDF file. The first page is the inside of the self-mailer and the
          * second page is the outside (where the address will be stamped on).
@@ -336,14 +368,14 @@ export declare namespace SelfMailerCreateParams {
         /**
          * Enum representing the supported self-mailer sizes.
          */
-        size: OrderProfilesSelfMailersAPI.SelfMailerSize;
+        size: '8.5x11_bifold' | '8.5x11_trifold' | '9.5x16_trifold';
         /**
          * 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.
@@ -353,7 +385,7 @@ export declare namespace SelfMailerCreateParams {
          * The mailing class of this order. If not provided, automatically set to
          * `first_class`.
          */
-        mailingClass?: BoxesAPI.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

package/resources/print-mail/self-mailers.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"self-mailers.d.mts","sourceRoot":"","sources":["../../src/resources/print-mail/self-mailers.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,QAAQ;OACb,KAAK,WAAW;OAChB,KAAK,YAAY;OACjB,KAAK,2BAA2B;OAChC,EAAE,UAAU,EAAE;OACd,EAAE,WAAW,EAAE,SAAS,EAAE,KAAK,eAAe,EAAE;OAChD,EAAE,cAAc,EAAE;AAGzB,qBAAa,WAAY,SAAQ,WAAW;IAC1C;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,MAAM,CAAC,IAAI,EAAE,sBAAsB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,UAAU,CAAC;IAItF;;;;;;;;OAQG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,UAAU,CAAC;IAItE;;;;;;;;;;OAUG;IACH,IAAI,CACF,KAAK,GAAE,oBAAoB,GAAG,IAAI,GAAG,SAAc,EACnD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,oBAAoB,EAAE,UAAU,CAAC;IAOhD;;;;;;;;OAQG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,UAAU,CAAC;IAIpE;;;;;;;;;;;;;OAaG;IACH,WAAW,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,6BAA6B,CAAC;CAG7F;AAED,MAAM,MAAM,oBAAoB,GAAG,SAAS,CAAC,UAAU,CAAC,CAAC;AAEzD,MAAM,WAAW,UAAU;IACzB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,IAAI,EAAE,WAAW,CAAC,OAAO,CAAC;IAE1B;;OAEG;IACH,IAAI,EAAE,OAAO,CAAC;IAEd;;;OAGG;IACH,YAAY,EAAE,QAAQ,CAAC,iBAAiB,CAAC;IAEzC;;OAEG;IACH,MAAM,EAAE,aAAa,CAAC;IAEtB;;;;OAIG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,IAAI,EAAE,2BAA2B,CAAC,cAAc,CAAC;IAEjD;;OAEG;IACH,MAAM,EAAE,QAAQ,CAAC,WAAW,CAAC;IAE7B;;;OAGG;IACH,EAAE,EAAE,WAAW,CAAC,OAAO,CAAC;IAExB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;;OAGG;IACH,YAAY,CAAC,EAAE,QAAQ,CAAC,YAAY,CAAC;IAErC;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;;;OAIG;IACH,SAAS,CAAC,EAAE,QAAQ,CAAC,cAAc,CAAC;IAEpC;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;;;OAKG;IACH,cAAc,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAE5C;;OAEG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAEtC;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;;;;;;;OASG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,6BAA6B;IAC5C;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX,MAAM,EAAE,MAAM,CAAC;IAEf;;;OAGG;IACH,GAAG,EAAE,MAAM,CAAC;CACb;AAED,MAAM,MAAM,sBAAsB,GAC9B,sBAAsB,CAAC,wBAAwB,GAC/C,sBAAsB,CAAC,4BAA4B,GACnD,sBAAsB,CAAC,0BAA0B,GACjD,sBAAsB,CAAC,2BAA2B,CAAC;AAEvD,MAAM,CAAC,OAAO,WAAW,sBAAsB,CAAC;IAC9C,UAAiB,wBAAwB;QACvC;;;WAGG;QACH,IAAI,EAAE,YAAY,CAAC,0BAA0B,GAAG,YAAY,CAAC,4BAA4B,GAAG,MAAM,CAAC;QAEnG;;;WAGG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;;WAGG;QACH,WAAW,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,IAAI,EAAE,2BAA2B,CAAC,cAAc,CAAC;QAEjD;;;;;WAKG;QACH,EAAE,EAAE,YAAY,CAAC,0BAA0B,GAAG,YAAY,CAAC,4BAA4B,GAAG,MAAM,CAAC;QAEjG;;;WAGG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB;;;WAGG;QACH,YAAY,CAAC,EAAE,QAAQ,CAAC,iBAAiB,CAAC;QAE1C;;;;;WAKG;QACH,cAAc,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;SAAE,CAAC;QAE5C;;WAEG;QACH,QAAQ,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;SAAE,CAAC;QAEtC;;;WAGG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC;KACnB;IAED,UAAiB,4BAA4B;QAC3C;;;WAGG;QACH,cAAc,EAAE,MAAM,CAAC;QAEvB;;;WAGG;QACH,eAAe,EAAE,MAAM,CAAC;KACzB;IAED,UAAiB,0BAA0B;QACzC;;;WAGG;QACH,IAAI,EAAE,YAAY,CAAC,0BAA0B,GAAG,YAAY,CAAC,4BAA4B,GAAG,MAAM,CAAC;QAEnG;;;;WAIG;QACH,GAAG,EAAE,MAAM,CAAC;QAEZ;;WAEG;QACH,IAAI,EAAE,2BAA2B,CAAC,cAAc,CAAC;QAEjD;;;;;WAKG;QACH,EAAE,EAAE,YAAY,CAAC,0BAA0B,GAAG,YAAY,CAAC,4BAA4B,GAAG,MAAM,CAAC;QAEjG;;;WAGG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB;;;WAGG;QACH,YAAY,CAAC,EAAE,QAAQ,CAAC,iBAAiB,CAAC;QAE1C;;;;;WAKG;QACH,cAAc,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;SAAE,CAAC;QAE5C;;WAEG;QACH,QAAQ,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;SAAE,CAAC;QAEtC;;;WAGG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC;KACnB;IAED,UAAiB,2BAA2B;QAC1C;;;WAGG;QACH,IAAI,EAAE,YAAY,CAAC,0BAA0B,GAAG,YAAY,CAAC,4BAA4B,GAAG,MAAM,CAAC;QAEnG;;;WAGG;QACH,GAAG,EAAE,MAAM,CAAC;QAEZ;;WAEG;QACH,IAAI,EAAE,2BAA2B,CAAC,cAAc,CAAC;QAEjD;;;;;WAKG;QACH,EAAE,EAAE,YAAY,CAAC,0BAA0B,GAAG,YAAY,CAAC,4BAA4B,GAAG,MAAM,CAAC;QAEjG;;;WAGG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB;;;WAGG;QACH,YAAY,CAAC,EAAE,QAAQ,CAAC,iBAAiB,CAAC;QAE1C;;;;;WAKG;QACH,cAAc,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;SAAE,CAAC;QAE5C;;WAEG;QACH,QAAQ,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;SAAE,CAAC;QAEtC;;;WAGG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC;KACnB;CACF;AAED,MAAM,WAAW,oBAAqB,SAAQ,eAAe;IAC3D;;;;;;OAMG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,CAAC,OAAO,WAAW,WAAW,CAAC;IACnC,OAAO,EACL,KAAK,UAAU,IAAI,UAAU,EAC7B,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,oBAAoB,IAAI,oBAAoB,GAClD,CAAC;CACH"}
+{"version":3,"file":"self-mailers.d.mts","sourceRoot":"","sources":["../../src/resources/print-mail/self-mailers.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,WAAW;OAChB,EAAE,UAAU,EAAE;OACd,EAAE,WAAW,EAAE,SAAS,EAAE,KAAK,eAAe,EAAE;OAChD,EAAE,cAAc,EAAE;AAGzB,qBAAa,WAAY,SAAQ,WAAW;IAC1C;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,MAAM,CAAC,IAAI,EAAE,sBAAsB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,UAAU,CAAC;IAItF;;;;;;;;OAQG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,UAAU,CAAC;IAItE;;;;;;;;;;OAUG;IACH,IAAI,CACF,KAAK,GAAE,oBAAoB,GAAG,IAAI,GAAG,SAAc,EACnD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,oBAAoB,EAAE,UAAU,CAAC;IAOhD;;;;;;;;OAQG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,UAAU,CAAC;IAIpE;;;;;;;;;;;;;OAaG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,UAAU,CAAC;IAItE;;;;;;;;;;;;;OAaG;IACH,WAAW,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,6BAA6B,CAAC;CAG7F;AAED,MAAM,MAAM,oBAAoB,GAAG,SAAS,CAAC,UAAU,CAAC,CAAC;AAEzD,MAAM,WAAW,UAAU;IACzB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,IAAI,EAAE,WAAW,CAAC,OAAO,CAAC;IAE1B;;OAEG;IACH,IAAI,EAAE,OAAO,CAAC;IAEd;;;OAGG;IACH,YAAY,EACR,aAAa,GACb,gBAAgB,GAChB,SAAS,GACT,WAAW,GACX,0BAA0B,GAC1B,YAAY,GACZ,kBAAkB,GAClB,qBAAqB,GACrB,WAAW,GACX,oBAAoB,GACpB,oBAAoB,GACpB,4BAA4B,GAC5B,2CAA2C,GAC3C,6BAA6B,GAC7B,2CAA2C,GAC3C,8BAA8B,GAC9B,6CAA6C,GAC7C,oBAAoB,GACpB,sBAAsB,GACtB,4BAA4B,GAC5B,uBAAuB,GACvB,mBAAmB,GACnB,mBAAmB,GACnB,wBAAwB,GACxB,yBAAyB,GACzB,sBAAsB,CAAC;IAE3B;;OAEG;IACH,MAAM,EAAE,aAAa,CAAC;IAEtB;;;;OAIG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,IAAI,EAAE,eAAe,GAAG,gBAAgB,GAAG,gBAAgB,CAAC;IAE5D;;OAEG;IACH,MAAM,EAAE,OAAO,GAAG,UAAU,GAAG,wBAAwB,GAAG,WAAW,GAAG,WAAW,CAAC;IAEpF;;;OAGG;IACH,EAAE,EAAE,WAAW,CAAC,OAAO,CAAC;IAExB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;;OAGG;IACH,YAAY,CAAC,EAAE,UAAU,CAAC,YAAY,CAAC;IAEvC;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;;;OAIG;IACH,SAAS,CAAC,EAAE,qBAAqB,GAAG,kBAAkB,GAAG,oBAAoB,CAAC;IAE9E;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;;;OAKG;IACH,cAAc,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAE5C;;OAEG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAEtC;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;;;;;;;OASG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AAED,yBAAiB,UAAU,CAAC;IAC1B;;;OAGG;IACH,UAAiB,YAAY;QAC3B;;WAEG;QACH,MAAM,EAAE,gBAAgB,GAAG,iBAAiB,GAAG,6BAA6B,CAAC;QAE7E;;WAEG;QACH,eAAe,CAAC,EAAE,MAAM,CAAC;QAEzB;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;KACf;CACF;AAED,MAAM,WAAW,6BAA6B;IAC5C;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX,MAAM,EAAE,MAAM,CAAC;IAEf;;;OAGG;IACH,GAAG,EAAE,MAAM,CAAC;CACb;AAED,MAAM,MAAM,sBAAsB,GAC9B,sBAAsB,CAAC,wBAAwB,GAC/C,sBAAsB,CAAC,4BAA4B,GACnD,sBAAsB,CAAC,0BAA0B,GACjD,sBAAsB,CAAC,2BAA2B,CAAC;AAEvD,MAAM,CAAC,OAAO,WAAW,sBAAsB,CAAC;IAC9C,UAAiB,wBAAwB;QACvC;;;WAGG;QACH,IAAI,EAAE,WAAW,CAAC,0BAA0B,GAAG,WAAW,CAAC,4BAA4B,GAAG,MAAM,CAAC;QAEjG;;;WAGG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;;WAGG;QACH,WAAW,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,IAAI,EAAE,eAAe,GAAG,gBAAgB,GAAG,gBAAgB,CAAC;QAE5D;;;;;WAKG;QACH,EAAE,EAAE,WAAW,CAAC,0BAA0B,GAAG,WAAW,CAAC,4BAA4B,GAAG,MAAM,CAAC;QAE/F;;;WAGG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB;;;WAGG;QACH,YAAY,CAAC,EACT,aAAa,GACb,gBAAgB,GAChB,SAAS,GACT,WAAW,GACX,0BAA0B,GAC1B,YAAY,GACZ,kBAAkB,GAClB,qBAAqB,GACrB,WAAW,GACX,oBAAoB,GACpB,oBAAoB,GACpB,4BAA4B,GAC5B,2CAA2C,GAC3C,6BAA6B,GAC7B,2CAA2C,GAC3C,8BAA8B,GAC9B,6CAA6C,GAC7C,oBAAoB,GACpB,sBAAsB,GACtB,4BAA4B,GAC5B,uBAAuB,GACvB,mBAAmB,GACnB,mBAAmB,GACnB,wBAAwB,GACxB,yBAAyB,GACzB,sBAAsB,CAAC;QAE3B;;;;;WAKG;QACH,cAAc,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;SAAE,CAAC;QAE5C;;WAEG;QACH,QAAQ,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;SAAE,CAAC;QAEtC;;;WAGG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC;KACnB;IAED,UAAiB,4BAA4B;QAC3C;;;WAGG;QACH,cAAc,EAAE,MAAM,CAAC;QAEvB;;;WAGG;QACH,eAAe,EAAE,MAAM,CAAC;KACzB;IAED,UAAiB,0BAA0B;QACzC;;;WAGG;QACH,IAAI,EAAE,WAAW,CAAC,0BAA0B,GAAG,WAAW,CAAC,4BAA4B,GAAG,MAAM,CAAC;QAEjG;;;;WAIG;QACH,GAAG,EAAE,MAAM,CAAC;QAEZ;;WAEG;QACH,IAAI,EAAE,eAAe,GAAG,gBAAgB,GAAG,gBAAgB,CAAC;QAE5D;;;;;WAKG;QACH,EAAE,EAAE,WAAW,CAAC,0BAA0B,GAAG,WAAW,CAAC,4BAA4B,GAAG,MAAM,CAAC;QAE/F;;;WAGG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB;;;WAGG;QACH,YAAY,CAAC,EACT,aAAa,GACb,gBAAgB,GAChB,SAAS,GACT,WAAW,GACX,0BAA0B,GAC1B,YAAY,GACZ,kBAAkB,GAClB,qBAAqB,GACrB,WAAW,GACX,oBAAoB,GACpB,oBAAoB,GACpB,4BAA4B,GAC5B,2CAA2C,GAC3C,6BAA6B,GAC7B,2CAA2C,GAC3C,8BAA8B,GAC9B,6CAA6C,GAC7C,oBAAoB,GACpB,sBAAsB,GACtB,4BAA4B,GAC5B,uBAAuB,GACvB,mBAAmB,GACnB,mBAAmB,GACnB,wBAAwB,GACxB,yBAAyB,GACzB,sBAAsB,CAAC;QAE3B;;;;;WAKG;QACH,cAAc,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;SAAE,CAAC;QAE5C;;WAEG;QACH,QAAQ,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;SAAE,CAAC;QAEtC;;;WAGG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC;KACnB;IAED,UAAiB,2BAA2B;QAC1C;;;WAGG;QACH,IAAI,EAAE,WAAW,CAAC,0BAA0B,GAAG,WAAW,CAAC,4BAA4B,GAAG,MAAM,CAAC;QAEjG;;;WAGG;QACH,GAAG,EAAE,MAAM,CAAC;QAEZ;;WAEG;QACH,IAAI,EAAE,eAAe,GAAG,gBAAgB,GAAG,gBAAgB,CAAC;QAE5D;;;;;WAKG;QACH,EAAE,EAAE,WAAW,CAAC,0BAA0B,GAAG,WAAW,CAAC,4BAA4B,GAAG,MAAM,CAAC;QAE/F;;;WAGG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB;;;WAGG;QACH,YAAY,CAAC,EACT,aAAa,GACb,gBAAgB,GAChB,SAAS,GACT,WAAW,GACX,0BAA0B,GAC1B,YAAY,GACZ,kBAAkB,GAClB,qBAAqB,GACrB,WAAW,GACX,oBAAoB,GACpB,oBAAoB,GACpB,4BAA4B,GAC5B,2CAA2C,GAC3C,6BAA6B,GAC7B,2CAA2C,GAC3C,8BAA8B,GAC9B,6CAA6C,GAC7C,oBAAoB,GACpB,sBAAsB,GACtB,4BAA4B,GAC5B,uBAAuB,GACvB,mBAAmB,GACnB,mBAAmB,GACnB,wBAAwB,GACxB,yBAAyB,GACzB,sBAAsB,CAAC;QAE3B;;;;;WAKG;QACH,cAAc,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;SAAE,CAAC;QAE5C;;WAEG;QACH,QAAQ,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;SAAE,CAAC;QAEtC;;;WAGG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC;KACnB;CACF;AAED,MAAM,WAAW,oBAAqB,SAAQ,eAAe;IAC3D;;;;;;OAMG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,CAAC,OAAO,WAAW,WAAW,CAAC;IACnC,OAAO,EACL,KAAK,UAAU,IAAI,UAAU,EAC7B,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,oBAAoB,IAAI,oBAAoB,GAClD,CAAC;CACH"}

package/resources/print-mail/self-mailers.d.ts

@@ -1,8 +1,5 @@
 import { APIResource } from "../../core/resource.js";
-import * as BoxesAPI from "./boxes.js";
 import * as ContactsAPI from "./contacts.js";
-import * as PrintMailAPI from "./print-mail.js";
-import * as OrderProfilesSelfMailersAPI from "./order-profiles/self-mailers.js";
 import { APIPromise } from "../../core/api-promise.js";
 import { PagePromise, SkipLimit, type SkipLimitParams } from "../../core/pagination.js";
 import { RequestOptions } from "../../internal/request-options.js";
@@ -61,6 +58,21 @@ export declare class SelfMailers extends APIResource {
      * ```
      */
     delete(id: string, options?: RequestOptions): APIPromise<SelfMailer>;
+    /**
+     * Progresses a self-mailer'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 selfMailer =
+     *   await client.printMail.selfMailers.progress('id');
+     * ```
+     */
+    progress(id: string, options?: RequestOptions): APIPromise<SelfMailer>;
     /**
      * Retrieve a self-mailer preview URL.
      *
@@ -99,7 +111,7 @@ export interface SelfMailer {
      * The mailing class of this order. This determines the speed and cost of delivery.
      * See `OrderMailingClass` for more details.
      */
-    mailingClass: BoxesAPI.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 `self_mailer`.
      */
@@ -113,11 +125,11 @@ export interface SelfMailer {
     /**
      * Enum representing the supported self-mailer sizes.
      */
-    size: OrderProfilesSelfMailersAPI.SelfMailerSize;
+    size: '8.5x11_bifold' | '8.5x11_trifold' | '9.5x16_trifold';
     /**
      * See `OrderStatus` for more details on the status of this order.
      */
-    status: BoxesAPI.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.
@@ -131,7 +143,7 @@ export interface SelfMailer {
      * The cancellation details of this order. Populated if the order has been
      * cancelled.
      */
-    cancellation?: BoxesAPI.Cancellation;
+    cancellation?: SelfMailer.Cancellation;
     /**
      * An optional string describing this resource. Will be visible in the API and the
      * dashboard.
@@ -146,7 +158,7 @@ export interface SelfMailer {
      * US-printed and US-destined orders. This is the most detailed way to track
      * non-express/certified orders.
      */
-    imbStatus?: BoxesAPI.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.
@@ -184,6 +196,26 @@ export interface SelfMailer {
      */
     url?: string;
 }
+export declare namespace SelfMailer {
+    /**
+     * 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 SelfMailerRetrieveURLResponse {
     /**
      * A unique ID prefixed with self*mailer*
@@ -203,7 +235,7 @@ export declare namespace SelfMailerCreateParams {
          * The contact information of the sender. You can pass contact information inline
          * here just like you can for the `to`.
          */
-        from: PrintMailAPI.ContactCreateWithFirstName | PrintMailAPI.ContactCreateWithCompanyName | string;
+        from: ContactsAPI.ContactCreateWithFirstName | ContactsAPI.ContactCreateWithCompanyName | string;
         /**
          * The HTML content for the inside of the self-mailer. You can supply _either_ this
          * or `insideTemplate` but not both.
@@ -217,14 +249,14 @@ export declare namespace SelfMailerCreateParams {
         /**
          * Enum representing the supported self-mailer sizes.
          */
-        size: OrderProfilesSelfMailersAPI.SelfMailerSize;
+        size: '8.5x11_bifold' | '8.5x11_trifold' | '9.5x16_trifold';
         /**
          * 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.
@@ -234,7 +266,7 @@ export declare namespace SelfMailerCreateParams {
          * The mailing class of this order. If not provided, automatically set to
          * `first_class`.
          */
-        mailingClass?: BoxesAPI.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
@@ -273,7 +305,7 @@ export declare namespace SelfMailerCreateParams {
          * The contact information of the sender. You can pass contact information inline
          * here just like you can for the `to`.
          */
-        from: PrintMailAPI.ContactCreateWithFirstName | PrintMailAPI.ContactCreateWithCompanyName | string;
+        from: ContactsAPI.ContactCreateWithFirstName | ContactsAPI.ContactCreateWithCompanyName | string;
         /**
          * A URL pointing to a 2 page PDF file. The first page is the inside of the
          * self-mailer and the second page is the outside (where the address will be
@@ -283,14 +315,14 @@ export declare namespace SelfMailerCreateParams {
         /**
          * Enum representing the supported self-mailer sizes.
          */
-        size: OrderProfilesSelfMailersAPI.SelfMailerSize;
+        size: '8.5x11_bifold' | '8.5x11_trifold' | '9.5x16_trifold';
         /**
          * 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.
@@ -300,7 +332,7 @@ export declare namespace SelfMailerCreateParams {
          * The mailing class of this order. If not provided, automatically set to
          * `first_class`.
          */
-        mailingClass?: BoxesAPI.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
@@ -327,7 +359,7 @@ export declare namespace SelfMailerCreateParams {
          * The contact information of the sender. You can pass contact information inline
          * here just like you can for the `to`.
          */
-        from: PrintMailAPI.ContactCreateWithFirstName | PrintMailAPI.ContactCreateWithCompanyName | string;
+        from: ContactsAPI.ContactCreateWithFirstName | ContactsAPI.ContactCreateWithCompanyName | string;
         /**
          * A 2 page PDF file. The first page is the inside of the self-mailer and the
          * second page is the outside (where the address will be stamped on).
@@ -336,14 +368,14 @@ export declare namespace SelfMailerCreateParams {
         /**
          * Enum representing the supported self-mailer sizes.
          */
-        size: OrderProfilesSelfMailersAPI.SelfMailerSize;
+        size: '8.5x11_bifold' | '8.5x11_trifold' | '9.5x16_trifold';
         /**
          * 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.
@@ -353,7 +385,7 @@ export declare namespace SelfMailerCreateParams {
          * The mailing class of this order. If not provided, automatically set to
          * `first_class`.
          */
-        mailingClass?: BoxesAPI.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

package/resources/print-mail/self-mailers.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"self-mailers.d.ts","sourceRoot":"","sources":["../../src/resources/print-mail/self-mailers.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,QAAQ;OACb,KAAK,WAAW;OAChB,KAAK,YAAY;OACjB,KAAK,2BAA2B;OAChC,EAAE,UAAU,EAAE;OACd,EAAE,WAAW,EAAE,SAAS,EAAE,KAAK,eAAe,EAAE;OAChD,EAAE,cAAc,EAAE;AAGzB,qBAAa,WAAY,SAAQ,WAAW;IAC1C;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,MAAM,CAAC,IAAI,EAAE,sBAAsB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,UAAU,CAAC;IAItF;;;;;;;;OAQG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,UAAU,CAAC;IAItE;;;;;;;;;;OAUG;IACH,IAAI,CACF,KAAK,GAAE,oBAAoB,GAAG,IAAI,GAAG,SAAc,EACnD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,oBAAoB,EAAE,UAAU,CAAC;IAOhD;;;;;;;;OAQG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,UAAU,CAAC;IAIpE;;;;;;;;;;;;;OAaG;IACH,WAAW,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,6BAA6B,CAAC;CAG7F;AAED,MAAM,MAAM,oBAAoB,GAAG,SAAS,CAAC,UAAU,CAAC,CAAC;AAEzD,MAAM,WAAW,UAAU;IACzB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,IAAI,EAAE,WAAW,CAAC,OAAO,CAAC;IAE1B;;OAEG;IACH,IAAI,EAAE,OAAO,CAAC;IAEd;;;OAGG;IACH,YAAY,EAAE,QAAQ,CAAC,iBAAiB,CAAC;IAEzC;;OAEG;IACH,MAAM,EAAE,aAAa,CAAC;IAEtB;;;;OAIG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,IAAI,EAAE,2BAA2B,CAAC,cAAc,CAAC;IAEjD;;OAEG;IACH,MAAM,EAAE,QAAQ,CAAC,WAAW,CAAC;IAE7B;;;OAGG;IACH,EAAE,EAAE,WAAW,CAAC,OAAO,CAAC;IAExB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;;OAGG;IACH,YAAY,CAAC,EAAE,QAAQ,CAAC,YAAY,CAAC;IAErC;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;;;OAIG;IACH,SAAS,CAAC,EAAE,QAAQ,CAAC,cAAc,CAAC;IAEpC;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;;;OAKG;IACH,cAAc,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAE5C;;OAEG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAEtC;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;;;;;;;OASG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,6BAA6B;IAC5C;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX,MAAM,EAAE,MAAM,CAAC;IAEf;;;OAGG;IACH,GAAG,EAAE,MAAM,CAAC;CACb;AAED,MAAM,MAAM,sBAAsB,GAC9B,sBAAsB,CAAC,wBAAwB,GAC/C,sBAAsB,CAAC,4BAA4B,GACnD,sBAAsB,CAAC,0BAA0B,GACjD,sBAAsB,CAAC,2BAA2B,CAAC;AAEvD,MAAM,CAAC,OAAO,WAAW,sBAAsB,CAAC;IAC9C,UAAiB,wBAAwB;QACvC;;;WAGG;QACH,IAAI,EAAE,YAAY,CAAC,0BAA0B,GAAG,YAAY,CAAC,4BAA4B,GAAG,MAAM,CAAC;QAEnG;;;WAGG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;;WAGG;QACH,WAAW,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,IAAI,EAAE,2BAA2B,CAAC,cAAc,CAAC;QAEjD;;;;;WAKG;QACH,EAAE,EAAE,YAAY,CAAC,0BAA0B,GAAG,YAAY,CAAC,4BAA4B,GAAG,MAAM,CAAC;QAEjG;;;WAGG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB;;;WAGG;QACH,YAAY,CAAC,EAAE,QAAQ,CAAC,iBAAiB,CAAC;QAE1C;;;;;WAKG;QACH,cAAc,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;SAAE,CAAC;QAE5C;;WAEG;QACH,QAAQ,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;SAAE,CAAC;QAEtC;;;WAGG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC;KACnB;IAED,UAAiB,4BAA4B;QAC3C;;;WAGG;QACH,cAAc,EAAE,MAAM,CAAC;QAEvB;;;WAGG;QACH,eAAe,EAAE,MAAM,CAAC;KACzB;IAED,UAAiB,0BAA0B;QACzC;;;WAGG;QACH,IAAI,EAAE,YAAY,CAAC,0BAA0B,GAAG,YAAY,CAAC,4BAA4B,GAAG,MAAM,CAAC;QAEnG;;;;WAIG;QACH,GAAG,EAAE,MAAM,CAAC;QAEZ;;WAEG;QACH,IAAI,EAAE,2BAA2B,CAAC,cAAc,CAAC;QAEjD;;;;;WAKG;QACH,EAAE,EAAE,YAAY,CAAC,0BAA0B,GAAG,YAAY,CAAC,4BAA4B,GAAG,MAAM,CAAC;QAEjG;;;WAGG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB;;;WAGG;QACH,YAAY,CAAC,EAAE,QAAQ,CAAC,iBAAiB,CAAC;QAE1C;;;;;WAKG;QACH,cAAc,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;SAAE,CAAC;QAE5C;;WAEG;QACH,QAAQ,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;SAAE,CAAC;QAEtC;;;WAGG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC;KACnB;IAED,UAAiB,2BAA2B;QAC1C;;;WAGG;QACH,IAAI,EAAE,YAAY,CAAC,0BAA0B,GAAG,YAAY,CAAC,4BAA4B,GAAG,MAAM,CAAC;QAEnG;;;WAGG;QACH,GAAG,EAAE,MAAM,CAAC;QAEZ;;WAEG;QACH,IAAI,EAAE,2BAA2B,CAAC,cAAc,CAAC;QAEjD;;;;;WAKG;QACH,EAAE,EAAE,YAAY,CAAC,0BAA0B,GAAG,YAAY,CAAC,4BAA4B,GAAG,MAAM,CAAC;QAEjG;;;WAGG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB;;;WAGG;QACH,YAAY,CAAC,EAAE,QAAQ,CAAC,iBAAiB,CAAC;QAE1C;;;;;WAKG;QACH,cAAc,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;SAAE,CAAC;QAE5C;;WAEG;QACH,QAAQ,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;SAAE,CAAC;QAEtC;;;WAGG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC;KACnB;CACF;AAED,MAAM,WAAW,oBAAqB,SAAQ,eAAe;IAC3D;;;;;;OAMG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,CAAC,OAAO,WAAW,WAAW,CAAC;IACnC,OAAO,EACL,KAAK,UAAU,IAAI,UAAU,EAC7B,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,oBAAoB,IAAI,oBAAoB,GAClD,CAAC;CACH"}
+{"version":3,"file":"self-mailers.d.ts","sourceRoot":"","sources":["../../src/resources/print-mail/self-mailers.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,WAAW;OAChB,EAAE,UAAU,EAAE;OACd,EAAE,WAAW,EAAE,SAAS,EAAE,KAAK,eAAe,EAAE;OAChD,EAAE,cAAc,EAAE;AAGzB,qBAAa,WAAY,SAAQ,WAAW;IAC1C;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,MAAM,CAAC,IAAI,EAAE,sBAAsB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,UAAU,CAAC;IAItF;;;;;;;;OAQG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,UAAU,CAAC;IAItE;;;;;;;;;;OAUG;IACH,IAAI,CACF,KAAK,GAAE,oBAAoB,GAAG,IAAI,GAAG,SAAc,EACnD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,oBAAoB,EAAE,UAAU,CAAC;IAOhD;;;;;;;;OAQG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,UAAU,CAAC;IAIpE;;;;;;;;;;;;;OAaG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,UAAU,CAAC;IAItE;;;;;;;;;;;;;OAaG;IACH,WAAW,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,6BAA6B,CAAC;CAG7F;AAED,MAAM,MAAM,oBAAoB,GAAG,SAAS,CAAC,UAAU,CAAC,CAAC;AAEzD,MAAM,WAAW,UAAU;IACzB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,IAAI,EAAE,WAAW,CAAC,OAAO,CAAC;IAE1B;;OAEG;IACH,IAAI,EAAE,OAAO,CAAC;IAEd;;;OAGG;IACH,YAAY,EACR,aAAa,GACb,gBAAgB,GAChB,SAAS,GACT,WAAW,GACX,0BAA0B,GAC1B,YAAY,GACZ,kBAAkB,GAClB,qBAAqB,GACrB,WAAW,GACX,oBAAoB,GACpB,oBAAoB,GACpB,4BAA4B,GAC5B,2CAA2C,GAC3C,6BAA6B,GAC7B,2CAA2C,GAC3C,8BAA8B,GAC9B,6CAA6C,GAC7C,oBAAoB,GACpB,sBAAsB,GACtB,4BAA4B,GAC5B,uBAAuB,GACvB,mBAAmB,GACnB,mBAAmB,GACnB,wBAAwB,GACxB,yBAAyB,GACzB,sBAAsB,CAAC;IAE3B;;OAEG;IACH,MAAM,EAAE,aAAa,CAAC;IAEtB;;;;OAIG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,IAAI,EAAE,eAAe,GAAG,gBAAgB,GAAG,gBAAgB,CAAC;IAE5D;;OAEG;IACH,MAAM,EAAE,OAAO,GAAG,UAAU,GAAG,wBAAwB,GAAG,WAAW,GAAG,WAAW,CAAC;IAEpF;;;OAGG;IACH,EAAE,EAAE,WAAW,CAAC,OAAO,CAAC;IAExB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;;OAGG;IACH,YAAY,CAAC,EAAE,UAAU,CAAC,YAAY,CAAC;IAEvC;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;;;OAIG;IACH,SAAS,CAAC,EAAE,qBAAqB,GAAG,kBAAkB,GAAG,oBAAoB,CAAC;IAE9E;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;;;OAKG;IACH,cAAc,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAE5C;;OAEG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAEtC;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;;;;;;;OASG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AAED,yBAAiB,UAAU,CAAC;IAC1B;;;OAGG;IACH,UAAiB,YAAY;QAC3B;;WAEG;QACH,MAAM,EAAE,gBAAgB,GAAG,iBAAiB,GAAG,6BAA6B,CAAC;QAE7E;;WAEG;QACH,eAAe,CAAC,EAAE,MAAM,CAAC;QAEzB;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;KACf;CACF;AAED,MAAM,WAAW,6BAA6B;IAC5C;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX,MAAM,EAAE,MAAM,CAAC;IAEf;;;OAGG;IACH,GAAG,EAAE,MAAM,CAAC;CACb;AAED,MAAM,MAAM,sBAAsB,GAC9B,sBAAsB,CAAC,wBAAwB,GAC/C,sBAAsB,CAAC,4BAA4B,GACnD,sBAAsB,CAAC,0BAA0B,GACjD,sBAAsB,CAAC,2BAA2B,CAAC;AAEvD,MAAM,CAAC,OAAO,WAAW,sBAAsB,CAAC;IAC9C,UAAiB,wBAAwB;QACvC;;;WAGG;QACH,IAAI,EAAE,WAAW,CAAC,0BAA0B,GAAG,WAAW,CAAC,4BAA4B,GAAG,MAAM,CAAC;QAEjG;;;WAGG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;;WAGG;QACH,WAAW,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,IAAI,EAAE,eAAe,GAAG,gBAAgB,GAAG,gBAAgB,CAAC;QAE5D;;;;;WAKG;QACH,EAAE,EAAE,WAAW,CAAC,0BAA0B,GAAG,WAAW,CAAC,4BAA4B,GAAG,MAAM,CAAC;QAE/F;;;WAGG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB;;;WAGG;QACH,YAAY,CAAC,EACT,aAAa,GACb,gBAAgB,GAChB,SAAS,GACT,WAAW,GACX,0BAA0B,GAC1B,YAAY,GACZ,kBAAkB,GAClB,qBAAqB,GACrB,WAAW,GACX,oBAAoB,GACpB,oBAAoB,GACpB,4BAA4B,GAC5B,2CAA2C,GAC3C,6BAA6B,GAC7B,2CAA2C,GAC3C,8BAA8B,GAC9B,6CAA6C,GAC7C,oBAAoB,GACpB,sBAAsB,GACtB,4BAA4B,GAC5B,uBAAuB,GACvB,mBAAmB,GACnB,mBAAmB,GACnB,wBAAwB,GACxB,yBAAyB,GACzB,sBAAsB,CAAC;QAE3B;;;;;WAKG;QACH,cAAc,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;SAAE,CAAC;QAE5C;;WAEG;QACH,QAAQ,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;SAAE,CAAC;QAEtC;;;WAGG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC;KACnB;IAED,UAAiB,4BAA4B;QAC3C;;;WAGG;QACH,cAAc,EAAE,MAAM,CAAC;QAEvB;;;WAGG;QACH,eAAe,EAAE,MAAM,CAAC;KACzB;IAED,UAAiB,0BAA0B;QACzC;;;WAGG;QACH,IAAI,EAAE,WAAW,CAAC,0BAA0B,GAAG,WAAW,CAAC,4BAA4B,GAAG,MAAM,CAAC;QAEjG;;;;WAIG;QACH,GAAG,EAAE,MAAM,CAAC;QAEZ;;WAEG;QACH,IAAI,EAAE,eAAe,GAAG,gBAAgB,GAAG,gBAAgB,CAAC;QAE5D;;;;;WAKG;QACH,EAAE,EAAE,WAAW,CAAC,0BAA0B,GAAG,WAAW,CAAC,4BAA4B,GAAG,MAAM,CAAC;QAE/F;;;WAGG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB;;;WAGG;QACH,YAAY,CAAC,EACT,aAAa,GACb,gBAAgB,GAChB,SAAS,GACT,WAAW,GACX,0BAA0B,GAC1B,YAAY,GACZ,kBAAkB,GAClB,qBAAqB,GACrB,WAAW,GACX,oBAAoB,GACpB,oBAAoB,GACpB,4BAA4B,GAC5B,2CAA2C,GAC3C,6BAA6B,GAC7B,2CAA2C,GAC3C,8BAA8B,GAC9B,6CAA6C,GAC7C,oBAAoB,GACpB,sBAAsB,GACtB,4BAA4B,GAC5B,uBAAuB,GACvB,mBAAmB,GACnB,mBAAmB,GACnB,wBAAwB,GACxB,yBAAyB,GACzB,sBAAsB,CAAC;QAE3B;;;;;WAKG;QACH,cAAc,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;SAAE,CAAC;QAE5C;;WAEG;QACH,QAAQ,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;SAAE,CAAC;QAEtC;;;WAGG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC;KACnB;IAED,UAAiB,2BAA2B;QAC1C;;;WAGG;QACH,IAAI,EAAE,WAAW,CAAC,0BAA0B,GAAG,WAAW,CAAC,4BAA4B,GAAG,MAAM,CAAC;QAEjG;;;WAGG;QACH,GAAG,EAAE,MAAM,CAAC;QAEZ;;WAEG;QACH,IAAI,EAAE,eAAe,GAAG,gBAAgB,GAAG,gBAAgB,CAAC;QAE5D;;;;;WAKG;QACH,EAAE,EAAE,WAAW,CAAC,0BAA0B,GAAG,WAAW,CAAC,4BAA4B,GAAG,MAAM,CAAC;QAE/F;;;WAGG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB;;;WAGG;QACH,YAAY,CAAC,EACT,aAAa,GACb,gBAAgB,GAChB,SAAS,GACT,WAAW,GACX,0BAA0B,GAC1B,YAAY,GACZ,kBAAkB,GAClB,qBAAqB,GACrB,WAAW,GACX,oBAAoB,GACpB,oBAAoB,GACpB,4BAA4B,GAC5B,2CAA2C,GAC3C,6BAA6B,GAC7B,2CAA2C,GAC3C,8BAA8B,GAC9B,6CAA6C,GAC7C,oBAAoB,GACpB,sBAAsB,GACtB,4BAA4B,GAC5B,uBAAuB,GACvB,mBAAmB,GACnB,mBAAmB,GACnB,wBAAwB,GACxB,yBAAyB,GACzB,sBAAsB,CAAC;QAE3B;;;;;WAKG;QACH,cAAc,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;SAAE,CAAC;QAE5C;;WAEG;QACH,QAAQ,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;SAAE,CAAC;QAEtC;;;WAGG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC;KACnB;CACF;AAED,MAAM,WAAW,oBAAqB,SAAQ,eAAe;IAC3D;;;;;;OAMG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,CAAC,OAAO,WAAW,WAAW,CAAC;IACnC,OAAO,EACL,KAAK,UAAU,IAAI,UAAU,EAC7B,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,oBAAoB,IAAI,oBAAoB,GAClD,CAAC;CACH"}

package/resources/print-mail/self-mailers.js

@@ -71,6 +71,23 @@ class SelfMailers extends resource_1.APIResource {
     delete(id, options) {
         return this._client.delete((0, path_1.path) `/print-mail/v1/self_mailers/${id}`, options);
     }
+    /**
+     * Progresses a self-mailer'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 selfMailer =
+     *   await client.printMail.selfMailers.progress('id');
+     * ```
+     */
+    progress(id, options) {
+        return this._client.post((0, path_1.path) `/print-mail/v1/self_mailers/${id}/progressions`, options);
+    }
     /**
      * Retrieve a self-mailer preview URL.
      *

package/resources/print-mail/self-mailers.js.map

@@ -1 +1 @@
-{"version":3,"file":"self-mailers.js","sourceRoot":"","sources":["../../src/resources/print-mail/self-mailers.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAMlD,yDAAqF;AAErF,uDAAiD;AAEjD,MAAa,WAAY,SAAQ,sBAAW;IAC1C;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,MAAM,CAAC,IAA4B,EAAE,OAAwB;QAC3D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,6BAA6B,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChF,CAAC;IAED;;;;;;;;OAQG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,+BAA+B,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC5E,CAAC;IAED;;;;;;;;;;OAUG;IACH,IAAI,CACF,QAAiD,EAAE,EACnD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,6BAA6B,EAAE,CAAA,sBAAqB,CAAA,EAAE;YACnF,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;OAQG;IACH,MAAM,CAAC,EAAU,EAAE,OAAwB;QACzC,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,+BAA+B,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC/E,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,WAAW,CAAC,EAAU,EAAE,OAAwB;QAC9C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,+BAA+B,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;IAChF,CAAC;CACF;AA1FD,kCA0FC"}
+{"version":3,"file":"self-mailers.js","sourceRoot":"","sources":["../../src/resources/print-mail/self-mailers.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAGlD,yDAAqF;AAErF,uDAAiD;AAEjD,MAAa,WAAY,SAAQ,sBAAW;IAC1C;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,MAAM,CAAC,IAA4B,EAAE,OAAwB;QAC3D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,6BAA6B,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChF,CAAC;IAED;;;;;;;;OAQG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,+BAA+B,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC5E,CAAC;IAED;;;;;;;;;;OAUG;IACH,IAAI,CACF,QAAiD,EAAE,EACnD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,6BAA6B,EAAE,CAAA,sBAAqB,CAAA,EAAE;YACnF,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;OAQG;IACH,MAAM,CAAC,EAAU,EAAE,OAAwB;QACzC,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,+BAA+B,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC/E,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,+BAA+B,EAAE,eAAe,EAAE,OAAO,CAAC,CAAC;IAC1F,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,WAAW,CAAC,EAAU,EAAE,OAAwB;QAC9C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,+BAA+B,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;IAChF,CAAC;CACF;AA5GD,kCA4GC"}

package/resources/print-mail/self-mailers.mjs

@@ -68,6 +68,23 @@ export class SelfMailers extends APIResource {
     delete(id, options) {
         return this._client.delete(path `/print-mail/v1/self_mailers/${id}`, options);
     }
+    /**
+     * Progresses a self-mailer'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 selfMailer =
+     *   await client.printMail.selfMailers.progress('id');
+     * ```
+     */
+    progress(id, options) {
+        return this._client.post(path `/print-mail/v1/self_mailers/${id}/progressions`, options);
+    }
     /**
      * Retrieve a self-mailer preview URL.
      *

package/resources/print-mail/self-mailers.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"self-mailers.mjs","sourceRoot":"","sources":["../../src/resources/print-mail/self-mailers.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAMf,EAAe,SAAS,EAAwB;OAEhD,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,WAAY,SAAQ,WAAW;IAC1C;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,MAAM,CAAC,IAA4B,EAAE,OAAwB;QAC3D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,6BAA6B,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChF,CAAC;IAED;;;;;;;;OAQG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,+BAA+B,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC5E,CAAC;IAED;;;;;;;;;;OAUG;IACH,IAAI,CACF,QAAiD,EAAE,EACnD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,6BAA6B,EAAE,CAAA,SAAqB,CAAA,EAAE;YACnF,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;OAQG;IACH,MAAM,CAAC,EAAU,EAAE,OAAwB;QACzC,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,+BAA+B,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC/E,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,WAAW,CAAC,EAAU,EAAE,OAAwB;QAC9C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,+BAA+B,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;IAChF,CAAC;CACF"}
+{"version":3,"file":"self-mailers.mjs","sourceRoot":"","sources":["../../src/resources/print-mail/self-mailers.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAGf,EAAe,SAAS,EAAwB;OAEhD,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,WAAY,SAAQ,WAAW;IAC1C;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,MAAM,CAAC,IAA4B,EAAE,OAAwB;QAC3D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,6BAA6B,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChF,CAAC;IAED;;;;;;;;OAQG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,+BAA+B,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC5E,CAAC;IAED;;;;;;;;;;OAUG;IACH,IAAI,CACF,QAAiD,EAAE,EACnD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,6BAA6B,EAAE,CAAA,SAAqB,CAAA,EAAE;YACnF,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;OAQG;IACH,MAAM,CAAC,EAAU,EAAE,OAAwB;QACzC,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,+BAA+B,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC/E,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,+BAA+B,EAAE,eAAe,EAAE,OAAO,CAAC,CAAC;IAC1F,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,WAAW,CAAC,EAAU,EAAE,OAAwB;QAC9C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,+BAA+B,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;IAChF,CAAC;CACF"}