telnyx 5.159.0 → 5.160.0

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,

data/rbi/telnyx/resources/requirement_groups.rbi

@@ -4,7 +4,9 @@ module Telnyx
   module Resources
     # Requirement Groups
     class RequirementGroups
-      # Create a new requirement group
+      # Creates a regulatory requirement group for a country, number type, and ordering
+      # or porting action. Optional customer-reference and requirement values are
+      # retained on the created group.
       sig do
         params(
           action: Telnyx::RequirementGroupCreateParams::Action::OrSymbol,
@@ -30,7 +32,8 @@ module Telnyx
       )
       end
 
-      # Get a single requirement group by ID
+      # Returns the regulatory requirement group identified by `id`, including its
+      # requirement values and current approval status.
       sig do
         params(
           id: String,
@@ -44,7 +47,8 @@ module Telnyx
       )
       end
 
-      # Update requirement values in requirement group
+      # Updates the customer reference or regulatory requirement values on the specified
+      # requirement group. The response contains the updated group.
       sig do
         params(
           id: String,
@@ -66,7 +70,8 @@ module Telnyx
       )
       end
 
-      # List requirement groups
+      # Returns regulatory requirement groups for the account. Results can be filtered
+      # by country, number type, action, approval status, and customer reference.
       sig do
         params(
           filter: Telnyx::RequirementGroupListParams::Filter::OrHash,
@@ -82,7 +87,8 @@ module Telnyx
       )
       end
 
-      # Delete a requirement group by ID
+      # Deletes the regulatory requirement group identified by `id`. The response
+      # contains the deleted requirement-group representation.
       sig do
         params(
           id: String,
@@ -96,7 +102,8 @@ module Telnyx
       )
       end
 
-      # Submit a Requirement Group for Approval
+      # Submits the specified regulatory requirement group for approval. The response
+      # contains the requirement group with its resulting approval status.
       sig do
         params(
           id: String,

data/rbi/telnyx/resources/room_compositions.rbi

@@ -40,7 +40,9 @@ module Telnyx
       )
       end
 
-      # View a room composition.
+      # Returns the composition identified by `room_composition_id`, including its room
+      # and session, processing status, media details, video layout, lifecycle
+      # timestamps, and download URL.
       sig do
         params(
           room_composition_id: String,
@@ -54,7 +56,8 @@ module Telnyx
       )
       end
 
-      # View a list of room compositions.
+      # Returns a paginated list of room compositions. Filter compositions by creation
+      # date, room session, or processing status.
       sig do
         params(
           filter: Telnyx::RoomCompositionListParams::Filter::OrHash,

data/rbi/telnyx/resources/room_participants.rbi

@@ -4,7 +4,8 @@ module Telnyx
   module Resources
     # Rooms Participants operations.
     class RoomParticipants
-      # View a room participant.
+      # Returns the participant identified by `room_participant_id`, including its
+      # session, context, and join, update, and leave timestamps.
       sig do
         params(
           room_participant_id: String,
@@ -18,7 +19,8 @@ module Telnyx
       )
       end
 
-      # View a list of room participants.
+      # Returns a paginated list of room participants across sessions. Filter
+      # participants by session, join, update, or leave date and by participant context.
       sig do
         params(
           filter: Telnyx::RoomParticipantListParams::Filter::OrHash,

data/rbi/telnyx/resources/room_recordings.rbi

@@ -4,7 +4,9 @@ module Telnyx
   module Resources
     # Rooms Recordings operations.
     class RoomRecordings
-      # View a room recording.
+      # Returns the recording identified by `room_recording_id`, including its room,
+      # session, participant, status, media details, lifecycle timestamps, and download
+      # URL.
       sig do
         params(
           room_recording_id: String,
@@ -18,7 +20,8 @@ module Telnyx
       )
       end
 
-      # View a list of room recordings.
+      # Returns a paginated list of room recordings. Filter recordings by room, session,
+      # participant, recording type, status, duration, or start and end dates.
       sig do
         params(
           filter: Telnyx::RoomRecordingListParams::Filter::OrHash,
@@ -57,7 +60,9 @@ module Telnyx
       )
       end
 
-      # Delete several room recordings in a bulk.
+      # Deletes the room recordings that match the supplied filters and returns the
+      # number of recordings affected. Filters support room, session, participant,
+      # recording type, status, duration, and start or end dates.
       sig do
         params(
           filter: Telnyx::RoomRecordingDeleteBulkParams::Filter::OrHash,

data/rbi/telnyx/resources/rooms/sessions/actions.rbi

@@ -20,7 +20,9 @@ module Telnyx
           )
           end
 
-          # Kick participants from a room session.
+          # Removes the selected participants from the specified room session. Apply the
+          # action to a list of participant IDs or to `all`, with optional participant IDs
+          # excluded from the action.
           sig do
             params(
               room_session_id: String,
@@ -45,7 +47,9 @@ module Telnyx
           )
           end
 
-          # Mute participants in room session.
+          # Mutes the selected participants in the specified room session. Apply the action
+          # to a list of participant IDs or to `all`, with optional participant IDs excluded
+          # from the action.
           sig do
             params(
               room_session_id: String,
@@ -70,7 +74,9 @@ module Telnyx
           )
           end
 
-          # Unmute participants in room session.
+          # Unmutes the selected participants in the specified room session. Apply the
+          # action to a list of participant IDs or to `all`, with optional participant IDs
+          # excluded from the action.
           sig do
             params(
               room_session_id: String,

data/rbi/telnyx/resources/rooms/sessions.rbi

@@ -8,7 +8,9 @@ module Telnyx
         sig { returns(Telnyx::Resources::Rooms::Sessions::Actions) }
         attr_reader :actions
 
-        # View a room session.
+        # Returns the room session identified by `room_session_id`, including its room,
+        # active status, and lifecycle timestamps. Use `include_participants` to include
+        # its participant records.
         sig do
           params(
             room_session_id: String,
@@ -25,7 +27,9 @@ module Telnyx
         )
         end
 
-        # View a list of room sessions.
+        # Returns a paginated list of room sessions across the account. Filter sessions by
+        # room, creation, update, or end date and active status, and use
+        # `include_participants` to include participant records.
         sig do
           params(
             filter: Telnyx::Rooms::SessionList0Params::Filter::OrHash,
@@ -53,7 +57,9 @@ module Telnyx
         )
         end
 
-        # View a list of room sessions.
+        # Returns a paginated list of sessions for the specified room. Filter sessions by
+        # creation, update, or end date and active status, and use `include_participants`
+        # to include participant records.
         sig do
           params(
             room_id: String,
@@ -84,7 +90,8 @@ module Telnyx
         )
         end
 
-        # View a list of room participants.
+        # Returns a paginated list of participants for the specified room session. Filter
+        # participants by join, update, or leave date and by participant context.
         sig do
           params(
             room_session_id: String,