telnyx 7.16.0 → 7.18.0

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

@@ -4,17 +4,18 @@ import { APIResource } from '../../core/resource';
 import * as EmailMessagesAPI from './email-messages';
 import * as EmailEventsAPI from '../email-events';
 import * as DraftsAPI from '../email-inboxes/drafts';
+import { EmailMessagesEmailCursorPagination } from '../email-inboxes/drafts';
 import * as RecipientsAPI from './recipients';
 import {
   EmailRecipient,
+  EmailRecipientsEmailCursorPagination,
   RecipientListParams,
-  RecipientListResponse,
   RecipientRetrieveParams,
   RecipientRetrieveResponse,
   Recipients,
 } from './recipients';
-import * as ThreadsAPI from '../email-inboxes/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';
@@ -55,14 +56,20 @@ export class EmailMessages extends APIResource {
    *
    * @example
    * ```ts
-   * const emailMessages = await client.emailMessages.list();
+   * // Automatically fetches more pages as needed.
+   * for await (const emailMessage of client.emailMessages.list()) {
+   *   // ...
+   * }
    * ```
    */
   list(
     query: EmailMessageListParams | null | undefined = {},
     options?: RequestOptions,
-  ): APIPromise<EmailMessageListResponse> {
-    return this._client.get('/email_messages', { query, ...options });
+  ): PagePromise<EmailMessagesEmailCursorPagination, DraftsAPI.EmailMessage> {
+    return this._client.getAPIList('/email_messages', EmailCursorPagination<DraftsAPI.EmailMessage>, {
+      query,
+      ...options,
+    });
   }
 
   /**
@@ -143,17 +150,24 @@ export class EmailMessages extends APIResource {
    *
    * @example
    * ```ts
-   * const response = await client.emailMessages.retrieveEvents(
+   * // Automatically fetches more pages as needed.
+   * for await (const messageEvent of client.emailMessages.retrieveEvents(
    *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
-   * );
+   * )) {
+   *   // ...
+   * }
    * ```
    */
   retrieveEvents(
     emailID: string,
     query: EmailMessageRetrieveEventsParams | null | undefined = {},
     options?: RequestOptions,
-  ): APIPromise<EmailMessageRetrieveEventsResponse> {
-    return this._client.get(path`/email_messages/${emailID}/events`, { query, ...options });
+  ): PagePromise<MessageEventsEmailCursorPagination, MessageEvent> {
+    return this._client.getAPIList(
+      path`/email_messages/${emailID}/events`,
+      EmailCursorPagination<MessageEvent>,
+      { query, ...options },
+    );
   }
 
   /**
@@ -208,6 +222,8 @@ export class EmailMessages extends APIResource {
   }
 }
 
+export type MessageEventsEmailCursorPagination = EmailCursorPagination<MessageEvent>;
+
 export interface AttachmentRequest {
   /**
    * Attachment content, typically Base64-encoded. Defaults to empty string when
@@ -246,6 +262,28 @@ export interface MessageEvent {
   payload?: { [key: string]: unknown };
 }
 
+export interface SuppressedRecipient {
+  /**
+   * 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;
+}
+
 /**
  * Per-send open and click tracking overrides. Omitted properties inherit the
  * sender domain's tracking settings.
@@ -280,12 +318,6 @@ export namespace EmailMessageRetrieveResponse {
   }
 }
 
-export interface EmailMessageListResponse {
-  data: Array<DraftsAPI.EmailMessage>;
-
-  meta: ThreadsAPI.EmailPaginationMeta;
-}
-
 export interface EmailMessageBatchResponse {
   data: Array<DraftsAPI.EmailMessage>;
 
@@ -325,12 +357,6 @@ export namespace EmailMessageBatchResponse {
   }
 }
 
-export interface EmailMessageRetrieveEventsResponse {
-  data: Array<MessageEvent>;
-
-  meta: ThreadsAPI.EmailPaginationMeta;
-}
-
 export interface EmailMessageDeleteAllParams {
   /**
    * Sender or recipient address to delete. Matching is trimmed and case-insensitive.
@@ -338,18 +364,7 @@ export interface EmailMessageDeleteAllParams {
   address: string;
 }
 
-export interface EmailMessageListParams {
-  /**
-   * 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;
-}
+export interface EmailMessageListParams extends EmailCursorPaginationParams {}
 
 export interface EmailMessageCreateParams {
   /**
@@ -477,7 +492,7 @@ export interface EmailMessageCreateParams {
   scheduled_at?: string | null;
 
   /**
-   * @deprecated Body param: Deprecated alias for `scheduled_at`.
+   * @deprecated Use scheduled_at instead.
    */
   send_at?: string;
 
@@ -630,7 +645,7 @@ export namespace EmailMessageBatchParams {
     scheduled_at?: string | null;
 
     /**
-     * @deprecated Deprecated alias for `scheduled_at`.
+     * @deprecated Use scheduled_at instead.
      */
     send_at?: string;
 
@@ -670,18 +685,7 @@ export namespace EmailMessageBatchParams {
   }
 }
 
-export interface EmailMessageRetrieveEventsParams {
-  /**
-   * 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;
-}
+export interface EmailMessageRetrieveEventsParams extends EmailCursorPaginationParams {}
 
 EmailMessages.Recipients = Recipients;
 
@@ -690,11 +694,11 @@ export declare namespace EmailMessages {
     type AttachmentRequest as AttachmentRequest,
     type EmailAddressInput as EmailAddressInput,
     type MessageEvent as MessageEvent,
+    type SuppressedRecipient as SuppressedRecipient,
     type TrackingSettings as TrackingSettings,
     type EmailMessageRetrieveResponse as EmailMessageRetrieveResponse,
-    type EmailMessageListResponse as EmailMessageListResponse,
     type EmailMessageBatchResponse as EmailMessageBatchResponse,
-    type EmailMessageRetrieveEventsResponse as EmailMessageRetrieveEventsResponse,
+    type MessageEventsEmailCursorPagination as MessageEventsEmailCursorPagination,
     type EmailMessageDeleteAllParams as EmailMessageDeleteAllParams,
     type EmailMessageListParams as EmailMessageListParams,
     type EmailMessageCreateParams as EmailMessageCreateParams,
@@ -706,8 +710,10 @@ export declare namespace EmailMessages {
     Recipients as Recipients,
     type EmailRecipient as EmailRecipient,
     type RecipientRetrieveResponse as RecipientRetrieveResponse,
-    type RecipientListResponse as RecipientListResponse,
+    type EmailRecipientsEmailCursorPagination as EmailRecipientsEmailCursorPagination,
     type RecipientListParams as RecipientListParams,
     type RecipientRetrieveParams as RecipientRetrieveParams,
   };
 }
+
+export { type EmailMessagesEmailCursorPagination };

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

@@ -5,22 +5,22 @@ export {
   type AttachmentRequest,
   type EmailAddressInput,
   type MessageEvent,
+  type SuppressedRecipient,
   type TrackingSettings,
   type EmailMessageRetrieveResponse,
-  type EmailMessageListResponse,
   type EmailMessageBatchResponse,
-  type EmailMessageRetrieveEventsResponse,
   type EmailMessageDeleteAllParams,
   type EmailMessageListParams,
   type EmailMessageCreateParams,
   type EmailMessageBatchParams,
   type EmailMessageRetrieveEventsParams,
+  type MessageEventsEmailCursorPagination,
 } from './email-messages';
 export {
   Recipients,
   type EmailRecipient,
   type RecipientRetrieveResponse,
-  type RecipientListResponse,
   type RecipientListParams,
   type RecipientRetrieveParams,
+  type EmailRecipientsEmailCursorPagination,
 } from './recipients';

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

@@ -2,6 +2,7 @@
 
 import { APIResource } from '../../core/resource';
 import { APIPromise } from '../../core/api-promise';
+import { EmailCursorPagination, type EmailCursorPaginationParams, PagePromise } from '../../core/pagination';
 import { RequestOptions } from '../../internal/request-options';
 import { path } from '../../internal/utils/path';
 
@@ -17,18 +18,24 @@ export class Recipients extends APIResource {
    *
    * @example
    * ```ts
-   * const recipients =
-   *   await client.emailMessages.recipients.list(
-   *     '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
-   *   );
+   * // Automatically fetches more pages as needed.
+   * for await (const emailRecipient of client.emailMessages.recipients.list(
+   *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   * )) {
+   *   // ...
+   * }
    * ```
    */
   list(
     emailID: string,
     query: RecipientListParams | null | undefined = {},
     options?: RequestOptions,
-  ): APIPromise<RecipientListResponse> {
-    return this._client.get(path`/email_messages/${emailID}/recipients`, { query, ...options });
+  ): PagePromise<EmailRecipientsEmailCursorPagination, EmailRecipient> {
+    return this._client.getAPIList(
+      path`/email_messages/${emailID}/recipients`,
+      EmailCursorPagination<EmailRecipient>,
+      { query, ...options },
+    );
   }
 
   /**
@@ -55,6 +62,8 @@ export class Recipients extends APIResource {
   }
 }
 
+export type EmailRecipientsEmailCursorPagination = EmailCursorPagination<EmailRecipient>;
+
 export interface EmailRecipient {
   /**
    * Recipient UUID.
@@ -115,40 +124,12 @@ export interface RecipientRetrieveResponse {
   data: EmailRecipient;
 }
 
-export interface RecipientListResponse {
-  data: Array<EmailRecipient>;
-
-  meta: RecipientListResponse.Meta;
-}
-
-export namespace RecipientListResponse {
-  export interface Meta {
-    page_size: number;
-
-    /**
-     * Cursor for the next page. Absent when there are no more results.
-     */
-    page_cursor?: string | null;
-  }
-}
-
-export interface RecipientListParams {
+export interface RecipientListParams extends EmailCursorPaginationParams {
   /**
    * Filter recipients by address kind.
    */
   kind?: 'to' | 'cc' | 'bcc';
 
-  /**
-   * 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;
-
   /**
    * Filter recipients by status.
    */
@@ -175,7 +156,7 @@ export declare namespace Recipients {
   export {
     type EmailRecipient as EmailRecipient,
     type RecipientRetrieveResponse as RecipientRetrieveResponse,
-    type RecipientListResponse as RecipientListResponse,
+    type EmailRecipientsEmailCursorPagination as EmailRecipientsEmailCursorPagination,
     type RecipientListParams as RecipientListParams,
     type RecipientRetrieveParams as RecipientRetrieveParams,
   };

package/src/resources/email-templates.ts

@@ -2,8 +2,8 @@
 
 import { APIResource } from '../core/resource';
 import * as EmailTemplatesAPI from './email-templates';
-import * as ThreadsAPI from './email-inboxes/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';
@@ -17,14 +17,20 @@ export class EmailTemplates extends APIResource {
    *
    * @example
    * ```ts
-   * const emailTemplates = await client.emailTemplates.list();
+   * // Automatically fetches more pages as needed.
+   * for await (const emailTemplate of client.emailTemplates.list()) {
+   *   // ...
+   * }
    * ```
    */
   list(
     query: EmailTemplateListParams | null | undefined = {},
     options?: RequestOptions,
-  ): APIPromise<EmailTemplateListResponse> {
-    return this._client.get('/email_templates', { query, ...options });
+  ): PagePromise<EmailTemplatesEmailCursorPagination, EmailTemplate> {
+    return this._client.getAPIList('/email_templates', EmailCursorPagination<EmailTemplate>, {
+      query,
+      ...options,
+    });
   }
 
   /**
@@ -109,7 +115,8 @@ export class EmailTemplates extends APIResource {
   }
 
   /**
-   * Updates one or more template fields.
+   * Updates one or more fields of the specified email template and returns the
+   * updated template.
    *
    * @example
    * ```ts
@@ -149,6 +156,8 @@ export class EmailTemplates extends APIResource {
   }
 }
 
+export type EmailTemplatesEmailCursorPagination = EmailCursorPagination<EmailTemplate>;
+
 export interface EmailTemplate {
   id: string;
 
@@ -194,12 +203,6 @@ export interface UpdateEmailTemplateRequest {
   variables?: Array<string>;
 }
 
-export interface EmailTemplateListResponse {
-  data: Array<EmailTemplate>;
-
-  meta: ThreadsAPI.EmailPaginationMeta;
-}
-
 export interface EmailTemplateRenderResponse {
   /**
    * Template object with `subject`, `html_body`, and `text_body` replaced by their
@@ -218,18 +221,7 @@ export namespace EmailTemplateRenderResponse {
   export interface Data extends EmailTemplatesAPI.EmailTemplate {}
 }
 
-export interface EmailTemplateListParams {
-  /**
-   * 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;
-}
+export interface EmailTemplateListParams extends EmailCursorPaginationParams {}
 
 export interface EmailTemplateCreateParams {
   /**
@@ -326,8 +318,8 @@ export declare namespace EmailTemplates {
     type EmailTemplate as EmailTemplate,
     type EmailTemplateResponse as EmailTemplateResponse,
     type UpdateEmailTemplateRequest as UpdateEmailTemplateRequest,
-    type EmailTemplateListResponse as EmailTemplateListResponse,
     type EmailTemplateRenderResponse as EmailTemplateRenderResponse,
+    type EmailTemplatesEmailCursorPagination as EmailTemplatesEmailCursorPagination,
     type EmailTemplateListParams as EmailTemplateListParams,
     type EmailTemplateCreateParams as EmailTemplateCreateParams,
     type EmailTemplateReplaceParams as EmailTemplateReplaceParams,

package/src/resources/email-threads.ts

@@ -2,7 +2,13 @@
 
 import { APIResource } from '../core/resource';
 import * as ThreadsAPI from './email-inboxes/threads/threads';
+import { InboundThreadsEmailBracketCursorPagination } from './email-inboxes/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';
 
@@ -21,8 +27,11 @@ export class EmailThreads extends APIResource {
   list(
     query: EmailThreadListParams | null | undefined = {},
     options?: RequestOptions,
-  ): APIPromise<ThreadsAPI.InboundThreadListResponse> {
-    return this._client.get('/email_threads', { query, ...options });
+  ): PagePromise<InboundThreadsEmailBracketCursorPagination, ThreadsAPI.InboundThread> {
+    return this._client.getAPIList('/email_threads', EmailBracketCursorPagination<ThreadsAPI.InboundThread>, {
+      query,
+      ...options,
+    });
   }
 
   /**
@@ -47,7 +56,7 @@ export interface EmailThreadRetrieveResponse {
   meta: ThreadsAPI.EmailPaginationMeta;
 }
 
-export interface EmailThreadListParams {
+export interface EmailThreadListParams extends EmailBracketCursorPaginationParams {
   /**
    * Restrict results to one or more inboxes. Repeat the parameter
    * (`filter[inbox_id][]=...&filter[inbox_id][]=...`) or pass a comma-separated
@@ -62,16 +71,6 @@ export interface EmailThreadListParams {
    * 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 EmailThreadRetrieveParams {
@@ -98,3 +97,5 @@ export declare namespace EmailThreads {
     type EmailThreadRetrieveParams as EmailThreadRetrieveParams,
   };
 }
+
+export { type InboundThreadsEmailBracketCursorPagination };

package/src/resources/email-validations/batch.ts

@@ -112,7 +112,7 @@ export namespace BatchRetrieveResponse {
 
   export namespace Data {
     export interface Results {
-      checks: Results.Checks;
+      checks: EmailValidationsAPI.EmailValidationChecks;
 
       email: string;
 
@@ -125,29 +125,6 @@ export namespace BatchRetrieveResponse {
        */
       did_you_mean?: string;
     }
-
-    export namespace Results {
-      export interface Checks {
-        disposable: EmailValidationsAPI.EmailValidationCheck;
-
-        mx: EmailValidationsAPI.EmailValidationCheck;
-
-        role_based: EmailValidationsAPI.EmailValidationCheck;
-
-        syntax: EmailValidationsAPI.EmailValidationCheck;
-
-        typo: Checks.Typo;
-      }
-
-      export namespace Checks {
-        export interface Typo extends EmailValidationsAPI.EmailValidationCheck {
-          /**
-           * Suggested correction for common typos. Omitted when nil.
-           */
-          suggestion?: string;
-        }
-      }
-    }
   }
 }
 

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

@@ -56,13 +56,34 @@ export interface EmailValidationCheck {
   details?: string;
 }
 
+export interface EmailValidationChecks {
+  disposable: EmailValidationCheck;
+
+  mx: EmailValidationCheck;
+
+  role_based: EmailValidationCheck;
+
+  syntax: EmailValidationCheck;
+
+  typo: EmailValidationChecks.Typo;
+}
+
+export namespace EmailValidationChecks {
+  export interface Typo extends EmailValidationsAPI.EmailValidationCheck {
+    /**
+     * Suggested correction for common typos. Omitted when nil.
+     */
+    suggestion?: string;
+  }
+}
+
 export interface EmailValidationCreateResponse {
   data: EmailValidationCreateResponse.Data;
 }
 
 export namespace EmailValidationCreateResponse {
   export interface Data {
-    checks: Data.Checks;
+    checks: EmailValidationsAPI.EmailValidationChecks;
 
     email: string;
 
@@ -77,29 +98,6 @@ export namespace EmailValidationCreateResponse {
      */
     did_you_mean?: string;
   }
-
-  export namespace Data {
-    export interface Checks {
-      disposable: EmailValidationsAPI.EmailValidationCheck;
-
-      mx: EmailValidationsAPI.EmailValidationCheck;
-
-      role_based: EmailValidationsAPI.EmailValidationCheck;
-
-      syntax: EmailValidationsAPI.EmailValidationCheck;
-
-      typo: Checks.Typo;
-    }
-
-    export namespace Checks {
-      export interface Typo extends EmailValidationsAPI.EmailValidationCheck {
-        /**
-         * Suggested correction for common typos. Omitted when nil.
-         */
-        suggestion?: string;
-      }
-    }
-  }
 }
 
 export interface EmailValidationCreateParams {
@@ -127,6 +125,7 @@ EmailValidations.Batch = Batch;
 export declare namespace EmailValidations {
   export {
     type EmailValidationCheck as EmailValidationCheck,
+    type EmailValidationChecks as EmailValidationChecks,
     type EmailValidationCreateResponse as EmailValidationCreateResponse,
     type EmailValidationCreateParams as EmailValidationCreateParams,
   };

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

@@ -10,6 +10,7 @@ export {
 export {
   EmailValidations,
   type EmailValidationCheck,
+  type EmailValidationChecks,
   type EmailValidationCreateResponse,
   type EmailValidationCreateParams,
 } from './email-validations';

package/src/resources/enterprises/enterprises.ts

@@ -249,26 +249,6 @@ export class Enterprises extends APIResource {
 
 export type EnterprisePublicsDefaultFlatPagination = DefaultFlatPagination<EnterprisePublic>;
 
-export interface BillingAddress {
-  /**
-   * State or province code (e.g. `IL`, `ON`).
-   */
-  administrative_area: string;
-
-  city: string;
-
-  /**
-   * ISO 3166-1 alpha-2 code (currently `US` or `CA`).
-   */
-  country: string;
-
-  postal_code: string;
-
-  street_address: string;
-
-  extended_address?: string | null;
-}
-
 export interface BillingContact {
   email: string;
 
@@ -285,7 +265,7 @@ export interface BillingContact {
 export interface EnterprisePublic {
   id?: string;
 
-  billing_address?: BillingAddress;
+  billing_address?: PhysicalAddress;
 
   billing_contact?: BillingContact;
 
@@ -435,7 +415,7 @@ export interface EnterpriseListParams extends DefaultFlatPaginationParams {
 }
 
 export interface EnterpriseCreateParams {
-  billing_address: BillingAddress;
+  billing_address: PhysicalAddress;
 
   billing_contact: BillingContact;
 
@@ -576,7 +556,7 @@ export interface EnterpriseCreateParams {
 }
 
 export interface EnterpriseUpdateParams {
-  billing_address?: BillingAddress;
+  billing_address?: PhysicalAddress;
 
   billing_contact?: BillingContact;
 
@@ -665,7 +645,6 @@ Enterprises.Dir = Dir;
 
 export declare namespace Enterprises {
   export {
-    type BillingAddress as BillingAddress,
     type BillingContact as BillingContact,
     type EnterprisePublic as EnterprisePublic,
     type EnterprisePublicWrapped as EnterprisePublicWrapped,

package/src/resources/enterprises/index.ts

@@ -3,7 +3,6 @@
 export { Dir, type DirListParams, type DirCreateParams } from './dir';
 export {
   Enterprises,
-  type BillingAddress,
   type BillingContact,
   type EnterprisePublic,
   type EnterprisePublicWrapped,

package/src/resources/enterprises/reputation/index.ts

@@ -17,6 +17,8 @@ export {
 } from './numbers';
 export {
   Remediation,
+  type RemediationPerNumberResults,
+  type RemediationRequest,
   type RemediationRequestWrapped,
   type RemediationStatus,
   type RemediationListResponse,