Class: Telnyx::Models::UserAddress

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

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(id: nil, administrative_area: nil, borough: nil, business_name: nil, country_code: nil, created_at: nil, customer_reference: nil, extended_address: nil, first_name: nil, last_name: nil, locality: nil, neighborhood: nil, phone_number: nil, postal_code: nil, record_type: nil, street_address: nil, updated_at: nil) ⇒ Object

Some parameter documentations has been truncated, see Telnyx::Models::UserAddress for more details.

Parameters:

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

    Uniquely identifies the user address.

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

    The locality of the user address. For US addresses, this corresponds to the stat

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

    The borough of the user address. This field is not used for addresses in the US

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

    The business name associated with the user address.

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

    The two-character (ISO 3166-1 alpha-2) country code of the user address.

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

    ISO 8601 formatted date indicating when the resource was created.

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

    A customer reference string for customer look ups.

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

    Additional street address information about the user address such as, but not li

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

    The first name associated with the user address.

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

    The last name associated with the user address.

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

    The locality of the user address. For US addresses, this corresponds to the city

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

    The neighborhood of the user address. This field is not used for addresses in th

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

    The phone number associated with the user address.

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

    The postal code of the user address.

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

    Identifies the type of the resource.

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

    The primary street address information about the user address.

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

    ISO 8601 formatted date indicating when the resource was updated.




# File 'lib/telnyx/models/user_address.rb', line 113

Instance Attribute Details

#administrative_area ⇒ String?

The locality of the user address. For US addresses, this corresponds to the state of the address.

Parameters:

  • (String)

Returns:

  • (String, nil) 


17
 
# File 'lib/telnyx/models/user_address.rb', line 17

optional :administrative_area, String

#borough ⇒ String?

The borough of the user address. This field is not used for addresses in the US but is used for some international addresses.

Parameters:

  • (String)

Returns:

  • (String, nil) 


24
 
# File 'lib/telnyx/models/user_address.rb', line 24

optional :borough, String

#business_name ⇒ String?

The business name associated with the user address.

Parameters:

  • (String)

Returns:

  • (String, nil) 


30
 
# File 'lib/telnyx/models/user_address.rb', line 30

optional :business_name, String

#country_code ⇒ String?

The two-character (ISO 3166-1 alpha-2) country code of the user address.

Parameters:

  • (String)

Returns:

  • (String, nil) 


36
 
# File 'lib/telnyx/models/user_address.rb', line 36

optional :country_code, String

#created_at ⇒ String?

ISO 8601 formatted date indicating when the resource was created.

Parameters:

  • (String)

Returns:

  • (String, nil) 


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

optional :created_at, String

#customer_reference ⇒ String?

A customer reference string for customer look ups.

Parameters:

  • (String)

Returns:

  • (String, nil) 


48
 
# File 'lib/telnyx/models/user_address.rb', line 48

optional :customer_reference, String

#extended_address ⇒ String?

Additional street address information about the user address such as, but not limited to, unit number or apartment number.

Parameters:

  • (String)

Returns:

  • (String, nil) 


55
 
# File 'lib/telnyx/models/user_address.rb', line 55

optional :extended_address, String

#first_name ⇒ String?

The first name associated with the user address.

Parameters:

  • (String)

Returns:

  • (String, nil) 


61
 
# File 'lib/telnyx/models/user_address.rb', line 61

optional :first_name, String

#id ⇒ String?

Uniquely identifies the user address.

Parameters:

  • (String)

Returns:

  • (String, nil) 


10
 
# File 'lib/telnyx/models/user_address.rb', line 10

optional :id, String

#last_name ⇒ String?

The last name associated with the user address.

Parameters:

  • (String)

Returns:

  • (String, nil) 


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

optional :last_name, String

#locality ⇒ String?

The locality of the user address. For US addresses, this corresponds to the city of the address.

Parameters:

  • (String)

Returns:

  • (String, nil) 


74
 
# File 'lib/telnyx/models/user_address.rb', line 74

optional :locality, String

#neighborhood ⇒ String?

The neighborhood of the user address. This field is not used for addresses in the US but is used for some international addresses.

Parameters:

  • (String)

Returns:

  • (String, nil) 


81
 
# File 'lib/telnyx/models/user_address.rb', line 81

optional :neighborhood, String

#phone_number ⇒ String?

The phone number associated with the user address.

Parameters:

  • (String)

Returns:

  • (String, nil) 


87
 
# File 'lib/telnyx/models/user_address.rb', line 87

optional :phone_number, String

#postal_code ⇒ String?

The postal code of the user address.

Parameters:

  • (String)

Returns:

  • (String, nil) 


93
 
# File 'lib/telnyx/models/user_address.rb', line 93

optional :postal_code, String

#record_type ⇒ String?

Identifies the type of the resource.

Parameters:

  • (String)

Returns:

  • (String, nil) 


99
 
# File 'lib/telnyx/models/user_address.rb', line 99

optional :record_type, String

#street_address ⇒ String?

The primary street address information about the user address.

Parameters:

  • (String)

Returns:

  • (String, nil) 


105
 
# File 'lib/telnyx/models/user_address.rb', line 105

optional :street_address, String

#updated_at ⇒ String?

ISO 8601 formatted date indicating when the resource was updated.

Parameters:

  • (String)

Returns:

  • (String, nil) 


111
 
# File 'lib/telnyx/models/user_address.rb', line 111

optional :updated_at, String

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


113
 
# File 'sig/telnyx/models/user_address.rbs', line 113

def to_hash: -> {