Class: Lithic::Models::Address

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/lithic/models/address.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(address1:, city:, country:, postal_code:, state:, address2: nil) ⇒ Object

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

Parameters:

  • address1 (String) —

    Valid deliverable address (no PO boxes).

  • city (String) —

    Name of city.

  • country (String) —

    Valid country code, entered in uppercase ISO 3166-1 alpha-3 three-character form

  • postal_code (String) —

    Valid postal code. USA postal codes (ZIP codes) are supported, entered as a five

  • state (String) —

    Valid state code. USA state codes are supported, entered in uppercase ISO 3166-2

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

    Unit or apartment number (if applicable).




# File 'lib/lithic/models/address.rb', line 47

Instance Attribute Details

#address1 ⇒ String

Valid deliverable address (no PO boxes).

Returns:

  • (String) 


10
 
# File 'lib/lithic/models/address.rb', line 10

required :address1, String

#address2 ⇒ String?

Unit or apartment number (if applicable).

Returns:

  • (String, nil) 


45
 
# File 'lib/lithic/models/address.rb', line 45

optional :address2, String

#city ⇒ String

Name of city.

Returns:

  • (String) 


16
 
# File 'lib/lithic/models/address.rb', line 16

required :city, String

#country ⇒ String

Valid country code, entered in uppercase ISO 3166-1 alpha-3 three-character format. Only USA is currently supported for all workflows. KYC_EXEMPT supports CAN additionally.

Returns:

  • (String) 


24
 
# File 'lib/lithic/models/address.rb', line 24

required :country, String

#postal_code ⇒ String

Valid postal code. USA postal codes (ZIP codes) are supported, entered as a five-digit postal code or nine-digit postal code (ZIP+4) using the format 12345-1234. KYC_EXEMPT supports Canadian postal codes.

Returns:

  • (String) 


32
 
# File 'lib/lithic/models/address.rb', line 32

required :postal_code, String

#state ⇒ String

Valid state code. USA state codes are supported, entered in uppercase ISO 3166-2 two-character format. KYC_EXEMPT supports Canadian province codes.

Returns:

  • (String) 


39
 
# File 'lib/lithic/models/address.rb', line 39

required :state, String