telnyx 5.126.0 → 5.128.0

data/rbi/telnyx/models/legacy/reporting/usage_report_retrieve_speech_to_text_params.rbi

@@ -16,12 +16,14 @@ module Telnyx
               )
             end
 
+          # End of the date range filter (inclusive, ISO 8601).
           sig { returns(T.nilable(Time)) }
           attr_reader :end_date
 
           sig { params(end_date: Time).void }
           attr_writer :end_date
 
+          # Start of the date range filter (inclusive, ISO 8601).
           sig { returns(T.nilable(Time)) }
           attr_reader :start_date
 
@@ -35,7 +37,13 @@ module Telnyx
               request_options: Telnyx::RequestOptions::OrHash
             ).returns(T.attached_class)
           end
-          def self.new(end_date: nil, start_date: nil, request_options: {})
+          def self.new(
+            # End of the date range filter (inclusive, ISO 8601).
+            end_date: nil,
+            # Start of the date range filter (inclusive, ISO 8601).
+            start_date: nil,
+            request_options: {}
+          )
           end
 
           sig do

data/rbi/telnyx/models/messaging_10dlc/brand_list_params.rbi

@@ -22,24 +22,28 @@ module Telnyx
         sig { params(brand_id: String).void }
         attr_writer :brand_id
 
+        # Filter results by country.
         sig { returns(T.nilable(String)) }
         attr_reader :country
 
         sig { params(country: String).void }
         attr_writer :country
 
+        # Filter results by display name.
         sig { returns(T.nilable(String)) }
         attr_reader :display_name
 
         sig { params(display_name: String).void }
         attr_writer :display_name
 
+        # Filter results by entity type.
         sig { returns(T.nilable(String)) }
         attr_reader :entity_type
 
         sig { params(entity_type: String).void }
         attr_writer :entity_type
 
+        # Page number to retrieve (1-based).
         sig { returns(T.nilable(Integer)) }
         attr_reader :page
 
@@ -69,6 +73,7 @@ module Telnyx
         end
         attr_writer :sort
 
+        # Filter results by state.
         sig { returns(T.nilable(String)) }
         attr_reader :state
 
@@ -99,15 +104,20 @@ module Telnyx
         def self.new(
           # Filter results by the Telnyx Brand id
           brand_id: nil,
+          # Filter results by country.
           country: nil,
+          # Filter results by display name.
           display_name: nil,
+          # Filter results by entity type.
           entity_type: nil,
+          # Page number to retrieve (1-based).
           page: nil,
           # number of records per page. maximum of 500
           records_per_page: nil,
           # Specifies the sort order for results. If not given, results are sorted by
           # createdAt in descending order.
           sort: nil,
+          # Filter results by state.
           state: nil,
           # Filter results by the TCR Brand id
           tcr_brand_id: nil,

data/rbi/telnyx/models/messaging_10dlc/campaign/usecase_get_cost_params.rbi

@@ -16,6 +16,7 @@ module Telnyx
               )
             end
 
+          # Filter results by usecase.
           sig { returns(String) }
           attr_accessor :usecase
 
@@ -25,7 +26,11 @@ module Telnyx
               request_options: Telnyx::RequestOptions::OrHash
             ).returns(T.attached_class)
           end
-          def self.new(usecase:, request_options: {})
+          def self.new(
+            # Filter results by usecase.
+            usecase:,
+            request_options: {}
+          )
           end
 
           sig do

data/rbi/telnyx/models/messaging_10dlc/campaign_list_params.rbi

@@ -15,6 +15,7 @@ module Telnyx
             )
           end
 
+        # Filter results by brand id.
         sig { returns(String) }
         attr_accessor :brand_id
 
