Class: Vng::Location

Inherits:
Resource show all
Defined in:
lib/vng/location.rb

Overview

Provides methods to interact with Vonigo locations.

Constant Summary collapse

PATH = 
'/api/v1/data/Locations/'
STATES_OPTION_ID =

These could be fetched from /system/objects/ method: 1, objectID: 20

{
  AK: 9879, AL: 9878, AR: 9877, AZ: 9880, CA: 9883, CO: 9876, CT: 9875,
  DC: 9874, DE: 9873, FL: 9872, GA: 9871, HI: 9870, IA: 9869, ID: 9868,
  IL: 9867, IN: 9866, KS: 9865, KY: 9864, LA: 9863, MA: 9862, MD: 9861,
  ME: 9860, MI: 9859, MN: 9858, MO: 9857, MS: 9856, MT: 9855, NC: 9854,
  ND: 9853, NE: 9852, NH: 9851, NJ: 9850, NM: 9849, NV: 9829, NY: 9848,
  OH: 9847, OK: 9846, OR: 9881, PA: 9845, RI: 9843, SC: 9841, SD: 9842,
  TN: 9840, TX: 9839, UT: 9838, VA: 9837, VT: 9836, WA: 9882, WI: 9828,
  WV: 9835, WY: 9834,
}

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(id:) ⇒ Location

Returns a new instance of Location.



22
23
24
 
# File 'lib/vng/location.rb', line 22

def initialize(id:)
  @id = id
end

Instance Attribute Details

#id ⇒ Object (readonly)

Returns the value of attribute id.



20
21
22
 
# File 'lib/vng/location.rb', line 20

def id
  @id
end

Class Method Details

.create(address:, city:, zip:, state:, client_id:) ⇒ Object 



26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
 
# File 'lib/vng/location.rb', line 26

def self.create(address:, city:, zip:, state:, client_id:)
  body = {
    method: '3',
    clientID: client_id,
    Fields: [
       { fieldID: 779, optionID: 9906 }, # 'USA'
       { fieldID: 778, optionID: STATES_OPTION_ID[state.to_sym] },
       { fieldID: 776, fieldValue: city },
       { fieldID: 773, fieldValue: address },
       { fieldID: 775, fieldValue: zip },
    ]
  }

  data = request path: PATH, body: body

  new id: data['Location']['objectID']
end