smartystreets_ruby_sdk 5.19.0 → 5.20.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 51cb2a009b7e285e29d6f6fb5e689a365105c69b1ee91988708a54277c646e36
-  data.tar.gz: 2125742bceda76772db7d941461247cc4a30d4bb09a70092d58b51f8857b5281
+  metadata.gz: 3c69c7e08647e5946fbfb968e690c6e6398aa52d8ea2cf2d9d24d332873df006
+  data.tar.gz: f8f16488a89c08c76d1fcbcb6f52d53c44b4c5c98d3b99593a40b6af98b8820d
 SHA512:
-  metadata.gz: 4c24e7dd98c9b13c60567a41f6b41e111cde5dfc65b730541eabca7eb68b9b24d1f67b81165205aa52db00fca1c58efcde3473fe74c2530b77d52ab8230da809
-  data.tar.gz: 9c5ca611177e645518e1dc4dffdc4762a8580dfc1a8a51c0fdd62c0b00a24962c2ef91b5d2e9e73e13760c6c0766c045f205f8bc00d5fa069ad3815dd71bb7b4
+  metadata.gz: 4d6468052deaf16a12101cc6bb0bf89c615ef2b5c97da3e8bf603ce70c09c18a08252f4d4b7fc6c7b735d670c2d63f6d0597256245b6e30aec51aee66b8b72a6
+  data.tar.gz: 01464c7a27f5655fed30d94d496551c14a81b1fe5f6bed77a114366b8578e97db6fcbbb6d7ca64b7744e9eb7ff511699e6ed0304ebeb41e7dc5f9fa90727b5fd

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/international_street/components.rb

@@ -12,7 +12,8 @@ module SmartyStreets
                   :sub_building_name, :postal_code, :dependent_locality, :premise_type, :sub_building_number,
                   :super_administrative_area, :premise_extra, :dependent_thoroughfare_predirection,
                   :building_trailing_type, :thoroughfare_predirection, :building_name, :level_type, :level_number,
-                  :country_iso_3, :sub_building_type
+                  :country_iso_3, :sub_building_type, :additional_content, :delivery_installation, :delivery_installation_type,
+                  :delivery_installation_qualifier_name, :route, :route_number, :route_type
 
       def initialize(obj)
         @country_iso_3 = obj.fetch('country_iso_3', nil)
@@ -58,6 +59,13 @@ module SmartyStreets
         @post_box = obj.fetch('post_box', nil)
         @post_box_type = obj.fetch('post_box_type', nil)
         @post_box_number = obj.fetch('post_box_number', nil)
+        @additional_content = obj.fetch('additional_content', nil)
+        @delivery_installation = obj.fetch('delivery_installation', nil)
+        @delivery_installation_type = obj.fetch('delivery_installation_type', nil)
+        @delivery_installation_qualifier_name = obj.fetch('delivery_installation_qualifier_name', nil)
+        @route = obj.fetch('route', nil)
+        @route_number = obj.fetch('route_number', nil)
+        @route_type = obj.fetch('route_type', nil)
       end
     end
   end

data/lib/smartystreets_ruby_sdk/us_enrichment/client.rb

@@ -19,40 +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(smarty_key)
-                __send(USEnrichment::Property::Principal::Lookup.new(smarty_key))
+            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(smarty_key)
-                __send(USEnrichment::GeoReference::Lookup.new(smarty_key))
+            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(smarty_key)
-                __send(USEnrichment::Secondary::Lookup.new(smarty_key))
+            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_secondary_count_lookup(smarty_key)
-                __send(USEnrichment::Secondary::Count::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(smarty_key, data_set, data_sub_set = nil)
-                __send(USEnrichment::Lookup.new(smarty_key, data_set, data_sub_set))
+            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?
-
-                if (lookup.data_sub_set.nil?)
-                    smarty_request.url_components = '/' + lookup.smarty_key + '/' + lookup.data_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
-                    smarty_request.url_components = '/' + lookup.smarty_key + '/' + lookup.data_set + '/' + lookup.data_sub_set
+                    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)
@@ -83,6 +132,10 @@ module SmartyStreets
                 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/lookup.rb

@@ -1,12 +1,18 @@
+require_relative '../json_able'
 module SmartyStreets
   module USEnrichment
-    class Lookup
-      attr_reader :smarty_key, :data_set, :data_sub_set
+    class Lookup < JSONAble
+      attr_accessor :smarty_key, :data_set, :data_sub_set, :freeform, :street, :city, :state, :zipcode
               
-      def initialize(smarty_key, data_set, data_sub_set)
+      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

data/lib/smartystreets_ruby_sdk/version.rb

@@ -1,3 +1,3 @@
 module SmartyStreets
-  VERSION = '5.19.0' # DO NOT EDIT (this is updated by a build job when a new release is published)
+  VERSION = '5.20.3' # 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.19.0
+  version: 5.20.3
 platform: ruby
 authors:
 - SmartyStreets SDK Team
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-08-12 00:00:00.000000000 Z
+date: 2024-10-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler