sentdm 0.31.0 → 0.33.0

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_header.rb

@@ -10,8 +10,56 @@ module Sentdm
       #   @return [String]
       required :template, String
 
+      # @!attribute example_url
+      #   Request-only. The s.dm URL of the asset Meta's reviewers see —
+      #   https://s.dm/s/{ID}, eight uppercase characters, uploaded to s.dm out of band.
+      #   NormalizeRichHeader folds it into the synthesized media variable's Props.Sample
+      #   and clears it, so it never persists and a stored definition is indistinguishable
+      #   from an imported one.
+      #
+      #   Stricter than the send path on purpose:
+      #   TemplateUtils.ValidateMediaVariableValues accepts any absolute https URL for the
+      #   per-send asset, because that one is the customer's and may live behind a signed
+      #   CDN link. This one is the review sample, has to outlive every resubmission, and
+      #   so must be ours. Do not "fix" one to match the other.
+      #
+      #   @return [String, nil]
+      optional :example_url, String, nil?: true
+
+      # @!attribute location
+      #   The map pin a location header drops. Meta wants none of this at creation — the
+      #   component is just {"type":"header","format":"location"} — so these values exist
+      #   for Sent: a preview, and the default a StaticResource header falls back to at
+      #   send.
+      #
+      #   @return [Sentdm::Models::TemplateHeader::Location, nil]
+      optional :location, -> { Sentdm::TemplateHeader::Location }, nil?: true
+
+      # @!attribute static_resource
+      #   Whether the asset registered at creation is reused when a caller omits the
+      #   header's variable at send time. Default false — the caller must supply it per
+      #   message, which is the behaviour every existing template has. Written only when
+      #   true, so a default-valued header serializes byte-identically to one imported
+      #   from Meta.
+      #
+      #   Stored and validated but not yet honoured at send: that lands with the Resumable
+      #   Upload work, alongside the code that lets such a template be approved in the
+      #   first place.
+      #
+      #   @return [Boolean, nil]
+      optional :static_resource, Sentdm::Internal::Type::Boolean
+
       # @!attribute type
-      #   The type of header (e.g., "text", "image", "video", "document")
+      #   The kind of header. One of:
+      #
+      #   text — up to 60 characters, at most one variable. image — png, jpg or jpeg.
+      #   Needs ExampleUrl. video — mp4. Needs ExampleUrl. gif — mp4, max 3.5MB. WhatsApp
+      #   renders larger files as an ordinary video. Needs ExampleUrl. document — pdf or
+      #   docx; only the first page is shown as a thumbnail, so pdf is the practical
+      #   choice. Needs ExampleUrl. location — a map pin, supplied through Location.
+      #
+      #   Kept lowercase because MetaToTemplateConverter writes Meta's format through
+      #   ToLowerInvariant() into this field on import, and the two are compared directly.
       #
       #   @return [String, nil]
       optional :type, String, nil?: true
@@ -22,7 +70,7 @@ module Sentdm
       #   @return [Array<Sentdm::Models::TemplateVariable>, nil]
       optional :variables, -> { Sentdm::Internal::Type::ArrayOf[Sentdm::TemplateVariable] }, nil?: true
 
-      # @!method initialize(template:, type: nil, variables: nil)
+      # @!method initialize(template:, example_url: nil, location: nil, static_resource: nil, type: nil, variables: nil)
       #   Some parameter documentations has been truncated, see
       #   {Sentdm::Models::TemplateHeader} for more details.
       #
@@ -30,9 +78,49 @@ module Sentdm
       #
       #   @param template [String] The header template text with optional variable placeholders (e.g., "Welcome to
       #
-      #   @param type [String, nil] The type of header (e.g., "text", "image", "video", "document")
+      #   @param example_url [String, nil] Request-only. The s.dm URL of the asset Meta's reviewers see — https://s.dm/s/{I
+      #
+      #   @param location [Sentdm::Models::TemplateHeader::Location, nil] The map pin a location header drops. Meta wants none of this at creation — the c
+      #
+      #   @param static_resource [Boolean] Whether the asset registered at creation is reused when a caller omits the heade
+      #
+      #   @param type [String, nil] The kind of header. One of:
       #
       #   @param variables [Array<Sentdm::Models::TemplateVariable>, nil] List of variables used in the header template
