postgrid-node 0.4.2 → 0.6.1

package/src/resources/print-mail/letters.ts

@@ -1,9 +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 { APIPromise } from '../../core/api-promise';
 import { PagePromise, SkipLimit, type SkipLimitParams } from '../../core/pagination';
 import { RequestOptions } from '../../internal/request-options';
@@ -75,6 +73,40 @@ export class Letters extends APIResource {
     return this._client.delete(path`/print-mail/v1/letters/${id}`, options);
   }
 
+  /**
+   * Cancel a letter by ID with a note. Note that this operation cannot be undone and
+   * that only letters with a status of `ready` can be cancelled.
+   *
+   * @example
+   * ```ts
+   * const letter = await client.printMail.letters.cancel('id', {
+   *   note: 'Cancelling this letter',
+   * });
+   * ```
+   */
+  cancel(id: string, body: LetterCancelParams, options?: RequestOptions): APIPromise<Letter> {
+    return this._client.post(path`/print-mail/v1/letters/${id}/cancellation`, { body, ...options });
+  }
+
+  /**
+   * Progresses a letter'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 letter = await client.printMail.letters.progress(
+   *   'id',
+   * );
+   * ```
+   */
+  progress(id: string, options?: RequestOptions): APIPromise<Letter> {
+    return this._client.post(path`/print-mail/v1/letters/${id}/progressions`, options);
+  }
+
   /**
    * Retrieve a letter preview URL.
    *
@@ -162,7 +194,33 @@ export interface Letter {
    * 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 `letter`.
@@ -184,7 +242,7 @@ export interface Letter {
   /**
    * 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
@@ -206,7 +264,7 @@ export interface Letter {
    * The cancellation details of this order. Populated if the order has been
    * cancelled.
    */
-  cancellation?: BoxesAPI.Cancellation;
+  cancellation?: Letter.Cancellation;
 
   /**
    * An optional string describing this resource. Will be visible in the API and the
@@ -230,7 +288,7 @@ export interface Letter {
    * 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
@@ -303,6 +361,29 @@ export interface Letter {
   url?: string;
 }
 
+export namespace Letter {
+  /**
+   * 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;
+  }
+}
+
 /**
  * Enum representing the supported letter sizes.
  */
