Class: SmartyStreets::USEnrichment::Lookup

Inherits:
JSONAble
  • Object
show all
Defined in:
lib/smartystreets_ruby_sdk/us_enrichment/lookup.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from JSONAble

#from_json!, #to_json

Constructor Details

#initialize(smarty_key = nil, data_set = nil, data_sub_set = nil, freeform = nil, street = nil, city = nil, state = nil, zipcode = nil, etag = nil, custom_param_hash = nil) ⇒ Lookup

Returns a new instance of Lookup.



7
8
9
10
11
12
13
14
15
16
17
18
 
# File 'lib/smartystreets_ruby_sdk/us_enrichment/lookup.rb', line 7

def initialize(smarty_key=nil, data_set=nil, data_sub_set=nil, freeform=nil, street=nil, city=nil, state=nil, zipcode=nil, etag=nil, custom_param_hash=nil)
  @smarty_key = smarty_key
  @data_set = data_set
  @data_sub_set = data_sub_set
  @freeform = freeform
  @street = street
  @city = city
  @state = state
  @zipcode = zipcode
  @etag = etag
  @custom_param_hash = {}
end

Instance Attribute Details

#city ⇒ Object

Returns the value of attribute city.



5
6
7
 
# File 'lib/smartystreets_ruby_sdk/us_enrichment/lookup.rb', line 5

def city
  @city
end

#custom_param_hash ⇒ Object

Returns the value of attribute custom_param_hash.



5
6
7
 
# File 'lib/smartystreets_ruby_sdk/us_enrichment/lookup.rb', line 5

def custom_param_hash
  @custom_param_hash
end

#data_set ⇒ Object

Returns the value of attribute data_set.



5
6
7
 
# File 'lib/smartystreets_ruby_sdk/us_enrichment/lookup.rb', line 5

def data_set
  @data_set
end

#data_sub_set ⇒ Object

Returns the value of attribute data_sub_set.



5
6
7
 
# File 'lib/smartystreets_ruby_sdk/us_enrichment/lookup.rb', line 5

def data_sub_set
  @data_sub_set
end

#etag ⇒ Object

Returns the value of attribute etag.



5
6
7
 
# File 'lib/smartystreets_ruby_sdk/us_enrichment/lookup.rb', line 5

def etag
  @etag
end

#freeform ⇒ Object

Returns the value of attribute freeform.



5
6
7
 
# File 'lib/smartystreets_ruby_sdk/us_enrichment/lookup.rb', line 5

def freeform
  @freeform
end

#smarty_key ⇒ Object

Returns the value of attribute smarty_key.



5
6
7
 
# File 'lib/smartystreets_ruby_sdk/us_enrichment/lookup.rb', line 5

def smarty_key
  @smarty_key
end

#state ⇒ Object

Returns the value of attribute state.



5
6
7
 
# File 'lib/smartystreets_ruby_sdk/us_enrichment/lookup.rb', line 5

def state
  @state
end

#street ⇒ Object

Returns the value of attribute street.



5
6
7
 
# File 'lib/smartystreets_ruby_sdk/us_enrichment/lookup.rb', line 5

def street
  @street
end

#zipcode ⇒ Object

Returns the value of attribute zipcode.



5
6
7
 
# File 'lib/smartystreets_ruby_sdk/us_enrichment/lookup.rb', line 5

def zipcode
  @zipcode
end

Instance Method Details

#add_custom_parameter(parameter, value) ⇒ Object 



20
21
22
 
# File 'lib/smartystreets_ruby_sdk/us_enrichment/lookup.rb', line 20

def add_custom_parameter(parameter, value)
  @custom_param_hash[parameter] = value
end