smartystreets_ruby_sdk 5.18.1 → 5.20.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cf9f006e4b5ed5f2f1b33ef7abab3044db467d5cd377cd2d8b6d7ca79953f516
-  data.tar.gz: c8f614070a3b5e0a06e0fa9f0654387bda1dfab10e5763834ea89bd1bd4a3b82
+  metadata.gz: feea3fd221e9e87912c8d35bd636b8c295ae0415ef20cc45880b330d1199ce3f
+  data.tar.gz: e0d8168d70e4edf32906f49ec0cb39b1f7890804a7067e80cf7538e1db1ba24c
 SHA512:
-  metadata.gz: d4f52e42db666abd8ef54d6332765b7e27b635e6843dbb354a4087634ce46571f742cb40a272ba9039064416178f7b141d0e7f1377aaffbad6abf27fcc2cae9e
-  data.tar.gz: 797b4818853ddefc8f84a57b1b37f9ed44d83072aad27c4d156836ef8e6fde3acefc6c06b83f2afa3ad154664312deb86730193f5695fbf2a322b5127205c8fa
+  metadata.gz: 17120bcc323bd9dd58ce32520fdfe8993afaf352dd595bbc2316a33cddd5e8ab44b4c2728b807488ab601be72e68a4627b5ea3a5b4a5825bb9843e0ffeb2e0eb
+  data.tar.gz: a9535cac7038a34e74101d551781368d883c9aafd12ef9b5dbe52d37c158cf8d3253cb179a1ce2a872cb928660a40c599e92a163ee3e7f1d4a0fbfcc165d64d7

data/examples/us_enrichment_example.rb

@@ -1,6 +1,7 @@
 require '../lib/smartystreets_ruby_sdk/static_credentials'
 require '../lib/smartystreets_ruby_sdk/shared_credentials'
 require '../lib/smartystreets_ruby_sdk/client_builder'
+require '../lib/smartystreets_ruby_sdk/us_enrichment/lookup'
 
 class USEnrichmentAddressExample
   def run
@@ -24,9 +25,35 @@ class USEnrichmentAddressExample
     client = SmartyStreets::ClientBuilder.new(credentials).
              build_us_enrichment_api_client
     result = nil
+
+    # Create a new lookup instance to search with address components
+    lookup = SmartyStreets::USEnrichment::Lookup.new
+
+    lookup.street = "56 Union Ave"
+    lookup.city = "Somerville"
+    lookup.state = "NJ"
+    lookup.zipcode = "08876"
+
+    # Or, create a freeform lookup to search using a single line address
+    freeform_lookup = SmartyStreets::USEnrichment::Lookup.new
+    freeform_lookup.freeform = "56 Union Ave Somerville NJ 08876"
+
+    
+
     begin
-      result = client.send_property_financial_lookup("765613032")
-    #   result = client.send_property_principal_lookup("765613032")
+      # Send a lookup with a smarty key using the line below
+      result = client.send_property_principal_lookup("325023201")
+
+      # Uncomment the following lines to perform other types of lookups:
+      # result = client.send_property_principal_lookup(lookup) # Using address components
+      # result = client.send_property_principal_lookup(freeform_lookup) # Using freeform address
+       
+      # Access the other Enrichment datasets using the below functions. All of these functions can take a lookup or a smartykey
+      # result = client.send_property_financial_lookup("325023201")
+      # result = client.send_geo_reference_lookup("325023201")
+      # result = client.send_secondary_lookup("325023201")
+      # result = client.send_secondary_count_lookup("325023201")
+
     rescue SmartyStreets::SmartyError => err
       puts err
       return

data/lib/smartystreets_ruby_sdk/us_enrichment/client.rb

@@ -2,6 +2,13 @@ require_relative "property/financial/response"
 require_relative "property/principal/response"
 require_relative "property/financial/lookup"
 require_relative "property/principal/lookup"
