telnyx 5.26.0 → 5.28.0

data/lib/telnyx/models/global_ip_health_check_list_response.rb

@@ -3,7 +3,7 @@
 module Telnyx
   module Models
     # @see Telnyx::Resources::GlobalIPHealthChecks#list
-    class GlobalIPHealthCheckListResponse < Telnyx::Internal::Type::BaseModel
+    class GlobalIPHealthCheckListResponse < Telnyx::Models::Record
       # @!attribute global_ip_id
       #   Global IP ID.
       #
@@ -22,41 +22,7 @@ module Telnyx
       #   @return [String, nil]
       optional :health_check_type, 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 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, record_type: nil, updated_at: nil, global_ip_id: nil, health_check_params: nil, health_check_type: nil)
-      #   @param id [String] Identifies the resource.
-      #
-      #   @param created_at [String] ISO 8601 formatted date-time indicating when the resource was created.
-      #
-      #   @param record_type [String] Identifies the type of the resource.
-      #
-      #   @param updated_at [String] ISO 8601 formatted date-time indicating when the resource was updated.
-      #
+      # @!method initialize(global_ip_id: nil, health_check_params: nil, health_check_type: nil)
       #   @param global_ip_id [String] Global IP ID.
       #
       #   @param health_check_params [Hash{Symbol=>Object}] A Global IP health check params.

data/lib/telnyx/models/global_ip_health_check_retrieve_response.rb

@@ -13,7 +13,7 @@ module Telnyx
       #   @param data [Telnyx::Models::GlobalIPHealthCheckRetrieveResponse::Data]
 
       # @see Telnyx::Models::GlobalIPHealthCheckRetrieveResponse#data
-      class Data < Telnyx::Internal::Type::BaseModel
+      class Data < Telnyx::Models::Record
         # @!attribute global_ip_id
         #   Global IP ID.
         #
@@ -32,41 +32,7 @@ module Telnyx
         #   @return [String, nil]
         optional :health_check_type, 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 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, record_type: nil, updated_at: nil, global_ip_id: nil, health_check_params: nil, health_check_type: nil)
-        #   @param id [String] Identifies the resource.
-        #
-        #   @param created_at [String] ISO 8601 formatted date-time indicating when the resource was created.
-        #
-        #   @param record_type [String] Identifies the type of the resource.
-        #
-        #   @param updated_at [String] ISO 8601 formatted date-time indicating when the resource was updated.
-        #
+        # @!method initialize(global_ip_id: nil, health_check_params: nil, health_check_type: nil)
         #   @param global_ip_id [String] Global IP ID.
         #
         #   @param health_check_params [Hash{Symbol=>Object}] A Global IP health check params.

data/lib/telnyx/models/global_ip_list_response.rb

@@ -3,7 +3,7 @@
 module Telnyx
   module Models
     # @see Telnyx::Resources::GlobalIPs#list
-    class GlobalIPListResponse < Telnyx::Internal::Type::BaseModel
+    class GlobalIPListResponse < Telnyx::Models::Record
       # @!attribute description
       #   A user specified description for the address.
       #
@@ -23,30 +23,6 @@ module Telnyx
       optional :ports, Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]
 
       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 updated_at
-        #   ISO 8601 formatted date-time indicating when the resource was updated.
-        #
-        #   @return [String, nil]
-        optional :updated_at, String
-
         # @!attribute ip_address
         #   The Global IP address.
         #
@@ -54,15 +30,7 @@ module Telnyx
         optional :ip_address, String
       end
 
-      # @!method initialize(id: nil, created_at: nil, record_type: nil, updated_at: nil, description: nil, ip_address: nil, name: nil, ports: nil)
-      #   @param id [String] Identifies the resource.
-      #
-      #   @param created_at [String] ISO 8601 formatted date-time indicating when the resource was created.
-      #
-      #   @param record_type [String] Identifies the type of the resource.
-      #
-      #   @param updated_at [String] ISO 8601 formatted date-time indicating when the resource was updated.
-      #
+      # @!method initialize(description: nil, ip_address: nil, name: nil, ports: nil)
       #   @param description [String] A user specified description for the address.
       #
       #   @param ip_address [String] The Global IP address.

