telnyx 5.159.0 → 5.161.0

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

data/lib/telnyx/resources/sim_cards/actions.rb

@@ -41,7 +41,7 @@ module Telnyx
         #
         # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
         #
-        # @return [Telnyx::Internal::DefaultFlatPagination<Telnyx::Models::SimCards::SimCardAction>]
+        # @return [Telnyx::Internal::DefaultFlatPagination<Telnyx::Models::SimCards::WirelessSimCardAction>]
         #
         # @see Telnyx::Models::SimCards::ActionListParams
         def list(params = {})
@@ -52,7 +52,7 @@ module Telnyx
             path: "sim_card_actions",
             query: query.transform_keys(page_number: "page[number]", page_size: "page[size]"),
             page: Telnyx::Internal::DefaultFlatPagination,
-            model: Telnyx::SimCards::SimCardAction,
+            model: Telnyx::SimCards::WirelessSimCardAction,
             options: options
           )
         end
@@ -87,6 +87,9 @@ module Telnyx
           )
         end
 
+        # Some parameter documentations has been truncated, see
+        # {Telnyx::Models::SimCards::ActionBulkEnableVoiceParams} for more details.
+        #
         # This API triggers an asynchronous operation to enable voice on SIM cards
         # belonging to a specified SIM Card Group.<br/> For each SIM Card a SIM Card
         # Action will be generated. The status of the SIM Card Actions can be followed
@@ -98,9 +101,12 @@ module Telnyx
         # [List Bulk SIM Card Action](https://developers.telnyx.com/api-reference/sim-card-actions/list-bulk-sim-card-actions)
         # API.
         #
-        # @overload bulk_enable_voice(sim_card_group_id:, request_options: {})
+        # @overload bulk_enable_voice(sim_card_group_id:, connection_id: nil, request_options: {})
         #
         # @param sim_card_group_id [String]
+        #
+        # @param connection_id [String] The identifier of the Mobile Voice Connection to associate with the SIM cards. T
+        #
         # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
         #
         # @return [Telnyx::Models::SimCards::ActionBulkEnableVoiceResponse]
@@ -167,6 +173,31 @@ module Telnyx
           )
         end
 
+        # This API disables voice calling on a SIM card. The SIM card will no longer be
+        # able to make or receive calls.<br/> The API will trigger an asynchronous
+        # operation called a SIM Card Action. The status of the SIM Card Action can be
+        # followed through the
+        # [List SIM Card Action](https://developers.telnyx.com/api-reference/sim-card-actions/list-sim-card-actions)
+        # API.
+        #
+        # @overload disable_voice(id, request_options: {})
+        #
+        # @param id [String] Identifies the SIM.
+        #
+        # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Telnyx::Models::SimCards::ActionDisableVoiceResponse]
+        #
+        # @see Telnyx::Models::SimCards::ActionDisableVoiceParams
+        def disable_voice(id, params = {})
+          @client.request(
+            method: :post,
+            path: ["sim_cards/%1$s/actions/disable_voice", id],
+            model: Telnyx::Models::SimCards::ActionDisableVoiceResponse,
+            options: params[:request_options]
+          )
+        end
+
         # This API enables a SIM card, connecting it to the network and making it possible
         # to consume data.<br/> To enable a SIM card, it must be associated with a SIM
         # card group.<br/> The API will trigger an asynchronous operation called a SIM
@@ -193,6 +224,40 @@ module Telnyx
           )
         end
 
+        # Some parameter documentations has been truncated, see
+        # {Telnyx::Models::SimCards::ActionEnableVoiceParams} for more details.
+        #
+        # This API enables voice calling on a SIM card. When a <code>connection_id</code>
+        # is provided, the SIM is associated with the specified Mobile Voice Connection.
+        # The connection must be owned by the same user and of type
+        # <code>mobile_voice</code>.<br/> The API will trigger an asynchronous operation
+        # called a SIM Card Action. The status of the SIM Card Action can be followed
+        # through the
+        # [List SIM Card Action](https://developers.telnyx.com/api-reference/sim-card-actions/list-sim-card-actions)
+        # API.
+        #
+        # @overload enable_voice(id, connection_id: nil, request_options: {})
+        #
+        # @param id [String] Identifies the SIM.
+        #
+        # @param connection_id [String] The identifier of the Mobile Voice Connection to associate with this SIM card. T
+        #
+        # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Telnyx::Models::SimCards::ActionEnableVoiceResponse]
+        #
+        # @see Telnyx::Models::SimCards::ActionEnableVoiceParams
+        def enable_voice(id, params = {})
+          parsed, options = Telnyx::SimCards::ActionEnableVoiceParams.dump_request(params)
+          @client.request(
+            method: :post,
+            path: ["sim_cards/%1$s/actions/enable_voice", id],
+            body: parsed,
+            model: Telnyx::Models::SimCards::ActionEnableVoiceResponse,
+            options: options
+          )
+        end
+
         # This API removes an existing public IP from a SIM card. <br/><br/> The API will
         # trigger an asynchronous operation called a SIM Card Action. The status of the
         # SIM Card Action can be followed through the

