sentdm 0.24.0 → 0.26.0

data/rbi/sentdm/models/profiles/brand_campaign.rbi

@@ -0,0 +1,299 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    module Profiles
+      class BrandCampaign < Sentdm::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(Sentdm::Profiles::BrandCampaign, Sentdm::Internal::AnyHash)
+          end
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :id
+
+        sig { params(id: String).void }
+        attr_writer :id
+
+        sig { returns(T.nilable(Time)) }
+        attr_accessor :billed_date
+
+        sig { returns(T.nilable(String)) }
+        attr_accessor :brand_id
+
+        sig { returns(T.nilable(Float)) }
+        attr_accessor :cost
+
+        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
+
+        # True once every carrier has completed its DCA election and the campaign is
+        # operationally ready for traffic.
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_accessor :dca_elections_complete
+
+        sig { returns(T.nilable(Time)) }
+        attr_accessor :dca_elections_completed_at
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :description
+
+        sig { params(description: String).void }
+        attr_writer :description
+
+        # True when the one-time campaign submission fee has already been charged.
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :has_submission_transaction
+
+        sig { params(has_submission_transaction: T::Boolean).void }
+        attr_writer :has_submission_transaction
+
+        sig { returns(T.nilable(String)) }
+        attr_accessor :help_keywords
+
+        sig { returns(T.nilable(String)) }
+        attr_accessor :help_message
+
+        sig { returns(T.nilable(String)) }
+        attr_accessor :message_flow
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :name
+
+        sig { params(name: String).void }
+        attr_writer :name
+
+        sig { returns(T.nilable(String)) }
+        attr_accessor :optin_keywords
+
+        sig { returns(T.nilable(String)) }
+        attr_accessor :optin_message
+
+        sig { returns(T.nilable(String)) }
+        attr_accessor :optout_keywords
+
+        sig { returns(T.nilable(String)) }
+        attr_accessor :optout_message
+
+        sig { returns(T.nilable(String)) }
+        attr_accessor :privacy_policy_link
+
+        sig do
+          returns(
+            T.nilable(Sentdm::Profiles::BrandCampaign::Status::TaggedSymbol)
+          )
+        end
+        attr_accessor :status
+
+        sig { returns(T.nilable(Time)) }
+        attr_accessor :submitted_at
+
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :submitted_to_tcr
+
+        sig { params(submitted_to_tcr: T::Boolean).void }
+        attr_writer :submitted_to_tcr
+
+        # The Campaign Registry identifier, once the campaign has been accepted.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :tcr_campaign_id
+
+        # Surfaced so customers can see why a submission did not reach the registry.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :tcr_sync_error
+
+        sig { returns(T.nilable(String)) }
+        attr_accessor :terms_and_conditions_link
+
+        # Campaign type (for example KYC or App).
+        sig { returns(T.nilable(String)) }
+        attr_reader :type
+
+        sig { params(type: String).void }
+        attr_writer :type
+
+        sig { returns(T.nilable(Time)) }
+        attr_accessor :updated_at
+
+        sig { returns(T.nilable(T::Array[Sentdm::Profiles::CampaignUseCase])) }
+        attr_reader :use_cases
+
+        sig do
+          params(
+            use_cases: T::Array[Sentdm::Profiles::CampaignUseCase::OrHash]
+          ).void
+        end
+        attr_writer :use_cases
+
+        # Expected messaging volume for this campaign — customer-supplied on
+        # create/update, and the input to both the TCR usecase classification (LOW_VOLUME
+        # vs MIXED/specific) and the campaign fee tier. Surfaced so customers can read
+        # back the value they set.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :volume
+
+        # A 10DLC campaign registered for a brand.
+        sig do
+          params(
+            id: String,
+            billed_date: T.nilable(Time),
+            brand_id: T.nilable(String),
+            cost: T.nilable(Float),
+            created_at: Time,
+            customer_id: String,
+            dca_elections_complete: T.nilable(T::Boolean),
+            dca_elections_completed_at: T.nilable(Time),
+            description: String,
+            has_submission_transaction: T::Boolean,
+            help_keywords: T.nilable(String),
+            help_message: T.nilable(String),
+            message_flow: T.nilable(String),
+            name: 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),
+            status:
+              T.nilable(Sentdm::Profiles::BrandCampaign::Status::OrSymbol),
+            submitted_at: T.nilable(Time),
+            submitted_to_tcr: T::Boolean,
+            tcr_campaign_id: T.nilable(String),
+            tcr_sync_error: T.nilable(String),
+            terms_and_conditions_link: T.nilable(String),
+            type: String,
+            updated_at: T.nilable(Time),
+            use_cases: T::Array[Sentdm::Profiles::CampaignUseCase::OrHash],
+            volume: T.nilable(String)
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          id: nil,
+          billed_date: nil,
+          brand_id: nil,
+          cost: nil,
+          created_at: nil,
+          customer_id: nil,
+          # True once every carrier has completed its DCA election and the campaign is
+          # operationally ready for traffic.
+          dca_elections_complete: nil,
+          dca_elections_completed_at: nil,
+          description: nil,
+          # True when the one-time campaign submission fee has already been charged.
+          has_submission_transaction: nil,
+          help_keywords: nil,
+          help_message: nil,
+          message_flow: nil,
+          name: nil,
+          optin_keywords: nil,
+          optin_message: nil,
+          optout_keywords: nil,
+          optout_message: nil,
+          privacy_policy_link: nil,
+          status: nil,
+          submitted_at: nil,
+          submitted_to_tcr: nil,
+          # The Campaign Registry identifier, once the campaign has been accepted.
+          tcr_campaign_id: nil,
+          # Surfaced so customers can see why a submission did not reach the registry.
+          tcr_sync_error: nil,
+          terms_and_conditions_link: nil,
+          # Campaign type (for example KYC or App).
+          type: nil,
+          updated_at: nil,
+          use_cases: nil,
+          # Expected messaging volume for this campaign — customer-supplied on
+          # create/update, and the input to both the TCR usecase classification (LOW_VOLUME
+          # vs MIXED/specific) and the campaign fee tier. Surfaced so customers can read
+          # back the value they set.
+          volume: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              billed_date: T.nilable(Time),
+              brand_id: T.nilable(String),
+              cost: T.nilable(Float),
+              created_at: Time,
+              customer_id: String,
+              dca_elections_complete: T.nilable(T::Boolean),
+              dca_elections_completed_at: T.nilable(Time),
+              description: String,
+              has_submission_transaction: T::Boolean,
+              help_keywords: T.nilable(String),
+              help_message: T.nilable(String),
+              message_flow: T.nilable(String),
+              name: 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),
+              status:
+                T.nilable(
+                  Sentdm::Profiles::BrandCampaign::Status::TaggedSymbol
+                ),
+              submitted_at: T.nilable(Time),
+              submitted_to_tcr: T::Boolean,
+              tcr_campaign_id: T.nilable(String),
+              tcr_sync_error: T.nilable(String),
+              terms_and_conditions_link: T.nilable(String),
+              type: String,
+              updated_at: T.nilable(Time),
+              use_cases: T::Array[Sentdm::Profiles::CampaignUseCase],
+              volume: T.nilable(String)
+            }
+          )
+        end
+        def to_hash
+        end
+
+        module Status
+          extend Sentdm::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(Symbol, Sentdm::Profiles::BrandCampaign::Status)
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          SENT_CREATED =
+            T.let(
+              :SENT_CREATED,
+              Sentdm::Profiles::BrandCampaign::Status::TaggedSymbol
+            )
+          ACTIVE =
+            T.let(
+              :ACTIVE,
+              Sentdm::Profiles::BrandCampaign::Status::TaggedSymbol
+            )
+          EXPIRED =
+            T.let(
+              :EXPIRED,
+              Sentdm::Profiles::BrandCampaign::Status::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[Sentdm::Profiles::BrandCampaign::Status::TaggedSymbol]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -22,13 +22,7 @@ module Sentdm
         attr_accessor :type
 
         # List of use cases with sample messages
-        sig do
-          returns(
-            T::Array[
-              Sentdm::Profiles::SentDmServicesEndpointsCustomerApIv3ContractsRequestsCampaignsCampaignUseCaseData
-            ]
-          )
-        end
+        sig { returns(T::Array[Sentdm::Profiles::CampaignUseCaseData]) }
         attr_accessor :use_cases
 
         # Comma-separated keywords that trigger help message (e.g., "HELP, INFO, SUPPORT")
@@ -67,16 +61,18 @@ module Sentdm
         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::SentDmServicesEndpointsCustomerApIv3ContractsRequestsCampaignsCampaignUseCaseData::OrHash
-              ],
+            use_cases: T::Array[Sentdm::Profiles::CampaignUseCaseData::OrHash],
             help_keywords: T.nilable(String),
             help_message: T.nilable(String),
             message_flow: T.nilable(String),
