Class: Sentdm::Models::ProfileDetail::Brand

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/sentdm/models/profile_detail.rb,
sig/sentdm/models/profile_detail.rbs

Overview

See Also:

  • Sentdm::Models::ProfileDetail#brand

Defined Under Namespace

Modules: IdentityStatus, Status Classes: Business, Compliance, Contact

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(business_name: nil, email: nil, name: nil, phone: nil, phone_country_code: nil, role: nil) ⇒ Object

Contact information for the brand

Parameters:

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

    Business/brand name

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

    Contact email address

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

    Primary contact name

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

    Contact phone number in E.164 format

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

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

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

    Contact's role in the business




# File 'lib/sentdm/models/profile_detail.rb', line 335

Instance Attribute Details

#business ⇒ Sentdm::Models::ProfileDetail::Brand::Business?

Business details and address information

Parameters:

  • value (Sentdm::ProfileDetail::Brand::Business, nil)

Returns:



258
 
# File 'lib/sentdm/models/profile_detail.rb', line 258

optional :business, -> { Sentdm::ProfileDetail::Brand::Business }, nil?: true

#compliance ⇒ Sentdm::Models::ProfileDetail::Brand::Compliance?

Compliance and TCR-related information

Parameters:

  • value (Sentdm::ProfileDetail::Brand::Compliance, nil)

Returns:



264
 
# File 'lib/sentdm/models/profile_detail.rb', line 264

optional :compliance, -> { Sentdm::ProfileDetail::Brand::Compliance }, nil?: true

#contact ⇒ Sentdm::Models::ProfileDetail::Brand::Contact?

Contact information for the brand

Parameters:

  • value (Sentdm::ProfileDetail::Brand::Contact, nil)

Returns:



270
 
# File 'lib/sentdm/models/profile_detail.rb', line 270

optional :contact, -> { Sentdm::ProfileDetail::Brand::Contact }, nil?: true

#created_at ⇒ Time?

When the brand was created

Parameters:

  • (Time)

Returns:

  • (Time, nil) 


276
 
# File 'lib/sentdm/models/profile_detail.rb', line 276

optional :created_at, Time

#csp_id ⇒ String?

Deprecated.

Deprecated and scheduled for removal. Identifies the Campaign Service Provider that registered the brand, which is Sent, so the value is the same for every brand and every account. Nothing on your side can act on it and there is no replacement. Stop reading it.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


287
 
# File 'lib/sentdm/models/profile_detail.rb', line 287

optional :csp_id, String, nil?: true

#id ⇒ String?

Unique identifier for the brand

Parameters:

  • (String)

Returns:

  • (String, nil) 


252
 
# File 'lib/sentdm/models/profile_detail.rb', line 252

optional :id, String

#identity_status ⇒ Symbol, ...

Parameters:

  • value (Sentdm::Models::ProfileDetail::Brand::identity_status, nil)

Returns:



292
 
# File 'lib/sentdm/models/profile_detail.rb', line 292

optional :identity_status, enum: -> { Sentdm::ProfileDetail::Brand::IdentityStatus }, nil?: true

#is_inherited ⇒ Boolean?

Whether this brand is inherited from the parent organization

Parameters:

  • (Boolean)

Returns:

  • (Boolean, nil) 


298
 
# File 'lib/sentdm/models/profile_detail.rb', line 298

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

#status ⇒ Symbol, ...

Parameters:

  • value (Sentdm::Models::ProfileDetail::Brand::status, nil)

Returns:



303
 
# File 'lib/sentdm/models/profile_detail.rb', line 303

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

#submitted_at ⇒ Time?

When the brand was submitted to TCR

Parameters:

  • value (Time, nil)

Returns:

  • (Time, nil) 


309
 
# File 'lib/sentdm/models/profile_detail.rb', line 309

optional :submitted_at, Time, nil?: true

#submitted_to_tcr ⇒ Boolean?

Whether this brand has been submitted to TCR

Parameters:

  • (Boolean)

Returns:

  • (Boolean, nil) 


315
 
# File 'lib/sentdm/models/profile_detail.rb', line 315

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

#tcr_brand_id ⇒ String?

TCR brand ID (populated after TCR submission)

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


321
 
# File 'lib/sentdm/models/profile_detail.rb', line 321

optional :tcr_brand_id, String, nil?: true

#universal_ein ⇒ String?

Universal EIN from TCR

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


327
 
# File 'lib/sentdm/models/profile_detail.rb', line 327

optional :universal_ein, String, nil?: true

#updated_at ⇒ Time?

When the brand was last updated

Parameters:

  • value (Time, nil)

Returns:

  • (Time, nil) 


333
 
# File 'lib/sentdm/models/profile_detail.rb', line 333

optional :updated_at, Time, nil?: true

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/sentdm/models/profile_detail.rb', line 587

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


260
 
# File 'sig/sentdm/models/profile_detail.rbs', line 260

def to_hash: -> {