telnyx 7.16.0 → 7.18.0

package/src/resources/email-blocks/{import.ts → imports.ts}

@@ -10,7 +10,7 @@ import { path } from '../../internal/utils/path';
 /**
  * Async CSV import of competitor suppression lists.
  */
-export class Import extends APIResource {
+export class Imports extends APIResource {
   /**
    * Accepts `multipart/form-data` with a `file` field (the CSV) and an optional
    * `block_ttl_days` (integer >0, default 30). Validates:
@@ -27,7 +27,7 @@ export class Import extends APIResource {
    * @example
    * ```ts
    * const emailBlockImportResponse =
-   *   await client.emailBlocks.import.create({
+   *   await client.emailBlocks.imports.create({
    *     file: fs.createReadStream('path/to/file'),
    *     block_ttl_days: 30,
    *   });
@@ -50,7 +50,7 @@ export class Import extends APIResource {
    * @example
    * ```ts
    * const emailBlockImportResponse =
-   *   await client.emailBlocks.import.retrieve(
+   *   await client.emailBlocks.imports.retrieve(
    *     '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
    *   );
    * ```
@@ -60,83 +60,81 @@ export class Import extends APIResource {
   }
 }
 
-export interface EmailBlockImportResponse {
+/**
+ * Import job. Schema fields hidden: `account_id`, `csv_content`, `block_ttl_days`.
+ * Nullable fields use the omit-nullable pattern.
+ */
+export interface EmailBlockImport {
+  id: string;
+
+  created_at: string;
+
   /**
-   * Import job. Schema fields hidden: `account_id`, `csv_content`, `block_ttl_days`.
-   * Nullable fields use the omit-nullable pattern.
+   * View-only.
+   */
+  record_type: 'email_block_import';
+
+  status: 'pending' | 'processing' | 'completed' | 'failed';
+
+  /**
+   * Data-row count at upload.
+   */
+  total: number;
+
+  updated_at: string;
+
+  /**
+   * Omitted until terminal success.
+   */
+  completed_at?: string;
+
+  /**
+   * Only when `status == completed`.
+   */
+  created_count?: number;
+
+  /**
+   * Only when `status == completed`.
    */
-  data: EmailBlockImportResponse.Data;
+  error_count?: number;
+
+  /**
+   * `{row_number: reason}`; only rendered when non-empty.
+   */
+  errors?: { [key: string]: string };
+
+  /**
+   * Only when `status == completed`.
+   */
+  existing_count?: number;
+
+  /**
+   * Only on terminal failure.
+   */
+  failure_reason?: string;
+
+  /**
+   * Only when `status == completed`.
+   */
+  processed_rows?: number;
+
+  /**
+   * Omitted when nil.
+   */
+  provider?: 'sendgrid' | 'mailgun' | 'ses' | 'generic';
+
+  /**
+   * Only when `status == completed`.
+   */
+  skipped_count?: number;
 }
 
-export namespace EmailBlockImportResponse {
+export interface EmailBlockImportResponse {
   /**
    * Import job. Schema fields hidden: `account_id`, `csv_content`, `block_ttl_days`.
    * Nullable fields use the omit-nullable pattern.
    */
-  export interface Data {
-    id: string;
-
-    created_at: string;
-
-    /**
-     * View-only.
-     */
-    record_type: 'email_block_import';
-
-    status: 'pending' | 'processing' | 'completed' | 'failed';
-
-    /**
-     * Data-row count at upload.
-     */
-    total: number;
-
-    updated_at: string;
-
-    /**
-     * Omitted until terminal success.
-     */
-    completed_at?: string;
-
-    /**
-     * Only when `status == completed`.
-     */
-    created_count?: number;
-
-    /**
-     * Only when `status == completed`.
-     */
-    error_count?: number;
-
-    /**
-     * `{row_number: reason}`; only rendered when non-empty.
-     */
-    errors?: { [key: string]: string };
-
-    /**
-     * Only when `status == completed`.
-     */
-    existing_count?: number;
-
-    /**
-     * Only on terminal failure.
-     */
-    failure_reason?: string;
-
-    /**
-     * Only when `status == completed`.
-     */
-    processed_rows?: number;
-
-    /**
-     * Omitted when nil.
-     */
-    provider?: 'sendgrid' | 'mailgun' | 'ses' | 'generic';
-
-    /**
-     * Only when `status == completed`.
-     */
-    skipped_count?: number;
-  }
+  data: EmailBlockImport;
 }
 
 export interface ImportCreateParams {
@@ -152,8 +150,9 @@ export interface ImportCreateParams {
   block_ttl_days?: number;
 }
 
-export declare namespace Import {
+export declare namespace Imports {
   export {
+    type EmailBlockImport as EmailBlockImport,
     type EmailBlockImportResponse as EmailBlockImportResponse,
     type ImportCreateParams as ImportCreateParams,
   };

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

@@ -12,5 +12,11 @@ export {
   type EmailBlockRetrieveExportParams,
   type EmailBlockRetrieveEventsParams,
   type EmailBlocksDefaultFlatPagination,
+  type EmailBlockRetrieveEventsResponsesDefaultFlatPagination,
 } from './email-blocks';
-export { Import, type EmailBlockImportResponse, type ImportCreateParams } from './import';
+export {
+  Imports,
+  type EmailBlockImport,
+  type EmailBlockImportResponse,
+  type ImportCreateParams,
+} from './imports';

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

@@ -412,12 +412,25 @@ export interface EmailDomainListParams extends DefaultFlatPaginationParams {
    */
   'filter[profile_id]'?: string;
 
+  /**
+   * Filter domains by verification status: pending, verifying, verified, failed,
+   * degraded, or suspended.
+   */
   'filter[status]'?: EmailDomainStatus;
 
+  /**
+   * Filter domains by type: custom, shared, or shared_inbound.
+   */
   'filter[type]'?: EmailDomainType;
 
+  /**
+   * Filter domains by whether they can currently receive inbound email.
+   */
   'filter[usable_for_inbound]'?: boolean;
 
+  /**
+   * Filter domains by whether they can currently be used to send email.
+   */
   'filter[usable_for_sending]'?: boolean;
 
   /**

package/src/resources/email-events.ts

@@ -4,6 +4,7 @@ import { APIResource } from '../core/resource';
 import * as EmailEventsAPI from './email-events';
 import * as DraftsAPI from './email-inboxes/drafts';
 import { APIPromise } from '../core/api-promise';
+import { EmailCursorPagination, type EmailCursorPaginationParams, PagePromise } from '../core/pagination';
 import { RequestOptions } from '../internal/request-options';
 
 /**
@@ -17,8 +18,11 @@ export class EmailEvents extends APIResource {
   list(
     query: EmailEventListParams | null | undefined = {},
     options?: RequestOptions,
-  ): APIPromise<EmailEventListResponse> {
-    return this._client.get('/email_events', { query, ...options });
+  ): PagePromise<EmailEventListResponsesEmailCursorPagination, EmailEventListResponse> {
+    return this._client.getAPIList('/email_events', EmailCursorPagination<EmailEventListResponse>, {
+      query,
+      ...options,
+    });
   }
 
   /**
@@ -33,6 +37,8 @@ export class EmailEvents extends APIResource {
   }
 }
 
+export type EmailEventListResponsesEmailCursorPagination = EmailCursorPagination<EmailEventListResponse>;
+
 export type EmailEventType =
   | 'queued'
   | 'deferred'
@@ -58,57 +64,38 @@ export interface TimeRange {
 }
 
 export interface EmailEventListResponse {
-  data: Array<EmailEventListResponse.Data>;
-
-  meta: EmailEventListResponse.Meta;
-}
-
-export namespace EmailEventListResponse {
-  export interface Data {
-    id: string;
-
-    email_id: string;
-
-    occurred_at: string;
+  id: string;
 
-    record_type: 'email_event';
+  email_id: string;
 
-    type: EmailEventsAPI.EmailEventType;
+  occurred_at: string;
 
-    /**
-     * Summary of the associated email message. Present when the email_message preload
-     * is available.
-     */
-    email?: Data.Email;
-
-    payload?: { [key: string]: unknown };
-  }
+  record_type: 'email_event';
 
-  export namespace Data {
-    /**
-     * Summary of the associated email message. Present when the email_message preload
-     * is available.
-     */
-    export interface Email {
-      cc: Array<DraftsAPI.EmailAddress>;
+  type: EmailEventType;
 
-      from: DraftsAPI.EmailAddress;
+  /**
+   * Summary of the associated email message. Present when the email_message preload
+   * is available.
+   */
+  email?: EmailEventListResponse.Email;
 
-      subject: string;
+  payload?: { [key: string]: unknown };
+}
 
-      to: Array<DraftsAPI.EmailAddress>;
-    }
-  }
+export namespace EmailEventListResponse {
+  /**
+   * Summary of the associated email message. Present when the email_message preload
+   * is available.
+   */
+  export interface Email {
+    cc: Array<DraftsAPI.EmailAddress>;
 
-  export interface Meta {
-    page_size: number;
+    from: DraftsAPI.EmailAddress;
 
-    time_range: EmailEventsAPI.TimeRange;
+    subject: string;
 
-    /**
-     * Cursor for the next page, when more results are available.
-     */
-    page_cursor?: string;
+    to: Array<DraftsAPI.EmailAddress>;
   }
 }
 
@@ -207,7 +194,7 @@ export namespace EmailEventRetrieveStatsResponse {
   }
 }
 
-export interface EmailEventListParams {
+export interface EmailEventListParams extends EmailCursorPaginationParams {
   /**
    * Filter events for a specific email message UUID. Invalid UUID values are
    * silently ignored (no filter applied).
@@ -226,17 +213,6 @@ export interface EmailEventListParams {
    */
   from?: string;
 
-  /**
-   * Opaque URL-safe Base64 cursor returned by a previous list response.
-   */
-  page_cursor?: string;
-
-  /**
-   * Number of results to return. Defaults to 25; maximum is 100. Invalid values are
-   * clamped to the valid range.
-   */
-  page_size?: number;
-
   /**
    * Inclusive ISO 8601 end timestamp. When `from` is provided without `to`, defaults
    * to `from + 30 days`.
@@ -263,6 +239,7 @@ export declare namespace EmailEvents {
     type TimeRange as TimeRange,
     type EmailEventListResponse as EmailEventListResponse,
     type EmailEventRetrieveStatsResponse as EmailEventRetrieveStatsResponse,
+    type EmailEventListResponsesEmailCursorPagination as EmailEventListResponsesEmailCursorPagination,
     type EmailEventListParams as EmailEventListParams,
     type EmailEventRetrieveStatsParams as EmailEventRetrieveStatsParams,
   };

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

@@ -2,8 +2,13 @@
 
 import { APIResource } from '../../core/resource';
 import * as EmailMessagesAPI from '../email-messages/email-messages';
-import * as ThreadsAPI from './threads/threads';
 import { APIPromise } from '../../core/api-promise';
+import {
+  EmailBracketCursorPagination,
+  type EmailBracketCursorPaginationParams,
+  EmailCursorPagination,
+  PagePromise,
+} from '../../core/pagination';
 import { buildHeaders } from '../../internal/headers';
 import { RequestOptions } from '../../internal/request-options';
 import { path } from '../../internal/utils/path';
@@ -18,17 +23,24 @@ export class Drafts extends APIResource {
    *
    * @example
    * ```ts
-   * const drafts = await client.emailInboxes.drafts.list(
+   * // Automatically fetches more pages as needed.
+   * for await (const emailDraft of client.emailInboxes.drafts.list(
    *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
-   * );
+   * )) {
+   *   // ...
+   * }
    * ```
    */
   list(
     inboxID: string,
     query: DraftListParams | null | undefined = {},
     options?: RequestOptions,
-  ): APIPromise<DraftListResponse> {
-    return this._client.get(path`/email_inboxes/${inboxID}/drafts`, { query, ...options });
+  ): PagePromise<EmailDraftsEmailBracketCursorPagination, EmailDraft> {
+    return this._client.getAPIList(
+      path`/email_inboxes/${inboxID}/drafts`,
+      EmailBracketCursorPagination<EmailDraft>,
+      { query, ...options },
+    );
   }
 
   /**
@@ -187,6 +199,10 @@ export class Drafts extends APIResource {
   }
 }
 
+export type EmailDraftsEmailBracketCursorPagination = EmailBracketCursorPagination<EmailDraft>;
+
+export type EmailMessagesEmailCursorPagination = EmailCursorPagination<EmailMessage>;
+
 export interface EmailAddress {
   email: string;
 
@@ -209,7 +225,7 @@ export interface EmailDraft {
    */
   status: 'draft' | 'sending' | 'sent';
 
-  attachments?: Array<unknown>;
+  attachments?: Array<{ [key: string]: unknown }>;
 
   bcc?: Array<EmailAddress>;
 
@@ -239,7 +255,7 @@ export interface EmailDraft {
   /**
    * Arbitrary customer-defined metadata.
    */
-  metadata?: unknown;
+  metadata?: { [key: string]: unknown };
 
   reply_to?: string | null;
 
@@ -281,7 +297,7 @@ export interface EmailDraft {
  * `thread_id` are server-owned and ignored if supplied.
  */
 export interface EmailDraftRequest {
-  attachments?: Array<unknown>;
+  attachments?: Array<{ [key: string]: unknown }>;
 
   bcc?: Array<EmailMessagesAPI.EmailAddressInput>;
 
@@ -302,7 +318,7 @@ export interface EmailDraftRequest {
 
   labels?: Array<string>;
 
-  metadata?: unknown;
+  metadata?: { [key: string]: unknown };
 
   reply_to?: string;
 
@@ -445,58 +461,18 @@ export interface EmailMessageResponse {
    * Recipients removed by suppression checks when at least one recipient remains and
    * the message is accepted.
    */
-  suppressed?: Array<EmailMessageResponse.Suppressed>;
-}
-
-export namespace EmailMessageResponse {
-  export interface Suppressed {
-    /**
-     * Whether an authorized send may override this suppression.
-     */
-    override_allowed: boolean;
-
-    /**
-     * Suppression reason returned by the recipient suppression service.
-     */
-    reason: string;
-
-    /**
-     * Scope at which the suppression applies.
-     */
-    scope: string;
-
-    /**
-     * Suppressed recipient email address.
-     */
-    to: string;
-  }
-}
-
-export interface DraftListResponse {
-  data: Array<EmailDraft>;
-
-  meta: ThreadsAPI.EmailPaginationMeta;
+  suppressed?: Array<EmailMessagesAPI.SuppressedRecipient>;
 }
 
-export interface DraftListParams {
+export interface DraftListParams extends EmailBracketCursorPaginationParams {
   /**
    * Restrict results to drafts in this state.
    */
   'filter[status]'?: 'draft' | 'sending' | 'sent';
-
-  /**
-   * 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 DraftCreateParams {
-  attachments?: Array<unknown>;
+  attachments?: Array<{ [key: string]: unknown }>;
 
   bcc?: Array<EmailMessagesAPI.EmailAddressInput>;
 
@@ -517,7 +493,7 @@ export interface DraftCreateParams {
 
   labels?: Array<string>;
 
-  metadata?: unknown;
+  metadata?: { [key: string]: unknown };
 
   reply_to?: string;
 
@@ -558,7 +534,7 @@ export interface DraftUpdateParams {
   /**
    * Body param
    */
-  attachments?: Array<unknown>;
+  attachments?: Array<{ [key: string]: unknown }>;
 
   /**
    * Body param
@@ -603,7 +579,7 @@ export interface DraftUpdateParams {
   /**
    * Body param
    */
-  metadata?: unknown;
+  metadata?: { [key: string]: unknown };
 
   /**
    * Body param
@@ -645,7 +621,7 @@ export interface DraftPatchParams {
   /**
    * Body param
    */
-  attachments?: Array<unknown>;
+  attachments?: Array<{ [key: string]: unknown }>;
 
   /**
    * Body param
@@ -690,7 +666,7 @@ export interface DraftPatchParams {
   /**
    * Body param
    */
-  metadata?: unknown;
+  metadata?: { [key: string]: unknown };
 
   /**
    * Body param
@@ -738,7 +714,7 @@ export declare namespace Drafts {
     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,