sentdm 0.28.0 → 0.30.0

data/lib/sentdm/models/profiles/campaign_update_params.rb

@@ -21,8 +21,8 @@ module Sentdm
         # @!attribute campaign
         #   Campaign data for create or update operation
         #
-        #   @return [Sentdm::Models::Profiles::CampaignUpdateParams::Campaign]
-        required :campaign, -> { Sentdm::Profiles::CampaignUpdateParams::Campaign }
+        #   @return [Sentdm::Models::Profiles::CampaignData]
+        required :campaign, -> { Sentdm::Profiles::CampaignData }
 
         # @!attribute sandbox
         #   Sandbox flag - when true, the operation is simulated without side effects Useful
@@ -49,7 +49,7 @@ module Sentdm
         #
         #   @param campaign_id [String]
         #
-        #   @param campaign [Sentdm::Models::Profiles::CampaignUpdateParams::Campaign] Campaign data for create or update operation
+        #   @param campaign [Sentdm::Models::Profiles::CampaignData] Campaign data for create or update operation
         #
         #   @param sandbox [Boolean] Sandbox flag - when true, the operation is simulated without side effects
         #
@@ -58,159 +58,6 @@ module Sentdm
         #   @param x_profile_id [String]
         #
         #   @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}]
-
-        class Campaign < Sentdm::Internal::Type::BaseModel
-          # @!attribute description
-          #   Campaign description
-          #
-          #   @return [String]
-          required :description, String
-
-          # @!attribute name
-          #   Campaign name
-          #
-          #   @return [String]
-          required :name, String
-
-          # @!attribute type
-          #   Campaign type (e.g., "KYC", "App").
-          #
-          #   Still required of a caller, and consulted by nothing. It named the signup path
-          #   that produced the campaign, was written to a column no query filters on, no TCR
-          #   payload carries and no fee or status decision reads, and is now defaulted at the
-          #   entity instead. It stays required so that a request which was valid before is
-          #   still valid — dropping it would be the client-visible change, not keeping it.
-          #
-          #   @return [String]
-          required :type, String
-
-          # @!attribute use_cases
-          #   List of use cases with sample messages
-          #
-          #   @return [Array<Sentdm::Models::Profiles::CampaignUpdateParams::Campaign::UseCase>]
-          required :use_cases,
-                   -> {
-                     Sentdm::Internal::Type::ArrayOf[Sentdm::Profiles::CampaignUpdateParams::Campaign::UseCase]
-                   },
-                   api_name: :useCases
-
-          # @!attribute help_keywords
-          #   Comma-separated keywords that trigger help message (e.g., "HELP, INFO, SUPPORT")
-          #
-          #   @return [String, nil]
-          optional :help_keywords, String, api_name: :helpKeywords, nil?: true
-
-          # @!attribute help_message
-          #   Message sent when user requests help
-          #
-          #   @return [String, nil]
-          optional :help_message, String, api_name: :helpMessage, nil?: true
-
-          # @!attribute message_flow
-          #   Description of how messages flow in the campaign
-          #
-          #   @return [String, nil]
-          optional :message_flow, String, api_name: :messageFlow, nil?: true
-
-          # @!attribute optin_keywords
-          #   Comma-separated keywords that trigger opt-in (e.g., "YES, START, SUBSCRIBE")
-          #
-          #   @return [String, nil]
-          optional :optin_keywords, String, api_name: :optinKeywords, nil?: true
-
-          # @!attribute optin_message
-          #   Message sent when user opts in
-          #
-          #   @return [String, nil]
-          optional :optin_message, String, api_name: :optinMessage, nil?: true
-
-          # @!attribute optout_keywords
-          #   Comma-separated keywords that trigger opt-out (e.g., "STOP, UNSUBSCRIBE, END")
-          #
-          #   @return [String, nil]
-          optional :optout_keywords, String, api_name: :optoutKeywords, nil?: true
-
-          # @!attribute optout_message
-          #   Message sent when user opts out
-          #
-          #   @return [String, nil]
-          optional :optout_message, String, api_name: :optoutMessage, nil?: true
-
-          # @!attribute privacy_policy_link
-          #   URL to privacy policy
-          #
-          #   @return [String, nil]
-          optional :privacy_policy_link, String, api_name: :privacyPolicyLink, nil?: true
-
-          # @!attribute terms_and_conditions_link
-          #   URL to terms and conditions
-          #
-          #   @return [String, nil]
-          optional :terms_and_conditions_link, String, api_name: :termsAndConditionsLink, nil?: true
-
-          # @!attribute volume
-          #   Expected messaging volume for this campaign. Numeric string (e.g. "1999",
-          #   "5000"). Values below 2000 bill at the low-volume tier.
-          #
-          #   @return [String, nil]
-          optional :volume, String, nil?: true
-
-          # @!method initialize(description:, name:, type:, use_cases:, help_keywords: nil, help_message: nil, message_flow: nil, optin_keywords: nil, optin_message: nil, optout_keywords: nil, optout_message: nil, privacy_policy_link: nil, terms_and_conditions_link: nil, volume: nil)
-          #   Some parameter documentations has been truncated, see
-          #   {Sentdm::Models::Profiles::CampaignUpdateParams::Campaign} for more details.
-          #
-          #   Campaign data for create or update operation
-          #
-          #   @param description [String] Campaign description
-          #
-          #   @param name [String] Campaign name
-          #
-          #   @param type [String] Campaign type (e.g., "KYC", "App").
-          #
-          #   @param use_cases [Array<Sentdm::Models::Profiles::CampaignUpdateParams::Campaign::UseCase>] List of use cases with sample messages
-          #
-          #   @param help_keywords [String, nil] Comma-separated keywords that trigger help message (e.g., "HELP, INFO, SUPPORT")
-          #
-          #   @param help_message [String, nil] Message sent when user requests help
-          #
-          #   @param message_flow [String, nil] Description of how messages flow in the campaign
-          #
-          #   @param optin_keywords [String, nil] Comma-separated keywords that trigger opt-in (e.g., "YES, START, SUBSCRIBE")
-          #
-          #   @param optin_message [String, nil] Message sent when user opts in
-          #
-          #   @param optout_keywords [String, nil] Comma-separated keywords that trigger opt-out (e.g., "STOP, UNSUBSCRIBE, END")
-          #
-          #   @param optout_message [String, nil] Message sent when user opts out
-          #
-          #   @param privacy_policy_link [String, nil] URL to privacy policy
-          #
-          #   @param terms_and_conditions_link [String, nil] URL to terms and conditions
-          #
-          #   @param volume [String, nil] Expected messaging volume for this campaign. Numeric string (e.g. "1999", "5000"
-
-          class UseCase < Sentdm::Internal::Type::BaseModel
-            # @!attribute messaging_use_case_us
-            #
-            #   @return [Symbol, Sentdm::Models::Profiles::MessagingUseCaseUs]
-            required :messaging_use_case_us,
-                     enum: -> { Sentdm::Profiles::MessagingUseCaseUs },
-                     api_name: :messagingUseCaseUs
-
-            # @!attribute sample_messages
-            #   Sample messages for this use case (1-5 messages, max 1024 characters each)
-            #
-            #   @return [Array<String>]
-            required :sample_messages, Sentdm::Internal::Type::ArrayOf[String], api_name: :sampleMessages
-
-            # @!method initialize(messaging_use_case_us:, sample_messages:)
-            #   Campaign use case with sample messages
-            #
-            #   @param messaging_use_case_us [Symbol, Sentdm::Models::Profiles::MessagingUseCaseUs]
-            #
-            #   @param sample_messages [Array<String>] Sample messages for this use case (1-5 messages, max 1024 characters each)
-          end
-        end
       end
     end
   end