@@ -61,6 +62,7 @@ module Telnyx
           ).returns(T.attached_class)
         end
         def self.new(
+          # Filter results by brand id.
           brand_id:,
           # The 1-indexed page number to get. The default value is `1`.
           page: nil,

data/rbi/telnyx/models/messaging_10dlc/phone_number_assignment_by_profile_list_phone_number_status_params.rbi

@@ -18,12 +18,14 @@ module Telnyx
         sig { returns(String) }
         attr_accessor :task_id
 
+        # Page number to retrieve (1-based).
         sig { returns(T.nilable(Integer)) }
         attr_reader :page
 
         sig { params(page: Integer).void }
         attr_writer :page
 
+        # Number of records to return per page.
         sig { returns(T.nilable(Integer)) }
         attr_reader :records_per_page
 
@@ -40,7 +42,9 @@ module Telnyx
         end
         def self.new(
           task_id:,
+          # Page number to retrieve (1-based).
           page: nil,
+          # Number of records to return per page.
           records_per_page: nil,
           request_options: {}
         )

data/rbi/telnyx/models/messaging_10dlc/phone_number_assignment_by_profile_retrieve_phone_number_status_params.rbi

@@ -18,12 +18,14 @@ module Telnyx
         sig { returns(String) }
         attr_accessor :task_id
 
+        # Page number to retrieve (1-based).
         sig { returns(T.nilable(Integer)) }
         attr_reader :page
 
         sig { params(page: Integer).void }
         attr_writer :page
 
+        # Number of records to return per page.
         sig { returns(T.nilable(Integer)) }
         attr_reader :records_per_page
 
@@ -40,7 +42,9 @@ module Telnyx
         end
         def self.new(
           task_id:,
+          # Page number to retrieve (1-based).
           page: nil,
+          # Number of records to return per page.
           records_per_page: nil,
           request_options: {}
         )

data/rbi/telnyx/models/messaging_10dlc/phone_number_campaign_list_params.rbi

@@ -35,12 +35,14 @@ module Telnyx
         end
         attr_writer :filter
 
+        # Page number to retrieve (1-based).
         sig { returns(T.nilable(Integer)) }
         attr_reader :page
 
         sig { params(page: Integer).void }
         attr_writer :page
 
+        # Number of records to return per page.
         sig { returns(T.nilable(Integer)) }
         attr_reader :records_per_page
 
@@ -82,7 +84,9 @@ module Telnyx
           # filter[telnyx_campaign_id], filter[telnyx_brand_id], filter[tcr_campaign_id],
           # filter[tcr_brand_id]
           filter: nil,
+          # Page number to retrieve (1-based).
           page: nil,
+          # Number of records to return per page.
           records_per_page: nil,
           # Specifies the sort order for results. If not given, results are sorted by
           # createdAt in descending order.

data/rbi/telnyx/models/messaging_hosted_number_list_params.rbi

@@ -35,12 +35,14 @@ module Telnyx
       sig { params(filter_phone_number_contains: String).void }
       attr_writer :filter_phone_number_contains
 
+      # Page number to retrieve (1-based).
       sig { returns(T.nilable(Integer)) }
       attr_reader :page_number
 
       sig { params(page_number: Integer).void }
       attr_writer :page_number
 
+      # Number of items to return per page.
       sig { returns(T.nilable(Integer)) }
       attr_reader :page_size
 
@@ -84,7 +86,9 @@ module Telnyx
         filter_phone_number: nil,
         # Filter by phone number substring.
         filter_phone_number_contains: nil,
+        # Page number to retrieve (1-based).
         page_number: nil,
+        # Number of items to return per page.
         page_size: nil,
         # Sort by phone number.
         sort_phone_number: nil,

data/rbi/telnyx/models/messaging_profile_list_alphanumeric_sender_ids_params.rbi

@@ -17,12 +17,14 @@ module Telnyx
       sig { returns(String) }
       attr_accessor :id
 
+      # Page number to retrieve (1-based).
       sig { returns(T.nilable(Integer)) }
       attr_reader :page_number
 
       sig { params(page_number: Integer).void }
       attr_writer :page_number
 
+      # Number of items to return per page.
       sig { returns(T.nilable(Integer)) }
       attr_reader :page_size
 
@@ -37,7 +39,14 @@ module Telnyx
           request_options: Telnyx::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
-      def self.new(id:, page_number: nil, page_size: nil, request_options: {})
+      def self.new(
+        id:,
+        # Page number to retrieve (1-based).
+        page_number: nil,
+        # Number of items to return per page.
+        page_size: nil,
+        request_options: {}
+      )
       end
 
       sig do

data/rbi/telnyx/models/messaging_profiles/autoresp_config_list_params.rbi

@@ -18,6 +18,7 @@ module Telnyx
         sig { returns(String) }
         attr_accessor :profile_id
 
+        # Filter results by country code.
         sig { returns(T.nilable(String)) }
         attr_reader :country_code
 
@@ -75,6 +76,7 @@ module Telnyx
         end
         def self.new(
           profile_id:,
+          # Filter results by country code.
           country_code: nil,
           # Consolidated created_at parameter (deepObject style). Originally:
           # created_at[gte], created_at[lte]

data/rbi/telnyx/models/messaging_tollfree/verification/request_list_params.rbi

@@ -16,6 +16,7 @@ module Telnyx
               )
             end
 
+          # Page number to retrieve (1-based).
           sig { returns(Integer) }
           attr_accessor :page
 
@@ -32,25 +33,28 @@ module Telnyx
           sig { params(business_name: String).void }
           attr_writer :business_name
 
+          # End of the date range filter (inclusive, ISO 8601).
           sig { returns(T.nilable(Time)) }
           attr_reader :date_end
 
           sig { params(date_end: Time).void }
           attr_writer :date_end
 
+          # Start of the date range filter (inclusive, ISO 8601).
           sig { returns(T.nilable(Time)) }
           attr_reader :date_start
 
           sig { params(date_start: Time).void }
           attr_writer :date_start
 
+          # Filter results by phone number.
           sig { returns(T.nilable(String)) }
           attr_reader :phone_number
 
           sig { params(phone_number: String).void }
           attr_writer :phone_number
 
-          # Tollfree verification status
+          # Filter results by status.
           sig do
             returns(
               T.nilable(
@@ -82,6 +86,7 @@ module Telnyx
             ).returns(T.attached_class)
           end
           def self.new(
+            # Page number to retrieve (1-based).
             page:,
             # Request this many records per page
             #
@@ -89,10 +94,13 @@ module Telnyx
             page_size:,
             # Filter verification requests by business name
             business_name: nil,
+            # End of the date range filter (inclusive, ISO 8601).
             date_end: nil,
+            # Start of the date range filter (inclusive, ISO 8601).
             date_start: nil,
+            # Filter results by phone number.
             phone_number: nil,
-            # Tollfree verification status
+            # Filter results by status.
             status: nil,
             request_options: {}
           )

data/rbi/telnyx/models/messaging_tollfree/verification/request_retrieve_status_history_params.rbi

@@ -19,11 +19,11 @@ module Telnyx
           sig { returns(String) }
           attr_accessor :id
 
+          # Page number to retrieve (1-based).
           sig { returns(Integer) }
           attr_accessor :page_number
 
-          # Request this many records per page. This value is automatically clamped if the
-          # provided value is too large.
+          # Number of items to return per page.
           sig { returns(Integer) }
           attr_accessor :page_size
 
@@ -37,9 +37,9 @@ module Telnyx
           end
           def self.new(
             id:,
+            # Page number to retrieve (1-based).
             page_number:,
-            # Request this many records per page. This value is automatically clamped if the
-            # provided value is too large.
+            # Number of items to return per page.
             page_size:,
             request_options: {}
           )

data/rbi/telnyx/models/network_list_interfaces_response.rbi

@@ -2,7 +2,7 @@
 
 module Telnyx
   module Models
-    class NetworkListInterfacesResponse < Telnyx::Internal::Type::BaseModel
+    class NetworkListInterfacesResponse < Telnyx::Models::Record
       OrHash =
         T.type_alias do
           T.any(
@@ -11,190 +11,13 @@ module Telnyx
           )
         end
 
-      # A user specified name for the interface.
-      sig { returns(T.nilable(String)) }
-      attr_reader :name
-
-      sig { params(name: String).void }
-      attr_writer :name
-
-      # The id of the network associated with the interface.
-      sig { returns(T.nilable(String)) }
-      attr_reader :network_id
-
-      sig { params(network_id: String).void }
-      attr_writer :network_id
-
-      sig do
-        returns(
-          T.nilable(Telnyx::Models::NetworkListInterfacesResponse::Region)
-        )
-      end
-      attr_reader :region
-
-      sig do
-        params(
-          region: Telnyx::Models::NetworkListInterfacesResponse::Region::OrHash
-        ).void
+      sig { returns(T.attached_class) }
+      def self.new
       end
-      attr_writer :region
-
-      # The region interface is deployed to.
-      sig { returns(T.nilable(String)) }
-      attr_reader :region_code
-
-      sig { params(region_code: String).void }
-      attr_writer :region_code
-
-      # Identifies the resource.
-      sig { returns(T.nilable(String)) }
-      attr_reader :id
-
-      sig { params(id: String).void }
-      attr_writer :id
-
-      # ISO 8601 formatted date-time indicating when the resource was created.
-      sig { returns(T.nilable(String)) }
-      attr_reader :created_at
-
-      sig { params(created_at: String).void }
-      attr_writer :created_at
-
-      # Identifies the type of the resource.
-      sig { returns(T.nilable(String)) }
-      attr_reader :record_type
-
-      sig { params(record_type: String).void }
-      attr_writer :record_type
-
-      # The current status of the interface deployment.
-      sig { returns(T.nilable(Telnyx::InterfaceStatus::TaggedSymbol)) }
-      attr_reader :status
-
-      sig { params(status: Telnyx::InterfaceStatus::OrSymbol).void }
-      attr_writer :status
-
-      # Identifies the type of the interface.
-      sig { returns(T.nilable(String)) }
-      attr_reader :type
-
-      sig { params(type: String).void }
-      attr_writer :type
-
-      # ISO 8601 formatted date-time indicating when the resource was updated.
-      sig { returns(T.nilable(String)) }
-      attr_reader :updated_at
-
-      sig { params(updated_at: String).void }
-      attr_writer :updated_at
 
-      sig do
-        params(
-          id: String,
-          created_at: String,
-          name: String,
-          network_id: String,
-          record_type: String,
-          region: Telnyx::Models::NetworkListInterfacesResponse::Region::OrHash,
-          region_code: String,
-          status: Telnyx::InterfaceStatus::OrSymbol,
-          type: String,
-          updated_at: String
-        ).returns(T.attached_class)
-      end
-      def self.new(
-        # Identifies the resource.
-        id: nil,
-        # ISO 8601 formatted date-time indicating when the resource was created.
-        created_at: nil,
-        # A user specified name for the interface.
-        name: nil,
-        # The id of the network associated with the interface.
-        network_id: nil,
-        # Identifies the type of the resource.
-        record_type: nil,
-        region: nil,
-        # The region interface is deployed to.
-        region_code: nil,
-        # The current status of the interface deployment.
-        status: nil,
-        # Identifies the type of the interface.
-        type: nil,
-        # ISO 8601 formatted date-time indicating when the resource was updated.
-        updated_at: nil
-      )
-      end
-
-      sig do
-        override.returns(
-          {
-            id: String,
-            created_at: String,
-            name: String,
-            network_id: String,
-            record_type: String,
-            region: Telnyx::Models::NetworkListInterfacesResponse::Region,
-            region_code: String,
-            status: Telnyx::InterfaceStatus::TaggedSymbol,
-            type: String,
-            updated_at: String
-          }
-        )
-      end
+      sig { override.returns({}) }
       def to_hash
       end
-
-      class Region < Telnyx::Internal::Type::BaseModel
-        OrHash =
-          T.type_alias do
-            T.any(
-              Telnyx::Models::NetworkListInterfacesResponse::Region,
-              Telnyx::Internal::AnyHash
-            )
-          end
-
-        # Region code of the interface.
-        sig { returns(T.nilable(String)) }
-        attr_reader :code
-
-        sig { params(code: String).void }
-        attr_writer :code
-
-        # Region name of the interface.
-        sig { returns(T.nilable(String)) }
-        attr_reader :name
-
-        sig { params(name: String).void }
-        attr_writer :name
-
-        # Identifies the type of the resource.
-        sig { returns(T.nilable(String)) }
-        attr_reader :record_type
-
-        sig { params(record_type: String).void }
-        attr_writer :record_type
-
-        sig do
-          params(code: String, name: String, record_type: String).returns(
-            T.attached_class
-          )
-        end
-        def self.new(
-          # Region code of the interface.
-          code: nil,
-          # Region name of the interface.
-          name: nil,
-          # Identifies the type of the resource.
-          record_type: nil
-        )
-        end
-
-        sig do
-          override.returns({ code: String, name: String, record_type: String })
-        end
-        def to_hash
-        end
-      end
     end
   end
 end

data/rbi/telnyx/models/organization_contact.rbi

@@ -8,48 +8,38 @@ module Telnyx
           T.any(Telnyx::OrganizationContact, Telnyx::Internal::AnyHash)
         end
 
-      # Contact's email address
       sig { returns(String) }
       attr_accessor :email
 
-      # Contact's first name
       sig { returns(String) }
       attr_accessor :first_name
 
-      # Contact's job title (required)
       sig { returns(String) }
       attr_accessor :job_title
 
-      # Contact's last name
       sig { returns(String) }
       attr_accessor :last_name
 
-      # Contact's phone number in E.164 format
+      # E.164 format with leading `+`.
       sig { returns(String) }
-      attr_accessor :phone
+      attr_accessor :phone_number
 
-      # Organization contact information. Note: the response returns this object with
-      # the phone field as 'phone' (not 'phone_number').
       sig do
         params(
           email: String,
           first_name: String,
           job_title: String,
           last_name: String,
-          phone: String
+          phone_number: String
         ).returns(T.attached_class)
       end
       def self.new(
-        # Contact's email address
         email:,
-        # Contact's first name
         first_name:,
-        # Contact's job title (required)
         job_title:,
-        # Contact's last name
         last_name:,
-        # Contact's phone number in E.164 format
-        phone:
+        # E.164 format with leading `+`.
+        phone_number:
       )
       end
 
@@ -60,7 +50,7 @@ module Telnyx
             first_name: String,
             job_title: String,
             last_name: String,
-            phone: String
+            phone_number: String
           }
         )
       end

