telnyx 5.159.0 → 5.161.0

data/lib/telnyx/resources/phone_numbers.rb

@@ -27,7 +27,8 @@ module Telnyx
       # @return [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`.
       #
       # @overload retrieve(id, request_options: {})
       #
@@ -50,7 +51,8 @@ module Telnyx
       # Some parameter documentations has been truncated, see
       # {Telnyx::Models::PhoneNumberUpdateParams} for more details.
       #
-      # Update a phone number
+      # Updates the configurable settings of the specified phone number. The response
+      # contains the complete updated phone-number representation.
       #
       # @overload update(phone_number_id, address_id: nil, billing_group_id: nil, connection_id: nil, customer_reference: nil, external_pin: nil, hd_voice_enabled: nil, tags: nil, request_options: {})
       #
@@ -89,7 +91,9 @@ module Telnyx
       # Some parameter documentations has been truncated, see
       # {Telnyx::Models::PhoneNumberListParams} for more details.
       #
-      # 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.
       #
       # @overload list(filter: nil, handle_messaging_profile_error: nil, page_number: nil, page_size: nil, sort: nil, request_options: {})
       #
@@ -105,7 +109,7 @@ module Telnyx
       #
       # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [Telnyx::Internal::DefaultFlatPagination<Telnyx::Models::PhoneNumberDetailed>]
+      # @return [Telnyx::Internal::DefaultFlatPagination<Telnyx::Models::NumbersPhoneNumberDetailed>]
       #
       # @see Telnyx::Models::PhoneNumberListParams
       def list(params = {})
@@ -116,12 +120,13 @@ module Telnyx
           path: "phone_numbers",
           query: query.transform_keys(page_number: "page[number]", page_size: "page[size]"),
           page: Telnyx::Internal::DefaultFlatPagination,
-          model: Telnyx::PhoneNumberDetailed,
+          model: Telnyx::NumbersPhoneNumberDetailed,
           options: options
         )
       end
 
-      # Delete a phone number
+      # Deletes the specified phone number from the account. The response contains the
+      # phone number's final deleted representation.
       #
       # @overload delete(id, request_options: {})
       #

data/lib/telnyx/resources/phone_numbers_regulatory_requirements.rb

@@ -8,7 +8,9 @@ module Telnyx
       # {Telnyx::Models::PhoneNumbersRegulatoryRequirementRetrieveParams} for more
       # details.
       #
-      # 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.
       #
       # @overload retrieve(filter: nil, request_options: {})
       #

data/lib/telnyx/resources/pricing/products.rb

@@ -11,10 +11,12 @@ module Telnyx
         # cached_input_rate) with tiered pricing. Some products use rate decks
         # (pricing_type: rate_deck) where rates are determined dynamically.
         #
-        # @overload retrieve(slug, page_number: nil, page_size: nil, request_options: {})
+        # @overload retrieve(slug, filter_country_iso: nil, page_number: nil, page_size: nil, request_options: {})
         #
         # @param slug [String] Product slug from the catalog listing.
         #
+        # @param filter_country_iso [String, nil]
+        #
         # @param page_number [Integer] Page number (1-based).
         #
         # @param page_size [Integer] Number of items per page (max 100).
@@ -30,7 +32,11 @@ module Telnyx
           @client.request(
             method: :get,
             path: ["pricing/products/%1$s", slug],
-            query: query,
+            query: query.transform_keys(
+              filter_country_iso: "filter[country_iso]",
+              page_number: "page[number]",
+              page_size: "page[size]"
+            ),
             model: Telnyx::Models::Pricing::ProductRetrieveResponse,
             options: options
           )
@@ -48,7 +54,7 @@ module Telnyx
         #
         # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
         #
-        # @return [Telnyx::Internal::DefaultFlatPaginationForInexplicitNumberOrders<Telnyx::Models::Pricing::ProductListResponse>]
+        # @return [Telnyx::Internal::DefaultFlatPagination<Telnyx::Models::Pricing::ProductListResponse>]
         #
         # @see Telnyx::Models::Pricing::ProductListParams
         def list(params = {})
@@ -57,8 +63,8 @@ module Telnyx
           @client.request(
             method: :get,
             path: "pricing/products",
-            query: query,
-            page: Telnyx::Internal::DefaultFlatPaginationForInexplicitNumberOrders,
+            query: query.transform_keys(page_number: "page[number]", page_size: "page[size]"),
+            page: Telnyx::Internal::DefaultFlatPagination,
             model: Telnyx::Models::Pricing::ProductListResponse,
             options: options
           )