data/lib/telnyx/models/global_ip_retrieve_response.rb

@@ -13,7 +13,7 @@ module Telnyx
       #   @param data [Telnyx::Models::GlobalIPRetrieveResponse::Data]
 
       # @see Telnyx::Models::GlobalIPRetrieveResponse#data
-      class Data < Telnyx::Internal::Type::BaseModel
+      class Data < Telnyx::Models::Record
         # @!attribute description
         #   A user specified description for the address.
         #
@@ -33,30 +33,6 @@ module Telnyx
         optional :ports, Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]
 
         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 updated_at
-          #   ISO 8601 formatted date-time indicating when the resource was updated.
-          #
-          #   @return [String, nil]
-          optional :updated_at, String
-
           # @!attribute ip_address
           #   The Global IP address.
           #
@@ -64,15 +40,7 @@ module Telnyx
           optional :ip_address, String
         end
 
-        # @!method initialize(id: nil, created_at: nil, record_type: nil, updated_at: nil, description: nil, ip_address: nil, name: nil, ports: nil)
-        #   @param id [String] Identifies the resource.
-        #
-        #   @param created_at [String] ISO 8601 formatted date-time indicating when the resource was created.
-        #
-        #   @param record_type [String] Identifies the type of the resource.
-        #
-        #   @param updated_at [String] ISO 8601 formatted date-time indicating when the resource was updated.
-        #
+        # @!method initialize(description: nil, ip_address: nil, name: nil, ports: nil)
         #   @param description [String] A user specified description for the address.
         #
         #   @param ip_address [String] The Global IP address.

data/lib/telnyx/models/messaging_10dlc/brand_get_sms_otp_by_reference_params.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module Messaging10dlc
+      # @see Telnyx::Resources::Messaging10dlc::Brand#get_sms_otp_by_reference
+      class BrandGetSMSOtpByReferenceParams < Telnyx::Internal::Type::BaseModel
+        extend Telnyx::Internal::Type::RequestParameters::Converter
+        include Telnyx::Internal::Type::RequestParameters
+
+        # @!attribute brand_id
+        #   Filter by Brand ID for easier lookup in portal applications
+        #
+        #   @return [String, nil]
+        optional :brand_id, String
+
+        # @!method initialize(brand_id: nil, request_options: {})
+        #   @param brand_id [String] Filter by Brand ID for easier lookup in portal applications
+        #
+        #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/telnyx/models/messaging_10dlc/brand_get_sms_otp_by_reference_response.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module Messaging10dlc
+      # @see Telnyx::Resources::Messaging10dlc::Brand#get_sms_otp_by_reference
+      class BrandGetSMSOtpByReferenceResponse < Telnyx::Internal::Type::BaseModel
+        # @!attribute brand_id
+        #   The Brand ID associated with this OTP request
+        #
+        #   @return [String]
+        required :brand_id, String, api_name: :brandId
+
+        # @!attribute delivery_status
+        #   The current delivery status of the OTP SMS message. Common values include:
+        #   `DELIVERED_HANDSET`, `PENDING`, `FAILED`, `EXPIRED`
+        #
+        #   @return [String]
+        required :delivery_status, String, api_name: :deliveryStatus
+
+        # @!attribute mobile_phone
+        #   The mobile phone number where the OTP was sent, in E.164 format
+        #
+        #   @return [String]
+        required :mobile_phone, String, api_name: :mobilePhone
+
+        # @!attribute reference_id
+        #   The reference ID for this OTP request, used for status queries
+        #
+        #   @return [String]
+        required :reference_id, String, api_name: :referenceId
+
+        # @!attribute request_date
+        #   The timestamp when the OTP request was initiated
+        #
+        #   @return [Time]
+        required :request_date, Time, api_name: :requestDate
+
+        # @!attribute delivery_status_date
+        #   The timestamp when the delivery status was last updated
+        #
+        #   @return [Time, nil]
+        optional :delivery_status_date, Time, api_name: :deliveryStatusDate
+
+        # @!attribute delivery_status_details
+        #   Additional details about the delivery status
+        #
+        #   @return [String, nil]
+        optional :delivery_status_details, String, api_name: :deliveryStatusDetails
+
+        # @!attribute verify_date
+        #   The timestamp when the OTP was successfully verified (if applicable)
+        #
+        #   @return [Time, nil]
+        optional :verify_date, Time, api_name: :verifyDate
+
+        # @!method initialize(brand_id:, delivery_status:, mobile_phone:, reference_id:, request_date:, delivery_status_date: nil, delivery_status_details: nil, verify_date: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Telnyx::Models::Messaging10dlc::BrandGetSMSOtpByReferenceResponse} for more
+        #   details.
+        #
+        #   Status information for an SMS OTP sent during Sole Proprietor brand verification
+        #
+        #   @param brand_id [String] The Brand ID associated with this OTP request
+        #
+        #   @param delivery_status [String] The current delivery status of the OTP SMS message. Common values include: `DELI
+        #
+        #   @param mobile_phone [String] The mobile phone number where the OTP was sent, in E.164 format
+        #
+        #   @param reference_id [String] The reference ID for this OTP request, used for status queries
+        #
+        #   @param request_date [Time] The timestamp when the OTP request was initiated
+        #
+        #   @param delivery_status_date [Time] The timestamp when the delivery status was last updated
+        #
+        #   @param delivery_status_details [String] Additional details about the delivery status
+        #
+        #   @param verify_date [Time] The timestamp when the OTP was successfully verified (if applicable)
+      end
+    end
+  end
+end

