sentdm 0.45.0 → 0.46.0

data/lib/sentdm/models/conversation_messages_list.rb

@@ -6,8 +6,8 @@ module Sentdm
       # @!attribute messages
       #   The messages on this page.
       #
-      #   @return [Array<Sentdm::Models::ConversationMessagesList::Message>, nil]
-      optional :messages, -> { Sentdm::Internal::Type::ArrayOf[Sentdm::ConversationMessagesList::Message] }
+      #   @return [Array<Sentdm::Models::Message>, nil]
+      optional :messages, -> { Sentdm::Internal::Type::ArrayOf[Sentdm::Message] }
 
       # @!attribute pagination
       #   Pagination metadata for list responses
@@ -18,436 +18,9 @@ module Sentdm
       # @!method initialize(messages: nil, pagination: nil)
       #   A paginated list of messages — used by both conversation read endpoints.
       #
-      #   @param messages [Array<Sentdm::Models::ConversationMessagesList::Message>] The messages on this page.
+      #   @param messages [Array<Sentdm::Models::Message>] The messages on this page.
       #
       #   @param pagination [Sentdm::Models::PaginationMeta] Pagination metadata for list responses
-
-      class Message < Sentdm::Internal::Type::BaseModel
-        # @!attribute id
-        #
-        #   @return [String, nil]
-        optional :id, String
-
-        # @!attribute active_contact_price
-        #
-        #   @return [Float, nil]
-        optional :active_contact_price, Float, nil?: true
-
-        # @!attribute channel
-        #
-        #   @return [String, nil]
-        optional :channel, String
-
-        # @!attribute contact_id
-        #
-        #   @return [String, nil]
-        optional :contact_id, String
-
-        # @!attribute created_at
-        #
-        #   @return [Time, nil]
-        optional :created_at, Time
-
-        # @!attribute customer_id
-        #
-        #   @return [String, nil]
-        optional :customer_id, String
-
-        # @!attribute direction
-        #
-        #   @return [String, nil]
-        optional :direction, String
-
-        # @!attribute events
-        #
-        #   @return [Array<Sentdm::Models::ConversationMessagesList::Message::Event>, nil]
-        optional :events,
-                 -> { Sentdm::Internal::Type::ArrayOf[Sentdm::ConversationMessagesList::Message::Event] },
-                 nil?: true
-
-        # @!attribute message_body
-        #   Structured message body format for database storage. Preserves channel-specific
-        #   components (header, header media, body, footer, buttons, MMS subject and media).
-        #
-        #   Persisted as the messageBody jsonb column on Messages. Every write path goes
-        #   through MessageUtils.MessageBodyJsonOptions, which writes nulls, so the envelope
-        #   shape is stable regardless of channel or status. Anything that rebuilds this
-        #   object field by field — the four IMessageBodyStrategy implementations and
-        #   MessageUtils.BuildSegmentBody — has to carry every member, or that member is
-        #   silently dropped on whichever path forgot it.
-        #
-        #   @return [Sentdm::Models::ConversationMessagesList::Message::MessageBody, nil]
-        optional :message_body, -> { Sentdm::ConversationMessagesList::Message::MessageBody }, nil?: true
-
-        # @!attribute phone
-        #
-        #   @return [String, nil]
-        optional :phone, String
-
-        # @!attribute phone_international
-        #
-        #   @return [String, nil]
-        optional :phone_international, String
-
-        # @!attribute price
-        #
-        #   @return [Float, nil]
-        optional :price, Float, nil?: true
-
-        # @!attribute reason
-        #   A human-readable sentence for reason_code, for example "Insufficient balance".
-        #   Omitted whenever reason_code is.
-        #
-        #   @return [String, nil]
-        optional :reason, String, nil?: true
-
-        # @!attribute reason_code
-        #   Why the message is at its current status, as a stable platform code such as
-        #   DELIVERY_007, BUSINESS_003 or DELIVERY_003. Present when the current status is
-        #   FAILED, FILTERED or BLOCKED and the lifecycle was loaded; omitted otherwise.
-        #   Switch on this rather than on reason: the code is stable, the wording may be
-        #   improved. It is the platform's classification of the outcome, never a carrier or
-        #   vendor code.
-        #
-        #   @return [String, nil]
-        optional :reason_code, String, nil?: true
-
-        # @!attribute region_code
-        #
-        #   @return [String, nil]
-        optional :region_code, String
-
-        # @!attribute status
-        #
-        #   @return [String, nil]
-        optional :status, String
-
-        # @!attribute template_category
-        #
-        #   @return [String, nil]
-        optional :template_category, String, nil?: true
-
-        # @!attribute template_id
-        #
-        #   @return [String, nil]
-        optional :template_id, String, nil?: true
-
-        # @!attribute template_name
-        #
-        #   @return [String, nil]
-        optional :template_name, String, nil?: true
-
-        # @!method initialize(id: nil, active_contact_price: nil, channel: nil, contact_id: nil, created_at: nil, customer_id: nil, direction: nil, events: nil, message_body: nil, phone: nil, phone_international: nil, price: nil, reason: nil, reason_code: nil, region_code: nil, status: nil, template_category: nil, template_id: nil, template_name: nil)
-        #   Some parameter documentations has been truncated, see
-        #   {Sentdm::Models::ConversationMessagesList::Message} for more details.
-        #
-        #   Message response for v3 API — same shape as v2 with snake_case JSON conventions.
-        #
-        #   The shape of a message that was sent immediately: it never has a scheduled_at
-        #   key. A message that is or was held for a later instant is a
-        #   ScheduledMessageResponse, and the endpoint decides which of the two to answer
-        #   with. From always returns this type.
-        #
-        #   @param id [String]
-        #
-        #   @param active_contact_price [Float, nil]
-        #
-        #   @param channel [String]
-        #
-        #   @param contact_id [String]
-        #
-        #   @param created_at [Time]
-        #
-        #   @param customer_id [String]
-        #
-        #   @param direction [String]
-        #
-        #   @param events [Array<Sentdm::Models::ConversationMessagesList::Message::Event>, nil]
-        #
-        #   @param message_body [Sentdm::Models::ConversationMessagesList::Message::MessageBody, nil] Structured message body format for database storage.
-        #
-        #   @param phone [String]
-        #
-        #   @param phone_international [String]
-        #
-        #   @param price [Float, nil]
-        #
-        #   @param reason [String, nil] A human-readable sentence for reason_code, for example "Insufficient balance". O
-        #
-        #   @param reason_code [String, nil] Why the message is at its current status, as a stable platform code such as
-        #
-        #   @param region_code [String]
-        #
-        #   @param status [String]
-        #
-        #   @param template_category [String, nil]
-        #
-        #   @param template_id [String, nil]
-        #
-        #   @param template_name [String, nil]
-
-        class Event < Sentdm::Internal::Type::BaseModel
-          # @!attribute status
-          #
-          #   @return [String]
-          required :status, String
-
-          # @!attribute timestamp
-          #
-          #   @return [Time]
-          required :timestamp, Time
-
-          # @!attribute description
-          #
-          #   @return [String, nil]
-          optional :description, String, nil?: true
-
-          # @!attribute reason
-          #   A human-readable sentence for reason_code. Omitted whenever reason_code is.
-          #
-          #   @return [String, nil]
-          optional :reason, String, nil?: true
-
-          # @!attribute reason_code
-          #   Why the message reached this status, as a stable platform code such as
-          #   DELIVERY_007. Present on FAILED, FILTERED and BLOCKED events; omitted on every
-          #   status that needs no explanation. Same wire name and vocabulary as on the
-          #   activities list and the webhook.
-          #
-          #   @return [String, nil]
-          optional :reason_code, String, nil?: true
-
-          # @!method initialize(status:, timestamp:, description: nil, reason: nil, reason_code: nil)
-          #   Some parameter documentations has been truncated, see
-          #   {Sentdm::Models::ConversationMessagesList::Message::Event} for more details.
-          #
-          #   Represents a status change event in a message's lifecycle (v3)
-          #
-          #   @param status [String]
-          #
-          #   @param timestamp [Time]
-          #
-          #   @param description [String, nil]
-          #
-          #   @param reason [String, nil] A human-readable sentence for reason_code. Omitted whenever reason_code is.
-          #
-          #   @param reason_code [String, nil] Why the message reached this status, as a stable platform code such as
-          #   DELIVERY\_
-        end
-
-        # @see Sentdm::Models::ConversationMessagesList::Message#message_body
-        class MessageBody < Sentdm::Internal::Type::BaseModel
-          # @!attribute buttons
-          #
-          #   @return [Array<Sentdm::Models::ConversationMessagesList::Message::MessageBody::Button>, nil]
-          optional :buttons,
-                   -> {
-                     Sentdm::Internal::Type::ArrayOf[Sentdm::ConversationMessagesList::Message::MessageBody::Button]
-                   },
-                   nil?: true
-
-          # @!attribute content
-          #
-          #   @return [String, nil]
-          optional :content, String
-
-          # @!attribute footer
-          #
-          #   @return [String, nil]
-          optional :footer, String, nil?: true
-
-          # @!attribute header
-          #
-          #   @return [String, nil]
-          optional :header, String, nil?: true
-
-          # @!attribute header_media
-          #   The media asset that rode a message's header, recorded as sent.
-          #
-          #   @return [Sentdm::Models::ConversationMessagesList::Message::MessageBody::HeaderMedia, nil]
-          optional :header_media,
-                   -> { Sentdm::ConversationMessagesList::Message::MessageBody::HeaderMedia },
-                   api_name: :headerMedia,
-                   nil?: true
-
-          # @!attribute media
-          #   MMS attachments, as the publicly fetchable URLs handed to the carrier. Null on
-          #   every other channel.
-          #
-          #   Persisted rather than derived because a resend and a curfew release rebuild the
-          #   send from the stored row — MessageReplayCommandBuilder reads templateId and
-          #   templateVariables and nothing else — so media that lives only on the original
-          #   request would silently turn a replayed MMS into a text message.
-          #
-          #   @return [Array<Sentdm::Models::ConversationMessagesList::Message::MessageBody::Media>, nil]
-          optional :media,
-                   -> {
-                     Sentdm::Internal::Type::ArrayOf[Sentdm::ConversationMessagesList::Message::MessageBody::Media]
-                   },
-                   nil?: true
-
-          # @!attribute subject
-          #   MMS subject line. Null on every other channel.
-          #
-          #   @return [String, nil]
-          optional :subject, String, nil?: true
-
-          # @!method initialize(buttons: nil, content: nil, footer: nil, header: nil, header_media: nil, media: nil, subject: nil)
-          #   Some parameter documentations has been truncated, see
-          #   {Sentdm::Models::ConversationMessagesList::Message::MessageBody} for more
-          #   details.
-          #
-          #   Structured message body format for database storage. Preserves channel-specific
-          #   components (header, header media, body, footer, buttons, MMS subject and media).
-          #
-          #   Persisted as the messageBody jsonb column on Messages. Every write path goes
-          #   through MessageUtils.MessageBodyJsonOptions, which writes nulls, so the envelope
-          #   shape is stable regardless of channel or status. Anything that rebuilds this
-          #   object field by field — the four IMessageBodyStrategy implementations and
-          #   MessageUtils.BuildSegmentBody — has to carry every member, or that member is
-          #   silently dropped on whichever path forgot it.
-          #
-          #   @param buttons [Array<Sentdm::Models::ConversationMessagesList::Message::MessageBody::Button>, nil]
-          #
-          #   @param content [String]
-          #
-          #   @param footer [String, nil]
-          #
-          #   @param header [String, nil]
-          #
-          #   @param header_media [Sentdm::Models::ConversationMessagesList::Message::MessageBody::HeaderMedia, nil] The media asset that rode a message's header, recorded as sent.
-          #
-          #   @param media [Array<Sentdm::Models::ConversationMessagesList::Message::MessageBody::Media>, nil] MMS attachments, as the publicly fetchable URLs handed to the carrier. Null on e
-          #
-          #   @param subject [String, nil] MMS subject line. Null on every other channel.
-
-          class Button < Sentdm::Internal::Type::BaseModel
-            # @!attribute postback_data
-            #
-            #   @return [String, nil]
-            optional :postback_data, String, api_name: :postbackData, nil?: true
-
-            # @!attribute text
-            #
-            #   @return [String, nil]
-            optional :text, String, nil?: true
-
-            # @!attribute type
-            #
-            #   @return [String, nil]
-            optional :type, String
-
-            # @!attribute value
-            #
-            #   @return [String, nil]
-            optional :value, String
-
-            # @!method initialize(postback_data: nil, text: nil, type: nil, value: nil)
-            #   @param postback_data [String, nil]
-            #   @param text [String, nil]
-            #   @param type [String]
-            #   @param value [String]
-          end
-
-          # @see Sentdm::Models::ConversationMessagesList::Message::MessageBody#header_media
-          class HeaderMedia < Sentdm::Internal::Type::BaseModel
-            # @!attribute type
-            #   "image", "video" or "document" — taken from the header's media variable.
-            #
-            #   @return [String, nil]
-            optional :type, String
-
-            # @!attribute url
-            #   The https URL the caller supplied for this send. Never the template's stored
-            #   props.sample, which is Meta's expiring header_handle rather than what was
-            #   delivered.
-            #
-            #   @return [String, nil]
-            optional :url, String
-
-            # @!method initialize(type: nil, url: nil)
-            #   Some parameter documentations has been truncated, see
-            #   {Sentdm::Models::ConversationMessagesList::Message::MessageBody::HeaderMedia}
-            #   for more details.
-            #
-            #   The media asset that rode a message's header, recorded as sent.
-            #
-            #   @param type [String] "image", "video" or "document" — taken from the header's media variable.
-            #
-            #   @param url [String] The https URL the caller supplied for this send. Never the template's stored
-          end
-
-          class Media < Sentdm::Internal::Type::BaseModel
-            # @!attribute media_type
-            #   One of MmsMediaTypes when the content type is known. Advisory — a reader should
-            #   trust the fetched object's own Content-Type.
-            #
-            #   @return [String, nil]
-            optional :media_type, String, api_name: :mediaType, nil?: true
-
-            # @!attribute mime_type
-            #   Content type as the provider declared it. Null when it declared none.
-            #
-            #   @return [String, nil]
-            optional :mime_type, String, api_name: :mimeType, nil?: true
-
-            # @!attribute size_bytes
-            #   Size as the provider declared it. Never measured here — nothing downloads the
-            #   file.
-            #
-            #   @return [Integer, nil]
-            optional :size_bytes, Integer, api_name: :sizeBytes, nil?: true
-
-            # @!attribute source_hash_sha256
-            #   Inbound only: the SHA-256 the provider declared alongside the attachment, when
-            #   it declared one. Relayed to the customer so they can verify what they fetch
-            #   matches what the carrier said it sent. It is the only integrity signal available
-            #   on an attachment nobody here has read.
-            #
-            #   @return [String, nil]
-            optional :source_hash_sha256, String, api_name: :sourceHashSha256, nil?: true
-
-            # @!attribute url
-            #   Where the file lives. Outbound: the URL the customer gave us and the carrier
-            #   fetched. Inbound: the URL the carrier hosts it at, relayed unchanged.
-            #
-            #   @return [String, nil]
-            optional :url, String, nil?: true
-
-            # @!method initialize(media_type: nil, mime_type: nil, size_bytes: nil, source_hash_sha256: nil, url: nil)
-            #   Some parameter documentations has been truncated, see
-            #   {Sentdm::Models::ConversationMessagesList::Message::MessageBody::Media} for more
-            #   details.
-            #
-            #   One attachment on a message, in either direction — and in both, a URL somebody
-            #   else hosts.
-            #
-            #   Outbound: the customer supplied a public URL and we handed it to the carrier.
-            #   Inbound: the carrier hosts the file and we record where. sent.dm never holds the
-            #   bytes, so there is no key, no expiry bookkeeping and nothing minted per read —
-            #   what is stored is what is served.
-            #
-            #   An inbound link expires on the carrier's own schedule and is unauthenticated.
-            #   That is the customer's to manage, and it is documented where they will see it
-            #   rather than only here — a recipient who needs an attachment to outlive that
-            #   window copies it on receipt.
-            #
-            #   Storing a presigned URL is the specific mistake this shape still avoids:
-            #   M260826130000 and M260826140000 exist because RCS assets were stored as signed
-            #   URLs and went stale. Nothing here is signed.
-            #
-            #   @param media_type [String, nil] One of MmsMediaTypes when the content type is known. Advisory — a reader should
-            #
-            #   @param mime_type [String, nil] Content type as the provider declared it. Null when it declared none.
-            #
-            #   @param size_bytes [Integer, nil] Size as the provider declared it. Never measured here — nothing downloads the fi
-            #
-            #   @param source_hash_sha256 [String, nil] Inbound only: the SHA-256 the provider declared alongside the attachment, when i
-            #
-            #   @param url [String, nil] Where the file lives. Outbound: the URL the customer gave us and the carrier fet
-          end
-        end
-      end
     end
   end
 end

