sentdm 0.31.0 → 0.33.0

data/lib/sentdm/models/message_send_params.rb

@@ -15,6 +15,25 @@ module Sentdm
       #   @return [Array<String>, nil]
       optional :channel, Sentdm::Internal::Type::ArrayOf[String], nil?: true
 
+      # @!attribute media_urls
+      #   Attachments for this send, as publicly fetchable https URLs. Used by the MMS
+      #   channel and ignored by every other one.
+      #
+      #   Supplying these replaces the media on the template's mms body rather than adding
+      #   to it, so a template can hold a default creative while a caller still sends
+      #   something recipient-specific.
+      #
+      #   Their presence is also what makes a message eligible for MMS on an auto-detect
+      #   send: a message with nothing attached is delivered as SMS, because an MMS with
+      #   no media is a more expensive text message.
+      #
+      #   The recipient's carrier fetches each URL after the send is accepted, so it must
+      #   stay publicly reachable — a link that expires, or one behind auth, arrives as a
+      #   failed message.
+      #
+      #   @return [Array<String>, nil]
+      optional :media_urls, Sentdm::Internal::Type::ArrayOf[String], nil?: true
+
       # @!attribute sandbox
       #   Sandbox flag - when true, the operation is simulated without side effects Useful
       #   for testing integrations without actual execution
@@ -22,6 +41,29 @@ module Sentdm
       #   @return [Boolean, nil]
       optional :sandbox, Sentdm::Internal::Type::Boolean
 
+      # @!attribute scheduled_at
+      #   Optional future send time as an ISO-8601 timestamp with an explicit UTC offset,
+      #   e.g. 2026-10-01T09:00:00+02:00 or 2026-10-01T07:00:00Z. A value without an
+      #   offset is rejected (400) rather than read in the server's zone. The offset only
+      #   fixes the instant: it is stored and echoed in UTC as scheduled_at. Omit to send
+      #   now. Must be at least one minute ahead and at most 30 days ahead. Accepted
+      #   messages report SCHEDULED and are released for delivery at this time. Quiet
+      #   hours, balance and template approval are evaluated at release, not at
+      #   acceptance: a message whose time falls inside a recipient's protected
+      #   quiet-hours window is moved to the next allowed time and a second
+      #   message.scheduled webhook reports the new scheduled_at.
+      #
+      #   @return [Time, nil]
+      optional :scheduled_at, Time, nil?: true
+
+      # @!attribute subject
+      #   Subject line for this send, overriding the template's. MMS only; ignored on
+      #   every other channel. Most handsets render it above the body, some ignore it
+      #   entirely.
+      #
+      #   @return [String, nil]
+      optional :subject, String, nil?: true
+
       # @!attribute template
       #   SDK-style template reference: resolve by ID or by name, with optional
       #   parameters.
@@ -51,14 +93,20 @@ module Sentdm
       #   @return [String, nil]
       optional :x_profile_id, String
 
-      # @!method initialize(channel: nil, sandbox: nil, template: nil, text: nil, to: nil, idempotency_key: nil, x_profile_id: nil, request_options: {})
+      # @!method initialize(channel: nil, media_urls: nil, sandbox: nil, scheduled_at: nil, subject: nil, template: nil, text: nil, to: nil, idempotency_key: nil, x_profile_id: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {Sentdm::Models::MessageSendParams} for more details.
       #
       #   @param channel [Array<String>, nil] Channels to broadcast on, e.g. ["whatsapp", "sms"].
       #
+      #   @param media_urls [Array<String>, nil] Attachments for this send, as publicly fetchable https URLs. Used by the MMS cha
+      #
       #   @param sandbox [Boolean] Sandbox flag - when true, the operation is simulated without side effects
       #
+      #   @param scheduled_at [Time, nil] Optional future send time as an ISO-8601 timestamp with an explicit UTC offset,
+      #
+      #   @param subject [String, nil] Subject line for this send, overriding the template's. MMS only; ignored on ever
+      #
       #   @param template [Sentdm::Models::MessageSendParams::Template, nil] SDK-style template reference: resolve by ID or by name, with optional parameters
       #
       #   @param text [String, nil] Plain-text (free-form) message body. Provide either Template or this.
@@ -85,12 +133,28 @@ module Sentdm
         optional :name, String, nil?: true
 
         # @!attribute parameters
