sentdm 0.19.0 → 0.20.0

data/lib/sentdm/models/profiles/sent_dm_services_endpoints_customer_ap_iv3_contracts_requests_campaigns_campaign_use_case_data.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    module Profiles
+      class SentDmServicesEndpointsCustomerApIv3ContractsRequestsCampaignsCampaignUseCaseData < Sentdm::Internal::Type::BaseModel
+        # @!attribute messaging_use_case_us
+        #
+        #   @return [Symbol, Sentdm::Models::Profiles::MessagingUseCaseUs]
+        required :messaging_use_case_us,
+                 enum: -> { Sentdm::Profiles::MessagingUseCaseUs },
+                 api_name: :messagingUseCaseUs
+
+        # @!attribute sample_messages
+        #   Sample messages for this use case (1-5 messages, max 1024 characters each)
+        #
+        #   @return [Array<String>]
+        required :sample_messages, Sentdm::Internal::Type::ArrayOf[String], api_name: :sampleMessages
+
+        # @!method initialize(messaging_use_case_us:, sample_messages:)
+        #   Campaign use case with sample messages
+        #
+        #   @param messaging_use_case_us [Symbol, Sentdm::Models::Profiles::MessagingUseCaseUs]
+        #
+        #   @param sample_messages [Array<String>] Sample messages for this use case (1-5 messages, max 1024 characters each)
+      end
+    end
+  end
+end

data/lib/sentdm/models/profiles/tcr_campaign_with_use_cases.rb