+require_relative "geo_reference/response"
+require_relative "geo_reference/lookup"
+require_relative "secondary/response"
+require_relative "secondary/lookup"
+require_relative "secondary/count/response"
+require_relative "secondary/count/lookup"
+require_relative "lookup"
 require_relative '../request'
 
 module SmartyStreets
@@ -12,20 +19,89 @@ module SmartyStreets
                 @serializer = serializer
             end
 
-            def send_property_financial_lookup(smarty_key)
-                __send(USEnrichment::Property::Financial::Lookup.new(smarty_key))
+            def send_property_financial_lookup(lookup)
+                if (lookup.instance_of? String)
+                    __send(USEnrichment::Property::Financial::Lookup.new(lookup))
+                elsif (lookup.instance_of? USEnrichment::Lookup)
+                    lookup.data_set = 'property'
+                    lookup.data_sub_set = 'financial'
+                    __send(lookup)
+                end
+            end
+
+            def send_property_principal_lookup(lookup)
+                if (lookup.instance_of? String)
+                    __send(USEnrichment::Property::Principal::Lookup.new(lookup))
+                elsif (lookup.instance_of? USEnrichment::Lookup)
+                    lookup.data_set = 'property'
+                    lookup.data_sub_set = 'principal'
+                    __send(lookup)
+                end
+            end
+
+            def send_geo_reference_lookup(lookup)
+                if (lookup.instance_of? String)
+                    __send(USEnrichment::GeoReference::Lookup.new(lookup))
+                elsif (lookup.instance_of? USEnrichment::Lookup)
+                    lookup.data_set = 'geo-reference'
+                    lookup.data_sub_set = nil
+                    __send(lookup)
+                end
+            end
+
+            def send_secondary_lookup(lookup)
+                if (lookup.instance_of? String)
+                    __send(USEnrichment::Secondary::Lookup.new(lookup))
+                elsif (lookup.instance_of? USEnrichment::Lookup)
+                    lookup.data_set = 'secondary'
+                    lookup.data_sub_set = nil
+                    __send(lookup)
+                end
             end
 
-            def send_property_principal_lookup(smarty_key)
-                __send(USEnrichment::Property::Principal::Lookup.new(smarty_key))
+            def send_secondary_count_lookup(lookup)
+                if (lookup.instance_of? String)
+                    __send(USEnrichment::Secondary::Count::Lookup.new(lookup))
+                elsif (lookup.instance_of? USEnrichment::Lookup)
+                    lookup.data_set = 'secondary'
+                    lookup.data_sub_set = 'count'
+                    __send(lookup)
+                end
+            end
+
+            def send_generic_lookup(lookup, data_set, data_sub_set = nil)
+                if (lookup.instance_of? String)
+                    __send(USEnrichment::Lookup.new(lookup, data_set, data_sub_set))
+                elsif (lookup.instance_of? USEnrichment::Lookup)
+                    lookup.data_set = data_set
+                    lookup.data_sub_set = data_sub_set
+                    __send(lookup)
+                end
             end
 
             def __send(lookup)
                 smarty_request = Request.new
 
                 return if lookup.nil?
-
-                smarty_request.url_components = '/' + lookup.smarty_key + '/' + lookup.data_set + '/' + lookup.data_sub_set
+                if (lookup.smarty_key.nil?)
+                    if (lookup.data_sub_set.nil?)
+                        smarty_request.url_components = '/search/' + lookup.data_set
+                    else
+                        smarty_request.url_components = '/search/' + lookup.data_set + '/' + lookup.data_sub_set
+                    end
+                    add_parameter(smarty_request, 'freeform', lookup.freeform)
+                    add_parameter(smarty_request, 'street', lookup.street)
+                    add_parameter(smarty_request, 'city', lookup.city)
+                    add_parameter(smarty_request, 'state', lookup.state)
+                    add_parameter(smarty_request, 'zipcode', lookup.zipcode)
+                else
+                    if (lookup.data_sub_set.nil?)
+                        smarty_request.url_components = '/' + lookup.smarty_key + '/' + lookup.data_set
+                    else
+                        smarty_request.url_components = '/' + lookup.smarty_key + '/' + lookup.data_set + '/' + lookup.data_sub_set
+                    end
+                end
+                
 
                 response = @sender.send(smarty_request)
                 results = @serializer.deserialize(response.payload)
