sentdm 0.19.0 → 0.20.0

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(Integer) }
+      attr_accessor :active_for
+
+      sig { returns(String) }
+      attr_accessor :country_code
+
+      sig { returns(String) }
+      attr_accessor :offer_code
+
+      sig { returns(String) }
+      attr_accessor :phone_number
+
+      sig { returns(String) }
+      attr_accessor :quick_reply_type
+
+      sig { returns(String) }
+      attr_accessor :text
+
+      sig { returns(String) }
+      attr_accessor :url
+
+      sig { returns(String) }
+      attr_accessor :url_type
+
+      sig { returns(T.nilable(String)) }
+      attr_accessor :autofill_text
+
+      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 :signature_hash
+
+      sig do
+        params(
+          active_for: Integer,
+          country_code: String,
+          offer_code: String,
+          phone_number: String,
+          quick_reply_type: String,
+          text: String,
+          url: String,
+          url_type: String,
+          autofill_text: T.nilable(String),
+          otp_type: T.nilable(String),
+          package_name: T.nilable(String),
+          signature_hash: T.nilable(String)
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        active_for:,
+        country_code:,
+        offer_code:,
+        phone_number:,
+        quick_reply_type:,
+        text:,
+        url:,
+        url_type:,
+        autofill_text: nil,
+        otp_type: nil,
+        package_name: nil,
+        signature_hash: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            active_for: Integer,
+            country_code: String,
+            offer_code: String,
+            phone_number: String,
+            quick_reply_type: String,
+            text: String,
+            url: String,
+            url_type: String,
+            autofill_text: T.nilable(String),
+            otp_type: T.nilable(String),
+            package_name: T.nilable(String),
+            signature_hash: 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,57 @@
+# 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(String) }
+      attr_accessor :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:,
+        # 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

data/rbi/sentdm/models/sent_dm_services_common_contracts_poc_os_template_header.rbi

@@ -0,0 +1,59 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    class SentDmServicesCommonContractsPocOsTemplateHeader < Sentdm::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Sentdm::SentDmServicesCommonContractsPocOsTemplateHeader,
+            Sentdm::Internal::AnyHash
+          )
+        end
+
+      # The header template text with optional variable placeholders (e.g., "Welcome to
+      # {{0:variable}}")
+      sig { returns(String) }
+      attr_accessor :template
+
+      # The type of header (e.g., "text", "image", "video", "document")
+      sig { returns(T.nilable(String)) }
+      attr_accessor :type
+
+      # List of variables used in the header template
+      sig { returns(T.nilable(T::Array[Sentdm::TemplateVariable])) }
+      attr_accessor :variables
+
+      # Header 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 header template text with optional variable placeholders (e.g., "Welcome to
+        # {{0:variable}}")
+        template:,
+        # The type of header (e.g., "text", "image", "video", "document")
+        type: nil,
+        # List of variables used in the header 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

data/rbi/sentdm/models/sent_dm_services_endpoints_customer_ap_iv3_contracts_requests_brands_brand_business_info.rbi