data/lib/telnyx/resources/rcs/agents/test_devices.rb

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+
+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.
+          #
+          # @overload create(id, phone_number:, request_options: {})
+          #
+          # @param id [String] The Telnyx-assigned agent identifier.
+          #
+          # @param phone_number [String]
+          #
+          # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
+          #
+          # @return [Telnyx::Models::Rcs::Agents::TestDeviceResponse]
+          #
+          # @see Telnyx::Models::Rcs::Agents::TestDeviceCreateParams
+          def create(id, params)
+            parsed, options = Telnyx::Rcs::Agents::TestDeviceCreateParams.dump_request(params)
+            @client.request(
+              method: :post,
+              path: ["rcs/agents/%1$s/test_devices", id],
+              body: parsed,
+              model: Telnyx::Rcs::Agents::TestDeviceResponse,
+              options: options
+            )
+          end
+
+          # Lists test devices attached to an RCS agent.
+          #
+          # @overload list(id, request_options: {})
+          #
+          # @param id [String] The Telnyx-assigned agent identifier.
+          #
+          # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
+          #
+          # @return [Array<Telnyx::Models::Rcs::Agents::TestDeviceResponse>]
+          #
+          # @see Telnyx::Models::Rcs::Agents::TestDeviceListParams
+          def list(id, params = {})
+            @client.request(
+              method: :get,
+              path: ["rcs/agents/%1$s/test_devices", id],
+              model: Telnyx::Internal::Type::ArrayOf[Telnyx::Rcs::Agents::TestDeviceResponse],
+              options: params[:request_options]
+            )
+          end
+
+          # Removes a test device from an RCS agent and its provider registration.
+          #
+          # @overload delete(test_device_id, id:, request_options: {})
+          #
+          # @param test_device_id [String] The Telnyx-assigned test device identifier.
+          #
+          # @param id [String] The Telnyx-assigned agent identifier.
+          #
+          # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
+          #
+          # @return [nil]
+          #
+          # @see Telnyx::Models::Rcs::Agents::TestDeviceDeleteParams
+          def delete(test_device_id, params)
+            parsed, options = Telnyx::Rcs::Agents::TestDeviceDeleteParams.dump_request(params)
+            id =
+              parsed.delete(:id) do
+                raise ArgumentError.new("missing required path argument #{_1}")
+              end
+            @client.request(
+              method: :delete,
+              path: ["rcs/agents/%1$s/test_devices/%2$s", id, test_device_id],
+              model: NilClass,
+              options: options
+            )
+          end
+
+          # @api private
+          #
+          # @param client [Telnyx::Client]
+          def initialize(client:)
+            @client = client
+          end
+        end
+      end
+    end
+  end
+end

data/lib/telnyx/resources/rcs/agents.rb