@@ -0,0 +1,248 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    module Profiles
+      class TcrCampaignWithUseCases < Sentdm::Models::Profiles::BaseDto
+        # @!attribute billed_date
+        #
+        #   @return [Time, nil]
+        optional :billed_date, Time, api_name: :billedDate, nil?: true
+
+        # @!attribute brand_id
+        #
+        #   @return [String, nil]
+        optional :brand_id, String, api_name: :brandId, nil?: true
+
+        # @!attribute cost
+        #
+        #   @return [Float, nil]
+        optional :cost, Float, nil?: true
+
+        # @!attribute csp_id
+        #
+        #   @return [String, nil]
+        optional :csp_id, String, api_name: :cspId, nil?: true
+
+        # @!attribute customer_id
+        #
+        #   @return [String, nil]
+        optional :customer_id, String, api_name: :customerId
+
+        # @!attribute dca_elections_complete
+        #
+        #   @return [Boolean, nil]
+        optional :dca_elections_complete, Sentdm::Internal::Type::Boolean, api_name: :dcaElectionsComplete
+
+        # @!attribute dca_elections_completed_at
+        #
+        #   @return [Time, nil]
+        optional :dca_elections_completed_at, Time, api_name: :dcaElectionsCompletedAt, nil?: true
+
+        # @!attribute description
+        #
+        #   @return [String, nil]
+        optional :description, String
+
+        # @!attribute help_keywords
+        #
+        #   @return [String, nil]
+        optional :help_keywords, String, api_name: :helpKeywords, nil?: true
+
+        # @!attribute help_message
+        #
+        #   @return [String, nil]
+        optional :help_message, String, api_name: :helpMessage, nil?: true
+
+        # @!attribute kyc_submission_form_id
+        #
+        #   @return [String, nil]
+        optional :kyc_submission_form_id, String, api_name: :kycSubmissionFormId, nil?: true
+
+        # @!attribute message_flow
+        #
+        #   @return [String, nil]
+        optional :message_flow, String, api_name: :messageFlow, nil?: true
+
+        # @!attribute name
+        #
+        #   @return [String, nil]
+        optional :name, String
+
+        # @!attribute optin_keywords
+        #
+        #   @return [String, nil]
+        optional :optin_keywords, String, api_name: :optinKeywords, nil?: true
+
+        # @!attribute optin_message
+        #
+        #   @return [String, nil]
+        optional :optin_message, String, api_name: :optinMessage, nil?: true
+
+        # @!attribute optout_keywords
+        #
+        #   @return [String, nil]
+        optional :optout_keywords, String, api_name: :optoutKeywords, nil?: true
+
+        # @!attribute optout_message
+        #
+        #   @return [String, nil]
+        optional :optout_message, String, api_name: :optoutMessage, nil?: true
+
+        # @!attribute privacy_policy_link
+        #
+        #   @return [String, nil]
+        optional :privacy_policy_link, String, api_name: :privacyPolicyLink, nil?: true
+
+        # @!attribute reseller_id
+        #
+        #   @return [String, nil]
+        optional :reseller_id, String, api_name: :resellerId, nil?: true
+
+        # @!attribute sharing_status
+        #
+        #   @return [Symbol, Sentdm::Models::Profiles::TcrCampaignWithUseCases::SharingStatus, nil]
+        optional :sharing_status,
+                 enum: -> { Sentdm::Profiles::TcrCampaignWithUseCases::SharingStatus },
+                 api_name: :sharingStatus,
+                 nil?: true
+
+        # @!attribute status
+        #
+        #   @return [Symbol, Sentdm::Models::Profiles::TcrCampaignWithUseCases::Status, nil]
+        optional :status, enum: -> { Sentdm::Profiles::TcrCampaignWithUseCases::Status }, nil?: true
+
+        # @!attribute submitted_at
+        #
+        #   @return [Time, nil]
+        optional :submitted_at, Time, api_name: :submittedAt, nil?: true
+
+        # @!attribute submitted_to_tcr
+        #
+        #   @return [Boolean, nil]
+        optional :submitted_to_tcr, Sentdm::Internal::Type::Boolean, api_name: :submittedToTCR
+
+        # @!attribute tcr_campaign_id
+        #
+        #   @return [String, nil]
+        optional :tcr_campaign_id, String, api_name: :tcrCampaignId, nil?: true
+
+        # @!attribute tcr_sync_error
+        #
+        #   @return [String, nil]
+        optional :tcr_sync_error, String, api_name: :tcrSyncError, nil?: true
+
+        # @!attribute telnyx_campaign_id
+        #
+        #   @return [String, nil]
+        optional :telnyx_campaign_id, String, api_name: :telnyxCampaignId, nil?: true
+
+        # @!attribute terms_and_conditions_link
+        #
+        #   @return [String, nil]
+        optional :terms_and_conditions_link, String, api_name: :termsAndConditionsLink, nil?: true
+
+        # @!attribute type
+        #
+        #   @return [String, nil]
+        optional :type, String
+
+        # @!attribute upstream_cnp_id
+        #
+        #   @return [String, nil]
+        optional :upstream_cnp_id, String, api_name: :upstreamCnpId, nil?: true
+
+        # @!attribute use_cases
+        #
+        #   @return [Array<Sentdm::Models::Profiles::TcrCampaignWithUseCases::UseCase>, nil]
+        optional :use_cases,
+                 -> { Sentdm::Internal::Type::ArrayOf[Sentdm::Profiles::TcrCampaignWithUseCases::UseCase] },
+                 api_name: :useCases
+
+        # @!method initialize(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)
+        #   @param billed_date [Time, nil]
+        #   @param brand_id [String, nil]
+        #   @param cost [Float, nil]
+        #   @param csp_id [String, nil]
+        #   @param customer_id [String]
+        #   @param dca_elections_complete [Boolean]
+        #   @param dca_elections_completed_at [Time, nil]
+        #   @param description [String]
+        #   @param help_keywords [String, nil]
+        #   @param help_message [String, nil]
+        #   @param kyc_submission_form_id [String, nil]
+        #   @param message_flow [String, nil]
+        #   @param name [String]
+        #   @param optin_keywords [String, nil]
+        #   @param optin_message [String, nil]
+        #   @param optout_keywords [String, nil]
+        #   @param optout_message [String, nil]
+        #   @param privacy_policy_link [String, nil]
+        #   @param reseller_id [String, nil]
+        #   @param sharing_status [Symbol, Sentdm::Models::Profiles::TcrCampaignWithUseCases::SharingStatus, nil]
+        #   @param status [Symbol, Sentdm::Models::Profiles::TcrCampaignWithUseCases::Status, nil]
+        #   @param submitted_at [Time, nil]
+        #   @param submitted_to_tcr [Boolean]
+        #   @param tcr_campaign_id [String, nil]
+        #   @param tcr_sync_error [String, nil]
+        #   @param telnyx_campaign_id [String, nil]
+        #   @param terms_and_conditions_link [String, nil]
+        #   @param type [String]
+        #   @param upstream_cnp_id [String, nil]
+        #   @param use_cases [Array<Sentdm::Models::Profiles::TcrCampaignWithUseCases::UseCase>]
+
+        module SharingStatus
+          extend Sentdm::Internal::Type::Enum
+
+          PENDING = :PENDING
+          ACCEPTED = :ACCEPTED
+          DECLINED = :DECLINED
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        module Status
+          extend Sentdm::Internal::Type::Enum
+
+          SENT_CREATED = :SENT_CREATED
+          ACTIVE = :ACTIVE
+          EXPIRED = :EXPIRED
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        class UseCase < Sentdm::Models::Profiles::BaseDto
+          # @!attribute campaign_id
+          #
+          #   @return [String, nil]
+          optional :campaign_id, String, api_name: :campaignId
+
+          # @!attribute customer_id
+          #
+          #   @return [String, nil]
+          optional :customer_id, String, api_name: :customerId
+
+          # @!attribute messaging_use_case_us
+          #
+          #   @return [Symbol, Sentdm::Models::Profiles::MessagingUseCaseUs, nil]
+          optional :messaging_use_case_us,
+                   enum: -> { Sentdm::Profiles::MessagingUseCaseUs },
+                   api_name: :messagingUseCaseUs
+
+          # @!attribute sample_messages
+          #
+          #   @return [Array<String>, nil]
+          optional :sample_messages, Sentdm::Internal::Type::ArrayOf[String], api_name: :sampleMessages
+
+          # @!method initialize(campaign_id: nil, customer_id: nil, messaging_use_case_us: nil, sample_messages: nil)
+          #   @param campaign_id [String]
+          #   @param customer_id [String]
+          #   @param messaging_use_case_us [Symbol, Sentdm::Models::Profiles::MessagingUseCaseUs]
+          #   @param sample_messages [Array<String>]
+        end
+      end
+    end
+  end
+end

