Class: Telnyx::Models::Rcs::BrandResponse

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/telnyx/models/rcs/brand_response.rb,
sig/telnyx/models/rcs/brand_response.rbs

Overview

See Also:

  • Telnyx::Resources::Rcs::Brands#create

Defined Under Namespace

Modules: Identifier, Status Classes: Address

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(administrative_area:, city:, country_code:, line_1:, postal_code:, line_2: nil) ⇒ Object

Parameters:

  • administrative_area (String)
  • city (String)
  • country_code (String) —

    The two-letter ISO 3166-1 country code.

  • line_1 (String)
  • postal_code (String)
  • line_2 (String, nil) (defaults to: nil) 



# File 'lib/telnyx/models/rcs/brand_response.rb', line 115

Instance Attribute Details

#addresses ⇒ Hash{Symbol=>Telnyx::Models::Rcs::BrandResponse::Address}

Parameters:

  • value (::Hash[Symbol, Telnyx::Rcs::BrandResponse::Address])

Returns:



11
 
# File 'lib/telnyx/models/rcs/brand_response.rb', line 11

required :addresses, -> { Telnyx::Internal::Type::HashOf[Telnyx::Rcs::BrandResponse::Address] }

#brand_id ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


16
 
# File 'lib/telnyx/models/rcs/brand_response.rb', line 16

required :brand_id, String

#capabilities ⇒ Telnyx::Models::Rcs::CapabilitiesResponse

Parameters:

  • value (Telnyx::Rcs::CapabilitiesResponse)

Returns:



21
 
# File 'lib/telnyx/models/rcs/brand_response.rb', line 21

required :capabilities, -> { Telnyx::Rcs::CapabilitiesResponse }

#contacts ⇒ Hash{Symbol=>Telnyx::Models::Rcs::BrandContact}

Parameters:

  • value (::Hash[Symbol, Telnyx::Rcs::BrandContact])

Returns:



26
 
# File 'lib/telnyx/models/rcs/brand_response.rb', line 26

required :contacts, -> { Telnyx::Internal::Type::HashOf[Telnyx::Rcs::BrandContact] }

#display_name ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


31
 
# File 'lib/telnyx/models/rcs/brand_response.rb', line 31

required :display_name, String

#identifiers ⇒ Hash{Symbol=>Telnyx::Models::Rcs::EinBrandIdentifier, Telnyx::Models::Rcs::StockSymbolBrandIdentifier}

Parameters:

  • value (::Hash[Symbol, Telnyx::Models::Rcs::BrandResponse::identifier])

Returns:



36
37
 
# File 'lib/telnyx/models/rcs/brand_response.rb', line 36

required :identifiers,
-> { Telnyx::Internal::Type::HashOf[union: Telnyx::Rcs::BrandResponse::Identifier] }

#legal_entity_type ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


42
 
# File 'lib/telnyx/models/rcs/brand_response.rb', line 42

required :legal_entity_type, String

#legal_name ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


47
 
# File 'lib/telnyx/models/rcs/brand_response.rb', line 47

required :legal_name, String

#organization_type ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


52
 
# File 'lib/telnyx/models/rcs/brand_response.rb', line 52

required :organization_type, String

#profile_id ⇒ String?

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


57
 
# File 'lib/telnyx/models/rcs/brand_response.rb', line 57

required :profile_id, String, nil?: true

#status ⇒ Symbol, Telnyx::Models::Rcs::BrandResponse::Status

Parameters:

  • value (Telnyx::Models::Rcs::BrandResponse::status)

Returns:



62
 
# File 'lib/telnyx/models/rcs/brand_response.rb', line 62

required :status, enum: -> { Telnyx::Rcs::BrandResponse::Status }

#website_url ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


67
 
# File 'lib/telnyx/models/rcs/brand_response.rb', line 67

required :website_url, String

Class Method Details

.variants ⇒ Array(Telnyx::Models::Rcs::EinBrandIdentifier, Telnyx::Models::Rcs::StockSymbolBrandIdentifier)

Returns:




# File 'lib/telnyx/models/rcs/brand_response.rb', line 136

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


60
 
# File 'sig/telnyx/models/rcs/brand_response.rbs', line 60

def to_hash: -> {