@@ -0,0 +1,213 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Resources
+    class Rcs
+      # Manage RCS agent registration, testing, verification, and launch.
+      class Agents
+        # Manage RCS agent registration, testing, verification, and launch.
+        # @return [Telnyx::Resources::Rcs::Agents::TestDevices]
+        attr_reader :test_devices
+
+        # Some parameter documentations has been truncated, see
+        # {Telnyx::Models::Rcs::AgentCreateParams} for more details.
+        #
+        # 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.
+        #
+        # @overload create(brand_id:, configuration:, display_name:, use_case:, idempotency_key:, hosting_region: nil, profile_id: nil, request_options: {})
+        #
+        # @param brand_id [String] Body param
+        #
+        # @param configuration [Telnyx::Models::Rcs::AgentConfiguration] Body param
+        #
+        # @param display_name [String] Body param
+        #
+        # @param use_case [Symbol, Telnyx::Models::Rcs::AgentUseCase] Body param
+        #
+        # @param idempotency_key [String] Header param: A caller-generated key containing letters, numbers, underscores, o
+        #
+        # @param hosting_region [String, nil] Body param
+        #
+        # @param profile_id [String, nil] Body param: A Messaging Profile owned by the authenticated organization. When om
+        #
+        # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Telnyx::Models::Rcs::AgentResponse]
+        #
+        # @see Telnyx::Models::Rcs::AgentCreateParams
+        def create(params)
+          parsed, options = Telnyx::Rcs::AgentCreateParams.dump_request(params)
+          header_params = {idempotency_key: "idempotency-key"}
+          @client.request(
+            method: :post,
+            path: "rcs/agents",
+            headers: parsed.slice(*header_params.keys).transform_keys(header_params),
+            body: parsed.except(*header_params.keys),
+            model: Telnyx::Rcs::AgentResponse,
+            options: options
+          )
+        end
+
+        # Retrieves an RCS agent, section statuses, test devices, carrier approvals, and
+        # provider capabilities.
+        #
+        # @overload retrieve(id, request_options: {})
+        #
+        # @param id [String] The Telnyx-assigned agent identifier.
+        #
+        # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Telnyx::Models::Rcs::AgentResponse]
+        #
+        # @see Telnyx::Models::Rcs::AgentRetrieveParams
+        def retrieve(id, params = {})
+          @client.request(
+            method: :get,
+            path: ["rcs/agents/%1$s", id],
+            model: Telnyx::Rcs::AgentResponse,
+            options: params[:request_options]
+          )
+        end
+
+        # Updates one or more fields on an agent while its status is `CREATED`. Submitted
+        # agents cannot be changed through this endpoint.
+        #
+        # @overload update(id, configuration: nil, display_name: nil, hosting_region: nil, profile_id: nil, use_case: nil, request_options: {})
+        #
+        # @param id [String] The Telnyx-assigned agent identifier.
+        #
+        # @param configuration [Telnyx::Models::Rcs::AgentConfiguration]
+        #
+        # @param display_name [String]
+        #
+        # @param hosting_region [String]
+        #
+        # @param profile_id [String]
+        #
+        # @param use_case [Symbol, Telnyx::Models::Rcs::AgentUseCase]
+        #
+        # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Telnyx::Models::Rcs::AgentResponse]
+        #
+        # @see Telnyx::Models::Rcs::AgentUpdateParams
+        def update(id, params = {})
+          parsed, options = Telnyx::Rcs::AgentUpdateParams.dump_request(params)
+          @client.request(
+            method: :patch,
+            path: ["rcs/agents/%1$s", id],
+            body: parsed,
+            model: Telnyx::Rcs::AgentResponse,
+            options: options
+          )
+        end
+
+        # Lists RCS agents owned by the authenticated organization, optionally filtered by
+        # brand.
+        #
+        # @overload list(brand_id: nil, request_options: {})
+        #
+        # @param brand_id [String] Only return agents belonging to this brand.
+        #
+        # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Array<Telnyx::Models::Rcs::AgentResponse>]
+        #
+        # @see Telnyx::Models::Rcs::AgentListParams
+        def list(params = {})
+          parsed, options = Telnyx::Rcs::AgentListParams.dump_request(params)
+          query = Telnyx::Internal::Util.encode_query_params(parsed)
+          @client.request(
+            method: :get,
+            path: "rcs/agents",
+            query: query,
+            model: Telnyx::Internal::Type::ArrayOf[Telnyx::Rcs::AgentResponse],
+            options: 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.
+        #
+        # @overload launch(id, campaign:, testing:, request_options: {})
+        #
+        # @param id [String] The Telnyx-assigned agent identifier.
+        #
+        # @param campaign [Telnyx::Models::Rcs::AgentLaunchParams::Campaign]
+        #
+        # @param testing [Telnyx::Models::Rcs::AgentTestingConfiguration]
+        #
+        # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Telnyx::Models::Rcs::AgentResponse]
+        #
+        # @see Telnyx::Models::Rcs::AgentLaunchParams
+        def launch(id, params)
+          parsed, options = Telnyx::Rcs::AgentLaunchParams.dump_request(params)
+          @client.request(
+            method: :post,
+            path: ["rcs/agents/%1$s/launch", id],
+            body: parsed,
+            model: Telnyx::Rcs::AgentResponse,
+            options: options
+          )
+        end
+
+        # Lists carrier approval records for an RCS agent. The provider may expose
+        # per-carrier, hub-level, or bot-level approval status.
+        #
+        # @overload retrieve_carrier_approvals(id, request_options: {})
+        #
+        # @param id [String] The Telnyx-assigned agent identifier.
+        #
+        # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Array<Telnyx::Models::Rcs::CarrierApprovalResponse>]
+        #
+        # @see Telnyx::Models::Rcs::AgentRetrieveCarrierApprovalsParams
+        def retrieve_carrier_approvals(id, params = {})
+          @client.request(
+            method: :get,
+            path: ["rcs/agents/%1$s/carrier_approvals", id],
+            model: Telnyx::Internal::Type::ArrayOf[Telnyx::Rcs::CarrierApprovalResponse],
+            options: params[: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.
+        #
+        # @overload submit(id, request_options: {})
+        #
+        # @param id [String] The Telnyx-assigned agent identifier.
+        #
+        # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Telnyx::Models::Rcs::AgentResponse]
+        #
+        # @see Telnyx::Models::Rcs::AgentSubmitParams
+        def submit(id, params = {})
+          @client.request(
+            method: :post,
+            path: ["rcs/agents/%1$s/submit", id],
+            model: Telnyx::Rcs::AgentResponse,
+            options: params[:request_options]
+          )
+        end
+
+        # @api private
+        #
+        # @param client [Telnyx::Client]
+        def initialize(client:)
+          @client = client
+          @test_devices = Telnyx::Resources::Rcs::Agents::TestDevices.new(client: client)
+        end
+      end
+    end
+  end
+end

data/lib/telnyx/resources/rcs/brands.rb

@@ -0,0 +1,163 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Resources
+    class Rcs
+      # Manage the legal business entities that operate RCS agents.
+      class Brands
+        # Some parameter documentations has been truncated, see
+        # {Telnyx::Models::Rcs::BrandCreateParams} for more details.
+        #
+        # Creates an editable RCS brand draft. Creating the draft does not begin external
+        # review.
+        #
+        # @overload create(addresses:, contacts:, display_name:, identifiers:, legal_entity_type:, legal_name:, organization_type:, website_url:, profile_id: nil, request_options: {})
+        #
+        # @param addresses [Hash{Symbol=>Telnyx::Models::Rcs::BrandCreateParams::Address}]
+        #
+        # @param contacts [Telnyx::Models::Rcs::BrandCreateParams::Contacts] Named business contacts. Use the `brand` key for the required BRAND contact.
+        #
+        # @param display_name [String]
+        #
+        # @param identifiers [Telnyx::Models::Rcs::BrandCreateParams::Identifiers] Named business identifiers. Use the `ein` key for the required EIN and `stock_sy
+        #
+        # @param legal_entity_type [Symbol, Telnyx::Models::Rcs::BrandLegalEntityType]
+        #
+        # @param legal_name [String]
+        #
+        # @param organization_type [Symbol, Telnyx::Models::Rcs::BrandOrganizationType]
+        #
+        # @param website_url [String]
+        #
+        # @param profile_id [String, nil] A Messaging Profile owned by the authenticated organization. Agents inherit this
+        #
+        # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Telnyx::Models::Rcs::BrandResponse]
+        #
+        # @see Telnyx::Models::Rcs::BrandCreateParams
+        def create(params)
+          parsed, options = Telnyx::Rcs::BrandCreateParams.dump_request(params)
+          @client.request(
+            method: :post,
+            path: "rcs/brands",
+            body: parsed,
+            model: Telnyx::Rcs::BrandResponse,
+            options: options
+          )
+        end
+
+        # Retrieves an RCS brand and its current lifecycle status.
+        #
+        # @overload retrieve(id, request_options: {})
+        #
+        # @param id [String] The Telnyx-assigned brand identifier.
+        #
+        # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Telnyx::Models::Rcs::BrandResponse]
+        #
+        # @see Telnyx::Models::Rcs::BrandRetrieveParams
+        def retrieve(id, params = {})
+          @client.request(
+            method: :get,
+            path: ["rcs/brands/%1$s", id],
+            model: Telnyx::Rcs::BrandResponse,
+            options: params[:request_options]
+          )
+        end
+
+        # Some parameter documentations has been truncated, see
+        # {Telnyx::Models::Rcs::BrandUpdateParams} for more details.
+        #
+        # Updates one or more fields on a brand while its status is `CREATED`. Submitted
+        # brands cannot be changed.
+        #
+        # @overload update(id, addresses: nil, contacts: nil, display_name: nil, identifiers: nil, legal_entity_type: nil, legal_name: nil, organization_type: nil, profile_id: nil, website_url: nil, request_options: {})
+        #
+        # @param id [String] The Telnyx-assigned brand identifier.
+        #
+        # @param addresses [Hash{Symbol=>Telnyx::Models::Rcs::BrandUpdateParams::Address}]
+        #
+        # @param contacts [Telnyx::Models::Rcs::BrandUpdateParams::Contacts] Named business contacts. Use the `brand` key for the required BRAND contact.
+        #
+        # @param display_name [String]
+        #
+        # @param identifiers [Telnyx::Models::Rcs::BrandUpdateParams::Identifiers] Named business identifiers. Use the `ein` key for the required EIN and `stock_sy
+        #
+        # @param legal_entity_type [Symbol, Telnyx::Models::Rcs::BrandLegalEntityType]
+        #
+        # @param legal_name [String]
+        #
+        # @param organization_type [Symbol, Telnyx::Models::Rcs::BrandOrganizationType]
+        #
+        # @param profile_id [String]
+        #
+        # @param website_url [String]
+        #
+        # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Telnyx::Models::Rcs::BrandResponse]
+        #
+        # @see Telnyx::Models::Rcs::BrandUpdateParams
+        def update(id, params = {})
+          parsed, options = Telnyx::Rcs::BrandUpdateParams.dump_request(params)
+          @client.request(
+            method: :patch,
+            path: ["rcs/brands/%1$s", id],
+            body: parsed,
+            model: Telnyx::Rcs::BrandResponse,
+            options: options
+          )
+        end
+
+        # Lists RCS brands owned by the authenticated organization.
+        #
+        # @overload list(request_options: {})
+        #
+        # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Array<Telnyx::Models::Rcs::BrandResponse>]
+        #
+        # @see Telnyx::Models::Rcs::BrandListParams
+        def list(params = {})
+          @client.request(
+            method: :get,
+            path: "rcs/brands",
+            model: Telnyx::Internal::Type::ArrayOf[Telnyx::Rcs::BrandResponse],
+            options: params[: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.
+        #
+        # @overload submit(id, request_options: {})
+        #
+        # @param id [String] The Telnyx-assigned brand identifier.
+        #
+        # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Telnyx::Models::Rcs::BrandResponse]
+        #
+        # @see Telnyx::Models::Rcs::BrandSubmitParams
+        def submit(id, params = {})
+          @client.request(
+            method: :post,
+            path: ["rcs/brands/%1$s/submit", id],
+            model: Telnyx::Rcs::BrandResponse,
+            options: params[:request_options]
+          )
+        end
+
+        # @api private
+        #
+        # @param client [Telnyx::Client]
+        def initialize(client:)
+          @client = client
+        end
+      end
+    end
+  end
+end

data/lib/telnyx/resources/rcs.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Resources
+    class Rcs
+      # Manage RCS agent registration, testing, verification, and launch.
+      # @return [Telnyx::Resources::Rcs::Agents]
+      attr_reader :agents
+
+      # Manage the legal business entities that operate RCS agents.
+      # @return [Telnyx::Resources::Rcs::Brands]
+      attr_reader :brands
+
+      # @api private
+      #
+      # @param client [Telnyx::Client]
+      def initialize(client:)
+        @client = client
+        @agents = Telnyx::Resources::Rcs::Agents.new(client: client)
+        @brands = Telnyx::Resources::Rcs::Brands.new(client: client)
+      end
+    end
+  end
+end

data/lib/telnyx/resources/regulatory_requirements.rb

@@ -7,7 +7,9 @@ module Telnyx
       # Some parameter documentations has been truncated, see
       # {Telnyx::Models::RegulatoryRequirementRetrieveParams} for more details.
       #
-      # 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.
       #
       # @overload retrieve(filter: nil, request_options: {})
       #

data/lib/telnyx/resources/requirement_groups.rb

@@ -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.
       #
       # @overload create(action:, country_code:, phone_number_type:, customer_reference: nil, regulatory_requirements: nil, request_options: {})
       #
@@ -34,7 +36,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.
       #
       # @overload retrieve(id, request_options: {})
       #
@@ -54,7 +57,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.
       #
       # @overload update(id, customer_reference: nil, regulatory_requirements: nil, request_options: {})
       #
@@ -83,7 +87,8 @@ module Telnyx
       # Some parameter documentations has been truncated, see
       # {Telnyx::Models::RequirementGroupListParams} for more details.
       #
-      # List requirement groups
+      # Returns regulatory requirement groups for the account. Results can be filtered
+      # by country, number type, action, approval status, and customer reference.
       #
       # @overload list(filter: nil, request_options: {})
       #
@@ -106,7 +111,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.
       #
       # @overload delete(id, request_options: {})
       #
@@ -126,7 +132,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.
       #
       # @overload submit_for_approval(id, request_options: {})
       #