telnyx 5.162.0 → 5.164.0

data/rbi/telnyx/resources/porting_orders/activation_jobs.rbi

@@ -5,7 +5,8 @@ module Telnyx
     class PortingOrders
       # Endpoints related to porting orders management.
       class ActivationJobs
-        # Returns a porting activation job.
+        # Returns the details of a single activation job for the porting order, including
+        # its current status.
         sig do
           params(
             activation_job_id: String,

data/rbi/telnyx/resources/porting_orders/phone_number_blocks.rbi

@@ -5,7 +5,8 @@ module Telnyx
     class PortingOrders
       # Endpoints related to porting orders management.
       class PhoneNumberBlocks
-        # Creates a new phone number block.
+        # Creates a phone number block on the porting order, representing a contiguous
+        # range of phone numbers to be ported together.
         sig do
           params(
             porting_order_id: String,
@@ -64,7 +65,7 @@ module Telnyx
         )
         end
 
-        # Deletes a phone number block.
+        # Deletes the specified phone number block from the porting order.
         sig do
           params(
             id: String,

data/rbi/telnyx/resources/porting_orders/phone_number_extensions.rbi

@@ -5,7 +5,8 @@ module Telnyx
     class PortingOrders
       # Endpoints related to porting orders management.
       class PhoneNumberExtensions
-        # Creates a new phone number extension.
+        # Creates a phone number extension on the porting order, mapping extension ranges
+        # to one of the order's phone numbers.
         sig do
           params(
             porting_order_id: String,
@@ -67,7 +68,7 @@ module Telnyx
         )
         end
 
-        # Deletes a phone number extension.
+        # Deletes the specified phone number extension from the porting order.
         sig do
           params(
             id: String,

data/rbi/telnyx/resources/porting_orders.rbi

@@ -46,7 +46,9 @@ module Telnyx
       sig { returns(Telnyx::Resources::PortingOrders::PhoneNumberExtensions) }
       attr_reader :phone_number_extensions
 
-      # Creates a new porting order object.
+      # Creates a new porting order to bring phone numbers from another carrier to
+      # Telnyx. Complete the order's requirements and then confirm it to submit the
+      # port.
       sig do
         params(
           phone_numbers: T::Array[String],
@@ -139,7 +141,8 @@ module Telnyx
       )
       end
 
-      # Returns a list of your porting order.
+      # Returns a paginated list of your porting orders. Supports filtering and sorting,
+      # and can optionally include the phone numbers attached to each order.
       sig do
         params(
           filter: Telnyx::PortingOrderListParams::Filter::OrHash,
@@ -206,7 +209,8 @@ module Telnyx
       def retrieve_exception_types(request_options: {})
       end
 
-      # Download a porting order loa template
+      # Downloads the Letter of Authorization (LOA) template document for this porting
+      # order, optionally rendered with a specific LOA configuration.
       sig do
         params(
           id: String,

data/rbi/telnyx/resources/portouts/comments.rbi

@@ -5,7 +5,8 @@ module Telnyx
     class Portouts
       # Number portout operations
       class Comments
-        # Creates a comment on a portout request.
+        # Creates a comment on the specified port-out request and returns the created
+        # comment.
         sig do
           params(
             id: String,

data/rbi/telnyx/resources/portouts/events.rbi

@@ -5,7 +5,7 @@ module Telnyx
     class Portouts
       # Number portout operations
       class Events
-        # Show a specific port-out event.
+        # Returns the details of a single port-out event, including its type and payload.
         sig do
           params(
             id: String,
@@ -19,7 +19,8 @@ module Telnyx
         )
         end
 
-        # Returns a list of all port-out events.
+        # Returns a paginated list of port-out events on your account, such as status
+        # changes on port-out requests, with support for filtering.
         sig do
           params(
             filter: Telnyx::Portouts::EventListParams::Filter::OrHash,
@@ -42,7 +43,8 @@ module Telnyx
         )
         end
 
-        # Republish a specific port-out event.
+        # Republishes the specified port-out event, triggering re-delivery of the
+        # corresponding webhook to your account.
         sig do
           params(
             id: String,

data/rbi/telnyx/resources/portouts/reports.rbi

@@ -23,7 +23,8 @@ module Telnyx
         )
         end
 
-        # Retrieve a specific report generated.
+        # Returns the details of a previously requested port-out report, including its
+        # status and parameters.
         sig do
           params(
             id: String,

data/rbi/telnyx/resources/portouts.rbi

@@ -76,7 +76,8 @@ module Telnyx
       )
       end
 
-      # Authorize or reject portout request
+      # Updates the status of the specified port-out request, using the status path
+      # segment to authorize or reject the port-out.
       sig do
         params(
           status: Telnyx::PortoutUpdateStatusParams::Status::OrSymbol,

data/rbi/telnyx/resources/pricing/products.rbi

@@ -17,11 +17,17 @@ module Telnyx
             page_number: Integer,
             page_size: Integer,
             request_options: Telnyx::RequestOptions::OrHash
-          ).returns(Telnyx::Models::Pricing::ProductRetrieveResponse)
+          ).returns(
+            Telnyx::Internal::DefaultFlatPagination[
+              Telnyx::Models::Pricing::ProductRetrieveResponse
+            ]
+          )
         end
         def retrieve(
           # Product slug from the catalog listing.
           slug,
+          # Two-letter ISO 3166-1 alpha-2 country code (uppercase, e.g. US) to filter
+          # pricing to a single country.
           filter_country_iso: nil,
           # Page number (1-based).
           page_number: nil,

data/rbi/telnyx/resources/private_wireless_gateways.rbi

@@ -77,7 +77,7 @@ module Telnyx
       )
       end
 
-      # Deletes the Private Wireless Gateway.
+      # Permanently deletes the specified Private Wireless Gateway from your account.
       sig do
         params(
           id: String,

data/rbi/telnyx/resources/public_internet_gateways.rbi

@@ -4,7 +4,9 @@ module Telnyx
   module Resources
     # Public Internet Gateway operations
     class PublicInternetGateways
-      # Create a new Public Internet Gateway.
+      # Requests creation of a public internet gateway on the specified network, giving
+      # the network internet egress. Creation is asynchronous, so the request is
+      # accepted and completes in the background.
       sig do
         params(
           body: Telnyx::PublicInternetGatewayCreateParams::Body::OrHash,
@@ -14,7 +16,7 @@ module Telnyx
       def create(body:, request_options: {})
       end
 
-      # Retrieve a Public Internet Gateway.
+      # Returns the details of a single public internet gateway by its identifier.
       sig do
         params(
           id: String,
@@ -28,7 +30,8 @@ module Telnyx
       )
       end
 
-      # List all Public Internet Gateways.
+      # Returns a paginated list of the public internet gateways on your account, with
+      # support for filtering.
       sig do
         params(
           filter: Telnyx::PublicInternetGatewayListParams::Filter::OrHash,
@@ -50,7 +53,8 @@ module Telnyx
       )
       end
 
-      # Delete a Public Internet Gateway.
+      # Deletes the specified public internet gateway, removing internet egress through
+      # it.
       sig do
         params(
           id: String,

data/rbi/telnyx/resources/queues.rbi

@@ -8,7 +8,8 @@ module Telnyx
       sig { returns(Telnyx::Resources::Queues::Calls) }
       attr_reader :calls
 
-      # Create a new call queue.
+      # Creates a new call queue with the provided configuration and returns the created
+      # queue.
       sig do
         params(
           queue_name: String,
@@ -25,7 +26,8 @@ module Telnyx
       )
       end
 
-      # Retrieve an existing call queue
+      # Returns the details of an existing call queue, including its current
+      # configuration.
       sig do
         params(
           queue_name: String,
@@ -73,7 +75,7 @@ module Telnyx
       )
       end
 
-      # Delete an existing call queue.
+      # Permanently deletes the specified call queue from your account.
       sig do
         params(
           queue_name: String,

data/rbi/telnyx/resources/rcs/brands.rbi

@@ -9,8 +9,7 @@ module Telnyx
         # review.
         sig do
           params(
-            addresses:
-              T::Hash[Symbol, Telnyx::Rcs::BrandCreateParams::Address::OrHash],
+            addresses: T::Hash[Symbol, Telnyx::Rcs::BrandAddress::OrHash],
             contacts: Telnyx::Rcs::BrandCreateParams::Contacts::OrHash,
             display_name: String,
             identifiers: Telnyx::Rcs::BrandCreateParams::Identifiers::OrHash,
@@ -60,8 +59,7 @@ module Telnyx
         sig do
           params(
             id: String,
-            addresses:
-              T::Hash[Symbol, Telnyx::Rcs::BrandUpdateParams::Address::OrHash],
+            addresses: T::Hash[Symbol, Telnyx::Rcs::BrandAddress::OrHash],
             contacts: Telnyx::Rcs::BrandUpdateParams::Contacts::OrHash,
             display_name: String,
             identifiers: Telnyx::Rcs::BrandUpdateParams::Identifiers::OrHash,

data/rbi/telnyx/resources/recordings.rbi

@@ -22,7 +22,8 @@ module Telnyx
       )
       end
 
-      # Returns a list of your call recordings.
+      # Returns a paginated list of your call recordings, with support for filtering to
+      # locate specific recordings.
       sig do
         params(
           filter: Telnyx::RecordingListParams::Filter::OrHash,
@@ -42,7 +43,8 @@ module Telnyx
       )
       end
 
-      # Permanently deletes a call recording.
+      # Permanently deletes the specified call recording and returns the deleted
+      # recording resource. The media is removed and can no longer be downloaded.
       sig do
         params(
           recording_id: String,

data/rbi/telnyx/resources/reports/mdr_usage_reports.rbi

@@ -56,7 +56,7 @@ module Telnyx
         def list(page_number: nil, page_size: nil, request_options: {})
         end
 
-        # Delete messaging usage report by id
+        # Permanently deletes the specified messaging usage report by its identifier.
         sig do
           params(
             id: String,

data/rbi/telnyx/resources/reports.rbi

@@ -11,7 +11,8 @@ module Telnyx
       sig { returns(Telnyx::Resources::Reports::MdrUsageReports) }
       attr_reader :mdr_usage_reports
 
-      # Fetch all Mdr records
+      # Returns message detail records (MDRs) matching the provided criteria, such as
+      # date range, direction, status, and message type.
       sig do
         params(
           id: String,
@@ -49,7 +50,8 @@ module Telnyx
       )
       end
 
-      # Fetch all Wdr records
+      # Returns wireless detail records (WDRs) matching the provided criteria, such as
+      # date range, SIM card, IMSI, or phone number, with pagination and sorting.
       sig do
         params(
           id: String,

data/rbi/telnyx/resources/requirement_types.rbi

@@ -4,7 +4,8 @@ module Telnyx
   module Resources
     # Types of requirements for international numbers and porting orders
     class RequirementTypes
-      # Retrieve a requirement type by id
+      # Returns the details of a single requirement type by its identifier, describing a
+      # kind of documentation needed for regulatory purposes.
       sig do
         params(
           id: String,

data/rbi/telnyx/resources/requirements.rbi

@@ -4,7 +4,9 @@ module Telnyx
   module Resources
     # Requirements for international numbers and porting orders
     class Requirements
-      # Retrieve a document requirement record
+      # Returns a single document requirement record by its identifier, describing the
+      # documentation needed for number-related actions. A specific requirement version
+      # can be requested.
       sig do
         params(
           id: String,

data/rbi/telnyx/resources/room_recordings.rbi

@@ -46,7 +46,8 @@ module Telnyx
       )
       end
 
-      # Synchronously delete a Room Recording.
+      # Synchronously deletes the specified video room recording. The recording's media
+      # is removed permanently.
       sig do
         params(
           room_recording_id: String,

data/rbi/telnyx/resources/rooms.rbi

@@ -11,7 +11,8 @@ module Telnyx
       sig { returns(Telnyx::Resources::Rooms::Sessions) }
       attr_reader :sessions
 
-      # Synchronously create a Room.
+      # Synchronously creates a new video room with the provided configuration and
+      # returns the created room.
       sig do
         params(
           enable_recording: T::Boolean,
@@ -62,7 +63,8 @@ module Telnyx
       )
       end
 
-      # Synchronously update a Room.
+      # Synchronously updates the specified video room's configuration and returns the
+      # updated room.
       sig do
         params(
           room_id: String,

data/rbi/telnyx/resources/sim_card_groups/actions.rbi

@@ -72,8 +72,9 @@ module Telnyx
         )
         end
 
-        # This action will asynchronously remove an existing Wireless Blocklist to all the
-        # SIMs in the SIM card group.
+        # This action asynchronously removes the Wireless Blocklist assigned to a SIM Card
+        # Group. The request returns `404` when the SIM Card Group does not exist and
+        # `422` when no Wireless Blocklist is assigned.
         sig do
           params(
             id: String,
@@ -114,8 +115,9 @@ module Telnyx
         )
         end
 
-        # This action will asynchronously assign a Wireless Blocklist to all the SIMs in
-        # the SIM card group.
+        # This action asynchronously assigns a Wireless Blocklist to all SIMs in the SIM
+        # Card Group. The request returns `404` when the SIM Card Group does not exist and
+        # `422` when the Wireless Blocklist does not exist.
         sig do
           params(
             id: String,

data/rbi/telnyx/resources/sim_card_groups.rbi

@@ -7,7 +7,8 @@ module Telnyx
       sig { returns(Telnyx::Resources::SimCardGroups::Actions) }
       attr_reader :actions
 
-      # Creates a new SIM card group object
+      # Creates a new SIM card group and returns it. Groups let you apply shared
+      # settings to a set of SIM cards.
       sig do
         params(
           name: String,
@@ -41,7 +42,7 @@ module Telnyx
       )
       end
 
-      # Updates a SIM card group
+      # Updates the specified SIM card group's attributes and returns the updated group.
       sig do
         params(
           id: String,
@@ -91,7 +92,7 @@ module Telnyx
       )
       end
 
-      # Permanently deletes a SIM card group
+      # Permanently deletes the specified SIM card group from your account.
       sig do
         params(
           id: String,

data/rbi/telnyx/resources/sim_card_order_preview.rbi

@@ -4,7 +4,8 @@ module Telnyx
   module Resources
     # SIM Card Orders operations
     class SimCardOrderPreview
-      # Preview SIM card order purchases.
+      # Previews a SIM card order purchase, returning estimated costs and details before
+      # you place the order. The preview is processed asynchronously.
       sig do
         params(
           address_id: String,

data/rbi/telnyx/resources/sim_card_orders.rbi

@@ -4,7 +4,8 @@ module Telnyx
   module Resources
     # SIM Card Orders operations
     class SimCardOrders
-      # Creates a new order for SIM cards.
+      # Creates a new order for physical SIM cards, including quantity and shipping
+      # details, and returns the created order.
       sig do
         params(
           address_id: String,
@@ -21,7 +22,7 @@ module Telnyx
       )
       end
 
-      # Get a single SIM card order by its ID.
+      # Returns the details of a single SIM card order by its ID, including its status.
       sig do
         params(
           id: String,

data/rbi/telnyx/resources/sim_cards.rbi

@@ -29,7 +29,7 @@ module Telnyx
       )
       end
 
-      # Updates SIM card data
+      # Updates the specified SIM card's attributes and returns the updated SIM card.
       sig do
         params(
           sim_card_id: String,

data/rbi/telnyx/resources/siprec_connectors.rbi

@@ -67,7 +67,7 @@ module Telnyx
       )
       end
 
-      # Deletes a stored SIPREC connector.
+      # Deletes the stored SIPREC connector with the specified connector name.
       sig do
         params(
           connector_name: String,

data/rbi/telnyx/resources/speech_to_text.rbi

@@ -49,13 +49,14 @@ module Telnyx
       # `Authorization: Bearer <API_KEY>` header.
       #
       # Supported engines: `Azure`, `Deepgram`, `Google`, `Telnyx`, `xAI`,
-      # `Speechmatics`, `Soniox`, `Parakeet`, `Humain`, `Reson8`.
+      # `Speechmatics`, `Soniox`, `Parakeet`, `Humain`, `Reson8`, `Cohere`.
       #
       # **Connection flow:**
       #
       # 1. Open WebSocket with query parameters specifying engine, input format, and
       #    language.
-      # 2. Send binary audio frames (mp3/wav format).
+      # 2. Send binary audio frames (mp3, wav, linear16, or linear32 format, per
+      #    `input_format`).
       # 3. Receive JSON transcript frames with `transcript`, `is_final`, and
       #    `confidence` fields.
       # 4. Close connection when done.
@@ -73,6 +74,7 @@ module Telnyx
           model:
             Telnyx::SpeechToTextRetrieveTranscriptionParams::Model::OrSymbol,
           redact: String,
+          sample_rate: Integer,
           request_options: Telnyx::RequestOptions::OrHash
         ).void
       end
@@ -95,13 +97,19 @@ module Telnyx
         # Comma-separated list of keywords to boost in the transcription. The engine will
         # prioritize recognition of these words.
         keywords: nil,
-        # The language spoken in the audio stream.
+        # The language spoken in the audio stream. For `cohere/ar-stt`, this must be `ar`
+        # or `en` — unlike other engines, Cohere does not auto-detect the language, and
+        # rejects unsupported values including `auto`; omitting it defaults to `ar`.
         language: nil,
         # The specific model to use within the selected transcription engine.
         model: nil,
         # Enable redaction of sensitive information (e.g., PCI data, SSN) from
         # transcription results. Supported values depend on the transcription engine.
         redact: nil,
+        # Audio sample rate in Hz. Required when `input_format` is a raw encoding
+        # (`linear16`, `linear32`) — those formats carry no header metadata. Ignored for
+        # container formats (`mp3`, `wav`), which self-describe their rate.
+        sample_rate: nil,
         request_options: {}
       )
       end

data/rbi/telnyx/resources/storage/buckets.rbi

@@ -23,7 +23,7 @@ module Telnyx
           params(
             object_name: String,
             bucket_name: String,
-            ttl: Integer,
+            body: Telnyx::Storage::BucketCreatePresignedURLParams::Body::OrHash,
             request_options: Telnyx::RequestOptions::OrHash
           ).returns(Telnyx::Models::Storage::BucketCreatePresignedURLResponse)
         end
@@ -32,8 +32,8 @@ module Telnyx
           object_name,
           # Path param: The name of the bucket
           bucket_name:,
-          # Body param: The time to live of the token in seconds
-          ttl: nil,
+          # Body param
+          body: nil,
           request_options: {}
         )
         end

data/rbi/telnyx/resources/storage/cloudfs.rbi

@@ -98,7 +98,11 @@ module Telnyx
             page_limit: Integer,
             sort: Telnyx::Storage::CloudfListParams::Sort::OrSymbol,
             request_options: Telnyx::RequestOptions::OrHash
-          ).returns(Telnyx::Models::Storage::CloudfListResponse)
+          ).returns(
+            Telnyx::Internal::CloudfsCursorPagination[
+              Telnyx::Models::Storage::CloudfListResponse
+            ]
+          )
         end
         def list(
           # Return only the filesystem whose name matches exactly.

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

@@ -6,7 +6,8 @@ module Telnyx
       class Migrations
         # Migrate data from an external provider into Telnyx Cloud Storage
         class Actions
-          # Stop an in-progress storage migration.
+          # Stops the specified in-progress storage migration and returns the updated
+          # migration.
           sig do
             params(
               id: String,

data/rbi/telnyx/resources/sub_number_orders.rbi

@@ -3,7 +3,7 @@
 module Telnyx
   module Resources
     class SubNumberOrders
-      # Get an existing sub number order.
+      # Returns the details of an existing sub number order, with support for filtering.
       sig do
         params(
           sub_number_order_id: String,
@@ -21,7 +21,8 @@ module Telnyx
       )
       end
 
-      # Updates a sub number order.
+      # Updates the requirements of an existing sub number order and returns the updated
+      # order.
       sig do
         params(
           sub_number_order_id: String,
@@ -48,7 +49,7 @@ module Telnyx
       def list(
         # Consolidated filter parameter (deepObject style). Originally: filter[status],
         # filter[order_request_id], filter[country_code], filter[phone_number_type],
-        # filter[phone_numbers_count]
+        # filter[phone_numbers_count], filter[include_phone_numbers]
         filter: nil,
         request_options: {}
       )

data/rbi/telnyx/resources/telephony_credentials.rbi

@@ -3,7 +3,8 @@
 module Telnyx
   module Resources
     class TelephonyCredentials
-      # Create a credential.
+      # Creates a new on-demand telephony credential for the specified connection. The
+      # credential can then be used to generate access tokens for SIP or WebRTC clients.
       sig do
         params(
           connection_id: String,
@@ -39,7 +40,7 @@ module Telnyx
       )
       end
 
-      # Update an existing credential.
+      # Updates the specified telephony credential and returns the updated credential.
       sig do
         params(
           id: String,
@@ -64,7 +65,8 @@ module Telnyx
       )
       end
 
-      # List all On-demand Credentials.
+      # Returns a paginated list of the on-demand telephony credentials on your account,
+      # with support for filtering.
       sig do
         params(
           filter: Telnyx::TelephonyCredentialListParams::Filter::OrHash,
@@ -85,7 +87,8 @@ module Telnyx
       )
       end
 
-      # Delete an existing credential.
+      # Permanently deletes the specified telephony credential, revoking any access it
+      # provided.
       sig do
         params(
           id: String,