telnyx 5.159.0 → 5.160.0

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: {})
       #

data/lib/telnyx/resources/room_compositions.rb

@@ -41,7 +41,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.
       #
       # @overload retrieve(room_composition_id, request_options: {})
       #
@@ -64,7 +66,8 @@ module Telnyx
       # Some parameter documentations has been truncated, see
       # {Telnyx::Models::RoomCompositionListParams} for more details.
       #
-      # View a list of room compositions.
+      # Returns a paginated list of room compositions. Filter compositions by creation
+      # date, room session, or processing status.
       #
       # @overload list(filter: nil, page_number: nil, page_size: nil, request_options: {})
       #

data/lib/telnyx/resources/room_participants.rb

@@ -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.
       #
       # @overload retrieve(room_participant_id, request_options: {})
       #
@@ -27,7 +28,8 @@ module Telnyx
       # Some parameter documentations has been truncated, see
       # {Telnyx::Models::RoomParticipantListParams} for more details.
       #
-      # 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.
       #
       # @overload list(filter: nil, page_number: nil, page_size: nil, request_options: {})
       #

data/lib/telnyx/resources/room_recordings.rb

@@ -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.
       #
       # @overload retrieve(room_recording_id, request_options: {})
       #
@@ -27,7 +29,8 @@ module Telnyx
       # Some parameter documentations has been truncated, see
       # {Telnyx::Models::RoomRecordingListParams} for more details.
       #
-      # 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.
       #
       # @overload list(filter: nil, page_number: nil, page_size: nil, request_options: {})
       #
@@ -78,7 +81,9 @@ module Telnyx
       # Some parameter documentations has been truncated, see
       # {Telnyx::Models::RoomRecordingDeleteBulkParams} for more details.
       #
-      # 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.
       #
       # @overload delete_bulk(filter: nil, page_number: nil, page_size: nil, request_options: {})
       #

data/lib/telnyx/resources/rooms/sessions/actions.rb

@@ -29,7 +29,9 @@ module Telnyx
           # Some parameter documentations has been truncated, see
           # {Telnyx::Models::Rooms::Sessions::ActionKickParams} for more details.
           #
-          # 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.
           #
           # @overload kick(room_session_id, exclude: nil, participants: nil, request_options: {})
           #
@@ -58,7 +60,9 @@ module Telnyx
           # Some parameter documentations has been truncated, see
           # {Telnyx::Models::Rooms::Sessions::ActionMuteParams} for more details.
           #
-          # 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.
           #
           # @overload mute(room_session_id, exclude: nil, participants: nil, request_options: {})
           #
@@ -87,7 +91,9 @@ module Telnyx
           # Some parameter documentations has been truncated, see
           # {Telnyx::Models::Rooms::Sessions::ActionUnmuteParams} for more details.
           #
-          # 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.
           #
           # @overload unmute(room_session_id, exclude: nil, participants: nil, request_options: {})
           #

data/lib/telnyx/resources/rooms/sessions.rb

@@ -8,7 +8,9 @@ module Telnyx
         # @return [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.
         #
         # @overload retrieve(room_session_id, include_participants: nil, request_options: {})
         #
@@ -36,7 +38,9 @@ module Telnyx
         # Some parameter documentations has been truncated, see
         # {Telnyx::Models::Rooms::SessionList0Params} for more details.
         #
-        # 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.
         #
         # @overload list_0(filter: nil, include_participants: nil, page_number: nil, page_size: nil, request_options: {})
         #
@@ -69,7 +73,9 @@ module Telnyx
         # Some parameter documentations has been truncated, see
         # {Telnyx::Models::Rooms::SessionList1Params} for more details.
         #
-        # 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.
         #
         # @overload list_1(room_id, filter: nil, include_participants: nil, page_number: nil, page_size: nil, request_options: {})
         #
@@ -104,7 +110,8 @@ module Telnyx
         # Some parameter documentations has been truncated, see
         # {Telnyx::Models::Rooms::SessionRetrieveParticipantsParams} for more details.
         #
-        # 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.
         #
         # @overload retrieve_participants(room_session_id, filter: nil, page_number: nil, page_size: nil, request_options: {})
         #

data/lib/telnyx/resources/rooms.rb

@@ -46,7 +46,9 @@ module Telnyx
         )
       end
 
-      # View a room.
+      # Returns the room identified by `room_id`, including its participant limit,
+      # recording and webhook configuration, and active session identifier. Use
+      # `include_sessions` to include its sessions.
       #
       # @overload retrieve(room_id, include_sessions: nil, request_options: {})
       #
@@ -111,7 +113,8 @@ module Telnyx
       # Some parameter documentations has been truncated, see
       # {Telnyx::Models::RoomListParams} for more details.
       #
-      # View a list of rooms.
+      # Returns a paginated list of rooms. Filter the results by creation or update date
+      # and unique name, and use `include_sessions` to include each room’s sessions.
       #
       # @overload list(filter: nil, include_sessions: nil, page_number: nil, page_size: nil, request_options: {})
       #

data/lib/telnyx/resources/short_codes.rb

@@ -4,7 +4,8 @@ module Telnyx
   module Resources
     # Short codes
     class ShortCodes
-      # Retrieve a short code
+      # Returns the messaging configuration and assignment details for the specified
+      # short code.
       #
       # @overload retrieve(id, request_options: {})
       #
@@ -55,7 +56,8 @@ module Telnyx
       # Some parameter documentations has been truncated, see
       # {Telnyx::Models::ShortCodeListParams} for more details.
       #
-      # List short codes
+      # Returns short codes owned by the authenticated account. Apply the documented
+      # filters and pagination parameters to narrow the result set.
       #
       # @overload list(filter: nil, page_number: nil, page_size: nil, request_options: {})
       #