Class: SmartyStreets::USEnrichment::LookupBase

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

Direct Known Subclasses

BusinessDetailLookup, Lookup

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from JSONAble

#from_json!, #to_json

Constructor Details

#initialize ⇒ LookupBase

Returns a new instance of LookupBase.



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

def initialize
  @request_etag = nil
  @response_etag = nil
  @include_array = []
  @exclude_array = []
  @features = nil
  @custom_param_hash = {}
end

Instance Attribute Details

#custom_param_hash ⇒ Object

Returns the value of attribute custom_param_hash.



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

def custom_param_hash
  @custom_param_hash
end

#exclude_array ⇒ Object

Returns the value of attribute exclude_array.



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

def exclude_array
  @exclude_array
end

#features ⇒ Object

Returns the value of attribute features.



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

def features
  @features
end

#include_array ⇒ Object

Returns the value of attribute include_array.



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

def include_array
  @include_array
end

#request_etag ⇒ Object

Returns the value of attribute request_etag.



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

def request_etag
  @request_etag
end

#response_etag ⇒ Object

Returns the value of attribute response_etag.



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

def response_etag
  @response_etag
end

Instance Method Details

#add_custom_parameter(parameter, value) ⇒ Object 



17
18
19
 
# File 'lib/smartystreets_ruby_sdk/us_enrichment/lookup.rb', line 17

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

#add_exclude_attribute(attribute) ⇒ Object 



25
26
27
 
# File 'lib/smartystreets_ruby_sdk/us_enrichment/lookup.rb', line 25

def add_exclude_attribute(attribute)
  @exclude_array << attribute unless @exclude_array.include?(attribute)
end

#add_include_attribute(attribute) ⇒ Object 



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

def add_include_attribute(attribute)
  @include_array << attribute unless @include_array.include?(attribute)
end