sentdm 0.5.0 → 0.8.0

data/rbi/sentdm/models/profiles/api_response_of_tcr_campaign_with_use_cases.rbi

@@ -23,14 +23,14 @@ module Sentdm
         end
         attr_writer :data
 
-        # Error details (null if successful)
+        # Error information
         sig { returns(T.nilable(Sentdm::APIError)) }
         attr_reader :error
 
         sig { params(error: T.nilable(Sentdm::APIError::OrHash)).void }
         attr_writer :error
 
-        # Metadata about the request and response
+        # Request and response metadata
         sig { returns(T.nilable(Sentdm::APIMeta)) }
         attr_reader :meta
 
@@ -56,9 +56,9 @@ module Sentdm
         def self.new(
           # The response data (null if error)
           data: nil,
-          # Error details (null if successful)
+          # Error information
           error: nil,
-          # Metadata about the request and response
+          # Request and response metadata
           meta: nil,
           # Indicates whether the request was successful
           success: nil

data/rbi/sentdm/models/profiles/base_dto.rbi

@@ -0,0 +1,53 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    module Profiles
+      class BaseDto < Sentdm::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(Sentdm::Profiles::BaseDto, Sentdm::Internal::AnyHash)
+          end
+
+        # Unique identifier
+        sig { returns(T.nilable(String)) }
+        attr_reader :id
+
+        sig { params(id: String).void }
+        attr_writer :id
+
+        sig { returns(T.nilable(Time)) }
+        attr_reader :created_at
+
+        sig { params(created_at: Time).void }
+        attr_writer :created_at
+
+        sig { returns(T.nilable(Time)) }
+        attr_accessor :updated_at
+
+        sig do
+          params(
+            id: String,
+            created_at: Time,
+            updated_at: T.nilable(Time)
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Unique identifier
+          id: nil,
+          created_at: nil,
+          updated_at: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            { id: String, created_at: Time, updated_at: T.nilable(Time) }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/sentdm/models/profiles/campaign_create_params.rbi

@@ -18,7 +18,7 @@ module Sentdm
         sig { returns(String) }
         attr_accessor :profile_id
 
-        # Campaign data
+        # Campaign data for create or update operation
         sig { returns(Sentdm::Profiles::CampaignData) }
         attr_reader :campaign
 
@@ -57,7 +57,7 @@ module Sentdm
         end
         def self.new(
           profile_id:,
-          # Campaign data
+          # Campaign data for create or update operation
           campaign:,
           # Sandbox flag - when true, the operation is simulated without side effects Useful
           # for testing integrations without actual execution

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

@@ -22,7 +22,13 @@ module Sentdm
         attr_accessor :type
 
         # List of use cases with sample messages
-        sig { returns(T::Array[Sentdm::Profiles::CampaignData::UseCase]) }
+        sig do
+          returns(
+            T::Array[
+              Sentdm::Profiles::SentDmServicesEndpointsCustomerApIv3ContractsRequestsCampaignsCampaignUseCaseData
+            ]
+          )
+        end
         attr_accessor :use_cases
 
         # Comma-separated keywords that trigger help message (e.g., "HELP, INFO, SUPPORT")
@@ -68,7 +74,9 @@ module Sentdm
             name: String,
             type: String,
             use_cases:
-              T::Array[Sentdm::Profiles::CampaignData::UseCase::OrHash],
+              T::Array[
+                Sentdm::Profiles::SentDmServicesEndpointsCustomerApIv3ContractsRequestsCampaignsCampaignUseCaseData::OrHash
+              ],
             help_keywords: T.nilable(String),
             help_message: T.nilable(String),
             message_flow: T.nilable(String),
@@ -116,7 +124,10 @@ module Sentdm
               description: String,
               name: String,
               type: String,
-              use_cases: T::Array[Sentdm::Profiles::CampaignData::UseCase],
+              use_cases:
+                T::Array[
+                  Sentdm::Profiles::SentDmServicesEndpointsCustomerApIv3ContractsRequestsCampaignsCampaignUseCaseData
+                ],
               help_keywords: T.nilable(String),
               help_message: T.nilable(String),
               message_flow: T.nilable(String),
@@ -131,52 +142,6 @@ module Sentdm
         end
         def to_hash
         end
-
-        class UseCase < Sentdm::Internal::Type::BaseModel
-          OrHash =
-            T.type_alias do
-              T.any(
-                Sentdm::Profiles::CampaignData::UseCase,
-                Sentdm::Internal::AnyHash
-              )
-            end
-
-          # US messaging use case category
-          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(
-            # US messaging use case category
-            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

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

@@ -71,7 +71,7 @@ module Sentdm
         def to_hash
         end
 
-        class Body < Sentdm::Models::MutationRequestBase
+        class Body < Sentdm::Models::MutationRequest
           OrHash =
             T.type_alias do
               T.any(

data/rbi/sentdm/models/profiles/campaign_list_response.rbi

@@ -20,14 +20,14 @@ module Sentdm
         end
         attr_accessor :data
 
-        # Error details (null if successful)
+        # Error information
         sig { returns(T.nilable(Sentdm::APIError)) }
         attr_reader :error
 
         sig { params(error: T.nilable(Sentdm::APIError::OrHash)).void }
         attr_writer :error
 
-        # Metadata about the request and response
+        # Request and response metadata
         sig { returns(T.nilable(Sentdm::APIMeta)) }
         attr_reader :meta
 
@@ -56,9 +56,9 @@ module Sentdm
         def self.new(
           # The response data (null if error)
           data: nil,
-          # Error details (null if successful)
+          # Error information
           error: nil,
-          # Metadata about the request and response
+          # Request and response metadata
           meta: nil,
           # Indicates whether the request was successful
           success: nil

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

@@ -21,7 +21,7 @@ module Sentdm
         sig { returns(String) }
         attr_accessor :campaign_id
 
-        # Campaign data
+        # Campaign data for create or update operation
         sig { returns(Sentdm::Profiles::CampaignData) }
         attr_reader :campaign
 
@@ -62,7 +62,7 @@ module Sentdm
         def self.new(
           profile_id:,
           campaign_id:,
-          # Campaign data
+          # Campaign data for create or update operation
           campaign:,
           # Sandbox flag - when true, the operation is simulated without side effects Useful
           # for testing integrations without actual execution

data/rbi/sentdm/models/profiles/sent_dm_services_endpoints_customer_ap_iv3_contracts_requests_campaigns_campaign_use_case_data.rbi

@@ -0,0 +1,51 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    module Profiles
+      class SentDmServicesEndpointsCustomerApIv3ContractsRequestsCampaignsCampaignUseCaseData < Sentdm::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Sentdm::Profiles::SentDmServicesEndpointsCustomerApIv3ContractsRequestsCampaignsCampaignUseCaseData,
+              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

data/rbi/sentdm/models/profiles/tcr_campaign_with_use_cases.rbi

@@ -3,7 +3,7 @@
 module Sentdm
   module Models
     module Profiles
-      class TcrCampaignWithUseCases < Sentdm::Models::BaseDto
+      class TcrCampaignWithUseCases < Sentdm::Models::Profiles::BaseDto
         OrHash =
           T.type_alias do
             T.any(
@@ -331,7 +331,7 @@ module Sentdm
           end
         end
 
-        class UseCase < Sentdm::Models::BaseDto
+        class UseCase < Sentdm::Models::Profiles::BaseDto
           OrHash =
             T.type_alias do
               T.any(

data/rbi/sentdm/models/sent_dm_services_common_contracts_poc_os_authentication_config.rbi

@@ -0,0 +1,56 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    class SentDmServicesCommonContractsPocOsAuthenticationConfig < Sentdm::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Sentdm::SentDmServicesCommonContractsPocOsAuthenticationConfig,
+            Sentdm::Internal::AnyHash
+          )
+        end
+
+      # Whether to add the security recommendation text: "For your security, do not
+      # share this code."
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :add_security_recommendation
+
+      sig { params(add_security_recommendation: T::Boolean).void }
+      attr_writer :add_security_recommendation
+
+      # Code expiration time in minutes (1-90). If set, adds footer: "This code expires
+      # in X minutes."
+      sig { returns(T.nilable(Integer)) }
+      attr_accessor :code_expiration_minutes
+
+      # Configuration for AUTHENTICATION category templates
+      sig do
+        params(
+          add_security_recommendation: T::Boolean,
+          code_expiration_minutes: T.nilable(Integer)
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Whether to add the security recommendation text: "For your security, do not
+        # share this code."
+        add_security_recommendation: nil,
+        # Code expiration time in minutes (1-90). If set, adds footer: "This code expires
+        # in X minutes."
+        code_expiration_minutes: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            add_security_recommendation: T::Boolean,
+            code_expiration_minutes: T.nilable(Integer)
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/sentdm/models/sent_dm_services_common_contracts_poc_os_template_body.rbi

@@ -0,0 +1,76 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    class SentDmServicesCommonContractsPocOsTemplateBody < Sentdm::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Sentdm::SentDmServicesCommonContractsPocOsTemplateBody,
+            Sentdm::Internal::AnyHash
+          )
+        end
+
+      # Content that will be used for all channels (SMS and WhatsApp) unless
+      # channel-specific content is provided
+      sig { returns(T.nilable(Sentdm::TemplateBodyContent)) }
+      attr_reader :multi_channel
+
+      sig do
+        params(
+          multi_channel: T.nilable(Sentdm::TemplateBodyContent::OrHash)
+        ).void
+      end
+      attr_writer :multi_channel
+
+      # SMS-specific content that overrides multi-channel content for SMS messages
+      sig { returns(T.nilable(Sentdm::TemplateBodyContent)) }
+      attr_reader :sms
+
+      sig { params(sms: T.nilable(Sentdm::TemplateBodyContent::OrHash)).void }
+      attr_writer :sms
+
+      # WhatsApp-specific content that overrides multi-channel content for WhatsApp
+      # messages
+      sig { returns(T.nilable(Sentdm::TemplateBodyContent)) }
+      attr_reader :whatsapp
+
+      sig do
+        params(whatsapp: T.nilable(Sentdm::TemplateBodyContent::OrHash)).void
+      end
+      attr_writer :whatsapp
+
+      # Body section of a message template with channel-specific content
+      sig do
+        params(
+          multi_channel: T.nilable(Sentdm::TemplateBodyContent::OrHash),
+          sms: T.nilable(Sentdm::TemplateBodyContent::OrHash),
+          whatsapp: T.nilable(Sentdm::TemplateBodyContent::OrHash)
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Content that will be used for all channels (SMS and WhatsApp) unless
+        # channel-specific content is provided
+        multi_channel: nil,
+        # SMS-specific content that overrides multi-channel content for SMS messages
+        sms: nil,
+        # WhatsApp-specific content that overrides multi-channel content for WhatsApp
+        # messages
+        whatsapp: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            multi_channel: T.nilable(Sentdm::TemplateBodyContent),
+            sms: T.nilable(Sentdm::TemplateBodyContent),
+            whatsapp: T.nilable(Sentdm::TemplateBodyContent)
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/sentdm/models/sent_dm_services_common_contracts_poc_os_template_button.rbi

@@ -0,0 +1,79 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    class SentDmServicesCommonContractsPocOsTemplateButton < Sentdm::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Sentdm::SentDmServicesCommonContractsPocOsTemplateButton,
+            Sentdm::Internal::AnyHash
+          )
+        end
+
+      # The unique identifier of the button (1-based index)
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :id
+
+      sig { params(id: Integer).void }
+      attr_writer :id
+
+      # Properties specific to the button type
+      sig do
+        returns(
+          T.nilable(
+            Sentdm::SentDmServicesCommonContractsPocOsTemplateButtonProps
+          )
+        )
+      end
+      attr_reader :props
+
+      sig do
+        params(
+          props:
+            Sentdm::SentDmServicesCommonContractsPocOsTemplateButtonProps::OrHash
+        ).void
+      end
+      attr_writer :props
+
+      # The type of button (e.g., QUICK_REPLY, URL, PHONE_NUMBER, VOICE_CALL, COPY_CODE)
+      sig { returns(T.nilable(String)) }
+      attr_reader :type
+
+      sig { params(type: String).void }
+      attr_writer :type
+
+      # Interactive button in a message template
+      sig do
+        params(
+          id: Integer,
+          props:
+            Sentdm::SentDmServicesCommonContractsPocOsTemplateButtonProps::OrHash,
+          type: String
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The unique identifier of the button (1-based index)
+        id: nil,
+        # Properties specific to the button type
+        props: nil,
+        # The type of button (e.g., QUICK_REPLY, URL, PHONE_NUMBER, VOICE_CALL, COPY_CODE)
+        type: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: Integer,
+            props:
+              Sentdm::SentDmServicesCommonContractsPocOsTemplateButtonProps,
+            type: String
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/sentdm/models/sent_dm_services_common_contracts_poc_os_template_button_props.rbi

@@ -0,0 +1,104 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    class SentDmServicesCommonContractsPocOsTemplateButtonProps < Sentdm::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Sentdm::SentDmServicesCommonContractsPocOsTemplateButtonProps,
+            Sentdm::Internal::AnyHash
+          )
+        end
+
+      sig { returns(T.nilable(Integer)) }
+      attr_accessor :active_for
+
+      sig { returns(T.nilable(String)) }
+      attr_accessor :autofill_text
+
+      sig { returns(T.nilable(String)) }
+      attr_accessor :country_code
+
+      sig { returns(T.nilable(String)) }
+      attr_accessor :offer_code
+
+      sig { returns(T.nilable(String)) }
+      attr_accessor :otp_type
+
+      sig { returns(T.nilable(String)) }
+      attr_accessor :package_name
+
+      sig { returns(T.nilable(String)) }
+      attr_accessor :phone_number
+
+      sig { returns(T.nilable(String)) }
+      attr_accessor :quick_reply_type
+
+      sig { returns(T.nilable(String)) }
+      attr_accessor :signature_hash
+
+      sig { returns(T.nilable(String)) }
+      attr_accessor :text
+
+      sig { returns(T.nilable(String)) }
+      attr_accessor :url
+
+      sig { returns(T.nilable(String)) }
+      attr_accessor :url_type
+
+      sig do
+        params(
+          active_for: T.nilable(Integer),
+          autofill_text: T.nilable(String),
+          country_code: T.nilable(String),
+          offer_code: T.nilable(String),
+          otp_type: T.nilable(String),
+          package_name: T.nilable(String),
+          phone_number: T.nilable(String),
+          quick_reply_type: T.nilable(String),
+          signature_hash: T.nilable(String),
+          text: T.nilable(String),
+          url: T.nilable(String),
+          url_type: T.nilable(String)
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        active_for: nil,
+        autofill_text: nil,
+        country_code: nil,
+        offer_code: nil,
+        otp_type: nil,
+        package_name: nil,
+        phone_number: nil,
+        quick_reply_type: nil,
+        signature_hash: nil,
+        text: nil,
+        url: nil,
+        url_type: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            active_for: T.nilable(Integer),
+            autofill_text: T.nilable(String),
+            country_code: T.nilable(String),
+            offer_code: T.nilable(String),
+            otp_type: T.nilable(String),
+            package_name: T.nilable(String),
+            phone_number: T.nilable(String),
+            quick_reply_type: T.nilable(String),
+            signature_hash: T.nilable(String),
+            text: T.nilable(String),
+            url: T.nilable(String),
+            url_type: T.nilable(String)
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/sentdm/models/sent_dm_services_common_contracts_poc_os_template_footer.rbi

@@ -0,0 +1,60 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    class SentDmServicesCommonContractsPocOsTemplateFooter < Sentdm::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Sentdm::SentDmServicesCommonContractsPocOsTemplateFooter,
+            Sentdm::Internal::AnyHash
+          )
+        end
+
+      # The footer template text with optional variable placeholders
+      sig { returns(T.nilable(String)) }
+      attr_reader :template
+
+      sig { params(template: String).void }
+      attr_writer :template
+
+      # The type of footer (typically "text")
+      sig { returns(T.nilable(String)) }
+      attr_accessor :type
+
+      # List of variables used in the footer template
+      sig { returns(T.nilable(T::Array[Sentdm::TemplateVariable])) }
+      attr_accessor :variables
+
+      # Footer section of a message template
+      sig do
+        params(
+          template: String,
+          type: T.nilable(String),
+          variables: T.nilable(T::Array[Sentdm::TemplateVariable::OrHash])
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The footer template text with optional variable placeholders
+        template: nil,
+        # The type of footer (typically "text")
+        type: nil,
+        # List of variables used in the footer template
+        variables: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            template: String,
+            type: T.nilable(String),
+            variables: T.nilable(T::Array[Sentdm::TemplateVariable])
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end