telnyx 7.16.0 → 7.18.0

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

@@ -1,7 +1,6 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import { APIResource } from '../../../core/resource';
-import * as RemediationAPI from './remediation';
 import { APIPromise } from '../../../core/api-promise';
 import {
   DefaultFlatPagination,
@@ -107,80 +106,77 @@ export class Remediation extends APIResource {
 
 export type RemediationListResponsesDefaultFlatPagination = DefaultFlatPagination<RemediationListResponse>;
 
-export interface RemediationRequestWrapped {
-  /**
-   * Full detail of a remediation request, returned on submit and GET by id.
-   */
-  data: RemediationRequestWrapped.Data;
-}
+/**
+ * Per-category buckets of phone numbers, populated once results are available.
+ * Empty lists are kept (not omitted) so consumers can iterate without
+ * null-checking each key.
+ */
+export interface RemediationPerNumberResults {
+  ineligible?: Array<string>;
 
-export namespace RemediationRequestWrapped {
-  /**
-   * Full detail of a remediation request, returned on submit and GET by id.
-   */
-  export interface Data {
-    id: string;
+  not_flagged?: Array<string>;
 
-    call_purpose: string;
+  refused?: Array<string>;
 
-    created_at: string;
+  remediated?: Array<string>;
 
-    /**
-     * Total phone numbers in this batch, including any later cancelled. May exceed the
-     * sum of the per-category result buckets, which omit cancelled numbers.
-     */
-    phone_numbers_count: number;
+  requires_review?: Array<string>;
+}
 
-    /**
-     * Numbers rejected before submission (e.g. cooldown).
-     */
-    phone_numbers_ineligible: number;
+/**
+ * Full detail of a remediation request, returned on submit and GET by id.
+ */
+export interface RemediationRequest {
+  id: string;
 
-    /**
-     * Numbers accepted for remediation, i.e. not rejected as ineligible. Counts
-     * numbers still queued (pending) as well as processed ones.
-     */
-    phone_numbers_submitted: number;
+  call_purpose: string;
 
-    /**
-     * Customer-facing status of a remediation request.
-     */
-    status: RemediationAPI.RemediationStatus;
+  created_at: string;
 
-    updated_at: string;
+  /**
+   * Total phone numbers in this batch, including any later cancelled. May exceed the
+   * sum of the per-category result buckets, which omit cancelled numbers.
+   */
+  phone_numbers_count: number;
 
-    contact_email?: string | null;
+  /**
+   * Numbers rejected before submission (e.g. cooldown).
+   */
+  phone_numbers_ineligible: number;
 
-    /**
-     * Per-category buckets. Populated once results are available. Null while the
-     * request is still pending.
-     */
-    results?: Data.Results | null;
+  /**
+   * Numbers accepted for remediation, i.e. not rejected as ineligible. Counts
+   * numbers still queued (pending) as well as processed ones.
+   */
+  phone_numbers_submitted: number;
 
-    tier1_completed_at?: string | null;
+  /**
+   * Customer-facing status of a remediation request.
+   */
+  status: RemediationStatus;
 
-    tier2_completed_at?: string | null;
+  updated_at: string;
 
-    webhook_url?: string | null;
-  }
+  contact_email?: string | null;
 
-  export namespace Data {
-    /**
-     * Per-category buckets. Populated once results are available. Null while the
-     * request is still pending.
-     */
-    export interface Results {
-      ineligible?: Array<string>;
+  /**
+   * Per-category buckets. Populated once results are available. Null while the
+   * request is still pending.
+   */
+  results?: RemediationPerNumberResults | null;
 
-      not_flagged?: Array<string>;
+  tier1_completed_at?: string | null;
 
-      refused?: Array<string>;
+  tier2_completed_at?: string | null;
 
-      remediated?: Array<string>;
+  webhook_url?: string | null;
+}
 
-      requires_review?: Array<string>;
-    }
-  }
+export interface RemediationRequestWrapped {
+  /**
+   * Full detail of a remediation request, returned on submit and GET by id.
+   */
+  data: RemediationRequest;
 }
 
 /**
@@ -262,6 +258,8 @@ export interface RemediationRetrieveParams {
 
 export declare namespace Remediation {
   export {
+    type RemediationPerNumberResults as RemediationPerNumberResults,
+    type RemediationRequest as RemediationRequest,
     type RemediationRequestWrapped as RemediationRequestWrapped,
     type RemediationStatus as RemediationStatus,
     type RemediationListResponse as RemediationListResponse,

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

@@ -25,6 +25,8 @@ import {
   RemediationListParams,
   RemediationListResponse,
   RemediationListResponsesDefaultFlatPagination,
+  RemediationPerNumberResults,
+  RemediationRequest,
   RemediationRequestWrapped,
   RemediationRetrieveParams,
   RemediationStatus,
@@ -258,6 +260,8 @@ export declare namespace Reputation {
 
   export {
     Remediation as Remediation,
+    type RemediationPerNumberResults as RemediationPerNumberResults,
+    type RemediationRequest as RemediationRequest,
     type RemediationRequestWrapped as RemediationRequestWrapped,
     type RemediationStatus as RemediationStatus,
     type RemediationListResponse as RemediationListResponse,

package/src/resources/faxes/faxes.ts

@@ -90,7 +90,7 @@ export class Faxes extends APIResource {
   }
 
   /**
-   * Retrieve the details of a single fax.
+   * Returns the details of a single fax, including its current status.
    *
    * @example
    * ```ts

package/src/resources/fqdn-connections/fqdn-connections.ts

@@ -45,7 +45,8 @@ export class FqdnConnections extends APIResource {
   }
 
   /**
-   * Creates a FQDN connection.
+   * Creates a new FQDN-based SIP connection. FQDN connections authenticate by your
+   * registered domain names rather than static IP addresses.
    *
    * @example
    * ```ts
@@ -62,7 +63,7 @@ export class FqdnConnections extends APIResource {
   }
 
   /**
-   * Deletes an FQDN connection.
+   * Permanently deletes the specified FQDN connection from your account.
    *
    * @example
    * ```ts

package/src/resources/fqdns.ts

@@ -29,7 +29,7 @@ export class Fqdns extends APIResource {
   }
 
   /**
-   * Create a new FQDN object.
+   * Creates a new FQDN record and attaches it to the specified connection.
    *
    * @example
    * ```ts
@@ -45,7 +45,7 @@ export class Fqdns extends APIResource {
   }
 
   /**
-   * Delete an FQDN.
+   * Permanently deletes the specified FQDN record from its connection.
    *
    * @example
    * ```ts
@@ -73,7 +73,7 @@ export class Fqdns extends APIResource {
   }
 
   /**
-   * Update the details of a specific FQDN.
+   * Updates the details of the specified FQDN record and returns the updated FQDN.
    *
    * @example
    * ```ts

package/src/resources/global-ip-allowed-ports.ts

@@ -9,7 +9,8 @@ import { RequestOptions } from '../internal/request-options';
  */
 export class GlobalIPAllowedPorts extends APIResource {
   /**
-   * List all Global IP Allowed Ports
+   * Returns the ports allowed for Global IP traffic, for use when configuring Global
+   * IP resources.
    */
   list(options?: RequestOptions): APIPromise<GlobalIPAllowedPortListResponse> {
     return this._client.get('/global_ip_allowed_ports', options);

package/src/resources/global-ip-assignments.ts

@@ -12,7 +12,8 @@ import { path } from '../internal/utils/path';
  */
 export class GlobalIPAssignments extends APIResource {
   /**
-   * List all Global IP assignments.
+   * Returns a paginated list of your Global IP assignments, the links between Global
+   * IPs and the WireGuard peers that receive their traffic.
    */
   list(
     query: GlobalIPAssignmentListParams | null | undefined = {},
@@ -25,7 +26,9 @@ export class GlobalIPAssignments extends APIResource {
   }
 
   /**
-   * Create a Global IP assignment.
+   * Assigns a Global IP to a WireGuard peer so traffic destined for the IP is
+   * delivered over that peer's tunnel. Assignment is asynchronous, so the request is
+   * accepted and completes in the background.
    */
   create(
     body: GlobalIPAssignmentCreateParams,
@@ -35,21 +38,24 @@ export class GlobalIPAssignments extends APIResource {
   }
 
   /**
-   * Delete a Global IP assignment.
+   * Deletes the specified Global IP assignment, detaching the Global IP from its
+   * WireGuard peer.
    */
   delete(id: string, options?: RequestOptions): APIPromise<GlobalIPAssignmentDeleteResponse> {
     return this._client.delete(path`/global_ip_assignments/${id}`, options);
   }
 
   /**
-   * Retrieve a Global IP assignment.
+   * Returns the details of a single Global IP assignment, including the Global IP
+   * and WireGuard peer it links.
    */
   retrieve(id: string, options?: RequestOptions): APIPromise<GlobalIPAssignmentRetrieveResponse> {
     return this._client.get(path`/global_ip_assignments/${id}`, options);
   }
 
   /**
-   * Update a Global IP assignment.
+   * Updates the specified Global IP assignment with the provided fields and returns
+   * the updated assignment.
    */
   update(
     globalIPAssignmentID: string,

package/src/resources/global-ip-health-check-types.ts

@@ -9,7 +9,8 @@ import { RequestOptions } from '../internal/request-options';
  */
 export class GlobalIPHealthCheckTypes extends APIResource {
   /**
-   * List all Global IP Health check types.
+   * Returns the health check types available for Global IPs, for use when creating
+   * Global IP health checks.
    */
   list(options?: RequestOptions): APIPromise<GlobalIPHealthCheckTypeListResponse> {
     return this._client.get('/global_ip_health_check_types', options);

package/src/resources/global-ip-health-checks.ts

@@ -12,7 +12,8 @@ import { path } from '../internal/utils/path';
  */
 export class GlobalIPHealthChecks extends APIResource {
   /**
-   * List all Global IP health checks.
+   * Returns a paginated list of the Global IP health checks configured on your
+   * account.
    *
    * @example
    * ```ts
@@ -33,7 +34,9 @@ export class GlobalIPHealthChecks extends APIResource {
   }
 
   /**
-   * Create a Global IP health check.
+   * Creates a health check for a Global IP to monitor the health of its assignments.
+   * Creation is asynchronous, so the request is accepted and the health check
+   * becomes active once provisioning completes.
    *
    * @example
    * ```ts
@@ -49,7 +52,8 @@ export class GlobalIPHealthChecks extends APIResource {
   }
 
   /**
-   * Delete a Global IP health check.
+   * Deletes the specified Global IP health check so it no longer monitors the Global
+   * IP's assignments.
    *
    * @example
    * ```ts
@@ -64,7 +68,8 @@ export class GlobalIPHealthChecks extends APIResource {
   }
 
   /**
-   * Retrieve a Global IP health check.
+   * Returns the details of a single Global IP health check, including its type and
+   * configuration.
    *
    * @example
    * ```ts

package/src/resources/global-ip-protocols.ts

@@ -9,7 +9,8 @@ import { RequestOptions } from '../internal/request-options';
  */
 export class GlobalIPProtocols extends APIResource {
   /**
-   * List all Global IP Protocols
+   * Returns the network protocols supported for Global IP traffic, for use when
+   * configuring Global IP resources.
    */
   list(options?: RequestOptions): APIPromise<GlobalIPProtocolListResponse> {
     return this._client.get('/global_ip_protocols', options);

package/src/resources/global-ips.ts

@@ -12,7 +12,8 @@ import { path } from '../internal/utils/path';
  */
 export class GlobalIPs extends APIResource {
   /**
-   * List all Global IPs.
+   * Returns a paginated list of the Global IPs on your account, including each IP's
+   * address and configuration.
    *
    * @example
    * ```ts
@@ -30,7 +31,9 @@ export class GlobalIPs extends APIResource {
   }
 
   /**
-   * Create a Global IP.
+   * Requests creation of a new Global IP, a static IP address announced from the
+   * Telnyx network. Provisioning is asynchronous, so the request is accepted and the
+   * Global IP becomes available once provisioning completes.
    *
    * @example
    * ```ts
@@ -42,7 +45,7 @@ export class GlobalIPs extends APIResource {
   }
 
   /**
-   * Delete a Global IP.
+   * Deletes the specified Global IP and releases its address back to Telnyx.
    *
    * @example
    * ```ts
@@ -56,7 +59,8 @@ export class GlobalIPs extends APIResource {
   }
 
   /**
-   * Retrieve a Global IP.
+   * Returns the details of a single Global IP, including its address and current
+   * configuration.
    *
    * @example
    * ```ts

package/src/resources/index.ts

@@ -9,6 +9,7 @@ export {
   type AISummarizeResponse,
   type AISummarizeParams,
   type AIRetrieveConversationHistoriesParams,
+  type AIRetrieveConversationHistoriesResponsesDefaultFlatPagination,
 } from './ai/ai';
 export {
   AccessIPAddress,
@@ -243,6 +244,7 @@ export {
   type CustomStorageConfiguration,
   type GcsConfigurationData,
   type S3ConfigurationData,
+  type S3GenericConfigurationData,
   type CustomStorageCredentialCreateParams,
   type CustomStorageCredentialUpdateParams,
 } from './custom-storage-credentials';
@@ -338,6 +340,7 @@ export {
   type EmailBlockRetrieveExportParams,
   type EmailBlockRetrieveEventsParams,
   type EmailBlocksDefaultFlatPagination,
+  type EmailBlockRetrieveEventsResponsesDefaultFlatPagination,
 } from './email-blocks/email-blocks';
 export {
   EmailDomains,
@@ -365,43 +368,44 @@ export {
   type EmailEventRetrieveStatsResponse,
   type EmailEventListParams,
   type EmailEventRetrieveStatsParams,
+  type EmailEventListResponsesEmailCursorPagination,
 } from './email-events';
 export {
   EmailInboxes,
   type EmailInbox,
   type EmailInboxResponse,
-  type EmailInboxListResponse,
   type EmailInboxListParams,
   type EmailInboxCreateParams,
+  type EmailInboxesEmailCursorPagination,
 } from './email-inboxes/email-inboxes';
 export {
   EmailMessages,
   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/email-messages';
 export {
   EmailTemplates,
   type EmailTemplate,
   type EmailTemplateResponse,
   type UpdateEmailTemplateRequest,
-  type EmailTemplateListResponse,
   type EmailTemplateRenderResponse,
   type EmailTemplateListParams,
   type EmailTemplateCreateParams,
   type EmailTemplateReplaceParams,
   type EmailTemplateUpdateParams,
   type EmailTemplateRenderParams,
+  type EmailTemplatesEmailCursorPagination,
 } from './email-templates';
 export {
   EmailThreads,
@@ -423,12 +427,12 @@ export {
 export {
   EmailValidations,
   type EmailValidationCheck,
+  type EmailValidationChecks,
   type EmailValidationCreateResponse,
   type EmailValidationCreateParams,
 } from './email-validations/email-validations';
 export {
   Enterprises,
-  type BillingAddress,
   type BillingContact,
   type EnterprisePublic,
   type EnterprisePublicWrapped,
@@ -687,6 +691,7 @@ export {
 export {
   Messages,
   type MessagingError0b38e7044b,
+  type MessagingInboundMessagePayload,
   type MessagingOutboundMessagePayload,
   type OutboundMessagePayload,
   type RcsAgentMessage,
@@ -956,6 +961,7 @@ export {
   type OAuthGrantsResponse,
   type OAuthIntrospectResponse,
   type OAuthRegisterResponse,
+  type OAuthRetrieveAuthorizeResponse,
   type OAuthRetrieveJwksResponse,
   type OAuthTokenResponse,
   type OAuthRetrieveAuthorizeParams,
@@ -1322,15 +1328,16 @@ export {
 export {
   SpeechToText,
   type SttServiceType,
-  type SpeechToTextListProvidersResponse,
   type TranscribeClientEvent,
   type TranscribeServerEvent,
+  type SpeechToTextListProvidersResponse,
   type SpeechToTextListProvidersParams,
   type SpeechToTextRetrieveTranscriptionParams,
 } from './speech-to-text';
 export { Storage, type StorageListMigrationSourceCoverageResponse } from './storage/storage';
 export {
   SubNumberOrders,
+  type NumbersSubNumberOrder,
   type SubNumberOrder,
   type SubNumberOrderRegulatoryRequirement,
   type SubNumberOrderRetrieveResponse,
@@ -1392,10 +1399,10 @@ export {
 } from './texml-applications';
 export {
   TextToSpeech,
-  type TextToSpeechGenerateSpeechResponse,
-  type TextToSpeechListVoicesResponse,
   type StreamClientEvent,
   type StreamServerEvent,
+  type TextToSpeechGenerateSpeechResponse,
+  type TextToSpeechListVoicesResponse,
   type TextToSpeechListVoicesParams,
   type TextToSpeechGenerateSpeechParams,
   type TextToSpeechRetrieveSpeechParams,
@@ -1614,6 +1621,7 @@ export {
   type FaxQueued,
   type FaxSendingStarted,
   type InboundMessage,
+  type InboundSipHeader,
   type NumberOrderStatusUpdate,
   type OutboundMessage,
   type ReplacedLinkClick,
@@ -1686,6 +1694,7 @@ export {
   type TranscriptionWebhookEvent,
   type UnsafeUnwrapWebhookEvent,
   type UnwrapWebhookEvent,
+  type InboundMessagesEmailBracketCursorPagination,
 } from './webhooks';
 export {
   WellKnown,
@@ -1737,13 +1746,13 @@ export {
 export {
   WirelessBlocklists,
   type WirelessBlocklist,
+  type WirelessWirelessBlocklist,
   type WirelessBlocklistCreateResponse,
   type WirelessBlocklistRetrieveResponse,
   type WirelessBlocklistUpdateResponse,
-  type WirelessBlocklistDeleteResponse,
   type WirelessBlocklistListParams,
   type WirelessBlocklistUpdateParams,
   type WirelessBlocklistCreateParams,
-  type WirelessBlocklistsDefaultFlatPagination,
+  type WirelessWirelessBlocklistsDefaultFlatPagination,
 } from './wireless-blocklists';
 export { X402 } from './x402/x402';

package/src/resources/invoices.ts

@@ -8,7 +8,7 @@ import { path } from '../internal/utils/path';
 
 export class Invoices extends APIResource {
   /**
-   * Retrieve a paginated list of invoices.
+   * Returns a paginated list of your invoices, with support for sorting.
    */
   list(
     query: InvoiceListParams | null | undefined = {},

package/src/resources/ip-connections.ts

@@ -13,7 +13,8 @@ import { path } from '../internal/utils/path';
  */
 export class IPConnections extends APIResource {
   /**
-   * Returns a list of your IP connections.
+   * Returns a paginated list of your IP-based SIP connections, with support for
+   * filtering and sorting.
    *
    * @example
    * ```ts
@@ -34,7 +35,8 @@ export class IPConnections extends APIResource {
   }
 
   /**
-   * Creates an IP connection.
+   * Creates a new IP-based SIP connection, which authenticates traffic by source IP
+   * address.
    *
    * @example
    * ```ts
@@ -46,7 +48,7 @@ export class IPConnections extends APIResource {
   }
 
   /**
-   * Deletes an existing IP connection.
+   * Permanently deletes the specified IP connection from your account.
    *
    * @example
    * ```ts

package/src/resources/ips.ts

@@ -29,7 +29,8 @@ export class IPs extends APIResource {
   }
 
   /**
-   * Create a new IP object.
+   * Creates a new IP record for use with IP-based connections, associating an IP
+   * address with the specified connection.
    *
    * @example
    * ```ts
@@ -43,7 +44,7 @@ export class IPs extends APIResource {
   }
 
   /**
-   * Delete an IP.
+   * Permanently deletes the specified IP record from its connection.
    *
    * @example
    * ```ts
@@ -71,7 +72,7 @@ export class IPs extends APIResource {
   }
 
   /**
-   * Update the details of a specific IP.
+   * Updates the details of the specified IP record and returns the updated IP.
    *
    * @example
    * ```ts

package/src/resources/legacy/reporting/usage-reports/messaging.ts

@@ -68,7 +68,8 @@ export class Messaging extends APIResource {
   }
 
   /**
-   * Fetch single MDR usage report by id.
+   * Returns a single MDR (Message Detail Record) usage report by its identifier,
+   * including its parameters and current status.
    *
    * @example
    * ```ts

package/src/resources/legacy/reporting/usage-reports/number-lookup.ts

@@ -34,7 +34,8 @@ export class NumberLookup extends APIResource {
   }
 
   /**
-   * Submit a new telco data usage report
+   * Submits a new telco data (number lookup) usage report request. The report is
+   * generated asynchronously; retrieve it by its identifier once ready.
    *
    * @example
    * ```ts

package/src/resources/legacy/reporting/usage-reports/voice.ts

@@ -69,7 +69,8 @@ export class Voice extends APIResource {
   }
 
   /**
-   * Fetch single cdr usage report by id.
+   * Returns a single CDR (Call Detail Record) usage report by its identifier,
+   * including its parameters and current status.
    *
    * @example
    * ```ts

package/src/resources/managed-accounts/managed-accounts.ts

@@ -84,7 +84,8 @@ export class ManagedAccounts extends APIResource {
   }
 
   /**
-   * Update a single managed account.
+   * Updates the specified managed account's attributes and returns the updated
+   * account.
    *
    * @example
    * ```ts