postgrid-node 0.4.2 → 0.6.1

package/src/resources/print-mail/cheques.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';
@@ -96,6 +94,40 @@ export class Cheques extends APIResource {
     return this._client.delete(path`/print-mail/v1/cheques/${id}`, options);
   }
 
+  /**
+   * Cancel a cheque by ID with a note. Note that this operation cannot be undone and
+   * that only cheques with a status of `ready` can be cancelled.
+   *
+   * @example
+   * ```ts
+   * const cheque = await client.printMail.cheques.cancel('id', {
+   *   note: 'Cancelling this cheque',
+   * });
+   * ```
+   */
+  cancel(id: string, body: ChequeCancelParams, options?: RequestOptions): APIPromise<Cheque> {
+    return this._client.post(path`/print-mail/v1/cheques/${id}/cancellation`, { body, ...options });
+  }
+
+  /**
+   * Progresses a cheque'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 cheque = await client.printMail.cheques.progress(
+   *   'id',
+   * );
+   * ```
+   */
+  progress(id: string, options?: RequestOptions): APIPromise<Cheque> {
+    return this._client.post(path`/print-mail/v1/cheques/${id}/progressions`, options);
+  }
+
   /**
    * Retrieve a cheque preview URL.
    *
@@ -178,7 +210,33 @@ export interface Cheque {
    * 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 `cheque`.
@@ -200,7 +258,7 @@ export interface Cheque {
   /**
    * 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
@@ -217,7 +275,7 @@ export interface Cheque {
    * The cancellation details of this order. Populated if the order has been
    * cancelled.
    */
-  cancellation?: BoxesAPI.Cancellation;
+  cancellation?: Cheque.Cancellation;
 
   /**
    * A link to the deposit-ready PDF for a digital-only cheque, returned if requested
@@ -253,7 +311,7 @@ export interface Cheque {
    * 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
@@ -317,6 +375,29 @@ export interface Cheque {
   url?: string;
 }
 
+export namespace Cheque {
+  /**
+   * 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 cheque sizes.
  */
