Class: Sentdm::Models::BrandData

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/sentdm/models/brand_data.rb

Defined Under Namespace

Modules: EntityType

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, #inspect, inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(brand_relationship:, contact_name:, vertical:, brand_name: nil, business_legal_name: nil, business_name: nil, business_role: nil, business_url: nil, city: nil, contact_email: nil, contact_phone: nil, contact_phone_country_code: nil, country: nil, country_of_registration: nil, destination_countries: nil, entity_type: nil, expected_messaging_volume: nil, is_tcr_application: nil, notes: nil, phone_number_prefix: nil, postal_code: nil, primary_use_case: nil, state: nil, street: nil, tax_id: nil, tax_id_type: nil) ⇒ Object

Brand and KYC data

Parameters:

  • brand_relationship (Symbol, Sentdm::Models::TcrBrandRelationship) —

    Brand relationship level with TCR (required for TCR)

  • contact_name (String) —

    Primary contact name (required)

  • vertical (Symbol, Sentdm::Models::TcrVertical) —

    Business vertical/industry category (required for TCR)

  • brand_name (String, nil) (defaults to: nil) —

    Brand name for KYC submission

  • business_legal_name (String, nil) (defaults to: nil) —

    Legal business name

  • business_name (String, nil) (defaults to: nil) —

    Business/brand name

  • business_role (String, nil) (defaults to: nil) —

    Contact’s role in the business

  • business_url (String, nil) (defaults to: nil) —

    Business website URL

  • city (String, nil) (defaults to: nil) —

    City

  • contact_email (String, nil) (defaults to: nil) —

    Contact email address

  • contact_phone (String, nil) (defaults to: nil) —

    Contact phone number in E.164 format

  • contact_phone_country_code (String, nil) (defaults to: nil) —

    Contact phone country code (e.g., “1” for US)

  • country (String, nil) (defaults to: nil) —

    Country code (e.g., US, CA)

  • country_of_registration (String, nil) (defaults to: nil) —

    Country where the business is registered

  • destination_countries (Array<Sentdm::Models::DestinationCountry>, nil) (defaults to: nil) —

    List of destination countries for messaging

  • entity_type (Symbol, Sentdm::Models::BrandData::EntityType, nil) (defaults to: nil) —

    Business entity type

  • expected_messaging_volume (String, nil) (defaults to: nil) —

    Expected daily messaging volume

  • is_tcr_application (Boolean, nil) (defaults to: nil) —

    Whether this is a TCR (Campaign Registry) application

  • notes (String, nil) (defaults to: nil) —

    Additional notes about the business or use case

  • phone_number_prefix (String, nil) (defaults to: nil) —

    Phone number prefix for messaging (e.g., “+1”)

  • postal_code (String, nil) (defaults to: nil) —

    Postal/ZIP code

  • primary_use_case (String, nil) (defaults to: nil) —

    Primary messaging use case description

  • state (String, nil) (defaults to: nil) —

    State/province code

  • street (String, nil) (defaults to: nil) —

    Street address

  • tax_id (String, nil) (defaults to: nil) —

    Tax ID/EIN number

  • tax_id_type (String, nil) (defaults to: nil) —

    Type of tax ID (e.g., us_ein, ca_bn)




# File 'lib/sentdm/models/brand_data.rb', line 165

Instance Attribute Details

#brand_name ⇒ String?

Brand name for KYC submission

Returns:

  • (String, nil) 


28
 
# File 'lib/sentdm/models/brand_data.rb', line 28

optional :brand_name, String, api_name: :brandName, nil?: true

#brand_relationship ⇒ Symbol, Sentdm::Models::TcrBrandRelationship

Brand relationship level with TCR (required for TCR)

Returns:



10
 
# File 'lib/sentdm/models/brand_data.rb', line 10

required :brand_relationship, enum: -> { Sentdm::TcrBrandRelationship }, api_name: :brandRelationship

#business_legal_name ⇒ String?

Legal business name

Returns:

  • (String, nil) 


34
 
# File 'lib/sentdm/models/brand_data.rb', line 34

optional :business_legal_name, String, api_name: :businessLegalName, nil?: true

#business_name ⇒ String?

Business/brand name

Returns:

  • (String, nil) 


40
 
# File 'lib/sentdm/models/brand_data.rb', line 40

optional :business_name, String, api_name: :businessName, nil?: true

#business_role ⇒ String?

Contact’s role in the business

Returns:

  • (String, nil) 


46
 
# File 'lib/sentdm/models/brand_data.rb', line 46

optional :business_role, String, api_name: :businessRole, nil?: true

#business_url ⇒ String?

Business website URL

Returns:

  • (String, nil) 


52
 
# File 'lib/sentdm/models/brand_data.rb', line 52

optional :business_url, String, api_name: :businessUrl, nil?: true

#city ⇒ String?

City

Returns:

  • (String, nil) 


58
 
# File 'lib/sentdm/models/brand_data.rb', line 58