data/lib/sentdm/models/sent_dm_services_common_contracts_poc_os_authentication_config.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    class SentDmServicesCommonContractsPocOsAuthenticationConfig < Sentdm::Internal::Type::BaseModel
+      # @!attribute add_security_recommendation
+      #   Whether to add the security recommendation text: "For your security, do not
+      #   share this code."
+      #
+      #   @return [Boolean, nil]
+      optional :add_security_recommendation,
+               Sentdm::Internal::Type::Boolean,
+               api_name: :addSecurityRecommendation
+
+      # @!attribute code_expiration_minutes
+      #   Code expiration time in minutes (1-90). If set, adds footer: "This code expires
+      #   in X minutes."
+      #
+      #   @return [Integer, nil]
+      optional :code_expiration_minutes, Integer, api_name: :codeExpirationMinutes, nil?: true
+
+      # @!method initialize(add_security_recommendation: nil, code_expiration_minutes: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Sentdm::Models::SentDmServicesCommonContractsPocOsAuthenticationConfig} for
+      #   more details.
+      #
+      #   Configuration for AUTHENTICATION category templates
+      #
+      #   @param add_security_recommendation [Boolean] Whether to add the security recommendation text: "For your security, do not shar
+      #
+      #   @param code_expiration_minutes [Integer, nil] Code expiration time in minutes (1-90). If set, adds footer: "This code expires
+    end
+  end
+end