@@ -359,7 +440,7 @@ export interface ChequeCreateParams {
    * 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 recipient of this order. You can either supply the contact information
@@ -367,7 +448,7 @@ export interface ChequeCreateParams {
    * 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;
 
   /**
    * The currency code of the cheque. This will be set to the default currency of the
@@ -406,7 +487,33 @@ export interface ChequeCreateParams {
    * 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';
 
   /**
    * The memo of the cheque.
@@ -445,7 +552,7 @@ export interface ChequeCreateParams {
    * mail it forward to the final recipient yourself. One use case for this is
    * signing cheques at your office before mailing them out yourself.
    */
-  redirectTo?: PrintMailAPI.ContactCreateWithFirstName | PrintMailAPI.ContactCreateWithCompanyName | string;
+  redirectTo?: ContactsAPI.ContactCreateWithFirstName | ContactsAPI.ContactCreateWithCompanyName | string;
 
   /**
    * This order will transition from `ready` to `printing` on the day after this
@@ -470,6 +577,10 @@ export interface ChequeListParams extends SkipLimitParams {
   search?: string;
 }
 
+export interface ChequeCancelParams {
+  note: string;
+}
+
 export declare namespace Cheques {
   export {
     type Cheque as Cheque,
@@ -479,5 +590,6 @@ export declare namespace Cheques {
     type ChequesSkipLimit as ChequesSkipLimit,
     type ChequeCreateParams as ChequeCreateParams,
     type ChequeListParams as ChequeListParams,
+    type ChequeCancelParams as ChequeCancelParams,
   };
 }

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

@@ -1,7 +1,6 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import { APIResource } from '../../core/resource';
-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';
@@ -208,9 +207,171 @@ export interface Contact {
   skipVerification?: boolean;
 }
 
-export type ContactCreate =
-  | PrintMailAPI.ContactCreateWithFirstName
-  | PrintMailAPI.ContactCreateWithCompanyName;
+export type ContactCreate = ContactCreateWithFirstName | ContactCreateWithCompanyName;
+
+export interface ContactCreateWithCompanyName {
+  /**
+   * The first line of the contact's address.
+   */
+  addressLine1: string;
+
+  companyName: string;
+
+  /**
+   * The ISO 3611-1 country code of the contact's address.
+   */
+  countryCode: string;
+
+  /**
+   * Second line of the contact's address, if applicable.
+   */
+  addressLine2?: string;
+
+  /**
+   * The city of the contact's address.
+   */
+  city?: string;
+
+  /**
+   * An optional string describing this resource. Will be visible in the API and the
+   * dashboard.
+   */
+  description?: string;
+
+  /**
+   * Email of the contact.
+   */
+  email?: string;
+
+  /**
+   * First name of the contact.
+   */
+  firstName?: string;
+
+  /**
+   * If `true`, PostGrid will force this contact to have an `addressStatus` of
+   * `verified` even if our address verification system says otherwise.
+   */
+  forceVerifiedStatus?: boolean;
+
+  /**
+   * Job title of the contact.
+   */
+  jobTitle?: string;
+
+  /**
+   * Last name of the contact.
+   */
+  lastName?: string;
+
+  /**
+   * See the section on Metadata.
+   */
+  metadata?: { [key: string]: unknown };
+
+  /**
+   * Phone number of the contact.
+   */
+  phoneNumber?: string;
+
+  /**
+   * The postal or ZIP code of the contact's address.
+   */
+  postalOrZip?: string;
+
+  /**
+   * Province or state of the contact's address.
+   */
+  provinceOrState?: string;
+
+  /**
+   * If `true`, PostGrid will skip running this contact's address through our address
+   * verification system.
+   */
+  skipVerification?: boolean;
+}
+
+export interface ContactCreateWithFirstName {
+  /**
+   * The first line of the contact's address.
+   */
+  addressLine1: string;
+
+  /**
+   * The ISO 3611-1 country code of the contact's address.
+   */
+  countryCode: string;
+
+  firstName: string;
+
+  /**
+   * Second line of the contact's address, if applicable.
+   */
+  addressLine2?: string;
+
+  /**
+   * The city of the contact's address.
+   */
+  city?: string;
+
+  /**
+   * Company name of the contact.
+   */
+  companyName?: string;
+
+  /**
+   * An optional string describing this resource. Will be visible in the API and the
+   * dashboard.
+   */
+  description?: string;
+
+  /**
+   * Email of the contact.
+   */
+  email?: string;
+
+  /**
+   * If `true`, PostGrid will force this contact to have an `addressStatus` of
+   * `verified` even if our address verification system says otherwise.
+   */
+  forceVerifiedStatus?: boolean;
+
+  /**
+   * Job title of the contact.
+   */
+  jobTitle?: string;
+
+  /**
+   * Last name of the contact.
+   */
+  lastName?: string;
+
+  /**
+   * See the section on Metadata.
+   */
+  metadata?: { [key: string]: unknown };
+
+  /**
+   * Phone number of the contact.
+   */
+  phoneNumber?: string;
+
+  /**
+   * The postal or ZIP code of the contact's address.
+   */
+  postalOrZip?: string;
+
+  /**
+   * Province or state of the contact's address.
+   */
+  provinceOrState?: string;
+
+  /**
+   * If `true`, PostGrid will skip running this contact's address through our address
+   * verification system.
+   */
+  skipVerification?: boolean;
+}
 
 export interface ContactDeleteResponse {
   /**
@@ -411,6 +572,8 @@ export declare namespace Contacts {
   export {
     type Contact as Contact,
     type ContactCreate as ContactCreate,
+    type ContactCreateWithCompanyName as ContactCreateWithCompanyName,
+    type ContactCreateWithFirstName as ContactCreateWithFirstName,
     type ContactDeleteResponse as ContactDeleteResponse,
     type ContactsSkipLimit as ContactsSkipLimit,
     type ContactCreateParams as ContactCreateParams,

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

@@ -11,15 +11,14 @@ export {
 } from './bank-accounts';
 export {
   Boxes,
-  type Box,
-  type BoxChequeBase,
-  type Cancellation,
-  type OrderImbStatus,
-  type OrderMailingClass,
-  type OrderStatus,
+  type BoxCreateResponse,
+  type BoxRetrieveResponse,
+  type BoxListResponse,
+  type BoxDeleteResponse,
+  type BoxProgressionsResponse,
   type BoxCreateParams,
   type BoxListParams,
-  type BoxesSkipLimit,
+  type BoxListResponsesSkipLimit,
 } from './boxes';
 export {
   Campaigns,
@@ -39,12 +38,15 @@ export {
   type ChequeRetrieveURLResponse,
   type ChequeCreateParams,
   type ChequeListParams,
+  type ChequeCancelParams,
   type ChequesSkipLimit,
 } from './cheques';
 export {
   Contacts,
   type Contact,
   type ContactCreate,
+  type ContactCreateWithCompanyName,
+  type ContactCreateWithFirstName,
   type ContactDeleteResponse,
   type ContactCreateParams,
   type ContactListParams,
@@ -60,6 +62,7 @@ export {
   type LetterRetrieveURLResponse,
   type LetterCreateParams,
   type LetterListParams,
+  type LetterCancelParams,
   type LettersSkipLimit,
 } from './letters';
 export {
@@ -84,16 +87,16 @@ export {
   type MailingListJobsParams,
   type MailingListsSkipLimit,
 } from './mailing-lists';
-export { OrderProfiles } from './order-profiles/index';
 export {
   Postcards,
   type Postcard,
   type PostcardRetrieveURLResponse,
   type PostcardCreateParams,
   type PostcardListParams,
+  type PostcardCancelParams,
   type PostcardsSkipLimit,
 } from './postcards';
-export { PrintMail, type ContactCreateWithCompanyName, type ContactCreateWithFirstName } from './print-mail';
+export { PrintMail } from './print-mail';
 export {
   Reports,
   type DeletedResponse,
@@ -112,17 +115,52 @@ export {
   type SelfMailerListParams,
   type SelfMailersSkipLimit,
 } from './self-mailers';
+export {
+  SnapPacks,
+  type SnapPackCreateResponse,
+  type SnapPackRetrieveResponse,
+  type SnapPackListResponse,
+  type SnapPackDeleteResponse,
+  type SnapPackProgressionsResponse,
+  type SnapPackRetrieveCapabilitiesResponse,
+  type SnapPackCreateParams,
+  type SnapPackListParams,
+  type SnapPackRetrieveCapabilitiesParams,
+  type SnapPackListResponsesSkipLimit,
+} from './snap-packs';
 export {
   SubOrganizations,
   type EmailPreferences,
   type SubOrganization,
-  type SubOrganizationUpdateResponse,
+  type SubOrganizationCreateResponse,
   type SubOrganizationRetrieveUsersResponse,
-  type SubOrganizationUpdateParams,
+  type SubOrganizationCreateParams,
   type SubOrganizationListParams,
   type SubOrganizationRetrieveUsersParams,
   type SubOrganizationsSkipLimit,
 } from './sub-organizations';
+export {
+  TargetedListBuilds,
+  type TargetedListBuildCreateResponse,
+  type TargetedListBuildRetrieveResponse,
+  type TargetedListBuildUpdateResponse,
+  type TargetedListBuildListResponse,
+  type TargetedListBuildDeleteResponse,
+  type TargetedListBuildConfirmResponse,
+  type TargetedListBuildCreateParams,
+  type TargetedListBuildUpdateParams,
+  type TargetedListBuildListParams,
+  type TargetedListBuildListResponsesSkipLimit,
+} from './targeted-list-builds/index';
+export {
+  TemplateEditorSessions,
+  type TemplateEditorSessionCreateResponse,
+  type TemplateEditorSessionListResponse,
+  type TemplateEditorSessionDeleteResponse,
+  type TemplateEditorSessionCreateParams,
+  type TemplateEditorSessionListParams,
+  type TemplateEditorSessionListResponsesSkipLimit,
+} from './template-editor-sessions';
 export {
   Templates,
   type Template,
@@ -132,3 +170,28 @@ export {
   type TemplateListParams,
   type TemplatesSkipLimit,
 } from './templates';
+export {
+  Trackers,
+  type TrackerCreateResponse,
+  type TrackerRetrieveResponse,
+  type TrackerUpdateResponse,
+  type TrackerListResponse,
+  type TrackerDeleteResponse,
+  type TrackerRetrieveVisitsResponse,
+  type TrackerCreateParams,
+  type TrackerUpdateParams,
+  type TrackerListParams,
+  type TrackerRetrieveVisitsParams,
+  type TrackerListResponsesSkipLimit,
+  type TrackerRetrieveVisitsResponsesSkipLimit,
+} from './trackers';
+export {
+  VirtualMailboxes,
+  type VirtualMailboxCreateResponse,
+  type VirtualMailboxRetrieveResponse,
+  type VirtualMailboxListResponse,
+  type VirtualMailboxRetrieveAddressResponse,
+  type VirtualMailboxCreateParams,
+  type VirtualMailboxListParams,
+  type VirtualMailboxListResponsesSkipLimit,
+} from './virtual-mailboxes/index';