data/lib/sentdm/models/profiles/campaign_use_case.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    module Profiles
+      class CampaignUseCase < Sentdm::Internal::Type::BaseModel
+        # @!attribute id
+        #
+        #   @return [String, nil]
+        optional :id, String
+
+        # @!attribute campaign_id
+        #
+        #   @return [String, nil]
+        optional :campaign_id, String, api_name: :campaignId
+
+        # @!attribute created_at
+        #
+        #   @return [Time, nil]
+        optional :created_at, Time, api_name: :createdAt
+
+        # @!attribute customer_id
+        #
+        #   @return [String, nil]
+        optional :customer_id, String, api_name: :customerId
+
+        # @!attribute messaging_use_case_us
+        #
+        #   @return [Symbol, Sentdm::Models::Profiles::MessagingUseCaseUs, nil]
+        optional :messaging_use_case_us,
+                 enum: -> { Sentdm::Profiles::MessagingUseCaseUs },
+                 api_name: :messagingUseCaseUs
+
+        # @!attribute sample_messages
+        #   Sample messages submitted to the registry for this use case.
+        #
+        #   @return [Array<String>, nil]
+        optional :sample_messages, Sentdm::Internal::Type::ArrayOf[String], api_name: :sampleMessages
+
+        # @!attribute updated_at
+        #
+        #   @return [Time, nil]
+        optional :updated_at, Time, api_name: :updatedAt, nil?: true
+
+        # @!method initialize(id: nil, campaign_id: nil, created_at: nil, customer_id: nil, messaging_use_case_us: nil, sample_messages: nil, updated_at: nil)
+        #   Customer-facing use-case representation for the public v3 campaign contract.
+        #   Exists for the same reason as BrandCampaignV3Response: nesting the
+        #   TcrCampaignUseCase database entity in a public response means any column added
+        #   to that table silently becomes part of the customer-facing contract. This DTO is
+        #   an explicit allowlist, so a new column stays invisible until it is added here on
+        #   purpose. This mirrors exactly the fields the entity already serialized, so it
+        #   removes nothing from the current response shape. It only closes the future-leak
+        #   path.
+        #
+        #   @param id [String]
+        #
+        #   @param campaign_id [String]
+        #
+        #   @param created_at [Time]
+        #
+        #   @param customer_id [String]
+        #
+        #   @param messaging_use_case_us [Symbol, Sentdm::Models::Profiles::MessagingUseCaseUs]
+        #
+        #   @param sample_messages [Array<String>] Sample messages submitted to the registry for this use case.
+        #
+        #   @param updated_at [Time, nil]
+      end
+    end
+  end
+end

