telnyx 5.168.0 → 5.170.0

data/rbi/telnyx/models/meeting_session_create_params.rbi

@@ -15,10 +15,10 @@ module Telnyx
       sig { returns(String) }
       attr_accessor :meeting_url
 
-      # Request options for attaching a voice assistant to the session. Routing fields
-      # (`call_control_connection_id`, `from`, and `loopback_sip_uri`) are used only to
-      # establish the assistant call leg and are omitted from response objects.
-      # `audio_gate` is returned with `id` in the assistant response object.
+      # Attach a Telnyx AI Assistant to the session. Supply the Assistant's ID; the
+      # Meeting service connects it to the meeting directly. The Call Control
+      # connection, caller ID and loopback SIP URI previously required here have been
+      # removed and are now rejected as unknown fields.
       sig { returns(T.nilable(Telnyx::MeetingSessionCreateParams::Assistant)) }
       attr_reader :assistant
 
@@ -83,6 +83,17 @@ module Telnyx
       end
       attr_writer :camera_image
 
+      # A message the bot posts to the meeting's chat as soon as it becomes active —
+      # typically a recording disclosure. Delivered at most once. Independent of
+      # `speak_on_enter`: both may be set, and the chat message posts first because it
+      # does not wait for text-to-speech or avatar startup. Rejected with 422
+      # `unsupported_capability` on platforms without meeting chat.
+      sig { returns(T.nilable(String)) }
+      attr_reader :chat_on_enter
+
+      sig { params(chat_on_enter: String).void }
+      attr_writer :chat_on_enter
+
       # Client-supplied idempotency key to safely retry creation requests without
       # duplicating sessions. Lookup is scoped to the authenticated account and compares
       # the key only; the request payload is not fingerprinted or compared.
@@ -108,7 +119,10 @@ module Telnyx
       sig { params(metadata: T::Hash[Symbol, T.anything]).void }
       attr_writer :metadata
 
-      # Text the bot speaks when it enters the meeting.
+      # Text the bot speaks when it enters the meeting. **Not spoken when an `assistant`
+      # is attached**: the value is accepted and echoed back on the session, but the
+      # assistant owns the voice and the line is never delivered, with no event
+      # reporting the omission. Use `chat_on_enter` to announce an assistant-backed bot.
       sig { returns(T.nilable(String)) }
       attr_reader :speak_on_enter
 
@@ -152,6 +166,7 @@ module Telnyx
               Telnyx::MeetingSessionCreateParams::CameraImage::MeetingSessionCameraImageBase64Source::OrHash,
               Telnyx::MeetingSessionCreateParams::CameraImage::MeetingSessionCameraImageURLSource::OrHash
             ),
+          chat_on_enter: String,
           idempotency_key: String,
           join_at: Time,
           metadata: T::Hash[Symbol, T.anything],
