postgrid-node 0.3.0 → 0.4.1

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

@@ -3,7 +3,9 @@
 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';
 import { path } from '../../internal/utils/path';
 
@@ -48,14 +50,17 @@ export class Letters extends APIResource {
    *
    * @example
    * ```ts
-   * const letters = await client.printMail.letters.list();
+   * // Automatically fetches more pages as needed.
+   * for await (const letter of client.printMail.letters.list()) {
+   *   // ...
+   * }
    * ```
    */
   list(
     query: LetterListParams | null | undefined = {},
     options?: RequestOptions,
-  ): APIPromise<LetterListResponse> {
-    return this._client.get('/print-mail/v1/letters', { query, ...options });
+  ): PagePromise<LettersSkipLimit, Letter> {
+    return this._client.getAPIList('/print-mail/v1/letters', SkipLimit<Letter>, { query, ...options });
   }
 
   /**
@@ -90,6 +95,8 @@ export class Letters extends APIResource {
   }
 }
 
+export type LettersSkipLimit = SkipLimit<Letter>;
+
 /**
  * Enum representing the placement of the address on the letter.
  */
@@ -376,18 +383,6 @@ export namespace PlasticCard {
   }
 }
 
-export interface LetterListResponse {
-  data: Array<Letter>;
-
-  limit: number;
-
-  object: 'list';
-
-  skip: number;
-
-  totalCount: number;
-}
-
 export interface LetterRetrieveURLResponse {
   /**
    * A unique ID prefixed with letter\_
@@ -414,10 +409,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:
-      | LetterCreateWithHTML.ContactCreateWithFirstName
-      | LetterCreateWithHTML.ContactCreateWithCompanyName
-      | string;
+    from: PrintMailAPI.ContactCreateWithFirstName | PrintMailAPI.ContactCreateWithCompanyName | string;
 
     /**
      * The HTML content for the letter. You can supply _either_ this or `template` but
@@ -431,10 +423,7 @@ export declare namespace LetterCreateParams {
      * contacts regardless of whether you provide the information inline here or call
      * the contact creation endpoint.
      */
-    to:
-      | LetterCreateWithHTML.ContactCreateWithFirstName
-      | LetterCreateWithHTML.ContactCreateWithCompanyName
-      | string;
+    to: PrintMailAPI.ContactCreateWithFirstName | PrintMailAPI.ContactCreateWithCompanyName | string;
 
     /**
      * Enum representing the placement of the address on the letter.
@@ -515,336 +504,6 @@ export declare namespace LetterCreateParams {
     size?: LetterSize;
   }
 
-  export namespace LetterCreateWithHTML {
-    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 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 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 LetterCreateWithTemplate {
     /**
      * The template ID for the letter. You can supply _either_ this or `html` but not
@@ -858,10 +517,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:
-      | LetterCreateWithPdf.ContactCreateWithFirstName
-      | LetterCreateWithPdf.ContactCreateWithCompanyName
-      | string;
+    from: PrintMailAPI.ContactCreateWithFirstName | PrintMailAPI.ContactCreateWithCompanyName | string;
 
     /**
      * A URL pointing to a PDF file for the letter or the PDF file itself.
@@ -874,10 +530,7 @@ export declare namespace LetterCreateParams {
      * contacts regardless of whether you provide the information inline here or call
      * the contact creation endpoint.
      */
-    to:
-      | LetterCreateWithPdf.ContactCreateWithFirstName
-      | LetterCreateWithPdf.ContactCreateWithCompanyName
-      | string;
+    to: PrintMailAPI.ContactCreateWithFirstName | PrintMailAPI.ContactCreateWithCompanyName | string;
 
     /**
      * Enum representing the placement of the address on the letter.
@@ -957,341 +610,9 @@ export declare namespace LetterCreateParams {
      */
     size?: LetterSize;
   }
-
-  export namespace LetterCreateWithPdf {
-    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 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 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 LetterListParams {
-  limit?: number;
-
+export interface LetterListParams extends SkipLimitParams {
   /**
    * You can supply any string to help narrow down the list of resources. For
    * example, if you pass `"New York"` (quoted), it will return resources that have
@@ -1300,8 +621,6 @@ export interface LetterListParams {
    * more details.
    */
   search?: string;
-
-  skip?: number;
 }
 
 export declare namespace Letters {
@@ -1311,8 +630,8 @@ export declare namespace Letters {
     type Letter as Letter,
     type LetterSize as LetterSize,
     type PlasticCard as PlasticCard,
-    type LetterListResponse as LetterListResponse,
     type LetterRetrieveURLResponse as LetterRetrieveURLResponse,
+    type LettersSkipLimit as LettersSkipLimit,
     type LetterCreateParams as LetterCreateParams,
     type LetterListParams as LetterListParams,
   };