data/lib/telnyx/resources/sip_registration_status.rb

@@ -7,9 +7,21 @@ module Telnyx
       # Some parameter documentations has been truncated, see
       # {Telnyx::Models::SipRegistrationStatusRetrieveParams} for more details.
       #
-      # Returns the live SIP registration state of a UAC connection: whether it is
-      # currently registered, when it last registered, and the last response Telnyx
-      # received from the registrar. Only `uac_external_credential` is supported today.
+      # Returns the live SIP registration status for a Telnyx endpoint: whether it is
+      # currently registered, when the current registration expires, and the last
+      # response Telnyx received from the registrar.
+      #
+      # The endpoint supports three credential types, selected with the
+      # `credential_type` query parameter. Each type is keyed by a different identifier:
+      #
+      # | `credential_type`           | Keyed by        | Use case                                                                   |
+      # | --------------------------- | --------------- | -------------------------------------------------------------------------- |
+      # | `uac_external_credential`   | `connection_id` | A UAC (SIP attach) connection that registers to an external PBX.           |
+      # | `telephony_credential`      | `username`      | An ephemeral, one-time-use telephony credential.                           |
+      # | `sip_credential_connection` | `username`      | A traditional SIP credential connection that registers directly to Telnyx. |
+      #
+      # The authenticated account is taken from your API key; you can only read the
+      # registration status of connections and credentials your account owns.
       #
       # @overload retrieve(credential_type:, connection_id: nil, username: nil, request_options: {})
       #
@@ -17,7 +29,7 @@ module Telnyx
       #
       # @param connection_id [String] Identifier of the UAC connection to look up. Required when `credential_type` is
       #
-      # @param username [String] SIP username of the telephony credential to look up. Required when `credential_t
+      # @param username [String] SIP username to look up. Required when `credential_type` is `telephony_credentia
       #
       # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
       #

data/lib/telnyx/resources/storage/migration_sources.rb

@@ -36,7 +36,7 @@ module Telnyx
           )
         end
 
-        # Get a Migration Source
+        # Retrieve the details of a specific migration source.
         #
         # @overload retrieve(id, request_options: {})
         #
@@ -56,7 +56,9 @@ module Telnyx
           )
         end
 
-        # List all Migration Sources
+        # List the migration sources configured on your account. A migration source is an
+        # external storage bucket from which data can be migrated into Telnyx Cloud
+        # Storage.
         #
         # @overload list(request_options: {})
         #
@@ -74,7 +76,7 @@ module Telnyx
           )
         end
 
-        # Delete a Migration Source
+        # Delete a migration source configuration.
         #
         # @overload delete(id, request_options: {})
         #

data/lib/telnyx/resources/storage/migrations/actions.rb

@@ -6,7 +6,7 @@ module Telnyx
       class Migrations
         # Migrate data from an external provider into Telnyx Cloud Storage
         class Actions
-          # Stop a Migration
+          # Stop an in-progress storage migration.
           #
           # @overload stop(id, request_options: {})
           #

data/lib/telnyx/resources/storage/migrations.rb

@@ -41,7 +41,7 @@ module Telnyx
           )
         end
 
-        # Get a Migration
+        # Retrieve the details and status of a specific storage migration.
         #
         # @overload retrieve(id, request_options: {})
         #
@@ -61,7 +61,7 @@ module Telnyx
           )
         end
 
-        # List all Migrations
+        # Retrieve a list of the storage migrations on your account.
         #
         # @overload list(request_options: {})
         #