+
+      # @see Sentdm::Models::TemplateHeader#location
+      class Location < Sentdm::Internal::Type::BaseModel
+        # @!attribute address
+        #
+        #   @return [String]
+        required :address, String
+
+        # @!attribute latitude
+        #
+        #   @return [String]
+        required :latitude, String
+
+        # @!attribute longitude
+        #
+        #   @return [String]
+        required :longitude, String
+
+        # @!attribute name
+        #
+        #   @return [String]
+        required :name, String
+
+        # @!method initialize(address:, latitude:, longitude:, name:)
+        #   The map pin a location header drops. Meta wants none of this at creation — the
+        #   component is just {"type":"header","format":"location"} — so these values exist
+        #   for Sent: a preview, and the default a StaticResource header falls back to at
+        #   send.
+        #
+        #   @param address [String]
+        #   @param latitude [String]
+        #   @param longitude [String]
+        #   @param name [String]
+      end
     end
   end
 end

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
@@ -37,6 +54,11 @@ module Sentdm
         required :media_type, String, api_name: :mediaType
 
         # @!attribute sample
+        #   Example value substituted into the template when previewing it and when
+        #   submitting it to Meta for review. Free text by nature, so the converter accepts
+        #   a JSON number or boolean here and normalizes it — see
+        #   JsonScalarToStringConverter for why — and guarantees it is always serialized
+        #   back out as a JSON string.
         #
         #   @return [String]
         required :sample, String
@@ -67,12 +89,21 @@ module Sentdm
         optional :short_url, String, api_name: :shortUrl, nil?: true
 
         # @!method initialize(media_type:, sample:, url:, variable_type:, alt: nil, regex: nil, short_url: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Sentdm::Models::TemplateVariable::Props} for more details.
+        #
         #   @param media_type [String]
-        #   @param sample [String]
+        #
+        #   @param sample [String] Example value substituted into the template when previewing it and when submitti
+        #
         #   @param url [String]
+        #
         #   @param variable_type [String]
+        #
         #   @param alt [String, nil]
+        #
         #   @param regex [String, nil]
+        #
         #   @param short_url [String, nil]
       end
     end

data/lib/sentdm/models/webhook_list_events_response.rb

@@ -31,11 +31,24 @@ 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 six webhook envelopes:
       #
-      #   @return [Sentdm::Models::MessageEvent, Sentdm::Models::InboundMessageEvent, Sentdm::Models::TemplateEvent, nil]
+      #   message — an outbound message changed status. message with event:
+      #   message.received — someone replied to you. templates — a template was approved,
+      #   rejected, paused or similar. channel — one of your markets moved in provisioning
+      #   or compliance. contact — a consent signal: opt-in, opt-out or help. link — a
+      #   tracked short link was clicked or a hosted file downloaded, or one expired or
+      #   was revoked.
+      #
+      #   Read field and event to tell which, the same way your endpoint does. The two
+      #   message envelopes are the reason that is two fields and not one: they share a
+      #   field and differ by event.
+      #
+      #   Treat the list as open. It has grown twice — channel and then link — and a
+      #   handler that rejects an envelope it does not recognise will break on the next
+      #   addition rather than ignore it.
+      #
+      #   @return [Sentdm::Models::MessageEvent, Sentdm::Models::InboundMessageEvent, Sentdm::Models::TemplateEvent, Sentdm::Models::ChannelEvent, Sentdm::Models::ContactEvent, Sentdm::Models::WebhookListEventsResponse::EventData::SentDmServicesCommonServicesWebhooksContractsWebhookEventOfLinkWebhookPayload, nil]
       optional :event_data, union: -> { Sentdm::Models::WebhookListEventsResponse::EventData }
 
       # @!attribute event_type
@@ -77,7 +90,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, Sentdm::Models::WebhookListEventsResponse::EventData::SentDmServicesCommonServicesWebhooksContractsWebhookEventOfLinkWebhookPayload] The exact event body that was delivered, or attempted, for this record. One of t
       #
       #   @param event_type [String]
       #
@@ -90,9 +103,22 @@ 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 six webhook envelopes:
+      #
+      # message — an outbound message changed status. message with event:
+      # message.received — someone replied to you. templates — a template was approved,
+      # rejected, paused or similar. channel — one of your markets moved in provisioning
+      # or compliance. contact — a consent signal: opt-in, opt-out or help. link — a
+      # tracked short link was clicked or a hosted file downloaded, or one expired or
+      # was revoked.
+      #
+      # Read field and event to tell which, the same way your endpoint does. The two
+      # message envelopes are the reason that is two fields and not one: they share a
+      # field and differ by event.
+      #
+      # Treat the list as open. It has grown twice — channel and then link — and a
+      # handler that rejects an envelope it does not recognise will break on the next
+      # addition rather than ignore it.
       #
       # @see Sentdm::Models::WebhookListEventsResponse#event_data
       module EventData
