Class: Increase::Models::EntityCreateParams::NaturalPerson::Address

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Increase::Models::EntityCreateParams::NaturalPerson::Address

Defined in:

lib/increase/models/entity_create_params.rb,
sig/increase/models/entity_create_params.rbs

Overview

See Also:

• Increase::Models::EntityCreateParams::NaturalPerson#address

Instance Attribute Summary

• #city ⇒ String

  The city, district, town, or village of the address.

• #country ⇒ String

  The two-letter ISO 3166-1 alpha-2 code for the country of the address.

• #line1 ⇒ String

  The first line of the address.

• #line2 ⇒ String^?

  The second line of the address.

• #state ⇒ String^?

  The two-letter United States Postal Service (USPS) abbreviation for the US state, province, or region of the address.

• #zip ⇒ String^?

  The ZIP or postal code of the address.

Instance Method Summary

• #initialize ⇒ Object constructor
• #to_hash ⇒ {

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 ⇒ Object

# File 'sig/increase/models/entity_create_params.rbs', line 1083

def initialize: (

Instance Attribute Details

#city ⇒ String

The city, district, town, or village of the address.

Parameters:

• value (String)

Returns:

• (String)

# File 'lib/increase/models/entity_create_params.rb', line 1294

required :city, String

#country ⇒ String

The two-letter ISO 3166-1 alpha-2 code for the country of the address.

Parameters:

• value (String)

Returns:

• (String)

# File 'lib/increase/models/entity_create_params.rb', line 1300

required :country, String

#line1 ⇒ String

The first line of the address. This is usually the street number and street.

Parameters:

• value (String)

Returns:

• (String)

# File 'lib/increase/models/entity_create_params.rb', line 1306

required :line1, String

#line2 ⇒ String^?

The second line of the address. This might be the floor or room number.

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/increase/models/entity_create_params.rb', line 1312

optional :line2, String

#state ⇒ String^?

The two-letter United States Postal Service (USPS) abbreviation for the US state, province, or region of the address. Required in certain countries.

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/increase/models/entity_create_params.rb', line 1319

optional :state, String

#zip ⇒ String^?

The ZIP or postal code of the address. Required in certain countries.

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/increase/models/entity_create_params.rb', line 1325

optional :zip, String

Instance Method Details

#to_hash ⇒ {

Returns:

• ({)

# File 'sig/increase/models/entity_create_params.rbs', line 1092

def to_hash: -> {