Class: Increase::Models::Lockbox::Address

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

Overview

See Also:

Instance Attribute Summary collapse

Method Summary

Methods inherited from Internal::Type::BaseModel

#==, ==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, #initialize, 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

This class inherits a constructor from Increase::Internal::Type::BaseModel

Instance Attribute Details

#cityString

The city of the address.

Returns:

  • (String)


97
# File 'lib/increase/models/lockbox.rb', line 97

required :city, String

#line1String

The first line of the address.

Returns:

  • (String)


103
# File 'lib/increase/models/lockbox.rb', line 103

required :line1, String

#line2String

The second line of the address.

Returns:

  • (String)


109
# File 'lib/increase/models/lockbox.rb', line 109

required :line2, String

#postal_codeString

The postal code of the address.

Returns:

  • (String)


115
# File 'lib/increase/models/lockbox.rb', line 115

required :postal_code, String

#recipientString?

The recipient line of the address. This will include the recipient name you provide when creating the address, as well as an ATTN suffix to help route the mail to your lockbox. Mail senders must include this ATTN line to receive mail at this Lockbox.

Returns:

  • (String, nil)


124
# File 'lib/increase/models/lockbox.rb', line 124

required :recipient, String, nil?: true

#stateString

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

Returns:

  • (String)


131
# File 'lib/increase/models/lockbox.rb', line 131

required :state, String