telnyx 5.173.0 → 5.174.0

data/rbi/telnyx/models/model_metadata.rbi

@@ -55,6 +55,14 @@ module Telnyx
       sig { returns(T.nilable(String)) }
       attr_accessor :base_model
 
+      # Whether the model is in beta. New Telnyx-hosted models launch with `beta: true`;
+      # the label is removed once the model is established.
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :beta
+
+      sig { params(beta: T::Boolean).void }
+      attr_writer :beta
+
       # Short, human-readable summary of what the model is best suited for.
       sig { returns(T.nilable(String)) }
       attr_accessor :description
@@ -166,6 +174,7 @@ module Telnyx
           parameters: Integer,
           tier: Telnyx::ModelMetadata::Tier::OrSymbol,
           base_model: T.nilable(String),
+          beta: T::Boolean,
           description: T.nilable(String),
           is_fine_tunable: T::Boolean,
           is_vision_supported: T::Boolean,
@@ -209,6 +218,9 @@ module Telnyx
         # Base model the fine-tuned model was trained from. Only set for fine-tuned
         # models.
         base_model: nil,
+        # Whether the model is in beta. New Telnyx-hosted models launch with `beta: true`;
+        # the label is removed once the model is established.
+        beta: nil,
         # Short, human-readable summary of what the model is best suited for.
         description: nil,
         # Whether the model can be used as a base for a fine-tuning job via
@@ -265,6 +277,7 @@ module Telnyx
             parameters: Integer,
             tier: Telnyx::ModelMetadata::Tier::TaggedSymbol,
             base_model: T.nilable(String),
+            beta: T::Boolean,
             description: T.nilable(String),
             is_fine_tunable: T::Boolean,
             is_vision_supported: T::Boolean,

data/rbi/telnyx/models/outbound_message_payload.rbi

@@ -31,6 +31,12 @@ module Telnyx
       end
       attr_writer :cc
 
+      # Identifies the next chunk when server-side SMS chunking
+      # (`auto_chunk_long_messages` on the messaging profile) split this message. Always
+      # present; null on non-chunked messages and on the final chunk.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :child_message_id
+
       # ISO 8601 formatted date indicating when the message was finalized.
       sig { returns(T.nilable(Time)) }
       attr_accessor :completed_at
@@ -129,6 +135,13 @@ module Telnyx
       sig { params(organization_id: String).void }
       attr_writer :organization_id
 
+      # Identifies the original request's message when server-side SMS chunking
+      # (`auto_chunk_long_messages` on the messaging profile) split it into chunks. The
+      # first chunk's ID is the original request's message ID. Always present; null when
+      # this message is not part of a chunked send.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :parent_message_id
+
       # Number of parts into which the message's body must be split.
       sig { returns(T.nilable(Integer)) }
       attr_reader :parts
@@ -265,6 +278,7 @@ module Telnyx
           id: String,
           body: Telnyx::OutboundMessagePayload::Body::OrHash,
           cc: T::Array[Telnyx::OutboundMessagePayload::Cc::OrHash],
+          child_message_id: T.nilable(String),
           completed_at: T.nilable(Time),
           cost: T.nilable(Telnyx::OutboundMessagePayload::Cost::OrHash),
           cost_breakdown:
@@ -277,6 +291,7 @@ module Telnyx
           messaging_profile_id: String,
           num_chars: Integer,
           organization_id: String,
+          parent_message_id: T.nilable(String),
           parts: Integer,
           received_at: Time,
           record_type: Telnyx::OutboundMessagePayload::RecordType::OrSymbol,
@@ -305,6 +320,10 @@ module Telnyx
         # WhatsApp messages contain the `whatsapp_message` object from the send request.
         body: nil,
         cc: nil,
+        # Identifies the next chunk when server-side SMS chunking
+        # (`auto_chunk_long_messages` on the messaging profile) split this message. Always
+        # present; null on non-chunked messages and on the final chunk.
+        child_message_id: nil,
         # ISO 8601 formatted date indicating when the message was finalized.
         completed_at: nil,
         cost: nil,
