Class: Increase::Models::EntityUpdateAddressParams::Address

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/increase/models/entity_update_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: , line1: , state: , zip: , line2: nil) ⇒ Object

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

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

Parameters:

  • city (String) (defaults to: ) —

    The city of the address.

  • line1 (String) (defaults to: ) —

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

  • state (String) (defaults to: ) —

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

  • zip (String) (defaults to: ) —

    The ZIP code of the address.

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

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



25
26
27
28
29
30
31
32
33
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
 
# File 'lib/increase/models/entity_update_address_params.rb', line 25

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

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

  # @!attribute state
  #   The two-letter United States Postal Service (USPS) abbreviation for the state of
  #   the address.
  #
  #   @return [String]
  required :state, String

  # @!attribute zip
  #   The ZIP code of the address.
  #
  #   @return [String]
  required :zip, String

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

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

Instance Attribute Details

#city ⇒ String

The city of the address.

Returns:

  • (String) 


30
 
# File 'lib/increase/models/entity_update_address_params.rb', line 30

required :city, String

#line1 ⇒ String

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

Returns:

  • (String) 


36
 
# File 'lib/increase/models/entity_update_address_params.rb', line 36

required :line1, String

#line2 ⇒ String?

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

Returns:

  • (String, nil) 


55
 
# File 'lib/increase/models/entity_update_address_params.rb', line 55

optional :line2, String

#state ⇒ String

The two-letter United States Postal Service (USPS) abbreviation for the state of the address.

Returns:

  • (String) 


43
 
# File 'lib/increase/models/entity_update_address_params.rb', line 43

required :state, String

#zip ⇒ String

The ZIP code of the address.

Returns:

  • (String) 


49
 
# File 'lib/increase/models/entity_update_address_params.rb', line 49

required :zip, String