data/lib/sentdm/models/profiles/campaign_use_case_data.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    module Profiles
+      class CampaignUseCaseData < Sentdm::Internal::Type::BaseModel
+        # @!attribute messaging_use_case_us
+        #
+        #   @return [Symbol, Sentdm::Models::Profiles::MessagingUseCaseUs]
+        required :messaging_use_case_us,
+                 enum: -> { Sentdm::Profiles::MessagingUseCaseUs },
+                 api_name: :messagingUseCaseUs
+
+        # @!attribute sample_messages
+        #   Sample messages for this use case (1-5 messages, max 1024 characters each)
+        #
+        #   @return [Array<String>]
+        required :sample_messages, Sentdm::Internal::Type::ArrayOf[String], api_name: :sampleMessages
+
+        # @!method initialize(messaging_use_case_us:, sample_messages:)
+        #   Campaign use case with sample messages
+        #
+        #   @param messaging_use_case_us [Symbol, Sentdm::Models::Profiles::MessagingUseCaseUs]
+        #
+        #   @param sample_messages [Array<String>] Sample messages for this use case (1-5 messages, max 1024 characters each)
+      end
+    end
+  end
+end

data/lib/sentdm/models/template.rb

@@ -0,0 +1,102 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    class Template < Sentdm::Internal::Type::BaseModel
+      # @!attribute customer_id
+      #   Which customer owns this — the key's own, or the profile named in x-profile-id.
+      #   Says whose resource this is, which the resource's own id does not.
+      #
+      #   @return [String]
+      required :customer_id, String
+
+      # @!attribute id
+      #   Unique template identifier
+      #
+      #   @return [String, nil]
+      optional :id, String
+
+      # @!attribute category
+      #   Template category: MARKETING, UTILITY, AUTHENTICATION
+      #
+      #   @return [String, nil]
+      optional :category, String
+
+      # @!attribute channels
+      #   Supported channels: sms, whatsapp
+      #
+      #   @return [Array<String>, nil]
+      optional :channels, Sentdm::Internal::Type::ArrayOf[String], nil?: true
+
+      # @!attribute created_at
+      #   When the template was created
+      #
+      #   @return [Time, nil]
+      optional :created_at, Time
+
+      # @!attribute is_published
+      #   Whether the template is published and active
+      #
+      #   @return [Boolean, nil]
+      optional :is_published, Sentdm::Internal::Type::Boolean
+
+      # @!attribute language
+      #   Template language code (e.g., en_US)
+      #
+      #   @return [String, nil]
+      optional :language, String
+
+      # @!attribute name
+      #   Template display name
+      #
+      #   @return [String, nil]
+      optional :name, String
+
+      # @!attribute status
+      #   Template status: APPROVED, PENDING, REJECTED
+      #
+      #   @return [String, nil]
+      optional :status, String
+
+      # @!attribute updated_at
+      #   When the template was last updated
+      #
+      #   @return [Time, nil]
+      optional :updated_at, Time, nil?: true
+
+      # @!attribute variables
+      #   Template variables for personalization
+      #
+      #   @return [Array<String>, nil]
+      optional :variables, Sentdm::Internal::Type::ArrayOf[String], nil?: true
+
+      # @!method initialize(customer_id:, id: nil, category: nil, channels: nil, created_at: nil, is_published: nil, language: nil, name: nil, status: nil, updated_at: nil, variables: nil)
+      #   Some parameter documentations has been truncated, see {Sentdm::Models::Template}
+      #   for more details.
+      #
+      #   Template response for v3 API
+      #
+      #   @param customer_id [String] Which customer owns this — the key's own, or the profile named in x-profile-id.
+      #
+      #   @param id [String] Unique template identifier
+      #
+      #   @param category [String] Template category: MARKETING, UTILITY, AUTHENTICATION
+      #
+      #   @param channels [Array<String>, nil] Supported channels: sms, whatsapp
+      #
+      #   @param created_at [Time] When the template was created
+      #
+      #   @param is_published [Boolean] Whether the template is published and active
+      #
+      #   @param language [String] Template language code (e.g., en_US)
+      #
+      #   @param name [String] Template display name
+      #
+      #   @param status [String] Template status: APPROVED, PENDING, REJECTED
+      #
+      #   @param updated_at [Time, nil] When the template was last updated
+      #
+      #   @param variables [Array<String>, nil] Template variables for personalization
+    end
+  end
+end

