Class: Sentdm::Models::BrandWithKYC

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

Defined Under Namespace

Modules: IdentityStatus, Status

Instance Attribute Summary collapse

Class Method 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(id: nil, brand_relationship: nil, business_legal_name: nil, business_name: nil, business_role: nil, business_url: nil, city: nil, contact_email: nil, contact_name: nil, contact_phone: nil, contact_phone_country_code: nil, country: nil, country_of_registration: nil, created_at: nil, csp_id: nil, destination_countries: nil, entity_type: nil, expected_messaging_volume: nil, identity_status: nil, is_inherited: nil, is_tcr_application: nil, notes: nil, phone_number_prefix: nil, postal_code: nil, primary_use_case: nil, state: nil, status: nil, street: nil, submitted_at: nil, submitted_to_tcr: nil, tax_id: nil, tax_id_type: nil, tcr_brand_id: nil, universal_ein: nil, updated_at: nil, vertical: nil) ⇒ Object

Flattened brand response with embedded KYC information

Parameters:

  • id (String) (defaults to: nil) —

    Unique identifier for the brand

  • brand_relationship (Symbol, Sentdm::Models::TcrBrandRelationship, nil) (defaults to: nil) —

    Brand relationship level with TCR

  • 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_name (String) (defaults to: nil) —

    Primary contact name

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

    Contact phone number

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

    Contact phone country code

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

    Country code

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

    Country where the business is registered

  • created_at (Time) (defaults to: nil) —

    When the brand was created

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

    CSP (Campaign Service Provider) ID

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

    List of destination countries for messaging

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

    Business entity type

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

    Expected daily messaging volume

  • identity_status (Symbol, Sentdm::Models::BrandWithKYC::IdentityStatus, nil) (defaults to: nil) —

    TCR brand identity verification status

  • is_inherited (Boolean) (defaults to: nil) —

    Whether this brand is inherited from parent organization

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

    Whether this is a TCR application

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

    Additional notes

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

    Phone number prefix for messaging

  • 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

  • status (Symbol, Sentdm::Models::BrandWithKYC::Status, nil) (defaults to: nil) —

    TCR brand status

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

    Street address

  • submitted_at (Time, nil) (defaults to: nil) —

    When the brand was submitted to TCR

  • submitted_to_tcr (Boolean) (defaults to: nil) —

    Whether this brand was submitted to TCR

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

    Tax ID/EIN number

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

    Type of tax ID

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

    TCR brand ID (populated after TCR submission)

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

    Universal EIN from TCR

  • updated_at (Time, nil) (defaults to: nil) —

    When the brand was last updated

  • vertical (Symbol, Sentdm::Models::TcrVertical, nil) (defaults to: nil) —

    Business vertical/industry category




# File 'lib/sentdm/models/brand_with_kyc.rb', line 230

Instance Attribute Details

#brand_relationship ⇒ Symbol, ...

Brand relationship level with TCR

Returns:



16
17
18
19
 
# File 'lib/sentdm/models/brand_with_kyc.rb', line 16

optional :brand_relationship,
enum: -> { Sentdm::TcrBrandRelationship },
api_name: :brandRelationship,
nil?: true

#business_legal_name ⇒ String?

Legal business name

Returns:

  • (String, nil) 


25
 
# File 'lib/sentdm/models/brand_with_kyc.rb', line 25

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

#business_name ⇒ String?

Business/brand name

Returns:

  • (String, nil) 


31
 
# File 'lib/sentdm/models/brand_with_kyc.rb', line 31

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

#business_role ⇒ String?

Contact’s role in the business

Returns:

  • (String, nil) 


37
 
# File 'lib/sentdm/models/brand_with_kyc.rb', line 37

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

#business_url ⇒ String?

Business website URL

Returns:

  • (String, nil) 


43
 
# File 'lib/sentdm/models/brand_with_kyc.rb', line 43

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

#city ⇒ String?

City

Returns:

  • (String, nil) 


49
 
# File 'lib/sentdm/models/brand_with_kyc.rb', line 49

optional :city, String, nil?: true

#contact_email ⇒ String?

Contact email address

Returns:

  • (String, nil) 


55
 
# File 'lib/sentdm/models/brand_with_kyc.rb', line 55

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

#contact_name ⇒ String?

Primary contact name

Returns:

  • (String, nil) 


61
 
# File 'lib/sentdm/models/brand_with_kyc.rb', line 61

optional :contact_name, String, api_name: :contactName

#contact_phone ⇒ String?

Contact phone number

Returns:

  • (String, nil) 


67
 
# File 'lib/sentdm/models/brand_with_kyc.rb', line 67

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

#contact_phone_country_code ⇒ String?

Contact phone country code

Returns:

  • (String, nil) 


73
 
# File 'lib/sentdm/models/brand_with_kyc.rb', line 73

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

#country ⇒ String?

Country code

Returns:

  • (String, nil) 


79
 
# File 'lib/sentdm/models/brand_with_kyc.rb', line 79

optional :country, String, nil?: true

#country_of_registration ⇒ String?

Country where the business is registered

Returns:

  • (String, nil) 


85
 
# File 'lib/sentdm/models/brand_with_kyc.rb', line 85

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

#created_at ⇒ Time?

When the brand was created

Returns:

  • (Time, nil) 


91
 
# File 'lib/sentdm/models/brand_with_kyc.rb', line 91

optional :created_at, Time, api_name: :createdAt

#csp_id ⇒ String?

CSP (Campaign Service Provider) ID

Returns:

  • (String, nil) 


97
 
# File 'lib/sentdm/models/brand_with_kyc.rb', line 97

optional :csp_id, String, api_name: :cspId, nil?: true

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

List of destination countries for messaging

Returns:



103
104
105
 
# File 'lib/sentdm/models/brand_with_kyc.rb', line 103

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

#entity_type ⇒ String?

Business entity type

Returns:

  • (String, nil) 


111
 
# File 'lib/sentdm/models/brand_with_kyc.rb', line 111

optional :entity_type, String, api_name: :entityType, nil?: true

#expected_messaging_volume ⇒ String?

Expected daily messaging volume

Returns:

  • (String, nil) 


117
 
# File 'lib/sentdm/models/brand_with_kyc.rb', line 117

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

#id ⇒ String?

Unique identifier for the brand

Returns:

  • (String, nil) 


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

optional :id, String

#identity_status ⇒ Symbol, ...

TCR brand identity verification status

Returns:



123
124
125
126
 
# File 'lib/sentdm/models/brand_with_kyc.rb', line 123

optional :identity_status,
enum: -> { Sentdm::BrandWithKYC::IdentityStatus },
api_name: :identityStatus,
nil?: true

#is_inherited ⇒ Boolean?

Whether this brand is inherited from parent organization

Returns:

  • (Boolean, nil) 


132
 
# File 'lib/sentdm/models/brand_with_kyc.rb', line 132

optional :is_inherited, Sentdm::Internal::Type::Boolean, api_name: :isInherited

#is_tcr_application ⇒ Boolean?

Whether this is a TCR application

Returns:

  • (Boolean, nil) 


138
 
# File 'lib/sentdm/models/brand_with_kyc.rb', line 138

optional :is_tcr_application, Sentdm::Internal::Type::Boolean, api_name: :isTcrApplication

#notes ⇒ String?

Additional notes

Returns:

  • (String, nil) 


144
 
# File 'lib/sentdm/models/brand_with_kyc.rb', line 144

optional :notes, String, nil?: true

#phone_number_prefix ⇒ String?

Phone number prefix for messaging

Returns:

  • (String, nil) 


150
 
# File 'lib/sentdm/models/brand_with_kyc.rb', line 150

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

#postal_code ⇒ String?

Postal/ZIP code

Returns:

  • (String, nil) 


156
 
# File 'lib/sentdm/models/brand_with_kyc.rb', line 156

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

#primary_use_case ⇒ String?

Primary messaging use case description

Returns:

  • (String, nil) 


162
 
# File 'lib/sentdm/models/brand_with_kyc.rb', line 162

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

#state ⇒ String?

State/province code

Returns:

  • (String, nil) 


168
 
# File 'lib/sentdm/models/brand_with_kyc.rb', line 168

optional :state, String, nil?: true

#status ⇒ Symbol, ...

TCR brand status

Returns:



174
 
# File 'lib/sentdm/models/brand_with_kyc.rb', line 174

optional :status, enum: -> { Sentdm::BrandWithKYC::Status }, nil?: true

#street ⇒ String?

Street address

Returns:

  • (String, nil) 


180
 
# File 'lib/sentdm/models/brand_with_kyc.rb', line 180

optional :street, String, nil?: true

#submitted_at ⇒ Time?

When the brand was submitted to TCR

Returns:

  • (Time, nil) 


186
 
# File 'lib/sentdm/models/brand_with_kyc.rb', line 186

optional :submitted_at, Time, api_name: :submittedAt, nil?: true

#submitted_to_tcr ⇒ Boolean?

Whether this brand was submitted to TCR

Returns:

  • (Boolean, nil) 


192
 
# File 'lib/sentdm/models/brand_with_kyc.rb', line 192

optional :submitted_to_tcr, Sentdm::Internal::Type::Boolean, api_name: :submittedToTCR

#tax_id ⇒ String?

Tax ID/EIN number

Returns:

  • (String, nil) 


198
 
# File 'lib/sentdm/models/brand_with_kyc.rb', line 198

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

#tax_id_type ⇒ String?

Type of tax ID

Returns:

  • (String, nil) 


204
 
# File 'lib/sentdm/models/brand_with_kyc.rb', line 204

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

#tcr_brand_id ⇒ String?

TCR brand ID (populated after TCR submission)

Returns:

  • (String, nil) 


210
 
# File 'lib/sentdm/models/brand_with_kyc.rb', line 210

optional :tcr_brand_id, String, api_name: :tcrBrandId, nil?: true

#universal_ein ⇒ String?

Universal EIN from TCR

Returns:

  • (String, nil) 


216
 
# File 'lib/sentdm/models/brand_with_kyc.rb', line 216

optional :universal_ein, String, api_name: :universalEin, nil?: true

#updated_at ⇒ Time?

When the brand was last updated

Returns:

  • (Time, nil) 


222
 
# File 'lib/sentdm/models/brand_with_kyc.rb', line 222

optional :updated_at, Time, api_name: :updatedAt, nil?: true

#vertical ⇒ Symbol, ...

Business vertical/industry category

Returns:



228
 
# File 'lib/sentdm/models/brand_with_kyc.rb', line 228

optional :vertical, enum: -> { Sentdm::TcrVertical }, nil?: true

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/sentdm/models/brand_with_kyc.rb', line 316