smartystreets_ruby_sdk 5.20.4 → 5.20.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c554ac1a2e41bfab06caaf370cc2c3650cf8978d4a9124b9d264d2fb0e816a52
-  data.tar.gz: 3665b21cad59e010cc754c4f92a6c353857537e1634a4b119d5b56f7bb405e93
+  metadata.gz: fb1b572ed0d7aba94f6e82270f168dac48b8f2814f9a91802a319f582ad4d7d6
+  data.tar.gz: 270bfca4f6bba08d859695b76f19ce6e0b0247d2a4fb23cfdb545f0e5189638f
 SHA512:
-  metadata.gz: 1e9118f8e575962fc0e0381687baf92ed8fcb1bb004699dd90a38737a8064108577b63a29d57d2a93abae1df260e7af70599e0415fc9719f9bde185b8ec5f519
-  data.tar.gz: d7753e3c65e0a7a4c5c734c60caf3f03c725f952ecc411ab459e55cbbf90edc41cd10e649b3f31cfba80fa706c4f90a3977b81d0279127aafec2cfd055ead680
+  metadata.gz: e1bfd01e7f995219aac05c965e00e76db458f7dae632820284aa6e921676f1562d6e7ca30fa2a055561df2d64d4214946527f3cc1cb7dabf06d4298bd831af46
+  data.tar.gz: 3e62baa76c824148527367128b27ab849f022f89572213fa5b8e99f38b1548baca72726b3f91eca9ad084e929843356c9462cc1ff4ac12d5a7cbb9c12ccf058d

data/examples/international_autocomplete_example.rb

@@ -32,6 +32,8 @@ class InternationalAutocompleteExample
     lookup.country = "FRA"
     lookup.locality = "Paris"
 
+    # lookup.add_custom_parameter('parameter', 'value')
+
     suggestions = client.send(lookup) # The client will also return the suggestions directly
 
     puts

data/examples/international_example.rb

@@ -38,6 +38,8 @@ class InternationalExample
     lookup.country = 'Brazil'
     lookup.postal_code = '02516-050'
 
+    # lookup.add_custom_parameter('parameter', 'value')
+
     candidates = client.send_lookup(lookup) # The candidates are also stored in the lookup's 'result' field.
 
     first_candidate = candidates[0]

data/examples/us_autocomplete_pro_example.rb

@@ -39,6 +39,8 @@ class USAutocompleteProExample
     lookup.prefer_ratio = 3
     lookup.source = "all"
 
+    # lookup.add_custom_parameter('parameter', 'value')
+
     suggestions = client.send(lookup) # The client will also return the suggestions directly
 
     puts

data/examples/us_enrichment_example.rb

@@ -33,7 +33,9 @@ class USEnrichmentAddressExample
     lookup.city = "Somerville"
     lookup.state = "NJ"
     lookup.zipcode = "08876"
-    #lookup.etag = "AUBAGDQDAIGQYCYC"
+    # lookup.etag = "AUBAGDQDAIGQYCYC"
+
+    # lookup.add_custom_parameter('parameter', 'value')
 
     # Or, create a freeform lookup to search using a single line address
     freeform_lookup = SmartyStreets::USEnrichment::Lookup.new

data/examples/us_extract_example.rb

@@ -37,6 +37,8 @@ class USExtractExample
     lookup.addresses_per_line = 2
     lookup.match =  SmartyStreets::USStreet::MatchType::ENHANCED
 
+    # lookup.add_custom_parameter('parameter', 'value')
+
     result = client.send(lookup)
 
     metadata = result.metadata

data/examples/us_reverse_geo_example.rb

@@ -29,6 +29,8 @@ class USReverseGeoExample
 
     lookup = Lookup.new(40.111111, -111.111111)
 
+    # lookup.add_custom_parameter('parameter', 'value')
+
     response = client.send(lookup)
     result = response.results[0]
 

data/examples/us_street_multiple_address_example.rb

@@ -44,6 +44,8 @@ class USStreetMultipleAddressExample
                                       # this will always return at least one result even if the address is invalid.
                                       # Refer to the documentation for additional Match Strategy options.
 
+    # batch[0].add_custom_parameter('parameter', 'value')
+
     batch.add(Lookup.new('1 Rosedale, Baltimore, Maryland')) # Freeform addresses work too.
     batch[1].candidates = 10 # Allows up to ten possible matches to be returned (default is 1).
 