-        #   Template variable parameters for personalization
+        #   Template variable parameters for personalization, keyed by variable name.
+        #
+        #   Every variable the template declares is required; GET /v3/templates/{id} lists
+        #   them. Supplying a key the template does not declare is ignored.
+        #
+        #   Media headers. A template whose header is an image (designed in WhatsApp Manager
+        #   and imported into Sent) declares a reserved header_image key. Its value is a
+        #   publicly reachable https URL that Meta fetches at send time — Sent does not host
+        #   the asset, and the sample approved with the template is not reused. The key is
+        #   derived from the header's media type, so header_video and header_document follow
+        #   the same shape when those formats ship.
+        #
+        #   "parameters": { "header_image": "https://cdn.example.com/banner.jpg", "name":
+        #   "John Doe" }
         #
         #   @return [Hash{Symbol=>String}, nil]
         optional :parameters, Sentdm::Internal::Type::HashOf[String], nil?: true
 
         # @!method initialize(id: nil, name: nil, parameters: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Sentdm::Models::MessageSendParams::Template} for more details.
+        #
         #   SDK-style template reference: resolve by ID or by name, with optional
         #   parameters.
         #
@@ -98,7 +162,7 @@ module Sentdm
         #
         #   @param name [String, nil] Template name (mutually exclusive with id)
         #
-        #   @param parameters [Hash{Symbol=>String}, nil] Template variable parameters for personalization
+        #   @param parameters [Hash{Symbol=>String}, nil] Template variable parameters for personalization, keyed by variable name.
       end
     end
   end

data/lib/sentdm/models/message_send_response.rb

@@ -14,7 +14,9 @@ module Sentdm
       #   its result; this is what a caller sees, and the mapping between them is a
       #   decision the endpoint makes.
       #
-      #   The wire is unchanged by the move: same names, same values.
+      #   The shape of an immediate send: it never has a scheduled_at key. A send that
+      #   carried scheduled_at is a ScheduledSendMessageResponse, and the endpoint decides
+      #   which of the two to answer with. From always returns this type.
       #
       #   @return [Sentdm::Models::MessageSendResponse::Data, nil]
       optional :data, -> { Sentdm::Models::MessageSendResponse::Data }, nil?: true
@@ -60,7 +62,9 @@ module Sentdm
                  -> { Sentdm::Internal::Type::ArrayOf[Sentdm::Models::MessageSendResponse::Data::Recipient] }
 
         # @!attribute status
-        #   Overall status — QUEUED once the batch is accepted for delivery.
+        #   QUEUED: the batch is accepted. A request that carried scheduled_at is QUEUED
+        #   here too; each message moves to SCHEDULED once it is held, as GET
+        #   /v3/messages/{id} and the message.scheduled webhook report.
         #
         #   @return [String, nil]
         optional :status, String
@@ -76,6 +80,9 @@ module Sentdm
         optional :template_name, String
 
         # @!method initialize(recipients: nil, status: nil, template_id: nil, template_name: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Sentdm::Models::MessageSendResponse::Data} for more details.
+        #
         #   The result of a multi-recipient send.
         #
         #   Declared here rather than in the service layer. POST /v3/messages used to
@@ -85,11 +92,13 @@ module Sentdm
         #   its result; this is what a caller sees, and the mapping between them is a
         #   decision the endpoint makes.
         #
-        #   The wire is unchanged by the move: same names, same values.
+        #   The shape of an immediate send: it never has a scheduled_at key. A send that
+        #   carried scheduled_at is a ScheduledSendMessageResponse, and the endpoint decides
+        #   which of the two to answer with. From always returns this type.
         #
         #   @param recipients [Array<Sentdm::Models::MessageSendResponse::Data::Recipient>]
         #
-        #   @param status [String] Overall status — QUEUED once the batch is accepted for delivery.
+        #   @param status [String] QUEUED: the batch is accepted. A request that carried scheduled_at is QUEUED
         #
         #   @param template_id [String]
         #

data/lib/sentdm/models/template.rb

@@ -17,6 +17,23 @@ module Sentdm
       #   @return [String, nil]
       optional :id, String
 
+      # @!attribute auto_reply_action
+      #   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.
+      #
+      #   @return [String, nil]
+      optional :auto_reply_action, String, nil?: true
+
       # @!attribute category
       #   Template category: MARKETING, UTILITY, AUTHENTICATION
       #