@@ -0,0 +1,180 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    class SentDmServicesEndpointsCustomerApIv3ContractsRequestsBrandsBrandBusinessInfo < Sentdm::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Sentdm::SentDmServicesEndpointsCustomerApIv3ContractsRequestsBrandsBrandBusinessInfo,
+            Sentdm::Internal::AnyHash
+          )
+        end
+
+      # City
+      sig { returns(T.nilable(String)) }
+      attr_accessor :city
+
+      # Country code (e.g., US, CA)
+      sig { returns(T.nilable(String)) }
+      attr_accessor :country
+
+      # Country where the business is registered
+      sig { returns(T.nilable(String)) }
+      attr_accessor :country_of_registration
+
+      sig do
+        returns(
+          T.nilable(
+            Sentdm::SentDmServicesEndpointsCustomerApIv3ContractsRequestsBrandsBrandBusinessInfo::EntityType::OrSymbol
+          )
+        )
+      end
+      attr_accessor :entity_type
+
+      # Legal business name
+      sig { returns(T.nilable(String)) }
+      attr_accessor :legal_name
+
+      # Postal/ZIP code
+      sig { returns(T.nilable(String)) }
+      attr_accessor :postal_code
+
+      # State/province code
+      sig { returns(T.nilable(String)) }
+      attr_accessor :state
+
+      # Street address
+      sig { returns(T.nilable(String)) }
+      attr_accessor :street
+
+      # Tax ID/EIN number
+      sig { returns(T.nilable(String)) }
+      attr_accessor :tax_id
+
+      # Type of tax ID (e.g., us_ein, ca_bn)
+      sig { returns(T.nilable(String)) }
+      attr_accessor :tax_id_type
+
+      # Business website URL
+      sig { returns(T.nilable(String)) }
+      attr_accessor :url
+
+      # Business details and address for brand KYC
+      sig do
+        params(
+          city: T.nilable(String),
+          country: T.nilable(String),
+          country_of_registration: T.nilable(String),
+          entity_type:
+            T.nilable(
+              Sentdm::SentDmServicesEndpointsCustomerApIv3ContractsRequestsBrandsBrandBusinessInfo::EntityType::OrSymbol
+            ),
+          legal_name: T.nilable(String),
+          postal_code: T.nilable(String),
+          state: T.nilable(String),
+          street: T.nilable(String),
+          tax_id: T.nilable(String),
+          tax_id_type: T.nilable(String),
+          url: T.nilable(String)
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # City
+        city: nil,
+        # Country code (e.g., US, CA)
+        country: nil,
+        # Country where the business is registered
+        country_of_registration: nil,
+        entity_type: nil,
+        # Legal business name
+        legal_name: nil,
+        # Postal/ZIP code
+        postal_code: nil,
+        # State/province code
+        state: nil,
+        # Street address
+        street: nil,
+        # Tax ID/EIN number
+        tax_id: nil,
+        # Type of tax ID (e.g., us_ein, ca_bn)
+        tax_id_type: nil,
+        # Business website URL
+        url: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            city: T.nilable(String),
+            country: T.nilable(String),
+            country_of_registration: T.nilable(String),
+            entity_type:
+              T.nilable(
+                Sentdm::SentDmServicesEndpointsCustomerApIv3ContractsRequestsBrandsBrandBusinessInfo::EntityType::OrSymbol
+              ),
+            legal_name: T.nilable(String),
+            postal_code: T.nilable(String),
+            state: T.nilable(String),
+            street: T.nilable(String),
+            tax_id: T.nilable(String),
+            tax_id_type: T.nilable(String),
+            url: T.nilable(String)
+          }
+        )
+      end
+      def to_hash
+      end
+
+      module EntityType
+        extend Sentdm::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(
+              Symbol,
+              Sentdm::SentDmServicesEndpointsCustomerApIv3ContractsRequestsBrandsBrandBusinessInfo::EntityType
+            )
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        PRIVATE_PROFIT =
+          T.let(
+            :PRIVATE_PROFIT,
+            Sentdm::SentDmServicesEndpointsCustomerApIv3ContractsRequestsBrandsBrandBusinessInfo::EntityType::TaggedSymbol
+          )
+        PUBLIC_PROFIT =
+          T.let(
+            :PUBLIC_PROFIT,
+            Sentdm::SentDmServicesEndpointsCustomerApIv3ContractsRequestsBrandsBrandBusinessInfo::EntityType::TaggedSymbol
+          )
+        NON_PROFIT =
+          T.let(
+            :NON_PROFIT,
+            Sentdm::SentDmServicesEndpointsCustomerApIv3ContractsRequestsBrandsBrandBusinessInfo::EntityType::TaggedSymbol
+          )
+        SOLE_PROPRIETOR =
+          T.let(
+            :SOLE_PROPRIETOR,
+            Sentdm::SentDmServicesEndpointsCustomerApIv3ContractsRequestsBrandsBrandBusinessInfo::EntityType::TaggedSymbol
+          )
+        GOVERNMENT =
+          T.let(
+            :GOVERNMENT,
+            Sentdm::SentDmServicesEndpointsCustomerApIv3ContractsRequestsBrandsBrandBusinessInfo::EntityType::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              Sentdm::SentDmServicesEndpointsCustomerApIv3ContractsRequestsBrandsBrandBusinessInfo::EntityType::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/sentdm/models/sent_dm_services_endpoints_customer_ap_iv3_contracts_requests_brands_brand_compliance_info.rbi

@@ -0,0 +1,95 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    class SentDmServicesEndpointsCustomerApIv3ContractsRequestsBrandsBrandComplianceInfo < Sentdm::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Sentdm::SentDmServicesEndpointsCustomerApIv3ContractsRequestsBrandsBrandComplianceInfo,
+            Sentdm::Internal::AnyHash
+          )
+        end
+
+      sig { returns(Sentdm::TcrBrandRelationship::OrSymbol) }
+      attr_accessor :brand_relationship
+
+      sig { returns(Sentdm::TcrVertical::OrSymbol) }
+      attr_accessor :vertical
+
+      # List of destination countries for messaging
+      sig { returns(T.nilable(T::Array[Sentdm::DestinationCountry])) }
+      attr_accessor :destination_countries
+
+      # Expected daily messaging volume
+      sig { returns(T.nilable(String)) }
+      attr_accessor :expected_messaging_volume
+
+      # Whether this is a TCR (Campaign Registry) application
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_accessor :is_tcr_application
+
+      # Additional notes about the business or use case
+      sig { returns(T.nilable(String)) }
+      attr_accessor :notes
+
+      # Phone number prefix for messaging (e.g., "+1")
+      sig { returns(T.nilable(String)) }
+      attr_accessor :phone_number_prefix
+
+      # Primary messaging use case description
+      sig { returns(T.nilable(String)) }
+      attr_accessor :primary_use_case
+
+      # Compliance and TCR information for brand registration
+      sig do
+        params(
+          brand_relationship: Sentdm::TcrBrandRelationship::OrSymbol,
+          vertical: Sentdm::TcrVertical::OrSymbol,
+          destination_countries:
+            T.nilable(T::Array[Sentdm::DestinationCountry::OrHash]),
+          expected_messaging_volume: T.nilable(String),
+          is_tcr_application: T.nilable(T::Boolean),
+          notes: T.nilable(String),
+          phone_number_prefix: T.nilable(String),
+          primary_use_case: T.nilable(String)
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        brand_relationship:,
+        vertical:,
+        # List of destination countries for messaging
+        destination_countries: nil,
+        # Expected daily messaging volume
+        expected_messaging_volume: nil,
+        # Whether this is a TCR (Campaign Registry) application
+        is_tcr_application: nil,
+        # Additional notes about the business or use case
+        notes: nil,
+        # Phone number prefix for messaging (e.g., "+1")
+        phone_number_prefix: nil,
+        # Primary messaging use case description
+        primary_use_case: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            brand_relationship: Sentdm::TcrBrandRelationship::OrSymbol,
+            vertical: Sentdm::TcrVertical::OrSymbol,
+            destination_countries:
+              T.nilable(T::Array[Sentdm::DestinationCountry]),
+            expected_messaging_volume: T.nilable(String),
+            is_tcr_application: T.nilable(T::Boolean),
+            notes: T.nilable(String),
+            phone_number_prefix: T.nilable(String),
+            primary_use_case: T.nilable(String)
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/sentdm/models/sent_dm_services_endpoints_customer_ap_iv3_contracts_requests_brands_brand_contact_info.rbi

@@ -0,0 +1,81 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    class SentDmServicesEndpointsCustomerApIv3ContractsRequestsBrandsBrandContactInfo < Sentdm::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Sentdm::SentDmServicesEndpointsCustomerApIv3ContractsRequestsBrandsBrandContactInfo,
+            Sentdm::Internal::AnyHash
+          )
+        end
+
+      # Primary contact name (required)
+      sig { returns(String) }
+      attr_accessor :name
+
+      # Business/brand name
+      sig { returns(T.nilable(String)) }
+      attr_accessor :business_name
+
+      # Contact email address
+      sig { returns(T.nilable(String)) }
+      attr_accessor :email
+
+      # Contact phone number in E.164 format
+      sig { returns(T.nilable(String)) }
+      attr_accessor :phone
+
+      # Contact phone country code (e.g., "1" for US)
+      sig { returns(T.nilable(String)) }
+      attr_accessor :phone_country_code
+
+      # Contact's role in the business
+      sig { returns(T.nilable(String)) }
+      attr_accessor :role
+
+      # Contact information for brand KYC
+      sig do
+        params(
+          name: String,
+          business_name: T.nilable(String),
+          email: T.nilable(String),
+          phone: T.nilable(String),
+          phone_country_code: T.nilable(String),
+          role: T.nilable(String)
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Primary contact name (required)
+        name:,
+        # Business/brand name
+        business_name: nil,
+        # Contact email address
+        email: nil,
+        # Contact phone number in E.164 format
+        phone: nil,
+        # Contact phone country code (e.g., "1" for US)
+        phone_country_code: nil,
+        # Contact's role in the business
+        role: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            name: String,
+            business_name: T.nilable(String),
+            email: T.nilable(String),
+            phone: T.nilable(String),
+            phone_country_code: T.nilable(String),
+            role: T.nilable(String)
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/sentdm/models/tcr_brand_relationship.rbi

@@ -0,0 +1,30 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    module TcrBrandRelationship
+      extend Sentdm::Internal::Type::Enum
+
+      TaggedSymbol =
+        T.type_alias { T.all(Symbol, Sentdm::TcrBrandRelationship) }
+      OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+      BASIC_ACCOUNT =
+        T.let(:BASIC_ACCOUNT, Sentdm::TcrBrandRelationship::TaggedSymbol)
+      MEDIUM_ACCOUNT =
+        T.let(:MEDIUM_ACCOUNT, Sentdm::TcrBrandRelationship::TaggedSymbol)
+      LARGE_ACCOUNT =
+        T.let(:LARGE_ACCOUNT, Sentdm::TcrBrandRelationship::TaggedSymbol)
+      SMALL_ACCOUNT =
+        T.let(:SMALL_ACCOUNT, Sentdm::TcrBrandRelationship::TaggedSymbol)
+      KEY_ACCOUNT =
+        T.let(:KEY_ACCOUNT, Sentdm::TcrBrandRelationship::TaggedSymbol)
+
+      sig do
+        override.returns(T::Array[Sentdm::TcrBrandRelationship::TaggedSymbol])
+      end
+      def self.values
+      end
+    end
+  end
+end

data/rbi/sentdm/models/tcr_vertical.rbi

@@ -0,0 +1,41 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    module TcrVertical
+      extend Sentdm::Internal::Type::Enum
+
+      TaggedSymbol = T.type_alias { T.all(Symbol, Sentdm::TcrVertical) }
+      OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+      PROFESSIONAL = T.let(:PROFESSIONAL, Sentdm::TcrVertical::TaggedSymbol)
+      REAL_ESTATE = T.let(:REAL_ESTATE, Sentdm::TcrVertical::TaggedSymbol)
+      HEALTHCARE = T.let(:HEALTHCARE, Sentdm::TcrVertical::TaggedSymbol)
+      HUMAN_RESOURCES =
+        T.let(:HUMAN_RESOURCES, Sentdm::TcrVertical::TaggedSymbol)
+      ENERGY = T.let(:ENERGY, Sentdm::TcrVertical::TaggedSymbol)
+      ENTERTAINMENT = T.let(:ENTERTAINMENT, Sentdm::TcrVertical::TaggedSymbol)
+      RETAIL = T.let(:RETAIL, Sentdm::TcrVertical::TaggedSymbol)
+      TRANSPORTATION = T.let(:TRANSPORTATION, Sentdm::TcrVertical::TaggedSymbol)
+      AGRICULTURE = T.let(:AGRICULTURE, Sentdm::TcrVertical::TaggedSymbol)
+      INSURANCE = T.let(:INSURANCE, Sentdm::TcrVertical::TaggedSymbol)
+      POSTAL = T.let(:POSTAL, Sentdm::TcrVertical::TaggedSymbol)
+      EDUCATION = T.let(:EDUCATION, Sentdm::TcrVertical::TaggedSymbol)
+      HOSPITALITY = T.let(:HOSPITALITY, Sentdm::TcrVertical::TaggedSymbol)
+      FINANCIAL = T.let(:FINANCIAL, Sentdm::TcrVertical::TaggedSymbol)
+      POLITICAL = T.let(:POLITICAL, Sentdm::TcrVertical::TaggedSymbol)
+      GAMBLING = T.let(:GAMBLING, Sentdm::TcrVertical::TaggedSymbol)
+      LEGAL = T.let(:LEGAL, Sentdm::TcrVertical::TaggedSymbol)
+      CONSTRUCTION = T.let(:CONSTRUCTION, Sentdm::TcrVertical::TaggedSymbol)
+      NGO = T.let(:NGO, Sentdm::TcrVertical::TaggedSymbol)
+      MANUFACTURING = T.let(:MANUFACTURING, Sentdm::TcrVertical::TaggedSymbol)
+      GOVERNMENT = T.let(:GOVERNMENT, Sentdm::TcrVertical::TaggedSymbol)
+      TECHNOLOGY = T.let(:TECHNOLOGY, Sentdm::TcrVertical::TaggedSymbol)
+      COMMUNICATION = T.let(:COMMUNICATION, Sentdm::TcrVertical::TaggedSymbol)
+
+      sig { override.returns(T::Array[Sentdm::TcrVertical::TaggedSymbol]) }
+      def self.values
+      end
+    end
+  end
+end