telnyx 5.159.0 → 5.161.0

data/rbi/telnyx/resources/phone_numbers/actions.rbi

@@ -5,8 +5,9 @@ module Telnyx
     class PhoneNumbers
       # Configure your phone numbers
       class Actions
-        # Change the bundle status for a phone number (set to being in a bundle or remove
-        # from a bundle)
+        # Adds the specified phone number to a bundle or removes it from a bundle
+        # according to the requested status change. The response contains the phone number
+        # with its updated bundle state.
         sig do
           params(
             id: String,
@@ -29,7 +30,9 @@ module Telnyx
         )
         end
 
-        # Enable emergency for a phone number
+        # Associates emergency-service settings with the specified phone number. The
+        # operation returns the updated phone-number configuration when completed
+        # immediately or an accepted state when processing continues asynchronously.
         sig do
           params(
             id: String,

data/rbi/telnyx/resources/phone_numbers/csv_downloads.rbi

@@ -4,7 +4,9 @@ module Telnyx
   module Resources
     class PhoneNumbers
       class CsvDownloads
-        # Create a CSV download
+        # Starts generation of a CSV export for phone numbers matching the supplied
+        # filters. The `csv_format` parameter selects the output format, and the response
+        # contains the resulting download record.
         sig do
           params(
             csv_format:
@@ -28,7 +30,8 @@ module Telnyx
         )
         end
 
-        # Retrieve a CSV download
+        # Returns the current status and download details for the CSV export identified by
+        # `id`.
         sig do
           params(
             id: String,
@@ -42,7 +45,8 @@ module Telnyx
         )
         end
 
-        # List CSV downloads
+        # Returns CSV export jobs created for account phone numbers, including each
+        # export's current status and pagination metadata.
         sig do
           params(
             page_number: Integer,

data/rbi/telnyx/resources/phone_numbers/jobs.rbi

@@ -5,7 +5,8 @@ module Telnyx
     class PhoneNumbers
       # Background jobs performed over a batch of phone numbers
       class Jobs
-        # Retrieve a phone numbers job
+        # Returns the status and details of the phone-number background job identified by
+        # `id`.
         sig do
           params(
             id: String,
@@ -19,7 +20,8 @@ module Telnyx
         )
         end
 
-        # Lists the phone numbers jobs
+        # Returns background jobs that operate on phone numbers. Results can be filtered
+        # by job type and sorted by creation time, and include pagination metadata.
         sig do
           params(
             filter: Telnyx::PhoneNumbers::JobListParams::Filter::OrHash,

data/rbi/telnyx/resources/phone_numbers/messaging.rbi

@@ -5,7 +5,8 @@ module Telnyx
     class PhoneNumbers
       # Configure your phone numbers
       class Messaging
-        # Retrieve a phone number with messaging settings
+        # Returns the messaging product and messaging-profile assignment for the specified
+        # phone number.
         sig do
           params(
             id: String,
@@ -19,7 +20,8 @@ module Telnyx
         )
         end
 
-        # Update the messaging profile and/or messaging product of a phone number
+        # Updates the messaging product, messaging profile, or both for the specified
+        # phone number.
         sig do
           params(
             id: String,
@@ -50,7 +52,8 @@ module Telnyx
         )
         end
 
-        # List phone numbers with messaging settings
+        # Returns phone numbers with their current messaging product and messaging-profile
+        # assignments.
         sig do
           params(
             filter_messaging_profile_id: String,

data/rbi/telnyx/resources/phone_numbers/voice.rbi

@@ -5,7 +5,8 @@ module Telnyx
     class PhoneNumbers
       # Configure your phone numbers
       class Voice
-        # Retrieve a phone number with voice settings
+        # Returns the specified phone number together with its current voice
+        # configuration.
         sig do
           params(
             id: String,
@@ -19,7 +20,8 @@ module Telnyx
         )
         end
 
-        # Update a phone number with voice settings
+        # Updates the voice configuration for the specified phone number. The response
+        # contains the phone number with its updated voice settings.
         sig do
           params(
             id: String,
@@ -67,7 +69,9 @@ module Telnyx
         )
         end
 
-        # List phone numbers with voice settings
+        # Returns account phone numbers together with their voice settings. Results
+        # support pagination, sorting, and filters for number, connection name, customer
+        # reference, and voice usage payment method.
         sig do
           params(
             filter: Telnyx::PhoneNumbers::VoiceListParams::Filter::OrHash,

data/rbi/telnyx/resources/phone_numbers/voicemail.rbi

@@ -5,11 +5,15 @@ module Telnyx
     class PhoneNumbers
       # Voicemail API
       class Voicemail
-        # Create voicemail settings for a phone number
+        # Create voicemail settings for a phone number. You can also configure a custom
+        # greeting by setting the `greeting` object: use `mode` `custom_greeting` together
+        # with a `media_name` that points to an audio file uploaded through the Media
+        # Storage API, or `mode` `default` to use the standard system greeting.
         sig do
           params(
             phone_number_id: String,
             enabled: T::Boolean,
+            greeting: Telnyx::PhoneNumbers::VoicemailRequest::Greeting::OrHash,
             pin: String,
             request_options: Telnyx::RequestOptions::OrHash
           ).returns(Telnyx::Models::PhoneNumbers::VoicemailCreateResponse)
@@ -19,6 +23,12 @@ module Telnyx
           phone_number_id,
           # Whether voicemail is enabled.
           enabled: nil,
+          # Controls the greeting a caller hears before leaving a voicemail. Set `mode` to
+          # `default` to play the standard system greeting, or to `custom_greeting` to play
+          # your own audio. When `mode` is `custom_greeting`, `media_name` is required and
+          # must reference an audio file already uploaded to your account through the Media
+          # Storage API.
+          greeting: nil,
           # The pin used for voicemail
           pin: nil,
           request_options: {}
@@ -39,11 +49,15 @@ module Telnyx
         )
         end
 
-        # Update voicemail settings for a phone number
+        # Update voicemail settings for a phone number. You can also configure a custom
+        # greeting by setting the `greeting` object: use `mode` `custom_greeting` together
+        # with a `media_name` that points to an audio file uploaded through the Media
+        # Storage API, or `mode` `default` to use the standard system greeting.
         sig do
           params(
             phone_number_id: String,
             enabled: T::Boolean,
+            greeting: Telnyx::PhoneNumbers::VoicemailRequest::Greeting::OrHash,
             pin: String,
             request_options: Telnyx::RequestOptions::OrHash
           ).returns(Telnyx::Models::PhoneNumbers::VoicemailUpdateResponse)
@@ -53,6 +67,12 @@ module Telnyx
           phone_number_id,
           # Whether voicemail is enabled.
           enabled: nil,
+          # Controls the greeting a caller hears before leaving a voicemail. Set `mode` to
+          # `default` to play the standard system greeting, or to `custom_greeting` to play
+          # your own audio. When `mode` is `custom_greeting`, `media_name` is required and
+          # must reference an audio file already uploaded to your account through the Media
+          # Storage API.
+          greeting: nil,
           # The pin used for voicemail
           pin: nil,
           request_options: {}

data/rbi/telnyx/resources/phone_numbers.rbi

@@ -27,7 +27,8 @@ module Telnyx
       sig { returns(Telnyx::Resources::PhoneNumbers::Voicemail) }
       attr_reader :voicemail
 
-      # Retrieve a phone number
+      # Returns the detailed configuration and current state of the phone number
+      # identified by `id`.
       sig do
         params(
           id: String,
@@ -41,7 +42,8 @@ module Telnyx
       )
       end
 
-      # Update a phone number
+      # Updates the configurable settings of the specified phone number. The response
+      # contains the complete updated phone-number representation.
       sig do
         params(
           phone_number_id: String,
@@ -79,7 +81,9 @@ module Telnyx
       )
       end
 
-      # List phone numbers
+      # Returns phone numbers associated with the account. Results support pagination,
+      # sorting, and filters for number attributes, status, source, connections, billing
+      # groups, emergency addresses, tags, and customer references.
       sig do
         params(
           filter: Telnyx::PhoneNumberListParams::Filter::OrHash,
@@ -90,7 +94,9 @@ module Telnyx
           sort: Telnyx::PhoneNumberListParams::Sort::OrSymbol,
           request_options: Telnyx::RequestOptions::OrHash
         ).returns(
-          Telnyx::Internal::DefaultFlatPagination[Telnyx::PhoneNumberDetailed]
+          Telnyx::Internal::DefaultFlatPagination[
+            Telnyx::NumbersPhoneNumberDetailed
+          ]
         )
       end
       def list(
@@ -117,7 +123,8 @@ module Telnyx
       )
       end
 
-      # Delete a phone number
+      # Deletes the specified phone number from the account. The response contains the
+      # phone number's final deleted representation.
       sig do
         params(
           id: String,

data/rbi/telnyx/resources/phone_numbers_regulatory_requirements.rbi

@@ -4,7 +4,9 @@ module Telnyx
   module Resources
     # Regulatory Requirements
     class PhoneNumbersRegulatoryRequirements
-      # Retrieve regulatory requirements for a list of phone numbers
+      # Returns the regulatory requirements that apply to the supplied comma-separated
+      # phone numbers. The response includes the matching requirement records and
+      # pagination metadata.
       sig do
         params(
           filter:

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

@@ -13,6 +13,7 @@ module Telnyx
         sig do
           params(
             slug: String,
+            filter_country_iso: T.nilable(String),
             page_number: Integer,
             page_size: Integer,
             request_options: Telnyx::RequestOptions::OrHash
@@ -21,6 +22,7 @@ module Telnyx
         def retrieve(
           # Product slug from the catalog listing.
           slug,
+          filter_country_iso: nil,
           # Page number (1-based).
           page_number: nil,
           # Number of items per page (max 100).
@@ -38,7 +40,7 @@ module Telnyx
             page_size: Integer,
             request_options: Telnyx::RequestOptions::OrHash
           ).returns(
-            Telnyx::Internal::DefaultFlatPaginationForInexplicitNumberOrders[
+            Telnyx::Internal::DefaultFlatPagination[
               Telnyx::Models::Pricing::ProductListResponse
             ]
           )

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

@@ -0,0 +1,66 @@
+# typed: strong
+
+module Telnyx
+  module Resources
+    class Rcs
+      class Agents
+        # Manage RCS agent registration, testing, verification, and launch.
+        class TestDevices
+          # Adds an RCS-capable test number after provider agent creation. Repeating the
+          # request for a number already attached to the agent returns the existing test
+          # device.
+          sig do
+            params(
+              id: String,
+              phone_number: String,
+              request_options: Telnyx::RequestOptions::OrHash
+            ).returns(Telnyx::Rcs::Agents::TestDeviceResponse)
+          end
+          def create(
+            # The Telnyx-assigned agent identifier.
+            id,
+            phone_number:,
+            request_options: {}
+          )
+          end
+
+          # Lists test devices attached to an RCS agent.
+          sig do
+            params(
+              id: String,
+              request_options: Telnyx::RequestOptions::OrHash
+            ).returns(T::Array[Telnyx::Rcs::Agents::TestDeviceResponse])
+          end
+          def list(
+            # The Telnyx-assigned agent identifier.
+            id,
+            request_options: {}
+          )
+          end
+
+          # Removes a test device from an RCS agent and its provider registration.
+          sig do
+            params(
+              test_device_id: String,
+              id: String,
+              request_options: Telnyx::RequestOptions::OrHash
+            ).void
+          end
+          def delete(
+            # The Telnyx-assigned test device identifier.
+            test_device_id,
+            # The Telnyx-assigned agent identifier.
+            id:,
+            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/rcs/agents.rbi

@@ -0,0 +1,163 @@
+# typed: strong
+
+module Telnyx
+  module Resources
+    class Rcs
+      # Manage RCS agent registration, testing, verification, and launch.
+      class Agents
+        # Manage RCS agent registration, testing, verification, and launch.
+        sig { returns(Telnyx::Resources::Rcs::Agents::TestDevices) }
+        attr_reader :test_devices
+
+        # Creates an editable RCS agent draft under a brand. The `Idempotency-Key` is
+        # scoped to the authenticated organization. Reusing the key with the same request
+        # returns the original agent, while reusing it with a different request returns a
+        # conflict.
+        sig do
+          params(
+            brand_id: String,
+            configuration: Telnyx::Rcs::AgentConfiguration::OrHash,
+            display_name: String,
+            use_case: Telnyx::Rcs::AgentUseCase::OrSymbol,
+            idempotency_key: String,
+            hosting_region: T.nilable(String),
+            profile_id: T.nilable(String),
+            request_options: Telnyx::RequestOptions::OrHash
+          ).returns(Telnyx::Rcs::AgentResponse)
+        end
+        def create(
+          # Body param
+          brand_id:,
+          # Body param
+          configuration:,
+          # Body param
+          display_name:,
+          # Body param
+          use_case:,
+          # Header param: A caller-generated key containing letters, numbers, underscores,
+          # or hyphens. Reuse the same key and request body when retrying the same logical
+          # agent creation.
+          idempotency_key:,
+          # Body param
+          hosting_region: nil,
+          # Body param: A Messaging Profile owned by the authenticated organization. When
+          # omitted, the agent inherits the brand profile.
+          profile_id: nil,
+          request_options: {}
+        )
+        end
+
+        # Retrieves an RCS agent, section statuses, test devices, carrier approvals, and
+        # provider capabilities.
+        sig do
+          params(
+            id: String,
+            request_options: Telnyx::RequestOptions::OrHash
+          ).returns(Telnyx::Rcs::AgentResponse)
+        end
+        def retrieve(
+          # The Telnyx-assigned agent identifier.
+          id,
+          request_options: {}
+        )
+        end
+
+        # Updates one or more fields on an agent while its status is `CREATED`. Submitted
+        # agents cannot be changed through this endpoint.
+        sig do
+          params(
+            id: String,
+            configuration: Telnyx::Rcs::AgentConfiguration::OrHash,
+            display_name: String,
+            hosting_region: String,
+            profile_id: String,
+            use_case: Telnyx::Rcs::AgentUseCase::OrSymbol,
+            request_options: Telnyx::RequestOptions::OrHash
+          ).returns(Telnyx::Rcs::AgentResponse)
+        end
+        def update(
+          # The Telnyx-assigned agent identifier.
+          id,
+          configuration: nil,
+          display_name: nil,
+          hosting_region: nil,
+          profile_id: nil,
+          use_case: nil,
+          request_options: {}
+        )
+        end
+
+        # Lists RCS agents owned by the authenticated organization, optionally filtered by
+        # brand.
+        sig do
+          params(
+            brand_id: String,
+            request_options: Telnyx::RequestOptions::OrHash
+          ).returns(T::Array[Telnyx::Rcs::AgentResponse])
+        end
+        def list(
+          # Only return agents belonging to this brand.
+          brand_id: nil,
+          request_options: {}
+        )
+        end
+
+        # Adds the campaign and testing configuration, then starts asynchronous carrier
+        # launch. Agent basics must already be submitted. Repeating a launch that is
+        # already in progress returns the current agent without creating new work.
+        sig do
+          params(
+            id: String,
+            campaign: Telnyx::Rcs::AgentLaunchParams::Campaign::OrHash,
+            testing: Telnyx::Rcs::AgentTestingConfiguration::OrHash,
+            request_options: Telnyx::RequestOptions::OrHash
+          ).returns(Telnyx::Rcs::AgentResponse)
+        end
+        def launch(
+          # The Telnyx-assigned agent identifier.
+          id,
+          campaign:,
+          testing:,
+          request_options: {}
+        )
+        end
+
+        # Lists carrier approval records for an RCS agent. The provider may expose
+        # per-carrier, hub-level, or bot-level approval status.
+        sig do
+          params(
+            id: String,
+            request_options: Telnyx::RequestOptions::OrHash
+          ).returns(T::Array[Telnyx::Rcs::CarrierApprovalResponse])
+        end
+        def retrieve_carrier_approvals(
+          # The Telnyx-assigned agent identifier.
+          id,
+          request_options: {}
+        )
+        end
+
+        # Starts asynchronous provider provisioning and submits the agent's basic
+        # configuration. The brand must be `VERIFIED`. Repeating this request for an
+        # in-progress agent returns its current state without creating new work.
+        sig do
+          params(
+            id: String,
+            request_options: Telnyx::RequestOptions::OrHash
+          ).returns(Telnyx::Rcs::AgentResponse)
+        end
+        def submit(
+          # The Telnyx-assigned agent identifier.
+          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/rcs/brands.rbi

@@ -0,0 +1,127 @@
+# typed: strong
+
+module Telnyx
+  module Resources
+    class Rcs
+      # Manage the legal business entities that operate RCS agents.
+      class Brands
+        # Creates an editable RCS brand draft. Creating the draft does not begin external
+        # review.
+        sig do
+          params(
+            addresses:
+              T::Hash[Symbol, Telnyx::Rcs::BrandCreateParams::Address::OrHash],
+            contacts: Telnyx::Rcs::BrandCreateParams::Contacts::OrHash,
+            display_name: String,
+            identifiers: Telnyx::Rcs::BrandCreateParams::Identifiers::OrHash,
+            legal_entity_type: Telnyx::Rcs::BrandLegalEntityType::OrSymbol,
+            legal_name: String,
+            organization_type: Telnyx::Rcs::BrandOrganizationType::OrSymbol,
+            website_url: String,
+            profile_id: T.nilable(String),
+            request_options: Telnyx::RequestOptions::OrHash
+          ).returns(Telnyx::Rcs::BrandResponse)
+        end
+        def create(
+          addresses:,
+          # Named business contacts. Use the `brand` key for the required BRAND contact.
+          contacts:,
+          display_name:,
+          # Named business identifiers. Use the `ein` key for the required EIN and
+          # `stock_symbol` for a public-profit brand's stock symbol.
+          identifiers:,
+          legal_entity_type:,
+          legal_name:,
+          organization_type:,
+          website_url:,
+          # A Messaging Profile owned by the authenticated organization. Agents inherit this
+          # value when they do not provide their own profile.
+          profile_id: nil,
+          request_options: {}
+        )
+        end
+
+        # Retrieves an RCS brand and its current lifecycle status.
+        sig do
+          params(
+            id: String,
+            request_options: Telnyx::RequestOptions::OrHash
+          ).returns(Telnyx::Rcs::BrandResponse)
+        end
+        def retrieve(
+          # The Telnyx-assigned brand identifier.
+          id,
+          request_options: {}
+        )
+        end
+
+        # Updates one or more fields on a brand while its status is `CREATED`. Submitted
+        # brands cannot be changed.
+        sig do
+          params(
+            id: String,
+            addresses:
+              T::Hash[Symbol, Telnyx::Rcs::BrandUpdateParams::Address::OrHash],
+            contacts: Telnyx::Rcs::BrandUpdateParams::Contacts::OrHash,
+            display_name: String,
+            identifiers: Telnyx::Rcs::BrandUpdateParams::Identifiers::OrHash,
+            legal_entity_type: Telnyx::Rcs::BrandLegalEntityType::OrSymbol,
+            legal_name: String,
+            organization_type: Telnyx::Rcs::BrandOrganizationType::OrSymbol,
+            profile_id: String,
+            website_url: String,
+            request_options: Telnyx::RequestOptions::OrHash
+          ).returns(Telnyx::Rcs::BrandResponse)
+        end
+        def update(
+          # The Telnyx-assigned brand identifier.
+          id,
+          addresses: nil,
+          # Named business contacts. Use the `brand` key for the required BRAND contact.
+          contacts: nil,
+          display_name: nil,
+          # Named business identifiers. Use the `ein` key for the required EIN and
+          # `stock_symbol` for a public-profit brand's stock symbol.
+          identifiers: nil,
+          legal_entity_type: nil,
+          legal_name: nil,
+          organization_type: nil,
+          profile_id: nil,
+          website_url: nil,
+          request_options: {}
+        )
+        end
+
+        # Lists RCS brands owned by the authenticated organization.
+        sig do
+          params(request_options: Telnyx::RequestOptions::OrHash).returns(
+            T::Array[Telnyx::Rcs::BrandResponse]
+          )
+        end
+        def list(request_options: {})
+        end
+
+        # Starts asynchronous provider provisioning and external review for a brand.
+        # Repeating this request for an in-progress brand returns its current state
+        # without creating new work.
+        sig do
+          params(
+            id: String,
+            request_options: Telnyx::RequestOptions::OrHash
+          ).returns(Telnyx::Rcs::BrandResponse)
+        end
+        def submit(
+          # The Telnyx-assigned brand identifier.
+          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/rcs.rbi

@@ -0,0 +1,20 @@
+# typed: strong
+
+module Telnyx
+  module Resources
+    class Rcs
+      # Manage RCS agent registration, testing, verification, and launch.
+      sig { returns(Telnyx::Resources::Rcs::Agents) }
+      attr_reader :agents
+
+      # Manage the legal business entities that operate RCS agents.
+      sig { returns(Telnyx::Resources::Rcs::Brands) }
+      attr_reader :brands
+
+      # @api private
+      sig { params(client: Telnyx::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/rbi/telnyx/resources/regulatory_requirements.rbi

@@ -4,7 +4,9 @@ module Telnyx
   module Resources
     # Regulatory Requirements
     class RegulatoryRequirements
-      # Retrieve regulatory requirements
+      # Returns regulatory requirements for number ordering, porting, or other supported
+      # actions. Results can be filtered by phone number, requirement group, country,
+      # number type, and action.
       sig do
         params(
           filter: Telnyx::RegulatoryRequirementRetrieveParams::Filter::OrHash,