telnyx 5.126.0 → 5.128.0

data/lib/telnyx/models/messaging_tollfree/verification/request_list_params.rb

@@ -10,6 +10,7 @@ module Telnyx
           include Telnyx::Internal::Type::RequestParameters
 
           # @!attribute page
+          #   Page number to retrieve (1-based).
           #
           #   @return [Integer]
           required :page, Integer
@@ -29,22 +30,25 @@ module Telnyx
           optional :business_name, String
 
           # @!attribute date_end
+          #   End of the date range filter (inclusive, ISO 8601).
           #
           #   @return [Time, nil]
           optional :date_end, Time
 
           # @!attribute date_start
+          #   Start of the date range filter (inclusive, ISO 8601).
           #
           #   @return [Time, nil]
           optional :date_start, Time
 
           # @!attribute phone_number
+          #   Filter results by phone number.
           #
           #   @return [String, nil]
           optional :phone_number, String
 
           # @!attribute status
-          #   Tollfree verification status
+          #   Filter results by status.
           #
           #   @return [Symbol, Telnyx::Models::MessagingTollfree::Verification::TfVerificationStatus, nil]
           optional :status, enum: -> { Telnyx::MessagingTollfree::Verification::TfVerificationStatus }
@@ -54,19 +58,19 @@ module Telnyx
           #   {Telnyx::Models::MessagingTollfree::Verification::RequestListParams} for more
           #   details.
           #
-          #   @param page [Integer]
+          #   @param page [Integer] Page number to retrieve (1-based).
           #
           #   @param page_size [Integer]
           #
           #   @param business_name [String] Filter verification requests by business name
           #
-          #   @param date_end [Time]
+          #   @param date_end [Time] End of the date range filter (inclusive, ISO 8601).
           #
-          #   @param date_start [Time]
+          #   @param date_start [Time] Start of the date range filter (inclusive, ISO 8601).
           #
-          #   @param phone_number [String]
+          #   @param phone_number [String] Filter results by phone number.
           #
-          #   @param status [Symbol, Telnyx::Models::MessagingTollfree::Verification::TfVerificationStatus] Tollfree verification status
+          #   @param status [Symbol, Telnyx::Models::MessagingTollfree::Verification::TfVerificationStatus] Filter results by status.
           #
           #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
         end

data/lib/telnyx/models/messaging_tollfree/verification/request_retrieve_status_history_params.rb

@@ -15,27 +15,23 @@ module Telnyx
           required :id, String
 
           # @!attribute page_number
+          #   Page number to retrieve (1-based).
           #
           #   @return [Integer]
           required :page_number, Integer
 
           # @!attribute page_size
-          #   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.
           #
           #   @return [Integer]
           required :page_size, Integer
 
           # @!method initialize(id:, page_number:, page_size:, request_options: {})
-          #   Some parameter documentations has been truncated, see
-          #   {Telnyx::Models::MessagingTollfree::Verification::RequestRetrieveStatusHistoryParams}
-          #   for more details.
-          #
           #   @param id [String]
           #
-          #   @param page_number [Integer]
+          #   @param page_number [Integer] Page number to retrieve (1-based).
           #
-          #   @param page_size [Integer] Request this many records per page. This value is automatically clamped if the p
+          #   @param page_size [Integer] Number of items to return per page.
           #
           #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
         end

data/lib/telnyx/models/network_list_interfaces_response.rb

@@ -3,118 +3,8 @@
 module Telnyx
   module Models
     # @see Telnyx::Resources::Networks#list_interfaces