data/lib/sentdm/models/sent_dm_services_common_contracts_poc_os_template_body.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    class SentDmServicesCommonContractsPocOsTemplateBody < Sentdm::Internal::Type::BaseModel
+      # @!attribute multi_channel
+      #   Content that will be used for all channels (SMS and WhatsApp) unless
+      #   channel-specific content is provided
+      #
+      #   @return [Sentdm::Models::TemplateBodyContent, nil]
+      optional :multi_channel, -> { Sentdm::TemplateBodyContent }, api_name: :multiChannel, nil?: true
+
+      # @!attribute rcs
+      #   RCS-specific content that overrides multi-channel content for RCS messages
+      #
+      #   @return [Sentdm::Models::TemplateBodyContent, nil]
+      optional :rcs, -> { Sentdm::TemplateBodyContent }, nil?: true
+
+      # @!attribute sms
+      #   SMS-specific content that overrides multi-channel content for SMS messages
+      #
+      #   @return [Sentdm::Models::TemplateBodyContent, nil]
+      optional :sms, -> { Sentdm::TemplateBodyContent }, nil?: true
+
+      # @!attribute whatsapp
+      #   WhatsApp-specific content that overrides multi-channel content for WhatsApp
+      #   messages
+      #
+      #   @return [Sentdm::Models::TemplateBodyContent, nil]
+      optional :whatsapp, -> { Sentdm::TemplateBodyContent }, nil?: true
+
+      # @!method initialize(multi_channel: nil, rcs: nil, sms: nil, whatsapp: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Sentdm::Models::SentDmServicesCommonContractsPocOsTemplateBody} for more
+      #   details.
+      #
+      #   Body section of a message template with channel-specific content
+      #
+      #   @param multi_channel [Sentdm::Models::TemplateBodyContent, nil] Content that will be used for all channels (SMS and WhatsApp) unless channel-spe
+      #
+      #   @param rcs [Sentdm::Models::TemplateBodyContent, nil] RCS-specific content that overrides multi-channel content for RCS messages
+      #
+      #   @param sms [Sentdm::Models::TemplateBodyContent, nil] SMS-specific content that overrides multi-channel content for SMS messages
+      #
+      #   @param whatsapp [Sentdm::Models::TemplateBodyContent, nil] WhatsApp-specific content that overrides multi-channel content for WhatsApp mess
+    end
+  end
+end

data/lib/sentdm/models/sent_dm_services_common_contracts_poc_os_template_button.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    class SentDmServicesCommonContractsPocOsTemplateButton < Sentdm::Internal::Type::BaseModel
+      # @!attribute props
+      #   Properties specific to the button type
+      #
+      #   @return [Sentdm::Models::SentDmServicesCommonContractsPocOsTemplateButtonProps]
+      required :props, -> { Sentdm::SentDmServicesCommonContractsPocOsTemplateButtonProps }
+
+      # @!attribute type
+      #   The type of button (e.g., QUICK_REPLY, URL, PHONE_NUMBER, VOICE_CALL, COPY_CODE)
+      #
+      #   @return [String]
+      required :type, String
+
+      # @!attribute id
+      #   The unique identifier of the button (1-based index)
+      #
+      #   @return [Integer, nil]
+      optional :id, Integer
+
+      # @!method initialize(props:, type:, id: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Sentdm::Models::SentDmServicesCommonContractsPocOsTemplateButton} for more
+      #   details.
+      #
+      #   Interactive button in a message template
+      #
+      #   @param props [Sentdm::Models::SentDmServicesCommonContractsPocOsTemplateButtonProps] Properties specific to the button type
+      #
+      #   @param type [String] The type of button (e.g., QUICK_REPLY, URL, PHONE_NUMBER, VOICE_CALL, COPY_CODE)
+      #
+      #   @param id [Integer] The unique identifier of the button (1-based index)
+    end
+  end
+end

