telnyx 5.159.0 → 5.161.0

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,

data/rbi/telnyx/resources/rooms.rbi

@@ -43,7 +43,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.
       sig do
         params(
           room_id: String,
@@ -95,7 +97,8 @@ module Telnyx
       )
       end
 
-      # 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.
       sig do
         params(
           filter: Telnyx::RoomListParams::Filter::OrHash,

data/rbi/telnyx/resources/short_codes.rbi

@@ -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.
       sig do
         params(
           id: String,
@@ -40,7 +41,8 @@ module Telnyx
       )
       end
 
-      # List short codes
+      # Returns short codes owned by the authenticated account. Apply the documented
+      # filters and pagination parameters to narrow the result set.
       sig do
         params(
           filter: Telnyx::ShortCodeListParams::Filter::OrHash,

data/rbi/telnyx/resources/sim_cards/actions.rbi

@@ -29,7 +29,7 @@ module Telnyx
             request_options: Telnyx::RequestOptions::OrHash
           ).returns(
             Telnyx::Internal::DefaultFlatPagination[
-              Telnyx::SimCards::SimCardAction
+              Telnyx::SimCards::WirelessSimCardAction
             ]
           )
         end
@@ -76,10 +76,19 @@ module Telnyx
         sig do
           params(
             sim_card_group_id: String,
+            connection_id: String,
             request_options: Telnyx::RequestOptions::OrHash
           ).returns(Telnyx::Models::SimCards::ActionBulkEnableVoiceResponse)
         end
-        def bulk_enable_voice(sim_card_group_id:, request_options: {})
+        def bulk_enable_voice(
+          sim_card_group_id:,
+          # The identifier of the Mobile Voice Connection to associate with the SIM cards.
+          # The connection must be owned by the same user and of type
+          # <code>mobile_voice</code>. If omitted, voice is enabled without a connection
+          # association.
+          connection_id: nil,
+          request_options: {}
+        )
         end
 
         # This API triggers an asynchronous operation to set a public IP for each of the
@@ -115,6 +124,25 @@ 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.
+        sig do
+          params(
+            id: String,
+            request_options: Telnyx::RequestOptions::OrHash
+          ).returns(Telnyx::Models::SimCards::ActionDisableVoiceResponse)
+        end
+        def disable_voice(
+          # Identifies the SIM.
+          id,
+          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
@@ -135,6 +163,33 @@ module Telnyx
         )
         end
 
+        # 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.
+        sig do
+          params(
+            id: String,
+            connection_id: String,
+            request_options: Telnyx::RequestOptions::OrHash
+          ).returns(Telnyx::Models::SimCards::ActionEnableVoiceResponse)
+        end
+        def enable_voice(
+          # Identifies the SIM.
+          id,
+          # The identifier of the Mobile Voice Connection to associate with this SIM card.
+          # The connection must be owned by the same user and of type
+          # <code>mobile_voice</code>. If omitted, voice is enabled without a connection
+          # association.
+          connection_id: nil,
+          request_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/rbi/telnyx/resources/sip_registration_status.rbi

@@ -4,9 +4,21 @@ module Telnyx
   module Resources
     # UAC connection operations
     class SipRegistrationStatus
-      # 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.
       sig do
         params(
           credential_type:
@@ -18,13 +30,14 @@ module Telnyx
       end
       def retrieve(
         # The kind of credential to look up. `uac_external_credential` is keyed by
-        # `connection_id`; `telephony_credential` is keyed by `username`.
+        # `connection_id`; `telephony_credential` and `sip_credential_connection` are
+        # keyed by `username`.
         credential_type:,
         # Identifier of the UAC connection to look up. Required when `credential_type` is
         # `uac_external_credential`.
         connection_id: nil,
-        # SIP username of the telephony credential to look up. Required when
-        # `credential_type` is `telephony_credential`.
+        # SIP username to look up. Required when `credential_type` is
+        # `telephony_credential` or `sip_credential_connection`.
         username: nil,
         request_options: {}
       )

data/rbi/telnyx/resources/storage/migration_sources.rbi

@@ -31,7 +31,7 @@ module Telnyx
         )
         end
 
-        # Get a Migration Source
+        # Retrieve the details of a specific migration source.
         sig do
           params(
             id: String,
@@ -45,7 +45,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.
         sig do
           params(request_options: Telnyx::RequestOptions::OrHash).returns(
             Telnyx::Models::Storage::MigrationSourceListResponse
@@ -54,7 +56,7 @@ module Telnyx
         def list(request_options: {})
         end
 
-        # Delete a Migration Source
+        # Delete a migration source configuration.
         sig do
           params(
             id: String,

data/rbi/telnyx/resources/storage/migrations/actions.rbi

@@ -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.
           sig do
             params(
               id: String,

data/rbi/telnyx/resources/storage/migrations.rbi

@@ -35,7 +35,7 @@ module Telnyx
         )
         end
 
-        # Get a Migration
+        # Retrieve the details and status of a specific storage migration.
         sig do
           params(
             id: String,
@@ -49,7 +49,7 @@ module Telnyx
         )
         end
 
-        # List all Migrations
+        # Retrieve a list of the storage migrations on your account.
         sig do
           params(request_options: Telnyx::RequestOptions::OrHash).returns(
             Telnyx::Models::Storage::MigrationListResponse

data/rbi/telnyx/resources/storage/sqldbs/actions.rbi

@@ -0,0 +1,50 @@
+# typed: strong
+
+module Telnyx
+  module Resources
+    class Storage
+      class Sqldbs
+        # Manage SQL databases and run SQL against them
+        class Actions
+          # 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.
+          sig do
+            params(
+              id: String,
+              sql: String,
+              params:
+                T::Array[
+                  T.nilable(
+                    Telnyx::Storage::Sqldbs::ActionQueryParams::Param::Variants
+                  )
+                ],
+              request_options: Telnyx::RequestOptions::OrHash
+            ).returns(Telnyx::Models::Storage::Sqldbs::ActionQueryResponse)
+          end
+          def query(
+            # SQL database ID
+            id,
+            # The SQL to run. Use positional `?` placeholders and supply the values in
+            # `params` rather than interpolating them into this string.
+            sql:,
+            # Positional bind parameters, in placeholder order. Each value is a string, a
+            # number, a boolean, or null; booleans are cast to `1`/`0`. The count must match
+            # the number of `?` placeholders exactly — a mismatch is rejected with 422 rather
+            # than binding null for the ones you left out. (Not enforced for multi-statement
+            # scripts or named parameters, where the placeholder count is not the number
+            # bound.)
+            params: nil,
+            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/storage/sqldbs.rbi

@@ -0,0 +1,105 @@
+# typed: strong
+
+module Telnyx
+  module Resources
+    class Storage
+      # Manage SQL databases and run SQL against them
+      class Sqldbs
+        # Manage SQL databases and run SQL against them
+        sig { returns(Telnyx::Resources::Storage::Sqldbs::Actions) }
+        attr_reader :actions
+
+        # Creates a new SQL database. Provisioning is asynchronous: the database is
+        # returned with status `pending` and becomes usable once it reaches
+        # `provision_ok`.
+        sig do
+          params(
+            name: String,
+            request_options: Telnyx::RequestOptions::OrHash
+          ).returns(Telnyx::Storage::SqlDatabaseResponseWrapper)
+        end
+        def create(
+          # Database name. Lowercase letters, numbers, and hyphens only; must start and end
+          # with a letter or number.
+          name:,
+          request_options: {}
+        )
+        end
+
+        # Retrieves a SQL database by its ID, including its provisioning status.
+        sig do
+          params(
+            id: String,
+            request_options: Telnyx::RequestOptions::OrHash
+          ).returns(Telnyx::Storage::SqlDatabaseResponseWrapper)
+        end
+        def retrieve(
+          # SQL database ID
+          id,
+          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.
+        sig do
+          params(
+            filter_name: String,
+            filter_status:
+              Telnyx::Storage::SqldbListParams::FilterStatus::OrSymbol,
+            page_number: Integer,
+            page_size: Integer,
+            sort: Telnyx::Storage::SqldbListParams::Sort::OrSymbol,
+            request_options: Telnyx::RequestOptions::OrHash
+          ).returns(
+            Telnyx::Internal::DefaultFlatPagination[
+              Telnyx::Storage::SqlDatabase
+            ]
+          )
+        end
+        def list(
+          # Filter by exact name match.
+          filter_name: nil,
+          # Filter by provisioning status.
+          filter_status: nil,
+          # The page number to load.
+          page_number: nil,
+          # The size of the page. Values above 250 are treated as 250.
+          page_size: nil,
+          # Sort field; prefix with `-` for descending order.
+          sort: nil,
+          request_options: {}
+        )
+        end
+
+        # 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`.
+        sig do
+          params(
+            id: String,
+            force: T::Boolean,
+            request_options: Telnyx::RequestOptions::OrHash
+          ).void
+        end
+        def delete(
+          # SQL database ID
+          id,
+          # Delete the database even when functions still bind it. Their bindings stop
+          # resolving.
+          force: nil,
+          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/storage.rbi

@@ -25,7 +25,11 @@ module Telnyx
       sig { returns(Telnyx::Resources::Storage::Cloudfs) }
       attr_reader :cloudfs
 
-      # List Migration Source coverage
+      # Manage SQL databases and run SQL against them
+      sig { returns(Telnyx::Resources::Storage::Sqldbs) }
+      attr_reader :sqldbs
+
+      # List the external storage providers and regions supported as migration sources.
       sig do
         params(request_options: Telnyx::RequestOptions::OrHash).returns(
           Telnyx::Models::StorageListMigrationSourceCoverageResponse

data/rbi/telnyx/resources/sub_number_orders.rbi

@@ -68,7 +68,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.
       sig do
         params(
           id: String,

data/rbi/telnyx/resources/user_addresses.rbi

@@ -98,7 +98,11 @@ module Telnyx
           page_size: Integer,
           sort: Telnyx::UserAddressListParams::Sort::OrSymbol,
           request_options: Telnyx::RequestOptions::OrHash
-        ).returns(Telnyx::Internal::DefaultFlatPagination[Telnyx::UserAddress])
+        ).returns(
+          Telnyx::Internal::DefaultFlatPagination[
+            Telnyx::UserAddressesUserAddress
+          ]
+        )
       end
       def list(
         # Consolidated filter parameter (deepObject style). Originally:

data/rbi/telnyx/resources/verifications/actions.rbi

@@ -5,7 +5,9 @@ module Telnyx
     class Verifications
       # Two factor authentication API
       class Actions
-        # 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.
         sig do
           params(
             verification_id: String,

data/rbi/telnyx/resources/verifications/by_phone_number/actions.rbi

@@ -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.
           sig do
             params(
               phone_number: String,

data/rbi/telnyx/resources/verifications/by_phone_number.rbi

@@ -11,7 +11,8 @@ module Telnyx
         end
         attr_reader :actions
 
-        # List verifications by phone number
+        # Returns a paginated list of verifications associated with the specified phone
+        # number.
         sig do
           params(
             phone_number: String,