postgrid-node 0.4.2 → 0.6.1

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

@@ -1,10 +1,7 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import { APIResource } from '../../core/resource';
-import * as BoxesAPI from './boxes';
 import * as ContactsAPI from './contacts';
-import * as PrintMailAPI from './print-mail';
-import * as OrderProfilesSelfMailersAPI from './order-profiles/self-mailers';
 import { APIPromise } from '../../core/api-promise';
 import { PagePromise, SkipLimit, type SkipLimitParams } from '../../core/pagination';
 import { RequestOptions } from '../../internal/request-options';
@@ -83,6 +80,24 @@ export class SelfMailers extends APIResource {
     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: string, options?: RequestOptions): APIPromise<SelfMailer> {
+    return this._client.post(path`/print-mail/v1/self_mailers/${id}/progressions`, options);
+  }
+
   /**
    * Retrieve a self-mailer preview URL.
    *
@@ -129,7 +144,33 @@ 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`.
@@ -146,12 +187,12 @@ 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
@@ -168,7 +209,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
@@ -186,7 +227,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
@@ -226,6 +267,29 @@ export interface SelfMailer {
   url?: string;
 }
 
+export namespace SelfMailer {
+  /**
+   * The cancellation details of this order. Populated if the order has been
+   * cancelled.
+   */
+  export 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*
@@ -253,7 +317,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
@@ -270,7 +334,7 @@ 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
@@ -278,7 +342,7 @@ export declare namespace SelfMailerCreateParams {
      * 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
@@ -290,7 +354,33 @@ 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
@@ -331,7 +421,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
@@ -343,7 +433,7 @@ 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
@@ -351,7 +441,7 @@ export declare namespace SelfMailerCreateParams {
      * 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
@@ -363,7 +453,33 @@ 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
@@ -390,7 +506,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
@@ -401,7 +517,7 @@ 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
@@ -409,7 +525,7 @@ export declare namespace SelfMailerCreateParams {
      * 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
@@ -421,7 +537,33 @@ 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