telnyx 5.168.0 → 5.170.0

data/rbi/telnyx/models/messaging_outbound_message_payload.rbi

@@ -18,6 +18,15 @@ module Telnyx
       sig { params(id: String).void }
       attr_writer :id
 
+      # RCS webhook message body. Text messages use the text property.
+      sig { returns(T.nilable(Telnyx::MessagingOutboundMessagePayload::Body)) }
+      attr_reader :body
+
+      sig do
+        params(body: Telnyx::MessagingOutboundMessagePayload::Body::OrHash).void
+      end
+      attr_writer :body
+
       sig do
         returns(
           T.nilable(T::Array[Telnyx::MessagingOutboundMessagePayload::Cc])
@@ -69,7 +78,7 @@ module Telnyx
       sig do
         returns(
           T.nilable(
-            Telnyx::MessagingOutboundMessagePayload::Direction::TaggedSymbol
+            Telnyx::MessagingOutboundMessagePayload::Direction::OrSymbol
           )
         )
       end
@@ -162,7 +171,7 @@ module Telnyx
       sig do
         returns(
           T.nilable(
-            Telnyx::MessagingOutboundMessagePayload::RecordType::TaggedSymbol
+            Telnyx::MessagingOutboundMessagePayload::RecordType::OrSymbol
           )
         )
       end
@@ -242,7 +251,7 @@ module Telnyx
       # The type of message.
       sig do
         returns(
-          T.nilable(Telnyx::MessagingOutboundMessagePayload::Type::TaggedSymbol)
+          T.nilable(Telnyx::MessagingOutboundMessagePayload::Type::OrSymbol)
         )
       end
       attr_reader :type
@@ -278,6 +287,7 @@ module Telnyx
       sig do
         params(
           id: String,
+          body: Telnyx::MessagingOutboundMessagePayload::Body::OrHash,
           cc: T::Array[Telnyx::MessagingOutboundMessagePayload::Cc::OrHash],
           completed_at: T.nilable(Time),
           cost:
@@ -319,6 +329,8 @@ module Telnyx
       def self.new(
         # Identifies the type of resource.
         id: nil,
+        # RCS webhook message body. Text messages use the text property.
+        body: nil,
         cc: nil,
         # ISO 8601 formatted date indicating when the message was finalized.
         completed_at: nil,
@@ -391,13 +403,14 @@ module Telnyx
         override.returns(
           {
             id: String,
+            body: Telnyx::MessagingOutboundMessagePayload::Body,
             cc: T::Array[Telnyx::MessagingOutboundMessagePayload::Cc],
             completed_at: T.nilable(Time),
             cost: T.nilable(Telnyx::MessagingOutboundMessagePayload::Cost),
             cost_breakdown:
               T.nilable(Telnyx::MessagingOutboundMessagePayload::CostBreakdown),
             direction:
-              Telnyx::MessagingOutboundMessagePayload::Direction::TaggedSymbol,
+              Telnyx::MessagingOutboundMessagePayload::Direction::OrSymbol,
             encoding: String,
             errors: T::Array[Telnyx::MessagingError0b38e7044b],
             from: Telnyx::MessagingOutboundMessagePayload::From,
@@ -408,7 +421,7 @@ module Telnyx
             parts: Integer,
             received_at: Time,
             record_type:
-              Telnyx::MessagingOutboundMessagePayload::RecordType::TaggedSymbol,
+              Telnyx::MessagingOutboundMessagePayload::RecordType::OrSymbol,
             sent_at: T.nilable(Time),
             smart_encoding_applied: T::Boolean,
             subject: T.nilable(String),
@@ -418,7 +431,7 @@ module Telnyx
             tcr_campaign_registered: T.nilable(String),
             text: String,
             to: T::Array[Telnyx::MessagingOutboundMessagePayload::To],
-            type: Telnyx::MessagingOutboundMessagePayload::Type::TaggedSymbol,
+            type: Telnyx::MessagingOutboundMessagePayload::Type::OrSymbol,
             valid_until: T.nilable(Time),
             wait_seconds: T.nilable(Float),
             webhook_failover_url: T.nilable(String),
@@ -429,6 +442,35 @@ module Telnyx
       def to_hash
       end
 
+      class Body < Telnyx::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Telnyx::MessagingOutboundMessagePayload::Body,
+              Telnyx::Internal::AnyHash
+            )
+          end
+
+        # RCS text message.
+        sig { returns(T.nilable(String)) }
+        attr_reader :text
+
+        sig { params(text: String).void }
+        attr_writer :text
+
+        # RCS webhook message body. Text messages use the text property.
+        sig { params(text: String).returns(T.attached_class) }
+        def self.new(
+          # RCS text message.
+          text: nil
+        )
+        end
+
+        sig { override.returns({ text: String }) }
+        def to_hash
+        end
+      end
+
       class Cc < Telnyx::Internal::Type::BaseModel
         OrHash =
           T.type_alias do
@@ -449,7 +491,7 @@ module Telnyx
         sig do
           returns(
             T.nilable(
-              Telnyx::MessagingOutboundMessagePayload::Cc::LineType::TaggedSymbol
+              Telnyx::MessagingOutboundMessagePayload::Cc::LineType::OrSymbol
             )
           )
         end
@@ -473,7 +515,7 @@ module Telnyx
         sig do
           returns(
             T.nilable(
-              Telnyx::MessagingOutboundMessagePayload::Cc::Status::TaggedSymbol
+              Telnyx::MessagingOutboundMessagePayload::Cc::Status::OrSymbol
             )
           )
         end
@@ -513,10 +555,10 @@ module Telnyx
             {
               carrier: String,
               line_type:
-                Telnyx::MessagingOutboundMessagePayload::Cc::LineType::TaggedSymbol,
+                Telnyx::MessagingOutboundMessagePayload::Cc::LineType::OrSymbol,
               phone_number: String,
               status:
-                Telnyx::MessagingOutboundMessagePayload::Cc::Status::TaggedSymbol
+                Telnyx::MessagingOutboundMessagePayload::Cc::Status::OrSymbol
             }
           )
         end
@@ -857,6 +899,20 @@ module Telnyx
             )
           end
 
+        # RCS agent identifier.
+        sig { returns(T.nilable(String)) }
+        attr_reader :agent_id
+
+        sig { params(agent_id: String).void }
+        attr_writer :agent_id
+
+        # RCS agent name.
+        sig { returns(T.nilable(String)) }
+        attr_reader :agent_name
+
+        sig { params(agent_name: String).void }
+        attr_writer :agent_name
+
         # The carrier of the receiver.
         sig { returns(T.nilable(String)) }
         attr_reader :carrier
@@ -868,7 +924,7 @@ module Telnyx
         sig do
           returns(
             T.nilable(
-              Telnyx::MessagingOutboundMessagePayload::From::LineType::TaggedSymbol
+              Telnyx::MessagingOutboundMessagePayload::From::LineType::OrSymbol
             )
           )
         end
@@ -892,6 +948,8 @@ module Telnyx
 
         sig do
           params(
+            agent_id: String,
+            agent_name: String,
             carrier: String,
             line_type:
               Telnyx::MessagingOutboundMessagePayload::From::LineType::OrSymbol,
@@ -899,6 +957,10 @@ module Telnyx
           ).returns(T.attached_class)
         end
         def self.new(
+          # RCS agent identifier.
+          agent_id: nil,
+          # RCS agent name.
+          agent_name: nil,
           # The carrier of the receiver.
           carrier: nil,
           # The line-type of the receiver.
@@ -912,9 +974,11 @@ module Telnyx
         sig do
           override.returns(
             {
+              agent_id: String,
+              agent_name: String,
               carrier: String,
               line_type:
-                Telnyx::MessagingOutboundMessagePayload::From::LineType::TaggedSymbol,
+                Telnyx::MessagingOutboundMessagePayload::From::LineType::OrSymbol,
               phone_number: String
             }
           )
@@ -1087,7 +1151,7 @@ module Telnyx
         sig do
           returns(
             T.nilable(
-              Telnyx::MessagingOutboundMessagePayload::To::LineType::TaggedSymbol
+              Telnyx::MessagingOutboundMessagePayload::To::LineType::OrSymbol
             )
           )
         end
@@ -1112,7 +1176,7 @@ module Telnyx
         sig do
           returns(
             T.nilable(
-              Telnyx::MessagingOutboundMessagePayload::To::Status::TaggedSymbol
+              Telnyx::MessagingOutboundMessagePayload::To::Status::OrSymbol
             )
           )
         end
@@ -1153,10 +1217,10 @@ module Telnyx
             {
               carrier: String,
               line_type:
-                Telnyx::MessagingOutboundMessagePayload::To::LineType::TaggedSymbol,
+                Telnyx::MessagingOutboundMessagePayload::To::LineType::OrSymbol,
               phone_number: String,
               status:
-                Telnyx::MessagingOutboundMessagePayload::To::Status::TaggedSymbol
+                Telnyx::MessagingOutboundMessagePayload::To::Status::OrSymbol
             }
           )
         end
@@ -1268,6 +1332,11 @@ module Telnyx
               :delivery_failed,
               Telnyx::MessagingOutboundMessagePayload::To::Status::TaggedSymbol
             )
+          READ =
+            T.let(
+              :read,
+              Telnyx::MessagingOutboundMessagePayload::To::Status::TaggedSymbol
+            )
 
           sig do
             override.returns(
@@ -1301,6 +1370,11 @@ module Telnyx
             :MMS,
             Telnyx::MessagingOutboundMessagePayload::Type::TaggedSymbol
           )
+        RCS =
+          T.let(
+            :RCS,
+            Telnyx::MessagingOutboundMessagePayload::Type::TaggedSymbol
+          )
 
         sig do
           override.returns(

data/rbi/telnyx/models/noise_suppression_engine_list_params.rbi

@@ -0,0 +1,30 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    class NoiseSuppressionEngineListParams < Telnyx::Internal::Type::BaseModel
+      extend Telnyx::Internal::Type::RequestParameters::Converter
+      include Telnyx::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            Telnyx::NoiseSuppressionEngineListParams,
+            Telnyx::Internal::AnyHash
+          )
+        end
+
+      sig do
+        params(request_options: Telnyx::RequestOptions::OrHash).returns(
+          T.attached_class
+        )
+      end
+      def self.new(request_options: {})
+      end
+
+      sig { override.returns({ request_options: Telnyx::RequestOptions }) }
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/telnyx/models/noise_suppression_engine_list_response.rbi

@@ -0,0 +1,94 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    class NoiseSuppressionEngineListResponse < Telnyx::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Telnyx::Models::NoiseSuppressionEngineListResponse,
+            Telnyx::Internal::AnyHash
+          )
+        end
+
+      sig do
+        returns(
+          T::Array[Telnyx::Models::NoiseSuppressionEngineListResponse::Data]
+        )
+      end
+      attr_accessor :data
+
+      sig do
+        params(
+          data:
+            T::Array[
+              Telnyx::Models::NoiseSuppressionEngineListResponse::Data::OrHash
+            ]
+        ).returns(T.attached_class)
+      end
+      def self.new(data:)
+      end
+
+      sig do
+        override.returns(
+          {
+            data:
+              T::Array[Telnyx::Models::NoiseSuppressionEngineListResponse::Data]
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Data < Telnyx::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Telnyx::Models::NoiseSuppressionEngineListResponse::Data,
+              Telnyx::Internal::AnyHash
+            )
+          end
+
+        # Default attenuation level of the engine (0-100, in multiples of ten).
+        sig { returns(Integer) }
+        attr_accessor :default_attenuation_level
+
+        # Human-readable name of the engine.
+        sig { returns(String) }
+        attr_accessor :label
+
+        # Machine-readable identifier of the engine, used when configuring noise
+        # suppression.
+        sig { returns(String) }
+        attr_accessor :value
+
+        # A noise suppression engine available to the authenticated user.
+        sig do
+          params(
+            default_attenuation_level: Integer,
+            label: String,
+            value: String
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Default attenuation level of the engine (0-100, in multiples of ten).
+          default_attenuation_level:,
+          # Human-readable name of the engine.
+          label:,
+          # Machine-readable identifier of the engine, used when configuring noise
+          # suppression.
+          value:
+        )
+        end
+
+        sig do
+          override.returns(
+            { default_attenuation_level: Integer, label: String, value: String }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/number_order_status_update.rbi

@@ -54,7 +54,9 @@ module Telnyx
         attr_accessor :id
 
         # The type of event being sent
-        sig { returns(String) }
+        sig do
+          returns(Telnyx::NumberOrderStatusUpdate::Data::EventType::OrSymbol)
+        end
         attr_accessor :event_type
 
         # ISO 8601 timestamp of when the event occurred
@@ -76,7 +78,8 @@ module Telnyx
         sig do
           params(
             id: String,
-            event_type: String,
+            event_type:
+              Telnyx::NumberOrderStatusUpdate::Data::EventType::OrSymbol,
             occurred_at: Time,
             payload: Telnyx::NumberOrderWithPhoneNumbers::OrHash,
             record_type: String
@@ -99,7 +102,8 @@ module Telnyx
           override.returns(
             {
               id: String,
-              event_type: String,
+              event_type:
+                Telnyx::NumberOrderStatusUpdate::Data::EventType::OrSymbol,
               occurred_at: Time,
               payload: Telnyx::NumberOrderWithPhoneNumbers,
               record_type: String
@@ -108,6 +112,33 @@ module Telnyx
         end
         def to_hash
         end
+
+        # The type of event being sent
+        module EventType
+          extend Telnyx::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(Symbol, Telnyx::NumberOrderStatusUpdate::Data::EventType)
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          NUMBER_ORDER_COMPLETE =
+            T.let(
+              :"number_order.complete",
+              Telnyx::NumberOrderStatusUpdate::Data::EventType::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Telnyx::NumberOrderStatusUpdate::Data::EventType::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
       end
 
       class Meta < Telnyx::Internal::Type::BaseModel

data/rbi/telnyx/models/number_order_status_update_webhook_event.rbi

@@ -65,7 +65,11 @@ module Telnyx
         attr_accessor :id
 
         # The type of event being sent
-        sig { returns(String) }
+        sig do
+          returns(
+            Telnyx::NumberOrderStatusUpdateWebhookEvent::Data::EventType::TaggedSymbol
+          )
+        end
         attr_accessor :event_type
 
         # ISO 8601 timestamp of when the event occurred
@@ -94,7 +98,8 @@ module Telnyx
         sig do
           params(
             id: String,
-            event_type: String,
+            event_type:
+              Telnyx::NumberOrderStatusUpdateWebhookEvent::Data::EventType::OrSymbol,
             occurred_at: Time,
             payload:
               Telnyx::NumberOrderStatusUpdateWebhookEvent::Data::Payload::OrHash,
@@ -120,7 +125,8 @@ module Telnyx
           override.returns(
             {
               id: String,
-              event_type: String,
+              event_type:
+                Telnyx::NumberOrderStatusUpdateWebhookEvent::Data::EventType::TaggedSymbol,
               occurred_at: Time,
               payload:
                 Telnyx::NumberOrderStatusUpdateWebhookEvent::Data::Payload,
@@ -131,6 +137,36 @@ module Telnyx
         def to_hash
         end
 
+        # The type of event being sent
+        module EventType
+          extend Telnyx::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                Telnyx::NumberOrderStatusUpdateWebhookEvent::Data::EventType
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          NUMBER_ORDER_COMPLETE =
+            T.let(
+              :"number_order.complete",
+              Telnyx::NumberOrderStatusUpdateWebhookEvent::Data::EventType::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Telnyx::NumberOrderStatusUpdateWebhookEvent::Data::EventType::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+
         class Payload < Telnyx::Internal::Type::BaseModel
           OrHash =
             T.type_alias do

data/rbi/telnyx/models/numbers_phone_number_detailed.rbi

@@ -78,11 +78,21 @@ module Telnyx
       end
       attr_writer :inbound_call_screening
 
-      # Identifies the messaging profile associated with the phone number.
+      # Identifies the messaging campaign associated with the phone number's messaging
+      # profile. If the messaging profile details could not be retrieved, this value is
+      # the string `UNAVAILABLE`.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :messaging_campaign_id
+
+      # Identifies the messaging profile associated with the phone number. If the
+      # messaging profile details could not be retrieved, this value is the string
+      # `UNAVAILABLE`.
       sig { returns(T.nilable(String)) }
       attr_accessor :messaging_profile_id
 
-      # The name of the messaging profile associated with the phone number.
+      # The name of the messaging profile associated with the phone number. If the
+      # messaging profile details could not be retrieved, this value is the string
+      # `UNAVAILABLE`.
       sig { returns(T.nilable(String)) }
       attr_accessor :messaging_profile_name
 
@@ -239,6 +249,7 @@ module Telnyx
           hd_voice_enabled: T::Boolean,
           inbound_call_screening:
             Telnyx::NumbersPhoneNumberDetailed::InboundCallScreening::OrSymbol,
+          messaging_campaign_id: T.nilable(String),
           messaging_profile_id: T.nilable(String),
           messaging_profile_name: T.nilable(String),
           source_type:
@@ -316,9 +327,17 @@ module Telnyx
         # fraudulent calls. It can be set to disabled, reject_calls, or flag_calls. This
         # feature has an additional per-number monthly cost associated with it.
         inbound_call_screening: nil,
-        # Identifies the messaging profile associated with the phone number.
+        # Identifies the messaging campaign associated with the phone number's messaging
+        # profile. If the messaging profile details could not be retrieved, this value is
+        # the string `UNAVAILABLE`.
+        messaging_campaign_id: nil,
+        # Identifies the messaging profile associated with the phone number. If the
+        # messaging profile details could not be retrieved, this value is the string
+        # `UNAVAILABLE`.
         messaging_profile_id: nil,
-        # The name of the messaging profile associated with the phone number.
+        # The name of the messaging profile associated with the phone number. If the
+        # messaging profile details could not be retrieved, this value is the string
+        # `UNAVAILABLE`.
         messaging_profile_name: nil,
         # Indicates if the phone number was purchased or ported in. For some numbers this
         # information may not be available.
@@ -361,6 +380,7 @@ module Telnyx
             hd_voice_enabled: T::Boolean,
             inbound_call_screening:
               Telnyx::NumbersPhoneNumberDetailed::InboundCallScreening::TaggedSymbol,
+            messaging_campaign_id: T.nilable(String),
             messaging_profile_id: T.nilable(String),
             messaging_profile_name: T.nilable(String),
             source_type:

data/rbi/telnyx/models/outbound_message.rbi

@@ -104,6 +104,11 @@ module Telnyx
             :"message.finalized",
             Telnyx::OutboundMessage::EventType::TaggedSymbol
           )
+        MESSAGE_READ =
+          T.let(
+            :"message.read",
+            Telnyx::OutboundMessage::EventType::TaggedSymbol
+          )
 
         sig do
           override.returns(