data/lib/telnyx/models/minimax_voice_settings.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    class MinimaxVoiceSettings < Telnyx::Internal::Type::BaseModel
+      # @!attribute type
+      #   Voice settings provider type
+      #
+      #   @return [Symbol, Telnyx::Models::MinimaxVoiceSettings::Type]
+      required :type, enum: -> { Telnyx::MinimaxVoiceSettings::Type }
+
+      # @!attribute pitch
+      #   Voice pitch adjustment. Default is 0.
+      #
+      #   @return [Integer, nil]
+      optional :pitch, Integer
+
+      # @!attribute speed
+      #   Speech speed multiplier. Default is 1.0.
+      #
+      #   @return [Float, nil]
+      optional :speed, Float
+
+      # @!attribute vol
+      #   Speech volume multiplier. Default is 1.0.
+      #
+      #   @return [Float, nil]
+      optional :vol, Float
+
+      # @!method initialize(type:, pitch: nil, speed: nil, vol: nil)
+      #   @param type [Symbol, Telnyx::Models::MinimaxVoiceSettings::Type] Voice settings provider type
+      #
+      #   @param pitch [Integer] Voice pitch adjustment. Default is 0.
+      #
+      #   @param speed [Float] Speech speed multiplier. Default is 1.0.
+      #
+      #   @param vol [Float] Speech volume multiplier. Default is 1.0.
+
+      # Voice settings provider type
+      #
+      # @see Telnyx::Models::MinimaxVoiceSettings#type
+      module Type
+        extend Telnyx::Internal::Type::Enum
+
+        MINIMAX = :minimax
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/telnyx/models/network_create.rb

@@ -2,49 +2,15 @@
 
 module Telnyx
   module Models
-    class NetworkCreate < Telnyx::Internal::Type::BaseModel
+    class NetworkCreate < Telnyx::Models::Record
       # @!attribute name
       #   A user specified name for the network.
       #
       #   @return [String]
       required :name, 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 updated_at
