sentdm 0.31.0 → 0.32.0

data/lib/sentdm/models/template_body.rb

@@ -4,27 +4,27 @@ module Sentdm
   module Models
     class TemplateBody < Sentdm::Internal::Type::BaseModel
       # @!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
@@ -33,15 +33,24 @@ module Sentdm
       #   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.
       #
-      #   @param multi_channel [Sentdm::Models::TemplateBodyContent, nil] Content that will be used for all channels (SMS and WhatsApp) unless channel-spe
+      #   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.
       #
-      #   @param rcs [Sentdm::Models::TemplateBodyContent, nil] RCS-specific content that overrides multi-channel content for RCS messages
+      #   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 sms [Sentdm::Models::TemplateBodyContent, nil] SMS-specific content that overrides multi-channel content for SMS messages
+      #   @param multi_channel [Sentdm::Models::TemplateBodyContent, nil] The shared body, used for every channel. One half of the choice described above.
       #
-      #   @param whatsapp [Sentdm::Models::TemplateBodyContent, nil] WhatsApp-specific content that overrides multi-channel content for WhatsApp mess
+      #   @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] The SMS body. It does not override multiChannel, it replaces it.
+      #
+      #   @param whatsapp [Sentdm::Models::TemplateBodyContent, nil] The WhatsApp body. It does not override multiChannel, it replaces it.
     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

data/lib/sentdm/models/template_event_payload.rb

@@ -22,6 +22,25 @@ module Sentdm
       #   @return [String, nil]
       optional :account_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.
+      #
+      #   Omitted for an ordinary template, so its presence is the answer to "is this an
+      #   auto-reply". Sent creates the three compliance auto-replies at signup and they
+      #   go through review like any other template, so their events arrive mixed in with
+      #   the customer's own with nothing else to tell them apart.
+      #
+      #   Named for the reader rather than after Template.OptAction, which it is mapped
+      #   from. The MCP tool result deliberately keeps OptAction, OptKeywords and IsOpt:
+      #   it mirrors the internal shape on purpose and publishes the keywords too, so
+      #   renaming one of the three there would leave a surface half in each vocabulary.
+      #   Two names for one concept, each consistent within its own surface, chosen over a
+      #   rename that breaks MCP clients silently.
+      #
+      #   @return [String, nil]
+      optional :auto_reply_action, String, nil?: true
+
       # @!attribute category
       #   The template's category, for example UTILITY, MARKETING, or AUTHENTICATION.
       #
@@ -29,10 +48,16 @@ module Sentdm
       optional :category, String
 
       # @!attribute channel
-      #   The channel the template applies to.
+      #   The channel leg this decision is about, for example whatsapp, sms, or rcs. A
+      #   template is reviewed per channel and the legs come back independently, so each
+      #   one reports separately.
+      #
+      #   Omitted when the decision applies to the template as a whole rather than to one
+      #   leg. That event is the broader news: a template-wide rejection blocks every
+      #   channel, whatever the individual legs say.
       #
       #   @return [String, nil]
-      optional :channel, String
+      optional :channel, String, nil?: true
 
       # @!attribute language
       #   The template's language code, for example en_US.
@@ -59,7 +84,7 @@ module Sentdm
       #   @return [String, nil]
       optional :template_name, String
 
-      # @!method initialize(status:, whatsapp_template_id:, account_id: nil, category: nil, channel: nil, language: nil, reason: nil, template_id: nil, template_name: nil)
+      # @!method initialize(status:, whatsapp_template_id:, account_id: nil, auto_reply_action: nil, category: nil, channel: nil, language: nil, reason: nil, template_id: nil, template_name: nil)
       #   Some parameter documentations has been truncated, see
       #   {Sentdm::Models::TemplateEventPayload} for more details.
       #
@@ -72,9 +97,11 @@ module Sentdm
       #
       #   @param account_id [String] The account the template belongs to.
       #
+      #   @param auto_reply_action [String, nil] Which consent keyword this template answers, when it is one of Sent's auto-repli
+      #
       #   @param category [String] The template's category, for example UTILITY, MARKETING, or
       #
-      #   @param channel [String] The channel the template applies to.
+      #   @param channel [String, nil] The channel leg this decision is about, for example whatsapp, sms, or rcs.
       #
       #   @param language [String] The template's language code, for example en_US.
       #

data/lib/sentdm/models/template_variable.rb

