@sentdm/sentdm 0.37.0 → 0.38.0

package/src/core/pagination.ts

@@ -0,0 +1,428 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { SentError } from './error';
+import { FinalRequestOptions } from '../internal/request-options';
+import { defaultParseResponse } from '../internal/parse';
+import { type Sent } from '../client';
+import { APIPromise } from './api-promise';
+import { type APIResponseProps } from '../internal/parse';
+import { maybeObj } from '../internal/utils/values';
+
+export type PageRequestOptions = Pick<FinalRequestOptions, 'query' | 'headers' | 'body' | 'path' | 'method'>;
+
+export abstract class AbstractPage<Item> implements AsyncIterable<Item> {
+  #client: Sent;
+  protected options: FinalRequestOptions;
+
+  protected response: Response;
+  protected body: unknown;
+
+  constructor(client: Sent, response: Response, body: unknown, options: FinalRequestOptions) {
+    this.#client = client;
+    this.options = options;
+    this.response = response;
+    this.body = body;
+  }
+
+  abstract nextPageRequestOptions(): PageRequestOptions | null;
+
+  abstract getPaginatedItems(): Item[];
+
+  hasNextPage(): boolean {
+    const items = this.getPaginatedItems();
+    if (!items.length) return false;
+    return this.nextPageRequestOptions() != null;
+  }
+
+  async getNextPage(): Promise<this> {
+    const nextOptions = this.nextPageRequestOptions();
+    if (!nextOptions) {
+      throw new SentError(
+        'No next page expected; please check `.hasNextPage()` before calling `.getNextPage()`.',
+      );
+    }
+
+    return await this.#client.requestAPIList(this.constructor as any, nextOptions);
+  }
+
+  async *iterPages(): AsyncGenerator<this> {
+    let page: this = this;
+    yield page;
+    while (page.hasNextPage()) {
+      page = await page.getNextPage();
+      yield page;
+    }
+  }
+
+  async *[Symbol.asyncIterator](): AsyncGenerator<Item> {
+    for await (const page of this.iterPages()) {
+      for (const item of page.getPaginatedItems()) {
+        yield item;
+      }
+    }
+  }
+}
+
+/**
+ * This subclass of Promise will resolve to an instantiated Page once the request completes.
+ *
+ * It also implements AsyncIterable to allow auto-paginating iteration on an unawaited list call, eg:
+ *
+ *    for await (const item of client.items.list()) {
+ *      console.log(item)
+ *    }
+ */
+export class PagePromise<
+    PageClass extends AbstractPage<Item>,
+    Item = ReturnType<PageClass['getPaginatedItems']>[number],
+  >
+  extends APIPromise<PageClass>
+  implements AsyncIterable<Item>
+{
+  constructor(
+    client: Sent,
+    request: Promise<APIResponseProps>,
+    Page: new (...args: ConstructorParameters<typeof AbstractPage>) => PageClass,
+  ) {
+    super(
+      client,
+      request,
+      async (client, props) =>
+        new Page(client, props.response, await defaultParseResponse(client, props), props.options),
+    );
+  }
+
+  /**
+   * Allow auto-paginating iteration on an unawaited list call, eg:
+   *
+   *    for await (const item of client.items.list()) {
+   *      console.log(item)
+   *    }
+   */
+  async *[Symbol.asyncIterator](): AsyncGenerator<Item> {
+    const page = await this;
+    for await (const item of page) {
+      yield item;
+    }
+  }
+}
+
+export interface ContactsPageResponse<Item> {
+  data: ContactsPageResponse.Data<Item>;
+}
+
+export namespace ContactsPageResponse {
+  export interface Data<Item> {
+    contacts?: Array<Item>;
+
+    pagination?: Data.Pagination;
+  }
+
+  export namespace Data {
+    export interface Pagination {
+      has_more?: boolean;
+    }
+  }
+}
+
+export interface ContactsPageParams {
+  page?: number;
+
+  page_size?: number;
+}
+
+export class ContactsPage<Item> extends AbstractPage<Item> implements ContactsPageResponse<Item> {
+  data: ContactsPageResponse.Data<Item>;
+
+  constructor(
+    client: Sent,
+    response: Response,
+    body: ContactsPageResponse<Item>,
+    options: FinalRequestOptions,
+  ) {
+    super(client, response, body, options);
+
+    this.data = body.data || {};
+  }
+
+  getPaginatedItems(): Item[] {
+    return this.data?.contacts ?? [];
+  }
+
+  override hasNextPage(): boolean {
+    if (this.data?.pagination?.has_more === false) {
+      return false;
+    }
+
+    return super.hasNextPage();
+  }
+
+  nextPageRequestOptions(): PageRequestOptions | null {
+    const query = this.options.query as ContactsPageParams;
+    const currentPage = query?.page ?? 1;
+
+    return {
+      ...this.options,
+      query: {
+        ...maybeObj(this.options.query),
+        page: currentPage + 1,
+      },
+    };
+  }
+}
+
+export interface ConversationsPageResponse<Item> {
+  data: ConversationsPageResponse.Data<Item>;
+}
+
+export namespace ConversationsPageResponse {
+  export interface Data<Item> {
+    messages?: Array<Item>;
+
+    pagination?: Data.Pagination;
+  }
+
+  export namespace Data {
+    export interface Pagination {
+      has_more?: boolean;
+    }
+  }
+}
+
+export interface ConversationsPageParams {
+  page?: number;
+
+  page_size?: number;
+}
+
+export class ConversationsPage<Item> extends AbstractPage<Item> implements ConversationsPageResponse<Item> {
+  data: ConversationsPageResponse.Data<Item>;
+
+  constructor(
+    client: Sent,
+    response: Response,
+    body: ConversationsPageResponse<Item>,
+    options: FinalRequestOptions,
+  ) {
+    super(client, response, body, options);
+
+    this.data = body.data || {};
+  }
+
+  getPaginatedItems(): Item[] {
+    return this.data?.messages ?? [];
+  }
+
+  override hasNextPage(): boolean {
+    if (this.data?.pagination?.has_more === false) {
+      return false;
+    }
+
+    return super.hasNextPage();
+  }
+
+  nextPageRequestOptions(): PageRequestOptions | null {
+    const query = this.options.query as ConversationsPageParams;
+    const currentPage = query?.page ?? 1;
+
+    return {
+      ...this.options,
+      query: {
+        ...maybeObj(this.options.query),
+        page: currentPage + 1,
+      },
+    };
+  }
+}
+
+export interface TemplatesPageResponse<Item> {
+  data: TemplatesPageResponse.Data<Item>;
+}
+
+export namespace TemplatesPageResponse {
+  export interface Data<Item> {
+    pagination?: Data.Pagination;
+
+    templates?: Array<Item>;
+  }
+
+  export namespace Data {
+    export interface Pagination {
+      has_more?: boolean;
+    }
+  }
+}
+
+export interface TemplatesPageParams {
+  page?: number;
+
+  page_size?: number;
+}
+
+export class TemplatesPage<Item> extends AbstractPage<Item> implements TemplatesPageResponse<Item> {
+  data: TemplatesPageResponse.Data<Item>;
+
+  constructor(
+    client: Sent,
+    response: Response,
+    body: TemplatesPageResponse<Item>,
+    options: FinalRequestOptions,
+  ) {
+    super(client, response, body, options);
+
+    this.data = body.data || {};
+  }
+
+  getPaginatedItems(): Item[] {
+    return this.data?.templates ?? [];
+  }
+
+  override hasNextPage(): boolean {
+    if (this.data?.pagination?.has_more === false) {
+      return false;
+    }
+
+    return super.hasNextPage();
+  }
+
+  nextPageRequestOptions(): PageRequestOptions | null {
+    const query = this.options.query as TemplatesPageParams;
+    const currentPage = query?.page ?? 1;
+
+    return {
+      ...this.options,
+      query: {
+        ...maybeObj(this.options.query),
+        page: currentPage + 1,
+      },
+    };
+  }
+}
+
+export interface WebhooksPageResponse<Item> {
+  data: WebhooksPageResponse.Data<Item>;
+}
+
+export namespace WebhooksPageResponse {
+  export interface Data<Item> {
+    pagination?: Data.Pagination;
+
+    webhooks?: Array<Item>;
+  }
+
+  export namespace Data {
+    export interface Pagination {
+      has_more?: boolean;
+    }
+  }
+}
+
+export interface WebhooksPageParams {
+  page?: number;
+
+  page_size?: number;
+}
+
+export class WebhooksPage<Item> extends AbstractPage<Item> implements WebhooksPageResponse<Item> {
+  data: WebhooksPageResponse.Data<Item>;
+
+  constructor(
+    client: Sent,
+    response: Response,
+    body: WebhooksPageResponse<Item>,
+    options: FinalRequestOptions,
+  ) {
+    super(client, response, body, options);
+
+    this.data = body.data || {};
+  }
+
+  getPaginatedItems(): Item[] {
+    return this.data?.webhooks ?? [];
+  }
+
+  override hasNextPage(): boolean {
+    if (this.data?.pagination?.has_more === false) {
+      return false;
+    }
+
+    return super.hasNextPage();
+  }
+
+  nextPageRequestOptions(): PageRequestOptions | null {
+    const query = this.options.query as WebhooksPageParams;
+    const currentPage = query?.page ?? 1;
+
+    return {
+      ...this.options,
+      query: {
+        ...maybeObj(this.options.query),
+        page: currentPage + 1,
+      },
+    };
+  }
+}
+
+export interface WebhookEventsPageResponse<Item> {
+  data: WebhookEventsPageResponse.Data<Item>;
+}
+
+export namespace WebhookEventsPageResponse {
+  export interface Data<Item> {
+    events?: Array<Item>;
+
+    pagination?: Data.Pagination;
+  }
+
+  export namespace Data {
+    export interface Pagination {
+      has_more?: boolean;
+    }
+  }
+}
+
+export interface WebhookEventsPageParams {
+  page?: number;
+
+  page_size?: number;
+}
+
+export class WebhookEventsPage<Item> extends AbstractPage<Item> implements WebhookEventsPageResponse<Item> {
+  data: WebhookEventsPageResponse.Data<Item>;
+
+  constructor(
+    client: Sent,
+    response: Response,
+    body: WebhookEventsPageResponse<Item>,
+    options: FinalRequestOptions,
+  ) {
+    super(client, response, body, options);
+
+    this.data = body.data || {};
+  }
+
+  getPaginatedItems(): Item[] {
+    return this.data?.events ?? [];
+  }
+
+  override hasNextPage(): boolean {
+    if (this.data?.pagination?.has_more === false) {
+      return false;
+    }
+
+    return super.hasNextPage();
+  }
+
+  nextPageRequestOptions(): PageRequestOptions | null {
+    const query = this.options.query as WebhookEventsPageParams;
+    const currentPage = query?.page ?? 1;
+
+    return {
+      ...this.options,
+      query: {
+        ...maybeObj(this.options.query),
+        page: currentPage + 1,
+      },
+    };
+  }
+}