-    class NetworkListInterfacesResponse < Telnyx::Internal::Type::BaseModel
-      # @!attribute name
-      #   A user specified name for the interface.
-      #
-      #   @return [String, nil]
-      optional :name, String
-
-      # @!attribute network_id
-      #   The id of the network associated with the interface.
-      #
-      #   @return [String, nil]
-      optional :network_id, String
-
-      # @!attribute region
-      #
-      #   @return [Telnyx::Models::NetworkListInterfacesResponse::Region, nil]
-      optional :region, -> { Telnyx::Models::NetworkListInterfacesResponse::Region }
-
-      # @!attribute region_code
-      #   The region interface is deployed to.
-      #
-      #   @return [String, nil]
-      optional :region_code, String
-
-      response_only do
-        # @!attribute id
-        #   Identifies the resource.
-        #
-        #   @return [String, nil]
-        optional :id, String
-
-        # @!attribute created_at
-        #   ISO 8601 formatted date-time indicating when the resource was created.
-        #
-        #   @return [String, nil]
-        optional :created_at, String
-
-        # @!attribute record_type
-        #   Identifies the type of the resource.
-        #
-        #   @return [String, nil]
-        optional :record_type, String
-
-        # @!attribute status
-        #   The current status of the interface deployment.
-        #
-        #   @return [Symbol, Telnyx::Models::InterfaceStatus, nil]
-        optional :status, enum: -> { Telnyx::InterfaceStatus }
-
-        # @!attribute type
-        #   Identifies the type of the interface.
-        #
-        #   @return [String, nil]
-        optional :type, String
-
-        # @!attribute updated_at
-        #   ISO 8601 formatted date-time indicating when the resource was updated.
-        #
-        #   @return [String, nil]
-        optional :updated_at, String
-      end
-
-      # @!method initialize(id: nil, created_at: nil, name: nil, network_id: nil, record_type: nil, region: nil, region_code: nil, status: nil, type: nil, updated_at: nil)
-      #   @param id [String] Identifies the resource.
-      #
-      #   @param created_at [String] ISO 8601 formatted date-time indicating when the resource was created.
-      #
-      #   @param name [String] A user specified name for the interface.
-      #
-      #   @param network_id [String] The id of the network associated with the interface.
-      #
-      #   @param record_type [String] Identifies the type of the resource.
-      #
-      #   @param region [Telnyx::Models::NetworkListInterfacesResponse::Region]
-      #
-      #   @param region_code [String] The region interface is deployed to.
-      #
-      #   @param status [Symbol, Telnyx::Models::InterfaceStatus] The current status of the interface deployment.
-      #
-      #   @param type [String] Identifies the type of the interface.
-      #
-      #   @param updated_at [String] ISO 8601 formatted date-time indicating when the resource was updated.
-
-      # @see Telnyx::Models::NetworkListInterfacesResponse#region
-      class Region < Telnyx::Internal::Type::BaseModel
-        # @!attribute code
-        #   Region code of the interface.
-        #
-        #   @return [String, nil]
-        optional :code, String
-
-        # @!attribute name
-        #   Region name of the interface.
-        #
-        #   @return [String, nil]
-        optional :name, String
-
-        response_only do
-          # @!attribute record_type
-          #   Identifies the type of the resource.
-          #
-          #   @return [String, nil]
-          optional :record_type, String
-        end
-
-        # @!method initialize(code: nil, name: nil, record_type: nil)
-        #   @param code [String] Region code of the interface.
-        #
-        #   @param name [String] Region name of the interface.
-        #
-        #   @param record_type [String] Identifies the type of the resource.
-      end
+    class NetworkListInterfacesResponse < Telnyx::Models::Record
+      # @!method initialize
     end
   end
 end

data/lib/telnyx/models/organization_contact.rb

@@ -4,48 +4,41 @@ module Telnyx
   module Models
     class OrganizationContact < Telnyx::Internal::Type::BaseModel
       # @!attribute email
-      #   Contact's email address
       #
       #   @return [String]
       required :email, String
 
       # @!attribute first_name
-      #   Contact's first name
       #
       #   @return [String]
       required :first_name, String
 
       # @!attribute job_title
-      #   Contact's job title (required)
       #
       #   @return [String]
       required :job_title, String
 
       # @!attribute last_name
-      #   Contact's last name
       #
       #   @return [String]
       required :last_name, String
 
-      # @!attribute phone
-      #   Contact's phone number in E.164 format
+      # @!attribute phone_number
+      #   E.164 format with leading `+`.
       #
       #   @return [String]
-      required :phone, String
+      required :phone_number, String
 
-      # @!method initialize(email:, first_name:, job_title:, last_name:, phone:)
-      #   Organization contact information. Note: the response returns this object with
-      #   the phone field as 'phone' (not 'phone_number').
+      # @!method initialize(email:, first_name:, job_title:, last_name:, phone_number:)
+      #   @param email [String]
       #
-      #   @param email [String] Contact's email address
+      #   @param first_name [String]
       #
-      #   @param first_name [String] Contact's first name
+      #   @param job_title [String]
       #
-      #   @param job_title [String] Contact's job title (required)
+      #   @param last_name [String]
       #