data/lib/telnyx/resources/storage/sqldbs/actions.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Resources
+    class Storage
+      class Sqldbs
+        # Manage SQL databases and run SQL against them
+        class Actions
+          # Some parameter documentations has been truncated, see
+          # {Telnyx::Models::Storage::Sqldbs::ActionQueryParams} for more details.
+          #
+          # Runs SQL against the database and returns the resulting rows — empty for
+          # statements that return none, such as DDL. Bind positional `?` placeholders with
+          # `params` rather than interpolating values into the SQL string.
+          #
+          # @overload query(id, sql:, params: nil, request_options: {})
+          #
+          # @param id [String] SQL database ID
+          #
+          # @param sql [String] The SQL to run. Use positional `?` placeholders and supply the values in `params
+          #
+          # @param params [Array<String, Float, Boolean, nil>] Positional bind parameters, in placeholder order. Each value is a string, a numb
+          #
+          # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
+          #
+          # @return [Telnyx::Models::Storage::Sqldbs::ActionQueryResponse]
+          #
+          # @see Telnyx::Models::Storage::Sqldbs::ActionQueryParams
+          def query(id, params)
+            parsed, options = Telnyx::Storage::Sqldbs::ActionQueryParams.dump_request(params)
+            @client.request(
+              method: :post,
+              path: ["storage/sqldbs/%1$s/actions/query", id],
+              body: parsed,
+              model: Telnyx::Models::Storage::Sqldbs::ActionQueryResponse,
+              options: options
+            )
+          end
+
+          # @api private
+          #
+          # @param client [Telnyx::Client]
+          def initialize(client:)
+            @client = client
+          end
+        end
+      end
+    end
+  end
+end

data/lib/telnyx/resources/storage/sqldbs.rb

@@ -0,0 +1,140 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Resources
+    class Storage
+      # Manage SQL databases and run SQL against them
+      class Sqldbs
+        # Manage SQL databases and run SQL against them
+        # @return [Telnyx::Resources::Storage::Sqldbs::Actions]
+        attr_reader :actions
+
+        # Some parameter documentations has been truncated, see
+        # {Telnyx::Models::Storage::SqldbCreateParams} for more details.
+        #
+        # Creates a new SQL database. Provisioning is asynchronous: the database is
+        # returned with status `pending` and becomes usable once it reaches
+        # `provision_ok`.
+        #
+        # @overload create(name:, request_options: {})
+        #
+        # @param name [String] Database name. Lowercase letters, numbers, and hyphens only; must start and end
+        #
+        # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Telnyx::Models::Storage::SqlDatabaseResponseWrapper]
+        #
+        # @see Telnyx::Models::Storage::SqldbCreateParams
+        def create(params)
+          parsed, options = Telnyx::Storage::SqldbCreateParams.dump_request(params)
+          @client.request(
+            method: :post,
+            path: "storage/sqldbs",
+            body: parsed,
+            model: Telnyx::Storage::SqlDatabaseResponseWrapper,
+            options: options
+          )
+        end
+
+        # Retrieves a SQL database by its ID, including its provisioning status.
+        #
+        # @overload retrieve(id, request_options: {})
+        #
+        # @param id [String] SQL database ID
+        #
+        # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Telnyx::Models::Storage::SqlDatabaseResponseWrapper]
+        #
+        # @see Telnyx::Models::Storage::SqldbRetrieveParams
+        def retrieve(id, params = {})
+          @client.request(
+            method: :get,
+            path: ["storage/sqldbs/%1$s", id],
+            model: Telnyx::Storage::SqlDatabaseResponseWrapper,
+            options: params[:request_options]
+          )
+        end
+
+        # Lists the SQL databases for the authenticated user's organization. Results use
+        # page-based pagination (`page[number]`/`page[size]`) and can be filtered and
+        # sorted.
+        #
+        # @overload list(filter_name: nil, filter_status: nil, page_number: nil, page_size: nil, sort: nil, request_options: {})
+        #
+        # @param filter_name [String] Filter by exact name match.
+        #
+        # @param filter_status [Symbol, Telnyx::Models::Storage::SqldbListParams::FilterStatus] Filter by provisioning status.
+        #
+        # @param page_number [Integer] The page number to load.
+        #
+        # @param page_size [Integer] The size of the page. Values above 250 are treated as 250.
+        #
+        # @param sort [Symbol, Telnyx::Models::Storage::SqldbListParams::Sort] Sort field; prefix with `-` for descending order.
+        #
+        # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Telnyx::Internal::DefaultFlatPagination<Telnyx::Models::Storage::SqlDatabase>]
+        #
+        # @see Telnyx::Models::Storage::SqldbListParams
+        def list(params = {})
+          parsed, options = Telnyx::Storage::SqldbListParams.dump_request(params)
+          query = Telnyx::Internal::Util.encode_query_params(parsed)
+          @client.request(
+            method: :get,
+            path: "storage/sqldbs",
+            query: query.transform_keys(
+              filter_name: "filter[name]",
+              filter_status: "filter[status]",
+              page_number: "page[number]",
+              page_size: "page[size]"
+            ),
+            page: Telnyx::Internal::DefaultFlatPagination,
+            model: Telnyx::Storage::SqlDatabase,
+            options: options
+          )
+        end
+
+        # Some parameter documentations has been truncated, see
+        # {Telnyx::Models::Storage::SqldbDeleteParams} for more details.
+        #
+        # Deletes a SQL database and all of the data it holds. Deletion is asynchronous
+        # and returns `202` with an empty body — the record is not removed synchronously.
+        # Poll `GET /storage/sqldbs/{id}`, which returns `404` once the database has been
+        # purged; there is no durable `deleted` state. A database still bound by a
+        # function is refused with `409` unless `force=true`.
+        #
+        # @overload delete(id, force: nil, request_options: {})
+        #
+        # @param id [String] SQL database ID
+        #
+        # @param force [Boolean] Delete the database even when functions still bind it. Their bindings stop resol
+        #
+        # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [nil]
+        #
+        # @see Telnyx::Models::Storage::SqldbDeleteParams
+        def delete(id, params = {})
+          parsed, options = Telnyx::Storage::SqldbDeleteParams.dump_request(params)
+          query = Telnyx::Internal::Util.encode_query_params(parsed)
+          @client.request(
+            method: :delete,
+            path: ["storage/sqldbs/%1$s", id],
+            query: query,
+            model: NilClass,
+            options: options
+          )
+        end
+
+        # @api private
+        #
+        # @param client [Telnyx::Client]
+        def initialize(client:)
+          @client = client
+          @actions = Telnyx::Resources::Storage::Sqldbs::Actions.new(client: client)
+        end
+      end
+    end
+  end
+end