data/examples/us_street_single_address_example.rb

@@ -40,11 +40,14 @@ class USStreetSingleAddressExample
     lookup.state = 'CA'
     lookup.zipcode = '21229'
     lookup.candidates = 3
+    lookup.county_source = SmartyStreets::USStreet::CountySource::GEOGRAPHIC
     lookup.match = SmartyStreets::USStreet::MatchType::INVALID
                                     # "invalid" is the most permissive match,
                                     # this will always return at least one result even if the address is invalid.
                                     # Refer to the documentation for additional Match Strategy options.
 
+    # lookup.add_custom_parameter('parameter', 'value')
+
     begin
       client.send_lookup(lookup)
     rescue SmartyStreets::SmartyError => err

data/examples/us_zipcode_multiple_lookup_example.rb

@@ -29,6 +29,8 @@ class USZipcodeMultipleLookupExample
     batch[0].input_id = '01189998819991197253' # Optional ID from your system
     batch[0].zipcode = '12345' # A Lookup may have a ZIP Code, city and state, or city, state, and ZIP Code
 
+    # batch[0].add_custom_parameter('parameter', 'value')
+
     batch.add(Lookup.new)
     batch[1].city = 'Phoenix'
     batch[1].state = 'Arizona'

data/examples/us_zipcode_single_lookup_example.rb

@@ -27,6 +27,8 @@ class UsZipcodeSingleLookupExample
     lookup.state = 'California'
     lookup.zipcode = '94043'
 
+    # lookup.add_custom_parameter('parameter', 'value')
+
     begin
       client.send_lookup(lookup)
     rescue SmartyStreets::SmartyError => err

data/lib/smartystreets_ruby_sdk/international_autocomplete/client.rb

@@ -42,6 +42,10 @@ module SmartyStreets
         add_parameter(request, 'include_only_locality', lookup.locality)
         add_parameter(request, 'include_only_postal_code', lookup.postal_code)
 
+        for key in lookup.custom_param_hash.keys do
+          add_parameter(request, key, lookup.custom_param_hash[key])
+        end
+
         request
       end
 

data/lib/smartystreets_ruby_sdk/international_autocomplete/lookup.rb

@@ -6,9 +6,9 @@ module SmartyStreets
     # of the lookup after it comes back from the API.
     class Lookup < JSONAble
 
-      attr_accessor :result, :search, :address_id, :country, :max_results, :locality, :postal_code
+      attr_accessor :result, :search, :address_id, :country, :max_results, :locality, :postal_code, :custom_param_hash
 
-      def initialize(search = nil, address_id = nil, country = nil, max_results = nil, locality = nil, postal_code = nil)
+      def initialize(search = nil, address_id = nil, country = nil, max_results = nil, locality = nil, postal_code = nil, custom_param_hash = nil)
         @result = []
         @search = search
         @address_id = address_id
@@ -16,6 +16,11 @@ module SmartyStreets
         @max_results = max_results
         @locality = locality
         @postal_code = postal_code
+        @custom_param_hash = {}
+      end
+
+      def add_custom_parameter(parameter, value)
+        @custom_param_hash[parameter] = value
       end
     end
   end

data/lib/smartystreets_ruby_sdk/international_street/client.rb

@@ -54,6 +54,10 @@ module SmartyStreets
         add_parameter(request, 'administrative_area', lookup.administrative_area)
         add_parameter(request, 'postal_code', lookup.postal_code)
 
+        for key in lookup.custom_param_hash.keys do
+          add_parameter(request, key, lookup.custom_param_hash[key])
+        end
+
         request
       end
 

data/lib/smartystreets_ruby_sdk/international_street/lookup.rb

@@ -15,7 +15,7 @@ module SmartyStreets
     class Lookup
 
       attr_accessor :input_id, :freeform, :locality, :postal_code, :address3, :address2, :inputId, :address1,
-                    :geocode, :administrative_area, :country, :organization, :language, :address4, :result
+                    :geocode, :administrative_area, :country, :organization, :language, :address4, :result, :custom_param_hash
 
       def initialize(freeform=nil, country=nil)
         @result = []
@@ -33,6 +33,11 @@ module SmartyStreets
         @locality = nil
         @administrative_area = nil
         @postal_code = nil
+        @custom_param_hash = {}
+      end
+
+      def add_custom_parameter(parameter, value)
+        @custom_param_hash[parameter] = value
       end
 
       def missing_country