@@ -326,6 +345,11 @@ module Telnyx
         num_chars: nil,
         # The id of the organization the messaging profile belongs to.
         organization_id: nil,
+        # Identifies the original request's message when server-side SMS chunking
+        # (`auto_chunk_long_messages` on the messaging profile) split it into chunks. The
+        # first chunk's ID is the original request's message ID. Always present; null when
+        # this message is not part of a chunked send.
+        parent_message_id: nil,
         # Number of parts into which the message's body must be split.
         parts: nil,
         # ISO 8601 formatted date indicating when the message request was received.
@@ -383,6 +407,7 @@ module Telnyx
             id: String,
             body: Telnyx::OutboundMessagePayload::Body,
             cc: T::Array[Telnyx::OutboundMessagePayload::Cc],
+            child_message_id: T.nilable(String),
             completed_at: T.nilable(Time),
             cost: T.nilable(Telnyx::OutboundMessagePayload::Cost),
             cost_breakdown:
@@ -395,6 +420,7 @@ module Telnyx
             messaging_profile_id: String,
             num_chars: Integer,
             organization_id: String,
+            parent_message_id: T.nilable(String),
             parts: Integer,
             received_at: Time,
             record_type:

data/rbi/telnyx/models/phone_numbers/numbers_phone_numbers_job.rbi

@@ -90,9 +90,7 @@ module Telnyx
         sig do
           returns(
             T.nilable(
-              T::Array[
-                Telnyx::PhoneNumbers::NumbersPhoneNumbersJob::PendingOperation
-              ]
+              T::Array[Telnyx::PhoneNumbers::PhoneNumbersJobPendingOperation]
             )
           )
         end
@@ -102,7 +100,7 @@ module Telnyx
           params(
             pending_operations:
               T::Array[
-                Telnyx::PhoneNumbers::NumbersPhoneNumbersJob::PendingOperation::OrHash
+                Telnyx::PhoneNumbers::PhoneNumbersJobPendingOperation::OrHash
               ]
           ).void
         end
@@ -136,9 +134,7 @@ module Telnyx
         sig do
           returns(
             T.nilable(
-              T::Array[
-                Telnyx::PhoneNumbers::NumbersPhoneNumbersJob::SuccessfulOperation
-              ]
+              T::Array[Telnyx::PhoneNumbers::PhoneNumbersJobSuccessfulOperation]
             )
           )
         end
@@ -148,7 +144,7 @@ module Telnyx
           params(
             successful_operations:
               T::Array[
-                Telnyx::PhoneNumbers::NumbersPhoneNumbersJob::SuccessfulOperation::OrHash
+                Telnyx::PhoneNumbers::PhoneNumbersJobSuccessfulOperation::OrHash
               ]
           ).void
         end
@@ -191,7 +187,7 @@ module Telnyx
               Telnyx::PhoneNumbers::NumbersPhoneNumbersJob::Parameters::OrHash,
             pending_operations:
               T::Array[
-                Telnyx::PhoneNumbers::NumbersPhoneNumbersJob::PendingOperation::OrHash
+                Telnyx::PhoneNumbers::PhoneNumbersJobPendingOperation::OrHash
               ],
             phone_numbers: T::Array[Telnyx::PhoneNumbersJobPhoneNumber::OrHash],
             record_type: String,
@@ -199,7 +195,7 @@ module Telnyx
               Telnyx::PhoneNumbers::NumbersPhoneNumbersJob::Status::OrSymbol,
             successful_operations:
               T::Array[
-                Telnyx::PhoneNumbers::NumbersPhoneNumbersJob::SuccessfulOperation::OrHash
+                Telnyx::PhoneNumbers::PhoneNumbersJobSuccessfulOperation::OrHash
               ],
             type: Telnyx::PhoneNumbers::NumbersPhoneNumbersJob::Type::OrSymbol,
             updated_at: String
@@ -249,16 +245,14 @@ module Telnyx
               parameters:
                 Telnyx::PhoneNumbers::NumbersPhoneNumbersJob::Parameters,
               pending_operations:
-                T::Array[
-                  Telnyx::PhoneNumbers::NumbersPhoneNumbersJob::PendingOperation
-                ],
+                T::Array[Telnyx::PhoneNumbers::PhoneNumbersJobPendingOperation],
               phone_numbers: T::Array[Telnyx::PhoneNumbersJobPhoneNumber],
               record_type: String,
               status:
                 Telnyx::PhoneNumbers::NumbersPhoneNumbersJob::Status::TaggedSymbol,
               successful_operations:
                 T::Array[
-                  Telnyx::PhoneNumbers::NumbersPhoneNumbersJob::SuccessfulOperation
+                  Telnyx::PhoneNumbers::PhoneNumbersJobSuccessfulOperation
                 ],
               type:
                 Telnyx::PhoneNumbers::NumbersPhoneNumbersJob::Type::TaggedSymbol,
@@ -892,48 +886,6 @@ module Telnyx
           end
         end
 
-        class PendingOperation < Telnyx::Internal::Type::BaseModel
-          OrHash =
-            T.type_alias do
-              T.any(
-                Telnyx::PhoneNumbers::NumbersPhoneNumbersJob::PendingOperation,
-                Telnyx::Internal::AnyHash
-              )
-            end
-
-          # The phone number's ID
-          sig { returns(T.nilable(String)) }
-          attr_reader :id
-
-          sig { params(id: String).void }
-          attr_writer :id
-
-          # The phone number in e164 format.
-          sig { returns(T.nilable(String)) }
-          attr_reader :phone_number
-
-          sig { params(phone_number: String).void }
-          attr_writer :phone_number
-
-          # The phone numbers pending confirmation on update results. Entries in this list
-          # are transient, and will be moved to either successful_operations or
-          # failed_operations once the processing is done.
-          sig do
-            params(id: String, phone_number: String).returns(T.attached_class)
-          end
-          def self.new(
-            # The phone number's ID
-            id: nil,
-            # The phone number in e164 format.
-            phone_number: nil
-          )
-          end
-
-          sig { override.returns({ id: String, phone_number: String }) }
-          def to_hash
-          end
-        end
-
         # Indicates the completion status of the background update.
         module Status
           extend Telnyx::Internal::Type::Enum
@@ -984,46 +936,6 @@ module Telnyx
           end
         end
 
-        class SuccessfulOperation < Telnyx::Internal::Type::BaseModel
-          OrHash =
-            T.type_alias do
-              T.any(
-                Telnyx::PhoneNumbers::NumbersPhoneNumbersJob::SuccessfulOperation,
-                Telnyx::Internal::AnyHash
-              )
-            end
-
-          # The phone number's ID
-          sig { returns(T.nilable(String)) }
-          attr_reader :id
-
-          sig { params(id: String).void }
-          attr_writer :id
-
-          # The phone number in e164 format.
-          sig { returns(T.nilable(String)) }
-          attr_reader :phone_number
-
-          sig { params(phone_number: String).void }
-          attr_writer :phone_number
-
-          # The phone numbers successfully updated.
-          sig do
-            params(id: String, phone_number: String).returns(T.attached_class)
-          end
-          def self.new(
-            # The phone number's ID
-            id: nil,
-            # The phone number in e164 format.
-            phone_number: nil
-          )
-          end
-
-          sig { override.returns({ id: String, phone_number: String }) }
-          def to_hash
-          end
-        end
-
         # Identifies the type of the background job.
         module Type
           extend Telnyx::Internal::Type::Enum

data/rbi/telnyx/models/phone_numbers/phone_numbers_job.rbi

@@ -68,7 +68,7 @@ module Telnyx
         sig do
           returns(
             T.nilable(
-              T::Array[Telnyx::PhoneNumbers::PhoneNumbersJob::PendingOperation]
+              T::Array[Telnyx::PhoneNumbers::PhoneNumbersJobPendingOperation]
             )
           )
         end