optional :city, String, nil?: true

#contact_email ⇒ String?

Contact email address

Returns:

  • (String, nil) 


64
 
# File 'lib/sentdm/models/brand_data.rb', line 64

optional :contact_email, String, api_name: :contactEmail, nil?: true

#contact_name ⇒ String

Primary contact name (required)

Returns:

  • (String) 


16
 
# File 'lib/sentdm/models/brand_data.rb', line 16

required :contact_name, String, api_name: :contactName

#contact_phone ⇒ String?

Contact phone number in E.164 format

Returns:

  • (String, nil) 


70
 
# File 'lib/sentdm/models/brand_data.rb', line 70

optional :contact_phone, String, api_name: :contactPhone, nil?: true

#contact_phone_country_code ⇒ String?

Contact phone country code (e.g., “1” for US)

Returns:

  • (String, nil) 


76
 
# File 'lib/sentdm/models/brand_data.rb', line 76

optional :contact_phone_country_code, String, api_name: :contactPhoneCountryCode, nil?: true

#country ⇒ String?

Country code (e.g., US, CA)

Returns:

  • (String, nil) 


82
 
# File 'lib/sentdm/models/brand_data.rb', line 82

optional :country, String, nil?: true

#country_of_registration ⇒ String?

Country where the business is registered

Returns:

  • (String, nil) 


88
 
# File 'lib/sentdm/models/brand_data.rb', line 88

optional :country_of_registration, String, api_name: :countryOfRegistration, nil?: true

#destination_countries ⇒ Array<Sentdm::Models::DestinationCountry>?

List of destination countries for messaging

Returns:



94
95
96
97
 
# File 'lib/sentdm/models/brand_data.rb', line 94

optional :destination_countries,
-> { Sentdm::Internal::Type::ArrayOf[Sentdm::DestinationCountry] },
api_name: :destinationCountries,
nil?: true

#entity_type ⇒ Symbol, ...

Business entity type

Returns:



103
 
# File 'lib/sentdm/models/brand_data.rb', line 103

optional :entity_type, enum: -> { Sentdm::BrandData::EntityType }, api_name: :entityType, nil?: true

#expected_messaging_volume ⇒ String?

Expected daily messaging volume

Returns:

  • (String, nil) 


109
 
# File 'lib/sentdm/models/brand_data.rb', line 109

optional :expected_messaging_volume, String, api_name: :expectedMessagingVolume, nil?: true

#is_tcr_application ⇒ Boolean?

Whether this is a TCR (Campaign Registry) application

Returns:

  • (Boolean, nil) 


115
 
# File 'lib/sentdm/models/brand_data.rb', line 115

optional :is_tcr_application, Sentdm::Internal::Type::Boolean, api_name: :isTcrApplication, nil?: true

#notes ⇒ String?

Additional notes about the business or use case

Returns:

  • (String, nil) 


121
 
# File 'lib/sentdm/models/brand_data.rb', line 121

optional :notes, String, nil?: true

#phone_number_prefix ⇒ String?

Phone number prefix for messaging (e.g., “+1”)

Returns:

  • (String, nil) 


127
 
# File 'lib/sentdm/models/brand_data.rb', line 127

optional :phone_number_prefix, String, api_name: :phoneNumberPrefix, nil?: true

#postal_code ⇒ String?

Postal/ZIP code

Returns:

  • (String, nil) 


133
 
# File 'lib/sentdm/models/brand_data.rb', line 133

optional :postal_code, String, api_name: :postalCode, nil?: true

#primary_use_case ⇒ String?

Primary messaging use case description

Returns:

  • (String, nil) 


139
 
# File 'lib/sentdm/models/brand_data.rb', line 139

optional :primary_use_case, String, api_name: :primaryUseCase, nil?: true

#state ⇒ String?

State/province code

Returns:

  • (String, nil) 


145
 
# File 'lib/sentdm/models/brand_data.rb', line 145

optional :state, String, nil?: true

#street ⇒ String?

Street address

Returns:

  • (String, nil) 


151
 
# File 'lib/sentdm/models/brand_data.rb', line 151

optional :street, String, nil?: true

#tax_id ⇒ String?

Tax ID/EIN number

Returns:

  • (String, nil) 


157
 
# File 'lib/sentdm/models/brand_data.rb', line 157

optional :tax_id, String, api_name: :taxId, nil?: true

#tax_id_type ⇒ String?

Type of tax ID (e.g., us_ein, ca_bn)

Returns:

  • (String, nil) 


163
 
# File 'lib/sentdm/models/brand_data.rb', line 163

optional :tax_id_type, String, api_name: :taxIdType, nil?: true

#vertical ⇒ Symbol, Sentdm::Models::TcrVertical

Business vertical/industry category (required for TCR)

Returns:



22
 
# File 'lib/sentdm/models/brand_data.rb', line 22

required :vertical, enum: -> { Sentdm::TcrVertical }