data/lib/sentdm/models/entity_type.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    module EntityType
+      extend Sentdm::Internal::Type::Enum
+
+      PRIVATE_PROFIT = :PRIVATE_PROFIT
+      PUBLIC_PROFIT = :PUBLIC_PROFIT
+      NON_PROFIT = :NON_PROFIT
+      SOLE_PROPRIETOR = :SOLE_PROPRIETOR
+      GOVERNMENT = :GOVERNMENT
+
+      # @!method self.values
+      #   @return [Array<Symbol>]
+    end
+  end
+end

data/lib/sentdm/models/inbound_media.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    class InboundMedia < Sentdm::Internal::Type::BaseModel
+      # @!attribute hash_sha256
+      #   SHA-256 of the file as the carrier declared it, when it declares one. Verify
+      #   what you download against this — sent.dm never reads the bytes, so it is the
+      #   only integrity signal available.
+      #
+      #   @return [String, nil]
+      optional :hash_sha256, String, nil?: true
+
+      # @!attribute mime_type
+      #   Content type as the carrier reported it, for example image/jpeg.
+      #
+      #   @return [String, nil]
+      optional :mime_type, String, nil?: true
+
+      # @!attribute size_bytes
+      #   Size in bytes as the carrier declared it. Absent when it declared none.
+      #
+      #   @return [Integer, nil]
+      optional :size_bytes, Integer, nil?: true
+
+      # @!attribute url
+      #   Where the carrier hosts the attachment.
+      #
+      #   This link expires and is not authenticated. sent.dm relays it rather than
+      #   copying the file, so how long it stays fetchable is the carrier's decision and
+      #   differs between them — assume days, not months. Anyone holding the URL can fetch
+      #   it until it lapses. Copy the file on receipt if you need it to outlive that
+      #   window; do not store this URL as a permanent reference.
+      #
+      #   @return [String, nil]
+      optional :url, String, nil?: true
+
+      # @!method initialize(hash_sha256: nil, mime_type: nil, size_bytes: nil, url: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Sentdm::Models::InboundMedia} for more details.
+      #
+      #   One attachment on an inbound message.
+      #
+      #   @param hash_sha256 [String, nil] SHA-256 of the file as the carrier declared it, when it declares one. Verify wha
+      #
+      #   @param mime_type [String, nil] Content type as the carrier reported it, for example image/jpeg.
+      #
+      #   @param size_bytes [Integer, nil] Size in bytes as the carrier declared it. Absent when it declared none.
+      #
+      #   @param url [String, nil] Where the carrier hosts the attachment.
+    end
+  end
+end