@@ -78,7 +78,7 @@ module Telnyx
           params(
             pending_operations:
               T::Array[
-                Telnyx::PhoneNumbers::PhoneNumbersJob::PendingOperation::OrHash
+                Telnyx::PhoneNumbers::PhoneNumbersJobPendingOperation::OrHash
               ]
           ).void
         end
@@ -109,9 +109,7 @@ module Telnyx
         sig do
           returns(
             T.nilable(
-              T::Array[
-                Telnyx::PhoneNumbers::PhoneNumbersJob::SuccessfulOperation
-              ]
+              T::Array[Telnyx::PhoneNumbers::PhoneNumbersJobSuccessfulOperation]
             )
           )
         end
@@ -121,7 +119,7 @@ module Telnyx
           params(
             successful_operations:
               T::Array[
-                Telnyx::PhoneNumbers::PhoneNumbersJob::SuccessfulOperation::OrHash
+                Telnyx::PhoneNumbers::PhoneNumbersJobSuccessfulOperation::OrHash
               ]
           ).void
         end
@@ -160,14 +158,14 @@ module Telnyx
               ],
             pending_operations:
               T::Array[
-                Telnyx::PhoneNumbers::PhoneNumbersJob::PendingOperation::OrHash
+                Telnyx::PhoneNumbers::PhoneNumbersJobPendingOperation::OrHash
               ],
             phone_numbers: T::Array[Telnyx::PhoneNumbersJobPhoneNumber::OrHash],
             record_type: String,
             status: Telnyx::PhoneNumbers::PhoneNumbersJob::Status::OrSymbol,
             successful_operations:
               T::Array[
-                Telnyx::PhoneNumbers::PhoneNumbersJob::SuccessfulOperation::OrHash
+                Telnyx::PhoneNumbers::PhoneNumbersJobSuccessfulOperation::OrHash
               ],
             type: Telnyx::PhoneNumbers::PhoneNumbersJob::Type::OrSymbol,
             updated_at: String
@@ -207,15 +205,13 @@ module Telnyx
                   Telnyx::PhoneNumbers::PhoneNumbersJob::FailedOperation
                 ],
               pending_operations:
-                T::Array[
-                  Telnyx::PhoneNumbers::PhoneNumbersJob::PendingOperation
-                ],
+                T::Array[Telnyx::PhoneNumbers::PhoneNumbersJobPendingOperation],
               phone_numbers: T::Array[Telnyx::PhoneNumbersJobPhoneNumber],
               record_type: String,
               status: Telnyx::PhoneNumbers::PhoneNumbersJob::Status::OrSymbol,
               successful_operations:
                 T::Array[
-                  Telnyx::PhoneNumbers::PhoneNumbersJob::SuccessfulOperation
+                  Telnyx::PhoneNumbers::PhoneNumbersJobSuccessfulOperation
                 ],
               type: Telnyx::PhoneNumbers::PhoneNumbersJob::Type::OrSymbol,
               updated_at: String
@@ -289,48 +285,6 @@ module Telnyx
           end
         end
 
-        class PendingOperation < Telnyx::Internal::Type::BaseModel
-          OrHash =
-            T.type_alias do
-              T.any(
-                Telnyx::PhoneNumbers::PhoneNumbersJob::PendingOperation,
-                Telnyx::Internal::AnyHash
-              )
-            end
-
-          # The phone number's ID
-          sig { returns(T.nilable(String)) }
-          attr_reader :id
-
-          sig { params(id: String).void }
-          attr_writer :id
-
-          # The phone number in e164 format.
-          sig { returns(T.nilable(String)) }
-          attr_reader :phone_number
-
-          sig { params(phone_number: String).void }
-          attr_writer :phone_number
-
-          # The phone numbers pending confirmation on update results. Entries in this list
-          # are transient, and will be moved to either successful_operations or
-          # failed_operations once the processing is done.
-          sig do
-            params(id: String, phone_number: String).returns(T.attached_class)
-          end
-          def self.new(
-            # The phone number's ID
-            id: nil,
-            # The phone number in e164 format.
-            phone_number: nil
-          )
-          end
-
-          sig { override.returns({ id: String, phone_number: String }) }
-          def to_hash
-          end
-        end
-
         # Indicates the completion status of the background update.
         module Status
           extend Telnyx::Internal::Type::Enum