package/src/index.ts

@@ -5,6 +5,7 @@ export { Sent as default } from './client';
 export { type Uploadable, toFile } from './core/uploads';
 export { APIPromise } from './core/api-promise';
 export { Sent, type ClientOptions } from './client';
+export { PagePromise } from './core/pagination';
 export {
   SentError,
   APIError,

package/src/pagination.ts

@@ -0,0 +1,2 @@
+/** @deprecated Import from ./core/pagination instead */
+export * from './core/pagination';

package/src/resources/contacts.ts

@@ -1,9 +1,9 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import { APIResource } from '../core/resource';
-import * as ContactsAPI from './contacts';
 import * as WebhooksAPI from './webhooks';
 import { APIPromise } from '../core/api-promise';
+import { ContactsPage, type ContactsPageParams, PagePromise } from '../core/pagination';
 import { buildHeaders } from '../internal/headers';
 import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
@@ -104,15 +104,18 @@ export class Contacts extends APIResource {
    *
    * @example
    * ```ts
-   * const contacts = await client.contacts.list({
-   *   page: 0,
-   *   page_size: 0,
-   * });
+   * // Automatically fetches more pages as needed.
+   * for await (const contactResponse of client.contacts.list()) {
+   *   // ...
+   * }
    * ```
    */
-  list(params: ContactListParams, options?: RequestOptions): APIPromise<ContactListResponse> {
-    const { 'x-profile-id': xProfileID, ...query } = params;
-    return this._client.get('/v3/contacts', {
+  list(
+    params: ContactListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<ContactResponsesContactsPage, ContactResponse> {
+    const { 'x-profile-id': xProfileID, ...query } = params ?? {};
+    return this._client.getAPIList('/v3/contacts', ContactsPage<ContactResponse>, {
       query,
       ...options,
       headers: buildHeaders([
@@ -178,6 +181,8 @@ export class Contacts extends APIResource {
   }
 }
 
+export type ContactResponsesContactsPage = ContactsPage<ContactResponse>;
+
 /**
  * Standard API response envelope for all v3 endpoints
  */
@@ -343,48 +348,6 @@ export interface ContactResponse {
   updated_at?: string | null;
 }
 
-/**
- * Standard API response envelope for all v3 endpoints
- */
-export interface ContactListResponse {
-  /**
-   * A paginated list of contacts.
-   */
-  data?: ContactListResponse.Data | null;
-
-  /**
-   * Error information
-   */
-  error?: WebhooksAPI.ErrorDetail | null;
-
-  /**
-   * Request and response metadata
-   */
-  meta?: WebhooksAPI.APIMeta;
-
-  /**
-   * Indicates whether the request was successful
-   */
-  success?: boolean;
-}
-
-export namespace ContactListResponse {
-  /**
-   * A paginated list of contacts.
-   */
-  export interface Data {
-    /**
-     * The contacts on this page.
-     */
-    contacts?: Array<ContactsAPI.ContactResponse>;
-
-    /**
-     * Pagination metadata for list responses
-     */
-    pagination?: WebhooksAPI.PaginationMeta;
-  }
-}
-
 export interface ContactCreateParams {
   /**
    * Body param: Phone number of the contact to create
@@ -453,17 +416,7 @@ export interface ContactUpdateParams {
   'x-profile-id'?: string;
 }
 
-export interface ContactListParams {
-  /**
-   * Query param: Page number (1-indexed)
-   */
-  page: number;
-
-  /**
-   * Query param: Number of items per page
-   */
-  page_size: number;
-
+export interface ContactListParams extends ContactsPageParams {
   /**
    * Query param: Optional channel filter (sms, whatsapp)
    */
@@ -516,7 +469,7 @@ export declare namespace Contacts {
     type APIResponseOfContactMessageSummary as APIResponseOfContactMessageSummary,
     type ContactMessageSummary as ContactMessageSummary,
     type ContactResponse as ContactResponse,
-    type ContactListResponse as ContactListResponse,
+    type ContactResponsesContactsPage as ContactResponsesContactsPage,
     type ContactCreateParams as ContactCreateParams,
     type ContactRetrieveParams as ContactRetrieveParams,
     type ContactUpdateParams as ContactUpdateParams,

package/src/resources/conversations.ts

@@ -2,7 +2,7 @@
 
 import { APIResource } from '../core/resource';
 import * as WebhooksAPI from './webhooks';
-import { APIPromise } from '../core/api-promise';
+import { ConversationsPage, type ConversationsPageParams, PagePromise } from '../core/pagination';
 import { buildHeaders } from '../internal/headers';
 import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
@@ -21,19 +21,18 @@ export class Conversations extends APIResource {
    *
    * @example
    * ```ts
-   * const apiResponseOfConversationMessagesList =
-   *   await client.conversations.list({
-   *     page: 0,
-   *     page_size: 0,
-   *   });
+   * // Automatically fetches more pages as needed.
+   * for await (const conversation of client.conversations.list()) {
+   *   // ...
+   * }
    * ```
    */
   list(
-    params: ConversationListParams,
+    params: ConversationListParams | null | undefined = {},
     options?: RequestOptions,
-  ): APIPromise<APIResponseOfConversationMessagesList> {
-    const { 'x-profile-id': xProfileID, ...query } = params;
-    return this._client.get('/v3/conversations', {
+  ): PagePromise<ConversationMessagesListMessagesConversationsPage, ConversationMessagesList.Message> {
+    const { 'x-profile-id': xProfileID, ...query } = params ?? {};
+    return this._client.getAPIList('/v3/conversations', ConversationsPage<ConversationMessagesList.Message>, {
       query,
       ...options,
       headers: buildHeaders([
@@ -49,30 +48,38 @@ export class Conversations extends APIResource {
    *
    * @example
    * ```ts
-   * const apiResponseOfConversationMessagesList =
-   *   await client.conversations.listMessages(
-   *     '08fab313-c9e2-502c-975e-08b0356c432e',
-   *     { page: 0, page_size: 0 },
-   *   );
+   * // Automatically fetches more pages as needed.
+   * for await (const conversation of client.conversations.listMessages(
+   *   '08fab313-c9e2-502c-975e-08b0356c432e',
+   * )) {
+   *   // ...
+   * }
    * ```
    */
   listMessages(
     id: string,
-    params: ConversationListMessagesParams,
+    params: ConversationListMessagesParams | null | undefined = {},
     options?: RequestOptions,
-  ): APIPromise<APIResponseOfConversationMessagesList> {
-    const { 'x-profile-id': xProfileID, ...query } = params;
-    return this._client.get(path`/v3/conversations/${id}`, {
-      query,
-      ...options,
-      headers: buildHeaders([
-        { ...(xProfileID != null ? { 'x-profile-id': xProfileID } : undefined) },
-        options?.headers,
-      ]),
-    });
+  ): PagePromise<ConversationMessagesListMessagesConversationsPage, ConversationMessagesList.Message> {
+    const { 'x-profile-id': xProfileID, ...query } = params ?? {};
+    return this._client.getAPIList(
+      path`/v3/conversations/${id}`,
+      ConversationsPage<ConversationMessagesList.Message>,
+      {
+        query,
+        ...options,
+        headers: buildHeaders([
+          { ...(xProfileID != null ? { 'x-profile-id': xProfileID } : undefined) },
+          options?.headers,
+        ]),
+      },
+    );
   }
 }
 
+export type ConversationMessagesListMessagesConversationsPage =
+  ConversationsPage<ConversationMessagesList.Message>;
+
 /**
  * Standard API response envelope for all v3 endpoints
  */
@@ -197,17 +204,7 @@ export namespace ConversationMessagesList {
   }
 }
 
-export interface ConversationListParams {
-  /**
-   * Query param
-   */
-  page: number;
-
-  /**
-   * Query param
-   */
-  page_size: number;
-
+export interface ConversationListParams extends ConversationsPageParams {
   /**
    * Header param: Profile UUID to scope the request to a child profile. Only
    * organization API keys can use this header. The profile must belong to the
@@ -216,17 +213,7 @@ export interface ConversationListParams {
   'x-profile-id'?: string;
 }
 
-export interface ConversationListMessagesParams {
-  /**
-   * Query param
-   */
-  page: number;
-
-  /**
-   * Query param
-   */
-  page_size: number;
-
+export interface ConversationListMessagesParams extends ConversationsPageParams {
   /**
    * Header param: Profile UUID to scope the request to a child profile. Only
    * organization API keys can use this header. The profile must belong to the
@@ -239,6 +226,7 @@ export declare namespace Conversations {
   export {
     type APIResponseOfConversationMessagesList as APIResponseOfConversationMessagesList,
     type ConversationMessagesList as ConversationMessagesList,
+    type ConversationMessagesListMessagesConversationsPage as ConversationMessagesListMessagesConversationsPage,
     type ConversationListParams as ConversationListParams,
     type ConversationListMessagesParams as ConversationListMessagesParams,
   };