data/lib/sentdm/models/inbound_message_event_payload.rb

@@ -39,10 +39,8 @@ module Sentdm
       #   lapses the entry remains with whatever the carrier declared about the file but
       #   the file is no longer reachable.
       #
-      #   @return [Array<Sentdm::Models::InboundMessageEventPayload::Media>, nil]
-      optional :media,
-               -> { Sentdm::Internal::Type::ArrayOf[Sentdm::InboundMessageEventPayload::Media] },
-               nil?: true
+      #   @return [Array<Sentdm::Models::InboundMedia>, nil]
+      optional :media, -> { Sentdm::Internal::Type::ArrayOf[Sentdm::InboundMedia] }, nil?: true
 
       # @!attribute message_id
       #   The inbound message.
@@ -100,7 +98,7 @@ module Sentdm
       #
       #   @param channel [String] The channel the message arrived on, for example sms or mms.
       #
-      #   @param media [Array<Sentdm::Models::InboundMessageEventPayload::Media>, nil] Attachments the contact sent, present only on channels that carry them (mms toda
+      #   @param media [Array<Sentdm::Models::InboundMedia>, nil] Attachments the contact sent, present only on channels that carry them (mms toda
       #
       #   @param message_id [String] The inbound message.
       #
@@ -111,54 +109,6 @@ module Sentdm
       #   @param text [String, nil] The message body. Sent as null when the inbound message carried no text, for
       #
       #   @param updated_at [String] When the message was received, in UTC (yyyy-MM-ddTHH:mm:ssZ). Same value as
