Contents

require_relative '../json_able'
module SmartyStreets
  module USStreet
    # In addition to holding all of the input data for this lookup, this class also will contain
    # the result of the lookup after it comes back from the API.
    #
    # See "https://smartystreets.com/docs/cloud/us-street-api#input-fields"
    #
    # @match:: Must be set to 'strict', 'enhanced', or 'invalid'. Constants for these are in match_type.rb
    class Lookup < JSONAble
      attr_accessor :input_id, :street, :street2, :secondary, :city, :state, :zipcode, :lastline, :addressee, :urbanization,
                    :match, :candidates, :format, :county_source, :custom_param_hash, :result

      def initialize(street=nil, street2=nil, secondary=nil, city=nil, state=nil, zipcode=nil, lastline=nil,
                     addressee=nil, urbanization=nil, match=nil, candidates=0, input_id=nil, county_source=nil, format=nil)
        @input_id = input_id
        @street = street
        @street2 = street2
        @secondary = secondary
        @city = city
        @state = state
        @zipcode = zipcode
        @lastline = lastline
        @addressee = addressee
        @urbanization = urbanization
        @match = match
        @candidates = candidates
        @format = format
        @county_source = county_source
        @custom_param_hash = {}
        @result = []
      end

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

    end
  end
end

Version data entries

1 entries across 1 versions & 1 rubygems

Version	Path
smartystreets_ruby_sdk-5.20.6	lib/smartystreets_ruby_sdk/us_street/lookup.rb