data/lib/sentdm/models/sent_dm_services_common_contracts_poc_os_template_button_props.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    class SentDmServicesCommonContractsPocOsTemplateButtonProps < Sentdm::Internal::Type::BaseModel
+      # @!attribute active_for
+      #
+      #   @return [Integer]
+      required :active_for, Integer, api_name: :activeFor
+
+      # @!attribute country_code
+      #
+      #   @return [String]
+      required :country_code, String, api_name: :countryCode
+
+      # @!attribute offer_code
+      #
+      #   @return [String]
+      required :offer_code, String, api_name: :offerCode
+
+      # @!attribute phone_number
+      #
+      #   @return [String]
+      required :phone_number, String, api_name: :phoneNumber
+
+      # @!attribute quick_reply_type
+      #
+      #   @return [String]
+      required :quick_reply_type, String, api_name: :quickReplyType
+
+      # @!attribute text
+      #
+      #   @return [String]
+      required :text, String
+
+      # @!attribute url
+      #
+      #   @return [String]
+      required :url, String
+
+      # @!attribute url_type
+      #
+      #   @return [String]
+      required :url_type, String, api_name: :urlType
+
+      # @!attribute autofill_text
+      #
+      #   @return [String, nil]
+      optional :autofill_text, String, api_name: :autofillText, nil?: true
+
+      # @!attribute otp_type
+      #
+      #   @return [String, nil]
+      optional :otp_type, String, api_name: :otpType, nil?: true
+
+      # @!attribute package_name
+      #
+      #   @return [String, nil]
+      optional :package_name, String, api_name: :packageName, nil?: true
+
+      # @!attribute signature_hash
+      #
+      #   @return [String, nil]
+      optional :signature_hash, String, api_name: :signatureHash, nil?: true
+
+      # @!method initialize(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)
+      #   @param active_for [Integer]
+      #   @param country_code [String]
+      #   @param offer_code [String]
+      #   @param phone_number [String]
+      #   @param quick_reply_type [String]
+      #   @param text [String]
+      #   @param url [String]
+      #   @param url_type [String]
+      #   @param autofill_text [String, nil]
+      #   @param otp_type [String, nil]
+      #   @param package_name [String, nil]
+      #   @param signature_hash [String, nil]
+    end
+  end
+end

data/lib/sentdm/models/sent_dm_services_common_contracts_poc_os_template_footer.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    class SentDmServicesCommonContractsPocOsTemplateFooter < Sentdm::Internal::Type::BaseModel
+      # @!attribute template
+      #   The footer template text with optional variable placeholders
+      #
+      #   @return [String]
+      required :template, String
+
+      # @!attribute type
+      #   The type of footer (typically "text")
+      #
+      #   @return [String, nil]
+      optional :type, String, nil?: true
+
+      # @!attribute variables
+      #   List of variables used in the footer template
+      #
+      #   @return [Array<Sentdm::Models::TemplateVariable>, nil]
+      optional :variables, -> { Sentdm::Internal::Type::ArrayOf[Sentdm::TemplateVariable] }, nil?: true
+
+      # @!method initialize(template:, type: nil, variables: nil)
+      #   Footer section of a message template
+      #
+      #   @param template [String] The footer template text with optional variable placeholders
+      #
+      #   @param type [String, nil] The type of footer (typically "text")
+      #
+      #   @param variables [Array<Sentdm::Models::TemplateVariable>, nil] List of variables used in the footer template
+    end
+  end
+end

data/lib/sentdm/models/sent_dm_services_common_contracts_poc_os_template_header.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    class SentDmServicesCommonContractsPocOsTemplateHeader < Sentdm::Internal::Type::BaseModel
+      # @!attribute template
+      #   The header template text with optional variable placeholders (e.g., "Welcome to
+      #   {{0:variable}}")
+      #
+      #   @return [String]
+      required :template, String
+
+      # @!attribute type
+      #   The type of header (e.g., "text", "image", "video", "document")
+      #
+      #   @return [String, nil]
+      optional :type, String, nil?: true
+
+      # @!attribute variables
+      #   List of variables used in the header template
+      #
+      #   @return [Array<Sentdm::Models::TemplateVariable>, nil]
+      optional :variables, -> { Sentdm::Internal::Type::ArrayOf[Sentdm::TemplateVariable] }, nil?: true
+
+      # @!method initialize(template:, type: nil, variables: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Sentdm::Models::SentDmServicesCommonContractsPocOsTemplateHeader} for more
+      #   details.
+      #
+      #   Header section of a message template
+      #
+      #   @param template [String] The header template text with optional variable placeholders (e.g., "Welcome to
+      #
+      #   @param type [String, nil] The type of header (e.g., "text", "image", "video", "document")
+      #
+      #   @param variables [Array<Sentdm::Models::TemplateVariable>, nil] List of variables used in the header template
+    end
+  end
+end

data/lib/sentdm/models/sent_dm_services_endpoints_customer_ap_iv3_contracts_requests_brands_brand_business_info.rb

