smartystreets_ruby_sdk 7.5.0 → 8.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e5e49c113cb830c32e70639e9b7aeb1153b22dde346f12047e7f27c31a7b5c46
-  data.tar.gz: db52d24f0dd8cd9f71296adb65f5531ea55ce8288030347d33446167d0937738
+  metadata.gz: 17d2106514bf57a8000b659a859949a5761637e7020b976b7d291d6c2d7a77ca
+  data.tar.gz: 9a7c861a9547ae6a412239b1e815c5a31cace855da242bfbd46b2da9a730c4d3
 SHA512:
-  metadata.gz: 7c707f24782531ba64d75396693b930444fe05fc7e06ee29b6c2205cf933ee8144d5c28d84710bc4e49a617e65ba5f103acd7c304f507a68c86b2764f90f9185
-  data.tar.gz: f907ea59300dc08d08ad8514b82a5892f19995a820fa484c5a056bf7174a07334a3342926dafa4adf71d4ab63306ea7f8ac4971a78ea7f447ce7cfb6377bfe4a
+  metadata.gz: 42ae40ef8d01607e0310cca3f7b238f702b624bbd0ea88251cb7aa530ce44a91275879f81e4ac0e9cb8a6fc1e4f817346099943d37063a818b42a09476853f56
+  data.tar.gz: 14737b02a4f6ec453a087082776b6ece9c7767d583dc459c4963ab66dec041d550d7814b05edc15c248220f963f86ade13f16b4aba264013cd322afb3e7ff329

data/Makefile

@@ -37,7 +37,7 @@ us_autocomplete_pro_api:
 	cd examples && ruby us_autocomplete_pro_example.rb
 
 us_enrichment_api:
-	cd examples && ruby us_enrichment_example.rb
+	cd examples && ruby us_enrichment_example.rb && ruby us_enrichment_business_example.rb && ruby us_enrichment_etag_example.rb
 
 us_extract_api:
 	cd examples && ruby us_extract_example.rb

data/examples/us_enrichment_business_example.rb

@@ -0,0 +1,72 @@
+require '../lib/smartystreets_ruby_sdk/static_credentials'
+require '../lib/smartystreets_ruby_sdk/shared_credentials'
+require '../lib/smartystreets_ruby_sdk/basic_auth_credentials'
+require '../lib/smartystreets_ruby_sdk/client_builder'
+require '../lib/smartystreets_ruby_sdk/us_enrichment/lookup'
+
+class USEnrichmentBusinessExample
+  def run
+    id = ENV['SMARTY_AUTH_ID']
+    token = ENV['SMARTY_AUTH_TOKEN']
+    credentials = SmartyStreets::BasicAuthCredentials.new(id, token)
+
+    client = SmartyStreets::ClientBuilder.new(credentials).build_us_enrichment_api_client
+
+    smarty_key = "1962995076"
+
+    begin
+      summary_results = client.send_business_lookup(smarty_key)
+    rescue SmartyStreets::SmartyError => err
+      puts err
+      return
+    end
+
+    if summary_results.nil? || summary_results.empty?
+      puts "No response returned for SmartyKey #{smarty_key}"
+      return
+    end
+
+    summary = summary_results[0]
+    if summary.businesses.nil? || summary.businesses.empty?
+      puts "SmartyKey #{smarty_key} has no business tenants"
+      return
+    end
+
+    puts "Summary results for SmartyKey: #{smarty_key}"
+    summary.businesses.each do |biz|
+      puts "  - #{biz.company_name} (ID: #{biz.business_id})"
+    end
+
+    first = summary.businesses[0]
+    puts
+    puts "Fetching details for business: #{first.company_name} (ID: #{first.business_id})"
+
+    begin
+      detail_result = client.send_business_detail_lookup(first.business_id)
+    rescue SmartyStreets::SmartyError => err
+      puts err
+      return
+    end
+
+    if detail_result.nil?
+      puts "No detail result returned"
+      return
+    end
+
+    puts
+    puts "Detail result:"
+    puts "  smarty_key: #{detail_result.smarty_key}"
+    puts "  data_set_name: #{detail_result.data_set_name}"
+    puts "  business_id: #{detail_result.business_id}"
+    attrs = detail_result.attributes
+    return if attrs.nil?
+    attrs.instance_variables.each do |var|
+      value = attrs.instance_variable_get(var)
+      next if value.nil?
+      puts "  #{var.to_s.delete('@')}: #{value}"
+    end
+  end
+end
+
+example = USEnrichmentBusinessExample.new
+example.run

data/examples/us_enrichment_etag_example.rb

