Class: Lithic::Models::ShippingAddress

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/lithic/models/shipping_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:, first_name:, last_name:, postal_code:, state:, address2: nil, email: nil, line2_text: nil, phone_number: nil) ⇒ Object

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

Parameters:

  • address1 (String) —

    Valid USPS routable address.

  • city (String) —

    City

  • country (String) —

    Uppercase ISO 3166-1 alpha-3 three character abbreviation.

  • first_name (String) —

    Customer’s first name. This will be the first name printed on the physical card.

  • last_name (String) —

    Customer’s surname (family name). This will be the last name printed on the phys

  • postal_code (String) —

    Postal code (formerly zipcode). For US addresses, either five-digit postal code

  • state (String) —

    Uppercase ISO 3166-2 two character abbreviation for US and CA. Optional with a l

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

    Unit number (if applicable).

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

    Email address to be contacted for expedited shipping process purposes. Required

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

    Text to be printed on line two of the physical card. Use of this field requires

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

    Cardholder’s phone number in E.164 format to be contacted for expedited shipping




# File 'lib/lithic/models/shipping_address.rb', line 81

Instance Attribute Details

#address1 ⇒ String

Valid USPS routable address.

Returns:

  • (String) 


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

required :address1, String

#address2 ⇒ String?

Unit number (if applicable).

Returns:

  • (String, nil) 


58
 
# File 'lib/lithic/models/shipping_address.rb', line 58

optional :address2, String

#city ⇒ String

City

Returns:

  • (String) 


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

required :city, String

#country ⇒ String

Uppercase ISO 3166-1 alpha-3 three character abbreviation.

Returns:

  • (String) 


22
 
# File 'lib/lithic/models/shipping_address.rb', line 22

required :country, String

#email ⇒ String?

Email address to be contacted for expedited shipping process purposes. Required if ‘shipping_method` is `EXPEDITED`.

Returns:

  • (String, nil) 


65
 
# File 'lib/lithic/models/shipping_address.rb', line 65

optional :email, String

#first_name ⇒ String

Customer’s first name. This will be the first name printed on the physical card. The combined length of ‘first_name` and `last_name` may not exceed 25 characters.

Returns:

  • (String) 


30
 
# File 'lib/lithic/models/shipping_address.rb', line 30

required :first_name, String

#last_name ⇒ String

Customer’s surname (family name). This will be the last name printed on the physical card. The combined length of ‘first_name` and `last_name` may not exceed 25 characters.

Returns:

  • (String) 


38
 
# File 'lib/lithic/models/shipping_address.rb', line 38

required :last_name, String

#line2_text ⇒ String?

Text to be printed on line two of the physical card. Use of this field requires additional permissions.

Returns:

  • (String, nil) 


72
 
# File 'lib/lithic/models/shipping_address.rb', line 72

optional :line2_text, String

#phone_number ⇒ String?

Cardholder’s phone number in E.164 format to be contacted for expedited shipping process purposes. Required if ‘shipping_method` is `EXPEDITED`.

Returns:

  • (String, nil) 


79
 
# File 'lib/lithic/models/shipping_address.rb', line 79

optional :phone_number, String

#postal_code ⇒ String

Postal code (formerly zipcode). For US addresses, either five-digit postal code or nine-digit postal code (ZIP+4) using the format 12345-1234.

Returns:

  • (String) 


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

required :postal_code, String

#state ⇒ String

Uppercase ISO 3166-2 two character abbreviation for US and CA. Optional with a limit of 24 characters for other countries.

Returns:

  • (String) 


52
 
# File 'lib/lithic/models/shipping_address.rb', line 52

required :state, String