sentdm 0.31.0 → 0.33.0

data/rbi/sentdm/models/template.rbi

@@ -18,6 +18,21 @@ module Sentdm
       sig { params(id: String).void }
       attr_writer :id
 
+      # Which consent keyword this template answers, when it is one of Sent's
+      # auto-replies: OPT_IN, OPT_OUT, HELP, or OTHER for a customer-defined keyword.
+      # Null for an ordinary template, and omitted from the response, so its presence is
+      # the answer to "is this an auto-reply".
+      #
+      # Deliberately not required, unlike CustomerId, even though the same "no single
+      # mapper" argument applies: NJsonSchema publishes a C# required member in the
+      # schema's required array, so the contract would have advertised a field this
+      # response omits for every ordinary template, and a generated client could refuse
+      # the common case. A compile-time guard is not worth a wrong published contract.
+      # Every mapping site sets it explicitly, and TemplateResponseSchemaTests pins the
+      # field as optional so it cannot be reintroduced.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :auto_reply_action
+
       # Template category: MARKETING, UTILITY, AUTHENTICATION
       sig { returns(T.nilable(String)) }
       attr_reader :category
@@ -25,7 +40,18 @@ module Sentdm
       sig { params(category: String).void }
       attr_writer :category
 
-      # Supported channels: sms, whatsapp
+      # The channels this template's definition can render on, in canonical order: sms,
+      # whatsapp, rcs.
+      #
+      # Derived from the definition's body, mirroring each channel's send-time fallback
+      # chain, so a channel is listed only when a real body would be produced for it:
+      # SMS reads sms ?? multiChannel, WhatsApp reads whatsapp ?? multiChannel, and RCS
+      # reads rcs ?? multiChannel ?? sms. A multiChannel body therefore reports all
+      # three, and the extra SMS fallback on RCS is why an sms/whatsapp pair reports RCS
+      # too.
+      #
+      # This says what the content can render on, not what may be sent: sending also
+      # needs the template approved for that channel.
       sig { returns(T.nilable(T::Array[String])) }
       attr_accessor :channels
 
@@ -57,7 +83,8 @@ module Sentdm
       sig { params(name: String).void }
       attr_writer :name
 
-      # Template status: APPROVED, PENDING, REJECTED
+      # Template status: DRAFT, PENDING, APPROVED, REJECTED. A template created with
+      # submit_for_review: false starts as DRAFT and stays there until it is submitted.
       sig { returns(T.nilable(String)) }
       attr_reader :status
 