@@ -409,7 +490,7 @@ export declare namespace LetterCreateParams {
      * 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 letter. You can supply _either_ this or `template` but
@@ -423,7 +504,7 @@ export declare namespace LetterCreateParams {
      * 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;
 
     /**
      * Enum representing the placement of the address on the letter.
@@ -461,7 +542,33 @@ export declare namespace LetterCreateParams {
      * 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
@@ -517,7 +624,7 @@ export declare namespace LetterCreateParams {
      * 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 PDF file for the letter or the PDF file itself.
@@ -530,7 +637,7 @@ export declare namespace LetterCreateParams {
      * 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;
 
     /**
      * Enum representing the placement of the address on the letter.
@@ -568,7 +675,33 @@ export declare namespace LetterCreateParams {
      * 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
@@ -623,6 +756,10 @@ export interface LetterListParams extends SkipLimitParams {
   search?: string;
 }
 
+export interface LetterCancelParams {
+  note: string;
+}
+
 export declare namespace Letters {
   export {
     type AddressPlacement as AddressPlacement,
@@ -634,5 +771,6 @@ export declare namespace Letters {
     type LettersSkipLimit as LettersSkipLimit,
     type LetterCreateParams as LetterCreateParams,
     type LetterListParams as LetterListParams,
+    type LetterCancelParams as LetterCancelParams,
   };
 }

package/src/resources/print-mail/mailing-list-imports.ts

@@ -8,6 +8,10 @@ import { buildHeaders } from '../../internal/headers';
 import { RequestOptions } from '../../internal/request-options';
 import { path } from '../../internal/utils/path';
 
+/**
+ *  The mailing list imports API enables you to import contact lists from files
+ *  and validate them for use in campaigns.
+ */
 export class MailingListImports extends APIResource {
   /**
    * Create a new mailing list import.
@@ -379,7 +383,7 @@ export interface MailingListImportCreateParams {
   senderMergeVariableMapping?: { [key: string]: string };
 
   /**
-   * Header param:
+   * Header param
    */
   'idempotency-key'?: string;
 }

package/src/resources/print-mail/mailing-lists.ts

@@ -7,6 +7,10 @@ import { buildHeaders } from '../../internal/headers';
 import { RequestOptions } from '../../internal/request-options';
 import { path } from '../../internal/utils/path';
 
+/**
+ *  The mailing lists API enables you to manage collections of contacts
+ *  that can be used for bulk mail campaigns.
+ */
 export class MailingLists extends APIResource {
   /**
    * Create a new mailing list.
@@ -236,7 +240,7 @@ export interface MailingListCreateParams {
   metadata?: { [key: string]: unknown };
 
   /**
-   * Header param:
+   * Header param
    */
   'idempotency-key'?: string;
 }

package/src/resources/print-mail/postcards.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 OrderProfilesPostcardsAPI from './order-profiles/postcards';
 import { APIPromise } from '../../core/api-promise';
 import { PagePromise, SkipLimit, type SkipLimitParams } from '../../core/pagination';
 import { RequestOptions } from '../../internal/request-options';
@@ -81,6 +78,41 @@ export class Postcards extends APIResource {
     return this._client.delete(path`/print-mail/v1/postcards/${id}`, options);
   }
 
+  /**
+   * Cancel a postcard by ID with a note. Note that this operation cannot be undone
+   * and that only postcards with a status of `ready` can be cancelled.
+   *
+   * @example
+   * ```ts
+   * const postcard = await client.printMail.postcards.cancel(
+   *   'id',
+   *   { note: 'Cancelling this postcard' },
+   * );
+   * ```
+   */
+  cancel(id: string, body: PostcardCancelParams, options?: RequestOptions): APIPromise<Postcard> {
+    return this._client.post(path`/print-mail/v1/postcards/${id}/cancellation`, { body, ...options });
+  }
+
+  /**
+   * Progresses a postcard'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 postcard = await client.printMail.postcards.progress(
+   *   'id',
+   * );
+   * ```
+   */
+  progress(id: string, options?: RequestOptions): APIPromise<Postcard> {
+    return this._client.post(path`/print-mail/v1/postcards/${id}/progressions`, options);
+  }
+
   /**
    * Retrieve a postcard preview URL.
    *
@@ -122,7 +154,33 @@ export interface Postcard {
    * 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 `postcard`.
@@ -139,12 +197,12 @@ export interface Postcard {
   /**
    * Enum representing the supported postcard sizes.
    */
-  size: OrderProfilesPostcardsAPI.PostcardSize;
+  size: '6x4' | '9x6' | '11x6';
 
   /**
    * 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
@@ -161,7 +219,7 @@ export interface Postcard {
    * The cancellation details of this order. Populated if the order has been
    * cancelled.
    */
-  cancellation?: BoxesAPI.Cancellation;
+  cancellation?: Postcard.Cancellation;
 
   /**
    * An optional string describing this resource. Will be visible in the API and the
@@ -184,7 +242,7 @@ export interface Postcard {
    * 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
@@ -205,6 +263,12 @@ export interface Postcard {
    */
   metadata?: { [key: string]: unknown };
 
+  /**
+   * Premium paper identifier. Use "standard" for regular stock or a premium*paper*\*
+   * ID.
+   */
+  paper?: string;
+
   /**
    * The tracking number of this order. Populated after an express/certified order
    * has been processed for delivery.
@@ -224,6 +288,29 @@ export interface Postcard {
   url?: string;
 }
 
+export namespace Postcard {
+  /**
+   * 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 PostcardRetrieveURLResponse {
   /**
    * A unique ID prefixed with postcard\_
@@ -262,7 +349,7 @@ export declare namespace PostcardCreateParams {
     /**
      * Enum representing the supported postcard sizes.
      */
-    size: OrderProfilesPostcardsAPI.PostcardSize;
+    size: '6x4' | '9x6' | '11x6';
 
     /**
      * The recipient of this order. You can either supply the contact information
@@ -270,7 +357,7 @@ export declare namespace PostcardCreateParams {
      * 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
@@ -283,13 +370,39 @@ export declare namespace PostcardCreateParams {
      * here just like you can for the `to`. Unlike other order types, the sender
      * address is optional for postcards.
      */
-    from?: PrintMailAPI.ContactCreateWithFirstName | PrintMailAPI.ContactCreateWithCompanyName | string;
+    from?: ContactsAPI.ContactCreateWithFirstName | ContactsAPI.ContactCreateWithCompanyName | string;
 
     /**
      * 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
@@ -304,6 +417,12 @@ export declare namespace PostcardCreateParams {
      */
     metadata?: { [key: string]: unknown };
 
+    /**
+     * Premium paper identifier. Use "standard" for regular stock or a premium*paper*\*
+     * ID.
+     */
+    paper?: string;
+
     /**
      * This order will transition from `ready` to `printing` on the day after this
      * date. You can use this parameter to schedule orders for a future date.
@@ -335,7 +454,7 @@ export declare namespace PostcardCreateParams {
     /**
      * Enum representing the supported postcard sizes.
      */
-    size: OrderProfilesPostcardsAPI.PostcardSize;
+    size: '6x4' | '9x6' | '11x6';
 
     /**
      * The recipient of this order. You can either supply the contact information
@@ -343,7 +462,7 @@ export declare namespace PostcardCreateParams {
      * 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
@@ -356,13 +475,39 @@ export declare namespace PostcardCreateParams {
      * here just like you can for the `to`. Unlike other order types, the sender
      * address is optional for postcards.
      */
-    from?: PrintMailAPI.ContactCreateWithFirstName | PrintMailAPI.ContactCreateWithCompanyName | string;
+    from?: ContactsAPI.ContactCreateWithFirstName | ContactsAPI.ContactCreateWithCompanyName | string;
 
     /**
      * 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
@@ -377,6 +522,12 @@ export declare namespace PostcardCreateParams {
      */
     metadata?: { [key: string]: unknown };
 
+    /**
+     * Premium paper identifier. Use "standard" for regular stock or a premium*paper*\*
+     * ID.
+     */
+    paper?: string;
+
     /**
      * This order will transition from `ready` to `printing` on the day after this
      * date. You can use this parameter to schedule orders for a future date.
@@ -394,7 +545,7 @@ export declare namespace PostcardCreateParams {
     /**
      * Enum representing the supported postcard sizes.
      */
-    size: OrderProfilesPostcardsAPI.PostcardSize;
+    size: '6x4' | '9x6' | '11x6';
 
     /**
      * The recipient of this order. You can either supply the contact information
@@ -402,7 +553,7 @@ export declare namespace PostcardCreateParams {
      * 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
@@ -415,13 +566,39 @@ export declare namespace PostcardCreateParams {
      * here just like you can for the `to`. Unlike other order types, the sender
      * address is optional for postcards.
      */
-    from?: PrintMailAPI.ContactCreateWithFirstName | PrintMailAPI.ContactCreateWithCompanyName | string;
+    from?: ContactsAPI.ContactCreateWithFirstName | ContactsAPI.ContactCreateWithCompanyName | string;
 
     /**
      * 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
@@ -436,6 +613,12 @@ export declare namespace PostcardCreateParams {
      */
     metadata?: { [key: string]: unknown };
 
+    /**
+     * Premium paper identifier. Use "standard" for regular stock or a premium*paper*\*
+     * ID.
+     */
+    paper?: string;
+
     /**
      * This order will transition from `ready` to `printing` on the day after this
      * date. You can use this parameter to schedule orders for a future date.
@@ -455,6 +638,10 @@ export interface PostcardListParams extends SkipLimitParams {
   search?: string;
 }
 
+export interface PostcardCancelParams {
+  note: string;
+}
+
 export declare namespace Postcards {
   export {
     type Postcard as Postcard,
@@ -462,5 +649,6 @@ export declare namespace Postcards {
     type PostcardsSkipLimit as PostcardsSkipLimit,
     type PostcardCreateParams as PostcardCreateParams,
     type PostcardListParams as PostcardListParams,
+    type PostcardCancelParams as PostcardCancelParams,
   };
 }