-        #   ISO 8601 formatted date-time indicating when the resource was updated.
-        #
-        #   @return [String, nil]
-        optional :updated_at, String
-      end
-
-      # @!method initialize(name:, id: nil, created_at: nil, record_type: nil, updated_at: nil)
+      # @!method initialize(name:)
       #   @param name [String] A user specified name for the network.
-      #
-      #   @param id [String] Identifies the resource.
-      #
-      #   @param created_at [String] ISO 8601 formatted date-time indicating when the resource was created.
-      #
-      #   @param record_type [String] Identifies the type of the resource.
-      #
-      #   @param updated_at [String] ISO 8601 formatted date-time indicating when the resource was updated.
     end
   end
 end

data/lib/telnyx/models/network_create_response.rb

@@ -13,48 +13,14 @@ module Telnyx
       #   @param data [Telnyx::Models::NetworkCreateResponse::Data]
 
       # @see Telnyx::Models::NetworkCreateResponse#data
-      class Data < Telnyx::Internal::Type::BaseModel
+      class Data < Telnyx::Models::Record
         # @!attribute name
         #   A user specified name for the network.
         #
         #   @return [String, nil]
         optional :name, 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 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, record_type: nil, updated_at: nil, name: nil)
-        #   @param id [String] Identifies the resource.
-        #
-        #   @param created_at [String] ISO 8601 formatted date-time indicating when the resource was created.
-        #
-        #   @param record_type [String] Identifies the type of the resource.
-        #
-        #   @param updated_at [String] ISO 8601 formatted date-time indicating when the resource was updated.
-        #
+        # @!method initialize(name: nil)
         #   @param name [String] A user specified name for the network.
       end
     end

data/lib/telnyx/models/network_delete_response.rb

@@ -13,48 +13,14 @@ module Telnyx
       #   @param data [Telnyx::Models::NetworkDeleteResponse::Data]
 
       # @see Telnyx::Models::NetworkDeleteResponse#data
-      class Data < Telnyx::Internal::Type::BaseModel
+      class Data < Telnyx::Models::Record
         # @!attribute name
         #   A user specified name for the network.
         #
         #   @return [String, nil]
         optional :name, 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 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, record_type: nil, updated_at: nil, name: nil)
-        #   @param id [String] Identifies the resource.
-        #
-        #   @param created_at [String] ISO 8601 formatted date-time indicating when the resource was created.
-        #
-        #   @param record_type [String] Identifies the type of the resource.
-        #
-        #   @param updated_at [String] ISO 8601 formatted date-time indicating when the resource was updated.
-        #
+        # @!method initialize(name: nil)
         #   @param name [String] A user specified name for the network.
       end
     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 updated_at
-        #   ISO 8601 formatted date-time indicating when the resource was updated.
-        #
-        #   @return [String, nil]
-        optional :updated_at, 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
-      end
-
-      # @!method initialize(id: nil, created_at: nil, record_type: nil, updated_at: nil, name: nil, network_id: nil, status: nil, region: nil, region_code: nil, type: nil)
-      #   @param id [String] Identifies the resource.
-      #
-      #   @param created_at [String] ISO 8601 formatted date-time indicating when the resource was created.
-      #
-      #   @param record_type [String] Identifies the type of the resource.
-      #
-      #   @param updated_at [String] ISO 8601 formatted date-time indicating when the resource was updated.
-      #
-      #   @param name [String] A user specified name for the interface.
-      #
-      #   @param network_id [String] The id of the network associated with the interface.
-      #
-      #   @param status [Symbol, Telnyx::Models::InterfaceStatus] The current status of the interface deployment.
-      #
-      #   @param region [Telnyx::Models::NetworkListInterfacesResponse::Region]
-      #
-      #   @param region_code [String] The region interface is deployed to.
-      #
-      #   @param type [String] Identifies the type of the interface.
-
-      # @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