Class: FinchAPI::Models::Location

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/finch_api/models/location.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_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, #inspect, inspect, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!

Constructor Details

#initialize(city: , country: , line1: , line2: , postal_code: , state: , name: nil, source_id: nil) ⇒ Object

Parameters:

  • city (String, nil) (defaults to: ) —

    City, district, suburb, town, or village.

  • country (String, nil) (defaults to: ) —

    The 2-letter ISO 3166 country code.

  • line1 (String, nil) (defaults to: ) —

    Street address or PO box.

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

    Apartment, suite, unit, or building.

  • postal_code (String, nil) (defaults to: ) —

    The postal code or zip code.

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

    The state code.

  • name (String, nil) (defaults to: nil)
  • source_id (String, nil) (defaults to: nil) 



# File 'lib/finch_api/models/location.rb', line 52

Instance Attribute Details

#city ⇒ String?

City, district, suburb, town, or village.

Returns:

  • (String, nil) 


10
 
# File 'lib/finch_api/models/location.rb', line 10

required :city, String, nil?: true

#country ⇒ String?

The 2-letter ISO 3166 country code.

Returns:

  • (String, nil) 


16
 
# File 'lib/finch_api/models/location.rb', line 16

required :country, String, nil?: true

#line1 ⇒ String?

Street address or PO box.

Returns:

  • (String, nil) 


22
 
# File 'lib/finch_api/models/location.rb', line 22

required :line1, String, nil?: true

#line2 ⇒ String?

Apartment, suite, unit, or building.

Returns:

  • (String, nil) 


28
 
# File 'lib/finch_api/models/location.rb', line 28

required :line2, String, nil?: true

#name ⇒ String?

Returns:

  • (String, nil) 


45
 
# File 'lib/finch_api/models/location.rb', line 45

optional :name, String, nil?: true

#postal_code ⇒ String?

The postal code or zip code.

Returns:

  • (String, nil) 


34
 
# File 'lib/finch_api/models/location.rb', line 34

required :postal_code, String, nil?: true

#source_id ⇒ String?

Returns:

  • (String, nil) 


50
 
# File 'lib/finch_api/models/location.rb', line 50

optional :source_id, String, nil?: true

#state ⇒ String?

The state code.

Returns:

  • (String, nil) 


40
 
# File 'lib/finch_api/models/location.rb', line 40

required :state, String, nil?: true