postgrid-node 0.5.0 → 0.6.1

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

@@ -2,7 +2,6 @@
 
 import { APIResource } from '../../core/resource';
 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';
@@ -95,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.
    *
@@ -407,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
@@ -415,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
@@ -519,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
@@ -544,6 +577,10 @@ export interface ChequeListParams extends SkipLimitParams {
   search?: string;
 }
 
+export interface ChequeCancelParams {
+  note: string;
+}
+
 export declare namespace Cheques {
   export {
     type Cheque as Cheque,
@@ -553,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

@@ -9,6 +9,17 @@ export {
   type BankAccountListParams,
   type BankAccountsSkipLimit,
 } from './bank-accounts';
+export {
+  Boxes,
+  type BoxCreateResponse,
+  type BoxRetrieveResponse,
+  type BoxListResponse,
+  type BoxDeleteResponse,
+  type BoxProgressionsResponse,
+  type BoxCreateParams,
+  type BoxListParams,
+  type BoxListResponsesSkipLimit,
+} from './boxes';
 export {
   Campaigns,
   type Campaign,
@@ -27,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,
@@ -48,6 +62,7 @@ export {
   type LetterRetrieveURLResponse,
   type LetterCreateParams,
   type LetterListParams,
+  type LetterCancelParams,
   type LettersSkipLimit,
 } from './letters';
 export {
@@ -72,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,
@@ -100,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,
@@ -120,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';

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

@@ -2,7 +2,6 @@
 
 import { APIResource } from '../../core/resource';
 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';
@@ -74,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.
    *
@@ -457,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
@@ -471,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.
@@ -591,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.
@@ -604,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.
@@ -723,6 +756,10 @@ export interface LetterListParams extends SkipLimitParams {
   search?: string;
 }
 
+export interface LetterCancelParams {
+  note: string;
+}
+
 export declare namespace Letters {
   export {
     type AddressPlacement as AddressPlacement,
@@ -734,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;
 }