-      #   @param last_name [String] Contact's last name
-      #
-      #   @param phone [String] Contact's phone number in E.164 format
+      #   @param phone_number [String] E.164 format with leading `+`.
     end
   end
 end

data/lib/telnyx/models/physical_address.rb

@@ -4,53 +4,49 @@ module Telnyx
   module Models
     class PhysicalAddress < Telnyx::Internal::Type::BaseModel
       # @!attribute administrative_area
-      #   State or province
+      #   State or province code (e.g. `IL`, `ON`).
       #
       #   @return [String]
       required :administrative_area, String
 
       # @!attribute city
-      #   City name
       #
       #   @return [String]
       required :city, String
 
       # @!attribute country
-      #   Country name (e.g., United States)
+      #   ISO 3166-1 alpha-2 code (currently `US` or `CA`).
       #
       #   @return [String]
       required :country, String
 
       # @!attribute postal_code
-      #   ZIP or postal code
       #
       #   @return [String]
       required :postal_code, String
 
       # @!attribute street_address
-      #   Street address
       #
       #   @return [String]
       required :street_address, String
 
       # @!attribute extended_address
-      #   Additional address line (suite, apt, etc.)
       #
       #   @return [String, nil]
       optional :extended_address, String, nil?: true
 
       # @!method initialize(administrative_area:, city:, country:, postal_code:, street_address:, extended_address: nil)
-      #   @param administrative_area [String] State or province
+      #   @param administrative_area [String] State or province code (e.g. `IL`, `ON`).
       #
-      #   @param city [String] City name
+      #   @param city [String]
       #
-      #   @param country [String] Country name (e.g., United States)
+      #   @param country [String] ISO 3166-1 alpha-2 code (currently `US` or `CA`).
       #
-      #   @param postal_code [String] ZIP or postal code
+      #   @param postal_code [String]
       #
-      #   @param street_address [String] Street address
+      #   @param street_address [String]
       #
-      #   @param extended_address [String, nil] Additional address line (suite, apt, etc.)
+      #   @param extended_address [String, nil]
     end
   end
 end

data/lib/telnyx/models/public_internet_gateway_create_response.rb

@@ -6,11 +6,16 @@ module Telnyx
     class PublicInternetGatewayCreateResponse < Telnyx::Internal::Type::BaseModel
       # @!attribute data
       #
-      #   @return [Telnyx::Models::PublicInternetGatewayRead, nil]
-      optional :data, -> { Telnyx::PublicInternetGatewayRead }
+      #   @return [Telnyx::Models::PublicInternetGatewayCreateResponse::Data, nil]
+      optional :data, -> { Telnyx::Models::PublicInternetGatewayCreateResponse::Data }
 
       # @!method initialize(data: nil)
-      #   @param data [Telnyx::Models::PublicInternetGatewayRead]
+      #   @param data [Telnyx::Models::PublicInternetGatewayCreateResponse::Data]
+
+      # @see Telnyx::Models::PublicInternetGatewayCreateResponse#data
+      class Data < Telnyx::Models::Record
+        # @!method initialize
+      end
     end
   end
 end

data/lib/telnyx/models/public_internet_gateway_delete_response.rb

@@ -6,11 +6,16 @@ module Telnyx
     class PublicInternetGatewayDeleteResponse < Telnyx::Internal::Type::BaseModel
       # @!attribute data
       #
-      #   @return [Telnyx::Models::PublicInternetGatewayRead, nil]
-      optional :data, -> { Telnyx::PublicInternetGatewayRead }
+      #   @return [Telnyx::Models::PublicInternetGatewayDeleteResponse::Data, nil]
+      optional :data, -> { Telnyx::Models::PublicInternetGatewayDeleteResponse::Data }
 
       # @!method initialize(data: nil)
-      #   @param data [Telnyx::Models::PublicInternetGatewayRead]
+      #   @param data [Telnyx::Models::PublicInternetGatewayDeleteResponse::Data]
+
+      # @see Telnyx::Models::PublicInternetGatewayDeleteResponse#data
+      class Data < Telnyx::Models::Record
+        # @!method initialize
+      end
     end
   end
 end

data/lib/telnyx/models/public_internet_gateway_list_response.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    # @see Telnyx::Resources::PublicInternetGateways#list
+    class PublicInternetGatewayListResponse < Telnyx::Models::Record
+      # @!method initialize
+    end
+  end
+end