@@ -77,6 +104,7 @@ module Sentdm
         params(
           customer_id: String,
           id: String,
+          auto_reply_action: T.nilable(String),
           category: String,
           channels: T.nilable(T::Array[String]),
           created_at: Time,
@@ -94,9 +122,33 @@ module Sentdm
         customer_id:,
         # Unique template identifier
         id: nil,
+        # Which consent keyword this template answers, when it is one of Sent's
+        # auto-replies: OPT_IN, OPT_OUT, HELP, or OTHER for a customer-defined keyword.
+        # Null for an ordinary template, and omitted from the response, so its presence is
+        # the answer to "is this an auto-reply".
+        #
+        # Deliberately not required, unlike CustomerId, even though the same "no single
+        # mapper" argument applies: NJsonSchema publishes a C# required member in the
+        # schema's required array, so the contract would have advertised a field this
+        # response omits for every ordinary template, and a generated client could refuse
+        # the common case. A compile-time guard is not worth a wrong published contract.
+        # Every mapping site sets it explicitly, and TemplateResponseSchemaTests pins the
+        # field as optional so it cannot be reintroduced.
+        auto_reply_action: nil,
         # Template category: MARKETING, UTILITY, AUTHENTICATION
         category: nil,
-        # Supported channels: sms, whatsapp
+        # The channels this template's definition can render on, in canonical order: sms,
+        # whatsapp, rcs.
+        #
+        # Derived from the definition's body, mirroring each channel's send-time fallback
+        # chain, so a channel is listed only when a real body would be produced for it:
+        # SMS reads sms ?? multiChannel, WhatsApp reads whatsapp ?? multiChannel, and RCS
+        # reads rcs ?? multiChannel ?? sms. A multiChannel body therefore reports all
+        # three, and the extra SMS fallback on RCS is why an sms/whatsapp pair reports RCS
+        # too.
+        #
+        # This says what the content can render on, not what may be sent: sending also
+        # needs the template approved for that channel.
         channels: nil,
         # When the template was created
         created_at: nil,
@@ -106,7 +158,8 @@ module Sentdm
         language: nil,
         # Template display name
         name: nil,
-        # Template status: APPROVED, PENDING, REJECTED
+        # Template status: DRAFT, PENDING, APPROVED, REJECTED. A template created with
+        # submit_for_review: false starts as DRAFT and stays there until it is submitted.
         status: nil,
         # When the template was last updated
         updated_at: nil,
@@ -120,6 +173,7 @@ module Sentdm
           {
             customer_id: String,
             id: String,
+            auto_reply_action: T.nilable(String),
             category: String,
             channels: T.nilable(T::Array[String]),
             created_at: Time,

data/rbi/sentdm/models/template_body.rbi

@@ -6,8 +6,20 @@ module Sentdm
       OrHash =
         T.type_alias { T.any(Sentdm::TemplateBody, Sentdm::Internal::AnyHash) }
 
-      # Content that will be used for all channels (SMS and WhatsApp) unless
-      # channel-specific content is provided
+      # MMS-specific content — subject, text and attachments.
+      #
+      # Like Rcs, an override that cannot stand on its own: a template still needs a
+      # MultiChannel body or the Sms + Whatsapp pair to be deliverable at all. Unlike
+      # Rcs, it has no fallback at send time — MMS with no media is a more expensive
+      # SMS, so a template without this slot is deliberately not MMS-capable and never
+      # produces an MMS route candidate.
+      sig { returns(T.nilable(Sentdm::TemplateBody::Mms)) }
+      attr_reader :mms
+
+      sig { params(mms: T.nilable(Sentdm::TemplateBody::Mms::OrHash)).void }
+      attr_writer :mms
+
+      # The shared body, used for every channel. One half of the choice described above.
       sig { returns(T.nilable(Sentdm::TemplateBodyContent)) }
       attr_reader :multi_channel
 
@@ -18,22 +30,23 @@ module Sentdm
       end
       attr_writer :multi_channel
 
-      # RCS-specific content that overrides multi-channel content for RCS messages
+      # RCS-specific copy that overrides the chosen strategy for RCS only. The one true
+      # override: optional on top of either strategy, but it cannot be the only body
+      # present. Its length cap is the higher one described on Template.
       sig { returns(T.nilable(Sentdm::TemplateBodyContent)) }
       attr_reader :rcs
 
       sig { params(rcs: T.nilable(Sentdm::TemplateBodyContent::OrHash)).void }
       attr_writer :rcs
 
-      # SMS-specific content that overrides multi-channel content for SMS messages
+      # The SMS body. It does not override multiChannel, it replaces it.
       sig { returns(T.nilable(Sentdm::TemplateBodyContent)) }
       attr_reader :sms
 
       sig { params(sms: T.nilable(Sentdm::TemplateBodyContent::OrHash)).void }
       attr_writer :sms
 
-      # WhatsApp-specific content that overrides multi-channel content for WhatsApp
-      # messages
+      # The WhatsApp body. It does not override multiChannel, it replaces it.
       sig { returns(T.nilable(Sentdm::TemplateBodyContent)) }
       attr_reader :whatsapp
 
@@ -42,9 +55,19 @@ module Sentdm
       end
       attr_writer :whatsapp
 
-      # Body section of a message template with channel-specific content
+      # Body section of a message template.
+      #
+      # A body picks one of two authoring strategies, and mixing them is refused
+      # (TemplateDefinitionValidator.HaveValidChannelConfiguration): a shared
+      # multiChannel body on its own, or an explicit sms + whatsapp pair, both present.
+      #
+      # multiChannel together with sms or whatsapp is rejected, and so is sms or
+      # whatsapp on its own — every template is expected to be deliverable on every
+      # channel. rcs is the one true override: it may accompany either strategy to vary
+      # the copy, but cannot stand alone.
       sig do
         params(
+          mms: T.nilable(Sentdm::TemplateBody::Mms::OrHash),
           multi_channel: T.nilable(Sentdm::TemplateBodyContent::OrHash),
           rcs: T.nilable(Sentdm::TemplateBodyContent::OrHash),
           sms: T.nilable(Sentdm::TemplateBodyContent::OrHash),
@@ -52,15 +75,23 @@ module Sentdm
         ).returns(T.attached_class)
       end
       def self.new(
-        # Content that will be used for all channels (SMS and WhatsApp) unless
-        # channel-specific content is provided
+        # MMS-specific content — subject, text and attachments.
+        #
+        # Like Rcs, an override that cannot stand on its own: a template still needs a
+        # MultiChannel body or the Sms + Whatsapp pair to be deliverable at all. Unlike
+        # Rcs, it has no fallback at send time — MMS with no media is a more expensive
+        # SMS, so a template without this slot is deliberately not MMS-capable and never
+        # produces an MMS route candidate.
+        mms: nil,
+        # The shared body, used for every channel. One half of the choice described above.
         multi_channel: nil,
-        # RCS-specific content that overrides multi-channel content for RCS messages
+        # RCS-specific copy that overrides the chosen strategy for RCS only. The one true
+        # override: optional on top of either strategy, but it cannot be the only body
+        # present. Its length cap is the higher one described on Template.
         rcs: nil,
-        # SMS-specific content that overrides multi-channel content for SMS messages
+        # The SMS body. It does not override multiChannel, it replaces it.
         sms: nil,
-        # WhatsApp-specific content that overrides multi-channel content for WhatsApp
-        # messages
+        # The WhatsApp body. It does not override multiChannel, it replaces it.
         whatsapp: nil
       )
       end
@@ -68,6 +99,7 @@ module Sentdm
       sig do
         override.returns(
           {
+            mms: T.nilable(Sentdm::TemplateBody::Mms),
             multi_channel: T.nilable(Sentdm::TemplateBodyContent),
             rcs: T.nilable(Sentdm::TemplateBodyContent),
             sms: T.nilable(Sentdm::TemplateBodyContent),
@@ -77,6 +109,116 @@ module Sentdm
       end
       def to_hash
       end
+
+      class Mms < Sentdm::Models::TemplateBodyContent
+        OrHash =
+          T.type_alias do
+            T.any(Sentdm::TemplateBody::Mms, Sentdm::Internal::AnyHash)
+          end
+
+        # Attachments carried by every send on this template, in order. A per-send
+        # media_urls on the request replaces this list rather than adding to it, so a
+        # template can hold a default creative and a caller can still send something
+        # recipient-specific.
+        sig { returns(T.nilable(T::Array[Sentdm::TemplateBody::Mms::Media])) }
+        attr_accessor :media
+
+        # MMS subject line. Optional — most handsets render it above the body, some ignore
+        # it entirely. Deliberately its own field rather than riding TemplateHeader: the
+        # header is authored once and shared across every channel, and carries Meta's
+        # 60-character cap plus its no-newline, no-emoji text rules, none of which
+        # describe an MMS subject.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :subject
+
+        # MMS-specific content — subject, text and attachments.
+        #
+        # Like Rcs, an override that cannot stand on its own: a template still needs a
+        # MultiChannel body or the Sms + Whatsapp pair to be deliverable at all. Unlike
+        # Rcs, it has no fallback at send time — MMS with no media is a more expensive
+        # SMS, so a template without this slot is deliberately not MMS-capable and never
+        # produces an MMS route candidate.
+        sig do
+          params(
+            media:
+              T.nilable(T::Array[Sentdm::TemplateBody::Mms::Media::OrHash]),
+            subject: T.nilable(String)
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Attachments carried by every send on this template, in order. A per-send
+          # media_urls on the request replaces this list rather than adding to it, so a
+          # template can hold a default creative and a caller can still send something
+          # recipient-specific.
+          media: nil,
+          # MMS subject line. Optional — most handsets render it above the body, some ignore
+          # it entirely. Deliberately its own field rather than riding TemplateHeader: the
+          # header is authored once and shared across every channel, and carries Meta's
+          # 60-character cap plus its no-newline, no-emoji text rules, none of which
+          # describe an MMS subject.
+          subject: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              media: T.nilable(T::Array[Sentdm::TemplateBody::Mms::Media]),
+              subject: T.nilable(String)
+            }
+          )
+        end
+        def to_hash
+        end
+
+        class Media < Sentdm::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(Sentdm::TemplateBody::Mms::Media, Sentdm::Internal::AnyHash)
+            end
+
+          # One of MmsMediaTypes. Advisory: the carrier reads the Content-Type off the
+          # fetched object, not this field. It exists so an authoring UI can render the
+          # right preview and so a reviewer can see what was intended.
+          sig { returns(T.nilable(String)) }
+          attr_accessor :media_type
+
+          # Publicly fetchable https URL. The carrier's MMSC fetches this at send time, so
+          # it has to stay reachable and unauthenticated for the life of the send —
+          # including retries and a DLQ replay — which is why a presigned URL is not a valid
+          # value here.
+          sig { returns(T.nilable(String)) }
+          attr_reader :url
+
+          sig { params(url: String).void }
+          attr_writer :url
+
+          # One attachment on an MMS template body.
+          sig do
+            params(media_type: T.nilable(String), url: String).returns(
+              T.attached_class
+            )
+          end
+          def self.new(
+            # One of MmsMediaTypes. Advisory: the carrier reads the Content-Type off the
+            # fetched object, not this field. It exists so an authoring UI can render the
+            # right preview and so a reviewer can see what was intended.
+            media_type: nil,
+            # Publicly fetchable https URL. The carrier's MMSC fetches this at send time, so
+            # it has to stay reachable and unauthenticated for the life of the send —
+            # including retries and a DLQ replay — which is why a presigned URL is not a valid
+            # value here.
+            url: nil
+          )
+          end
+
+          sig do
+            override.returns({ media_type: T.nilable(String), url: String })
+          end
+          def to_hash
+          end
+        end
+      end
     end
   end
 end

data/rbi/sentdm/models/template_body_content.rbi

@@ -8,12 +8,39 @@ module Sentdm
           T.any(Sentdm::TemplateBodyContent, Sentdm::Internal::AnyHash)
         end
 
+      # The body copy, with variables written as {{index:variable}}.
+      #
+      # Length cap depends on which channel this body belongs to:
+      # TemplateContentLimits.MaxBodyLength (1024) for multiChannel, sms and whatsapp —
+      # Meta's BODY limit, which a multiChannel body may be delivered under — and
+      # TemplateContentLimits.MaxRcsBodyLength (3072) for an rcs body, which never
+      # reaches Meta. The maxLength advertised on this schema is the 1024 one, because
+      # all four channel bodies share this single schema — an rcs body between the two
+      # is accepted.
+      #
+      # Meta requires every variable to carry surrounding context, so a body is refused
+      # unless it also satisfies all of the following (enforced by
+      # TemplateDefinitionValidator): At least one letter before the first variable and
+      # after the last — trailing punctuation such as "... {{1:variable}}." does not
+      # count. At least (2 × variable count) + 1 words once the placeholders are
+      # removed. No two variables adjacent with only whitespace between them. No leading
+      # or trailing newline, no more than two consecutive line breaks, and no more than
+      # four consecutive spaces.
+      #
+      # Example: "Hello {{0:variable}}! Welcome to {{1:variable}}. We are glad to have
+      # you on board." — two variables, so at least five words are required, and the
+      # copy after the final variable contains letters.
       sig { returns(String) }
       attr_accessor :template
 
+      # The type of body content — send "text". It is dropped from the stored definition
+      # when null, so a body posted without it is saved with no type key at all and the
+      # template editor has nothing to render the block from.
       sig { returns(T.nilable(String)) }
       attr_accessor :type
 
+      # The variables referenced by the body copy, one entry per {{index:variable}}
+      # placeholder.
       sig { returns(T.nilable(T::Array[Sentdm::TemplateVariable])) }
       attr_accessor :variables
 
@@ -24,7 +51,38 @@ module Sentdm
           variables: T.nilable(T::Array[Sentdm::TemplateVariable::OrHash])
         ).returns(T.attached_class)
       end
-      def self.new(template:, type: nil, variables: nil)
+      def self.new(
+        # The body copy, with variables written as {{index:variable}}.
+        #
+        # Length cap depends on which channel this body belongs to:
+        # TemplateContentLimits.MaxBodyLength (1024) for multiChannel, sms and whatsapp —
+        # Meta's BODY limit, which a multiChannel body may be delivered under — and
+        # TemplateContentLimits.MaxRcsBodyLength (3072) for an rcs body, which never
+        # reaches Meta. The maxLength advertised on this schema is the 1024 one, because
+        # all four channel bodies share this single schema — an rcs body between the two
+        # is accepted.
+        #
+        # Meta requires every variable to carry surrounding context, so a body is refused
+        # unless it also satisfies all of the following (enforced by
+        # TemplateDefinitionValidator): At least one letter before the first variable and
+        # after the last — trailing punctuation such as "... {{1:variable}}." does not
+        # count. At least (2 × variable count) + 1 words once the placeholders are
+        # removed. No two variables adjacent with only whitespace between them. No leading
+        # or trailing newline, no more than two consecutive line breaks, and no more than
+        # four consecutive spaces.
+        #
+        # Example: "Hello {{0:variable}}! Welcome to {{1:variable}}. We are glad to have
+        # you on board." — two variables, so at least five words are required, and the
+        # copy after the final variable contains letters.
+        template:,
+        # The type of body content — send "text". It is dropped from the stored definition
+        # when null, so a body posted without it is saved with no type key at all and the
+        # template editor has nothing to render the block from.
+        type: nil,
+        # The variables referenced by the body copy, one entry per {{index:variable}}
+        # placeholder.
+        variables: nil
+      )
       end
 
       sig do

data/rbi/sentdm/models/template_button.rbi

@@ -19,7 +19,13 @@ module Sentdm
       sig { returns(String) }
       attr_accessor :type
 
-      # The unique identifier of the button (1-based index)
+      # The button's identifier (1-based index), unique within the template.
+      #
+      # Omitting it is only safe for a template holding a single button. The field is a
+      # non-nullable int, so every button that leaves it out defaults to 0, and two such
+      # buttons are refused by the unique-id rule ("Button IDs must be unique"). Number
+      # them from 1 in the order they should appear — order matters on RCS, where only
+      # the first four buttons render.
       sig { returns(T.nilable(Integer)) }
       attr_reader :id
 
@@ -39,7 +45,13 @@ module Sentdm
         props:,
         # The type of button (e.g., QUICK_REPLY, URL, PHONE_NUMBER, VOICE_CALL, COPY_CODE)
         type:,
-        # The unique identifier of the button (1-based index)
+        # The button's identifier (1-based index), unique within the template.
+        #
+        # Omitting it is only safe for a template holding a single button. The field is a
+        # non-nullable int, so every button that leaves it out defaults to 0, and two such
+        # buttons are refused by the unique-id rule ("Button IDs must be unique"). Number
+        # them from 1 in the order they should appear — order matters on RCS, where only
+        # the first four buttons render.
         id: nil
       )
       end

data/rbi/sentdm/models/template_button_props.rbi

@@ -23,6 +23,17 @@ module Sentdm
       sig { returns(String) }
       attr_accessor :quick_reply_type
 
+      # The button's label. Required for every button type, and capped at
+      # TemplateContentLimits.MaxButtonTextLength (25) characters.
+      #
+      # Meta accepts only static text here, so a label is refused when it contains a
+      # {{...}} variable placeholder, a newline, an emoji, or WhatsApp formatting markup
+      # (\*, \_, ~) — enforced by ApplyButtonLabelContentRules in
+      # TemplateButtonValidator. Meta reports all four as one error: "Buttons can't have
+      # any variables, newlines, emojis, or formatting characters."
+      #
+      # AUTHENTICATION OTP buttons are the exception: Meta auto-localizes their label
+      # from the template language, and the converter drops whatever text was sent.
       sig { returns(String) }
       attr_accessor :text
 
@@ -73,6 +84,17 @@ module Sentdm
         offer_code:,
         phone_number:,
         quick_reply_type:,
+        # The button's label. Required for every button type, and capped at
+        # TemplateContentLimits.MaxButtonTextLength (25) characters.
+        #
+        # Meta accepts only static text here, so a label is refused when it contains a
+        # {{...}} variable placeholder, a newline, an emoji, or WhatsApp formatting markup
+        # (\*, \_, ~) — enforced by ApplyButtonLabelContentRules in
+        # TemplateButtonValidator. Meta reports all four as one error: "Buttons can't have
+        # any variables, newlines, emojis, or formatting characters."
+        #
+        # AUTHENTICATION OTP buttons are the exception: Meta auto-localizes their label
+        # from the template language, and the converter drops whatever text was sent.
         text:,
         url:,
         url_type:,

data/rbi/sentdm/models/template_definition.rbi

@@ -8,7 +8,16 @@ module Sentdm
           T.any(Sentdm::TemplateDefinition, Sentdm::Internal::AnyHash)
         end
 
-      # Body section of a message template with channel-specific content
+      # Body section of a message template.
+      #
+      # A body picks one of two authoring strategies, and mixing them is refused
+      # (TemplateDefinitionValidator.HaveValidChannelConfiguration): a shared
+      # multiChannel body on its own, or an explicit sms + whatsapp pair, both present.
+      #
+      # multiChannel together with sms or whatsapp is rejected, and so is sms or
+      # whatsapp on its own — every template is expected to be deliverable on every
+      # channel. rcs is the one true override: it may accompany either strategy to vary
+      # the copy, but cannot stand alone.
       sig { returns(Sentdm::TemplateBody) }
       attr_reader :body
 
@@ -62,7 +71,16 @@ module Sentdm
         ).returns(T.attached_class)
       end
       def self.new(
-        # Body section of a message template with channel-specific content
+        # Body section of a message template.
+        #
+        # A body picks one of two authoring strategies, and mixing them is refused
+        # (TemplateDefinitionValidator.HaveValidChannelConfiguration): a shared
+        # multiChannel body on its own, or an explicit sms + whatsapp pair, both present.
+        #
+        # multiChannel together with sms or whatsapp is rejected, and so is sms or
+        # whatsapp on its own — every template is expected to be deliverable on every
+        # channel. rcs is the one true override: it may accompany either strategy to vary
+        # the copy, but cannot stand alone.
         body:,
         # Configuration for AUTHENTICATION category templates
         authentication_config: nil,

data/rbi/sentdm/models/template_event.rbi

@@ -6,14 +6,14 @@ module Sentdm
       OrHash =
         T.type_alias { T.any(Sentdm::TemplateEvent, Sentdm::Internal::AnyHash) }
 
-      # The specific event within the family, for example message.delivered or
-      # message.received. Absent on events that have no subtype, so treat it as
-      # optional.
+      # The specific event within the family, for example message.delivered,
+      # message.received or contact.opt_out. Absent on events that have no subtype, so
+      # treat it as optional.
       sig { returns(T.nilable(String)) }
       attr_accessor :event
 
-      # The event family, for example message or templates. Route on this first, then on
-      # event for the specific change.
+      # The event family, for example message, templates or contact. Route on this
+      # first, then on event for the specific change.
       sig { returns(T.nilable(String)) }
       attr_reader :field
 
@@ -30,6 +30,10 @@ module Sentdm
       end
       attr_writer :payload
 
+      # The event-specific body.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :request_id
+
       # When Sent emitted the event, in UTC (yyyy-MM-ddTHH:mm:ssZ). This is the emission
       # time, not the time the underlying change happened. Use the timestamp inside the
       # payload for the latter.
@@ -46,20 +50,23 @@ module Sentdm
           event: T.nilable(String),
           field: String,
           payload: T.nilable(Sentdm::TemplateEventPayload::OrHash),
+          request_id: T.nilable(String),
           timestamp: String
         ).returns(T.attached_class)
       end
       def self.new(
-        # The specific event within the family, for example message.delivered or
-        # message.received. Absent on events that have no subtype, so treat it as
-        # optional.
+        # The specific event within the family, for example message.delivered,
+        # message.received or contact.opt_out. Absent on events that have no subtype, so
+        # treat it as optional.
         event: nil,
-        # The event family, for example message or templates. Route on this first, then on
-        # event for the specific change.
+        # The event family, for example message, templates or contact. Route on this
+        # first, then on event for the specific change.
         field: nil,
         # Body of a template status event. Delivered when a template's review outcome
         # changes, so you can react without polling.
         payload: nil,
+        # The event-specific body.
+        request_id: nil,
         # When Sent emitted the event, in UTC (yyyy-MM-ddTHH:mm:ssZ). This is the emission
         # time, not the time the underlying change happened. Use the timestamp inside the
         # payload for the latter.
@@ -73,6 +80,7 @@ module Sentdm
             event: T.nilable(String),
             field: String,
             payload: T.nilable(Sentdm::TemplateEventPayload),
+            request_id: T.nilable(String),
             timestamp: String
           }
         )