data/lib/smartystreets_ruby_sdk/us_autocomplete_pro/client.rb

@@ -51,6 +51,10 @@ module SmartyStreets
         end
         add_parameter(request, 'selected', lookup.selected)
 
+        for key in lookup.custom_param_hash.keys do
+          add_parameter(request, key, lookup.custom_param_hash[key])
+        end
+
         request
       end
 

data/lib/smartystreets_ruby_sdk/us_autocomplete_pro/lookup.rb

@@ -10,11 +10,11 @@ module SmartyStreets
 
       attr_accessor :result, :search, :max_results, :city_filter, :state_filter, :zip_filter,
                     :exclude_states, :prefer_cities, :prefer_states, :prefer_zip_codes, :prefer_ratio,
-                    :prefer_geolocation, :selected, :source
+                    :prefer_geolocation, :selected, :source, :custom_param_hash
 
       def initialize(search=nil, max_results=nil, city_filter=nil, state_filter=nil, zip_filter=nil,
                      exclude_states=nil, prefer_cities=nil, prefer_states=nil, prefer_zips=nil, prefer_ratio=nil,
-                     prefer_geolocation=nil, selected=nil, source=nil)
+                     prefer_geolocation=nil, selected=nil, source=nil, custom_param_hash=nil)
         @result = []
         @search = search
         @max_results = max_results
@@ -29,6 +29,11 @@ module SmartyStreets
         @prefer_geolocation = prefer_geolocation
         @selected = selected
         @source = source
+        @custom_param_hash = {}
+      end
+
+      def add_custom_parameter(parameter, value)
+        @custom_param_hash[parameter] = value
       end
 
       def add_city_filter(city)

data/lib/smartystreets_ruby_sdk/us_enrichment/client.rb

@@ -105,6 +105,9 @@ module SmartyStreets
                         smarty_request.url_components = '/' + lookup.smarty_key + '/' + lookup.data_set + '/' + lookup.data_sub_set
                     end
                 end
+                for key in lookup.custom_param_hash.keys do
+                    add_parameter(smarty_request, key, lookup.custom_param_hash[key])
+                end
                 
 
                 response = @sender.send(smarty_request)

data/lib/smartystreets_ruby_sdk/us_enrichment/geo_reference/lookup.rb

@@ -2,13 +2,18 @@ module SmartyStreets
   module USEnrichment
     module GeoReference
       class Lookup
-        attr_reader :smarty_key, :data_set, :data_sub_set, :etag
+        attr_reader :smarty_key, :data_set, :data_sub_set, :etag, :custom_param_hash
 
-        def initialize(smarty_key, etag=nil)
+        def initialize(smarty_key, etag=nil, custom_param_hash=nil)
           @smarty_key = smarty_key
           @data_set = 'geo-reference'
           @data_sub_set = nil
           @etag = etag
+          @custom_param_hash = {}
+        end
+
+        def add_custom_parameter(parameter, value)
+          @custom_param_hash[parameter] = value
         end
       end
     end

data/lib/smartystreets_ruby_sdk/us_enrichment/lookup.rb

@@ -2,9 +2,9 @@ require_relative '../json_able'
 module SmartyStreets
   module USEnrichment
     class Lookup < JSONAble
-      attr_accessor :smarty_key, :data_set, :data_sub_set, :freeform, :street, :city, :state, :zipcode, :etag
+      attr_accessor :smarty_key, :data_set, :data_sub_set, :freeform, :street, :city, :state, :zipcode, :etag, :custom_param_hash
               
-      def initialize(smarty_key=nil, data_set=nil, data_sub_set=nil, freeform=nil, street=nil, city=nil, state=nil, zipcode=nil, etag=nil)
+      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
@@ -14,6 +14,11 @@ module SmartyStreets
         @state = state
         @zipcode = zipcode
         @etag = etag
+        @custom_param_hash = {}
+      end
+
+      def add_custom_parameter(parameter, value)
+        @custom_param_hash[parameter] = value
       end
     end
   end

data/lib/smartystreets_ruby_sdk/us_enrichment/property/financial/lookup.rb

@@ -3,13 +3,18 @@ module SmartyStreets
         module Property
             module Financial
                 class Lookup
-                    attr_reader :smarty_key, :data_set, :data_sub_set, :etag
+                    attr_reader :smarty_key, :data_set, :data_sub_set, :etag, :custom_param_hash
                     