@@ -42,10 +118,24 @@ module SmartyStreets
                     if lookup.data_sub_set == "principal"
                         result = USEnrichment::Property::Principal::Response.new(raw_result)
                     end
+                    if lookup.data_set == "geo-reference"
+                      result = USEnrichment::GeoReference::Response.new(raw_result)
+                    end
+                    if lookup.data_set == "secondary"
+                      if lookup.data_sub_set == "count"
+                        result = USEnrichment::Secondary::Count::Response.new(raw_result)
+                      elsif lookup.data_sub_set.nil?
+                        result = USEnrichment::Secondary::Response.new(raw_result)
+                      end
+                    end
                     output << result
                 end
                 output
             end
+
+            def add_parameter(request, key, value)
+                request.parameters[key] = value unless value.nil? or value.empty?
+            end
         end
     end
 end

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

@@ -0,0 +1,23 @@
+require_relative 'census_block_entry'
+require_relative 'census_county_division_entry'
+require_relative 'census_tract_entry'
+require_relative 'core_based_stat_area_entry'
+require_relative 'place_entry'
+
+module SmartyStreets
+    module USEnrichment
+        module GeoReference
+            class Attributes
+                attr_reader :census_block, :census_county_division, :census_tract, :core_based_stat_area, :place
+            
+                def initialize(obj)
+                    @census_block = GeoReference::CensusBlockEntry.new(obj['census_block'])
+                    @census_county_division = GeoReference::CensusCountyDivisionEntry.new(obj['census_county_division'])
+                    @census_tract = GeoReference::CensusTractEntry.new(obj['census_tract'])
+                    @core_based_stat_area = GeoReference::CoreBasedStatAreaEntry.new(obj['core_based_stat_area'])
+                    @place = GeoReference::PlaceEntry.new(obj['place'])
+                end
+            end
+        end
+    end
+end

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

@@ -0,0 +1,14 @@
+module SmartyStreets
+  module USEnrichment
+    module GeoReference
+      class CensusBlockEntry
+        attr_reader :accuracy, :geoid
+
+        def initialize(obj)
+          @accuracy = obj['accuracy']
+          @geoid = obj['geoid']
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+module SmartyStreets
+  module USEnrichment
+    module GeoReference
+      class CensusCountyDivisionEntry
+        attr_reader :accuracy, :code, :name
+        
+        def initialize(obj)
+          @accuracy = obj['accuracy']
+          @code = obj['code']
+          @name = obj['name']
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,13 @@
+module SmartyStreets
+  module USEnrichment
+    module GeoReference
+      class CensusTractEntry
+        attr_reader :code
+        
+        def initialize(obj)
+          @code = obj['code']
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,14 @@
+module SmartyStreets
+  module USEnrichment
+    module GeoReference
+      class CoreBasedStatAreaEntry
+        attr_reader :code, :name
+        
+        def initialize(obj)
+          @code = obj['code']
+          @name = obj['name']
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+module SmartyStreets
+  module USEnrichment
+    module GeoReference
+      class Lookup
+        attr_reader :smarty_key, :data_set, :data_sub_set
+
+        def initialize(smarty_key)
+          @smarty_key = smarty_key
+          @data_set = 'geo-reference'
+          @data_sub_set = nil
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,16 @@
+module SmartyStreets
+  module USEnrichment
+    module GeoReference
+      class PlaceEntry
+        attr_reader :accuracy, :code, :name, :type
+        
+        def initialize(obj)
+          @accuracy = obj['accuracy']
+          @code = obj['code']
+          @name = obj['name']
+          @type = obj['type']
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+require_relative "attributes"
+
+module SmartyStreets
+  module USEnrichment
+    module GeoReference
+      class Response
+        attr_reader :smarty_key, :data_set, :attributes
+
+        def initialize(obj)
+          @smarty_key = obj['smarty_key']
+          @data_set = 'geo-reference'
+          @attributes = Attributes.new(obj['attributes'])
+        end
+      end
+    end
+  end
+end