@@ -165,10 +180,10 @@ module Telnyx
       def self.new(
         # The meeting URL the bot should join.
         meeting_url:,
-        # Request options for attaching a voice assistant to the session. Routing fields
-        # (`call_control_connection_id`, `from`, and `loopback_sip_uri`) are used only to
-        # establish the assistant call leg and are omitted from response objects.
-        # `audio_gate` is returned with `id` in the assistant response object.
+        # Attach a Telnyx AI Assistant to the session. Supply the Assistant's ID; the
+        # Meeting service connects it to the meeting directly. The Call Control
+        # connection, caller ID and loopback SIP URI previously required here have been
+        # removed and are now rejected as unknown fields.
         assistant: nil,
         # Request options for attaching a bring-your-own-key avatar to the session.
         avatar: nil,
@@ -185,6 +200,12 @@ module Telnyx
         # recordings. An effective Avatar or Assistant webpage output takes precedence, so
         # this input is ignored and a URL source is not fetched.
         camera_image: nil,
+        # A message the bot posts to the meeting's chat as soon as it becomes active —
+        # typically a recording disclosure. Delivered at most once. Independent of
+        # `speak_on_enter`: both may be set, and the chat message posts first because it
+        # does not wait for text-to-speech or avatar startup. Rejected with 422
+        # `unsupported_capability` on platforms without meeting chat.
+        chat_on_enter: nil,
         # Client-supplied idempotency key to safely retry creation requests without
         # duplicating sessions. Lookup is scoped to the authenticated account and compares
         # the key only; the request payload is not fingerprinted or compared.
@@ -195,7 +216,10 @@ module Telnyx
         # Arbitrary key-value metadata attached to the session. The serialized JSON
         # representation must not exceed 16384 characters at runtime.
         metadata: nil,
-        # Text the bot speaks when it enters the meeting.
+        # Text the bot speaks when it enters the meeting. **Not spoken when an `assistant`
+        # is attached**: the value is accepted and echoed back on the session, but the
+        # assistant owns the voice and the line is never delivered, with no event
+        # reporting the omission. Use `chat_on_enter` to announce an assistant-backed bot.
         speak_on_enter: nil,
         # If true, generate a summary artifact when the session ends.
         summarize_on_end: nil,
@@ -224,6 +248,7 @@ module Telnyx
                 Telnyx::MeetingSessionCreateParams::CameraImage::MeetingSessionCameraImageBase64Source,
                 Telnyx::MeetingSessionCreateParams::CameraImage::MeetingSessionCameraImageURLSource
               ),
+            chat_on_enter: String,
             idempotency_key: String,
             join_at: Time,
             metadata: T::Hash[Symbol, T.anything],
@@ -251,19 +276,12 @@ module Telnyx
         sig { returns(String) }
         attr_accessor :id
 
-        # Call control connection used to bridge the assistant into the meeting audio.
-        sig { returns(String) }
-        attr_accessor :call_control_connection_id
-
-        # E.164 calling number used as the originating party for the assistant call leg.
-        sig { returns(String) }
-        attr_accessor :from
-
-        # SIP URI to which the assistant media loopback is established.
-        sig { returns(String) }
-        attr_accessor :loopback_sip_uri
-
-        # Audio gating strategy for the assistant call leg.
+        # Audio gating strategy for the assistant call leg. `half_duplex` (default) sends
+        # the assistant a single mixed meeting stream and mutes it while the assistant
+        # speaks, so the assistant cannot hear itself and cannot be interrupted.
+        # `full_duplex` sends a separate stream per participant, which allows barge-in and
+        # removes self-hearing, and COSTS SIGNIFICANTLY MORE: per-participant streams
+        # multiply the per-minute cost by the number of participants.
         sig do
           returns(
             T.nilable(
@@ -281,31 +299,73 @@ module Telnyx
         end
         attr_writer :audio_gate
 
-        # Request options for attaching a voice assistant to the session. Routing fields
-        # (`call_control_connection_id`, `from`, and `loopback_sip_uri`) are used only to
-        # establish the assistant call leg and are omitted from response objects.
-        # `audio_gate` is returned with `id` in the assistant response object.
+        # Per-conversation values for the
+        # [dynamic variables](/docs/inference/ai-assistants/dynamic-variables) used in the
+        # Assistant's instructions, greeting, or tools. Delivered before the Assistant's
+        # first utterance, so they resolve for the opening line as well as the rest of the
+        # conversation. At most 63 entries; keys 1-128 characters; values must be strings.
+        # The map is budgeted in aggregate at 1,047,552 bytes (1023 KiB) rather than
+        # capped per value. `streaming_audio`, `ai_assistant_streaming_audio` and
+        # `meeting_session_id` are reserved and rejected with `400 invalid_request` --
+        # they toggle provider infrastructure or are set by the service rather than fill a
+        # prompt template.
+        sig { returns(T.nilable(T::Hash[Symbol, String])) }
+        attr_reader :dynamic_variables
+
+        sig { params(dynamic_variables: T::Hash[Symbol, String]).void }
+        attr_writer :dynamic_variables
+
+        # Leave the meeting when the Assistant's conversation reaches a terminal state --
+        # `ended` **or** `failed`. Off by default, which leaves the bot in the meeting
+        # after the Assistant stops. Fires once: a second terminal transition does not
+        # leave twice, and a leave the provider refuses is logged without changing how the
+        # session settles.
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :leave_on_end
+
+        sig { params(leave_on_end: T::Boolean).void }
+        attr_writer :leave_on_end
+
+        # Attach a Telnyx AI Assistant to the session. Supply the Assistant's ID; the
+        # Meeting service connects it to the meeting directly. The Call Control
+        # connection, caller ID and loopback SIP URI previously required here have been
+        # removed and are now rejected as unknown fields.
         sig do
           params(
             id: String,
-            call_control_connection_id: String,
-            from: String,
-            loopback_sip_uri: String,
             audio_gate:
-              Telnyx::MeetingSessionCreateParams::Assistant::AudioGate::OrSymbol
+              Telnyx::MeetingSessionCreateParams::Assistant::AudioGate::OrSymbol,
+            dynamic_variables: T::Hash[Symbol, String],
+            leave_on_end: T::Boolean
           ).returns(T.attached_class)
         end
         def self.new(
           # Identifier of the assistant to attach.
           id:,
-          # Call control connection used to bridge the assistant into the meeting audio.
-          call_control_connection_id:,
-          # E.164 calling number used as the originating party for the assistant call leg.
-          from:,
-          # SIP URI to which the assistant media loopback is established.
-          loopback_sip_uri:,
-          # Audio gating strategy for the assistant call leg.
-          audio_gate: nil
+          # Audio gating strategy for the assistant call leg. `half_duplex` (default) sends
+          # the assistant a single mixed meeting stream and mutes it while the assistant
+          # speaks, so the assistant cannot hear itself and cannot be interrupted.
+          # `full_duplex` sends a separate stream per participant, which allows barge-in and
+          # removes self-hearing, and COSTS SIGNIFICANTLY MORE: per-participant streams
+          # multiply the per-minute cost by the number of participants.
+          audio_gate: nil,
+          # Per-conversation values for the
+          # [dynamic variables](/docs/inference/ai-assistants/dynamic-variables) used in the
+          # Assistant's instructions, greeting, or tools. Delivered before the Assistant's
+          # first utterance, so they resolve for the opening line as well as the rest of the
+          # conversation. At most 63 entries; keys 1-128 characters; values must be strings.
+          # The map is budgeted in aggregate at 1,047,552 bytes (1023 KiB) rather than
+          # capped per value. `streaming_audio`, `ai_assistant_streaming_audio` and
+          # `meeting_session_id` are reserved and rejected with `400 invalid_request` --
+          # they toggle provider infrastructure or are set by the service rather than fill a
+          # prompt template.
+          dynamic_variables: nil,
+          # Leave the meeting when the Assistant's conversation reaches a terminal state --
+          # `ended` **or** `failed`. Off by default, which leaves the bot in the meeting
+          # after the Assistant stops. Fires once: a second terminal transition does not
+          # leave twice, and a leave the provider refuses is logged without changing how the
+          # session settles.
+          leave_on_end: nil
         )
         end
 
@@ -313,18 +373,22 @@ module Telnyx
           override.returns(
             {
               id: String,
-              call_control_connection_id: String,
-              from: String,
-              loopback_sip_uri: String,
               audio_gate:
-                Telnyx::MeetingSessionCreateParams::Assistant::AudioGate::OrSymbol
+                Telnyx::MeetingSessionCreateParams::Assistant::AudioGate::OrSymbol,
+              dynamic_variables: T::Hash[Symbol, String],
+              leave_on_end: T::Boolean
             }
           )
         end
         def to_hash
         end
 
-        # Audio gating strategy for the assistant call leg.
+        # Audio gating strategy for the assistant call leg. `half_duplex` (default) sends
+        # the assistant a single mixed meeting stream and mutes it while the assistant
+        # speaks, so the assistant cannot hear itself and cannot be interrupted.
+        # `full_duplex` sends a separate stream per participant, which allows barge-in and
+        # removes self-hearing, and COSTS SIGNIFICANTLY MORE: per-participant streams
+        # multiply the per-minute cost by the number of participants.
         module AudioGate
           extend Telnyx::Internal::Type::Enum
 
@@ -337,14 +401,14 @@ module Telnyx
             end
           OrSymbol = T.type_alias { T.any(Symbol, String) }
 
-          NONE =
+          HALF_DUPLEX =
             T.let(
-              :none,
+              :half_duplex,
               Telnyx::MeetingSessionCreateParams::Assistant::AudioGate::TaggedSymbol
             )
-          HALF_DUPLEX =
+          FULL_DUPLEX =
             T.let(
-              :half_duplex,
+              :full_duplex,
               Telnyx::MeetingSessionCreateParams::Assistant::AudioGate::TaggedSymbol
             )
 

data/rbi/telnyx/models/meeting_sessions/artifact_create_params.rbi

@@ -18,23 +18,34 @@ module Telnyx
         sig { returns(String) }
         attr_accessor :id
 
-        # Type of artifact to generate from the session.
+        # One of two shapes: a named type on its own, or `custom` with the prompt it
+        # answers.
         sig do
-          returns(Telnyx::MeetingSessions::ArtifactCreateParams::Type::OrSymbol)
+          returns(
+            T.any(
+              Telnyx::MeetingSessions::ArtifactCreateParams::Body::NamedArtifact,
+              Telnyx::MeetingSessions::ArtifactCreateParams::Body::CustomArtifact
+            )
+          )
         end
-        attr_accessor :type
+        attr_accessor :body
 
         sig do
           params(
             id: String,
-            type: Telnyx::MeetingSessions::ArtifactCreateParams::Type::OrSymbol,
+            body:
+              T.any(
+                Telnyx::MeetingSessions::ArtifactCreateParams::Body::NamedArtifact::OrHash,
+                Telnyx::MeetingSessions::ArtifactCreateParams::Body::CustomArtifact::OrHash
+              ),
             request_options: Telnyx::RequestOptions::OrHash
           ).returns(T.attached_class)
         end
         def self.new(
           id:,
-          # Type of artifact to generate from the session.
-          type:,
+          # One of two shapes: a named type on its own, or `custom` with the prompt it
+          # answers.
+          body:,
           request_options: {}
         )
         end
@@ -43,8 +54,11 @@ module Telnyx
           override.returns(
             {
               id: String,
-              type:
-                Telnyx::MeetingSessions::ArtifactCreateParams::Type::OrSymbol,
+              body:
+                T.any(
+                  Telnyx::MeetingSessions::ArtifactCreateParams::Body::NamedArtifact,
+                  Telnyx::MeetingSessions::ArtifactCreateParams::Body::CustomArtifact
+                ),
               request_options: Telnyx::RequestOptions
             }
           )
@@ -52,35 +66,158 @@ module Telnyx
         def to_hash
         end
 
-        # Type of artifact to generate from the session.
-        module Type
-          extend Telnyx::Internal::Type::Enum
+        # One of two shapes: a named type on its own, or `custom` with the prompt it
+        # answers.
+        module Body
+          extend Telnyx::Internal::Type::Union
 
-          TaggedSymbol =
+          Variants =
             T.type_alias do
-              T.all(Symbol, Telnyx::MeetingSessions::ArtifactCreateParams::Type)
+              T.any(
+                Telnyx::MeetingSessions::ArtifactCreateParams::Body::NamedArtifact,
+                Telnyx::MeetingSessions::ArtifactCreateParams::Body::CustomArtifact
+              )
+            end
+
+          class NamedArtifact < Telnyx::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  Telnyx::MeetingSessions::ArtifactCreateParams::Body::NamedArtifact,
+                  Telnyx::Internal::AnyHash
+                )
+              end
+
+            # What to generate from the transcript. `custom` is answered from a `prompt` you
+            # supply; the five named types need none.
+            sig do
+              returns(
+                Telnyx::MeetingSessions::ArtifactCreateParams::Body::NamedArtifact::Type::OrSymbol
+              )
             end
-          OrSymbol = T.type_alias { T.any(Symbol, String) }
+            attr_accessor :type
 
-          SUMMARY =
-            T.let(
-              :summary,
-              Telnyx::MeetingSessions::ArtifactCreateParams::Type::TaggedSymbol
+            sig do
+              params(
+                type:
+                  Telnyx::MeetingSessions::ArtifactCreateParams::Body::NamedArtifact::Type::OrSymbol
+              ).returns(T.attached_class)
+            end
+            def self.new(
+              # What to generate from the transcript. `custom` is answered from a `prompt` you
+              # supply; the five named types need none.
+              type:
             )
-          ACTION_ITEMS =
-            T.let(
-              :action_items,
-              Telnyx::MeetingSessions::ArtifactCreateParams::Type::TaggedSymbol
+            end
+
+            sig do
+              override.returns(
+                {
+                  type:
+                    Telnyx::MeetingSessions::ArtifactCreateParams::Body::NamedArtifact::Type::OrSymbol
+                }
+              )
+            end
+            def to_hash
+            end
+
+            # What to generate from the transcript. `custom` is answered from a `prompt` you
+            # supply; the five named types need none.
+            module Type
+              extend Telnyx::Internal::Type::Enum
+
+              TaggedSymbol =
+                T.type_alias do
+                  T.all(
+                    Symbol,
+                    Telnyx::MeetingSessions::ArtifactCreateParams::Body::NamedArtifact::Type
+                  )
+                end
+              OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+              SUMMARY =
+                T.let(
+                  :summary,
+                  Telnyx::MeetingSessions::ArtifactCreateParams::Body::NamedArtifact::Type::TaggedSymbol
+                )
+              ACTION_ITEMS =
+                T.let(
+                  :action_items,
+                  Telnyx::MeetingSessions::ArtifactCreateParams::Body::NamedArtifact::Type::TaggedSymbol
+                )
+              DECISIONS =
+                T.let(
+                  :decisions,
+                  Telnyx::MeetingSessions::ArtifactCreateParams::Body::NamedArtifact::Type::TaggedSymbol
+                )
+              TOPICS =
+                T.let(
+                  :topics,
+                  Telnyx::MeetingSessions::ArtifactCreateParams::Body::NamedArtifact::Type::TaggedSymbol
+                )
+              OPEN_QUESTIONS =
+                T.let(
+                  :open_questions,
+                  Telnyx::MeetingSessions::ArtifactCreateParams::Body::NamedArtifact::Type::TaggedSymbol
+                )
+
+              sig do
+                override.returns(
+                  T::Array[
+                    Telnyx::MeetingSessions::ArtifactCreateParams::Body::NamedArtifact::Type::TaggedSymbol
+                  ]
+                )
+              end
+              def self.values
+              end
+            end
+          end
+
+          class CustomArtifact < Telnyx::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  Telnyx::MeetingSessions::ArtifactCreateParams::Body::CustomArtifact,
+                  Telnyx::Internal::AnyHash
+                )
+              end
+
+            # An open-ended request answered from the transcript. Required when `type` is
+            # `custom`, and rejected with 400 on any named type. Trimmed before storage and
+            # echoed back in artifact responses and the `artifact.completed` webhook.
+            sig { returns(String) }
+            attr_accessor :prompt
+
+            # Answered from the `prompt` below rather than a fixed question.
+            sig { returns(Symbol) }
+            attr_accessor :type
+
+            sig do
+              params(prompt: String, type: Symbol).returns(T.attached_class)
+            end
+            def self.new(
+              # An open-ended request answered from the transcript. Required when `type` is
+              # `custom`, and rejected with 400 on any named type. Trimmed before storage and
+              # echoed back in artifact responses and the `artifact.completed` webhook.
+              prompt:,
+              # Answered from the `prompt` below rather than a fixed question.
+              type: :custom
             )
+            end
+
+            sig { override.returns({ prompt: String, type: Symbol }) }
+            def to_hash
+            end
+          end
 
           sig do
             override.returns(
               T::Array[
-                Telnyx::MeetingSessions::ArtifactCreateParams::Type::TaggedSymbol
+                Telnyx::MeetingSessions::ArtifactCreateParams::Body::Variants
               ]
             )
           end
-          def self.values
+          def self.variants
           end
         end
       end

data/rbi/telnyx/models/meeting_sessions/meeting_session_artifact.rbi

@@ -59,6 +59,11 @@ module Telnyx
         end
         attr_writer :model_provenance
 
+        # The prompt that produced this artifact, or null for a named type. Non-null only
+        # when `type` is `custom`; the five named types always return `null`.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :prompt
+
         sig { returns(String) }
         attr_accessor :session_id
 
@@ -92,6 +97,7 @@ module Telnyx
               T.nilable(
                 Telnyx::MeetingSessions::MeetingSessionArtifact::ModelProvenance::OrHash
               ),
+            prompt: T.nilable(String),
             session_id: String,
             status:
               Telnyx::MeetingSessions::MeetingSessionArtifact::Status::OrSymbol,
@@ -106,6 +112,9 @@ module Telnyx
           created_at:,
           failure_reason:,
           model_provenance:,
+          # The prompt that produced this artifact, or null for a named type. Non-null only
+          # when `type` is `custom`; the five named types always return `null`.
+          prompt:,
           session_id:,
           status:,
           type:,
@@ -127,6 +136,7 @@ module Telnyx
                 T.nilable(
                   Telnyx::MeetingSessions::MeetingSessionArtifact::ModelProvenance
                 ),
+              prompt: T.nilable(String),
               session_id: String,
               status:
                 Telnyx::MeetingSessions::MeetingSessionArtifact::Status::TaggedSymbol,
@@ -247,6 +257,26 @@ module Telnyx
               :action_items,
               Telnyx::MeetingSessions::MeetingSessionArtifact::Type::TaggedSymbol
             )
+          DECISIONS =
+            T.let(
+              :decisions,
+              Telnyx::MeetingSessions::MeetingSessionArtifact::Type::TaggedSymbol
+            )
+          TOPICS =
+            T.let(
+              :topics,
+              Telnyx::MeetingSessions::MeetingSessionArtifact::Type::TaggedSymbol
+            )
+          OPEN_QUESTIONS =
+            T.let(
+              :open_questions,
+              Telnyx::MeetingSessions::MeetingSessionArtifact::Type::TaggedSymbol
+            )
+          CUSTOM =
+            T.let(
+              :custom,
+              Telnyx::MeetingSessions::MeetingSessionArtifact::Type::TaggedSymbol
+            )
 
           sig do
             override.returns(

data/rbi/telnyx/models/message_event.rbi

@@ -6,9 +6,29 @@ module Telnyx
       OrHash =
         T.type_alias { T.any(Telnyx::MessageEvent, Telnyx::Internal::AnyHash) }
 
+      # Additive canonical outcome name, prefixed with `email.`. Gateway rejection is
+      # `email.gw_reject`, ambiguous injection timeout is `email.injection_timeout`, and
+      # MTA expiration is `email.expired`. Unchanged outcomes retain their names.
+      # Existing stored rows are translated only when recorded payload evidence proves
+      # the outcome; a legacy failed row is not guessed or sharpened.
+      sig { returns(String) }
+      attr_accessor :canonical_event_type
+
+      # Legacy customer-visible event name, prefixed with `email.`. Gateway rejections
+      # render `email.failed`; MTA expirations render `email.bounced`. Webhook
+      # subscription allowlists match the legacy name.
+      sig { returns(String) }
+      attr_accessor :event_type
+
       sig { returns(Time) }
       attr_accessor :occurred_at
 
+      # Bare stored event names returned by message history. In addition to the normal
+      # send and delivery lifecycle, polling can expose suppression, scan, and
+      # quarantine lifecycle rows. Sharp canonical names gw_reject, injection_timeout,
+      # and expired distinguish gateway rejection, ambiguous injection timeout, and MTA
+      # expiration. The failed and bounced names remain valid for system/admin failures
+      # and hard bounces respectively. Existing stored rows retain their original names.
       sig { returns(Telnyx::EmailEventType::TaggedSymbol) }
       attr_accessor :type
 
@@ -18,19 +38,46 @@ module Telnyx
       sig { params(payload: T::Hash[Symbol, T.anything]).void }
       attr_writer :payload
 
+      # An event on the per-message events endpoint. The legacy event_type and additive
+      # canonical_event_type are email.-prefixed. The deprecated type preserves the bare
+      # stored event name for compatibility.
       sig do
         params(
+          canonical_event_type: String,
+          event_type: String,
           occurred_at: Time,
           type: Telnyx::EmailEventType::OrSymbol,
           payload: T::Hash[Symbol, T.anything]
         ).returns(T.attached_class)
       end
-      def self.new(occurred_at:, type:, payload: nil)
+      def self.new(
+        # Additive canonical outcome name, prefixed with `email.`. Gateway rejection is
+        # `email.gw_reject`, ambiguous injection timeout is `email.injection_timeout`, and
+        # MTA expiration is `email.expired`. Unchanged outcomes retain their names.
+        # Existing stored rows are translated only when recorded payload evidence proves
+        # the outcome; a legacy failed row is not guessed or sharpened.
+        canonical_event_type:,
+        # Legacy customer-visible event name, prefixed with `email.`. Gateway rejections
+        # render `email.failed`; MTA expirations render `email.bounced`. Webhook
+        # subscription allowlists match the legacy name.
+        event_type:,
+        occurred_at:,
+        # Bare stored event names returned by message history. In addition to the normal
+        # send and delivery lifecycle, polling can expose suppression, scan, and
+        # quarantine lifecycle rows. Sharp canonical names gw_reject, injection_timeout,
+        # and expired distinguish gateway rejection, ambiguous injection timeout, and MTA
+        # expiration. The failed and bounced names remain valid for system/admin failures
+        # and hard bounces respectively. Existing stored rows retain their original names.
+        type:,
+        payload: nil
+      )
       end
 
       sig do
         override.returns(
           {
+            canonical_event_type: String,
+            event_type: String,
             occurred_at: Time,
             type: Telnyx::EmailEventType::TaggedSymbol,
             payload: T::Hash[Symbol, T.anything]

data/rbi/telnyx/models/message_retrieve_group_messages_response.rbi

@@ -11,30 +11,24 @@ module Telnyx
           )
         end
 
-      sig do
-        returns(T.nilable(T::Array[Telnyx::MessagingOutboundMessagePayload]))
-      end
+      sig { returns(T.nilable(T::Array[Telnyx::OutboundMessagePayload])) }
       attr_reader :data
 
       sig do
-        params(
-          data: T::Array[Telnyx::MessagingOutboundMessagePayload::OrHash]
-        ).void
+        params(data: T::Array[Telnyx::OutboundMessagePayload::OrHash]).void
       end
       attr_writer :data
 
       sig do
-        params(
-          data: T::Array[Telnyx::MessagingOutboundMessagePayload::OrHash]
-        ).returns(T.attached_class)
+        params(data: T::Array[Telnyx::OutboundMessagePayload::OrHash]).returns(
+          T.attached_class
+        )
       end
       def self.new(data: nil)
       end
 
       sig do
-        override.returns(
-          { data: T::Array[Telnyx::MessagingOutboundMessagePayload] }
-        )
+        override.returns({ data: T::Array[Telnyx::OutboundMessagePayload] })
       end
       def to_hash
       end