postgrid-node 0.2.0 → 0.4.0

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

@@ -3,6 +3,7 @@
 import { APIResource } from '../../core/resource';
 import * as MailingListImportsAPI from './mailing-list-imports';
 import { APIPromise } from '../../core/api-promise';
+import { PagePromise, SkipLimit, type SkipLimitParams } from '../../core/pagination';
 import { buildHeaders } from '../../internal/headers';
 import { RequestOptions } from '../../internal/request-options';
 import { path } from '../../internal/utils/path';
@@ -90,15 +91,21 @@ export class MailingListImports extends APIResource {
    *
    * @example
    * ```ts
-   * const mailingListImports =
-   *   await client.printMail.mailingListImports.list();
+   * // Automatically fetches more pages as needed.
+   * for await (const mailingListImportResponse of client.printMail.mailingListImports.list()) {
+   *   // ...
+   * }
    * ```
    */
   list(
     query: MailingListImportListParams | null | undefined = {},
     options?: RequestOptions,
-  ): APIPromise<MailingListImportListResponse> {
-    return this._client.get('/print-mail/v1/mailing_list_imports', { query, ...options });
+  ): PagePromise<MailingListImportResponsesSkipLimit, MailingListImportResponse> {
+    return this._client.getAPIList(
+      '/print-mail/v1/mailing_list_imports',
+      SkipLimit<MailingListImportResponse>,
+      { query, ...options },
+    );
   }
 
   /**
@@ -118,6 +125,8 @@ export class MailingListImports extends APIResource {
   }
 }
 
+export type MailingListImportResponsesSkipLimit = SkipLimit<MailingListImportResponse>;
+
 /**
  * Type of file supported for mailing list imports.
  */
@@ -317,21 +326,6 @@ export interface VerificationStatusCount {
   verifiedCount: number;
 }
 
-/**
- * A list of mailing list imports.
- */
-export interface MailingListImportListResponse {
-  data: Array<MailingListImportResponse>;
-
-  limit: number;
-
-  object: 'list';
-
-  skip: number;
-
-  totalCount: number;
-}
-
 export interface MailingListImportDeleteResponse {
   /**
    * A unique ID prefixed with mailing*list_import*
@@ -404,9 +398,7 @@ export interface MailingListImportUpdateParams {
   metadata?: { [key: string]: string } | null;
 }
 
-export interface MailingListImportListParams {
-  limit?: number;
-
+export interface MailingListImportListParams 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
@@ -415,8 +407,6 @@ export interface MailingListImportListParams {
    * more details.
    */
   search?: string;
-
-  skip?: number;
 }
 
 export declare namespace MailingListImports {
@@ -424,8 +414,8 @@ export declare namespace MailingListImports {
     type FileType as FileType,
     type MailingListImportResponse as MailingListImportResponse,
     type VerificationStatusCount as VerificationStatusCount,
-    type MailingListImportListResponse as MailingListImportListResponse,
     type MailingListImportDeleteResponse as MailingListImportDeleteResponse,
+    type MailingListImportResponsesSkipLimit as MailingListImportResponsesSkipLimit,
     type MailingListImportCreateParams as MailingListImportCreateParams,
     type MailingListImportUpdateParams as MailingListImportUpdateParams,
     type MailingListImportListParams as MailingListImportListParams,

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

@@ -2,6 +2,7 @@
 
 import { APIResource } from '../../core/resource';
 import { APIPromise } from '../../core/api-promise';
+import { PagePromise, SkipLimit, type SkipLimitParams } from '../../core/pagination';
 import { buildHeaders } from '../../internal/headers';
 import { RequestOptions } from '../../internal/request-options';
 import { path } from '../../internal/utils/path';
@@ -67,15 +68,20 @@ export class MailingLists extends APIResource {
    *
    * @example
    * ```ts
-   * const mailingLists =
-   *   await client.printMail.mailingLists.list();
+   * // Automatically fetches more pages as needed.
+   * for await (const mailingList of client.printMail.mailingLists.list()) {
+   *   // ...
+   * }
    * ```
    */
   list(
     query: MailingListListParams | null | undefined = {},
     options?: RequestOptions,
-  ): APIPromise<MailingListListResponse> {
-    return this._client.get('/print-mail/v1/mailing_lists', { query, ...options });
+  ): PagePromise<MailingListsSkipLimit, MailingList> {
+    return this._client.getAPIList('/print-mail/v1/mailing_lists', SkipLimit<MailingList>, {
+      query,
+      ...options,
+    });
   }
 
   /**
@@ -123,6 +129,8 @@ export class MailingLists extends APIResource {
   }
 }
 
+export type MailingListsSkipLimit = SkipLimit<MailingList>;
+
 /**
  * Represents a mailing list.
  */
@@ -206,21 +214,6 @@ export interface MailingListUpdate {
   metadata?: { [key: string]: unknown };
 }
 
-/**
- * A list of mailing lists.
- */
-export interface MailingListListResponse {
-  data: Array<MailingList>;
-
-  limit: number;
-
-  object: 'list';
-
-  skip: number;
-
-  totalCount: number;
-}
-
 export interface MailingListDeleteResponse {
   /**
    * A unique ID prefixed with mailing*list*
@@ -261,9 +254,7 @@ export interface MailingListUpdateParams {
   metadata?: { [key: string]: unknown };
 }
 
-export interface MailingListListParams {
-  limit?: number;
-
+export interface MailingListListParams 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
@@ -272,8 +263,6 @@ export interface MailingListListParams {
    * more details.
    */
   search?: string;
-
-  skip?: number;
 }
 
 export interface MailingListJobsParams {
@@ -306,8 +295,8 @@ export declare namespace MailingLists {
   export {
     type MailingList as MailingList,
     type MailingListUpdate as MailingListUpdate,
-    type MailingListListResponse as MailingListListResponse,
     type MailingListDeleteResponse as MailingListDeleteResponse,
+    type MailingListsSkipLimit as MailingListsSkipLimit,
     type MailingListCreateParams as MailingListCreateParams,
     type MailingListUpdateParams as MailingListUpdateParams,
     type MailingListListParams as MailingListListParams,

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

@@ -4,6 +4,7 @@ import { APIResource } from '../../../core/resource';
 import * as BoxesAPI from '../boxes';
 import * as ChequesAPI from '../cheques';
 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';
 
@@ -78,15 +79,20 @@ export class Cheques extends APIResource {
    *
    * @example
    * ```ts
-   * const cheques =
-   *   await client.printMail.orderProfiles.cheques.list();
+   * // Automatically fetches more pages as needed.
+   * for await (const chequeListResponse of client.printMail.orderProfiles.cheques.list()) {
+   *   // ...
+   * }
    * ```
    */
   list(
     query: ChequeListParams | null | undefined = {},
     options?: RequestOptions,
-  ): APIPromise<ChequeListResponse> {
-    return this._client.get('/print-mail/v1/order_profiles/cheques', { query, ...options });
+  ): PagePromise<ChequeListResponsesSkipLimit, ChequeListResponse> {
+    return this._client.getAPIList('/print-mail/v1/order_profiles/cheques', SkipLimit<ChequeListResponse>, {
+      query,
+      ...options,
+    });
   }
 
   /**
@@ -103,6 +109,8 @@ export class Cheques extends APIResource {
   }
 }
 
+export type ChequeListResponsesSkipLimit = SkipLimit<ChequeListResponse>;
+
 export interface ChequeProfile {
   /**
    * Unique identifier for the order profile.
@@ -198,106 +206,89 @@ export interface ChequeProfile {
  */
 export type CurrencyCode = 'CAD' | 'USD';
 
-/**
- * Represents a list of Cheque Profiles.
- */
 export interface ChequeListResponse {
-  data: Array<ChequeListResponse.Data>;
+  /**
+   * Unique identifier for the order profile.
+   */
+  id: string;
 
-  limit: number;
+  /**
+   * ID of the bank account to use for the cheque. Required for creation.
+   */
+  bankAccount: string;
 
-  object: 'list';
+  /**
+   * Timestamp when the profile was created.
+   */
+  createdAt: string;
 
-  skip: number;
+  /**
+   * Indicates if the profile is associated with the live or test environment.
+   */
+  live: boolean;
 
-  totalCount: number;
-}
+  /**
+   * Always `cheque_profile`.
+   */
+  object: 'cheque_profile';
 
-export namespace ChequeListResponse {
-  export interface Data {
-    /**
-     * Unique identifier for the order profile.
-     */
-    id: string;
-
-    /**
-     * ID of the bank account to use for the cheque. Required for creation.
-     */
-    bankAccount: string;
-
-    /**
-     * Timestamp when the profile was created.
-     */
-    createdAt: string;
-
-    /**
-     * Indicates if the profile is associated with the live or test environment.
-     */
-    live: boolean;
-
-    /**
-     * Always `cheque_profile`.
-     */
-    object: 'cheque_profile';
-
-    /**
-     * Enum representing the supported cheque sizes.
-     */
-    size: ChequesAPI.ChequeSize;
-
-    /**
-     * Timestamp when the profile was last updated.
-     */
-    updatedAt: string;
-
-    /**
-     * An optional description for the profile. Set to `null` to remove during update.
-     */
-    description?: string | null;
-
-    /**
-     * ID of a template for an optional attached letter. Cannot be used with
-     * `letterHTML` or `letterPDF`.
-     */
-    letterTemplate?: string;
-
-    /**
-     * A temporary, signed URL to view the attached letter PDF, if any. Output only.
-     */
-    letterUploadedPDF?: string;
-
-    /**
-     * A publicly accessible URL for the logo to print on the cheque. Set to `null` to
-     * remove during update.
-     */
-    logo?: string | null;
-
-    /**
-     * Mailing class. Generally must be first class (or equivalent for destination
-     * country) for cheques.
-     */
-    mailingClass?: BoxesAPI.OrderMailingClass;
-
-    /**
-     * Memo line text for the cheque. Set to `null` to remove during update.
-     */
-    memo?: string | null;
-
-    /**
-     * Default merge variables for orders created using this profile.
-     */
-    mergeVariables?: { [key: string]: unknown } | null;
-
-    /**
-     * Message included on the cheque stub. Set to `null` to remove during update.
-     */
-    message?: string | null;
-
-    /**
-     * Optional key-value metadata.
-     */
-    metadata?: { [key: string]: string } | null;
-  }
+  /**
+   * Enum representing the supported cheque sizes.
+   */
+  size: ChequesAPI.ChequeSize;
+
+  /**
+   * Timestamp when the profile was last updated.
+   */
+  updatedAt: string;
+
+  /**
+   * An optional description for the profile. Set to `null` to remove during update.
+   */
+  description?: string | null;
+
+  /**
+   * ID of a template for an optional attached letter. Cannot be used with
+   * `letterHTML` or `letterPDF`.
+   */
+  letterTemplate?: string;
+
+  /**
+   * A temporary, signed URL to view the attached letter PDF, if any. Output only.
+   */
+  letterUploadedPDF?: string;
+
+  /**
+   * A publicly accessible URL for the logo to print on the cheque. Set to `null` to
+   * remove during update.
+   */
+  logo?: string | null;
+
+  /**
+   * Mailing class. Generally must be first class (or equivalent for destination
+   * country) for cheques.
+   */
+  mailingClass?: BoxesAPI.OrderMailingClass;
+
+  /**
+   * Memo line text for the cheque. Set to `null` to remove during update.
+   */
+  memo?: string | null;
+
+  /**
+   * Default merge variables for orders created using this profile.
+   */
+  mergeVariables?: { [key: string]: unknown } | null;
+
+  /**
+   * Message included on the cheque stub. Set to `null` to remove during update.
+   */
+  message?: string | null;
+
+  /**
+   * Optional key-value metadata.
+   */
+  metadata?: { [key: string]: string } | null;
 }
 
 export interface ChequeDeleteResponse {
@@ -469,9 +460,7 @@ export interface ChequeUpdateParams {
   metadata?: { [key: string]: string } | null;
 }
 
-export interface ChequeListParams {
-  limit?: number;
-
+export interface ChequeListParams 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
@@ -480,8 +469,6 @@ export interface ChequeListParams {
    * more details.
    */
   search?: string;
-
-  skip?: number;
 }
 
 export declare namespace Cheques {
@@ -490,6 +477,7 @@ export declare namespace Cheques {
     type CurrencyCode as CurrencyCode,
     type ChequeListResponse as ChequeListResponse,
     type ChequeDeleteResponse as ChequeDeleteResponse,
+    type ChequeListResponsesSkipLimit as ChequeListResponsesSkipLimit,
     type ChequeCreateParams as ChequeCreateParams,
     type ChequeRetrieveParams as ChequeRetrieveParams,
     type ChequeUpdateParams as ChequeUpdateParams,

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

@@ -10,37 +10,38 @@ export {
   type ChequeRetrieveParams,
   type ChequeUpdateParams,
   type ChequeListParams,
+  type ChequeListResponsesSkipLimit,
 } from './cheques';
 export {
   Letters,
   type LetterProfile,
-  type LetterListResponse,
   type LetterDeleteResponse,
   type LetterCreateParams,
   type LetterRetrieveParams,
   type LetterUpdateParams,
   type LetterListParams,
+  type LetterProfilesSkipLimit,
 } from './letters';
 export { OrderProfiles } from './order-profiles';
 export {
   Postcards,
   type PostcardProfile,
   type PostcardSize,
-  type PostcardListResponse,
   type PostcardDeleteResponse,
   type PostcardCreateParams,
   type PostcardRetrieveParams,
   type PostcardUpdateParams,
   type PostcardListParams,
+  type PostcardProfilesSkipLimit,
 } from './postcards';
 export {
   SelfMailers,
   type SelfMailerProfile,
   type SelfMailerSize,
-  type SelfMailerListResponse,
   type SelfMailerDeleteResponse,
   type SelfMailerCreateParams,
   type SelfMailerRetrieveParams,
   type SelfMailerUpdateParams,
   type SelfMailerListParams,
+  type SelfMailerProfilesSkipLimit,
 } from './self-mailers';

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

@@ -4,6 +4,7 @@ import { APIResource } from '../../../core/resource';
 import * as BoxesAPI from '../boxes';
 import * as LettersAPI from '../letters';
 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';
 
@@ -84,15 +85,20 @@ export class Letters extends APIResource {
    *
    * @example
    * ```ts
-   * const letters =
-   *   await client.printMail.orderProfiles.letters.list();
+   * // Automatically fetches more pages as needed.
+   * for await (const letterProfile of client.printMail.orderProfiles.letters.list()) {
+   *   // ...
+   * }
    * ```
    */
   list(
     query: LetterListParams | null | undefined = {},
     options?: RequestOptions,
-  ): APIPromise<LetterListResponse> {
-    return this._client.get('/print-mail/v1/order_profiles/letters', { query, ...options });
+  ): PagePromise<LetterProfilesSkipLimit, LetterProfile> {
+    return this._client.getAPIList('/print-mail/v1/order_profiles/letters', SkipLimit<LetterProfile>, {
+      query,
+      ...options,
+    });
   }
 
   /**
@@ -110,6 +116,8 @@ export class Letters extends APIResource {
   }
 }
 
+export type LetterProfilesSkipLimit = SkipLimit<LetterProfile>;
+
 export interface LetterProfile {
   /**
    * Unique identifier for the order profile.
@@ -202,21 +210,6 @@ export interface LetterProfile {
   uploadedPDF?: string;
 }
 
-/**
- * Represents a list of Letter Profiles.
- */
-export interface LetterListResponse {
-  data: Array<LetterProfile>;
-
-  limit: number;
-
-  object: 'list';
-
-  skip: number;
-
-  totalCount: number;
-}
-
 export interface LetterDeleteResponse {
   /**
    * Unique identifier for the order profile.
@@ -395,9 +388,7 @@ export interface LetterUpdateParams {
   template?: string;
 }
 
-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
@@ -406,15 +397,13 @@ export interface LetterListParams {
    * more details.
    */
   search?: string;
-
-  skip?: number;
 }
 
 export declare namespace Letters {
   export {
     type LetterProfile as LetterProfile,
-    type LetterListResponse as LetterListResponse,
     type LetterDeleteResponse as LetterDeleteResponse,
+    type LetterProfilesSkipLimit as LetterProfilesSkipLimit,
     type LetterCreateParams as LetterCreateParams,
     type LetterRetrieveParams as LetterRetrieveParams,
     type LetterUpdateParams as LetterUpdateParams,

package/src/resources/print-mail/order-profiles/order-profiles.ts

@@ -7,6 +7,7 @@ import {
   ChequeDeleteResponse,
   ChequeListParams,
   ChequeListResponse,
+  ChequeListResponsesSkipLimit,
   ChequeProfile,
   ChequeRetrieveParams,
   ChequeUpdateParams,
@@ -18,8 +19,8 @@ import {
   LetterCreateParams,
   LetterDeleteResponse,
   LetterListParams,
-  LetterListResponse,
   LetterProfile,
+  LetterProfilesSkipLimit,
   LetterRetrieveParams,
   LetterUpdateParams,
   Letters,
@@ -29,8 +30,8 @@ import {
   PostcardCreateParams,
   PostcardDeleteResponse,
   PostcardListParams,
-  PostcardListResponse,
   PostcardProfile,
+  PostcardProfilesSkipLimit,
   PostcardRetrieveParams,
   PostcardSize,
   PostcardUpdateParams,
@@ -41,8 +42,8 @@ import {
   SelfMailerCreateParams,
   SelfMailerDeleteResponse,
   SelfMailerListParams,
-  SelfMailerListResponse,
   SelfMailerProfile,
+  SelfMailerProfilesSkipLimit,
   SelfMailerRetrieveParams,
   SelfMailerSize,
   SelfMailerUpdateParams,
@@ -68,6 +69,7 @@ export declare namespace OrderProfiles {
     type CurrencyCode as CurrencyCode,
     type ChequeListResponse as ChequeListResponse,
     type ChequeDeleteResponse as ChequeDeleteResponse,
+    type ChequeListResponsesSkipLimit as ChequeListResponsesSkipLimit,
     type ChequeCreateParams as ChequeCreateParams,
     type ChequeRetrieveParams as ChequeRetrieveParams,
     type ChequeUpdateParams as ChequeUpdateParams,
@@ -77,8 +79,8 @@ export declare namespace OrderProfiles {
   export {
     Letters as Letters,
     type LetterProfile as LetterProfile,
-    type LetterListResponse as LetterListResponse,
     type LetterDeleteResponse as LetterDeleteResponse,
+    type LetterProfilesSkipLimit as LetterProfilesSkipLimit,
     type LetterCreateParams as LetterCreateParams,
     type LetterRetrieveParams as LetterRetrieveParams,
     type LetterUpdateParams as LetterUpdateParams,
@@ -89,8 +91,8 @@ export declare namespace OrderProfiles {
     Postcards as Postcards,
     type PostcardProfile as PostcardProfile,
     type PostcardSize as PostcardSize,
-    type PostcardListResponse as PostcardListResponse,
     type PostcardDeleteResponse as PostcardDeleteResponse,
+    type PostcardProfilesSkipLimit as PostcardProfilesSkipLimit,
     type PostcardCreateParams as PostcardCreateParams,
     type PostcardRetrieveParams as PostcardRetrieveParams,
     type PostcardUpdateParams as PostcardUpdateParams,
@@ -101,8 +103,8 @@ export declare namespace OrderProfiles {
     SelfMailers as SelfMailers,
     type SelfMailerProfile as SelfMailerProfile,
     type SelfMailerSize as SelfMailerSize,
-    type SelfMailerListResponse as SelfMailerListResponse,
     type SelfMailerDeleteResponse as SelfMailerDeleteResponse,
+    type SelfMailerProfilesSkipLimit as SelfMailerProfilesSkipLimit,
     type SelfMailerCreateParams as SelfMailerCreateParams,
     type SelfMailerRetrieveParams as SelfMailerRetrieveParams,
     type SelfMailerUpdateParams as SelfMailerUpdateParams,