telnyx 5.26.0 → 5.28.0

data/rbi/telnyx/models/global_ip_delete_response.rbi

@@ -33,7 +33,7 @@ module Telnyx
       def to_hash
       end
 
-      class Data < Telnyx::Internal::Type::BaseModel
+      class Data < Telnyx::Models::Record
         OrHash =
           T.type_alias do
             T.any(
@@ -63,34 +63,6 @@ module Telnyx
         sig { params(ports: T::Hash[Symbol, T.anything]).void }
         attr_writer :ports
 
-        # 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
-
-        # 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
-
         # The Global IP address.
         sig { returns(T.nilable(String)) }
         attr_reader :ip_address
@@ -100,10 +72,6 @@ module Telnyx
 
         sig do
           params(
-            id: String,
-            created_at: String,
-            record_type: String,
-            updated_at: String,
             description: String,
             ip_address: String,
             name: String,
@@ -111,14 +79,6 @@ module Telnyx
           ).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,
-          # Identifies the type of the resource.
-          record_type: nil,
-          # ISO 8601 formatted date-time indicating when the resource was updated.
-          updated_at: nil,
           # A user specified description for the address.
           description: nil,
           # The Global IP address.
@@ -133,10 +93,6 @@ module Telnyx
         sig do
           override.returns(
             {
-              id: String,
-              created_at: String,
-              record_type: String,
-              updated_at: String,
               description: String,
               ip_address: String,
               name: String,

data/rbi/telnyx/models/global_ip_health_check_create_response.rbi

@@ -41,7 +41,7 @@ module Telnyx
       def to_hash
       end
 
-      class Data < Telnyx::Internal::Type::BaseModel
+      class Data < Telnyx::Models::Record
         OrHash =
           T.type_alias do
             T.any(
@@ -71,54 +71,14 @@ module Telnyx
         sig { params(health_check_type: String).void }
         attr_writer :health_check_type
 
-        # 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
-
-        # 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,
-            record_type: String,
-            updated_at: String,
             global_ip_id: String,
             health_check_params: T::Hash[Symbol, T.anything],
             health_check_type: 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,
-          # Identifies the type of the resource.
-          record_type: nil,
-          # ISO 8601 formatted date-time indicating when the resource was updated.
-          updated_at: nil,
           # Global IP ID.
           global_ip_id: nil,
           # A Global IP health check params.
@@ -131,10 +91,6 @@ module Telnyx
         sig do
           override.returns(
             {
-              id: String,
-              created_at: String,
-              record_type: String,
-              updated_at: String,
               global_ip_id: String,
               health_check_params: T::Hash[Symbol, T.anything],
               health_check_type: String

data/rbi/telnyx/models/global_ip_health_check_delete_response.rbi

@@ -41,7 +41,7 @@ module Telnyx
       def to_hash
       end
 
-      class Data < Telnyx::Internal::Type::BaseModel
+      class Data < Telnyx::Models::Record
         OrHash =
           T.type_alias do
             T.any(
@@ -71,54 +71,14 @@ module Telnyx
         sig { params(health_check_type: String).void }
         attr_writer :health_check_type
 
-        # 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
-
-        # 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,
-            record_type: String,
-            updated_at: String,
             global_ip_id: String,
             health_check_params: T::Hash[Symbol, T.anything],
             health_check_type: 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,
-          # Identifies the type of the resource.
-          record_type: nil,
-          # ISO 8601 formatted date-time indicating when the resource was updated.
-          updated_at: nil,
           # Global IP ID.
           global_ip_id: nil,
           # A Global IP health check params.
@@ -131,10 +91,6 @@ module Telnyx
         sig do
           override.returns(
             {
-              id: String,
-              created_at: String,
-              record_type: String,
-              updated_at: String,
               global_ip_id: String,
               health_check_params: T::Hash[Symbol, T.anything],
               health_check_type: String

data/rbi/telnyx/models/global_ip_health_check_list_response.rbi

@@ -2,7 +2,7 @@
 
 module Telnyx
   module Models
-    class GlobalIPHealthCheckListResponse < Telnyx::Internal::Type::BaseModel
+    class GlobalIPHealthCheckListResponse < Telnyx::Models::Record
       OrHash =
         T.type_alias do
           T.any(
@@ -32,54 +32,14 @@ module Telnyx
       sig { params(health_check_type: String).void }
       attr_writer :health_check_type
 
-      # 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
-
-      # 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,
-          record_type: String,
-          updated_at: String,
           global_ip_id: String,
           health_check_params: T::Hash[Symbol, T.anything],
           health_check_type: 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,
-        # Identifies the type of the resource.
-        record_type: nil,
-        # ISO 8601 formatted date-time indicating when the resource was updated.
-        updated_at: nil,
         # Global IP ID.
         global_ip_id: nil,
         # A Global IP health check params.
@@ -92,10 +52,6 @@ module Telnyx
       sig do
         override.returns(
           {
-            id: String,
-            created_at: String,
-            record_type: String,
-            updated_at: String,
             global_ip_id: String,
             health_check_params: T::Hash[Symbol, T.anything],
             health_check_type: String

data/rbi/telnyx/models/global_ip_health_check_retrieve_response.rbi

@@ -43,7 +43,7 @@ module Telnyx
       def to_hash
       end
 
-      class Data < Telnyx::Internal::Type::BaseModel
+      class Data < Telnyx::Models::Record
         OrHash =
           T.type_alias do
             T.any(
@@ -73,54 +73,14 @@ module Telnyx
         sig { params(health_check_type: String).void }
         attr_writer :health_check_type
 
-        # 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
-
-        # 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,
-            record_type: String,
-            updated_at: String,
             global_ip_id: String,
             health_check_params: T::Hash[Symbol, T.anything],
             health_check_type: 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,
-          # Identifies the type of the resource.
-          record_type: nil,
-          # ISO 8601 formatted date-time indicating when the resource was updated.
-          updated_at: nil,
           # Global IP ID.
           global_ip_id: nil,
           # A Global IP health check params.
@@ -133,10 +93,6 @@ module Telnyx
         sig do
           override.returns(
             {
-              id: String,
-              created_at: String,
-              record_type: String,
-              updated_at: String,
               global_ip_id: String,
               health_check_params: T::Hash[Symbol, T.anything],
               health_check_type: String

data/rbi/telnyx/models/global_ip_list_response.rbi

@@ -2,7 +2,7 @@
 
 module Telnyx
   module Models
-    class GlobalIPListResponse < Telnyx::Internal::Type::BaseModel
+    class GlobalIPListResponse < Telnyx::Models::Record
       OrHash =
         T.type_alias do
           T.any(Telnyx::Models::GlobalIPListResponse, Telnyx::Internal::AnyHash)
@@ -29,34 +29,6 @@ module Telnyx
       sig { params(ports: T::Hash[Symbol, T.anything]).void }
       attr_writer :ports
 
-      # 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
-
-      # 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
-
       # The Global IP address.
       sig { returns(T.nilable(String)) }
       attr_reader :ip_address
@@ -66,10 +38,6 @@ module Telnyx
 
       sig do
         params(
-          id: String,
-          created_at: String,
-          record_type: String,
-          updated_at: String,
           description: String,
           ip_address: String,
           name: String,
@@ -77,14 +45,6 @@ module Telnyx
         ).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,
-        # Identifies the type of the resource.
-        record_type: nil,
-        # ISO 8601 formatted date-time indicating when the resource was updated.
-        updated_at: nil,
         # A user specified description for the address.
         description: nil,
         # The Global IP address.
@@ -99,10 +59,6 @@ module Telnyx
       sig do
         override.returns(
           {
-            id: String,
-            created_at: String,
-            record_type: String,
-            updated_at: String,
             description: String,
             ip_address: String,
             name: String,

data/rbi/telnyx/models/global_ip_retrieve_response.rbi

@@ -37,7 +37,7 @@ module Telnyx
       def to_hash
       end
 
-      class Data < Telnyx::Internal::Type::BaseModel
+      class Data < Telnyx::Models::Record
         OrHash =
           T.type_alias do
             T.any(
@@ -67,34 +67,6 @@ module Telnyx
         sig { params(ports: T::Hash[Symbol, T.anything]).void }
         attr_writer :ports
 
-        # 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
-
-        # 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
-
         # The Global IP address.
         sig { returns(T.nilable(String)) }
         attr_reader :ip_address
@@ -104,10 +76,6 @@ module Telnyx
 
         sig do
           params(
-            id: String,
-            created_at: String,
-            record_type: String,
-            updated_at: String,
             description: String,
             ip_address: String,
             name: String,
@@ -115,14 +83,6 @@ module Telnyx
           ).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,
-          # Identifies the type of the resource.
-          record_type: nil,
-          # ISO 8601 formatted date-time indicating when the resource was updated.
-          updated_at: nil,
           # A user specified description for the address.
           description: nil,
           # The Global IP address.
@@ -137,10 +97,6 @@ module Telnyx
         sig do
           override.returns(
             {
-              id: String,
-              created_at: String,
-              record_type: String,
-              updated_at: String,
               description: String,
               ip_address: String,
               name: String,

data/rbi/telnyx/models/messaging_10dlc/brand_get_sms_otp_by_reference_params.rbi

@@ -0,0 +1,48 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module Messaging10dlc
+      class BrandGetSMSOtpByReferenceParams < Telnyx::Internal::Type::BaseModel
+        extend Telnyx::Internal::Type::RequestParameters::Converter
+        include Telnyx::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              Telnyx::Messaging10dlc::BrandGetSMSOtpByReferenceParams,
+              Telnyx::Internal::AnyHash
+            )
+          end
+
+        # Filter by Brand ID for easier lookup in portal applications
+        sig { returns(T.nilable(String)) }
+        attr_reader :brand_id
+
+        sig { params(brand_id: String).void }
+        attr_writer :brand_id
+
+        sig do
+          params(
+            brand_id: String,
+            request_options: Telnyx::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Filter by Brand ID for easier lookup in portal applications
+          brand_id: nil,
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            { brand_id: String, request_options: Telnyx::RequestOptions }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/messaging_10dlc/brand_get_sms_otp_by_reference_response.rbi

@@ -0,0 +1,110 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module Messaging10dlc
+      class BrandGetSMSOtpByReferenceResponse < Telnyx::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Telnyx::Models::Messaging10dlc::BrandGetSMSOtpByReferenceResponse,
+              Telnyx::Internal::AnyHash
+            )
+          end
+
+        # The Brand ID associated with this OTP request
+        sig { returns(String) }
+        attr_accessor :brand_id
+
+        # The current delivery status of the OTP SMS message. Common values include:
+        # `DELIVERED_HANDSET`, `PENDING`, `FAILED`, `EXPIRED`
+        sig { returns(String) }
+        attr_accessor :delivery_status
+
+        # The mobile phone number where the OTP was sent, in E.164 format
+        sig { returns(String) }
+        attr_accessor :mobile_phone
+
+        # The reference ID for this OTP request, used for status queries
+        sig { returns(String) }
+        attr_accessor :reference_id
+
+        # The timestamp when the OTP request was initiated
+        sig { returns(Time) }
+        attr_accessor :request_date
+
+        # The timestamp when the delivery status was last updated
+        sig { returns(T.nilable(Time)) }
+        attr_reader :delivery_status_date
+
+        sig { params(delivery_status_date: Time).void }
+        attr_writer :delivery_status_date
+
+        # Additional details about the delivery status
+        sig { returns(T.nilable(String)) }
+        attr_reader :delivery_status_details
+
+        sig { params(delivery_status_details: String).void }
+        attr_writer :delivery_status_details
+
+        # The timestamp when the OTP was successfully verified (if applicable)
+        sig { returns(T.nilable(Time)) }
+        attr_reader :verify_date
+
+        sig { params(verify_date: Time).void }
+        attr_writer :verify_date
+
+        # Status information for an SMS OTP sent during Sole Proprietor brand verification
+        sig do
+          params(
+            brand_id: String,
+            delivery_status: String,
+            mobile_phone: String,
+            reference_id: String,
+            request_date: Time,
+            delivery_status_date: Time,
+            delivery_status_details: String,
+            verify_date: Time
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The Brand ID associated with this OTP request
+          brand_id:,
+          # The current delivery status of the OTP SMS message. Common values include:
+          # `DELIVERED_HANDSET`, `PENDING`, `FAILED`, `EXPIRED`
+          delivery_status:,
+          # The mobile phone number where the OTP was sent, in E.164 format
+          mobile_phone:,
+          # The reference ID for this OTP request, used for status queries
+          reference_id:,
+          # The timestamp when the OTP request was initiated
+          request_date:,
+          # The timestamp when the delivery status was last updated
+          delivery_status_date: nil,
+          # Additional details about the delivery status
+          delivery_status_details: nil,
+          # The timestamp when the OTP was successfully verified (if applicable)
+          verify_date: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              brand_id: String,
+              delivery_status: String,
+              mobile_phone: String,
+              reference_id: String,
+              request_date: Time,
+              delivery_status_date: Time,
+              delivery_status_details: String,
+              verify_date: Time
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end