-                    def initialize(smarty_key, etag=nil)
+                    def initialize(smarty_key, etag=nil, custom_param_hash=nil)
                         @smarty_key = smarty_key
                         @data_set = "property"
                         @data_sub_set = "financial"
                         @etag = etag
+                        @custom_param_hash = {}
+                    end
+
+                    def add_custom_parameter(parameter, value)
+                        @custom_param_hash[parameter] = value
                     end
                 end
             end

data/lib/smartystreets_ruby_sdk/us_enrichment/property/principal/lookup.rb

@@ -3,13 +3,18 @@ module SmartyStreets
         module Property
             module Principal
                 class Lookup
-                    attr_reader :smarty_key, :data_set, :data_sub_set, :etag
+                    attr_reader :smarty_key, :data_set, :data_sub_set, :etag, :custom_param_hash
                     
-                    def initialize(smarty_key, etag=nil)
+                    def initialize(smarty_key, etag=nil, custom_param_hash=nil)
                         @smarty_key = smarty_key
                         @data_set = "property"
                         @data_sub_set = "principal"
                         @etag = etag
+                        @custom_param_hash = {}
+                    end
+
+                    def add_custom_parameter(parameter, value)
+                        @custom_param_hash[parameter] = value
                     end
                 end
             end

data/lib/smartystreets_ruby_sdk/us_enrichment/secondary/count/lookup.rb

@@ -3,13 +3,18 @@ module SmartyStreets
     module Secondary
       module Count
         class Lookup
-          attr_reader :smarty_key, :data_set, :data_sub_set, :etag
+          attr_reader :smarty_key, :data_set, :data_sub_set, :etag, :custom_param_hash
               
-          def initialize(smarty_key, etag=nil)
+          def initialize(smarty_key, etag=nil, custom_param_hash=nil)
             @smarty_key = smarty_key
             @data_set = "secondary"
             @data_sub_set = "count"
             @etag = etag
+            @custom_param_hash = {}
+          end
+
+          def add_custom_parameter(parameter, value)
+            @custom_param_hash[parameter] = value
           end
         end
       end

data/lib/smartystreets_ruby_sdk/us_enrichment/secondary/lookup.rb

@@ -2,13 +2,18 @@ module SmartyStreets
   module USEnrichment
     module Secondary
       class Lookup
-        attr_reader :smarty_key, :data_set, :data_sub_set, :etag
+        attr_reader :smarty_key, :data_set, :data_sub_set, :etag, :custom_param_hash
               
-        def initialize(smarty_key, etag=nil)
+        def initialize(smarty_key, etag=nil, custom_param_hash=nil)
           @smarty_key = smarty_key
           @data_set = "secondary"
           @data_sub_set = nil
           @etag = etag
+          @custom_param_hash = {}
+        end
+
+        def add_custom_parameter(parameter, value)
+          @custom_param_hash[parameter] = value
         end
       end
     end

data/lib/smartystreets_ruby_sdk/us_extract/client.rb

@@ -41,6 +41,10 @@ module SmartyStreets
           add_parameter(request, 'match', lookup.match)
         end
 
+        for key in lookup.custom_param_hash.keys do
+          add_parameter(request, key, lookup.custom_param_hash[key])
+        end
+
         request
       end
 

data/lib/smartystreets_ruby_sdk/us_extract/lookup.rb

@@ -7,9 +7,9 @@ module SmartyStreets
     #
     # See "https://smartystreets.com/docs/cloud/us-extract-api#http-request-input-fields"
     class Lookup < JSONAble
-      attr_accessor :text, :result, :aggressive, :addresses_per_line, :html, :addresses_have_line_breaks, :match
+      attr_accessor :text, :result, :aggressive, :addresses_per_line, :html, :addresses_have_line_breaks, :match, :custom_param_hash
 
-      def initialize(text=nil, html=nil, aggressive=nil, addresses_have_line_breaks=nil, addresses_per_line=nil, match=nil)
+      def initialize(text=nil, html=nil, aggressive=nil, addresses_have_line_breaks=nil, addresses_per_line=nil, match=nil, custom_param_hash=nil)
         @text = text
         @html = html
         @aggressive = aggressive
@@ -17,6 +17,11 @@ module SmartyStreets
         @addresses_per_line = addresses_per_line
         @match = match
         @result = nil
+        @custom_param_hash = {}
+      end
+
+      def add_custom_parameter(parameter, value)
+        @custom_param_hash[parameter] = value
       end
     end
   end