-
-      class Media < Sentdm::Internal::Type::BaseModel
-        # @!attribute hash_sha256
-        #   SHA-256 of the file as the carrier declared it, when it declares one. Verify
-        #   what you download against this — sent.dm never reads the bytes, so it is the
-        #   only integrity signal available.
-        #
-        #   @return [String, nil]
-        optional :hash_sha256, String, nil?: true
-
-        # @!attribute mime_type
-        #   Content type as the carrier reported it, for example image/jpeg.
-        #
-        #   @return [String, nil]
-        optional :mime_type, String, nil?: true
-
-        # @!attribute size_bytes
-        #   Size in bytes as the carrier declared it. Absent when it declared none.
-        #
-        #   @return [Integer, nil]
-        optional :size_bytes, Integer, nil?: true
-
-        # @!attribute url
-        #   Where the carrier hosts the attachment.
-        #
-        #   This link expires and is not authenticated. sent.dm relays it rather than
-        #   copying the file, so how long it stays fetchable is the carrier's decision and
-        #   differs between them — assume days, not months. Anyone holding the URL can fetch
-        #   it until it lapses. Copy the file on receipt if you need it to outlive that
-        #   window; do not store this URL as a permanent reference.
-        #
-        #   @return [String, nil]
-        optional :url, String, nil?: true
-
-        # @!method initialize(hash_sha256: nil, mime_type: nil, size_bytes: nil, url: nil)
-        #   Some parameter documentations has been truncated, see
-        #   {Sentdm::Models::InboundMessageEventPayload::Media} for more details.
-        #
-        #   One attachment on an inbound message.
-        #
-        #   @param hash_sha256 [String, nil] SHA-256 of the file as the carrier declared it, when it declares one. Verify wha
-        #
-        #   @param mime_type [String, nil] Content type as the carrier reported it, for example image/jpeg.
-        #
-        #   @param size_bytes [Integer, nil] Size in bytes as the carrier declared it. Absent when it declared none.
-        #
-        #   @param url [String, nil] Where the carrier hosts the attachment.
-      end
     end
   end
 end

data/lib/sentdm/models/link_event.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    class LinkEvent < 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::LinkEventPayload, nil]
+      optional :payload, -> { Sentdm::LinkEventPayload }, 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::LinkEvent} 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::LinkEventPayload, 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
+    end
+  end
+end