@@ -0,0 +1,122 @@
+require '../lib/smartystreets_ruby_sdk/static_credentials'
+require '../lib/smartystreets_ruby_sdk/shared_credentials'
+require '../lib/smartystreets_ruby_sdk/basic_auth_credentials'
+require '../lib/smartystreets_ruby_sdk/client_builder'
+require '../lib/smartystreets_ruby_sdk/us_enrichment/lookup'
+
+class USEnrichmentEtagExample
+  def run
+    id = ENV['SMARTY_AUTH_ID']
+    token = ENV['SMARTY_AUTH_TOKEN']
+    credentials = SmartyStreets::BasicAuthCredentials.new(id, token)
+
+    @client = SmartyStreets::ClientBuilder.new(credentials).build_us_enrichment_api_client
+    smarty_key = "1962995076"
+
+    business_id = exercise_summary_etag(smarty_key)
+    return if business_id.nil?
+
+    exercise_detail_etag(business_id)
+  end
+
+  def exercise_summary_etag(smarty_key)
+    puts "=== Business.Summary ETag round trip ==="
+
+    first = SmartyStreets::USEnrichment::Lookup.new(smarty_key, 'business')
+    begin
+      initial_results = @client.send_business_lookup(first)
+    rescue SmartyStreets::SmartyError => err
+      puts "  Initial Summary call failed: #{err.message}"
+      return nil
+    end
+    captured_etag = first.response_etag
+    puts "  Call 1 (no Etag): captured Etag=#{display(captured_etag)}, results=#{initial_results.nil? ? 0 : initial_results.length}"
+
+    if captured_etag.nil? || captured_etag.empty?
+      puts "  Server did not return an Etag header; skipping conditional calls."
+      return first_business_id(initial_results)
+    end
+
+    second = SmartyStreets::USEnrichment::Lookup.new(smarty_key, 'business')
+    second.request_etag = captured_etag
+    begin
+      @client.send_business_lookup(second)
+      puts "  Call 2 (matching Etag): 200 - server did NOT honor the conditional. Etag=#{display(second.response_etag)}"
+    rescue SmartyStreets::NotModifiedInfo => ex
+      puts "  Call 2 (matching Etag): 304 NotModifiedInfo - caller treats this as cache-valid. Refreshed Etag=#{display(ex.response_etag)}"
+    rescue SmartyStreets::SmartyError => err
+      puts "  Call 2 unexpected failure: #{err.class}: #{err.message}"
+      return nil
+    end
+
+    third = SmartyStreets::USEnrichment::Lookup.new(smarty_key, 'business')
+    third.request_etag = captured_etag + "X"
+    begin
+      @client.send_business_lookup(third)
+      puts "  Call 3 (mutated Etag): 200 as expected. Etag=#{display(third.response_etag)}"
+    rescue SmartyStreets::NotModifiedInfo
+      puts "  Call 3 (mutated Etag): 304 - UNEXPECTED. Server treated a different Etag as matching."
+    rescue SmartyStreets::SmartyError => err
+      puts "  Call 3 unexpected failure: #{err.class}: #{err.message}"
+    end
+
+    first_business_id(initial_results)
+  end
+
+  def exercise_detail_etag(business_id)
+    puts
+    puts "=== Business.Detail ETag round trip (businessId: #{business_id}) ==="
+
+    first = SmartyStreets::USEnrichment::BusinessDetailLookup.new(business_id)
+    begin
+      initial_result = @client.send_business_detail_lookup(first)
+    rescue SmartyStreets::SmartyError => err
+      puts "  Initial Detail call failed: #{err.message}"
+      return
+    end
+    captured_etag = first.response_etag
+    puts "  Call 1 (no Etag): captured Etag=#{display(captured_etag)}, businessId=#{initial_result ? initial_result.business_id : '<nil>'}"
+
+    if captured_etag.nil? || captured_etag.empty?
+      puts "  Server did not return an Etag header; skipping conditional calls."
+      return
+    end
+
+    second = SmartyStreets::USEnrichment::BusinessDetailLookup.new(business_id)
+    second.request_etag = captured_etag
+    begin
+      @client.send_business_detail_lookup(second)
+      puts "  Call 2 (matching Etag): 200 - server did NOT honor the conditional. Etag=#{display(second.response_etag)}"
+    rescue SmartyStreets::NotModifiedInfo => ex
+      puts "  Call 2 (matching Etag): 304 NotModifiedInfo - caller treats this as cache-valid. Refreshed Etag=#{display(ex.response_etag)}"
+    rescue SmartyStreets::SmartyError => err
+      puts "  Call 2 unexpected failure: #{err.class}: #{err.message}"
+      return
+    end
+
+    third = SmartyStreets::USEnrichment::BusinessDetailLookup.new(business_id)
+    third.request_etag = captured_etag + "X"
+    begin
+      @client.send_business_detail_lookup(third)
+      puts "  Call 3 (mutated Etag): 200 as expected. Etag=#{display(third.response_etag)}"
+    rescue SmartyStreets::NotModifiedInfo
+      puts "  Call 3 (mutated Etag): 304 - UNEXPECTED. Server treated a different Etag as matching."
+    rescue SmartyStreets::SmartyError => err
+      puts "  Call 3 unexpected failure: #{err.class}: #{err.message}"
+    end
+  end
+
+  def first_business_id(summary_results)
+    return nil if summary_results.nil? || summary_results.empty?
+    first = summary_results[0]
+    return nil if first.businesses.nil? || first.businesses.empty?
+    first.businesses[0].business_id
+  end
+
+  def display(value)
+    value.nil? || value.empty? ? "<none>" : value
+  end
+end
+
+example = USEnrichmentEtagExample.new
+example.run

data/examples/us_enrichment_example.rb

@@ -5,14 +5,11 @@ require '../lib/smartystreets_ruby_sdk/client_builder'
 require '../lib/smartystreets_ruby_sdk/us_enrichment/lookup'
 
 class USEnrichmentAddressExample
-  def run
-    # key = 'Your SmartyStreets Auth Key here'
-    # referer = 'Your host name here'
-    # We recommend storing your secret keys in environment variables instead---it's safer!
-    # key = ENV['SMARTY_AUTH_WEB']
-    # referer = ENV['SMARTY_AUTH_REFERER']
-    # credentials = SmartyStreets::SharedCredentials.new(key, referer)
+  # SmartyKey used for the non-property datasets. The property example uses a
+  # separate key because its address happens to have rich financial history.
+  SHARED_SMARTY_KEY = '325023201'
 
+  def run
     id = ENV['SMARTY_AUTH_ID']
     token = ENV['SMARTY_AUTH_TOKEN']
     credentials = SmartyStreets::BasicAuthCredentials.new(id, token)
@@ -23,114 +20,167 @@ class USEnrichmentAddressExample
     #
     # To try with a proxy, add this method call at the end of the chain
     #   with_proxy('localhost', 8080, 'proxyUser', 'proxyPassword')
-    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
+    @client = SmartyStreets::ClientBuilder.new(credentials).
+      build_us_enrichment_api_client
+
+    property_principal_example
+    geo_reference_example
+    risk_example
+    secondary_example
+    secondary_count_example
+  end
 
-    lookup.smarty_key = "87844267"
-    lookup.street = "56 Union Ave"
-    lookup.city = "Somerville"
-    lookup.state = "NJ"
-    lookup.zipcode = "08876"
-    lookup.features = "financial"
-    # lookup.etag = "AUBAGDQDAIGQYCYC"
+  # ---------- property / principal ----------
+  def property_principal_example
+    banner 'property / principal'
 
+    lookup = SmartyStreets::USEnrichment::Lookup.new
+    lookup.smarty_key = '87844267'
+    lookup.street = '56 Union Ave'
+    lookup.city = 'Somerville'
+    lookup.state = 'NJ'
+    lookup.zipcode = '08876'
+    lookup.features = 'financial'
+    # lookup.request_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
-    freeform_lookup.freeform = "56 Union Ave Somerville NJ 08876"
+    results = invoke { @client.send_property_principal_lookup(lookup) }
+    return if results.nil? || results.empty?
 
-    begin
-      # Send a lookup with a smarty key using the line below
-      # result = client.send_property_principal_lookup("325023201")
+    response = results[0]
+    attrs = response.attributes
+    puts "Smarty Key: #{response.smarty_key}"
+    puts "Data Set: #{response.data_set_name}/#{response.data_subset_name}"
+    puts "ETag: #{lookup.response_etag}"
+    puts
+    puts 'Property Address:'
+    puts "  Full Address: #{attrs.property_address_full}"
+    puts "  City: #{attrs.property_address_city}, #{attrs.property_address_state} #{attrs.property_address_zipcode}"
+    puts "Owner: #{attrs.owner_full_name}"
+    puts "Year Built: #{attrs.year_built}  Building Sqft: #{attrs.building_sqft}"
+    puts "Assessed Value: #{attrs.assessed_value}  Total Market Value: #{attrs.total_market_value}"
+    unless attrs.financial_history.nil? || attrs.financial_history.empty?
+      puts "Financial History entries: #{attrs.financial_history.length}"
+    end
+  end
 
