Class: FinchAPI::Models::Location

Inherits:
BaseModel
  • Object
show all
Defined in:
lib/finch-api/models/location.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

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

Returns a new instance of Location.

Parameters:

  • city (String, nil) (defaults to: nil)
  • country (String, nil) (defaults to: nil)
  • line1 (String, nil) (defaults to: nil)
  • line2 (String, nil) (defaults to: nil)
  • name (String, nil) (defaults to: nil)
  • postal_code (String, nil) (defaults to: nil)
  • source_id (String, nil) (defaults to: nil)
  • state (String, nil) (defaults to: nil) 


10
11
12
13
14
15
16
17
18
19
20
21
22
 
# File 'lib/finch-api/models/location.rb', line 10

def initialize(
  city: nil,
  country: nil,
  line1: nil,
  line2: nil,
  name: nil,
  postal_code: nil,
  source_id: nil,
  state: nil,
  **
)
  super
end

Instance Attribute Details

#city ⇒ String?

City, district, suburb, town, or village.

Returns:

  • (String, nil) 


10
 
# File 'lib/finch-api/models/location.rb', line 10

optional :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

optional :country, String, nil?: true

#line1 ⇒ String?

Street address or PO box.

Returns:

  • (String, nil) 


22
 
# File 'lib/finch-api/models/location.rb', line 22

optional :line1, String, nil?: true

#line2 ⇒ String?

Apartment, suite, unit, or building.

Returns:

  • (String, nil) 


28
 
# File 'lib/finch-api/models/location.rb', line 28

optional :line2, String, nil?: true

#name ⇒ String?

Returns:

  • (String, nil) 


33
 
# File 'lib/finch-api/models/location.rb', line 33

optional :name, String, nil?: true

#postal_code ⇒ String?

The postal code or zip code.

Returns:

  • (String, nil) 


39
 
# File 'lib/finch-api/models/location.rb', line 39

optional :postal_code, String, nil?: true

#source_id ⇒ String?

Returns:

  • (String, nil) 


44
 
# File 'lib/finch-api/models/location.rb', line 44

optional :source_id, String, nil?: true

#state ⇒ String?

The state code.

Returns:

  • (String, nil) 


50
 
# File 'lib/finch-api/models/location.rb', line 50

optional :state, String, nil?: true