@@ -4,6 +4,9 @@ module Sentdm
   module Models
     class TemplateVariable < Sentdm::Internal::Type::BaseModel
       # @!attribute name
+      #   The variable's name, and the key callers use for it in a send request's
+      #   parameters object. Must start with a letter and hold only letters, digits and
+      #   underscores.
       #
       #   @return [String]
       required :name, String
@@ -14,20 +17,34 @@ module Sentdm
       required :props, -> { Sentdm::TemplateVariable::Props }
 
       # @!attribute type
+      #   One of variable, link or media. Decides which Props fields are required.
       #
       #   @return [String]
       required :type, String
 
       # @!attribute id
+      #   The variable's index, and the number its {{index:variable}} placeholder refers
+      #   to.
+      #
+      #   Omitting it is only safe for a section holding a single variable. The field is a
+      #   non-nullable int, so every variable that leaves it out defaults to 0, and a
+      #   section with two such variables is refused by the unique-id rule ("variables
+      #   must have unique IDs"). Number them from 0 in the order they appear.
       #
       #   @return [Integer, nil]
       optional :id, Integer
 
       # @!method initialize(name:, props:, type:, id: nil)
-      #   @param name [String]
+      #   Some parameter documentations has been truncated, see
+      #   {Sentdm::Models::TemplateVariable} for more details.
+      #
+      #   @param name [String] The variable's name, and the key callers use for it in a send request's paramete
+      #
       #   @param props [Sentdm::Models::TemplateVariable::Props]
-      #   @param type [String]
-      #   @param id [Integer]
+      #
+      #   @param type [String] One of variable, link or media. Decides which Props fields
+      #
+      #   @param id [Integer] The variable's index, and the number its {{index:variable}} placeholder refers t
 
       # @see Sentdm::Models::TemplateVariable#props
       class Props < Sentdm::Internal::Type::BaseModel

data/lib/sentdm/models/webhook_list_events_response.rb

@@ -31,11 +31,11 @@ module Sentdm
 
       # @!attribute event_data
       #   The exact event body that was delivered, or attempted, for this record. One of
-      #   the three webhook envelopes: a message status change, an inbound message, or a
-      #   template status change. Read field and event to tell which, the same way your
-      #   endpoint does.
+      #   the four webhook envelopes: a message status change, an inbound message, a
+      #   template status change, or a contact consent signal. Read field and event to
+      #   tell which, the same way your endpoint does.
       #
-      #   @return [Sentdm::Models::MessageEvent, Sentdm::Models::InboundMessageEvent, Sentdm::Models::TemplateEvent, nil]
+      #   @return [Sentdm::Models::MessageEvent, Sentdm::Models::InboundMessageEvent, Sentdm::Models::TemplateEvent, Sentdm::Models::ChannelEvent, Sentdm::Models::ContactEvent, nil]
       optional :event_data, union: -> { Sentdm::Models::WebhookListEventsResponse::EventData }
 
       # @!attribute event_type
@@ -77,7 +77,7 @@ module Sentdm
       #
       #   @param error_message [String, nil]
       #
-      #   @param event_data [Sentdm::Models::MessageEvent, Sentdm::Models::InboundMessageEvent, Sentdm::Models::TemplateEvent] The exact event body that was delivered, or attempted, for this record. One of t
+      #   @param event_data [Sentdm::Models::MessageEvent, Sentdm::Models::InboundMessageEvent, Sentdm::Models::TemplateEvent, Sentdm::Models::ChannelEvent, Sentdm::Models::ContactEvent] The exact event body that was delivered, or attempted, for this record. One of t
       #
       #   @param event_type [String]
       #
@@ -90,9 +90,9 @@ module Sentdm
       #   @param response_body [String, nil]
 
       # The exact event body that was delivered, or attempted, for this record. One of
-      # the three webhook envelopes: a message status change, an inbound message, or a
-      # template status change. Read field and event to tell which, the same way your
-      # endpoint does.
+      # the four webhook envelopes: a message status change, an inbound message, a
+      # template status change, or a contact consent signal. Read field and event to
+      # tell which, the same way your endpoint does.
       #
       # @see Sentdm::Models::WebhookListEventsResponse#event_data
       module EventData
@@ -110,8 +110,16 @@ module Sentdm
         # varies only in Payload.
         variant -> { Sentdm::TemplateEvent }
 
+        # The envelope Sent POSTs to a subscribed webhook endpoint. Every event shares this shape and
+        # varies only in Payload.
+        variant -> { Sentdm::ChannelEvent }
+
+        # The envelope Sent POSTs to a subscribed webhook endpoint. Every event shares this shape and
+        # varies only in Payload.
+        variant -> { Sentdm::ContactEvent }
+
         # @!method self.variants
-        #   @return [Array(Sentdm::Models::MessageEvent, Sentdm::Models::InboundMessageEvent, Sentdm::Models::TemplateEvent)]
+        #   @return [Array(Sentdm::Models::MessageEvent, Sentdm::Models::InboundMessageEvent, Sentdm::Models::TemplateEvent, Sentdm::Models::ChannelEvent, Sentdm::Models::ContactEvent)]
       end
     end
   end

data/lib/sentdm/models.rb

@@ -67,10 +67,18 @@ module Sentdm
 
   BrandsBrandData = Sentdm::Models::BrandsBrandData
 
+  ChannelEvent = Sentdm::Models::ChannelEvent
+
+  ChannelEventPayload = Sentdm::Models::ChannelEventPayload
+
   ContactCreateParams = Sentdm::Models::ContactCreateParams
 
   ContactDeleteParams = Sentdm::Models::ContactDeleteParams
 
+  ContactEvent = Sentdm::Models::ContactEvent
+
+  ContactEventPayload = Sentdm::Models::ContactEventPayload
+
   ContactListParams = Sentdm::Models::ContactListParams
 
   ContactMessageSummary = Sentdm::Models::ContactMessageSummary

data/lib/sentdm/resources/templates.rb

@@ -15,7 +15,9 @@ module Sentdm
       #
       # Creates a new message template with header, body, footer, and buttons. The
       # template can be submitted for review immediately or saved as draft for later
-      # submission.
+      # submission. There is no `name` field on create — the display name is derived
+      # from the template's content and can be changed afterwards with
+      # `PUT /v3/templates/{id}`.
       #
       # @overload create(category: nil, creation_source: nil, definition: nil, language: nil, sandbox: nil, submit_for_review: nil, idempotency_key: nil, x_profile_id: nil, request_options: {})
       #
@@ -85,7 +87,31 @@ module Sentdm
       # {Sentdm::Models::TemplateUpdateParams} for more details.
       #
       # Updates an existing template's name, category, language, definition, or submits
-      # it for review.
+      # it for review. While the template is in review (status PENDING, or any channel
+      # awaiting a verdict) its definition, category and language are frozen and a
+      # resubmission is refused — those requests answer 409 CONFLICT_006. The display
+      # name stays editable throughout.
+      #
+      # `definition`, `category` and `language` are editable only from status DRAFT,
+      # REJECTED or APPROVED. An edit to any of them on a template in another state
+      # (PAUSED, DISABLED or REVOKED) is refused with 400 VALIDATION_001 and the detail
+      # "Template (except display name) cannot be updated unless it is in draft or
+      # rejected status"; `name` stays editable in every state. `submit_for_review` on a
+      # PAUSED, DISABLED or REVOKED template is accepted and answers 200, but opens no
+      # review and does not move the status — only the reviewer can reinstate it.
+      #
+      # Editing an APPROVED template is a live edit: the new content is stored
+      # immediately, and sending `submit_for_review: true` re-opens review, which
+      # returns the affected channels to PENDING so they stop sending until they are
+      # approved again. The previously approved content is never sent during re-review.
+      # Watch the per-channel `templates` webhook events rather than assuming the
+      # template-level status.
+      #
+      # Templates provisioned by Sent (light-onboarding templates, whose names carry the
+      # reserved `sent_` prefix) are read-only: every field is refused with 400
+      # VALIDATION*001 and the detail "This template is read-only. Only 'submit for
+      # review' is allowed.", and only `submit_for_review` is accepted. A `name`
+      # starting with `sent*` is refused for the same reason — the prefix is reserved.
       #
       # @overload update(id, category: nil, definition: nil, language: nil, name: nil, sandbox: nil, submit_for_review: nil, idempotency_key: nil, x_profile_id: nil, request_options: {})
       #

data/lib/sentdm/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Sentdm
-  VERSION = "0.31.0"
+  VERSION = "0.32.0"
 end

data/lib/sentdm.rb