-      # 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
+  # ---------- geo-reference ----------
+  def geo_reference_example
+    banner 'geo-reference'
 
-      # Access the other Enrichment datasets using the below functions. All of these functions can take a lookup or a smartykey
-      # result = client.send_geo_reference_lookup("325023201")
-      # result = client.send_risk_lookup("325023201")
-      # result = client.send_secondary_lookup("325023201")
-      # result = client.send_secondary_count_lookup("325023201")
+    lookup = SmartyStreets::USEnrichment::Lookup.new(SHARED_SMARTY_KEY)
+    results = invoke { @client.send_geo_reference_lookup(lookup) }
+    return if results.nil? || results.empty?
 
-    rescue SmartyStreets::SmartyError => err
-      puts err
-      return
-    end
+    response = results[0]
+    attrs = response.attributes
+    puts "Smarty Key: #{response.smarty_key}"
+    puts "Data Set: #{response.data_set_name} (version: #{response.data_set_version})"
+    puts "Matched Address: #{response.matched_address}"
+    puts "ETag: #{lookup.response_etag}"
+    puts
+    print_object('Census Block', attrs.census_block)
+    print_object('Census County Division', attrs.census_county_division)
+    print_object('Census Tract', attrs.census_tract)
+    print_object('Core Based Stat Area', attrs.core_based_stat_area)
+    print_object('Place', attrs.place)
+  end
 
-    if result.empty?
-      puts 'No results. This means the smartykey is not valid.'
-      return
-    end
+  # ---------- risk ----------
+  def risk_example
+    banner 'risk'
 
-    puts "Lookup Successful! Here is the result:"
-    puts
+    lookup = SmartyStreets::USEnrichment::Lookup.new(SHARED_SMARTY_KEY)
+    results = invoke { @client.send_risk_lookup(lookup) }
+    return if results.nil? || results.empty?
 
-    response = result[0]
+    response = results[0]
     attrs = response.attributes
-
     puts "Smarty Key: #{response.smarty_key}"
-    puts "Data Set: #{response.data_set_name}/#{response.data_subset_name}"
-    puts "ETag: #{response.etag}"
+    puts "Data Set: #{response.data_set_name}"
+    puts "Matched Address: #{response.matched_address}"
+    puts "ETag: #{lookup.response_etag}"
     puts
+    puts "Overall Risk:   rating=#{attrs.RISK_RATNG}  score=#{attrs.RISK_SCORE}  spctl=#{attrs.RISK_SPCTL}  value=#{attrs.RISK_VALUE}"
+    puts "Resilience:     rating=#{attrs.RESL_RATNG}  score=#{attrs.RESL_SCORE}  value=#{attrs.RESL_VALUE}"
+    puts "Expected Loss:  rating=#{attrs.EAL_RATNG}   score=#{attrs.EAL_SCORE}   value=#{attrs.EAL_VALT}"
+    puts "Geography:      county=#{attrs.COUNTY}  state=#{attrs.STATE} (#{attrs.STATEABBRV})  tract=#{attrs.TRACT}"
+  end
 
-    puts "Property Address:"
-    puts "\tFull Address: #{attrs.property_address_full}"
-    puts "\tCity: #{attrs.property_address_city}"
-    puts "\tState: #{attrs.property_address_state}"
-    puts "\tZIP: #{attrs.property_address_zipcode}"
-    puts
+  # ---------- secondary ----------
+  def secondary_example
+    banner 'secondary'
 
-    puts "Owner:"
-    puts "\tName: #{attrs.owner_full_name}"
-    puts "\tOccupancy: #{attrs.owner_occupancy_status}"
-    puts
+    lookup = SmartyStreets::USEnrichment::Lookup.new(SHARED_SMARTY_KEY)
+    results = invoke { @client.send_secondary_lookup(lookup) }
+    return if results.nil? || results.empty?
 
-    puts "Property Details:"
-    puts "\tLand Use: #{attrs.land_use_standard}"
-    puts "\tYear Built: #{attrs.year_built}"
-    puts "\tBuilding Sqft: #{attrs.building_sqft}"
-    puts "\tLot Sqft: #{attrs.lot_sqft}"
-    puts "\tAcres: #{attrs.acres}"
-    puts "\tBathrooms: #{attrs.bathrooms_total}"
-    puts "\tBedrooms: #{attrs.bedrooms}"
-    puts "\tStories: #{attrs.stories_number}"
-    puts "\tFireplace: #{attrs.fireplace}"
-    puts "\tGarage: #{attrs.garage}"
+    response = results[0]
+    puts "Smarty Key: #{response.smarty_key}"
+    puts "Matched Address: #{response.matched_address}"
+    puts "ETag: #{lookup.response_etag}"
     puts
+    print_object('Root Address', response.root_address)
 
-    puts "Assessment:"
-    puts "\tAssessed Value: #{attrs.assessed_value}"
-    puts "\tTotal Market Value: #{attrs.total_market_value}"
-    puts "\tTax Year: #{attrs.tax_assess_year}"
-    puts "\tTax Billed: #{attrs.tax_billed_amount}"
-    puts
+    unless response.aliases.nil? || response.aliases.empty?
+      puts "\nAliases (#{response.aliases.length}):"
+      response.aliases.each_with_index { |a, i| puts "  [#{i}] #{one_liner(a)}" }
+    end
+
+    unless response.secondaries.nil? || response.secondaries.empty?
+      puts "\nSecondaries (#{response.secondaries.length}):"
+      response.secondaries.first(5).each_with_index { |s, i| puts "  [#{i}] #{one_liner(s)}" }
+      puts "  ...#{response.secondaries.length - 5} more" if response.secondaries.length > 5
+    end
+  end
+
+  # ---------- secondary / count ----------
+  def secondary_count_example
+    banner 'secondary / count'
+
+    lookup = SmartyStreets::USEnrichment::Lookup.new(SHARED_SMARTY_KEY)
+    results = invoke { @client.send_secondary_count_lookup(lookup) }
+    return if results.nil? || results.empty?
 
-    puts "Location:"
-    puts "\tCounty: #{attrs.situs_county}"
-    puts "\tLatitude: #{attrs.latitude}"
-    puts "\tLongitude: #{attrs.longitude}"
-    puts "\tElevation (ft): #{attrs.elevation_feet}"
+    response = results[0]
+    puts "Smarty Key: #{response.smarty_key}"
+    puts "Matched Address: #{response.matched_address}"
+    puts "Count: #{response.count}"
+    puts "ETag: #{lookup.response_etag}"
+  end
+
+  # ---------- helpers ----------
+  def banner(title)
     puts
+    puts "=== #{title} ==="
+  end
 