@@ -85,7 +81,8 @@ module Sentdm
             optout_keywords: T.nilable(String),
             optout_message: T.nilable(String),
             privacy_policy_link: T.nilable(String),
-            terms_and_conditions_link: T.nilable(String)
+            terms_and_conditions_link: T.nilable(String),
+            volume: T.nilable(String)
           ).returns(T.attached_class)
         end
         def self.new(
@@ -114,7 +111,10 @@ module Sentdm
           # URL to privacy policy
           privacy_policy_link: nil,
           # URL to terms and conditions
-          terms_and_conditions_link: nil
+          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
 
@@ -124,10 +124,7 @@ module Sentdm
               description: String,
               name: String,
               type: String,
-              use_cases:
-                T::Array[
-                  Sentdm::Profiles::SentDmServicesEndpointsCustomerApIv3ContractsRequestsCampaignsCampaignUseCaseData
-                ],
+              use_cases: T::Array[Sentdm::Profiles::CampaignUseCaseData],
               help_keywords: T.nilable(String),
               help_message: T.nilable(String),
               message_flow: T.nilable(String),
@@ -136,7 +133,8 @@ module Sentdm
               optout_keywords: T.nilable(String),
               optout_message: T.nilable(String),
               privacy_policy_link: T.nilable(String),
-              terms_and_conditions_link: T.nilable(String)
+              terms_and_conditions_link: T.nilable(String),
+              volume: T.nilable(String)
             }
           )
         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/{sent_dm_services_endpoints_customer_ap_iv3_contracts_requests_campaigns_campaign_use_case_data.rbi → campaign_use_case_data.rbi}

