telnyx 7.16.0 → 7.18.0

package/src/resources/email-inboxes/email-inboxes.ts

@@ -6,7 +6,6 @@ import {
   DraftCreateParams,
   DraftDeleteParams,
   DraftListParams,
-  DraftListResponse,
   DraftPatchParams,
   DraftRetrieveParams,
   DraftSendParams,
@@ -16,6 +15,7 @@ import {
   EmailDraft,
   EmailDraftRequest,
   EmailDraftResponse,
+  EmailDraftsEmailBracketCursorPagination,
   EmailMessage,
   EmailMessageResponse,
 } from './drafts';
@@ -29,13 +29,13 @@ import {
   FilterReplaceParams,
   FilterReplaceResponse,
   Filters,
+  InboxFilters,
   MutateInboxFiltersRequest,
 } from './filters';
 import * as MessagesAPI from './messages/messages';
 import {
   MessageDraftsParams,
   MessageListParams,
-  MessageListResponse,
   MessageUpdateParams,
   MessageUpdateResponse,
   Messages,
@@ -47,6 +47,7 @@ import {
   InboundThread,
   InboundThreadDetail,
   InboundThreadListResponse,
+  InboundThreadsEmailBracketCursorPagination,
   ThreadListParams,
   ThreadMessage,
   ThreadRetrieveParams,
@@ -54,6 +55,7 @@ import {
   Threads,
 } from './threads/threads';
 import { APIPromise } from '../../core/api-promise';
+import { EmailCursorPagination, type EmailCursorPaginationParams, PagePromise } from '../../core/pagination';
 import { buildHeaders } from '../../internal/headers';
 import { RequestOptions } from '../../internal/request-options';
 import { path } from '../../internal/utils/path';
@@ -73,14 +75,20 @@ export class EmailInboxes extends APIResource {
    *
    * @example
    * ```ts
-   * const emailInboxes = await client.emailInboxes.list();
+   * // Automatically fetches more pages as needed.
+   * for await (const emailInbox of client.emailInboxes.list()) {
+   *   // ...
+   * }
    * ```
    */
   list(
     query: EmailInboxListParams | null | undefined = {},
     options?: RequestOptions,
-  ): APIPromise<EmailInboxListResponse> {
-    return this._client.get('/email_inboxes', { query, ...options });
+  ): PagePromise<EmailInboxesEmailCursorPagination, EmailInbox> {
+    return this._client.getAPIList('/email_inboxes', EmailCursorPagination<EmailInbox>, {
+      query,
+      ...options,
+    });
   }
 
   /**
@@ -137,6 +145,8 @@ export class EmailInboxes extends APIResource {
   }
 }
 
+export type EmailInboxesEmailCursorPagination = EmailCursorPagination<EmailInbox>;
+
 export interface EmailInbox {
   id: string;
 
@@ -164,34 +174,7 @@ export interface EmailInboxResponse {
   data: EmailInbox;
 }
 
-export interface EmailInboxListResponse {
-  data: Array<EmailInbox>;
-
-  meta: EmailInboxListResponse.Meta;
-}
-
-export namespace EmailInboxListResponse {
-  export interface Meta {
-    page_size: number;
-
-    /**
-     * Cursor for the next inbox page, when more results are available.
-     */
-    page_cursor?: string;
-  }
-}
-
-export interface EmailInboxListParams {
-  /**
-   * Opaque cursor returned by the previous inbox page.
-   */
-  page_cursor?: string;
-
-  /**
-   * Number of results to return. Defaults to 20; maximum is 250.
-   */
-  page_size?: number;
-}
+export interface EmailInboxListParams extends EmailCursorPaginationParams {}
 
 export interface EmailInboxCreateParams {
   /**
@@ -217,7 +200,7 @@ export declare namespace EmailInboxes {
   export {
     type EmailInbox as EmailInbox,
     type EmailInboxResponse as EmailInboxResponse,
-    type EmailInboxListResponse as EmailInboxListResponse,
+    type EmailInboxesEmailCursorPagination as EmailInboxesEmailCursorPagination,
     type EmailInboxListParams as EmailInboxListParams,
     type EmailInboxCreateParams as EmailInboxCreateParams,
   };
@@ -230,7 +213,7 @@ export declare namespace EmailInboxes {
     type EmailDraftResponse as EmailDraftResponse,
     type EmailMessage as EmailMessage,
     type EmailMessageResponse as EmailMessageResponse,
-    type DraftListResponse as DraftListResponse,
+    type EmailDraftsEmailBracketCursorPagination as EmailDraftsEmailBracketCursorPagination,
     type DraftListParams as DraftListParams,
     type DraftCreateParams as DraftCreateParams,
     type DraftDeleteParams as DraftDeleteParams,
@@ -242,6 +225,7 @@ export declare namespace EmailInboxes {
 
   export {
     Filters as Filters,
+    type InboxFilters as InboxFilters,
     type MutateInboxFiltersRequest as MutateInboxFiltersRequest,
     type FilterListResponse as FilterListResponse,
     type FilterAddResponse as FilterAddResponse,
@@ -255,7 +239,6 @@ export declare namespace EmailInboxes {
   export {
     Messages as Messages,
     type MessageUpdateResponse as MessageUpdateResponse,
-    type MessageListResponse as MessageListResponse,
     type MessageListParams as MessageListParams,
     type MessageUpdateParams as MessageUpdateParams,
     type MessageDraftsParams as MessageDraftsParams,
@@ -270,6 +253,7 @@ export declare namespace EmailInboxes {
     type InboundThreadListResponse as InboundThreadListResponse,
     type ThreadMessage as ThreadMessage,
     type ThreadRetrieveResponse as ThreadRetrieveResponse,
+    type InboundThreadsEmailBracketCursorPagination as InboundThreadsEmailBracketCursorPagination,
     type ThreadListParams as ThreadListParams,
     type ThreadRetrieveParams as ThreadRetrieveParams,
   };

package/src/resources/email-inboxes/filters.ts

@@ -90,6 +90,14 @@ export class Filters extends APIResource {
   }
 }
 
+export interface InboxFilters {
+  allowlist: Array<string>;
+
+  blocklist: Array<string>;
+
+  record_type: 'email_inbox_filters';
+}
+
 export interface MutateInboxFiltersRequest {
   entries: Array<string>;
 
@@ -100,59 +108,19 @@ export interface MutateInboxFiltersRequest {
 }
 
 export interface FilterListResponse {
-  data: FilterListResponse.Data;
-}
-
-export namespace FilterListResponse {
-  export interface Data {
-    allowlist: Array<string>;
-
-    blocklist: Array<string>;
-
-    record_type: 'email_inbox_filters';
-  }
+  data: InboxFilters;
 }
 
 export interface FilterAddResponse {
-  data: FilterAddResponse.Data;
-}
-
-export namespace FilterAddResponse {
-  export interface Data {
-    allowlist: Array<string>;
-
-    blocklist: Array<string>;
-
-    record_type: 'email_inbox_filters';
-  }
+  data: InboxFilters;
 }
 
 export interface FilterDeleteAllResponse {
-  data: FilterDeleteAllResponse.Data;
-}
-
-export namespace FilterDeleteAllResponse {
-  export interface Data {
-    allowlist: Array<string>;
-
-    blocklist: Array<string>;
-
-    record_type: 'email_inbox_filters';
-  }
+  data: InboxFilters;
 }
 
 export interface FilterReplaceResponse {
-  data: FilterReplaceResponse.Data;
-}
-
-export namespace FilterReplaceResponse {
-  export interface Data {
-    allowlist: Array<string>;
-
-    blocklist: Array<string>;
-
-    record_type: 'email_inbox_filters';
-  }
+  data: InboxFilters;
 }
 
 export interface FilterDeleteAllParams {
@@ -181,6 +149,7 @@ export interface FilterReplaceParams {
 
 export declare namespace Filters {
   export {
+    type InboxFilters as InboxFilters,
     type MutateInboxFiltersRequest as MutateInboxFiltersRequest,
     type FilterListResponse as FilterListResponse,
     type FilterAddResponse as FilterAddResponse,

package/src/resources/email-inboxes/index.ts

@@ -8,7 +8,6 @@ export {
   type EmailDraftResponse,
   type EmailMessage,
   type EmailMessageResponse,
-  type DraftListResponse,
   type DraftListParams,
   type DraftCreateParams,
   type DraftDeleteParams,
@@ -16,17 +15,20 @@ export {
   type DraftUpdateParams,
   type DraftPatchParams,
   type DraftSendParams,
+  type EmailMessagesEmailCursorPagination,
+  type EmailDraftsEmailBracketCursorPagination,
 } from './drafts';
 export {
   EmailInboxes,
   type EmailInbox,
   type EmailInboxResponse,
-  type EmailInboxListResponse,
   type EmailInboxListParams,
   type EmailInboxCreateParams,
+  type EmailInboxesEmailCursorPagination,
 } from './email-inboxes';
 export {
   Filters,
+  type InboxFilters,
   type MutateInboxFiltersRequest,
   type FilterListResponse,
   type FilterAddResponse,
@@ -39,7 +41,6 @@ export {
 export {
   Messages,
   type MessageUpdateResponse,
-  type MessageListResponse,
   type MessageListParams,
   type MessageUpdateParams,
   type MessageDraftsParams,
@@ -55,4 +56,5 @@ export {
   type ThreadRetrieveResponse,
   type ThreadListParams,
   type ThreadRetrieveParams,
+  type InboundThreadsEmailBracketCursorPagination,
 } from './threads/index';

package/src/resources/email-inboxes/messages/actions.ts

@@ -123,10 +123,10 @@ export class Actions extends APIResource {
  * Email address accepted by inbox message actions, as a string or an object with
  * `email` and optional `name`.
  */
-export type InboxActionEmailAddressInput = string | InboxActionEmailAddressInput.UnionMember1;
+export type InboxActionEmailAddressInput = string | InboxActionEmailAddressInput.InboxRecipientAddress;
 
 export namespace InboxActionEmailAddressInput {
-  export interface UnionMember1 {
+  export interface InboxRecipientAddress {
     email: string;
 
     name?: string;
@@ -139,11 +139,11 @@ export namespace InboxActionEmailAddressInput {
  */
 export type InboxActionRecipientInput =
   | string
-  | InboxActionRecipientInput.UnionMember1
+  | InboxActionRecipientInput.InboxRecipientAddress
   | Array<InboxActionEmailAddressInput>;
 
 export namespace InboxActionRecipientInput {
-  export interface UnionMember1 {
+  export interface InboxRecipientAddress {
     email: string;
 
     name?: string;
@@ -177,7 +177,7 @@ export interface ActionForwardParams {
    * Body param: One recipient or a non-empty recipient array. Each recipient may be
    * an email string or an object with `email` and optional `name`.
    */
-  to: string | ActionForwardParams.UnionMember1 | Array<InboxActionEmailAddressInput>;
+  to: string | ActionForwardParams.InboxRecipientAddress | Array<InboxActionEmailAddressInput>;
 
   /**
    * Body param: One recipient or a recipient array. Each recipient may be an email
@@ -205,7 +205,7 @@ export interface ActionForwardParams {
 }
 
 export namespace ActionForwardParams {
-  export interface UnionMember1 {
+  export interface InboxRecipientAddress {
     email: string;
 
     name?: string;

package/src/resources/email-inboxes/messages/index.ts

@@ -20,7 +20,6 @@ export {
 export {
   Messages,
   type MessageUpdateResponse,
-  type MessageListResponse,
   type MessageListParams,
   type MessageUpdateParams,
   type MessageDraftsParams,

package/src/resources/email-inboxes/messages/messages.ts

@@ -2,6 +2,7 @@
 
 import { APIResource } from '../../../core/resource';
 import * as WebhooksAPI from '../../webhooks';
+import { InboundMessagesEmailBracketCursorPagination } from '../../webhooks';
 import * as DraftsAPI from '../drafts';
 import * as EmailMessagesAPI from '../../email-messages/email-messages';
 import * as ActionsAPI from './actions';
@@ -23,8 +24,12 @@ import {
   LabelMutationRequest,
   Labels,
 } from './labels';
-import * as ThreadsAPI from '../threads/threads';
 import { APIPromise } from '../../../core/api-promise';
+import {
+  EmailBracketCursorPagination,
+  type EmailBracketCursorPaginationParams,
+  PagePromise,
+} from '../../../core/pagination';
 import { RequestOptions } from '../../../internal/request-options';
 import { path } from '../../../internal/utils/path';
 
@@ -39,17 +44,24 @@ export class Messages extends APIResource {
    *
    * @example
    * ```ts
-   * const messages = await client.emailInboxes.messages.list(
+   * // Automatically fetches more pages as needed.
+   * for await (const inboundMessage of client.emailInboxes.messages.list(
    *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
-   * );
+   * )) {
+   *   // ...
+   * }
    * ```
    */
   list(
     inboxID: string,
     query: MessageListParams | null | undefined = {},
     options?: RequestOptions,
-  ): APIPromise<MessageListResponse> {
-    return this._client.get(path`/email_inboxes/${inboxID}/messages`, { query, ...options });
+  ): PagePromise<InboundMessagesEmailBracketCursorPagination, WebhooksAPI.InboundMessage> {
+    return this._client.getAPIList(
+      path`/email_inboxes/${inboxID}/messages`,
+      EmailBracketCursorPagination<WebhooksAPI.InboundMessage>,
+      { query, ...options },
+    );
   }
 
   /**
@@ -119,13 +131,7 @@ export interface MessageUpdateResponse {
   data: WebhooksAPI.InboundMessage;
 }
 
-export interface MessageListResponse {
-  data: Array<WebhooksAPI.InboundMessage>;
-
-  meta: ThreadsAPI.EmailPaginationMeta;
-}
-
-export interface MessageListParams {
+export interface MessageListParams extends EmailBracketCursorPaginationParams {
   /**
    * Case-insensitive literal substring of the sender address.
    */
@@ -168,16 +174,6 @@ export interface MessageListParams {
    * messages.
    */
   'filter[unread]'?: boolean;
-
-  /**
-   * Opaque cursor returned by the previous page.
-   */
-  'page[after]'?: string;
-
-  /**
-   * Number of results to return. Defaults to 25; maximum is 100.
-   */
-  'page[size]'?: number;
 }
 
 export interface MessageUpdateParams {
@@ -187,10 +183,9 @@ export interface MessageUpdateParams {
   inbox_id: string;
 
   /**
-   * Body param: Set to `true` for server time, an ISO 8601 timestamp for an explicit
-   * read time, or `null` to mark unread.
+   * Body param
    */
-  read_at: true | null | string;
+  read_at: true | string;
 }
 
 export interface MessageDraftsParams {
@@ -202,7 +197,7 @@ export interface MessageDraftsParams {
   /**
    * Body param
    */
-  attachments?: Array<unknown>;
+  attachments?: Array<{ [key: string]: unknown }>;
 
   /**
    * Body param
@@ -247,7 +242,7 @@ export interface MessageDraftsParams {
   /**
    * Body param
    */
-  metadata?: unknown;
+  metadata?: { [key: string]: unknown };
 
   /**
    * Body param
@@ -286,7 +281,6 @@ Messages.Labels = Labels;
 export declare namespace Messages {
   export {
     type MessageUpdateResponse as MessageUpdateResponse,
-    type MessageListResponse as MessageListResponse,
     type MessageListParams as MessageListParams,
     type MessageUpdateParams as MessageUpdateParams,
     type MessageDraftsParams as MessageDraftsParams,
@@ -311,3 +305,5 @@ export declare namespace Messages {
     type LabelCreateParams as LabelCreateParams,
   };
 }
+
+export { type InboundMessagesEmailBracketCursorPagination };

package/src/resources/email-inboxes/threads/index.ts

@@ -18,4 +18,5 @@ export {
   type ThreadRetrieveResponse,
   type ThreadListParams,
   type ThreadRetrieveParams,
+  type InboundThreadsEmailBracketCursorPagination,
 } from './threads';

package/src/resources/email-inboxes/threads/threads.ts

@@ -10,6 +10,11 @@ import {
   Labels,
 } from './labels';
 import { APIPromise } from '../../../core/api-promise';
+import {
+  EmailBracketCursorPagination,
+  type EmailBracketCursorPaginationParams,
+  PagePromise,
+} from '../../../core/pagination';
 import { RequestOptions } from '../../../internal/request-options';
 import { path } from '../../../internal/utils/path';
 
@@ -24,18 +29,24 @@ export class Threads extends APIResource {
    *
    * @example
    * ```ts
-   * const inboundThreadListResponse =
-   *   await client.emailInboxes.threads.list(
-   *     '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
-   *   );
+   * // Automatically fetches more pages as needed.
+   * for await (const inboundThread of client.emailInboxes.threads.list(
+   *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   * )) {
+   *   // ...
+   * }
    * ```
    */
   list(
     inboxID: string,
     query: ThreadListParams | null | undefined = {},
     options?: RequestOptions,
-  ): APIPromise<InboundThreadListResponse> {
-    return this._client.get(path`/email_inboxes/${inboxID}/threads`, { query, ...options });
+  ): PagePromise<InboundThreadsEmailBracketCursorPagination, InboundThread> {
+    return this._client.getAPIList(
+      path`/email_inboxes/${inboxID}/threads`,
+      EmailBracketCursorPagination<InboundThread>,
+      { query, ...options },
+    );
   }
 
   /**
@@ -60,6 +71,8 @@ export class Threads extends APIResource {
   }
 }
 
+export type InboundThreadsEmailBracketCursorPagination = EmailBracketCursorPagination<InboundThread>;
+
 export interface EmailPaginationMeta {
   page_size: number;
 
@@ -231,22 +244,12 @@ export interface ThreadRetrieveResponse {
   meta: EmailPaginationMeta;
 }
 
-export interface ThreadListParams {
+export interface ThreadListParams extends EmailBracketCursorPaginationParams {
   /**
    * Returns only threads carrying this label. Thread labels are independent of the
    * labels on the thread's messages.
    */
   'filter[label]'?: string;
-
-  /**
-   * Opaque cursor returned by the previous page.
-   */
-  'page[after]'?: string;
-
-  /**
-   * Number of results to return. Defaults to 25; maximum is 100.
-   */
-  'page[size]'?: number;
 }
 
 export interface ThreadRetrieveParams {
@@ -278,6 +281,7 @@ export declare namespace Threads {
     type InboundThreadListResponse as InboundThreadListResponse,
     type ThreadMessage as ThreadMessage,
     type ThreadRetrieveResponse as ThreadRetrieveResponse,
+    type InboundThreadsEmailBracketCursorPagination as InboundThreadsEmailBracketCursorPagination,
     type ThreadListParams as ThreadListParams,
     type ThreadRetrieveParams as ThreadRetrieveParams,
   };