@@ -24,7 +41,18 @@ module Sentdm
       optional :category, String
 
       # @!attribute channels
-      #   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.
       #
       #   @return [Array<String>, nil]
       optional :channels, Sentdm::Internal::Type::ArrayOf[String], nil?: true
@@ -54,7 +82,8 @@ module Sentdm
       optional :name, String
 
       # @!attribute status
-      #   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.
       #
       #   @return [String, nil]
       optional :status, String
@@ -71,7 +100,7 @@ module Sentdm
       #   @return [Array<String>, nil]
       optional :variables, Sentdm::Internal::Type::ArrayOf[String], nil?: true
 
-      # @!method initialize(customer_id:, id: nil, category: nil, channels: nil, created_at: nil, is_published: nil, language: nil, name: nil, status: nil, updated_at: nil, variables: nil)
+      # @!method initialize(customer_id:, id: nil, auto_reply_action: nil, category: nil, channels: nil, created_at: nil, is_published: nil, language: nil, name: nil, status: nil, updated_at: nil, variables: nil)
       #   Some parameter documentations has been truncated, see {Sentdm::Models::Template}
       #   for more details.
       #
@@ -81,9 +110,11 @@ module Sentdm
       #
       #   @param id [String] Unique template identifier
       #
+      #   @param auto_reply_action [String, nil] Which consent keyword this template answers, when it is one of Sent's auto-repli
+      #
       #   @param category [String] Template category: MARKETING, UTILITY, AUTHENTICATION
       #
-      #   @param channels [Array<String>, nil] Supported channels: sms, whatsapp
+      #   @param channels [Array<String>, nil] The channels this template's definition can render on, in canonical order: sms,
       #
       #   @param created_at [Time] When the template was created
       #
@@ -93,7 +124,7 @@ module Sentdm
       #
       #   @param name [String] Template display name
       #
-      #   @param status [String] Template status: APPROVED, PENDING, REJECTED
+      #   @param status [String] Template status: DRAFT, PENDING, APPROVED, REJECTED. A template created with
       #
       #   @param updated_at [Time, nil] When the template was last updated
       #

data/lib/sentdm/models/template_body.rb

@@ -3,45 +3,135 @@
 module Sentdm
   module Models
     class TemplateBody < Sentdm::Internal::Type::BaseModel
+      # @!attribute mms
+      #   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.
+      #
+      #   @return [Sentdm::Models::TemplateBody::Mms, nil]
+      optional :mms, -> { Sentdm::TemplateBody::Mms }, nil?: true
+
       # @!attribute multi_channel
-      #   Content that will be used for all channels (SMS and WhatsApp) unless
-      #   channel-specific content is provided
+      #   The shared body, used for every channel. One half of the choice described above.
       #
       #   @return [Sentdm::Models::TemplateBodyContent, nil]
       optional :multi_channel, -> { Sentdm::TemplateBodyContent }, api_name: :multiChannel, nil?: true
 
       # @!attribute rcs
-      #   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.
       #
       #   @return [Sentdm::Models::TemplateBodyContent, nil]
       optional :rcs, -> { Sentdm::TemplateBodyContent }, nil?: true
 
       # @!attribute sms
-      #   SMS-specific content that overrides multi-channel content for SMS messages
+      #   The SMS body. It does not override multiChannel, it replaces it.
       #
       #   @return [Sentdm::Models::TemplateBodyContent, nil]
       optional :sms, -> { Sentdm::TemplateBodyContent }, nil?: true
 
       # @!attribute whatsapp
-      #   WhatsApp-specific content that overrides multi-channel content for WhatsApp
-      #   messages
+      #   The WhatsApp body. It does not override multiChannel, it replaces it.
       #
       #   @return [Sentdm::Models::TemplateBodyContent, nil]
       optional :whatsapp, -> { Sentdm::TemplateBodyContent }, nil?: true
 
-      # @!method initialize(multi_channel: nil, rcs: nil, sms: nil, whatsapp: nil)
+      # @!method initialize(mms: nil, multi_channel: nil, rcs: nil, sms: nil, whatsapp: nil)
       #   Some parameter documentations has been truncated, see
       #   {Sentdm::Models::TemplateBody} for more details.
       #
-      #   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.
+      #
+      #   @param mms [Sentdm::Models::TemplateBody::Mms, nil] MMS-specific content — subject, text and attachments.
       #
-      #   @param multi_channel [Sentdm::Models::TemplateBodyContent, nil] Content that will be used for all channels (SMS and WhatsApp) unless channel-spe
+      #   @param multi_channel [Sentdm::Models::TemplateBodyContent, nil] The shared body, used for every channel. One half of the choice described above.
       #
-      #   @param rcs [Sentdm::Models::TemplateBodyContent, nil] RCS-specific content that overrides multi-channel content for RCS messages
+      #   @param rcs [Sentdm::Models::TemplateBodyContent, nil] RCS-specific copy that overrides the chosen strategy for RCS only. The one true
       #
-      #   @param sms [Sentdm::Models::TemplateBodyContent, nil] SMS-specific content that overrides multi-channel content for SMS messages
+      #   @param sms [Sentdm::Models::TemplateBodyContent, nil] The SMS body. It does not override multiChannel, it replaces it.
       #
-      #   @param whatsapp [Sentdm::Models::TemplateBodyContent, nil] WhatsApp-specific content that overrides multi-channel content for WhatsApp mess
+      #   @param whatsapp [Sentdm::Models::TemplateBodyContent, nil] The WhatsApp body. It does not override multiChannel, it replaces it.
+
+      # @see Sentdm::Models::TemplateBody#mms
+      class Mms < Sentdm::Models::TemplateBodyContent
+        # @!attribute media
+        #   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.
+        #
+        #   @return [Array<Sentdm::Models::TemplateBody::Mms::Media>, nil]
+        optional :media, -> { Sentdm::Internal::Type::ArrayOf[Sentdm::TemplateBody::Mms::Media] }, nil?: true
+
+        # @!attribute subject
+        #   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.
+        #
+        #   @return [String, nil]
+        optional :subject, String, nil?: true
+
+        # @!method initialize(media: nil, subject: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Sentdm::Models::TemplateBody::Mms} for more details.
+        #
+        #   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.
+        #
+        #   @param media [Array<Sentdm::Models::TemplateBody::Mms::Media>, nil] Attachments carried by every send on this template, in order. A per-send media_u
+        #
+        #   @param subject [String, nil] MMS subject line. Optional — most handsets render it above the body, some ignore
+
+        class Media < Sentdm::Internal::Type::BaseModel
+          # @!attribute media_type
+          #   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.
+          #
+          #   @return [String, nil]
+          optional :media_type, String, api_name: :mediaType, nil?: true
+
+          # @!attribute url
+          #   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.
+          #
+          #   @return [String, nil]
+          optional :url, String
+
+          # @!method initialize(media_type: nil, url: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {Sentdm::Models::TemplateBody::Mms::Media} for more details.
+          #
+          #   One attachment on an MMS template body.
+          #
+          #   @param media_type [String, nil] One of MmsMediaTypes. Advisory: the carrier reads the Content-Type off the
+          #
+          #   @param url [String] Publicly fetchable https URL. The carrier's MMSC fetches this at send time, so i
+        end
+      end
     end
   end
 end

data/lib/sentdm/models/template_body_content.rb

@@ -4,24 +4,56 @@ module Sentdm
   module Models
     class TemplateBodyContent < Sentdm::Internal::Type::BaseModel
       # @!attribute template
+      #   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.
       #
       #   @return [String]
       required :template, String
 
       # @!attribute type
+      #   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.
       #
       #   @return [String, nil]
       optional :type, String, nil?: true
 
       # @!attribute variables
+      #   The variables referenced by the body copy, one entry per {{index:variable}}
+      #   placeholder.
       #
       #   @return [Array<Sentdm::Models::TemplateVariable>, nil]
       optional :variables, -> { Sentdm::Internal::Type::ArrayOf[Sentdm::TemplateVariable] }, nil?: true
 
       # @!method initialize(template:, type: nil, variables: nil)
-      #   @param template [String]
-      #   @param type [String, nil]
-      #   @param variables [Array<Sentdm::Models::TemplateVariable>, nil]
+      #   Some parameter documentations has been truncated, see
+      #   {Sentdm::Models::TemplateBodyContent} for more details.
+      #
+      #   @param template [String] The body copy, with variables written as {{index:variable}}.
+      #
+      #   @param type [String, nil] The type of body content — send "text". It is dropped from the stored definition
+      #
+      #   @param variables [Array<Sentdm::Models::TemplateVariable>, nil] The variables referenced by the body copy, one entry per {{index:variable}} plac
     end
   end
 end

