sentdm 0.19.0 → 0.20.0

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

@@ -0,0 +1,425 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    module Profiles
+      class TcrCampaignWithUseCases < Sentdm::Models::Profiles::BaseDto
+        OrHash =
+          T.type_alias do
+            T.any(
+              Sentdm::Profiles::TcrCampaignWithUseCases,
+              Sentdm::Internal::AnyHash
+            )
+          end
+
+        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(String)) }
+        attr_accessor :csp_id
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :customer_id
+
+        sig { params(customer_id: String).void }
+        attr_writer :customer_id
+
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :dca_elections_complete
+
+        sig { params(dca_elections_complete: T::Boolean).void }
+        attr_writer :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
+
+        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 :kyc_submission_form_id
+
+        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 { returns(T.nilable(String)) }
+        attr_accessor :reseller_id
+
+        sig do
+          returns(
+            T.nilable(
+              Sentdm::Profiles::TcrCampaignWithUseCases::SharingStatus::TaggedSymbol
+            )
+          )
+        end
+        attr_accessor :sharing_status
+
+        sig do
+          returns(
+            T.nilable(
+              Sentdm::Profiles::TcrCampaignWithUseCases::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
+
+        sig { returns(T.nilable(String)) }
+        attr_accessor :tcr_campaign_id
+
+        sig { returns(T.nilable(String)) }
+        attr_accessor :tcr_sync_error
+
+        sig { returns(T.nilable(String)) }
+        attr_accessor :telnyx_campaign_id
+
+        sig { returns(T.nilable(String)) }
+        attr_accessor :terms_and_conditions_link
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :type
+
+        sig { params(type: String).void }
+        attr_writer :type
+
+        sig { returns(T.nilable(String)) }
+        attr_accessor :upstream_cnp_id
+
+        sig do
+          returns(
+            T.nilable(
+              T::Array[Sentdm::Profiles::TcrCampaignWithUseCases::UseCase]
+            )
+          )
+        end
+        attr_reader :use_cases
+
+        sig do
+          params(
+            use_cases:
+              T::Array[
+                Sentdm::Profiles::TcrCampaignWithUseCases::UseCase::OrHash
+              ]
+          ).void
+        end
+        attr_writer :use_cases
+
+        sig do
+          params(
+            billed_date: T.nilable(Time),
+            brand_id: T.nilable(String),
+            cost: T.nilable(Float),
+            csp_id: T.nilable(String),
+            customer_id: String,
+            dca_elections_complete: T::Boolean,
+            dca_elections_completed_at: T.nilable(Time),
+            description: String,
+            help_keywords: T.nilable(String),
+            help_message: T.nilable(String),
+            kyc_submission_form_id: 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),
+            reseller_id: T.nilable(String),
+            sharing_status:
+              T.nilable(
+                Sentdm::Profiles::TcrCampaignWithUseCases::SharingStatus::OrSymbol
+              ),
+            status:
+              T.nilable(
+                Sentdm::Profiles::TcrCampaignWithUseCases::Status::OrSymbol
+              ),
+            submitted_at: T.nilable(Time),
+            submitted_to_tcr: T::Boolean,
+            tcr_campaign_id: T.nilable(String),
+            tcr_sync_error: T.nilable(String),
+            telnyx_campaign_id: T.nilable(String),
+            terms_and_conditions_link: T.nilable(String),
+            type: String,
+            upstream_cnp_id: T.nilable(String),
+            use_cases:
+              T::Array[
+                Sentdm::Profiles::TcrCampaignWithUseCases::UseCase::OrHash
+              ]
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          billed_date: nil,
+          brand_id: nil,
+          cost: nil,
+          csp_id: nil,
+          customer_id: nil,
+          dca_elections_complete: nil,
+          dca_elections_completed_at: nil,
+          description: nil,
+          help_keywords: nil,
+          help_message: nil,
+          kyc_submission_form_id: nil,
+          message_flow: nil,
+          name: nil,
+          optin_keywords: nil,
+          optin_message: nil,
+          optout_keywords: nil,
+          optout_message: nil,
+          privacy_policy_link: nil,
+          reseller_id: nil,
+          sharing_status: nil,
+          status: nil,
+          submitted_at: nil,
+          submitted_to_tcr: nil,
+          tcr_campaign_id: nil,
+          tcr_sync_error: nil,
+          telnyx_campaign_id: nil,
+          terms_and_conditions_link: nil,
+          type: nil,
+          upstream_cnp_id: nil,
+          use_cases: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              billed_date: T.nilable(Time),
+              brand_id: T.nilable(String),
+              cost: T.nilable(Float),
+              csp_id: T.nilable(String),
+              customer_id: String,
+              dca_elections_complete: T::Boolean,
+              dca_elections_completed_at: T.nilable(Time),
+              description: String,
+              help_keywords: T.nilable(String),
+              help_message: T.nilable(String),
+              kyc_submission_form_id: 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),
+              reseller_id: T.nilable(String),
+              sharing_status:
+                T.nilable(
+                  Sentdm::Profiles::TcrCampaignWithUseCases::SharingStatus::TaggedSymbol
+                ),
+              status:
+                T.nilable(
+                  Sentdm::Profiles::TcrCampaignWithUseCases::Status::TaggedSymbol
+                ),
+              submitted_at: T.nilable(Time),
+              submitted_to_tcr: T::Boolean,
+              tcr_campaign_id: T.nilable(String),
+              tcr_sync_error: T.nilable(String),
+              telnyx_campaign_id: T.nilable(String),
+              terms_and_conditions_link: T.nilable(String),
+              type: String,
+              upstream_cnp_id: T.nilable(String),
+              use_cases:
+                T::Array[Sentdm::Profiles::TcrCampaignWithUseCases::UseCase]
+            }
+          )
+        end
+        def to_hash
+        end
+
+        module SharingStatus
+          extend Sentdm::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                Sentdm::Profiles::TcrCampaignWithUseCases::SharingStatus
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          PENDING =
+            T.let(
+              :PENDING,
+              Sentdm::Profiles::TcrCampaignWithUseCases::SharingStatus::TaggedSymbol
+            )
+          ACCEPTED =
+            T.let(
+              :ACCEPTED,
+              Sentdm::Profiles::TcrCampaignWithUseCases::SharingStatus::TaggedSymbol
+            )
+          DECLINED =
+            T.let(
+              :DECLINED,
+              Sentdm::Profiles::TcrCampaignWithUseCases::SharingStatus::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Sentdm::Profiles::TcrCampaignWithUseCases::SharingStatus::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+
+        module Status
+          extend Sentdm::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(Symbol, Sentdm::Profiles::TcrCampaignWithUseCases::Status)
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          SENT_CREATED =
+            T.let(
+              :SENT_CREATED,
+              Sentdm::Profiles::TcrCampaignWithUseCases::Status::TaggedSymbol
+            )
+          ACTIVE =
+            T.let(
+              :ACTIVE,
+              Sentdm::Profiles::TcrCampaignWithUseCases::Status::TaggedSymbol
+            )
+          EXPIRED =
+            T.let(
+              :EXPIRED,
+              Sentdm::Profiles::TcrCampaignWithUseCases::Status::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Sentdm::Profiles::TcrCampaignWithUseCases::Status::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+
+        class UseCase < Sentdm::Models::Profiles::BaseDto
+          OrHash =
+            T.type_alias do
+              T.any(
+                Sentdm::Profiles::TcrCampaignWithUseCases::UseCase,
+                Sentdm::Internal::AnyHash
+              )
+            end
+
+          sig { returns(T.nilable(String)) }
+          attr_reader :campaign_id
+
+          sig { params(campaign_id: String).void }
+          attr_writer :campaign_id
+
+          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
+
+          sig { returns(T.nilable(T::Array[String])) }
+          attr_reader :sample_messages
+
+          sig { params(sample_messages: T::Array[String]).void }
+          attr_writer :sample_messages
+
+          sig do
+            params(
+              campaign_id: String,
+              customer_id: String,
+              messaging_use_case_us:
+                Sentdm::Profiles::MessagingUseCaseUs::OrSymbol,
+              sample_messages: T::Array[String]
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            campaign_id: nil,
+            customer_id: nil,
+            messaging_use_case_us: nil,
+            sample_messages: nil
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                campaign_id: String,
+                customer_id: String,
+                messaging_use_case_us:
+                  Sentdm::Profiles::MessagingUseCaseUs::TaggedSymbol,
+                sample_messages: T::Array[String]
+              }
+            )
+          end
+          def to_hash
+          end
+        end
+      end
+    end
+  end
+end

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,87 @@
+# 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
+
+      # RCS-specific content that overrides multi-channel content for RCS messages
+      sig { returns(T.nilable(Sentdm::TemplateBodyContent)) }
+      attr_reader :rcs
+
+      sig { params(rcs: T.nilable(Sentdm::TemplateBodyContent::OrHash)).void }
+      attr_writer :rcs
+
+      # 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),
+          rcs: 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,
+        # RCS-specific content that overrides multi-channel content for RCS messages
+        rcs: 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),
+            rcs: 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,72 @@
+# 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
+
+      # Properties specific to the button type
+      sig do
+        returns(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(String) }
+      attr_accessor :type
+
+      # 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
+
+      # Interactive button in a message template
+      sig do
+        params(
+          props:
+            Sentdm::SentDmServicesCommonContractsPocOsTemplateButtonProps::OrHash,
+          type: String,
+          id: Integer
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Properties specific to the button type
+        props:,
+        # The type of button (e.g., QUICK_REPLY, URL, PHONE_NUMBER, VOICE_CALL, COPY_CODE)
+        type:,
+        # The unique identifier of the button (1-based index)
+        id: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            props:
+              Sentdm::SentDmServicesCommonContractsPocOsTemplateButtonProps,
+            type: String,
+            id: Integer
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end