Class: Increase::Models::EntityUpdateBeneficialOwnerAddressParams::Address

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/increase/models/entity_update_beneficial_owner_address_params.rb

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(city: , country: , line1: , line2: nil, state: nil, zip: nil) ⇒ Object

Some parameter documentations has been truncated, see Increase::Models::EntityUpdateBeneficialOwnerAddressParams::Address for more details.

The individual’s physical address. Mail receiving locations like PO Boxes and PMB’s are disallowed.

Parameters:

  • city (String) (defaults to: ) —

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

  • country (String) (defaults to: ) —

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

  • line1 (String) (defaults to: ) —

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

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

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

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

    The two-letter United States Postal Service (USPS) abbreviation for the US state

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

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



34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/increase/models/entity_update_beneficial_owner_address_params.rb', line 34

class Address < Increase::Internal::Type::BaseModel
  # @!attribute city
  #   The city, district, town, or village of the address.
  #
  #   @return [String]
  required :city, String

  # @!attribute country
  #   The two-letter ISO 3166-1 alpha-2 code for the country of the address.
  #
  #   @return [String]
  required :country, String

  # @!attribute line1
  #   The first line of the address. This is usually the street number and street.
  #
  #   @return [String]
  required :line1, String

  # @!attribute line2
  #   The second line of the address. This might be the floor or room number.
  #
  #   @return [String, nil]
  optional :line2, String

  # @!attribute state
  #   The two-letter United States Postal Service (USPS) abbreviation for the US
  #   state, province, or region of the address. Required in certain countries.
  #
  #   @return [String, nil]
  optional :state, String

  # @!attribute zip
  #   The ZIP or postal code of the address. Required in certain countries.
  #
  #   @return [String, nil]
  optional :zip, String

  # @!method initialize(city:, country:, line1:, line2: nil, state: nil, zip: nil)
  #   Some parameter documentations has been truncated, see
  #   {Increase::Models::EntityUpdateBeneficialOwnerAddressParams::Address} for more
  #   details.
  #
  #   The individual's physical address. Mail receiving locations like PO Boxes and
  #   PMB's are disallowed.
  #
  #   @param city [String] The city, district, town, or village of the address.
  #
  #   @param country [String] The two-letter ISO 3166-1 alpha-2 code for the country of the address.
  #
  #   @param line1 [String] The first line of the address. This is usually the street number and street.
  #
  #   @param line2 [String] The second line of the address. This might be the floor or room number.
  #
  #   @param state [String] The two-letter United States Postal Service (USPS) abbreviation for the US state
  #
  #   @param zip [String] The ZIP or postal code of the address. Required in certain countries.
end

Instance Attribute Details

#city ⇒ String

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

Returns:

  • (String) 


39
 
# File 'lib/increase/models/entity_update_beneficial_owner_address_params.rb', line 39

required :city, String

#country ⇒ String

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

Returns:

  • (String) 


45
 
# File 'lib/increase/models/entity_update_beneficial_owner_address_params.rb', line 45

required :country, String

#line1 ⇒ String

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

Returns:

  • (String) 


51
 
# File 'lib/increase/models/entity_update_beneficial_owner_address_params.rb', line 51

required :line1, String

#line2 ⇒ String?

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

Returns:

  • (String, nil) 


57
 
# File 'lib/increase/models/entity_update_beneficial_owner_address_params.rb', line 57

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.

Returns:

  • (String, nil) 


64
 
# File 'lib/increase/models/entity_update_beneficial_owner_address_params.rb', line 64

optional :state, String

#zip ⇒ String?

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

Returns:

  • (String, nil) 


70
 
# File 'lib/increase/models/entity_update_beneficial_owner_address_params.rb', line 70

optional :zip, String