telnyx 5.159.0 → 5.161.0

data/rbi/telnyx/resources/verifications.rbi

@@ -12,7 +12,8 @@ module Telnyx
       sig { returns(Telnyx::Resources::Verifications::Actions) }
       attr_reader :actions
 
-      # Retrieve verification
+      # Returns the verification identified by ID, including its channel, phone number,
+      # Verify profile, timeout, and current status.
       sig do
         params(
           verification_id: String,
@@ -26,7 +27,9 @@ module Telnyx
       )
       end
 
-      # Trigger Call verification
+      # Starts a verification for the specified phone number and delivers its code in a
+      # voice call using the selected Verify profile. Returns the pending verification
+      # record.
       sig do
         params(
           phone_number: String,
@@ -53,7 +56,9 @@ module Telnyx
       )
       end
 
-      # Trigger Flash call verification
+      # Starts a verification for the specified phone number and places a brief call
+      # with the code embedded in the caller ID. Returns the pending verification
+      # record.
       sig do
         params(
           phone_number: String,
@@ -73,7 +78,8 @@ module Telnyx
       )
       end
 
-      # Trigger SMS verification
+      # Starts a verification for the specified phone number and sends its code by SMS
+      # using the selected Verify profile. Returns the pending verification record.
       sig do
         params(
           phone_number: String,
@@ -96,7 +102,9 @@ module Telnyx
       )
       end
 
