Class: Telnyx::Models::Rcs::BrandCreateParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/telnyx/models/rcs/brand_create_params.rb,
sig/telnyx/models/rcs/brand_create_params.rbs

Overview

See Also:

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

Defined Under Namespace

Classes: Address, Contacts, Identifiers

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Internal::Type::RequestParameters::Converter

dump_request

Methods included from Internal::Type::RequestParameters

included

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_create_params.rb', line 117

Instance Attribute Details

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

Parameters:

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

Returns:



14
 
# File 'lib/telnyx/models/rcs/brand_create_params.rb', line 14

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

#contacts ⇒ Telnyx::Models::Rcs::BrandCreateParams::Contacts

Named business contacts. Use the brand key for the required BRAND contact.

Parameters:

  • value (Telnyx::Rcs::BrandCreateParams::Contacts)

Returns:



20
 
# File 'lib/telnyx/models/rcs/brand_create_params.rb', line 20

required :contacts, -> { Telnyx::Rcs::BrandCreateParams::Contacts }

#display_name ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


25
 
# File 'lib/telnyx/models/rcs/brand_create_params.rb', line 25

required :display_name, String

#identifiers ⇒ Telnyx::Models::Rcs::BrandCreateParams::Identifiers

Named business identifiers. Use the ein key for the required EIN and stock_symbol for a public-profit brand's stock symbol.

Parameters:

  • value (Telnyx::Rcs::BrandCreateParams::Identifiers)

Returns:



32
 
# File 'lib/telnyx/models/rcs/brand_create_params.rb', line 32

required :identifiers, -> { Telnyx::Rcs::BrandCreateParams::Identifiers }

#legal_entity_type ⇒ Symbol, Telnyx::Models::Rcs::BrandLegalEntityType

Parameters:

  • value (Telnyx::Models::Rcs::brand_legal_entity_type)

Returns:



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

required :legal_entity_type, enum: -> { Telnyx::Rcs::BrandLegalEntityType }

#legal_name ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


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

required :legal_name, String

#organization_type ⇒ Symbol, Telnyx::Models::Rcs::BrandOrganizationType

Parameters:

  • value (Telnyx::Models::Rcs::brand_organization_type)

Returns:



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

required :organization_type, enum: -> { Telnyx::Rcs::BrandOrganizationType }

#profile_id ⇒ String?

A Messaging Profile owned by the authenticated organization. Agents inherit this value when they do not provide their own profile.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


59
 
# File 'lib/telnyx/models/rcs/brand_create_params.rb', line 59

optional :profile_id, String, nil?: true

#website_url ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


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

required :website_url, String

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/telnyx/models/rcs/brand_create_params.rb', line 157

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


53
 
# File 'sig/telnyx/models/rcs/brand_create_params.rbs', line 53

def to_hash: -> {