-    unless attrs.financial_history.nil? || attrs.financial_history.empty?
-      puts "Financial History (#{attrs.financial_history.length} entries):"
-      attrs.financial_history.each_with_index do |entry, i|
-        puts "\tEntry #{i + 1}:"
-        puts "\t\tDocument Type: #{entry.document_type_description}"
-        puts "\t\tLender: #{entry.lender_name}"
-        puts "\t\tMortgage Amount: #{entry.mortgage_amount}"
-        puts "\t\tMortgage Type: #{entry.mortgage_type}"
-        puts "\t\tRecording Date: #{entry.mortgage_recording_date}"
-      end
+  def invoke
+    yield
+  rescue SmartyStreets::SmartyError => err
+    puts "  Lookup failed: #{err.class}: #{err.message}"
+    nil
+  end
+
+  def print_object(label, obj)
+    puts "#{label}:"
+    if obj.nil?
+      puts '  (none)'
+      return
+    end
+    obj.instance_variables.each do |var|
+      value = obj.instance_variable_get(var)
+      next if value.nil?
+      puts "  #{var.to_s.delete('@')}: #{value}"
     end
   end
+
+  def one_liner(obj)
+    obj.instance_variables.filter_map do |var|
+      value = obj.instance_variable_get(var)
+      "#{var.to_s.delete('@')}=#{value}" unless value.nil?
+    end.join(' ')
+  end
 end
 
-example = USEnrichmentAddressExample.new
-example.run
+USEnrichmentAddressExample.new.run

data/lib/smartystreets_ruby_sdk/exceptions.rb

@@ -4,6 +4,12 @@ module SmartyStreets
   end
 
   class NotModifiedInfo < SmartyError
+    attr_reader :response_etag
+
+    def initialize(message = nil, response_etag = nil)
+      super(message)
+      @response_etag = response_etag
+    end
   end
 
   class BadCredentialsError < SmartyError

data/lib/smartystreets_ruby_sdk/response.rb

@@ -8,5 +8,18 @@ module SmartyStreets
       @header = header
       @error = error
     end
+
+    # Case-insensitive lookup that works on both plain Hash (used by mocks)
+    # and Net::HTTPResponse (returned by the live HTTP transport, which
+    # exposes each_header but not each_pair).
+    def find_header(name)
+      return nil if @header.nil?
+      target = name.to_s.downcase
+      iterator = @header.respond_to?(:each_header) ? :each_header : :each_pair
+      @header.send(iterator) do |k, v|
+        return v if k.to_s.downcase == target
+      end
+      nil
+    end
   end
 end

data/lib/smartystreets_ruby_sdk/status_code_sender.rb

@@ -18,6 +18,8 @@ module SmartyStreets
       response
     end
 
+    private
+
     def parse_rate_limit_response(response)
       error_message = ""
       if !response.payload.nil?
@@ -35,8 +37,8 @@ module SmartyStreets
 
     def assign_exception(response)
       response.error = case response.status_code
-                         when '304'          
-                           NotModifiedInfo.new(NOT_MODIFIED)
+                         when '304'
+                           NotModifiedInfo.new(NOT_MODIFIED, response.find_header('etag'))
                          when '401'
                            BadCredentialsError.new(BAD_CREDENTIALS)
                          when '402'

data/lib/smartystreets_ruby_sdk/us_enrichment/business/detail/attributes.rb