data/lib/telnyx/models/public_internet_gateway_retrieve_response.rb

@@ -6,11 +6,16 @@ module Telnyx
     class PublicInternetGatewayRetrieveResponse < Telnyx::Internal::Type::BaseModel
       # @!attribute data
       #
-      #   @return [Telnyx::Models::PublicInternetGatewayRead, nil]
-      optional :data, -> { Telnyx::PublicInternetGatewayRead }
+      #   @return [Telnyx::Models::PublicInternetGatewayRetrieveResponse::Data, nil]
+      optional :data, -> { Telnyx::Models::PublicInternetGatewayRetrieveResponse::Data }
 
       # @!method initialize(data: nil)
-      #   @param data [Telnyx::Models::PublicInternetGatewayRead]
+      #   @param data [Telnyx::Models::PublicInternetGatewayRetrieveResponse::Data]
+
+      # @see Telnyx::Models::PublicInternetGatewayRetrieveResponse#data
+      class Data < Telnyx::Models::Record
+        # @!method initialize
+      end
     end
   end
 end

data/lib/telnyx/models/report_list_mdrs_params.rb

@@ -8,25 +8,25 @@ module Telnyx
       include Telnyx::Internal::Type::RequestParameters
 
       # @!attribute id
-      #   Message uuid
+      #   Filter results by identifier.
       #
       #   @return [String, nil]
       optional :id, String
 
       # @!attribute cld
-      #   Destination number
+      #   Filter results by cld.
       #
       #   @return [String, nil]
       optional :cld, String
 
       # @!attribute cli
-      #   Origination number
+      #   Filter results by cli.
       #
       #   @return [String, nil]
       optional :cli, String
 
       # @!attribute direction
-      #   Direction (inbound or outbound)
+      #   Filter results by direction.
       #
       #   @return [Symbol, Telnyx::Models::ReportListMdrsParams::Direction, nil]
       optional :direction, enum: -> { Telnyx::ReportListMdrsParams::Direction }
@@ -38,13 +38,13 @@ module Telnyx
       optional :end_date, String
 
       # @!attribute message_type
-      #   Type of message
+      #   Filter results by message type.
       #
       #   @return [Symbol, Telnyx::Models::ReportListMdrsParams::MessageType, nil]
       optional :message_type, enum: -> { Telnyx::ReportListMdrsParams::MessageType }
 
       # @!attribute profile
-      #   Name of the profile
+      #   Filter results by profile.
       #
       #   @return [String, nil]
       optional :profile, String
@@ -56,33 +56,33 @@ module Telnyx
       optional :start_date, String
 
       # @!attribute status
-      #   Message status
+      #   Filter results by status.
       #
       #   @return [Symbol, Telnyx::Models::ReportListMdrsParams::Status, nil]
       optional :status, enum: -> { Telnyx::ReportListMdrsParams::Status }
 
       # @!method initialize(id: nil, cld: nil, cli: nil, direction: nil, end_date: nil, message_type: nil, profile: nil, start_date: nil, status: nil, request_options: {})
-      #   @param id [String] Message uuid
+      #   @param id [String] Filter results by identifier.
       #
-      #   @param cld [String] Destination number
+      #   @param cld [String] Filter results by cld.
       #
-      #   @param cli [String] Origination number
+      #   @param cli [String] Filter results by cli.
       #
-      #   @param direction [Symbol, Telnyx::Models::ReportListMdrsParams::Direction] Direction (inbound or outbound)
+      #   @param direction [Symbol, Telnyx::Models::ReportListMdrsParams::Direction] Filter results by direction.
       #
       #   @param end_date [String] Pagination end date
       #
-      #   @param message_type [Symbol, Telnyx::Models::ReportListMdrsParams::MessageType] Type of message
+      #   @param message_type [Symbol, Telnyx::Models::ReportListMdrsParams::MessageType] Filter results by message type.
       #
-      #   @param profile [String] Name of the profile
+      #   @param profile [String] Filter results by profile.
       #
       #   @param start_date [String] Pagination start date
       #
-      #   @param status [Symbol, Telnyx::Models::ReportListMdrsParams::Status] Message status
+      #   @param status [Symbol, Telnyx::Models::ReportListMdrsParams::Status] Filter results by status.
       #
       #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
 
