telnyx 5.158.0 → 5.159.0

data/rbi/telnyx/resources/email_unsubscribe_groups.rbi

@@ -0,0 +1,110 @@
+# 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
+
+      # Create an unsubscribe group
+      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
+
+      # Retrieve an unsubscribe group
+      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/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/phone_numbers/actions.rbi

@@ -10,7 +10,7 @@ module Telnyx
         sig do
           params(
             id: String,
-            bundle_id: String,
+            bundle_id: T.nilable(String),
             request_options: Telnyx::RequestOptions::OrHash
           ).returns(
             Telnyx::Models::PhoneNumbers::ActionChangeBundleStatusResponse

data/rbi/telnyx/resources/pricing/products.rbi

@@ -0,0 +1,62 @@
+# typed: strong
+
+module Telnyx
+  module Resources
+    class Pricing
+      # Public pricing operations
+      class Products
+        # Returns pricing entries for a single product. Most products return standard rate
+        # entries with fields like rate, unit, country_iso, direction, and tiers.
+        # Inference products return model-specific fields (model, input_rate, output_rate,
+        # cached_input_rate) with tiered pricing. Some products use rate decks
+        # (pricing_type: rate_deck) where rates are determined dynamically.
+        sig do
+          params(
+            slug: String,
+            page_number: Integer,
+            page_size: Integer,
+            request_options: Telnyx::RequestOptions::OrHash
+          ).returns(Telnyx::Models::Pricing::ProductRetrieveResponse)
+        end
+        def retrieve(
+          # Product slug from the catalog listing.
+          slug,
+          # Page number (1-based).
+          page_number: nil,
+          # Number of items per page (max 100).
+          page_size: nil,
+          request_options: {}
+        )
+        end
+
+        # Returns the full product catalog with pagination. Each entry contains a slug,
+        # display name, and description. Use the slug to fetch per-product pricing via GET
+        # /pricing/products/{slug}.
+        sig do
+          params(
+            page_number: Integer,
+            page_size: Integer,
+            request_options: Telnyx::RequestOptions::OrHash
+          ).returns(
+            Telnyx::Internal::DefaultFlatPaginationForInexplicitNumberOrders[
+              Telnyx::Models::Pricing::ProductListResponse
+            ]
+          )
+        end
+        def list(
+          # Page number (1-based).
+          page_number: nil,
+          # Number of items per page (max 100).
+          page_size: 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/pricing.rbi

@@ -0,0 +1,16 @@
+# typed: strong
+
+module Telnyx
+  module Resources
+    class Pricing
+      # Public pricing operations
+      sig { returns(Telnyx::Resources::Pricing::Products) }
+      attr_reader :products
+
+      # @api private
+      sig { params(client: Telnyx::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/rbi/telnyx/resources/short_codes.rbi

@@ -34,6 +34,7 @@ module Telnyx
         id,
         # Unique identifier for a messaging profile.
         messaging_profile_id:,
+        # Tags associated with the resource.
         tags: nil,
         request_options: {}
       )

data/rbi/telnyx/resources/speech_to_text.rbi

@@ -49,7 +49,7 @@ module Telnyx
       # `Authorization: Bearer <API_KEY>` header.
       #
       # Supported engines: `Azure`, `Deepgram`, `Google`, `Telnyx`, `xAI`,
-      # `Speechmatics`, `Soniox`, `Parakeet`.
+      # `Speechmatics`, `Soniox`, `Parakeet`, `Humain`, `Reson8`.
       #
       # **Connection flow:**
       #

data/rbi/telnyx/resources/text_to_speech.rbi

@@ -17,7 +17,7 @@ module Telnyx
       # with provider-specific parameters.
       #
       # Supported providers: `aws`, `telnyx`, `azure`, `elevenlabs`, `minimax`, `rime`,
-      # `resemble`, `xai`.
+      # `resemble`, `xai`, `humain`.
       #
       # The Telnyx `Ultra` model supports 44 languages with emotion control, speed
       # adjustment, and volume control. Use the `telnyx` provider-specific parameters to
@@ -29,6 +29,7 @@ module Telnyx
           disable_cache: T::Boolean,
           elevenlabs:
             ::Telnyx::TextToSpeechGenerateSpeechParams::Elevenlabs::OrHash,
+          humain: ::Telnyx::TextToSpeechGenerateSpeechParams::Humain::OrHash,
           language: String,
           minimax: ::Telnyx::TextToSpeechGenerateSpeechParams::Minimax::OrHash,
           output_type:
@@ -57,6 +58,10 @@ module Telnyx
         disable_cache: nil,
         # ElevenLabs provider-specific parameters.
         elevenlabs: nil,
+        # Humain provider-specific parameters. Unlike other providers, Humain has no
+        # format/sample-rate negotiation (output is always PCM16 24kHz mono) and no
+        # language parameter — language is fixed per voice.
+        humain: nil,
         # Language code (e.g. `en-US`). Usage varies by provider.
         language: nil,
         # Minimax provider-specific parameters.
@@ -123,7 +128,7 @@ module Telnyx
       # synthesize; receive JSON frames containing base64-encoded audio chunks.
       #
       # Supported providers: `aws`, `telnyx`, `azure`, `murfai`, `minimax`, `rime`,
-      # `resemble`, `elevenlabs`, `xai`.
+      # `resemble`, `elevenlabs`, `xai`, `humain`.
       #
       # **Connection flow:**
       #

data/rbi/telnyx/resources/webhooks.rbi

@@ -29,6 +29,8 @@ module Telnyx
             Telnyx::CallMachineGreetingEndedWebhookEvent,
             Telnyx::CallMachinePremiumDetectionEndedWebhookEvent,
             Telnyx::CallMachinePremiumGreetingEndedWebhookEvent,
+            Telnyx::CallPaymentCompletedWebhookEvent,
+            Telnyx::CallPaymentProgressWebhookEvent,
             Telnyx::CallPlaybackEndedWebhookEvent,
             Telnyx::CallPlaybackStartedWebhookEvent,
             Telnyx::CallRecordingErrorWebhookEvent,
@@ -111,6 +113,8 @@ module Telnyx
             Telnyx::CallMachineGreetingEndedWebhookEvent,
             Telnyx::CallMachinePremiumDetectionEndedWebhookEvent,
             Telnyx::CallMachinePremiumGreetingEndedWebhookEvent,
+            Telnyx::CallPaymentCompletedWebhookEvent,
+            Telnyx::CallPaymentProgressWebhookEvent,
             Telnyx::CallPlaybackEndedWebhookEvent,
             Telnyx::CallPlaybackStartedWebhookEvent,
             Telnyx::CallRecordingErrorWebhookEvent,

data/rbi/telnyx/resources/whatsapp/phone_numbers/conversational_components.rbi

@@ -0,0 +1,58 @@
+# typed: strong
+
+module Telnyx
+  module Resources
+    class Whatsapp
+      class PhoneNumbers
+        # Manage Whatsapp phone numbers
+        class ConversationalComponents
+          # Get phone number conversational components
+          sig do
+            params(
+              phone_number: String,
+              request_options: Telnyx::RequestOptions::OrHash
+            ).returns(
+              Telnyx::Models::Whatsapp::PhoneNumbers::ConversationalComponentListResponse
+            )
+          end
+          def list(
+            # Phone number (E.164 format)
+            phone_number,
+            request_options: {}
+          )
+          end
+
+          # Update phone number conversational components
+          sig do
+            params(
+              phone_number: String,
+              commands:
+                T::Array[
+                  Telnyx::Whatsapp::PhoneNumbers::ConversationalComponentPatchAllParams::Command::OrHash
+                ],
+              ice_breakers: T::Array[String],
+              request_options: Telnyx::RequestOptions::OrHash
+            ).returns(
+              Telnyx::Models::Whatsapp::PhoneNumbers::ConversationalComponentPatchAllResponse
+            )
+          end
+          def patch_all(
+            # Phone number (E.164 format)
+            phone_number,
+            # List of commands
+            commands: nil,
+            # List of ice breakers
+            ice_breakers: nil,
+            request_options: {}
+          )
+          end
+
+          # @api private
+          sig { params(client: Telnyx::Client).returns(T.attached_class) }
+          def self.new(client:)
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/resources/whatsapp/phone_numbers.rbi

@@ -15,6 +15,14 @@ module Telnyx
         sig { returns(Telnyx::Resources::Whatsapp::PhoneNumbers::Profile) }
         attr_reader :profile
 
+        # Manage Whatsapp phone numbers
+        sig do
+          returns(
+            Telnyx::Resources::Whatsapp::PhoneNumbers::ConversationalComponents
+          )
+        end
+        attr_reader :conversational_components
+
         # List Whatsapp phone numbers
         sig do
           params(

data/sig/telnyx/client.rbs

@@ -356,6 +356,26 @@ module Telnyx
 
     attr_reader infringement_claims: Telnyx::Resources::InfringementClaims
 
+    attr_reader email_blocks: Telnyx::Resources::EmailBlocks
+
+    attr_reader email_domains: Telnyx::Resources::EmailDomains
+
+    attr_reader email_events: Telnyx::Resources::EmailEvents
+
+    attr_reader email_inboxes: Telnyx::Resources::EmailInboxes
+
+    attr_reader email_messages: Telnyx::Resources::EmailMessages
+
+    attr_reader email_templates: Telnyx::Resources::EmailTemplates
+
+    attr_reader email_threads: Telnyx::Resources::EmailThreads
+
+    attr_reader email_unsubscribe_groups: Telnyx::Resources::EmailUnsubscribeGroups
+
+    attr_reader email_validations: Telnyx::Resources::EmailValidations
+
+    attr_reader pricing: Telnyx::Resources::Pricing
+
     private def auth_headers: -> ::Hash[String, String]
 
     private def bearer_auth: -> ::Hash[String, String]

data/sig/telnyx/models/ai/assistant_chat_params.rbs

@@ -6,7 +6,8 @@ module Telnyx
           assistant_id: String,
           content: String,
           conversation_id: String,
-          name: String
+          name: String,
+          stream: bool
         }
         & Telnyx::Internal::Type::request_parameters
 
@@ -24,11 +25,16 @@ module Telnyx
 
         def name=: (String) -> String
 
+        attr_reader stream: bool?
+
+        def stream=: (bool) -> bool
+
         def initialize: (
           assistant_id: String,
           content: String,
           conversation_id: String,
           ?name: String,
+          ?stream: bool,
           ?request_options: Telnyx::request_opts
         ) -> void
 
@@ -37,6 +43,7 @@ module Telnyx
           content: String,
           conversation_id: String,
           name: String,
+          stream: bool,
           request_options: Telnyx::RequestOptions
         }
       end

data/sig/telnyx/models/ai/chat_completion_request.rbs

@@ -21,6 +21,7 @@ module Telnyx
           presence_penalty: Float,
           response_format: Telnyx::AI::ChatCompletionRequest::ResponseFormat,
           seed: Integer,
+          service_tier: String,
           stop: Telnyx::Models::AI::ChatCompletionRequest::stop,
           stream: bool,
           temperature: Float,
@@ -104,6 +105,10 @@ module Telnyx
 
         def seed=: (Integer) -> Integer
 
+        attr_reader service_tier: String?
+
+        def service_tier=: (String) -> String
+
         attr_reader stop: Telnyx::Models::AI::ChatCompletionRequest::stop?
 
         def stop=: (
@@ -161,6 +166,7 @@ module Telnyx
           ?presence_penalty: Float,
           ?response_format: Telnyx::AI::ChatCompletionRequest::ResponseFormat,
           ?seed: Integer,
+          ?service_tier: String,
           ?stop: Telnyx::Models::AI::ChatCompletionRequest::stop,
           ?stream: bool,
           ?temperature: Float,
@@ -190,6 +196,7 @@ module Telnyx
           presence_penalty: Float,
           response_format: Telnyx::AI::ChatCompletionRequest::ResponseFormat,
           seed: Integer,
+          service_tier: String,
           stop: Telnyx::Models::AI::ChatCompletionRequest::stop,
           stream: bool,
           temperature: Float,

data/sig/telnyx/models/ai/openai_create_response_params.rbs

@@ -7,6 +7,7 @@ module Telnyx
           input: ::Hash[Symbol, top],
           instructions: String,
           model: String,
+          service_tier: String,
           stream: bool
         }
         & Telnyx::Internal::Type::request_parameters
@@ -31,6 +32,10 @@ module Telnyx
 
         def model=: (String) -> String
 
+        attr_reader service_tier: String?
+
+        def service_tier=: (String) -> String
+
         attr_reader stream: bool?
 
         def stream=: (bool) -> bool
@@ -40,6 +45,7 @@ module Telnyx
           ?input: ::Hash[Symbol, top],
           ?instructions: String,
           ?model: String,
+          ?service_tier: String,
           ?stream: bool,
           ?request_options: Telnyx::request_opts
         ) -> void
@@ -49,6 +55,7 @@ module Telnyx
           input: ::Hash[Symbol, top],
           instructions: String,
           model: String,
+          service_tier: String,
           stream: bool,
           request_options: Telnyx::RequestOptions
         }