data/lib/telnyx/resources/storage.rb

@@ -25,7 +25,11 @@ module Telnyx
       # @return [Telnyx::Resources::Storage::Cloudfs]
       attr_reader :cloudfs
 
-      # List Migration Source coverage
+      # Manage SQL databases and run SQL against them
+      # @return [Telnyx::Resources::Storage::Sqldbs]
+      attr_reader :sqldbs
+
+      # List the external storage providers and regions supported as migration sources.
       #
       # @overload list_migration_source_coverage(request_options: {})
       #
@@ -53,6 +57,7 @@ module Telnyx
         @migrations = Telnyx::Resources::Storage::Migrations.new(client: client)
         @kvs = Telnyx::Resources::Storage::Kvs.new(client: client)
         @cloudfs = Telnyx::Resources::Storage::Cloudfs.new(client: client)
+        @sqldbs = Telnyx::Resources::Storage::Sqldbs.new(client: client)
       end
     end
   end

data/lib/telnyx/resources/sub_number_orders.rb

@@ -101,7 +101,9 @@ module Telnyx
         )
       end
 
-      # Update requirement group for a sub number order
+      # Associates an existing requirement group with the specified sub number order.
+      # The response contains the updated sub number order requirement-group
+      # relationship.
       #
       # @overload update_requirement_group(id, requirement_group_id:, request_options: {})
       #

data/lib/telnyx/resources/user_addresses.rb

@@ -96,7 +96,7 @@ module Telnyx
       #
       # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [Telnyx::Internal::DefaultFlatPagination<Telnyx::Models::UserAddress>]
+      # @return [Telnyx::Internal::DefaultFlatPagination<Telnyx::Models::UserAddressesUserAddress>]
       #
       # @see Telnyx::Models::UserAddressListParams
       def list(params = {})
@@ -107,7 +107,7 @@ module Telnyx
           path: "user_addresses",
           query: query.transform_keys(page_number: "page[number]", page_size: "page[size]"),
           page: Telnyx::Internal::DefaultFlatPagination,
-          model: Telnyx::UserAddress,
+          model: Telnyx::UserAddressesUserAddress,
           options: options
         )
       end

data/lib/telnyx/resources/verifications/actions.rb

@@ -8,7 +8,9 @@ module Telnyx
         # Some parameter documentations has been truncated, see
         # {Telnyx::Models::Verifications::ActionVerifyParams} for more details.
         #
-        # Verify verification code by ID
+        # Checks the supplied code, or the supplied status for a custom-code verification,
+        # against the verification identified by ID. The response indicates whether the
+        # verification was accepted or rejected.
         #
         # @overload verify(verification_id, code: nil, status: nil, request_options: {})
         #

data/lib/telnyx/resources/verifications/by_phone_number/actions.rb

@@ -6,7 +6,8 @@ module Telnyx
       class ByPhoneNumber
         # Two factor authentication API
         class Actions
-          # Verify verification code by phone number
+          # Submits a verification code for the specified phone number and Verify profile.
+          # The response indicates whether the code was accepted or rejected.
           #
           # @overload verify(phone_number, code:, verify_profile_id:, request_options: {})
           #