data/lib/sentdm/models/template_button.rb

@@ -16,7 +16,13 @@ module Sentdm
       required :type, String
 
       # @!attribute id
-      #   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.
       #
       #   @return [Integer, nil]
       optional :id, Integer
@@ -31,7 +37,7 @@ module Sentdm
       #
       #   @param type [String] The type of button (e.g., QUICK_REPLY, URL, PHONE_NUMBER, VOICE_CALL, COPY_CODE)
       #
-      #   @param id [Integer] The unique identifier of the button (1-based index)
+      #   @param id [Integer] The button's identifier (1-based index), unique within the template.
     end
   end
 end

data/lib/sentdm/models/template_button_props.rb

@@ -29,6 +29,17 @@ module Sentdm
       required :quick_reply_type, String, api_name: :quickReplyType
 
       # @!attribute text
+      #   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.
       #
       #   @return [String]
       required :text, String
@@ -85,7 +96,7 @@ module Sentdm
       #
       #   @param quick_reply_type [String]
       #
-      #   @param text [String]
+      #   @param text [String] The button's label. Required for every button type, and capped at
       #
       #   @param url [String]
       #

data/lib/sentdm/models/template_definition.rb

@@ -4,7 +4,16 @@ module Sentdm
   module Models
     class TemplateDefinition < Sentdm::Internal::Type::BaseModel
       # @!attribute body
-      #   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.
       #
       #   @return [Sentdm::Models::TemplateBody]
       required :body, -> { Sentdm::TemplateBody }
@@ -43,10 +52,13 @@ module Sentdm
       optional :header, -> { Sentdm::TemplateHeader }, nil?: true
 
       # @!method initialize(body:, authentication_config: nil, buttons: nil, definition_version: nil, footer: nil, header: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Sentdm::Models::TemplateDefinition} for more details.
+      #
       #   Complete definition of a message template including header, body, footer, and
       #   buttons
       #
-      #   @param body [Sentdm::Models::TemplateBody] Body section of a message template with channel-specific content
+      #   @param body [Sentdm::Models::TemplateBody] Body section of a message template.
       #
       #   @param authentication_config [Sentdm::Models::AuthenticationConfig, nil] Configuration for AUTHENTICATION category templates
       #

data/lib/sentdm/models/template_event.rb

@@ -4,16 +4,16 @@ module Sentdm
   module Models
     class TemplateEvent < Sentdm::Internal::Type::BaseModel
       # @!attribute event
-      #   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.
       #
       #   @return [String, nil]
       optional :event, String, nil?: true
 
       # @!attribute field
-      #   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.
       #
       #   @return [String, nil]
       optional :field, String
@@ -25,6 +25,12 @@ module Sentdm
       #   @return [Sentdm::Models::TemplateEventPayload, nil]
       optional :payload, -> { Sentdm::TemplateEventPayload }, nil?: true
 
+      # @!attribute request_id
+      #   The event-specific body.
+      #
+      #   @return [String, nil]
+      optional :request_id, String, nil?: true
+
       # @!attribute timestamp
       #   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
@@ -33,19 +39,21 @@ module Sentdm
       #   @return [String, nil]
       optional :timestamp, String
 
-      # @!method initialize(event: nil, field: nil, payload: nil, timestamp: nil)
+      # @!method initialize(event: nil, field: nil, payload: nil, request_id: nil, timestamp: nil)
       #   Some parameter documentations has been truncated, see
       #   {Sentdm::Models::TemplateEvent} for more details.
       #
       #   The envelope Sent POSTs to a subscribed webhook endpoint. Every event shares
       #   this shape and varies only in Payload.
       #
-      #   @param event [String, nil] The specific event within the family, for example message.delivered or
+      #   @param event [String, nil] The specific event within the family, for example message.delivered,
       #
-      #   @param field [String] The event family, for example message or templates. Route on this first, then
+      #   @param field [String] The event family, for example message, templates or contact. Route on
       #
       #   @param payload [Sentdm::Models::TemplateEventPayload, nil] Body of a template status event. Delivered when a template's review outcome chan
       #
+      #   @param request_id [String, nil] The event-specific body.
+      #
       #   @param timestamp [String] When Sent emitted the event, in UTC (yyyy-MM-ddTHH:mm:ssZ). This is the emission
     end
   end