data/lib/smartystreets_ruby_sdk/us_reverse_geo/client.rb

@@ -28,6 +28,10 @@ module SmartyStreets
         add_parameter(request, 'longitude', lookup.longitude)
         add_parameter(request, 'source', lookup.source)
 
+        for key in lookup.custom_param_hash.keys do
+          add_parameter(request, key, lookup.custom_param_hash[key])
+        end
+
         request
       end
 

data/lib/smartystreets_ruby_sdk/us_reverse_geo/lookup.rb

@@ -10,12 +10,17 @@ module SmartyStreets
 
     class Lookup
 
-      attr_accessor :latitude, :longitude, :source, :response
+      attr_accessor :latitude, :longitude, :source, :response, :custom_param_hash
 
-      def initialize(latitude, longitude, source)
+      def initialize(latitude, longitude, source=nil, custom_param_hash=nil)
         @latitude = sprintf('%.8f', latitude)
         @longitude = sprintf('%.8f', longitude)
         @source = source
+        @custom_param_hash = {}
+      end
+
+      def add_custom_parameter(parameter, value)
+        @custom_param_hash[parameter] = value
       end
     end
   end

data/lib/smartystreets_ruby_sdk/us_street/client.rb

@@ -62,6 +62,12 @@ module SmartyStreets
           converted_lookup['match'] = lookup.match
           converted_lookup['candidates'] = lookup.candidates
           converted_lookup['format'] = lookup.format
+          converted_lookup['county_source'] = lookup.county_source
+
+          for key in lookup.custom_param_hash.keys do
+            converted_lookup[key] = lookup.custom_param_hash[key]
+          end
+
           converted_obj.push(converted_lookup)
         end
         converted_obj

data/lib/smartystreets_ruby_sdk/us_street/lookup.rb

@@ -9,10 +9,10 @@ module SmartyStreets
     # @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, :result
+                    :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, format=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
@@ -26,8 +26,15 @@ module SmartyStreets
         @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

data/lib/smartystreets_ruby_sdk/us_street/match_type.rb

@@ -10,5 +10,10 @@ module SmartyStreets
       DEFAULT = 'default'.freeze
       PROJECT_USA = 'project-usa'.freeze
     end
+
+    module CountySource
+      POSTAL = 'postal'.freeze
+      GEOGRAPHIC = 'geographic'.freeze
+    end
   end
 end

data/lib/smartystreets_ruby_sdk/us_zipcode/client.rb

@@ -58,6 +58,10 @@ module SmartyStreets
           add_field(converted_lookup, 'state', lookup.state)
           add_field(converted_lookup, 'zipcode', lookup.zipcode)
 
+          for key in lookup.custom_param_hash.keys do
+            add_field(converted_lookup, key, lookup.custom_param_hash[key])
+          end
+
           converted_obj.push(converted_lookup)
         end
 

data/lib/smartystreets_ruby_sdk/us_zipcode/lookup.rb

@@ -7,14 +7,19 @@ module SmartyStreets
     #
     #   See "https://smartystreets.com/docs/cloud/us-zipcode-api#http-request-input-fields"
     class Lookup < JSONAble
-      attr_accessor :result, :state, :zipcode, :input_id, :city
+      attr_accessor :result, :state, :zipcode, :input_id, :city, :custom_param_hash
 
-      def initialize(city=nil, state=nil, zipcode=nil, input_id=nil)
+      def initialize(city=nil, state=nil, zipcode=nil, input_id=nil, custom_param_hash=nil)
         @result = nil
         @input_id = input_id
         @city = city
         @state = state
         @zipcode = zipcode
+        @custom_param_hash = {}
+      end
+
+      def add_custom_parameter(parameter, value)
+        @custom_param_hash[parameter] = value
       end
     end
   end

data/lib/smartystreets_ruby_sdk/version.rb

@@ -1,3 +1,3 @@
 module SmartyStreets
-  VERSION = '5.20.4' # DO NOT EDIT (this is updated by a build job when a new release is published)
+  VERSION = '5.20.6' # DO NOT EDIT (this is updated by a build job when a new release is published)
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: smartystreets_ruby_sdk
 version: !ruby/object:Gem::Version
-  version: 5.20.4
+  version: 5.20.6
 platform: ruby
 authors:
 - SmartyStreets SDK Team
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-11-01 00:00:00.000000000 Z
+date: 2024-11-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler