postgrid-node 0.3.0 → 0.4.0

package/src/resources/print-mail/sub-organizations.ts

@@ -3,6 +3,7 @@
 import { APIResource } from '../../core/resource';
 import * as SubOrganizationsAPI from './sub-organizations';
 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';
 
@@ -50,15 +51,20 @@ export class SubOrganizations extends APIResource {
    *
    * @example
    * ```ts
-   * const subOrganizations =
-   *   await client.printMail.subOrganizations.list();
+   * // Automatically fetches more pages as needed.
+   * for await (const subOrganization of client.printMail.subOrganizations.list()) {
+   *   // ...
+   * }
    * ```
    */
   list(
     query: SubOrganizationListParams | null | undefined = {},
     options?: RequestOptions,
-  ): APIPromise<SubOrganizationListResponse> {
-    return this._client.get('/print-mail/v1/sub_organizations', { query, ...options });
+  ): PagePromise<SubOrganizationsSkipLimit, SubOrganization> {
+    return this._client.getAPIList('/print-mail/v1/sub_organizations', SkipLimit<SubOrganization>, {
+      query,
+      ...options,
+    });
   }
 
   /**
@@ -81,6 +87,8 @@ export class SubOrganizations extends APIResource {
   }
 }
 
+export type SubOrganizationsSkipLimit = SkipLimit<SubOrganization>;
+
 /**
  * A set of preferences for how a user should receive emails.
  */
@@ -240,18 +248,6 @@ export namespace SubOrganizationUpdateResponse {
   }
 }
 
-export interface SubOrganizationListResponse {
-  data: Array<SubOrganization>;
-
-  limit: number;
-
-  object: 'list';
-
-  skip: number;
-
-  totalCount: number;
-}
-
 export type SubOrganizationRetrieveUsersResponse =
   Array<SubOrganizationRetrieveUsersResponse.SubOrganizationRetrieveUsersResponseItem>;
 
@@ -350,9 +346,7 @@ export interface SubOrganizationUpdateParams {
   phoneNumber?: string;
 }
 
-export interface SubOrganizationListParams {
-  limit?: number;
-
+export interface SubOrganizationListParams 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
@@ -361,8 +355,6 @@ export interface SubOrganizationListParams {
    * more details.
    */
   search?: string;
-
-  skip?: number;
 }
 
 export interface SubOrganizationRetrieveUsersParams {
@@ -385,8 +377,8 @@ export declare namespace SubOrganizations {
     type EmailPreferences as EmailPreferences,
     type SubOrganization as SubOrganization,
     type SubOrganizationUpdateResponse as SubOrganizationUpdateResponse,
-    type SubOrganizationListResponse as SubOrganizationListResponse,
     type SubOrganizationRetrieveUsersResponse as SubOrganizationRetrieveUsersResponse,
+    type SubOrganizationsSkipLimit as SubOrganizationsSkipLimit,
     type SubOrganizationUpdateParams as SubOrganizationUpdateParams,
     type SubOrganizationListParams as SubOrganizationListParams,
     type SubOrganizationRetrieveUsersParams as SubOrganizationRetrieveUsersParams,

package/src/resources/print-mail/templates.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 { RequestOptions } from '../../internal/request-options';
 import { path } from '../../internal/utils/path';
 
@@ -59,14 +60,17 @@ export class Templates extends APIResource {
    *
    * @example
    * ```ts
-   * const templates = await client.printMail.templates.list();
+   * // Automatically fetches more pages as needed.
+   * for await (const template of client.printMail.templates.list()) {
+   *   // ...
+   * }
    * ```
    */
   list(
     query: TemplateListParams | null | undefined = {},
     options?: RequestOptions,
-  ): APIPromise<TemplateListResponse> {
-    return this._client.get('/print-mail/v1/templates', { query, ...options });
+  ): PagePromise<TemplatesSkipLimit, Template> {
+    return this._client.getAPIList('/print-mail/v1/templates', SkipLimit<Template>, { query, ...options });
   }
 
   /**
@@ -84,6 +88,8 @@ export class Templates extends APIResource {
   }
 }
 
+export type TemplatesSkipLimit = SkipLimit<Template>;
+
 export interface Template {
   /**
    * A unique ID prefixed with template\_
@@ -127,18 +133,6 @@ export interface Template {
   metadata?: { [key: string]: unknown };
 }
 
-export interface TemplateListResponse {
-  data: Array<Template>;
-
-  limit: number;
-
-  object: 'list';
-
-  skip: number;
-
-  totalCount: number;
-}
-
 export interface TemplateDeleteResponse {
   /**
    * A unique ID prefixed with template\_
@@ -189,9 +183,7 @@ export interface TemplateUpdateParams {
   metadata?: { [key: string]: unknown };
 }
 
-export interface TemplateListParams {
-  limit?: number;
-
+export interface TemplateListParams 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
@@ -200,15 +192,13 @@ export interface TemplateListParams {
    * more details.
    */
   search?: string;
-
-  skip?: number;
 }
 
 export declare namespace Templates {
   export {
     type Template as Template,
-    type TemplateListResponse as TemplateListResponse,
     type TemplateDeleteResponse as TemplateDeleteResponse,
+    type TemplatesSkipLimit as TemplatesSkipLimit,
     type TemplateCreateParams as TemplateCreateParams,
     type TemplateUpdateParams as TemplateUpdateParams,
     type TemplateListParams as TemplateListParams,

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '0.3.0'; // x-release-please-version
+export const VERSION = '0.4.0'; // x-release-please-version

package/version.d.mts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.3.0";
+export declare const VERSION = "0.4.0";
 //# sourceMappingURL=version.d.mts.map

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.3.0";
+export declare const VERSION = "0.4.0";
 //# sourceMappingURL=version.d.ts.map

package/version.js

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
-exports.VERSION = '0.3.0'; // x-release-please-version
+exports.VERSION = '0.4.0'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

@@ -1,2 +1,2 @@
-export const VERSION = '0.3.0'; // x-release-please-version
+export const VERSION = '0.4.0'; // x-release-please-version
 //# sourceMappingURL=version.mjs.map