-      # Direction (inbound or outbound)
+      # Filter results by direction.
       module Direction
         extend Telnyx::Internal::Type::Enum
 
@@ -93,7 +93,7 @@ module Telnyx
         #   @return [Array<Symbol>]
       end
 
-      # Type of message
+      # Filter results by message type.
       module MessageType
         extend Telnyx::Internal::Type::Enum
 
@@ -104,7 +104,7 @@ module Telnyx
         #   @return [Array<Symbol>]
       end
 
-      # Message status
+      # Filter results by status.
       module Status
         extend Telnyx::Internal::Type::Enum
 

data/lib/telnyx/models/report_list_wdrs_params.rb

@@ -8,7 +8,7 @@ module Telnyx
       include Telnyx::Internal::Type::RequestParameters
 
       # @!attribute id
-      #   WDR uuid
+      #   Filter results by identifier.
       #
       #   @return [String, nil]
       optional :id, String
@@ -20,19 +20,19 @@ module Telnyx
       optional :end_date, String
 
       # @!attribute imsi
-      #   International mobile subscriber identity
+      #   Filter results by imsi.
       #
       #   @return [String, nil]
       optional :imsi, String
 
       # @!attribute mcc
-      #   Mobile country code
+      #   Filter results by mcc.
       #
       #   @return [String, nil]
       optional :mcc, String
 
       # @!attribute mnc
-      #   Mobile network code
+      #   Filter results by mnc.
       #
       #   @return [String, nil]
       optional :mnc, String
@@ -48,32 +48,31 @@ module Telnyx
       optional :page_size, Integer
 
       # @!attribute phone_number
-      #   Phone number
+      #   Filter results by phone number.
       #
       #   @return [String, nil]
       optional :phone_number, String
 
       # @!attribute sim_card_id
-      #   Sim card unique identifier
+      #   Filter results by sim card id.
       #
       #   @return [String, nil]
       optional :sim_card_id, String
 
       # @!attribute sim_group_id
-      #   Sim group unique identifier
+      #   Filter results by sim group id.
       #
       #   @return [String, nil]
       optional :sim_group_id, String
 
       # @!attribute sim_group_name
-      #   Sim group name
+      #   Filter results by sim group name.
       #
       #   @return [String, nil]
       optional :sim_group_name, String
 
       # @!attribute sort
-      #   Field used to order the data. If no field is specified, default value is
-      #   'created_at'
+      #   Field and direction to sort the results by.
       #
       #   @return [Array<String>, nil]
       optional :sort, Telnyx::Internal::Type::ArrayOf[String]
@@ -85,32 +84,29 @@ module Telnyx
       optional :start_date, String
 
       # @!method initialize(id: nil, end_date: nil, imsi: nil, mcc: nil, mnc: nil, page_number: nil, page_size: nil, phone_number: nil, sim_card_id: nil, sim_group_id: nil, sim_group_name: nil, sort: nil, start_date: nil, request_options: {})
-      #   Some parameter documentations has been truncated, see
-      #   {Telnyx::Models::ReportListWdrsParams} for more details.
-      #
-      #   @param id [String] WDR uuid
+      #   @param id [String] Filter results by identifier.
       #
       #   @param end_date [String] End date
       #
-      #   @param imsi [String] International mobile subscriber identity
+      #   @param imsi [String] Filter results by imsi.
       #
-      #   @param mcc [String] Mobile country code
+      #   @param mcc [String] Filter results by mcc.
       #
-      #   @param mnc [String] Mobile network code
+      #   @param mnc [String] Filter results by mnc.
       #
       #   @param page_number [Integer]
       #
       #   @param page_size [Integer]
       #
-      #   @param phone_number [String] Phone number
+      #   @param phone_number [String] Filter results by phone number.
       #
-      #   @param sim_card_id [String] Sim card unique identifier
+      #   @param sim_card_id [String] Filter results by sim card id.
       #
-      #   @param sim_group_id [String] Sim group unique identifier
+      #   @param sim_group_id [String] Filter results by sim group id.
       #
-      #   @param sim_group_name [String] Sim group name
+      #   @param sim_group_name [String] Filter results by sim group name.
       #
-      #   @param sort [Array<String>] Field used to order the data. If no field is specified, default value is 'create
+      #   @param sort [Array<String>] Field and direction to sort the results by.
       #
       #   @param start_date [String] Start date
       #