data/sig/telnyx/models/ai/transcription_settings.rbs

@@ -60,6 +60,8 @@ module Telnyx
           | :"xai/grok-stt"
           | :"soniox/stt-rt-v4"
           | :"nvidia/parakeet-v3"
+          | :"humain/realtime"
+          | :"reson8/turns"
           | :"distil-whisper/distil-large-v2"
           | :"openai/whisper-large-v3-turbo"
 
@@ -74,6 +76,8 @@ module Telnyx
           XAI_GROK_STT: :"xai/grok-stt"
           SONIOX_STT_RT_V4: :"soniox/stt-rt-v4"
           NVIDIA_PARAKEET_V3: :"nvidia/parakeet-v3"
+          HUMAIN_REALTIME: :"humain/realtime"
+          RESON8_TURNS: :"reson8/turns"
           DISTIL_WHISPER_DISTIL_LARGE_V2: :"distil-whisper/distil-large-v2"
           OPENAI_WHISPER_LARGE_V3_TURBO: :"openai/whisper-large-v3-turbo"
 

data/sig/telnyx/models/attachment_request.rbs

@@ -0,0 +1,48 @@
+module Telnyx
+  module Models
+    type attachment_request =
+      {
+        content: String,
+        content_id: String?,
+        content_type: String,
+        disposition: String,
+        filename: String
+      }
+
+    class AttachmentRequest < Telnyx::Internal::Type::BaseModel
+      attr_reader content: String?
+
+      def content=: (String) -> String
+
+      attr_accessor content_id: String?
+
+      attr_reader content_type: String?
+
+      def content_type=: (String) -> String
+
+      attr_reader disposition: String?
+
+      def disposition=: (String) -> String
+
+      attr_reader filename: String?
+
+      def filename=: (String) -> String
+
+      def initialize: (
+        ?content: String,
+        ?content_id: String?,
+        ?content_type: String,
+        ?disposition: String,
+        ?filename: String
+      ) -> void
+
+      def to_hash: -> {
+        content: String,
+        content_id: String?,
+        content_type: String,
+        disposition: String,
+        filename: String
+      }
+    end
+  end
+end