@@ -110,8 +136,305 @@ 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 }
+
+        # The envelope Sent POSTs to a subscribed webhook endpoint. Every event shares this shape and
+        # varies only in Payload.
+        variant -> { Sentdm::Models::WebhookListEventsResponse::EventData::SentDmServicesCommonServicesWebhooksContractsWebhookEventOfLinkWebhookPayload }
+
+        class SentDmServicesCommonServicesWebhooksContractsWebhookEventOfLinkWebhookPayload < Sentdm::Internal::Type::BaseModel
+          # @!attribute event
+          #   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, templates or contact. Route on this
+          #   first, then on event for the specific change.
+          #
+          #   @return [String, nil]
+          optional :field, String
+
+          # @!attribute payload
+          #   Body of a link event: something happened to a tracked link Sent published on the
+          #   customer's behalf. A link points either at a URL the customer supplied or at a
+          #   file Sent hosts for them; LinkKind says which. Delivered when an eligible
+          #   request is served, or when a published link reaches the end of its life.
+          #
+          #   A click is a request, not a read receipt. link.clicked means the redirect was
+          #   served; link.downloaded means bytes went out. Neither proves a person saw
+          #   anything — messaging providers and link scanners fetch URLs on their own, which
+          #   is what TrafficClass exists to tell apart. Filter on it before reporting a
+          #   click-through rate; treat likely_human as a hint, never as delivery
+          #   confirmation.
+          #
+          #   RecordId identifies the link; the X-Webhook-Event-ID header identifies the
+          #   delivery. One link is hit many times, so those are the two keys a subscriber
+          #   needs: group by the first, deduplicate on the second — exactly as on every other
+          #   family. The payload carries no event identifier of its own, for the same reason
+          #   none of the others do.
+          #
+          #   Nothing here identifies the visitor. No IP address and no visitor token crosses
+          #   this boundary. Country, Device and Browser are coarse buckets derived at the
+          #   edge and are absent whenever the request did not supply enough to derive them.
+          #
+          #   @return [Sentdm::Models::WebhookListEventsResponse::EventData::SentDmServicesCommonServicesWebhooksContractsWebhookEventOfLinkWebhookPayload::Payload, nil]
+          optional :payload,
+                   -> { Sentdm::Models::WebhookListEventsResponse::EventData::SentDmServicesCommonServicesWebhooksContractsWebhookEventOfLinkWebhookPayload::Payload },
+                   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
+          #   payload for the latter.
+          #
+          #   @return [String, nil]
+          optional :timestamp, String
+
+          # @!method initialize(event: nil, field: nil, payload: nil, request_id: nil, timestamp: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {Sentdm::Models::WebhookListEventsResponse::EventData::SentDmServicesCommonServicesWebhooksContractsWebhookEventOfLinkWebhookPayload}
+          #   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,
+          #
+          #   @param field [String] The event family, for example message, templates or contact. Route on
+          #
+          #   @param payload [Sentdm::Models::WebhookListEventsResponse::EventData::SentDmServicesCommonServicesWebhooksContractsWebhookEventOfLinkWebhookPayload::Payload, nil] Body of a link event: something happened to a tracked link Sent published on the
+          #
+          #   @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
+
+          # @see Sentdm::Models::WebhookListEventsResponse::EventData::SentDmServicesCommonServicesWebhooksContractsWebhookEventOfLinkWebhookPayload#payload
+          class Payload < Sentdm::Internal::Type::BaseModel
+            # @!attribute record_id
+            #   The link's public identifier — the eight-character code in the short URL, for
+            #   example A78B2BU0. Unique across both kinds, and never reused, so it is the
+            #   stable key to group one link's events by.
+            #
+            #   @return [String]
+            required :record_id, String
+
+            # @!attribute access_country
+            #   Where the request appeared to come from, as an ISO 3166-1 alpha-2 code. Named
+            #   separately from the country on a channel event, which is a destination market
+            #   the customer registered for — this one is a property of a single visitor and is
+            #   absent when the edge could not resolve it.
+            #
+            #   @return [String, nil]
+            optional :access_country, String, nil?: true
+
+            # @!attribute access_outcome
+            #   How the request was served, when the edge recorded it. Free text describing the
+            #   outcome — show it to a human rather than branching on it.
+            #
+            #   @return [String, nil]
+            optional :access_outcome, String, nil?: true
+
+            # @!attribute browser
+            #   The requesting browser family, for example chrome or safari, or unknown. Derived
+            #   from the user agent.
+            #
+            #   @return [String, nil]
+            optional :browser, String, nil?: true
+
+            # @!attribute bytes_served
+            #   How many bytes were served, for a file access. A ranged request reports the
+            #   bytes in that range, not the size of the file, so several accesses of one file
+            #   can each report a part.
+            #
+            #   @return [Integer, nil]
+            optional :bytes_served, Integer, nil?: true
+
+            # @!attribute channel
+            #   The channel the message carrying this link went out on: sms, whatsapp, or rcs.
+            #
+            #   @return [String, nil]
+            optional :channel, String, nil?: true
+
+            # @!attribute customer_id
+            #   The organization the link belongs to. Always the parent account, never a sender
+            #   profile — read SenderProfileId for that.
+            #
+            #   This family publishes the owner as an explicit pair rather than the single
+            #   account_id the other families use. The pair says which organization and which
+            #   profile without the subscriber deriving either, which is the trade: one more key
+            #   against not having to know that account_id silently becomes the profile when one
+            #   exists.
+            #
+            #   @return [String, nil]
+            optional :customer_id, String
+
+            # @!attribute device
+            #   The requesting device class: mobile, tablet, desktop or unknown. Derived from
+            #   the user agent.
+            #
+            #   @return [String, nil]
+            optional :device, String, nil?: true
+
+            # @!attribute link_kind
+            #   What the link points at: url for a destination the customer supplied, file for
+            #   media Sent hosts. Always present, and implied by the event — link.clicked is
+            #   always url and link.downloaded always file — but published as its own field so a
+            #   subscriber can branch on the kind without parsing the event name, the same
+            #   separation the channel family keeps between its event and its status.
+            #
+            #   @return [String, nil]
+            optional :link_kind, String
+
+            # @!attribute message_id
+            #   The message the link was published in.
+            #
+            #   The event can arrive before the message is readable through GET /v3/messages: a
+            #   provider may fetch a link within milliseconds of the send, and nothing here
+            #   waits for the message row. Retry the read rather than treating an unknown id as
+            #   an error.
+            #
+            #   @return [String, nil]
+            optional :message_id, String, nil?: true
+
+            # @!attribute occurred_at
+            #   When the access or lifecycle change actually happened, in UTC
+            #   (yyyy-MM-ddTHH:mm:ssZ). The envelope's timestamp is when Sent emitted the event;
+            #   this is when the thing occurred, and the two differ by the ingest delay.
+            #
+            #   @return [String, nil]
+            optional :occurred_at, String
+
+            # @!attribute reference_key
+            #   The caller-supplied label tying this link back to a position in the message, for
+            #   example body:0 for the first link in the body. Present when the link was created
+            #   with one.
+            #
+            #   @return [String, nil]
+            optional :reference_key, String, nil?: true
+
+            # @!attribute referrer_host
+            #   The host of the page that linked here, when the request supplied one. The host
+            #   only — never a full referring URL.
+            #
+            #   @return [String, nil]
+            optional :referrer_host, String, nil?: true
+
+            # @!attribute request_method
+            #   The HTTP method of the request that was served, for an access event. Omitted on
+            #   link.expired and link.revoked, which describe no request.
+            #
+            #   @return [String, nil]
+            optional :request_method, String, nil?: true
+
+            # @!attribute sender_profile_id
+            #   The sender profile that owns the link, or null when the organization owns it
+            #   directly. Always on the wire so a handler reads one shape rather than branching
+            #   on whether the key arrived.
+            #
+            #   sender_profile_id, not profile_id: the API already publishes
+            #   messaging_profile_id and sending_phone_number_profile_id for provider-side
+            #   profiles, which are a different thing entirely. The unqualified name would read
+            #   as one of those.
+            #
+            #   @return [String, nil]
+            optional :sender_profile_id, String, nil?: true
+
+            # @!attribute status_code
+            #   The HTTP status Sent answered the request with: 302 for a link, 200 or 206 for a
+            #   file. Omitted on lifecycle events.
+            #
+            #   @return [Integer, nil]
+            optional :status_code, Integer, nil?: true
+
+            # @!attribute traffic_class
+            #   A coarse guess at what made the request: likely_human, provider (a messaging
+            #   platform prefetching the link), bot, or unknown. Derived from the user agent, so
+            #   it is a hint for filtering noise rather than a fact to bill or report on.
+            #
+            #   @return [String, nil]
+            optional :traffic_class, String, nil?: true
+
+            # @!method initialize(record_id:, access_country: nil, access_outcome: nil, browser: nil, bytes_served: nil, channel: nil, customer_id: nil, device: nil, link_kind: nil, message_id: nil, occurred_at: nil, reference_key: nil, referrer_host: nil, request_method: nil, sender_profile_id: nil, status_code: nil, traffic_class: nil)
+            #   Some parameter documentations has been truncated, see
+            #   {Sentdm::Models::WebhookListEventsResponse::EventData::SentDmServicesCommonServicesWebhooksContractsWebhookEventOfLinkWebhookPayload::Payload}
+            #   for more details.
+            #
+            #   Body of a link event: something happened to a tracked link Sent published on the
+            #   customer's behalf. A link points either at a URL the customer supplied or at a
+            #   file Sent hosts for them; LinkKind says which. Delivered when an eligible
+            #   request is served, or when a published link reaches the end of its life.
+            #
+            #   A click is a request, not a read receipt. link.clicked means the redirect was
+            #   served; link.downloaded means bytes went out. Neither proves a person saw
+            #   anything — messaging providers and link scanners fetch URLs on their own, which
+            #   is what TrafficClass exists to tell apart. Filter on it before reporting a
+            #   click-through rate; treat likely_human as a hint, never as delivery
+            #   confirmation.
+            #
+            #   RecordId identifies the link; the X-Webhook-Event-ID header identifies the
+            #   delivery. One link is hit many times, so those are the two keys a subscriber
+            #   needs: group by the first, deduplicate on the second — exactly as on every other
+            #   family. The payload carries no event identifier of its own, for the same reason
+            #   none of the others do.
+            #
+            #   Nothing here identifies the visitor. No IP address and no visitor token crosses
+            #   this boundary. Country, Device and Browser are coarse buckets derived at the
+            #   edge and are absent whenever the request did not supply enough to derive them.
+            #
+            #   @param record_id [String] The link's public identifier — the eight-character code in the short URL, for ex
+            #
+            #   @param access_country [String, nil] Where the request appeared to come from, as an ISO 3166-1 alpha-2 code. Named se
+            #
+            #   @param access_outcome [String, nil] How the request was served, when the edge recorded it. Free text describing the
+            #
+            #   @param browser [String, nil] The requesting browser family, for example chrome or safari, or
+            #
+            #   @param bytes_served [Integer, nil] How many bytes were served, for a file access. A ranged request reports the byte
+            #
+            #   @param channel [String, nil] The channel the message carrying this link went out on: sms, whatsapp, or
+            #
+            #   @param customer_id [String] The organization the link belongs to. Always the parent account, never a sender
+            #
+            #   @param device [String, nil] The requesting device class: mobile, tablet, desktop or
+            #
+            #   @param link_kind [String] What the link points at: url for a destination the customer supplied, file for
+            #
+            #   @param message_id [String, nil] The message the link was published in.
+            #
+            #   @param occurred_at [String] When the access or lifecycle change actually happened, in UTC
+            #
+            #   @param reference_key [String, nil] The caller-supplied label tying this link back to a position in the message, for
+            #
+            #   @param referrer_host [String, nil] The host of the page that linked here, when the request supplied one. The host o
+            #
+            #   @param request_method [String, nil] The HTTP method of the request that was served, for an access event. Omitted on
+            #
+            #   @param sender_profile_id [String, nil] The sender profile that owns the link, or null when the organization owns it dir
+            #
+            #   @param status_code [Integer, nil] The HTTP status Sent answered the request with: 302 for a link, 200 or
+            #
+            #   @param traffic_class [String, nil] A coarse guess at what made the request: likely_human, provider (a messaging
+          end
+        end
+
         # @!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, Sentdm::Models::WebhookListEventsResponse::EventData::SentDmServicesCommonServicesWebhooksContractsWebhookEventOfLinkWebhookPayload)]
       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