data/rbi/telnyx/models/physical_address.rbi

@@ -8,27 +8,23 @@ module Telnyx
           T.any(Telnyx::PhysicalAddress, Telnyx::Internal::AnyHash)
         end
 
-      # State or province
+      # State or province code (e.g. `IL`, `ON`).
       sig { returns(String) }
       attr_accessor :administrative_area
 
-      # City name
       sig { returns(String) }
       attr_accessor :city
 
-      # Country name (e.g., United States)
+      # ISO 3166-1 alpha-2 code (currently `US` or `CA`).
       sig { returns(String) }
       attr_accessor :country
 
-      # ZIP or postal code
       sig { returns(String) }
       attr_accessor :postal_code
 
-      # Street address
       sig { returns(String) }
       attr_accessor :street_address
 
-      # Additional address line (suite, apt, etc.)
       sig { returns(T.nilable(String)) }
       attr_accessor :extended_address
 
@@ -43,17 +39,13 @@ module Telnyx
         ).returns(T.attached_class)
       end
       def self.new(
-        # State or province
+        # State or province code (e.g. `IL`, `ON`).
         administrative_area:,
-        # City name
         city:,
-        # Country name (e.g., United States)
+        # ISO 3166-1 alpha-2 code (currently `US` or `CA`).
         country:,
-        # ZIP or postal code
         postal_code:,
-        # Street address
         street_address:,
-        # Additional address line (suite, apt, etc.)
         extended_address: nil
       )
       end