data/lib/smartystreets_ruby_sdk/us_enrichment/lookup.rb

@@ -0,0 +1,19 @@
+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
+              
+      def initialize(smarty_key=nil, data_set=nil, data_sub_set=nil, freeform=nil, street=nil, city=nil, state=nil, zipcode=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
+      end
+    end
+  end
+end

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

@@ -0,0 +1,23 @@
+module SmartyStreets
+  module USEnrichment
+    module Secondary
+      class AliasesEntry
+        attr_reader :smarty_key, :primary_number, :street_predirection, :street_name, :street_suffix, :street_postdirection, :city_name,
+        :state_abbreviation, :zipcode, :plus4_code
+
+        def initialize(obj)
+          @smarty_key = obj['smarty_key']
+          @primary_number = obj['primary_number']
+          @street_predirection = obj['street_predirection']
+          @street_name = obj['street_name']
+          @street_suffix = obj['street_suffix']
+          @street_postdirection = obj['street_postdirection']
+          @city_name = obj['city_name']
+          @state_abbreviation = obj['state_abbreviation']
+          @zipcode = obj['zipcode']
+          @plus4_code = obj['plus4_code']
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+module SmartyStreets
+  module USEnrichment
+    module Secondary
+      module Count
+        class Lookup
+          attr_reader :smarty_key, :data_set, :data_sub_set
+              
+          def initialize(smarty_key)
+            @smarty_key = smarty_key
+            @data_set = "secondary"
+            @data_sub_set = "count"
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,16 @@
+module SmartyStreets
+  module USEnrichment
+    module Secondary
+      module Count
+        class Response
+          attr_reader :smarty_key, :count
+
+          def initialize(obj)
+            @smarty_key = obj['smarty_key']
+            @count = obj['count']
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+module SmartyStreets
+  module USEnrichment
+    module Secondary
+      class Lookup
+        attr_reader :smarty_key, :data_set, :data_sub_set
+              
+        def initialize(smarty_key)
+          @smarty_key = smarty_key
+          @data_set = "secondary"
+          @data_sub_set = nil
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,38 @@
+require_relative 'root_address_entry'
+require_relative 'aliases_entry'
+require_relative 'secondaries_entry'
+
+module SmartyStreets
+  module USEnrichment
+    module Secondary
+      class Response
+        attr_reader :smarty_key, :root_address, :aliases, :secondaries
+
+        def initialize(obj)
+          @smarty_key = obj['smarty_key']
+          @root_address = Secondary::RootAddressEntry.new(obj['root_address'])
+          if !obj['aliases'].nil?
+            @aliases = createAliasesArray(obj['aliases'])
+          end
+          @secondaries = createSecondariesArray(obj['secondaries'])
+        end
+
+        def createAliasesArray(obj)
+          aliasesArray = []
+          for item in obj do
+            aliasesArray << Secondary::AliasesEntry.new(item)
+          end
+          return aliasesArray
+        end
+
+        def createSecondariesArray(obj)
+          secondariesArray = []
+          for item in obj do
+            secondariesArray << Secondary::SecondariesEntry.new(item)
+          end
+          return secondariesArray
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,24 @@
+module SmartyStreets
+  module USEnrichment
+    module Secondary
+      class RootAddressEntry
+        attr_reader :secondary_count, :smarty_key, :primary_number, :street_predirection, :street_name, :street_suffix, :street_postdirection,
+        :city_name, :state_abbreviation, :zipcode, :plus4_code
+
+        def initialize(obj)
+          @secondary_count = obj['secondary_count']
+          @smarty_key = obj['smarty_key']
+          @primary_number = obj['primary_number']
+          @street_predirection = obj['street_predirection']
+          @street_name = obj['street_name']
+          @street_suffix = obj['street_suffix']
+          @street_postdirection = obj['street_postdirection']
+          @city_name = obj['city_name']
+          @state_abbreviation = obj['state_abbreviation']
+          @zipcode = obj['zipcode']
+          @plus4_code = obj['plus4_code']
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,16 @@
+module SmartyStreets
+  module USEnrichment
+    module Secondary
+      class SecondariesEntry
+        attr_reader :smarty_key, :secondary_designator, :secondary_number, :plus4_code
+
+        def initialize(obj)
+          @smarty_key = obj['smarty_key']
+          @secondary_designator = obj['secondary_designator']
+          @secondary_number = obj['secondary_number']
+          @plus4_code = obj['plus4_code']
+        end
+      end
+    end
+  end
+end

data/lib/smartystreets_ruby_sdk/version.rb

@@ -1,3 +1,3 @@
 module SmartyStreets
-  VERSION = '5.18.1' # DO NOT EDIT (this is updated by a build job when a new release is published)
+  VERSION = '5.20.2' # 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.18.1
+  version: 5.20.2
 platform: ruby
 authors:
 - SmartyStreets SDK Team
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-07-02 00:00:00.000000000 Z
+date: 2024-09-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -143,6 +143,15 @@ files:
 - lib/smartystreets_ruby_sdk/us_autocomplete_pro/suggestion.rb
 - lib/smartystreets_ruby_sdk/us_enrichment.rb
 - lib/smartystreets_ruby_sdk/us_enrichment/client.rb
+- lib/smartystreets_ruby_sdk/us_enrichment/geo_reference/attributes.rb
+- lib/smartystreets_ruby_sdk/us_enrichment/geo_reference/census_block_entry.rb
+- lib/smartystreets_ruby_sdk/us_enrichment/geo_reference/census_county_division_entry.rb
+- lib/smartystreets_ruby_sdk/us_enrichment/geo_reference/census_tract_entry.rb
+- lib/smartystreets_ruby_sdk/us_enrichment/geo_reference/core_based_stat_area_entry.rb
+- lib/smartystreets_ruby_sdk/us_enrichment/geo_reference/lookup.rb
+- lib/smartystreets_ruby_sdk/us_enrichment/geo_reference/place_entry.rb
+- lib/smartystreets_ruby_sdk/us_enrichment/geo_reference/response.rb
+- lib/smartystreets_ruby_sdk/us_enrichment/lookup.rb
 - lib/smartystreets_ruby_sdk/us_enrichment/property/financial/attributes.rb
 - lib/smartystreets_ruby_sdk/us_enrichment/property/financial/history_entry.rb
 - lib/smartystreets_ruby_sdk/us_enrichment/property/financial/lookup.rb
@@ -150,6 +159,13 @@ files:
 - lib/smartystreets_ruby_sdk/us_enrichment/property/principal/attributes.rb
 - lib/smartystreets_ruby_sdk/us_enrichment/property/principal/lookup.rb
 - lib/smartystreets_ruby_sdk/us_enrichment/property/principal/response.rb
+- lib/smartystreets_ruby_sdk/us_enrichment/secondary/aliases_entry.rb
+- lib/smartystreets_ruby_sdk/us_enrichment/secondary/count/lookup.rb
+- lib/smartystreets_ruby_sdk/us_enrichment/secondary/count/response.rb
+- lib/smartystreets_ruby_sdk/us_enrichment/secondary/lookup.rb
+- lib/smartystreets_ruby_sdk/us_enrichment/secondary/response.rb
+- lib/smartystreets_ruby_sdk/us_enrichment/secondary/root_address_entry.rb
+- lib/smartystreets_ruby_sdk/us_enrichment/secondary/secondaries_entry.rb
 - lib/smartystreets_ruby_sdk/us_extract.rb
 - lib/smartystreets_ruby_sdk/us_extract/address.rb
 - lib/smartystreets_ruby_sdk/us_extract/client.rb