@@ -72,8 +72,12 @@ require_relative "sentdm/models/brand_business_info"
 require_relative "sentdm/models/brand_compliance_info"
 require_relative "sentdm/models/brand_contact_info"
 require_relative "sentdm/models/brands_brand_data"
+require_relative "sentdm/models/channel_event"
+require_relative "sentdm/models/channel_event_payload"
 require_relative "sentdm/models/contact_create_params"
 require_relative "sentdm/models/contact_delete_params"
+require_relative "sentdm/models/contact_event"
+require_relative "sentdm/models/contact_event_payload"
 require_relative "sentdm/models/contact_list_params"
 require_relative "sentdm/models/contact_message_summary"
 require_relative "sentdm/models/contact_response"

data/rbi/sentdm/models/channel_event.rbi

@@ -0,0 +1,128 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    class ChannelEvent < Sentdm::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias { T.any(Sentdm::ChannelEvent, Sentdm::Internal::AnyHash) }
+
+      # 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, templates or contact. Route on this
+      # first, then on event for the specific change.
+      sig { returns(T.nilable(String)) }
+      attr_reader :field
+
+      sig { params(field: String).void }
+      attr_writer :field
+
+      # Body of a channel event: where one of the customer's channels stands in
+      # provisioning and compliance. Delivered when a milestone moves — a registration
+      # filed, a verdict returned, a resubmission asked for, a sender gone live — so a
+      # customer's own onboarding UI does not have to poll GET /v3/channels.
+      #
+      # The subject is one item, never the account. A customer's "SMS channel" has no
+      # status; a market does. Country, NumberType and SenderValue name which one, so a
+      # customer terminating only to Kosovo never receives an event about US 10DLC.
+      #
+      # Status is the stable half of the contract. It is the same four-value set GET
+      # /v3/channels publishes, computed through the same code, so an event and a read
+      # of the same market cannot disagree. A subscriber that reads nothing but the
+      # status and the subject fields is a correct subscriber. The sub-type on the
+      # envelope names the specific milestone and is additive — that vocabulary comes
+      # from registries and carriers, which are parties Sent does not control.
+      #
+      # Status means provisioning and compliance are complete, not that a send will
+      # succeed right now. An account can be suspended, or a destination blocked by a
+      # routing rule, without either showing up here. Those are separate surfaces and
+      # deliberately not modelled on this payload.
+      sig { returns(T.nilable(Sentdm::ChannelEventPayload)) }
+      attr_reader :payload
+
+      sig do
+        params(payload: T.nilable(Sentdm::ChannelEventPayload::OrHash)).void
+      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.
+      sig { returns(T.nilable(String)) }
+      attr_reader :timestamp
+
+      sig { params(timestamp: String).void }
+      attr_writer :timestamp
+
+      # The envelope Sent POSTs to a subscribed webhook endpoint. Every event shares
+      # this shape and varies only in Payload.
+      sig do
+        params(
+          event: T.nilable(String),
+          field: String,
+          payload: T.nilable(Sentdm::ChannelEventPayload::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,
+        # 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, templates or contact. Route on this
+        # first, then on event for the specific change.
+        field: nil,
+        # Body of a channel event: where one of the customer's channels stands in
+        # provisioning and compliance. Delivered when a milestone moves — a registration
+        # filed, a verdict returned, a resubmission asked for, a sender gone live — so a
+        # customer's own onboarding UI does not have to poll GET /v3/channels.
+        #
+        # The subject is one item, never the account. A customer's "SMS channel" has no
+        # status; a market does. Country, NumberType and SenderValue name which one, so a
+        # customer terminating only to Kosovo never receives an event about US 10DLC.
+        #
+        # Status is the stable half of the contract. It is the same four-value set GET
+        # /v3/channels publishes, computed through the same code, so an event and a read
+        # of the same market cannot disagree. A subscriber that reads nothing but the
+        # status and the subject fields is a correct subscriber. The sub-type on the
+        # envelope names the specific milestone and is additive — that vocabulary comes
+        # from registries and carriers, which are parties Sent does not control.
+        #
+        # Status means provisioning and compliance are complete, not that a send will
+        # succeed right now. An account can be suspended, or a destination blocked by a
+        # routing rule, without either showing up here. Those are separate surfaces and
+        # deliberately not modelled on this payload.
+        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.
+        timestamp: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            event: T.nilable(String),
+            field: String,
+            payload: T.nilable(Sentdm::ChannelEventPayload),
+            request_id: T.nilable(String),
+            timestamp: String
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end