@@ -0,0 +1,241 @@
+module SmartyStreets
+  module USEnrichment
+    module Business
+      module Detail
+        class Attributes
+          attr_reader :accounting_expense_range, :accounting_expense_total, :advertising_expense_range, :advertising_expense_total, :business_insurance_expense_range, :business_insurance_expense_total
+          attr_reader :business_status, :business_type, :carrier_route, :census_block, :census_tract, :city_name
+          attr_reader :company_name, :company_name_secondary, :contact_first_name, :contact_full_name, :contact_gender, :contact_last_name
+          attr_reader :contact_middle_name, :contact_prefix, :contact_professional_title, :contact_suffix, :core_based_stat_area_code, :core_based_stat_area_name
+          attr_reader :corporate_employee_count_range, :corporate_employee_count_total, :county_fips, :county_name, :credit_capacity, :credit_capacity_range
+          attr_reader :credit_score, :credit_score_description, :date_of_last_update, :delivery_line_1, :delivery_point, :delivery_point_check_digit
+          attr_reader :domestic_foreign_owner_indicator, :ein, :email, :email_available_indicator, :executive_department, :executive_level
+          attr_reader :executive_verification_type, :fax, :female_owned_indicator, :foreign_parent_city_name, :foreign_parent_company_name, :foreign_parent_country
+          attr_reader :fortune_1000_branches, :fortune_1000_indicator, :fortune_1000_rank, :holding_city_name, :holding_company_name, :holding_id
+          attr_reader :holding_state_abbreviation, :home_based_business_indicator, :hq_city_name, :hq_company_name, :hq_id, :hq_number_of_companies
+          attr_reader :hq_state_abbreviation, :latitude, :legal_expense_range, :legal_expense_total, :linkage_company_name, :linkage_indicator
+          attr_reader :linkage_level, :linkage_type, :location_employee_count, :location_employee_count_range, :location_sales_range, :location_sales_total
+          attr_reader :longitude, :mail_score_code, :mail_score_description, :mailing_carrier_route, :mailing_city_name, :mailing_delivery_line_1
+          attr_reader :mailing_delivery_point, :mailing_delivery_point_check_digit, :mailing_plus4_code, :mailing_state_abbreviation, :mailing_zipcode, :manufacturing_indicator
+          attr_reader :minority_owned_indicator, :minority_type, :naics_01_code, :naics_01_description, :naics_02_code, :naics_02_description
+          attr_reader :naics_03_code, :naics_03_description, :naics_04_code, :naics_04_description, :naics_05_code, :naics_05_description
+          attr_reader :naics_06_code, :naics_06_description, :new_business_indicator, :non_profit_indicator, :num_of_pcs_range, :num_of_pcs_total
+          attr_reader :number_of_years_in_business, :number_of_years_in_business_range, :office_equipment_expense_range, :office_equipment_expense_total, :operating_hours_friday, :operating_hours_monday
+          attr_reader :operating_hours_saturday, :operating_hours_sunday, :operating_hours_thursday, :operating_hours_tuesday, :operating_hours_wednesday, :phone
+          attr_reader :phone_area_code, :phone_secondary, :phone_toll_free, :plus4_code, :population_range, :precision
+          attr_reader :primary_executive_indicator, :primary_number, :primary_sic_2digit_code, :primary_sic_2digit_description, :primary_sic_4digit_code, :primary_sic_4digit_description
+          attr_reader :primary_sic_code, :primary_sic_description, :public_indicator, :rdi, :rent_expense_range, :rent_expense_total
+          attr_reader :secondary_01_sic_7digit_code, :secondary_01_sic_7digit_description, :secondary_02_sic_7digit_code, :secondary_02_sic_7digit_description, :secondary_03_sic_7digit_code, :secondary_03_sic_7digit_description
+          attr_reader :secondary_04_sic_7digit_code, :secondary_04_sic_7digit_description, :secondary_05_sic_7digit_code, :secondary_05_sic_7digit_description, :secondary_designator, :secondary_number
+          attr_reader :sectional_center_facility, :small_business_indicator, :source_title, :square_footage, :square_footage_range, :standardized_title
+          attr_reader :standardized_title_rank, :state_abbreviation, :stock_exchange, :street_name, :street_postdirection, :street_predirection
+          attr_reader :street_suffix, :sub_hq_city_name, :sub_hq_company_name, :sub_hq_id, :sub_hq_number_of_companies, :sub_hq_state_abbreviation
+          attr_reader :technology_expense_range, :technology_expense_total, :telecom_expense_range, :telecom_expense_total, :ticker_symbol, :time_zone
+          attr_reader :url, :url_facebook, :url_instagram, :url_linkedin, :url_twitter, :url_yelp
+          attr_reader :url_youtube, :utilities_expense_range, :utilities_expense_total, :webmail_indicator, :year_current, :year_current_employee_count
+          attr_reader :year_established, :year_four_prior, :year_four_prior_employee_count, :year_four_prior_employee_growth, :year_one_prior, :year_one_prior_employee_count
+          attr_reader :year_one_prior_employee_growth, :year_three_prior, :year_three_prior_employee_count, :year_three_prior_employee_growth, :year_two_prior, :year_two_prior_employee_count
+          attr_reader :year_two_prior_employee_growth, :zipcode
+
+          def initialize(obj)
+            return if obj.nil?
+            @accounting_expense_range = obj['accounting_expense_range']
+            @accounting_expense_total = obj['accounting_expense_total']
+            @advertising_expense_range = obj['advertising_expense_range']
+            @advertising_expense_total = obj['advertising_expense_total']
+            @business_insurance_expense_range = obj['business_insurance_expense_range']
+            @business_insurance_expense_total = obj['business_insurance_expense_total']
+            @business_status = obj['business_status']
+            @business_type = obj['business_type']
+            @carrier_route = obj['carrier_route']
+            @census_block = obj['census_block']
+            @census_tract = obj['census_tract']
+            @city_name = obj['city_name']
+            @company_name = obj['company_name']
+            @company_name_secondary = obj['company_name_secondary']
+            @contact_first_name = obj['contact_first_name']
+            @contact_full_name = obj['contact_full_name']
+            @contact_gender = obj['contact_gender']
+            @contact_last_name = obj['contact_last_name']
+            @contact_middle_name = obj['contact_middle_name']
+            @contact_prefix = obj['contact_prefix']
+            @contact_professional_title = obj['contact_professional_title']
+            @contact_suffix = obj['contact_suffix']
+            @core_based_stat_area_code = obj['core_based_stat_area_code']
+            @core_based_stat_area_name = obj['core_based_stat_area_name']
+            @corporate_employee_count_range = obj['corporate_employee_count_range']
+            @corporate_employee_count_total = obj['corporate_employee_count_total']
+            @county_fips = obj['county_fips']
+            @county_name = obj['county_name']
+            @credit_capacity = obj['credit_capacity']
+            @credit_capacity_range = obj['credit_capacity_range']
+            @credit_score = obj['credit_score']
+            @credit_score_description = obj['credit_score_description']
+            @date_of_last_update = obj['date_of_last_update']
+            @delivery_line_1 = obj['delivery_line_1']
+            @delivery_point = obj['delivery_point']
+            @delivery_point_check_digit = obj['delivery_point_check_digit']
+            @domestic_foreign_owner_indicator = obj['domestic_foreign_owner_indicator']
+            @ein = obj['ein']
+            @email = obj['email']
+            @email_available_indicator = obj['email_available_indicator']
+            @executive_department = obj['executive_department']
+            @executive_level = obj['executive_level']
+            @executive_verification_type = obj['executive_verification_type']
+            @fax = obj['fax']
+            @female_owned_indicator = obj['female_owned_indicator']
+            @foreign_parent_city_name = obj['foreign_parent_city_name']
+            @foreign_parent_company_name = obj['foreign_parent_company_name']
+            @foreign_parent_country = obj['foreign_parent_country']
+            @fortune_1000_branches = obj['fortune_1000_branches']
+            @fortune_1000_indicator = obj['fortune_1000_indicator']
+            @fortune_1000_rank = obj['fortune_1000_rank']
+            @holding_city_name = obj['holding_city_name']
+            @holding_company_name = obj['holding_company_name']
+            @holding_id = obj['holding_id']
+            @holding_state_abbreviation = obj['holding_state_abbreviation']
+            @home_based_business_indicator = obj['home_based_business_indicator']
+            @hq_city_name = obj['hq_city_name']
+            @hq_company_name = obj['hq_company_name']
+            @hq_id = obj['hq_id']
+            @hq_number_of_companies = obj['hq_number_of_companies']
+            @hq_state_abbreviation = obj['hq_state_abbreviation']
+            @latitude = obj['latitude']
+            @legal_expense_range = obj['legal_expense_range']
+            @legal_expense_total = obj['legal_expense_total']
+            @linkage_company_name = obj['linkage_company_name']
+            @linkage_indicator = obj['linkage_indicator']
+            @linkage_level = obj['linkage_level']
+            @linkage_type = obj['linkage_type']
+            @location_employee_count = obj['location_employee_count']
+            @location_employee_count_range = obj['location_employee_count_range']
+            @location_sales_range = obj['location_sales_range']
+            @location_sales_total = obj['location_sales_total']
+            @longitude = obj['longitude']
+            @mail_score_code = obj['mail_score_code']
+            @mail_score_description = obj['mail_score_description']
+            @mailing_carrier_route = obj['mailing_carrier_route']
+            @mailing_city_name = obj['mailing_city_name']
+            @mailing_delivery_line_1 = obj['mailing_delivery_line_1']
+            @mailing_delivery_point = obj['mailing_delivery_point']
+            @mailing_delivery_point_check_digit = obj['mailing_delivery_point_check_digit']
+            @mailing_plus4_code = obj['mailing_plus4_code']
+            @mailing_state_abbreviation = obj['mailing_state_abbreviation']
+            @mailing_zipcode = obj['mailing_zipcode']
+            @manufacturing_indicator = obj['manufacturing_indicator']
+            @minority_owned_indicator = obj['minority_owned_indicator']
+            @minority_type = obj['minority_type']
+            @naics_01_code = obj['naics_01_code']
+            @naics_01_description = obj['naics_01_description']
+            @naics_02_code = obj['naics_02_code']
+            @naics_02_description = obj['naics_02_description']
+            @naics_03_code = obj['naics_03_code']
+            @naics_03_description = obj['naics_03_description']
+            @naics_04_code = obj['naics_04_code']
+            @naics_04_description = obj['naics_04_description']
+            @naics_05_code = obj['naics_05_code']
+            @naics_05_description = obj['naics_05_description']
+            @naics_06_code = obj['naics_06_code']
+            @naics_06_description = obj['naics_06_description']
+            @new_business_indicator = obj['new_business_indicator']
+            @non_profit_indicator = obj['non_profit_indicator']
+            @num_of_pcs_range = obj['num_of_pcs_range']
+            @num_of_pcs_total = obj['num_of_pcs_total']
+            @number_of_years_in_business = obj['number_of_years_in_business']
+            @number_of_years_in_business_range = obj['number_of_years_in_business_range']
+            @office_equipment_expense_range = obj['office_equipment_expense_range']
+            @office_equipment_expense_total = obj['office_equipment_expense_total']
+            @operating_hours_friday = obj['operating_hours_friday']
+            @operating_hours_monday = obj['operating_hours_monday']
+            @operating_hours_saturday = obj['operating_hours_saturday']
+            @operating_hours_sunday = obj['operating_hours_sunday']
+            @operating_hours_thursday = obj['operating_hours_thursday']
+            @operating_hours_tuesday = obj['operating_hours_tuesday']
+            @operating_hours_wednesday = obj['operating_hours_wednesday']
+            @phone = obj['phone']
+            @phone_area_code = obj['phone_area_code']
+            @phone_secondary = obj['phone_secondary']
+            @phone_toll_free = obj['phone_toll_free']
+            @plus4_code = obj['plus4_code']
+            @population_range = obj['population_range']
+            @precision = obj['precision']
+            @primary_executive_indicator = obj['primary_executive_indicator']
+            @primary_number = obj['primary_number']
+            @primary_sic_2digit_code = obj['primary_sic_2digit_code']
+            @primary_sic_2digit_description = obj['primary_sic_2digit_description']
+            @primary_sic_4digit_code = obj['primary_sic_4digit_code']
+            @primary_sic_4digit_description = obj['primary_sic_4digit_description']
+            @primary_sic_code = obj['primary_sic_code']
+            @primary_sic_description = obj['primary_sic_description']
+            @public_indicator = obj['public_indicator']
+            @rdi = obj['rdi']
+            @rent_expense_range = obj['rent_expense_range']
+            @rent_expense_total = obj['rent_expense_total']
+            @secondary_01_sic_7digit_code = obj['secondary_01_sic_7digit_code']
+            @secondary_01_sic_7digit_description = obj['secondary_01_sic_7digit_description']
+            @secondary_02_sic_7digit_code = obj['secondary_02_sic_7digit_code']
+            @secondary_02_sic_7digit_description = obj['secondary_02_sic_7digit_description']
+            @secondary_03_sic_7digit_code = obj['secondary_03_sic_7digit_code']
+            @secondary_03_sic_7digit_description = obj['secondary_03_sic_7digit_description']
+            @secondary_04_sic_7digit_code = obj['secondary_04_sic_7digit_code']
+            @secondary_04_sic_7digit_description = obj['secondary_04_sic_7digit_description']
+            @secondary_05_sic_7digit_code = obj['secondary_05_sic_7digit_code']
+            @secondary_05_sic_7digit_description = obj['secondary_05_sic_7digit_description']
+            @secondary_designator = obj['secondary_designator']
+            @secondary_number = obj['secondary_number']
+            @sectional_center_facility = obj['sectional_center_facility']
+            @small_business_indicator = obj['small_business_indicator']
+            @source_title = obj['source_title']
+            @square_footage = obj['square_footage']
+            @square_footage_range = obj['square_footage_range']
+            @standardized_title = obj['standardized_title']
+            @standardized_title_rank = obj['standardized_title_rank']
+            @state_abbreviation = obj['state_abbreviation']
+            @stock_exchange = obj['stock_exchange']
+            @street_name = obj['street_name']
+            @street_postdirection = obj['street_postdirection']
+            @street_predirection = obj['street_predirection']
+            @street_suffix = obj['street_suffix']
+            @sub_hq_city_name = obj['sub_hq_city_name']
+            @sub_hq_company_name = obj['sub_hq_company_name']
+            @sub_hq_id = obj['sub_hq_id']
+            @sub_hq_number_of_companies = obj['sub_hq_number_of_companies']
+            @sub_hq_state_abbreviation = obj['sub_hq_state_abbreviation']
+            @technology_expense_range = obj['technology_expense_range']
+            @technology_expense_total = obj['technology_expense_total']
+            @telecom_expense_range = obj['telecom_expense_range']
+            @telecom_expense_total = obj['telecom_expense_total']
+            @ticker_symbol = obj['ticker_symbol']
+            @time_zone = obj['time_zone']
+            @url = obj['url']
+            @url_facebook = obj['url_facebook']
+            @url_instagram = obj['url_instagram']
+            @url_linkedin = obj['url_linkedin']
+            @url_twitter = obj['url_twitter']
+            @url_yelp = obj['url_yelp']
+            @url_youtube = obj['url_youtube']
+            @utilities_expense_range = obj['utilities_expense_range']
+            @utilities_expense_total = obj['utilities_expense_total']
+            @webmail_indicator = obj['webmail_indicator']
+            @year_current = obj['year_current']
+            @year_current_employee_count = obj['year_current_employee_count']
+            @year_established = obj['year_established']
+            @year_four_prior = obj['year_four_prior']
+            @year_four_prior_employee_count = obj['year_four_prior_employee_count']
+            @year_four_prior_employee_growth = obj['year_four_prior_employee_growth']
+            @year_one_prior = obj['year_one_prior']
+            @year_one_prior_employee_count = obj['year_one_prior_employee_count']
+            @year_one_prior_employee_growth = obj['year_one_prior_employee_growth']
+            @year_three_prior = obj['year_three_prior']
+            @year_three_prior_employee_count = obj['year_three_prior_employee_count']
+            @year_three_prior_employee_growth = obj['year_three_prior_employee_growth']
+            @year_two_prior = obj['year_two_prior']
+            @year_two_prior_employee_count = obj['year_two_prior_employee_count']
+            @year_two_prior_employee_growth = obj['year_two_prior_employee_growth']
+            @zipcode = obj['zipcode']
+          end
+        end
+      end
+    end
+  end
+end

