@sentdm/sentdm 0.37.0 → 0.38.0

package/src/resources/index.ts

@@ -6,13 +6,13 @@ export {
   type APIResponseOfContactMessageSummary,
   type ContactMessageSummary,
   type ContactResponse,
-  type ContactListResponse,
   type ContactCreateParams,
   type ContactRetrieveParams,
   type ContactUpdateParams,
   type ContactListParams,
   type ContactDeleteParams,
   type ContactRetrieveMessageSummaryParams,
+  type ContactResponsesContactsPage,
 } from './contacts';
 export {
   Conversations,
@@ -20,6 +20,7 @@ export {
   type ConversationMessagesList,
   type ConversationListParams,
   type ConversationListMessagesParams,
+  type ConversationMessagesListMessagesConversationsPage,
 } from './conversations';
 export { Me, type ProfileSettings, type MeRetrieveResponse, type MeRetrieveParams } from './me';
 export {
@@ -67,12 +68,12 @@ export {
   type TemplateFooter,
   type TemplateHeader,
   type TemplateVariable,
-  type TemplateListResponse,
   type TemplateCreateParams,
   type TemplateRetrieveParams,
   type TemplateUpdateParams,
   type TemplateListParams,
   type TemplateDeleteParams,
+  type TemplatesTemplatesPage,
 } from './templates';
 export {
   Users,
@@ -100,7 +101,6 @@ export {
   type TemplateEventPayload,
   type WebhookEventType,
   type WebhookResponse,
-  type WebhookListResponse,
   type WebhookListEventTypesResponse,
   type WebhookListEventsResponse,
   type WebhookRotateSecretResponse,
@@ -115,4 +115,6 @@ export {
   type WebhookRotateSecretParams,
   type WebhookTestParams,
   type WebhookToggleStatusParams,
+  type WebhookResponsesWebhooksPage,
+  type WebhookListEventsResponsesWebhookEventsPage,
 } from './webhooks';

package/src/resources/templates.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 TemplatesAPI from './templates';
 import * as WebhooksAPI from './webhooks';
 import { APIPromise } from '../core/api-promise';
+import { PagePromise, TemplatesPage, type TemplatesPageParams } from '../core/pagination';
 import { buildHeaders } from '../internal/headers';
 import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
@@ -101,15 +101,18 @@ export class Templates extends APIResource {
    *
    * @example
    * ```ts
-   * const templates = await client.templates.list({
-   *   page: 0,
-   *   page_size: 0,
-   * });
+   * // Automatically fetches more pages as needed.
+   * for await (const template of client.templates.list()) {
+   *   // ...
+   * }
    * ```
    */
-  list(params: TemplateListParams, options?: RequestOptions): APIPromise<TemplateListResponse> {
-    const { 'x-profile-id': xProfileID, ...query } = params;
-    return this._client.get('/v3/templates', {
+  list(
+    params: TemplateListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<TemplatesTemplatesPage, Template> {
+    const { 'x-profile-id': xProfileID, ...query } = params ?? {};
+    return this._client.getAPIList('/v3/templates', TemplatesPage<Template>, {
       query,
       ...options,
       headers: buildHeaders([
@@ -143,6 +146,8 @@ export class Templates extends APIResource {
   }
 }
 
+export type TemplatesTemplatesPage = TemplatesPage<Template>;
+
 /**
  * Standard API response envelope for all v3 endpoints
  */
@@ -439,48 +444,6 @@ export namespace TemplateVariable {
   }
 }
 
-/**
- * Standard API response envelope for all v3 endpoints
- */
-export interface TemplateListResponse {
-  /**
-   * A paginated list of templates.
-   */
-  data?: TemplateListResponse.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 TemplateListResponse {
-  /**
-   * A paginated list of templates.
-   */
-  export interface Data {
-    /**
-     * Pagination metadata for list responses
-     */
-    pagination?: WebhooksAPI.PaginationMeta;
-
-    /**
-     * The templates on this page.
-     */
-    templates?: Array<TemplatesAPI.Template>;
-  }
-}
-
 export interface TemplateCreateParams {
   /**
    * Body param: Template category: MARKETING, UTILITY, AUTHENTICATION (optional,
@@ -589,17 +552,7 @@ export interface TemplateUpdateParams {
   'x-profile-id'?: string;
 }
 
-export interface TemplateListParams {
-  /**
-   * Query param: Page number (1-indexed)
-   */
-  page: number;
-
-  /**
-   * Query param: Number of items per page
-   */
-  page_size: number;
-
+export interface TemplateListParams extends TemplatesPageParams {
   /**
    * Query param: Optional category filter: MARKETING, UTILITY, AUTHENTICATION
    */
@@ -666,7 +619,7 @@ export declare namespace Templates {
     type TemplateFooter as TemplateFooter,
     type TemplateHeader as TemplateHeader,
     type TemplateVariable as TemplateVariable,
-    type TemplateListResponse as TemplateListResponse,
+    type TemplatesTemplatesPage as TemplatesTemplatesPage,
     type TemplateCreateParams as TemplateCreateParams,
     type TemplateRetrieveParams as TemplateRetrieveParams,
     type TemplateUpdateParams as TemplateUpdateParams,

package/src/resources/webhooks.ts

@@ -3,6 +3,13 @@
 import { APIResource } from '../core/resource';
 import * as WebhooksAPI from './webhooks';
 import { APIPromise } from '../core/api-promise';
+import {
+  PagePromise,
+  WebhookEventsPage,
+  type WebhookEventsPageParams,
+  WebhooksPage,
+  type WebhooksPageParams,
+} from '../core/pagination';
 import { buildHeaders } from '../internal/headers';
 import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
@@ -93,15 +100,18 @@ export class Webhooks extends APIResource {
    *
    * @example
    * ```ts
-   * const webhooks = await client.webhooks.list({
-   *   page: 0,
-   *   page_size: 0,
-   * });
+   * // Automatically fetches more pages as needed.
+   * for await (const webhookResponse of client.webhooks.list()) {
+   *   // ...
+   * }
    * ```
    */
-  list(params: WebhookListParams, options?: RequestOptions): APIPromise<WebhookListResponse> {
-    const { 'x-profile-id': xProfileID, ...query } = params;
-    return this._client.get('/v3/webhooks', {
+  list(
+    params: WebhookListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<WebhookResponsesWebhooksPage, WebhookResponse> {
+    const { 'x-profile-id': xProfileID, ...query } = params ?? {};
+    return this._client.getAPIList('/v3/webhooks', WebhooksPage<WebhookResponse>, {
       query,
       ...options,
       headers: buildHeaders([
@@ -163,26 +173,32 @@ export class Webhooks extends APIResource {
    *
    * @example
    * ```ts
-   * const response = await client.webhooks.listEvents(
+   * // Automatically fetches more pages as needed.
+   * for await (const webhookListEventsResponse of client.webhooks.listEvents(
    *   'd4f5a6b7-c8d9-4e0f-a1b2-c3d4e5f6a7b8',
-   *   { page: 0, page_size: 0 },
-   * );
+   * )) {
+   *   // ...
+   * }
    * ```
    */
   listEvents(
     id: string,
-    params: WebhookListEventsParams,
+    params: WebhookListEventsParams | null | undefined = {},
     options?: RequestOptions,
-  ): APIPromise<WebhookListEventsResponse> {
-    const { 'x-profile-id': xProfileID, ...query } = params;
-    return this._client.get(path`/v3/webhooks/${id}/events`, {
-      query,
-      ...options,
-      headers: buildHeaders([
-        { ...(xProfileID != null ? { 'x-profile-id': xProfileID } : undefined) },
-        options?.headers,
-      ]),
-    });
+  ): PagePromise<WebhookListEventsResponsesWebhookEventsPage, WebhookListEventsResponse> {
+    const { 'x-profile-id': xProfileID, ...query } = params ?? {};
+    return this._client.getAPIList(
+      path`/v3/webhooks/${id}/events`,
+      WebhookEventsPage<WebhookListEventsResponse>,
+      {
+        query,
+        ...options,
+        headers: buildHeaders([
+          { ...(xProfileID != null ? { 'x-profile-id': xProfileID } : undefined) },
+          options?.headers,
+        ]),
+      },
+    );
   }
 
   /**
@@ -271,6 +287,10 @@ export class Webhooks extends APIResource {
   }
 }
 
+export type WebhookResponsesWebhooksPage = WebhooksPage<WebhookResponse>;
+
+export type WebhookListEventsResponsesWebhookEventsPage = WebhookEventsPage<WebhookListEventsResponse>;
+
 /**
  * Request and response metadata
  */
@@ -707,48 +727,6 @@ export interface WebhookResponse {
   updated_at?: string | null;
 }
 
-/**
- * Standard API response envelope for all v3 endpoints
- */
-export interface WebhookListResponse {
-  /**
-   * A paginated list of webhooks.
-   */
-  data?: WebhookListResponse.Data | null;
-
-  /**
-   * Error information
-   */
-  error?: ErrorDetail | null;
-
-  /**
-   * Request and response metadata
-   */
-  meta?: APIMeta;
-
-  /**
-   * Indicates whether the request was successful
-   */
-  success?: boolean;
-}
-
-export namespace WebhookListResponse {
-  /**
-   * A paginated list of webhooks.
-   */
-  export interface Data {
-    /**
-     * Pagination metadata for list responses
-     */
-    pagination?: WebhooksAPI.PaginationMeta;
-
-    /**
-     * The webhooks on this page.
-     */
-    webhooks?: Array<WebhooksAPI.WebhookResponse>;
-  }
-}
-
 /**
  * Standard API response envelope for all v3 endpoints
  */
@@ -791,78 +769,34 @@ export namespace WebhookListEventTypesResponse {
   }
 }
 
-/**
- * Standard API response envelope for all v3 endpoints
- */
 export interface WebhookListEventsResponse {
-  /**
-   * A paginated list of webhook delivery records.
-   */
-  data?: WebhookListEventsResponse.Data | null;
+  id?: string;
 
-  /**
-   * Error information
-   */
-  error?: ErrorDetail | null;
+  created_at?: string;
 
-  /**
-   * Request and response metadata
-   */
-  meta?: APIMeta;
+  delivery_attempts?: number;
 
-  /**
-   * Indicates whether the request was successful
-   */
-  success?: boolean;
-}
+  delivery_status?: string;
+
+  error_message?: string | null;
 
-export namespace WebhookListEventsResponse {
   /**
-   * A paginated list of webhook delivery records.
+   * The exact event body that was delivered, or attempted, for this record. One of
+   * the three webhook envelopes: a message status change, an inbound message, or a
+   * template status change. Read field and event to tell which, the same way your
+   * endpoint does.
    */
-  export interface Data {
-    /**
-     * The events on this page.
-     */
-    events?: Array<Data.Event>;
-
-    /**
-     * Pagination metadata for list responses
-     */
-    pagination?: WebhooksAPI.PaginationMeta;
-  }
-
-  export namespace Data {
-    export interface Event {
-      id?: string;
-
-      created_at?: string;
-
-      delivery_attempts?: number;
-
-      delivery_status?: string;
-
-      error_message?: string | null;
-
-      /**
-       * The exact event body that was delivered, or attempted, for this record. One of
-       * the three webhook envelopes: a message status change, an inbound message, or a
-       * template status change. Read field and event to tell which, the same way your
-       * endpoint does.
-       */
-      event_data?: WebhooksAPI.MessageEvent | WebhooksAPI.InboundMessageEvent | WebhooksAPI.TemplateEvent;
+  event_data?: MessageEvent | InboundMessageEvent | TemplateEvent;
 
-      event_type?: string;
+  event_type?: string;
 
-      http_status_code?: number | null;
+  http_status_code?: number | null;
 
-      processing_completed_at?: string | null;
+  processing_completed_at?: string | null;
 
-      processing_started_at?: string | null;
+  processing_started_at?: string | null;
 
-      response_body?: string | null;
-    }
-  }
+  response_body?: string | null;
 }
 
 /**
@@ -1047,17 +981,7 @@ export interface WebhookUpdateParams {
   'x-profile-id'?: string;
 }
 
-export interface WebhookListParams {
-  /**
-   * Query param
-   */
-  page: number;
-
-  /**
-   * Query param
-   */
-  page_size: number;
-
+export interface WebhookListParams extends WebhooksPageParams {
   /**
    * Query param
    */
@@ -1092,17 +1016,7 @@ export interface WebhookListEventTypesParams {
   'x-profile-id'?: string;
 }
 
-export interface WebhookListEventsParams {
-  /**
-   * Query param
-   */
-  page: number;
-
-  /**
-   * Query param
-   */
-  page_size: number;
-
+export interface WebhookListEventsParams extends WebhookEventsPageParams {
   /**
    * Query param
    */
@@ -1207,11 +1121,12 @@ export declare namespace Webhooks {
     type TemplateEventPayload as TemplateEventPayload,
     type WebhookEventType as WebhookEventType,
     type WebhookResponse as WebhookResponse,
-    type WebhookListResponse as WebhookListResponse,
     type WebhookListEventTypesResponse as WebhookListEventTypesResponse,
     type WebhookListEventsResponse as WebhookListEventsResponse,
     type WebhookRotateSecretResponse as WebhookRotateSecretResponse,
     type WebhookTestResponse as WebhookTestResponse,
+    type WebhookResponsesWebhooksPage as WebhookResponsesWebhooksPage,
+    type WebhookListEventsResponsesWebhookEventsPage as WebhookListEventsResponsesWebhookEventsPage,
     type WebhookCreateParams as WebhookCreateParams,
     type WebhookRetrieveParams as WebhookRetrieveParams,
     type WebhookUpdateParams as WebhookUpdateParams,

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '0.37.0'; // x-release-please-version
+export const VERSION = '0.38.0'; // x-release-please-version

package/version.d.mts

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

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.37.0";
+export declare const VERSION = "0.38.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.37.0'; // x-release-please-version
+exports.VERSION = '0.38.0'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

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