-      # Trigger WhatsApp verification
+      # Starts a verification for the specified phone number and sends its code over
+      # WhatsApp using the selected Verify profile. Returns the pending verification
+      # record.
       sig do
         params(
           phone_number: String,

data/rbi/telnyx/resources/verified_numbers/actions.rbi

@@ -5,7 +5,8 @@ module Telnyx
     class VerifiedNumbers
       # Verified Numbers operations
       class Actions
-        # Submit verification code
+        # Submit the verification code received via the selected verification method to
+        # verify a phone number.
         sig do
           params(
             phone_number: String,

data/rbi/telnyx/resources/verified_numbers.rbi

@@ -33,7 +33,7 @@ module Telnyx
       )
       end
 
-      # Retrieve a verified number
+      # Retrieve the details of a verified number on your account.
       sig do
         params(
           phone_number: String,
@@ -60,7 +60,7 @@ module Telnyx
       def list(page_number: nil, page_size: nil, request_options: {})
       end
 
-      # Delete a verified number
+      # Remove a verified number from your account.
       sig do
         params(
           phone_number: String,

data/rbi/telnyx/resources/verify_profiles.rbi

@@ -51,7 +51,8 @@ module Telnyx
       )
       end
 
-      # Update Verify profile
+      # Updates the specified Verify profile's name, webhook destinations, language,
+      # daily spend limits, or channel-specific settings. Returns the updated profile.
       sig do
         params(
           verify_profile_id: String,
@@ -105,7 +106,7 @@ module Telnyx
       )
       end
 
-      # Delete Verify profile
+      # Deletes the specified Verify profile and returns the deleted profile record.
       sig do
         params(
           verify_profile_id: String,

data/rbi/telnyx/resources/web_search/research.rbi

@@ -0,0 +1,71 @@
+# typed: strong
+
+module Telnyx
+  module Resources
+    class WebSearch
+      # Deep research with citations and async task polling.
+      class Research
+        # Starts a deep research task that runs multiple searches, reads sources, and
+        # synthesizes an answer with citations.
+        #
+        # ## Synchronous mode (default)
+        #
+        # When `background` is `false` or omitted, the request blocks until the research
+        # completes and returns the answer with citations. This can take up to 120 seconds
+        # depending on `research_effort`.
+        #
+        # ## Asynchronous mode
+        #
+        # When `background` is `true`, the request returns immediately with a `task_id`
+        # and `status: pending`. Poll `GET /web_search/research/{task_id}` to check when
+        # the research completes and retrieve the answer.
+        sig do
+          params(
+            query: String,
+            background: T::Boolean,
+            max_sources: Integer,
+            research_effort:
+              Telnyx::WebSearch::ResearchCreateParams::ResearchEffort::OrSymbol,
+            request_options: Telnyx::RequestOptions::OrHash
+          ).returns(Telnyx::Models::WebSearch::ResearchCreateResponse)
+        end
+        def create(
+          # The research question or topic.
+          query:,
+          # When `true`, the research runs asynchronously. The response returns a `task_id`
+          # immediately instead of waiting for the result. Poll
+          # `GET /web_search/research/{task_id}` to check status.
+          background: nil,
+          # Maximum number of sources to use.
+          max_sources: nil,
+          # Research depth level. `lite` is fastest, `deep` is most thorough.
+          research_effort: nil,
+          request_options: {}
+        )
+        end
+
+        # Polls the status of a previously started asynchronous research task. When the
+        # status is `completed`, the response includes the answer and citations. When the
+        # status is `failed`, the response includes an error message.
+        sig do
+          params(
+            task_id: String,
+            request_options: Telnyx::RequestOptions::OrHash
+          ).returns(Telnyx::Models::WebSearch::ResearchRetrieveResponse)
+        end
+        def retrieve(
+          # The research task ID returned by `POST /web_search/research` with
+          # `background: true`.
+          task_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/web_search.rbi

@@ -0,0 +1,86 @@
+# typed: strong
+
+module Telnyx
+  module Resources
+    class WebSearch
+      # Deep research with citations and async task polling.
+      sig { returns(Telnyx::Resources::WebSearch::Research) }
+      attr_reader :research
+
+      # Performs a real-time web search and returns structured, LLM-ready JSON results
+      # with titles, URLs, descriptions, and snippets. Supports filtering by domain,
+      # country, safe search, freshness, and live crawl.
+      #
+      # **Note:** `include_domains` and `exclude_domains` cannot be used in the same
+      # request. Use one or the other.
+      sig do
+        params(
+          query: String,
+          count: Integer,
+          country: String,
+          exclude_domains: T::Array[String],
+          freshness: String,
+          include_domains: T::Array[String],
+          livecrawl: T::Boolean,
+          safesearch: Telnyx::WebSearchCreateParams::Safesearch::OrSymbol,
+          request_options: Telnyx::RequestOptions::OrHash
+        ).returns(Telnyx::Models::WebSearchCreateResponse)
+      end
+      def create(
+        # The search query text.
+        query:,
+        # Number of results to return (1-100).
+        count: nil,
+        # Two-letter country code (ISO 3166-1 alpha-2) to bias results.
+        country: nil,
+        # Exclude results from these domains (bare hostnames, e.g. `pinterest.com`).
+        exclude_domains: nil,
+        # Time-based filter for results. Common values: `day`, `week`, `month`, `year`.
+        freshness: nil,
+        # Restrict results to these domains (bare hostnames, e.g. `arxiv.org`).
+        include_domains: nil,
+        # When true, the provider crawls pages in real-time for fresh content. The boolean
+        # is translated to the provider's internal enum internally; callers always pass
+        # `true` or `false`.
+        livecrawl: nil,
+        # Safe search filter level.
+        safesearch: nil,
+        request_options: {}
+      )
+      end
+
+      # Retrieves clean HTML or Markdown content from a list of URLs. Supports up to 20
+      # URLs per request (public API limit). Specify which formats to return: `html`,
+      # `markdown`, `metadata`.
+      sig do
+        params(
+          urls: T::Array[String],
+          crawl_timeout: Integer,
+          formats: T::Array[Telnyx::WebSearchContentsParams::Format::OrSymbol],
+          max_age: T.nilable(Integer),
+          request_options: Telnyx::RequestOptions::OrHash
+        ).returns(Telnyx::Models::WebSearchContentsResponse)
+      end
+      def contents(
+        # List of URLs to retrieve content from (max 20 for public API).
+        urls:,
+        # Timeout for crawling each URL, in seconds (1-60).
+        crawl_timeout: nil,
+        # Content formats to return. If omitted, `html` and `metadata` are returned by
+        # default. Retrieval is best-effort per URL: a format field appears only when that
+        # content could be produced, and a freshly crawled page may also include `html`
+        # even when not requested.
+        formats: nil,
+        # Maximum age of cached content in seconds. `null` means no limit.
+        max_age: 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/webhooks.rbi

@@ -9,6 +9,8 @@ module Telnyx
             Telnyx::CallAIGatherEndedWebhookEvent,
             Telnyx::CallAIGatherMessageHistoryUpdatedWebhookEvent,
             Telnyx::CallAIGatherPartialResultsWebhookEvent,
+            Telnyx::ArtifactCompletedWebhookEvent,
+            Telnyx::ArtifactFailedWebhookEvent,
             Telnyx::CallAnsweredWebhookEvent,
             Telnyx::CallBridgedWebhookEvent,
             Telnyx::CallConversationEndedWebhookEvent,
@@ -71,8 +73,11 @@ module Telnyx
             Telnyx::FaxSendingStarted,
             Telnyx::HostedNumberOrderEventWebhookEvent,
             Telnyx::InboundMessageWebhookEvent,
-            Telnyx::NumberOrderStatusUpdate,
+            Telnyx::NumberOrderStatusUpdateWebhookEvent,
+            Telnyx::RecordingAvailableWebhookEvent,
             Telnyx::ReplacedLinkClickWebhookEvent,
+            Telnyx::SessionStatusChangedWebhookEvent,
+            Telnyx::TranscriptCompletedWebhookEvent,
             Telnyx::TranscriptionWebhookEvent
           )
         )
@@ -93,6 +98,8 @@ module Telnyx
             Telnyx::CallAIGatherEndedWebhookEvent,
             Telnyx::CallAIGatherMessageHistoryUpdatedWebhookEvent,
             Telnyx::CallAIGatherPartialResultsWebhookEvent,
+            Telnyx::ArtifactCompletedWebhookEvent,
+            Telnyx::ArtifactFailedWebhookEvent,
             Telnyx::CallAnsweredWebhookEvent,
             Telnyx::CallBridgedWebhookEvent,
             Telnyx::CallConversationEndedWebhookEvent,
@@ -155,8 +162,11 @@ module Telnyx
             Telnyx::FaxSendingStarted,
             Telnyx::HostedNumberOrderEventWebhookEvent,
             Telnyx::InboundMessageWebhookEvent,
-            Telnyx::NumberOrderStatusUpdate,
+            Telnyx::NumberOrderStatusUpdateWebhookEvent,
+            Telnyx::RecordingAvailableWebhookEvent,
             Telnyx::ReplacedLinkClickWebhookEvent,
+            Telnyx::SessionStatusChangedWebhookEvent,
+            Telnyx::TranscriptCompletedWebhookEvent,
             Telnyx::TranscriptionWebhookEvent
           )
         )

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

@@ -5,7 +5,7 @@ module Telnyx
     class Whatsapp
       class BusinessAccounts
         class PhoneNumbers
-          # List phone numbers for a WABA
+          # Returns phone numbers registered under the specified WhatsApp Business Account.
           sig do
             params(
               id: String,
@@ -27,7 +27,8 @@ module Telnyx
           )
           end
 
-          # Initialize Whatsapp phone number verification
+          # Starts verification of a phone number for the specified WhatsApp Business
+          # Account using the requested verification method.
           sig do
             params(
               id: String,

data/rbi/telnyx/resources/whatsapp/business_accounts/settings.rbi

@@ -6,7 +6,7 @@ module Telnyx
       class BusinessAccounts
         # Manage Whatsapp business accounts
         class Settings
-          # Get WABA settings
+          # Returns account-level settings for the specified WhatsApp Business Account.
           sig do
             params(
               id: String,
@@ -22,7 +22,8 @@ module Telnyx
           )
           end
 
-          # Update WABA settings
+          # Updates the supplied account-level settings for the specified WhatsApp Business
+          # Account.
           sig do
             params(
               id: String,

data/rbi/telnyx/resources/whatsapp/business_accounts.rbi

@@ -14,7 +14,7 @@ module Telnyx
         sig { returns(Telnyx::Resources::Whatsapp::BusinessAccounts::Settings) }
         attr_reader :settings
 
-        # Get a single Whatsapp Business Account
+        # Returns the configuration and status of the specified WhatsApp Business Account.
         sig do
           params(
             id: String,
@@ -28,7 +28,7 @@ module Telnyx
         )
         end
 
-        # List Whatsapp Business Accounts
+        # Returns WhatsApp Business Accounts linked to the authenticated Telnyx account.
         sig do
           params(
             page_number: Integer,
@@ -43,7 +43,8 @@ module Telnyx
         def list(page_number: nil, page_size: nil, request_options: {})
         end
 
-        # Delete a Whatsapp Business Account
+        # Unlinks and deletes the specified WhatsApp Business Account resource from
+        # Telnyx.
         sig do
           params(
             id: String,

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

@@ -6,7 +6,7 @@ module Telnyx
       class PhoneNumbers
         # Manage Whatsapp phone numbers
         class CallingSettings
-          # Get calling settings for a phone number
+          # Returns the WhatsApp calling configuration for the specified phone number.
           sig do
             params(
               phone_number: String,
@@ -22,7 +22,7 @@ module Telnyx
           )
           end
 
-          # Enable or disable Whatsapp calling for a phone number
+          # Enables or disables WhatsApp calling for the specified phone number.
           sig do
             params(
               phone_number: String,

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

@@ -6,7 +6,8 @@ module Telnyx
       class PhoneNumbers
         # Manage Whatsapp phone numbers
         class ConversationalComponents
-          # Get phone number conversational components
+          # Returns the conversational components configured for the specified WhatsApp
+          # phone number.
           sig do
             params(
               phone_number: String,
@@ -22,7 +23,8 @@ module Telnyx
           )
           end
 
-          # Update phone number conversational components
+          # Updates the conversational components configured for the specified WhatsApp
+          # phone number.
           sig do
             params(
               phone_number: String,

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

@@ -7,7 +7,8 @@ module Telnyx
         class Profile
           # Manage Whatsapp phone numbers
           class Photo
-            # Get Whatsapp profile photo
+            # Returns the current business-profile photo for the specified WhatsApp phone
+            # number.
             sig do
               params(
                 phone_number: String,
@@ -23,7 +24,7 @@ module Telnyx
             )
             end
 
-            # Delete Whatsapp profile photo
+            # Removes the business-profile photo from the specified WhatsApp phone number.
             sig do
               params(
                 phone_number: String,
@@ -37,7 +38,8 @@ module Telnyx
             )
             end
 
-            # Upload Whatsapp profile photo
+            # Uploads and assigns a business-profile photo to the specified WhatsApp phone
+            # number.
             sig do
               params(
                 phone_number: String,

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

@@ -12,7 +12,7 @@ module Telnyx
           end
           attr_reader :photo
 
-          # Get phone number business profile
+          # Returns the business profile displayed for the specified WhatsApp phone number.
           sig do
             params(
               phone_number: String,
@@ -28,7 +28,8 @@ module Telnyx
           )
           end
 
-          # Update phone number business profile
+          # Updates the supplied business-profile fields for the specified WhatsApp phone
+          # number.
           sig do
             params(
               phone_number: String,

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

@@ -23,7 +23,7 @@ module Telnyx
         end
         attr_reader :conversational_components
 
-        # List Whatsapp phone numbers
+        # Returns WhatsApp phone numbers linked to the authenticated Telnyx account.
         sig do
           params(
             page_number: Integer,
@@ -38,7 +38,7 @@ module Telnyx
         def list(page_number: nil, page_size: nil, request_options: {})
         end
 
-        # Delete a Whatsapp phone number
+        # Removes the specified phone number from Telnyx WhatsApp management.
         sig do
           params(
             phone_number: String,
@@ -52,7 +52,18 @@ module Telnyx
         )
         end
 
-        # Resend verification code
+        # Retrieve a list of the phone numbers registered for WhatsApp on your account.
+        sig do
+          params(
+            page_number: Integer,
+            page_size: Integer,
+            request_options: Telnyx::RequestOptions::OrHash
+          ).returns(Telnyx::Models::Whatsapp::PhoneNumberGetResponse)
+        end
+        def get(page_number: nil, page_size: nil, request_options: {})
+        end
+
+        # Requests a new verification code for the specified WhatsApp phone number.
         sig do
           params(
             phone_number: String,
@@ -90,7 +101,7 @@ module Telnyx
         )
         end
 
-        # Submit verification code for a phone number
+        # Submits the verification code received for the specified WhatsApp phone number.
         sig do
           params(
             phone_number: String,

data/rbi/telnyx/resources/whatsapp/templates.rbi

@@ -5,7 +5,8 @@ module Telnyx
     class Whatsapp
       # Manage Whatsapp message templates
       class Templates
-        # Create a Whatsapp message template
+        # Creates a WhatsApp message template for review and subsequent use in template
+        # messages.
         sig do
           params(
             category:
@@ -43,7 +44,8 @@ module Telnyx
         )
         end
 
-        # List Whatsapp message templates
+        # Returns WhatsApp message templates owned by the authenticated account, including
+        # their current review state.
         sig do
           params(
             filter_category:

data/rbi/telnyx/resources/whatsapp/user_data.rbi

@@ -5,7 +5,8 @@ module Telnyx
     class Whatsapp
       # Manage Whatsapp business accounts
       class UserData
-        # Fetch Whatsapp user data
+        # Returns the WhatsApp user-data settings associated with the authenticated Telnyx
+        # account.
         sig do
           params(request_options: Telnyx::RequestOptions::OrHash).returns(
             Telnyx::Models::Whatsapp::UserDataRetrieveResponse
@@ -14,7 +15,8 @@ module Telnyx
         def retrieve(request_options: {})
         end
 
-        # Update Whatsapp user data
+        # Updates the supplied WhatsApp user-data settings for the authenticated Telnyx
+        # account.
         sig do
           params(
             webhook_failover_url: String,

data/rbi/telnyx/resources/whatsapp_message_templates.rbi

@@ -4,7 +4,8 @@ module Telnyx
   module Resources
     # Manage Whatsapp message templates
     class WhatsappMessageTemplates
-      # Get a Whatsapp message template by ID
+      # Returns the content, components, language, and current review state of the
+      # specified WhatsApp message template.
       sig do
         params(
           id: String,
@@ -18,7 +19,7 @@ module Telnyx
       )
       end
 
-      # Update a Whatsapp message template
+      # Updates the editable fields of the specified WhatsApp message template.
       sig do
         params(
           id: String,
@@ -47,7 +48,7 @@ module Telnyx
       )
       end
 
-      # Delete a Whatsapp message template
+      # Deletes the specified WhatsApp message template.
       sig do
         params(id: String, request_options: Telnyx::RequestOptions::OrHash).void
       end

data/sig/telnyx/client.rbs

@@ -220,7 +220,7 @@ module Telnyx
 
     attr_reader queues: Telnyx::Resources::Queues
 
-    attr_reader rcs_agents: Telnyx::Resources::RcsAgents
+    attr_reader rcs: Telnyx::Resources::Rcs
 
     attr_reader recording_transcriptions: Telnyx::Resources::RecordingTranscriptions
 
@@ -376,6 +376,10 @@ module Telnyx
 
     attr_reader pricing: Telnyx::Resources::Pricing
 
+    attr_reader web_search: Telnyx::Resources::WebSearch
+
+    attr_reader meeting_sessions: Telnyx::Resources::MeetingSessions
+
     private def auth_headers: -> ::Hash[String, String]
 
     private def bearer_auth: -> ::Hash[String, String]

data/sig/telnyx/models/actions/purchase_create_response.rbs

@@ -4,7 +4,7 @@ module Telnyx
       type purchase_create_response =
         {
           data: ::Array[Telnyx::SimpleSimCard],
-          errors: ::Array[Telnyx::WirelessError]
+          errors: ::Array[Telnyx::Actions::WirelessErrorC5290d5308]
         }
 
       class PurchaseCreateResponse < Telnyx::Internal::Type::BaseModel
@@ -14,20 +14,20 @@ module Telnyx
           ::Array[Telnyx::SimpleSimCard]
         ) -> ::Array[Telnyx::SimpleSimCard]
 
-        attr_reader errors: ::Array[Telnyx::WirelessError]?
+        attr_reader errors: ::Array[Telnyx::Actions::WirelessErrorC5290d5308]?
 
         def errors=: (
-          ::Array[Telnyx::WirelessError]
-        ) -> ::Array[Telnyx::WirelessError]
+          ::Array[Telnyx::Actions::WirelessErrorC5290d5308]
+        ) -> ::Array[Telnyx::Actions::WirelessErrorC5290d5308]
 
         def initialize: (
           ?data: ::Array[Telnyx::SimpleSimCard],
-          ?errors: ::Array[Telnyx::WirelessError]
+          ?errors: ::Array[Telnyx::Actions::WirelessErrorC5290d5308]
         ) -> void
 
         def to_hash: -> {
           data: ::Array[Telnyx::SimpleSimCard],
-          errors: ::Array[Telnyx::WirelessError]
+          errors: ::Array[Telnyx::Actions::WirelessErrorC5290d5308]
         }
       end
     end

data/sig/telnyx/models/actions/register_create_response.rbs

@@ -4,7 +4,7 @@ module Telnyx
       type register_create_response =
         {
           data: ::Array[Telnyx::SimpleSimCard],
-          errors: ::Array[Telnyx::WirelessError]
+          errors: ::Array[Telnyx::Actions::WirelessErrorC5290d5308]
         }
 
       class RegisterCreateResponse < Telnyx::Internal::Type::BaseModel
@@ -14,20 +14,20 @@ module Telnyx
           ::Array[Telnyx::SimpleSimCard]
         ) -> ::Array[Telnyx::SimpleSimCard]
 
-        attr_reader errors: ::Array[Telnyx::WirelessError]?
+        attr_reader errors: ::Array[Telnyx::Actions::WirelessErrorC5290d5308]?
 
         def errors=: (
-          ::Array[Telnyx::WirelessError]
-        ) -> ::Array[Telnyx::WirelessError]
+          ::Array[Telnyx::Actions::WirelessErrorC5290d5308]
+        ) -> ::Array[Telnyx::Actions::WirelessErrorC5290d5308]
 
         def initialize: (
           ?data: ::Array[Telnyx::SimpleSimCard],
-          ?errors: ::Array[Telnyx::WirelessError]
+          ?errors: ::Array[Telnyx::Actions::WirelessErrorC5290d5308]
         ) -> void
 
         def to_hash: -> {
           data: ::Array[Telnyx::SimpleSimCard],
-          errors: ::Array[Telnyx::WirelessError]
+          errors: ::Array[Telnyx::Actions::WirelessErrorC5290d5308]
         }
       end
     end