data/lib/smartystreets_ruby_sdk/us_enrichment/business/detail/response.rb

@@ -0,0 +1,20 @@
+require_relative 'attributes'
+
+module SmartyStreets
+  module USEnrichment
+    module Business
+      module Detail
+        class Response
+          attr_reader :smarty_key, :data_set_name, :business_id, :attributes
+
+          def initialize(obj)
+            @smarty_key = obj['smarty_key']
+            @data_set_name = obj['data_set_name']
+            @business_id = obj['business_id']
+            @attributes = Attributes.new(obj['attributes'])
+          end
+        end
+      end
+    end
+  end
+end

data/lib/smartystreets_ruby_sdk/us_enrichment/business/summary/business_entry.rb

@@ -0,0 +1,16 @@
+module SmartyStreets
+  module USEnrichment
+    module Business
+      module Summary
+        class BusinessEntry
+          attr_reader :company_name, :business_id
+
+          def initialize(obj)
+            @company_name = obj['company_name']
+            @business_id = obj['business_id']
+          end
+        end
+      end
+    end
+  end
+end

data/lib/smartystreets_ruby_sdk/us_enrichment/business/summary/response.rb

@@ -0,0 +1,24 @@
+require_relative 'business_entry'
+
+module SmartyStreets
+  module USEnrichment
+    module Business
+      module Summary
+        class Response
+          attr_reader :smarty_key, :data_set_name, :businesses
+
+          def initialize(obj)
+            @smarty_key = obj['smarty_key']
+            @data_set_name = obj['data_set_name']
+            @businesses = build_businesses(obj['businesses'])
+          end
+
+          def build_businesses(entries)
+            return [] if entries.nil?
+            entries.map { |entry| Business::Summary::BusinessEntry.new(entry) }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/smartystreets_ruby_sdk/us_enrichment/client.rb