@@ -378,46 +332,6 @@ module Telnyx
           end
         end
 
-        class SuccessfulOperation < Telnyx::Internal::Type::BaseModel
-          OrHash =
-            T.type_alias do
-              T.any(
-                Telnyx::PhoneNumbers::PhoneNumbersJob::SuccessfulOperation,
-                Telnyx::Internal::AnyHash
-              )
-            end
-
-          # The phone number's ID
-          sig { returns(T.nilable(String)) }
-          attr_reader :id
-
-          sig { params(id: String).void }
-          attr_writer :id
-
-          # The phone number in e164 format.
-          sig { returns(T.nilable(String)) }
-          attr_reader :phone_number
-
-          sig { params(phone_number: String).void }
-          attr_writer :phone_number
-
-          # The phone numbers successfully updated.
-          sig do
-            params(id: String, phone_number: String).returns(T.attached_class)
-          end
-          def self.new(
-            # The phone number's ID
-            id: nil,
-            # The phone number in e164 format.
-            phone_number: nil
-          )
-          end
-
-          sig { override.returns({ id: String, phone_number: String }) }
-          def to_hash
-          end
-        end
-
         # Identifies the type of the background job.
         module Type
           extend Telnyx::Internal::Type::Enum

data/rbi/telnyx/models/phone_numbers/phone_numbers_job_pending_operation.rbi

@@ -0,0 +1,49 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    PhoneNumbersJobPendingOperation =
+      PhoneNumbers::PhoneNumbersJobPendingOperation
+
+    module PhoneNumbers
+      class PhoneNumbersJobPendingOperation < Telnyx::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Telnyx::PhoneNumbers::PhoneNumbersJobPendingOperation,
+              Telnyx::Internal::AnyHash
+            )
+          end
+
+        # The phone number's ID
+        sig { returns(T.nilable(String)) }
+        attr_reader :id
+
+        sig { params(id: String).void }
+        attr_writer :id
+
+        # The phone number in e164 format.
+        sig { returns(T.nilable(String)) }
+        attr_reader :phone_number
+
+        sig { params(phone_number: String).void }
+        attr_writer :phone_number
+
+        sig do
+          params(id: String, phone_number: String).returns(T.attached_class)
+        end
+        def self.new(
+          # The phone number's ID
+          id: nil,
+          # The phone number in e164 format.
+          phone_number: nil
+        )
+        end
+
+        sig { override.returns({ id: String, phone_number: String }) }
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/phone_numbers/phone_numbers_job_successful_operation.rbi

@@ -0,0 +1,49 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    PhoneNumbersJobSuccessfulOperation =
+      PhoneNumbers::PhoneNumbersJobSuccessfulOperation
+
+    module PhoneNumbers
+      class PhoneNumbersJobSuccessfulOperation < Telnyx::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Telnyx::PhoneNumbers::PhoneNumbersJobSuccessfulOperation,
+              Telnyx::Internal::AnyHash
+            )
+          end
+
+        # The phone number's ID
+        sig { returns(T.nilable(String)) }
+        attr_reader :id
+
+        sig { params(id: String).void }
+        attr_writer :id
+
+        # The phone number in e164 format.
+        sig { returns(T.nilable(String)) }
+        attr_reader :phone_number
+
+        sig { params(phone_number: String).void }
+        attr_writer :phone_number
+
+        sig do
+          params(id: String, phone_number: String).returns(T.attached_class)
+        end
+        def self.new(
+          # The phone number's ID
+          id: nil,
+          # The phone number in e164 format.
+          phone_number: nil
+        )
+        end
+
+        sig { override.returns({ id: String, phone_number: String }) }
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/update_email_template_request.rbi

@@ -42,13 +42,7 @@ module Telnyx
 
       # Structured variable requirements. Required variables cannot define defaults;
       # invalid combinations return 422. Set to `null` to clear the schema.
