postgrid-node 0.3.0 → 0.4.1

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

@@ -3,6 +3,7 @@
 import { APIResource } from '../../../core/resource';
 import * as BoxesAPI from '../boxes';
 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';
 
@@ -74,15 +75,20 @@ export class Postcards extends APIResource {
    *
    * @example
    * ```ts
-   * const postcards =
-   *   await client.printMail.orderProfiles.postcards.list();
+   * // Automatically fetches more pages as needed.
+   * for await (const postcardProfile of client.printMail.orderProfiles.postcards.list()) {
+   *   // ...
+   * }
    * ```
    */
   list(
     query: PostcardListParams | null | undefined = {},
     options?: RequestOptions,
-  ): APIPromise<PostcardListResponse> {
-    return this._client.get('/print-mail/v1/order_profiles/postcards', { query, ...options });
+  ): PagePromise<PostcardProfilesSkipLimit, PostcardProfile> {
+    return this._client.getAPIList('/print-mail/v1/order_profiles/postcards', SkipLimit<PostcardProfile>, {
+      query,
+      ...options,
+    });
   }
 
   /**
@@ -101,6 +107,8 @@ export class Postcards extends APIResource {
   }
 }
 
+export type PostcardProfilesSkipLimit = SkipLimit<PostcardProfile>;
+
 export interface PostcardProfile {
   /**
    * Unique identifier for the order profile.
@@ -174,21 +182,6 @@ export interface PostcardProfile {
  */
 export type PostcardSize = '6x4' | '9x6' | '11x6';
 
-/**
- * Represents a list of Postcard Profiles.
- */
-export interface PostcardListResponse {
-  data: Array<PostcardProfile>;
-
-  limit: number;
-
-  object: 'list';
-
-  skip: number;
-
-  totalCount: number;
-}
-
 export interface PostcardDeleteResponse {
   /**
    * Unique identifier for the order profile.
@@ -309,9 +302,7 @@ export interface PostcardUpdateParams {
   pdf?: string;
 }
 
-export interface PostcardListParams {
-  limit?: number;
-
+export interface PostcardListParams 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
@@ -320,16 +311,14 @@ export interface PostcardListParams {
    * more details.
    */
   search?: string;
-
-  skip?: number;
 }
 
 export declare namespace Postcards {
   export {
     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,

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

@@ -3,6 +3,7 @@
 import { APIResource } from '../../../core/resource';
 import * as BoxesAPI from '../boxes';
 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';
 
@@ -79,15 +80,21 @@ export class SelfMailers extends APIResource {
    *
    * @example
    * ```ts
-   * const selfMailers =
-   *   await client.printMail.orderProfiles.selfMailers.list();
+   * // Automatically fetches more pages as needed.
+   * for await (const selfMailerProfile of client.printMail.orderProfiles.selfMailers.list()) {
+   *   // ...
+   * }
    * ```
    */
   list(
     query: SelfMailerListParams | null | undefined = {},
     options?: RequestOptions,
-  ): APIPromise<SelfMailerListResponse> {
-    return this._client.get('/print-mail/v1/order_profiles/self_mailers', { query, ...options });
+  ): PagePromise<SelfMailerProfilesSkipLimit, SelfMailerProfile> {
+    return this._client.getAPIList(
+      '/print-mail/v1/order_profiles/self_mailers',
+      SkipLimit<SelfMailerProfile>,
+      { query, ...options },
+    );
   }
 
   /**
@@ -106,6 +113,8 @@ export class SelfMailers extends APIResource {
   }
 }
 
+export type SelfMailerProfilesSkipLimit = SkipLimit<SelfMailerProfile>;
+
 /**
  * Represents a Self-Mailer Profile resource.
  */
@@ -181,21 +190,6 @@ export interface SelfMailerProfile {
  */
 export type SelfMailerSize = '8.5x11_bifold' | '8.5x11_trifold' | '9.5x16_trifold';
 
-/**
- * Represents a list of Self-Mailer Profiles.
- */
-export interface SelfMailerListResponse {
-  data: Array<SelfMailerProfile>;
-
-  limit: number;
-
-  object: 'list';
-
-  skip: number;
-
-  totalCount: number;
-}
-
 export interface SelfMailerDeleteResponse {
   /**
    * Unique identifier for the order profile.
@@ -319,9 +313,7 @@ export interface SelfMailerUpdateParams {
   pdf?: string;
 }
 
-export interface SelfMailerListParams {
-  limit?: number;
-
+export interface SelfMailerListParams 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
@@ -330,16 +322,14 @@ export interface SelfMailerListParams {
    * more details.
    */
   search?: string;
-
-  skip?: number;
 }
 
 export declare namespace SelfMailers {
   export {
     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,