sentdm 0.32.0 → 0.34.0

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

@@ -54,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
@@ -84,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_create_params.rb

@@ -41,6 +41,13 @@ module Sentdm
       #   @return [Boolean, nil]
       optional :sandbox, Sentdm::Internal::Type::Boolean
 
+      # @!attribute sender_profile
+      #   Request-only: the events an organization webhook's sender profile clones
+      #   receive, one clone per existing and future profile. Responses never return it.
+      #
+      #   @return [Sentdm::Models::WebhookCreateParams::SenderProfile, nil]
+      optional :sender_profile, -> { Sentdm::WebhookCreateParams::SenderProfile }, nil?: true
+
       # @!attribute timeout_seconds
       #
       #   @return [Integer, nil]
@@ -56,7 +63,7 @@ module Sentdm
       #   @return [String, nil]
       optional :x_profile_id, String
 
-      # @!method initialize(display_name: nil, endpoint_url: nil, event_filters: nil, event_types: nil, retry_count: nil, sandbox: nil, timeout_seconds: nil, idempotency_key: nil, x_profile_id: nil, request_options: {})
+      # @!method initialize(display_name: nil, endpoint_url: nil, event_filters: nil, event_types: nil, retry_count: nil, sandbox: nil, sender_profile: nil, timeout_seconds: nil, idempotency_key: nil, x_profile_id: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {Sentdm::Models::WebhookCreateParams} for more details.
       #
@@ -72,6 +79,8 @@ module Sentdm
       #
       #   @param sandbox [Boolean] Sandbox flag - when true, the operation is simulated without side effects
       #
+      #   @param sender_profile [Sentdm::Models::WebhookCreateParams::SenderProfile, nil] Request-only: the events an organization webhook's sender profile clones receive
+      #
       #   @param timeout_seconds [Integer]
       #
       #   @param idempotency_key [String]
@@ -79,6 +88,27 @@ module Sentdm
       #   @param x_profile_id [String]
       #
       #   @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}]
+
+      class SenderProfile < Sentdm::Internal::Type::BaseModel
+        # @!attribute event_filters
+        #
+        #   @return [Hash{Symbol=>Array<String>}, nil]
+        optional :event_filters,
+                 Sentdm::Internal::Type::HashOf[Sentdm::Internal::Type::ArrayOf[String]],
+                 nil?: true
+
+        # @!attribute event_types
+        #
+        #   @return [Array<String>, nil]
+        optional :event_types, Sentdm::Internal::Type::ArrayOf[String]
+
+        # @!method initialize(event_filters: nil, event_types: nil)
+        #   Request-only: the events an organization webhook's sender profile clones
+        #   receive, one clone per existing and future profile. Responses never return it.
+        #
+        #   @param event_filters [Hash{Symbol=>Array<String>}, nil]
+        #   @param event_types [Array<String>]
+      end
     end
   end
 end