telnyx 5.158.0 → 5.160.0

data/rbi/telnyx/resources/email_unsubscribe_groups.rbi

@@ -0,0 +1,111 @@
+# typed: strong
+
+module Telnyx
+  module Resources
+    # Named groups and group-scoped suppressions.
+    class EmailUnsubscribeGroups
+      # Named groups and group-scoped suppressions.
+      sig { returns(Telnyx::Resources::EmailUnsubscribeGroups::Suppressions) }
+      attr_reader :suppressions
+
+      # Creates an account-owned unsubscribe group for associating email categories with
+      # separate recipient suppression lists.
+      sig do
+        params(
+          name: String,
+          description: T.nilable(String),
+          request_options: Telnyx::RequestOptions::OrHash
+        ).returns(Telnyx::UnsubscribeGroupResponse)
+      end
+      def create(name:, description: nil, request_options: {})
+      end
+
+      # Returns the account-owned unsubscribe group identified by ID.
+      sig do
+        params(
+          id: String,
+          request_options: Telnyx::RequestOptions::OrHash
+        ).returns(Telnyx::UnsubscribeGroupResponse)
+      end
+      def retrieve(
+        # Resource UUID. Malformed UUIDs are treated as not-found (not 400).
+        id,
+        request_options: {}
+      )
+      end
+
+      # Partial update (only `name` / `description`). `PUT` is not routed.
+      sig do
+        params(
+          id: String,
+          description: T.nilable(String),
+          name: String,
+          request_options: Telnyx::RequestOptions::OrHash
+        ).returns(Telnyx::UnsubscribeGroupResponse)
+      end
+      def update(
+        # Resource UUID. Malformed UUIDs are treated as not-found (not 400).
+        id,
+        description: nil,
+        name: nil,
+        request_options: {}
+      )
+      end
+
+      # Offset pagination only (`page[number]` default 1, `page[size]` default 25, max
+      # 100). No `sort`/`filter`/cursor — ordering fixed `desc created_at, desc id`.
+      # Uses the shared `QueryParser.parse_offset/1` — a malformed `page` (e.g. flat
+      # `?page=1` instead of `?page[number]=1`) returns `400` (code `10015`), consistent
+      # with `GET /v2/email_blocks`. `meta` includes `total_pages`.
+      sig do
+        params(
+          page_number: Integer,
+          page_size: Integer,
+          request_options: Telnyx::RequestOptions::OrHash
+        ).returns(
+          Telnyx::Internal::DefaultFlatPagination[Telnyx::UnsubscribeGroup]
+        )
+      end
+      def list(
+        # Offset page number (≥1, default 1).
+        page_number: nil,
+        # Page size (1–100, default 25).
+        page_size: nil,
+        request_options: {}
+      )
+      end
+
+      # If the group has 0 active suppressions, hard-deletes the row. With `force=true`,
+      # soft-deletes all active suppressions first (status → `removed`, `group_id`
+      # cleared, `removed` audit event per block) in a single transaction, then
+      # hard-deletes the group. Without `force` and active suppressions present → `409`.
+      # Audit trail is preserved. `force` only accepts the string `"true"` or boolean
+      # `true`; all other values are false.
+      sig do
+        params(
+          id: String,
+          force:
+            T.any(
+              Telnyx::EmailUnsubscribeGroupDeleteParams::Force::OrSymbol,
+              T::Boolean
+            ),
+          request_options: Telnyx::RequestOptions::OrHash
+        ).void
+      end
+      def delete(
+        # Resource UUID. Malformed UUIDs are treated as not-found (not 400).
+        id,
+        # Force-delete a group with active suppressions. Only `"true"` (string) or `true`
+        # (bool) are truthy; all other values are false.
+        force: nil,
+        request_options: {}
+      )
+      end
+
+      # @api private
+      sig { params(client: Telnyx::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/rbi/telnyx/resources/email_validations/batch.rbi

@@ -0,0 +1,59 @@
+# typed: strong
+
+module Telnyx
+  module Resources
+    class EmailValidations
+      # Validate email addresses synchronously or in asynchronous batches.
+      class Batch
+        # Creates an asynchronous batch validation job for up to 1,000 email addresses.
+        sig do
+          params(
+            emails: T::Array[String],
+            webhook_url: String,
+            idempotency_key: String,
+            request_options: Telnyx::RequestOptions::OrHash
+          ).returns(Telnyx::Models::EmailValidations::BatchCreateResponse)
+        end
+        def create(
+          # Body param
+          emails:,
+          # Body param: URL for batch completion webhook. Empty string is treated as
+          # omitted. SSRF-protected; private/reserved IPs and internal hostnames are
+          # rejected.
+          webhook_url: nil,
+          # Header param: Optional opaque, unquoted key for safely retrying the same logical
+          # request. Keys must contain 1 to 255 letters, numbers, hyphens, or underscores.
+          # Generate a unique UUID v4 for each operation and reuse it only when retrying
+          # that operation with the same request. Invalid headers—including duplicate,
+          # empty, malformed, or overlong values—return 400 with error code 10015. A request
+          # already in progress with the same key returns 409; reusing the key with a
+          # different request returns 422. Only successful responses are replayed, for up to
+          # 24 hours. Do not include sensitive data in the key.
+          idempotency_key: nil,
+          request_options: {}
+        )
+        end
+
+        # Retrieves the current status and, once completed, validation results for a batch
+        # job.
+        sig do
+          params(
+            id: String,
+            request_options: Telnyx::RequestOptions::OrHash
+          ).returns(Telnyx::Models::EmailValidations::BatchRetrieveResponse)
+        end
+        def retrieve(
+          # Email validation batch UUID.
+          id,
+          request_options: {}
+        )
+        end
+
+        # @api private
+        sig { params(client: Telnyx::Client).returns(T.attached_class) }
+        def self.new(client:)
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/resources/email_validations.rbi

@@ -0,0 +1,42 @@
+# typed: strong
+
+module Telnyx
+  module Resources
+    # Validate email addresses synchronously or in asynchronous batches.
+    class EmailValidations
+      # Validate email addresses synchronously or in asynchronous batches.
+      sig { returns(Telnyx::Resources::EmailValidations::Batch) }
+      attr_reader :batch
+
+      # Validates a single email address and returns deliverability checks.
+      sig do
+        params(
+          email: String,
+          idempotency_key: String,
+          request_options: Telnyx::RequestOptions::OrHash
+        ).returns(Telnyx::Models::EmailValidationCreateResponse)
+      end
+      def create(
+        # Body param: Email address to validate. Any non-empty string is accepted; invalid
+        # syntax returns valid=false rather than a request error.
+        email:,
+        # Header param: Optional opaque, unquoted key for safely retrying the same logical
+        # request. Keys must contain 1 to 255 letters, numbers, hyphens, or underscores.
+        # Generate a unique UUID v4 for each operation and reuse it only when retrying
+        # that operation with the same request. Invalid headers—including duplicate,
+        # empty, malformed, or overlong values—return 400 with error code 10015. A request
+        # already in progress with the same key returns 409; reusing the key with a
+        # different request returns 422. Only successful responses are replayed, for up to
+        # 24 hours. Do not include sensitive data in the key.
+        idempotency_key: nil,
+        request_options: {}
+      )
+      end
+
+      # @api private
+      sig { params(client: Telnyx::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/rbi/telnyx/resources/external_connections.rbi

@@ -155,7 +155,8 @@ module Telnyx
       )
       end
 
-      # Update a location's static emergency address
+      # Update the static emergency address assigned to a specific location of an
+      # external connection.
       sig do
         params(
           location_id: String,

data/rbi/telnyx/resources/faxes.rbi

@@ -101,7 +101,7 @@ module Telnyx
       )
       end
 
-      # View a fax
+      # Retrieve the details of a single fax.
       sig do
         params(
           id: String,
@@ -115,7 +115,7 @@ module Telnyx
       )
       end
 
-      # View a list of faxes
+      # Retrieve a paginated list of faxes sent or received on your account.
       sig do
         params(
           filter: Telnyx::FaxListParams::Filter::OrHash,
@@ -135,7 +135,7 @@ module Telnyx
       )
       end
 
-      # Delete a fax
+      # Delete a fax resource from your account.
       sig do
         params(id: String, request_options: Telnyx::RequestOptions::OrHash).void
       end

data/rbi/telnyx/resources/fqdn_connections/fqdn_authentication.rbi

@@ -0,0 +1,77 @@
+# typed: strong
+
+module Telnyx
+  module Resources
+    class FqdnConnections
+      # FQDN connection operations
+      class FqdnAuthentication
+        # Retrieves the details of an existing FQDN authentication strategy for a specific
+        # FQDN connection.
+        sig do
+          params(
+            fqdn_connection_id: String,
+            request_options: Telnyx::RequestOptions::OrHash
+          ).returns(
+            Telnyx::Models::FqdnConnections::FqdnAuthenticationListResponse
+          )
+        end
+        def list(
+          # The ID of the FQDN connection.
+          fqdn_connection_id,
+          request_options: {}
+        )
+        end
+
+        # Updates the FQDN authentication strategy for a specific FQDN connection.
+        sig do
+          params(
+            fqdn_connection_id: String,
+            failover_url: String,
+            fqdn_outbound_authentication:
+              Telnyx::FqdnConnections::FqdnAuthenticationPatchAllParams::FqdnOutboundAuthentication::OrSymbol,
+            ip_authentication_method:
+              Telnyx::FqdnConnections::FqdnAuthenticationPatchAllParams::IPAuthenticationMethod::OrSymbol,
+            password: String,
+            txt_name: String,
+            txt_ttl: Integer,
+            txt_value: String,
+            user_name: String,
+            webhook_url: String,
+            request_options: Telnyx::RequestOptions::OrHash
+          ).returns(
+            Telnyx::Models::FqdnConnections::FqdnAuthenticationPatchAllResponse
+          )
+        end
+        def patch_all(
+          # The ID of the FQDN connection.
+          fqdn_connection_id,
+          # The failover webhook URL.
+          failover_url: nil,
+          # The outbound authentication type.
+          fqdn_outbound_authentication: nil,
+          # The IP authentication method.
+          ip_authentication_method: nil,
+          # The password for authentication.
+          password: nil,
+          # The TXT record name for Microsoft Teams SBC DNS verification.
+          txt_name: nil,
+          # The TTL for the TXT record.
+          txt_ttl: nil,
+          # The TXT record value for Microsoft Teams SBC DNS verification.
+          txt_value: nil,
+          # The username for authentication.
+          user_name: nil,
+          # The webhook URL for authentication events.
+          webhook_url: nil,
+          request_options: {}
+        )
+        end
+
+        # @api private
+        sig { params(client: Telnyx::Client).returns(T.attached_class) }
+        def self.new(client:)
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/resources/fqdn_connections.rbi

@@ -4,6 +4,10 @@ module Telnyx
   module Resources
     # FQDN connection operations
     class FqdnConnections
+      # FQDN connection operations
+      sig { returns(Telnyx::Resources::FqdnConnections::FqdnAuthentication) }
+      attr_reader :fqdn_authentication
+
       # Creates a FQDN connection.
       sig do
         params(
@@ -131,6 +135,7 @@ module Telnyx
           android_push_credential_id: T.nilable(String),
           call_cost_in_webhooks: T::Boolean,
           connection_name: String,
+          conversation_persistence: T::Boolean,
           default_on_hold_comfort_noise_enabled: T::Boolean,
           dtmf_type: Telnyx::DtmfType::OrSymbol,
           encode_contact_header_enabled: T::Boolean,
@@ -168,6 +173,10 @@ module Telnyx
         call_cost_in_webhooks: nil,
         # A user-assigned name to help manage the connection.
         connection_name: nil,
+        # Whether conversation persistence is enabled for this connection. When enabled,
+        # calls handled by the connection are transcribed, stored, and indexed. Defaults
+        # to false.
+        conversation_persistence: nil,
         # When enabled, Telnyx will generate comfort noise when you place the call on
         # hold. If disabled, you will need to generate comfort noise or on hold music to
         # avoid RTP timeout.

data/rbi/telnyx/resources/global_ip_assignment_health.rbi

@@ -4,7 +4,7 @@ module Telnyx
   module Resources
     # Global IPs
     class GlobalIPAssignmentHealth
-      # Global IP Assignment Health Check Metrics
+      # Retrieve health check metrics for your Global IP assignments.
       sig do
         params(
           filter:

data/rbi/telnyx/resources/global_ip_assignments_usage.rbi

@@ -4,7 +4,7 @@ module Telnyx
   module Resources
     # Global IPs
     class GlobalIPAssignmentsUsage
-      # Global IP Assignment Usage Metrics
+      # Retrieve usage metrics for your Global IP assignments.
       sig do
         params(
           filter:

data/rbi/telnyx/resources/global_ip_latency.rbi

@@ -4,7 +4,7 @@ module Telnyx
   module Resources
     # Global IPs
     class GlobalIPLatency
-      # Global IP Latency Metrics
+      # Retrieve latency metrics measured for your Global IPs.
       sig do
         params(
           filter: Telnyx::GlobalIPLatencyRetrieveParams::Filter::OrHash,

data/rbi/telnyx/resources/global_ip_usage.rbi

@@ -4,7 +4,7 @@ module Telnyx
   module Resources
     # Global IPs
     class GlobalIPUsage
-      # Global IP Usage Metrics
+      # Retrieve usage metrics for your Global IPs.
       sig do
         params(
           filter: Telnyx::GlobalIPUsageRetrieveParams::Filter::OrHash,

data/rbi/telnyx/resources/ip_connections.rbi

@@ -128,6 +128,7 @@ module Telnyx
           android_push_credential_id: T.nilable(String),
           call_cost_in_webhooks: T::Boolean,
           connection_name: String,
+          conversation_persistence: T::Boolean,
           default_on_hold_comfort_noise_enabled: T::Boolean,
           dtmf_type: Telnyx::DtmfType::OrSymbol,
           encode_contact_header_enabled: T::Boolean,
@@ -166,6 +167,10 @@ module Telnyx
         # Specifies if call cost webhooks should be sent for this connection.
         call_cost_in_webhooks: nil,
         connection_name: nil,
+        # Whether conversation persistence is enabled for this connection. When enabled,
+        # calls handled by the connection are transcribed, stored, and indexed. Defaults
+        # to false.
+        conversation_persistence: nil,
         # When enabled, Telnyx will generate comfort noise when you place the call on
         # hold. If disabled, you will need to generate comfort noise or on hold music to
         # avoid RTP timeout.

data/rbi/telnyx/resources/ledger_billing_group_reports.rbi

@@ -4,7 +4,8 @@ module Telnyx
   module Resources
     # Ledger billing reports
     class LedgerBillingGroupReports
-      # Create a ledger billing group report
+      # Create a ledger billing group report, which aggregates ledger activity by
+      # billing group.
       sig do
         params(
           month: Integer,
@@ -21,7 +22,8 @@ module Telnyx
       )
       end
 
-      # Get a ledger billing group report
+      # Retrieve the details and status of a previously created ledger billing group
+      # report.
       sig do
         params(
           id: String,

data/rbi/telnyx/resources/legacy/reporting/usage_reports/number_lookup.rbi

@@ -51,11 +51,23 @@ module Telnyx
 
             # Retrieve a paginated list of telco data usage reports
             sig do
-              params(request_options: Telnyx::RequestOptions::OrHash).returns(
-                Telnyx::Models::Legacy::Reporting::UsageReports::NumberLookupListResponse
+              params(
+                page: Integer,
+                per_page: Integer,
+                request_options: Telnyx::RequestOptions::OrHash
+              ).returns(
+                Telnyx::Internal::PerPagePagination[
+                  Telnyx::Legacy::Reporting::UsageReports::TelcoDataUsageReportResponse
+                ]
               )
             end
-            def list(request_options: {})
+            def list(
+              # Page number to retrieve (1-based).
+              page: nil,
+              # Filter results by per page.
+              per_page: nil,
+              request_options: {}
+            )
             end
 
             # Delete a specific telco data usage report by its ID

data/rbi/telnyx/resources/messages/rcs.rbi

@@ -26,7 +26,8 @@ module Telnyx
         )
         end
 
-        # Send an RCS message
+        # Queues an outbound RCS message through the selected RCS agent. Check recipient
+        # capabilities before sending features that require RCS support.
         sig do
           params(
             agent_id: String,

data/rbi/telnyx/resources/messages.rbi

@@ -2,7 +2,6 @@
 
 module Telnyx
   module Resources
-    # Messages
     class Messages
       # Send RCS messages
       sig { returns(Telnyx::Resources::Messages::Rcs) }
@@ -195,7 +194,8 @@ module Telnyx
       )
       end
 
-      # Send a group MMS message
+      # Queues an MMS addressed to multiple recipients as a group conversation. Delivery
+      # events are reported asynchronously through messaging webhooks.
       sig do
         params(
           from: String,
@@ -233,7 +233,8 @@ module Telnyx
       )
       end
 
-      # Send a long code message
+      # Queues an outbound SMS or MMS using a long-code sender. Delivery progress and
+      # final disposition are reported asynchronously through messaging webhooks.
       sig do
         params(
           from: String,
@@ -289,7 +290,8 @@ module Telnyx
       )
       end
 
-      # Send a message using number pool
+      # Queues an outbound message using a number pool. Telnyx selects an eligible
+      # sender from the pool according to its messaging profile configuration.
       sig do
         params(
           messaging_profile_id: String,
@@ -345,7 +347,8 @@ module Telnyx
       )
       end
 
-      # Send a short code message
+      # Queues an outbound SMS or MMS using a short-code sender. Delivery progress and
+      # final disposition are reported asynchronously through messaging webhooks.
       sig do
         params(
           from: String,
@@ -433,6 +436,37 @@ module Telnyx
       )
       end
 
+      # Sends a WhatsApp message using a Telnyx WhatsApp-enabled number. The message
+      # body, interactive elements, media, location, and reaction content are specified
+      # in the `whatsapp_message` field. Delivery progress and final disposition are
+      # reported asynchronously through messaging webhooks.
+      sig do
+        params(
+          from: String,
+          to: String,
+          whatsapp_message: Telnyx::WhatsappMessageContent::OrHash,
+          messaging_profile_id: String,
+          type: Telnyx::MessageWhatsappParams::Type::OrSymbol,
+          webhook_url: String,
+          request_options: Telnyx::RequestOptions::OrHash
+        ).returns(Telnyx::Models::MessageWhatsappResponse)
+      end
+      def whatsapp(
+        # Phone number in +E.164 format associated with Whatsapp account
+        from:,
+        # Phone number in +E.164 format
+        to:,
+        whatsapp_message:,
+        # Messaging profile ID - required if the 'from' number is not SMS-enabled
+        messaging_profile_id: nil,
+        # Message type - must be set to "WHATSAPP"
+        type: nil,
+        # The URL where webhooks related to this message will be sent.
+        webhook_url: nil,
+        request_options: {}
+      )
+      end
+
       # @api private
       sig { params(client: Telnyx::Client).returns(T.attached_class) }
       def self.new(client:)

data/rbi/telnyx/resources/messaging/rcs/agents.rbi

@@ -6,12 +6,12 @@ module Telnyx
       class Rcs
         # Send RCS messages
         class Agents
-          # Retrieve an RCS agent
+          # Returns the configuration and current state of the specified RCS agent.
           sig do
             params(
               id: String,
               request_options: Telnyx::RequestOptions::OrHash
-            ).returns(Telnyx::RcsAgentResponse)
+            ).returns(Telnyx::Rcs::RcsAgentResponse)
           end
           def retrieve(
             # RCS agent ID
@@ -20,7 +20,7 @@ module Telnyx
           )
           end
 
-          # Modify an RCS agent
+          # Updates the supplied configuration fields on the specified RCS agent.
           sig do
             params(
               id: String,
@@ -28,7 +28,7 @@ module Telnyx
               webhook_failover_url: T.nilable(String),
               webhook_url: T.nilable(String),
               request_options: Telnyx::RequestOptions::OrHash
-            ).returns(Telnyx::RcsAgentResponse)
+            ).returns(Telnyx::Rcs::RcsAgentResponse)
           end
           def update(
             # RCS agent ID
@@ -43,13 +43,15 @@ module Telnyx
           )
           end
 
-          # List all RCS agents
+          # Returns RCS agents available to the authenticated account.
           sig do
             params(
               page_number: Integer,
               page_size: Integer,
               request_options: Telnyx::RequestOptions::OrHash
-            ).returns(Telnyx::Internal::DefaultFlatPagination[Telnyx::RcsAgent])
+            ).returns(
+              Telnyx::Internal::DefaultFlatPagination[Telnyx::Rcs::RcsAgent]
+            )
           end
           def list(page_number: nil, page_size: nil, request_options: {})
           end

data/rbi/telnyx/resources/messaging/rcs.rbi

@@ -26,7 +26,7 @@ module Telnyx
         )
         end
 
-        # Check RCS capabilities (batch)
+        # Returns RCS capability information for multiple recipients in one request.
         sig do
           params(
             agent_id: String,
@@ -43,7 +43,8 @@ module Telnyx
         )
         end
 
-        # Check RCS capabilities
+        # Returns the RCS features supported by the specified recipient for the selected
+        # agent.
         sig do
           params(
             phone_number: String,

data/rbi/telnyx/resources/messaging_10dlc/brand.rbi

@@ -321,7 +321,9 @@ module Telnyx
         )
         end
 
-        # Resend brand 2FA email
+        # Requests a new two-factor authentication email for the specified 10DLC brand.
+        # Complete verification through the link delivered to the brand contact before
+        # continuing registration.
         sig do
           params(
             brand_id: String,

data/rbi/telnyx/resources/messaging_10dlc/campaign/osr.rbi

@@ -6,7 +6,9 @@ module Telnyx
       class Campaign
         # Campaign operations
         class Osr
-          # Get OSR campaign attributes
+          # Returns the optional shared-responsibility attributes recorded for the campaign.
+          # Use these values to inspect the campaign configuration submitted to the
+          # registry.
           sig do
             params(
               campaign_id: String,

data/rbi/telnyx/resources/messaging_10dlc/campaign/usecase.rbi

@@ -6,7 +6,8 @@ module Telnyx
       class Campaign
         # Campaign operations
         class Usecase
-          # Get Campaign Cost
+          # Returns the upfront and monthly cost associated with the selected 10DLC campaign
+          # use case.
           sig do
             params(
               usecase: String,

data/rbi/telnyx/resources/messaging_10dlc/campaign.rbi

@@ -163,7 +163,8 @@ module Telnyx
         )
         end
 
-        # Get Sharing Status
+        # Returns whether the campaign is configured for partner sharing and the current
+        # sharing state.
         sig do
           params(
             campaign_id: String,