@@ -0,0 +1,116 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    class SentDmServicesEndpointsCustomerApIv3ContractsRequestsBrandsBrandBusinessInfo < Sentdm::Internal::Type::BaseModel
+      # @!attribute city
+      #   City
+      #
+      #   @return [String, nil]
+      optional :city, String, nil?: true
+
+      # @!attribute country
+      #   Country code (e.g., US, CA)
+      #
+      #   @return [String, nil]
+      optional :country, String, nil?: true
+
+      # @!attribute country_of_registration
+      #   Country where the business is registered
+      #
+      #   @return [String, nil]
+      optional :country_of_registration, String, api_name: :countryOfRegistration, nil?: true
+
+      # @!attribute entity_type
+      #
+      #   @return [Symbol, Sentdm::Models::SentDmServicesEndpointsCustomerApIv3ContractsRequestsBrandsBrandBusinessInfo::EntityType, nil]
+      optional :entity_type,
+               enum: -> {
+                 Sentdm::SentDmServicesEndpointsCustomerApIv3ContractsRequestsBrandsBrandBusinessInfo::EntityType
+               },
+               api_name: :entityType,
+               nil?: true
+
+      # @!attribute legal_name
+      #   Legal business name
+      #
+      #   @return [String, nil]
+      optional :legal_name, String, api_name: :legalName, nil?: true
+
+      # @!attribute postal_code
+      #   Postal/ZIP code
+      #
+      #   @return [String, nil]
+      optional :postal_code, String, api_name: :postalCode, nil?: true
+
+      # @!attribute state
+      #   State/province code
+      #
+      #   @return [String, nil]
+      optional :state, String, nil?: true
+
+      # @!attribute street
+      #   Street address
+      #
+      #   @return [String, nil]
+      optional :street, String, nil?: true
+
+      # @!attribute tax_id
+      #   Tax ID/EIN number
+      #
+      #   @return [String, nil]
+      optional :tax_id, String, api_name: :taxId, nil?: true
+
+      # @!attribute tax_id_type
+      #   Type of tax ID (e.g., us_ein, ca_bn)
+      #
+      #   @return [String, nil]
+      optional :tax_id_type, String, api_name: :taxIdType, nil?: true
+
+      # @!attribute url
+      #   Business website URL
+      #
+      #   @return [String, nil]
+      optional :url, String, nil?: true
+
+      # @!method initialize(city: nil, country: nil, country_of_registration: nil, entity_type: nil, legal_name: nil, postal_code: nil, state: nil, street: nil, tax_id: nil, tax_id_type: nil, url: nil)
+      #   Business details and address for brand KYC
+      #
+      #   @param city [String, nil] City
+      #
+      #   @param country [String, nil] Country code (e.g., US, CA)
+      #
+      #   @param country_of_registration [String, nil] Country where the business is registered
+      #
+      #   @param entity_type [Symbol, Sentdm::Models::SentDmServicesEndpointsCustomerApIv3ContractsRequestsBrandsBrandBusinessInfo::EntityType, nil]
+      #
+      #   @param legal_name [String, nil] Legal business name
+      #
+      #   @param postal_code [String, nil] Postal/ZIP code
+      #
+      #   @param state [String, nil] State/province code
+      #
+      #   @param street [String, nil] Street address
+      #
+      #   @param tax_id [String, nil] Tax ID/EIN number
+      #
+      #   @param tax_id_type [String, nil] Type of tax ID (e.g., us_ein, ca_bn)
+      #
+      #   @param url [String, nil] Business website URL
+
+      # @see Sentdm::Models::SentDmServicesEndpointsCustomerApIv3ContractsRequestsBrandsBrandBusinessInfo#entity_type
+      module EntityType
+        extend Sentdm::Internal::Type::Enum
+
+        PRIVATE_PROFIT = :PRIVATE_PROFIT
+        PUBLIC_PROFIT = :PUBLIC_PROFIT
+        NON_PROFIT = :NON_PROFIT
+        SOLE_PROPRIETOR = :SOLE_PROPRIETOR
+        GOVERNMENT = :GOVERNMENT
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end