sentdm 0.29.0 → 0.31.0

data/rbi/sentdm/models/profiles/campaign_data.rbi

@@ -0,0 +1,158 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    module Profiles
+      class CampaignData < Sentdm::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(Sentdm::Profiles::CampaignData, Sentdm::Internal::AnyHash)
+          end
+
+        # Campaign description
+        sig { returns(String) }
+        attr_accessor :description
+
+        # Campaign name
+        sig { returns(String) }
+        attr_accessor :name
+
+        # 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.
+        sig { returns(String) }
+        attr_accessor :type
+
+        # List of use cases with sample messages
+        sig { returns(T::Array[Sentdm::Profiles::CampaignUseCaseData]) }
+        attr_accessor :use_cases
+
+        # Comma-separated keywords that trigger help message (e.g., "HELP, INFO, SUPPORT")
+        sig { returns(T.nilable(String)) }
+        attr_accessor :help_keywords
+
+        # Message sent when user requests help
+        sig { returns(T.nilable(String)) }
+        attr_accessor :help_message
+
+        # Description of how messages flow in the campaign
+        sig { returns(T.nilable(String)) }
+        attr_accessor :message_flow
+
+        # Comma-separated keywords that trigger opt-in (e.g., "YES, START, SUBSCRIBE")
+        sig { returns(T.nilable(String)) }
+        attr_accessor :optin_keywords
+
+        # Message sent when user opts in
+        sig { returns(T.nilable(String)) }
+        attr_accessor :optin_message
+
+        # Comma-separated keywords that trigger opt-out (e.g., "STOP, UNSUBSCRIBE, END")
+        sig { returns(T.nilable(String)) }
+        attr_accessor :optout_keywords
+
+        # Message sent when user opts out
+        sig { returns(T.nilable(String)) }
+        attr_accessor :optout_message
+
+        # URL to privacy policy
+        sig { returns(T.nilable(String)) }
+        attr_accessor :privacy_policy_link
+
+        # URL to terms and conditions
+        sig { returns(T.nilable(String)) }
+        attr_accessor :terms_and_conditions_link
+
+        # Expected messaging volume for this campaign. Numeric string (e.g. "1999",
+        # "5000"). Values below 2000 bill at the low-volume tier.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :volume
+
+        # Campaign data for create or update operation
+        sig do
+          params(
+            description: String,
+            name: String,
+            type: String,
+            use_cases: T::Array[Sentdm::Profiles::CampaignUseCaseData::OrHash],
+            help_keywords: T.nilable(String),
+            help_message: T.nilable(String),
+            message_flow: T.nilable(String),
+            optin_keywords: T.nilable(String),
+            optin_message: T.nilable(String),
+            optout_keywords: T.nilable(String),
+            optout_message: T.nilable(String),
+            privacy_policy_link: T.nilable(String),
+            terms_and_conditions_link: T.nilable(String),
+            volume: T.nilable(String)
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Campaign description
+          description:,
+          # Campaign name
+          name:,
+          # 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.
+          type:,
+          # List of use cases with sample messages
+          use_cases:,
+          # Comma-separated keywords that trigger help message (e.g., "HELP, INFO, SUPPORT")
+          help_keywords: nil,
+          # Message sent when user requests help
+          help_message: nil,
+          # Description of how messages flow in the campaign
+          message_flow: nil,
+          # Comma-separated keywords that trigger opt-in (e.g., "YES, START, SUBSCRIBE")
+          optin_keywords: nil,
+          # Message sent when user opts in
+          optin_message: nil,
+          # Comma-separated keywords that trigger opt-out (e.g., "STOP, UNSUBSCRIBE, END")
+          optout_keywords: nil,
+          # Message sent when user opts out
+          optout_message: nil,
+          # URL to privacy policy
+          privacy_policy_link: nil,
+          # URL to terms and conditions
+          terms_and_conditions_link: nil,
+          # Expected messaging volume for this campaign. Numeric string (e.g. "1999",
+          # "5000"). Values below 2000 bill at the low-volume tier.
+          volume: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              description: String,
+              name: String,
+              type: String,
+              use_cases: T::Array[Sentdm::Profiles::CampaignUseCaseData],
+              help_keywords: T.nilable(String),
+              help_message: T.nilable(String),
+              message_flow: T.nilable(String),
+              optin_keywords: T.nilable(String),
+              optin_message: T.nilable(String),
+              optout_keywords: T.nilable(String),
+              optout_message: T.nilable(String),
+              privacy_policy_link: T.nilable(String),
+              terms_and_conditions_link: T.nilable(String),
+              volume: T.nilable(String)
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/sentdm/models/profiles/campaign_delete_params.rbi

@@ -3,7 +3,7 @@
 module Sentdm
   module Models
     module Profiles
-      class CampaignDeleteParams < Sentdm::Internal::Type::BaseModel
+      class CampaignDeleteParams < Sentdm::Models::MutationRequest
         extend Sentdm::Internal::Type::RequestParameters::Converter
         include Sentdm::Internal::Type::RequestParameters
 
@@ -21,14 +21,6 @@ module Sentdm
         sig { returns(String) }
         attr_accessor :campaign_id
 
-        # Sandbox flag - when true, the operation is simulated without side effects Useful
-        # for testing integrations without actual execution
-        sig { returns(T.nilable(T::Boolean)) }
-        attr_reader :sandbox
-
-        sig { params(sandbox: T::Boolean).void }
-        attr_writer :sandbox
-
         sig { returns(T.nilable(String)) }
         attr_reader :x_profile_id
 
@@ -39,7 +31,6 @@ module Sentdm
           params(
             profile_id: String,
             campaign_id: String,
-            sandbox: T::Boolean,
             x_profile_id: String,
             request_options: Sentdm::RequestOptions::OrHash
           ).returns(T.attached_class)
@@ -47,9 +38,6 @@ module Sentdm
         def self.new(
           profile_id:,
           campaign_id:,
-          # Sandbox flag - when true, the operation is simulated without side effects Useful
-          # for testing integrations without actual execution
-          sandbox: nil,
           x_profile_id: nil,
           request_options: {}
         )
@@ -60,7 +48,6 @@ module Sentdm
             {
               profile_id: String,
               campaign_id: String,
-              sandbox: T::Boolean,
               x_profile_id: String,
               request_options: Sentdm::RequestOptions
             }

data/rbi/sentdm/models/profiles/campaign_update_params.rbi

@@ -22,14 +22,10 @@ module Sentdm
         attr_accessor :campaign_id
 
         # Campaign data for create or update operation
-        sig { returns(Sentdm::Profiles::CampaignUpdateParams::Campaign) }
+        sig { returns(Sentdm::Profiles::CampaignData) }
         attr_reader :campaign
 
-        sig do
-          params(
-            campaign: Sentdm::Profiles::CampaignUpdateParams::Campaign::OrHash
-          ).void
-        end
+        sig { params(campaign: Sentdm::Profiles::CampaignData::OrHash).void }
         attr_writer :campaign
 
         # Sandbox flag - when true, the operation is simulated without side effects Useful
@@ -56,7 +52,7 @@ module Sentdm
           params(
             profile_id: String,
             campaign_id: String,
-            campaign: Sentdm::Profiles::CampaignUpdateParams::Campaign::OrHash,
+            campaign: Sentdm::Profiles::CampaignData::OrHash,
             sandbox: T::Boolean,
             idempotency_key: String,
             x_profile_id: String,
@@ -82,7 +78,7 @@ module Sentdm
             {
               profile_id: String,
               campaign_id: String,
-              campaign: Sentdm::Profiles::CampaignUpdateParams::Campaign,
+              campaign: Sentdm::Profiles::CampaignData,
               sandbox: T::Boolean,
               idempotency_key: String,
               x_profile_id: String,
@@ -92,216 +88,6 @@ module Sentdm
         end
         def to_hash
         end
-
-        class Campaign < Sentdm::Internal::Type::BaseModel
-          OrHash =
-            T.type_alias do
-              T.any(
-                Sentdm::Profiles::CampaignUpdateParams::Campaign,
-                Sentdm::Internal::AnyHash
-              )
-            end
-
-          # Campaign description
-          sig { returns(String) }
-          attr_accessor :description
-
-          # Campaign name
-          sig { returns(String) }
-          attr_accessor :name
-
-          # 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.
-          sig { returns(String) }
-          attr_accessor :type
-
-          # List of use cases with sample messages
-          sig do
-            returns(
-              T::Array[
-                Sentdm::Profiles::CampaignUpdateParams::Campaign::UseCase
-              ]
-            )
-          end
-          attr_accessor :use_cases
-
-          # Comma-separated keywords that trigger help message (e.g., "HELP, INFO, SUPPORT")
-          sig { returns(T.nilable(String)) }
-          attr_accessor :help_keywords
-
-          # Message sent when user requests help
-          sig { returns(T.nilable(String)) }
-          attr_accessor :help_message
-
-          # Description of how messages flow in the campaign
-          sig { returns(T.nilable(String)) }
-          attr_accessor :message_flow
-
-          # Comma-separated keywords that trigger opt-in (e.g., "YES, START, SUBSCRIBE")
-          sig { returns(T.nilable(String)) }
-          attr_accessor :optin_keywords
-
-          # Message sent when user opts in
-          sig { returns(T.nilable(String)) }
-          attr_accessor :optin_message
-
-          # Comma-separated keywords that trigger opt-out (e.g., "STOP, UNSUBSCRIBE, END")
-          sig { returns(T.nilable(String)) }
-          attr_accessor :optout_keywords
-
-          # Message sent when user opts out
-          sig { returns(T.nilable(String)) }
-          attr_accessor :optout_message
-
-          # URL to privacy policy
-          sig { returns(T.nilable(String)) }
-          attr_accessor :privacy_policy_link
-
-          # URL to terms and conditions
-          sig { returns(T.nilable(String)) }
-          attr_accessor :terms_and_conditions_link
-
-          # Expected messaging volume for this campaign. Numeric string (e.g. "1999",
-          # "5000"). Values below 2000 bill at the low-volume tier.
-          sig { returns(T.nilable(String)) }
-          attr_accessor :volume
-
-          # Campaign data for create or update operation
-          sig do
-            params(
-              description: String,
-              name: String,
-              type: String,
-              use_cases:
-                T::Array[
-                  Sentdm::Profiles::CampaignUpdateParams::Campaign::UseCase::OrHash
-                ],
-              help_keywords: T.nilable(String),
-              help_message: T.nilable(String),
-              message_flow: T.nilable(String),
-              optin_keywords: T.nilable(String),
-              optin_message: T.nilable(String),
-              optout_keywords: T.nilable(String),
-              optout_message: T.nilable(String),
-              privacy_policy_link: T.nilable(String),
-              terms_and_conditions_link: T.nilable(String),
-              volume: T.nilable(String)
-            ).returns(T.attached_class)
-          end
-          def self.new(
-            # Campaign description
-            description:,
-            # Campaign name
-            name:,
-            # 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.
-            type:,
-            # List of use cases with sample messages
-            use_cases:,
-            # Comma-separated keywords that trigger help message (e.g., "HELP, INFO, SUPPORT")
-            help_keywords: nil,
-            # Message sent when user requests help
-            help_message: nil,
-            # Description of how messages flow in the campaign
-            message_flow: nil,
-            # Comma-separated keywords that trigger opt-in (e.g., "YES, START, SUBSCRIBE")
-            optin_keywords: nil,
-            # Message sent when user opts in
-            optin_message: nil,
-            # Comma-separated keywords that trigger opt-out (e.g., "STOP, UNSUBSCRIBE, END")
-            optout_keywords: nil,
-            # Message sent when user opts out
-            optout_message: nil,
-            # URL to privacy policy
-            privacy_policy_link: nil,
-            # URL to terms and conditions
-            terms_and_conditions_link: nil,
-            # Expected messaging volume for this campaign. Numeric string (e.g. "1999",
-            # "5000"). Values below 2000 bill at the low-volume tier.
-            volume: nil
-          )
-          end
-
-          sig do
-            override.returns(
-              {
-                description: String,
-                name: String,
-                type: String,
-                use_cases:
-                  T::Array[
-                    Sentdm::Profiles::CampaignUpdateParams::Campaign::UseCase
-                  ],
-                help_keywords: T.nilable(String),
-                help_message: T.nilable(String),
-                message_flow: T.nilable(String),
-                optin_keywords: T.nilable(String),
-                optin_message: T.nilable(String),
-                optout_keywords: T.nilable(String),
-                optout_message: T.nilable(String),
-                privacy_policy_link: T.nilable(String),
-                terms_and_conditions_link: T.nilable(String),
-                volume: T.nilable(String)
-              }
-            )
-          end
-          def to_hash
-          end
-
-          class UseCase < Sentdm::Internal::Type::BaseModel
-            OrHash =
-              T.type_alias do
-                T.any(
-                  Sentdm::Profiles::CampaignUpdateParams::Campaign::UseCase,
-                  Sentdm::Internal::AnyHash
-                )
-              end
-
-            sig { returns(Sentdm::Profiles::MessagingUseCaseUs::OrSymbol) }
-            attr_accessor :messaging_use_case_us
-
-            # Sample messages for this use case (1-5 messages, max 1024 characters each)
-            sig { returns(T::Array[String]) }
-            attr_accessor :sample_messages
-
-            # Campaign use case with sample messages
-            sig do
-              params(
-                messaging_use_case_us:
-                  Sentdm::Profiles::MessagingUseCaseUs::OrSymbol,
-                sample_messages: T::Array[String]
-              ).returns(T.attached_class)
-            end
-            def self.new(
-              messaging_use_case_us:,
-              # Sample messages for this use case (1-5 messages, max 1024 characters each)
-              sample_messages:
-            )
-            end
-
-            sig do
-              override.returns(
-                {
-                  messaging_use_case_us:
-                    Sentdm::Profiles::MessagingUseCaseUs::OrSymbol,
-                  sample_messages: T::Array[String]
-                }
-              )
-            end
-            def to_hash
-            end
-          end
-        end
       end
     end
   end

data/rbi/sentdm/models/profiles/campaign_use_case.rbi

@@ -0,0 +1,110 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    module Profiles
+      class CampaignUseCase < Sentdm::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(Sentdm::Profiles::CampaignUseCase, Sentdm::Internal::AnyHash)
+          end
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :id
+
+        sig { params(id: String).void }
+        attr_writer :id
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :campaign_id
+
+        sig { params(campaign_id: String).void }
+        attr_writer :campaign_id
+
+        sig { returns(T.nilable(Time)) }
+        attr_reader :created_at
+
+        sig { params(created_at: Time).void }
+        attr_writer :created_at
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :customer_id
+
+        sig { params(customer_id: String).void }
+        attr_writer :customer_id
+
+        sig do
+          returns(T.nilable(Sentdm::Profiles::MessagingUseCaseUs::TaggedSymbol))
+        end
+        attr_reader :messaging_use_case_us
+
+        sig do
+          params(
+            messaging_use_case_us:
+              Sentdm::Profiles::MessagingUseCaseUs::OrSymbol
+          ).void
+        end
+        attr_writer :messaging_use_case_us
+
+        # Sample messages submitted to the registry for this use case.
+        sig { returns(T.nilable(T::Array[String])) }
+        attr_reader :sample_messages
+
+        sig { params(sample_messages: T::Array[String]).void }
+        attr_writer :sample_messages
+
+        sig { returns(T.nilable(Time)) }
+        attr_accessor :updated_at
+
+        # 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.
+        sig do
+          params(
+            id: String,
+            campaign_id: String,
+            created_at: Time,
+            customer_id: String,
+            messaging_use_case_us:
+              Sentdm::Profiles::MessagingUseCaseUs::OrSymbol,
+            sample_messages: T::Array[String],
+            updated_at: T.nilable(Time)
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          id: nil,
+          campaign_id: nil,
+          created_at: nil,
+          customer_id: nil,
+          messaging_use_case_us: nil,
+          # Sample messages submitted to the registry for this use case.
+          sample_messages: nil,
+          updated_at: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              campaign_id: String,
+              created_at: Time,
+              customer_id: String,
+              messaging_use_case_us:
+                Sentdm::Profiles::MessagingUseCaseUs::TaggedSymbol,
+              sample_messages: T::Array[String],
+              updated_at: T.nilable(Time)
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/sentdm/models/profiles/campaign_use_case_data.rbi

@@ -0,0 +1,51 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    module Profiles
+      class CampaignUseCaseData < Sentdm::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Sentdm::Profiles::CampaignUseCaseData,
+              Sentdm::Internal::AnyHash
+            )
+          end
+
+        sig { returns(Sentdm::Profiles::MessagingUseCaseUs::OrSymbol) }
+        attr_accessor :messaging_use_case_us
+
+        # Sample messages for this use case (1-5 messages, max 1024 characters each)
+        sig { returns(T::Array[String]) }
+        attr_accessor :sample_messages
+
+        # Campaign use case with sample messages
+        sig do
+          params(
+            messaging_use_case_us:
+              Sentdm::Profiles::MessagingUseCaseUs::OrSymbol,
+            sample_messages: T::Array[String]
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          messaging_use_case_us:,
+          # Sample messages for this use case (1-5 messages, max 1024 characters each)
+          sample_messages:
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              messaging_use_case_us:
+                Sentdm::Profiles::MessagingUseCaseUs::OrSymbol,
+              sample_messages: T::Array[String]
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end