@@ -3,8 +3,12 @@ require_relative "geo_reference/response"
 require_relative "risk/response"
 require_relative "secondary/response"
 require_relative "secondary/count/response"
+require_relative "business/summary/response"
+require_relative "business/detail/response"
 require_relative "lookup"
 require_relative '../request'
+require_relative '../exceptions'
+require 'uri'
 
 module SmartyStreets
     module USEnrichment
@@ -64,6 +68,50 @@ module SmartyStreets
                 end
             end
 
+            def send_business_lookup(lookup)
+                if (lookup.instance_of? String)
+                    __send(USEnrichment::Lookup.new(lookup,'business'))
+                elsif (lookup.instance_of? USEnrichment::Lookup)
+                    lookup.data_set = 'business'
+                    lookup.data_sub_set = nil
+                    __send(lookup)
+                end
+            end
+
+            def send_business_detail_lookup(lookup)
+                if (lookup.instance_of? String)
+                    lookup = USEnrichment::BusinessDetailLookup.new(lookup)
+                end
+                unless lookup.instance_of? USEnrichment::BusinessDetailLookup
+                    raise SmartyError.new("Business detail lookup requires a non-empty 'business_id'")
+                end
+                if blank?(lookup.business_id)
+                    raise SmartyError.new("Business detail lookup requires a non-empty 'business_id'")
+                end
+
+                smarty_request = Request.new
+                smarty_request.url_components = '/business/' + encode_path_segment(lookup.business_id)
+                apply_common_request_fields(smarty_request, lookup)
+
+                response = @sender.send(smarty_request)
+                capture_response_etag(response, lookup)
+                results = @serializer.deserialize(response.payload)
+
+                results = [] if results.nil?
+                raise response.error if response.error
+
+                if results.length > 1
+                    raise SmartyError.new("Business detail response contained #{results.length} results; expected at most 1")
+                end
+
+                if results.empty?
+                    lookup.result = nil
+                else
+                    lookup.result = USEnrichment::Business::Detail::Response.new(results[0])
+                end
+                lookup.result
+            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))
@@ -74,15 +122,15 @@ module SmartyStreets
                 end
             end
 
-            def __send(lookup)
-                smarty_request = Request.new
-
-                return if lookup.nil?
+            private
 
-                if (!lookup.etag.nil?)
-                    smarty_request.header["ETAG"] = lookup.etag
+            def __send(lookup)
+                if lookup.nil? || (blank?(lookup.smarty_key) && blank?(lookup.street) && blank?(lookup.freeform))
+                    raise SmartyError.new("Lookup requires one of 'smartykey', 'street', or 'freeform' to be set")
                 end
 
+                smarty_request = Request.new
+
                 if (!lookup.features.nil?)
                     add_parameter(smarty_request, 'features', lookup.features)
                 end
@@ -105,43 +153,75 @@ 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
+
+                apply_common_request_fields(smarty_request, lookup)
 
                 response = @sender.send(smarty_request)
+                capture_response_etag(response, lookup)
                 results = @serializer.deserialize(response.payload)
-                
+
                 results = [] if results.nil?
                 raise response.error if response.error
-                
+
                 output = []
                 results.each do |raw_result|
                     result = nil
                     if lookup.data_sub_set == "principal"
-                        result = USEnrichment::Property::Principal::Response.new(raw_result, response.header['etag'])
+                        result = USEnrichment::Property::Principal::Response.new(raw_result)
                     end
                     if lookup.data_set == "geo-reference"
-                      result = USEnrichment::GeoReference::Response.new(raw_result, response.header['etag'])
+                      result = USEnrichment::GeoReference::Response.new(raw_result)
                     end
                     if lookup.data_set == "risk"
-                      result = USEnrichment::Risk::Response.new(raw_result, response.header['etag'])
+                      result = USEnrichment::Risk::Response.new(raw_result)
                     end
                     if lookup.data_set == "secondary"
                       if lookup.data_sub_set == "count"
-                        result = USEnrichment::Secondary::Count::Response.new(raw_result, response.header['etag'])
+                        result = USEnrichment::Secondary::Count::Response.new(raw_result)
                       elsif lookup.data_sub_set.nil?
-                        result = USEnrichment::Secondary::Response.new(raw_result, response.header['etag'])
+                        result = USEnrichment::Secondary::Response.new(raw_result)
                       end
                     end
+                    if lookup.data_set == "business" && lookup.data_sub_set.nil?
+                        result = USEnrichment::Business::Summary::Response.new(raw_result)
+                    end
                     output << result
                 end
                 output
             end
 
+            def apply_common_request_fields(request, lookup)
+                unless lookup.include_array.empty?
+                    request.parameters['include'] = lookup.include_array.join(',')
+                end
+                unless lookup.exclude_array.empty?
+                    request.parameters['exclude'] = lookup.exclude_array.join(',')
+                end
+                unless lookup.request_etag.nil?
+                    request.header['Etag'] = lookup.request_etag
+                end
+                lookup.custom_param_hash.each do |key, value|
+                    add_parameter(request, key, value)
+                end
+            end
+
+            def capture_response_etag(response, lookup)
+                return if response.nil?
+                etag = response.find_header('etag')
+                lookup.response_etag = etag unless etag.nil?
+            end
+
+            def encode_path_segment(value)
+                URI.encode_www_form_component(value).gsub('+', '%20')
+            end
+
             def add_parameter(request, key, value)
                 request.parameters[key] = value unless value.nil? or value.empty?
             end
+
+            def blank?(value)
+                value.nil? || value.to_s.strip.empty?
+            end
         end
     end
-end
+end

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

@@ -4,15 +4,14 @@ module SmartyStreets
   module USEnrichment
     module GeoReference
       class Response
-        attr_reader :smarty_key, :data_set_name, :data_set_version, :matched_address, :attributes, :etag
+        attr_reader :smarty_key, :data_set_name, :data_set_version, :matched_address, :attributes
 