data/lib/sentdm/models/template_event_payload.rb

@@ -3,6 +3,19 @@
 module Sentdm
   module Models
     class TemplateEventPayload < Sentdm::Internal::Type::BaseModel
+      # @!attribute status
+      #   The review status the template just reached, for example APPROVED or REJECTED.
+      #
+      #   @return [String]
+      required :status, String
+
+      # @!attribute whatsapp_template_id
+      #   The template's identifier with Meta, assigned when the template is submitted for
+      #   review.
+      #
+      #   @return [String]
+      required :whatsapp_template_id, String
+
       # @!attribute account_id
       #   The account the template belongs to.
       #
@@ -34,12 +47,6 @@ module Sentdm
       #   @return [String, nil]
       optional :reason, String, nil?: true
 
-      # @!attribute status
-      #   The review status the template just reached, for example APPROVED or REJECTED.
-      #
-      #   @return [String, nil]
-      optional :status, String
-
       # @!attribute template_id
       #   The template in Sent.
       #
@@ -52,20 +59,17 @@ module Sentdm
       #   @return [String, nil]
       optional :template_name, String
 
-      # @!attribute whatsapp_template_id
-      #   The template's identifier with Meta, assigned when the template is submitted for
-      #   review.
-      #
-      #   @return [String, nil]
-      optional :whatsapp_template_id, String
-
-      # @!method initialize(account_id: nil, category: nil, channel: nil, language: nil, reason: nil, status: nil, template_id: nil, template_name: nil, whatsapp_template_id: nil)
+      # @!method initialize(status:, whatsapp_template_id:, account_id: 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.
       #
       #   Body of a template status event. Delivered when a template's review outcome
       #   changes, so you can react without polling.
       #
+      #   @param status [String] The review status the template just reached, for example APPROVED or
+      #
+      #   @param whatsapp_template_id [String] The template's identifier with Meta, assigned when the template is submitted for
+      #
       #   @param account_id [String] The account the template belongs to.
       #
       #   @param category [String] The template's category, for example UTILITY, MARKETING, or
@@ -76,13 +80,9 @@ module Sentdm
       #
       #   @param reason [String, nil] Why the template reached Status, when a reason was given. Populated on a
       #
-      #   @param status [String] The review status the template just reached, for example APPROVED or
-      #
       #   @param template_id [String] The template in Sent.
       #
       #   @param template_name [String] The template's display name.
-      #
-      #   @param whatsapp_template_id [String] The template's identifier with Meta, assigned when the template is submitted for
     end
   end
 end