Class: SmartyStreets::InternationalPostalCode::Candidate

Inherits:
Object
  • Object
show all
Defined in:
lib/smartystreets_ruby_sdk/international_postal_code/candidate.rb

Overview

Represents a single candidate returned by the International Postal Code API. See smartystreets.com/docs/cloud/international-postal-code-api

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(obj) ⇒ Candidate

Returns a new instance of Candidate.



18
19
20
21
22
23
24
25
26
27
28
29
30
 
# File 'lib/smartystreets_ruby_sdk/international_postal_code/candidate.rb', line 18

def initialize(obj)
  @input_id = obj['input_id']
  @administrative_area = obj['administrative_area']
  @sub_administrative_area = obj['sub_administrative_area']
  @super_administrative_area = obj['super_administrative_area']
  @country_iso_3 = obj['country_iso_3']
  @locality = obj['locality']
  @dependent_locality = obj['dependent_locality']
  @dependent_locality_name = obj['dependent_locality_name']
  @double_dependent_locality = obj['double_dependent_locality']
  @postal_code = obj['postal_code']
  @postal_code_extra = obj['postal_code_extra']
end

Instance Attribute Details

#administrative_area ⇒ Object (readonly)

Returns the value of attribute administrative_area.



6
7
8
 
# File 'lib/smartystreets_ruby_sdk/international_postal_code/candidate.rb', line 6

def administrative_area
  @administrative_area
end

#country_iso_3 ⇒ Object (readonly)

Returns the value of attribute country_iso_3.



6
7
8
 
# File 'lib/smartystreets_ruby_sdk/international_postal_code/candidate.rb', line 6

def country_iso_3
  @country_iso_3
end

#dependent_locality ⇒ Object (readonly)

Returns the value of attribute dependent_locality.



6
7
8
 
# File 'lib/smartystreets_ruby_sdk/international_postal_code/candidate.rb', line 6

def dependent_locality
  @dependent_locality
end

#dependent_locality_name ⇒ Object (readonly)

Returns the value of attribute dependent_locality_name.



6
7
8
 
# File 'lib/smartystreets_ruby_sdk/international_postal_code/candidate.rb', line 6

def dependent_locality_name
  @dependent_locality_name
end

#double_dependent_locality ⇒ Object (readonly)

Returns the value of attribute double_dependent_locality.



6
7
8
 
# File 'lib/smartystreets_ruby_sdk/international_postal_code/candidate.rb', line 6

def double_dependent_locality
  @double_dependent_locality
end

#input_id ⇒ Object (readonly)

Returns the value of attribute input_id.



6
7
8
 
# File 'lib/smartystreets_ruby_sdk/international_postal_code/candidate.rb', line 6

def input_id
  @input_id
end

#locality ⇒ Object (readonly)

Returns the value of attribute locality.



6
7
8
 
# File 'lib/smartystreets_ruby_sdk/international_postal_code/candidate.rb', line 6

def locality
  @locality
end

#postal_code ⇒ Object (readonly)

Returns the value of attribute postal_code.



6
7
8
 
# File 'lib/smartystreets_ruby_sdk/international_postal_code/candidate.rb', line 6

def postal_code
  @postal_code
end

#postal_code_extra ⇒ Object (readonly)

Returns the value of attribute postal_code_extra.



6
7
8
 
# File 'lib/smartystreets_ruby_sdk/international_postal_code/candidate.rb', line 6

def postal_code_extra
  @postal_code_extra
end

#sub_administrative_area ⇒ Object (readonly)

Returns the value of attribute sub_administrative_area.



6
7
8
 
# File 'lib/smartystreets_ruby_sdk/international_postal_code/candidate.rb', line 6

def sub_administrative_area
  @sub_administrative_area
end

#super_administrative_area ⇒ Object (readonly)

Returns the value of attribute super_administrative_area.



6
7
8
 
# File 'lib/smartystreets_ruby_sdk/international_postal_code/candidate.rb', line 6

def super_administrative_area
  @super_administrative_area
end