-      sig do
-        returns(
-          T.nilable(
-            T::Hash[Symbol, Telnyx::UpdateEmailTemplateRequest::VariableSchema]
-          )
-        )
-      end
+      sig { returns(T.nilable(T::Hash[Symbol, Telnyx::VariableSchemaEntry])) }
       attr_accessor :variable_schema
 
       # Persisted variable names. In `automatic` mode a non-null array is rejected; in
@@ -87,12 +81,7 @@ module Telnyx
           subject: T.nilable(String),
           text_body: T.nilable(String),
           variable_schema:
-            T.nilable(
-              T::Hash[
-                Symbol,
-                Telnyx::UpdateEmailTemplateRequest::VariableSchema::OrHash
-              ]
-            ),
+            T.nilable(T::Hash[Symbol, Telnyx::VariableSchemaEntry::OrHash]),
           variables: T.nilable(T::Array[String]),
           variables_mode:
             Telnyx::UpdateEmailTemplateRequest::VariablesMode::OrSymbol
@@ -137,12 +126,7 @@ module Telnyx
             subject: T.nilable(String),
             text_body: T.nilable(String),
             variable_schema:
-              T.nilable(
-                T::Hash[
-                  Symbol,
-                  Telnyx::UpdateEmailTemplateRequest::VariableSchema
-                ]
-              ),
+              T.nilable(T::Hash[Symbol, Telnyx::VariableSchemaEntry]),
             variables: T.nilable(T::Array[String]),
             variables_mode:
               Telnyx::UpdateEmailTemplateRequest::VariablesMode::OrSymbol
@@ -152,46 +136,6 @@ module Telnyx
       def to_hash
       end
 
-      class VariableSchema < Telnyx::Internal::Type::BaseModel
-        OrHash =
-          T.type_alias do
-            T.any(
-              Telnyx::UpdateEmailTemplateRequest::VariableSchema,
-              Telnyx::Internal::AnyHash
-            )
-          end
-
-        # Whether the variable must be supplied when strict variable validation is
-        # enabled.
-        sig { returns(T::Boolean) }
-        attr_accessor :required
-
-        # Default value for an optional variable. Rejected when `required` is `true`.
-        sig { returns(T.nilable(String)) }
-        attr_reader :default
-
-        sig { params(default: String).void }
-        attr_writer :default
-
-        sig do
-          params(required: T::Boolean, default: String).returns(
-            T.attached_class
-          )
-        end
-        def self.new(
-          # Whether the variable must be supplied when strict variable validation is
-          # enabled.
-          required:,
-          # Default value for an optional variable. Rejected when `required` is `true`.
-          default: nil
-        )
-        end
-
-        sig { override.returns({ required: T::Boolean, default: String }) }
-        def to_hash
-        end
-      end
-
       # Controls how `variables` is maintained. Setting `automatic` re-extracts
       # immediately from the effective subject, HTML body, and text body and rejects a
       # simultaneous non-null array. Setting `explicit` requires the exact non-null

data/rbi/telnyx/models/variable_schema_entry.rbi

@@ -0,0 +1,40 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    class VariableSchemaEntry < Telnyx::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Telnyx::VariableSchemaEntry, Telnyx::Internal::AnyHash)
+        end
+
+      # Whether the variable must be supplied when strict variable validation is
+      # enabled.
+      sig { returns(T::Boolean) }
+      attr_accessor :required
+
+      # Default value for an optional variable. Rejected when `required` is `true`.
+      sig { returns(T.nilable(String)) }
+      attr_reader :default
+
+      sig { params(default: String).void }
+      attr_writer :default
+
+      sig do
+        params(required: T::Boolean, default: String).returns(T.attached_class)
+      end
+      def self.new(
+        # Whether the variable must be supplied when strict variable validation is
+        # enabled.
+        required:,
+        # Default value for an optional variable. Rejected when `required` is `true`.
+        default: nil
+      )
+      end
+
+      sig { override.returns({ required: T::Boolean, default: String }) }
+      def to_hash
+      end
+    end
+  end
+end