-        def initialize(obj, etag=nil)
+        def initialize(obj)
           @smarty_key = obj['smarty_key']
           @data_set_name = obj['data_set_name']
           @data_set_version = obj['data_set_version']
           @matched_address = obj['matched_address']
           @attributes = Attributes.new(obj['attributes'])
-          @etag = etag
         end
       end
     end

data/lib/smartystreets_ruby_sdk/us_enrichment/lookup.rb

@@ -1,10 +1,37 @@
 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, :features, :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, features=nil, custom_param_hash=nil)
+    class LookupBase < JSONAble
+      attr_accessor :request_etag, :response_etag, :include_array, :exclude_array, :features, :custom_param_hash
+
+      def initialize
+        @request_etag = nil
+        @response_etag = nil
+        @include_array = []
+        @exclude_array = []
+        @features = nil
+        @custom_param_hash = {}
+      end
+
+      def add_custom_parameter(parameter, value)
+        @custom_param_hash[parameter] = value
+      end
+
+      def add_include_attribute(attribute)
+        @include_array << attribute unless @include_array.include?(attribute)
+      end
+
+      def add_exclude_attribute(attribute)
+        @exclude_array << attribute unless @exclude_array.include?(attribute)
+      end
+    end
+
+    class Lookup < LookupBase
+      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, request_etag=nil, features=nil)
+        super()
         @smarty_key = smarty_key
         @data_set = data_set
         @data_sub_set = data_sub_set
@@ -13,14 +40,19 @@ module SmartyStreets
         @city = city
         @state = state
         @zipcode = zipcode
-        @etag = etag
+        @request_etag = request_etag
         @features = features
-        @custom_param_hash = {}
       end
+    end
 
-      def add_custom_parameter(parameter, value)
-        @custom_param_hash[parameter] = value
+    class BusinessDetailLookup < LookupBase
+      attr_accessor :business_id, :result
+
+      def initialize(business_id=nil)
+        super()
+        @business_id = business_id
+        @result = nil
       end
     end
   end
-end
+end

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

@@ -5,15 +5,14 @@ module SmartyStreets
         module Property
             module Principal
                 class Response
-                    attr_reader :smarty_key, :data_set_name, :data_subset_name, :matched_address, :attributes, :etag
-            
-                    def initialize(obj, etag=nil)
+                    attr_reader :smarty_key, :data_set_name, :data_subset_name, :matched_address, :attributes
+
+                    def initialize(obj)
                         @smarty_key = obj['smarty_key']
                         @data_set_name = obj['data_set_name']
                         @data_subset_name = obj['data_subset_name']
                         @matched_address = obj['matched_address']
                         @attributes = Attributes.new(obj['attributes'])
-                        @etag = etag
                     end
                 end
             end

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

@@ -4,14 +4,13 @@ module SmartyStreets
   module USEnrichment
     module Risk
       class Response
-        attr_reader :smarty_key, :data_set_name, :matched_address, :attributes, :etag
+        attr_reader :smarty_key, :data_set_name, :matched_address, :attributes
 
-        def initialize(obj, etag=nil)
+        def initialize(obj)
           @smarty_key = obj['smarty_key']
           @data_set_name = obj['data_set_name']
           @matched_address = obj['matched_address']
           @attributes = Attributes.new(obj['attributes'])
-          @etag = etag
         end
       end
     end

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

@@ -3,13 +3,12 @@ module SmartyStreets
     module Secondary
       module Count
         class Response
-          attr_reader :smarty_key, :matched_address, :count, :etag
+          attr_reader :smarty_key, :matched_address, :count
 
-          def initialize(obj, etag=nil)
+          def initialize(obj)
             @smarty_key = obj['smarty_key']
             @matched_address = obj['matched_address']
             @count = obj['count']
-            @etag = etag
           end
         end
       end

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

@@ -6,9 +6,9 @@ module SmartyStreets
   module USEnrichment
     module Secondary
       class Response
-        attr_reader :smarty_key, :matched_address, :root_address, :aliases, :secondaries, :etag
+        attr_reader :smarty_key, :matched_address, :root_address, :aliases, :secondaries
 
-        def initialize(obj, etag=nil)
+        def initialize(obj)
           @smarty_key = obj['smarty_key']
           @matched_address = obj['matched_address']
           @root_address = Secondary::RootAddressEntry.new(obj['root_address'])
@@ -16,7 +16,6 @@ module SmartyStreets
             @aliases = createAliasesArray(obj['aliases'])
           end
           @secondaries = createSecondariesArray(obj['secondaries'])
-          @etag=etag
         end
 
         def createAliasesArray(obj)

data/lib/smartystreets_ruby_sdk/us_enrichment.rb

@@ -1,13 +1,14 @@
-require_relative './us_enrichment/property/financial/attributes'
-require_relative './us_enrichment/property/financial/history_entry'
-require_relative './us_enrichment/property/financial/response'
-
 require_relative './us_enrichment/property/principal/attributes'
 require_relative './us_enrichment/property/principal/response'
 
+require_relative './us_enrichment/business/summary/business_entry'
+require_relative './us_enrichment/business/summary/response'
+require_relative './us_enrichment/business/detail/attributes'
+require_relative './us_enrichment/business/detail/response'
+
 require_relative './us_enrichment/client'
 
 module SmartyStreets
     module USEnrichment
     end
-end
+end

data/lib/smartystreets_ruby_sdk/version.rb

@@ -1,3 +1,3 @@
 module SmartyStreets
-  VERSION = '7.5.0' # DO NOT EDIT (this is updated by a build job when a new release is published)
+  VERSION = '8.0.0' # 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: 7.5.0
+  version: 8.0.0
 platform: ruby
 authors:
 - SmartyStreets SDK Team
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2026-04-01 00:00:00.000000000 Z
+date: 2026-04-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -97,6 +97,8 @@ files:
 - examples/international_example.rb
 - examples/international_postal_code_example.rb
 - examples/us_autocomplete_pro_example.rb
+- examples/us_enrichment_business_example.rb
+- examples/us_enrichment_etag_example.rb
 - examples/us_enrichment_example.rb
 - examples/us_extract_example.rb
 - examples/us_reverse_geo_example.rb
@@ -153,6 +155,10 @@ files:
 - lib/smartystreets_ruby_sdk/us_autocomplete_pro/lookup.rb
 - lib/smartystreets_ruby_sdk/us_autocomplete_pro/suggestion.rb
 - lib/smartystreets_ruby_sdk/us_enrichment.rb
+- lib/smartystreets_ruby_sdk/us_enrichment/business/detail/attributes.rb
+- lib/smartystreets_ruby_sdk/us_enrichment/business/detail/response.rb
+- lib/smartystreets_ruby_sdk/us_enrichment/business/summary/business_entry.rb
+- lib/smartystreets_ruby_sdk/us_enrichment/business/summary/response.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