@@ -3,11 +3,11 @@
 module Sentdm
   module Models
     module Profiles
-      class SentDmServicesEndpointsCustomerApIv3ContractsRequestsCampaignsCampaignUseCaseData < Sentdm::Internal::Type::BaseModel
+      class CampaignUseCaseData < Sentdm::Internal::Type::BaseModel
         OrHash =
           T.type_alias do
             T.any(
-              Sentdm::Profiles::SentDmServicesEndpointsCustomerApIv3ContractsRequestsCampaignsCampaignUseCaseData,
+              Sentdm::Profiles::CampaignUseCaseData,
               Sentdm::Internal::AnyHash
             )
           end

data/rbi/sentdm/models/{sent_dm_services_common_contracts_poc_os_template_body.rbi → template_body.rbi}

@@ -2,14 +2,9 @@
 
 module Sentdm
   module Models
-    class SentDmServicesCommonContractsPocOsTemplateBody < Sentdm::Internal::Type::BaseModel
+    class TemplateBody < Sentdm::Internal::Type::BaseModel
       OrHash =
-        T.type_alias do
-          T.any(
-            Sentdm::SentDmServicesCommonContractsPocOsTemplateBody,
-            Sentdm::Internal::AnyHash
-          )
-        end
+        T.type_alias { T.any(Sentdm::TemplateBody, Sentdm::Internal::AnyHash) }
 
       # Content that will be used for all channels (SMS and WhatsApp) unless
       # channel-specific content is provided

data/rbi/sentdm/models/{sent_dm_services_common_contracts_poc_os_template_button.rbi → template_button.rbi}

@@ -2,27 +2,17 @@
 
 module Sentdm
   module Models
-    class SentDmServicesCommonContractsPocOsTemplateButton < Sentdm::Internal::Type::BaseModel
+    class TemplateButton < Sentdm::Internal::Type::BaseModel
       OrHash =
         T.type_alias do
-          T.any(
-            Sentdm::SentDmServicesCommonContractsPocOsTemplateButton,
-            Sentdm::Internal::AnyHash
-          )
+          T.any(Sentdm::TemplateButton, Sentdm::Internal::AnyHash)
         end
 
       # Properties specific to the button type
-      sig do
-        returns(Sentdm::SentDmServicesCommonContractsPocOsTemplateButtonProps)
-      end
+      sig { returns(Sentdm::TemplateButtonProps) }
       attr_reader :props
 
-      sig do
-        params(
-          props:
-            Sentdm::SentDmServicesCommonContractsPocOsTemplateButtonProps::OrHash
-        ).void
-      end
+      sig { params(props: Sentdm::TemplateButtonProps::OrHash).void }
       attr_writer :props
 
       # The type of button (e.g., QUICK_REPLY, URL, PHONE_NUMBER, VOICE_CALL, COPY_CODE)
@@ -39,8 +29,7 @@ module Sentdm
       # Interactive button in a message template
       sig do
         params(
-          props:
-            Sentdm::SentDmServicesCommonContractsPocOsTemplateButtonProps::OrHash,
+          props: Sentdm::TemplateButtonProps::OrHash,
           type: String,
           id: Integer
         ).returns(T.attached_class)
@@ -57,12 +46,7 @@ module Sentdm
 
       sig do
         override.returns(
-          {
-            props:
-              Sentdm::SentDmServicesCommonContractsPocOsTemplateButtonProps,
-            type: String,
-            id: Integer
-          }
+          { props: Sentdm::TemplateButtonProps, type: String, id: Integer }
         )
       end
       def to_hash

data/rbi/sentdm/models/{sent_dm_services_common_contracts_poc_os_template_button_props.rbi → template_button_props.rbi}

@@ -2,13 +2,10 @@
 
 module Sentdm
   module Models
-    class SentDmServicesCommonContractsPocOsTemplateButtonProps < Sentdm::Internal::Type::BaseModel
+    class TemplateButtonProps < Sentdm::Internal::Type::BaseModel
       OrHash =
         T.type_alias do
-          T.any(
-            Sentdm::SentDmServicesCommonContractsPocOsTemplateButtonProps,
-            Sentdm::Internal::AnyHash
-          )
+          T.any(Sentdm::TemplateButtonProps, Sentdm::Internal::AnyHash)
         end
 
       sig { returns(Integer) }