smartystreets-python-sdk 5.7.0__tar.gz → 6.0.1__tar.gz

{smartystreets_python_sdk-5.7.0 → smartystreets_python_sdk-6.0.1}/PKG-INFO

@@ -1,9 +1,9 @@
 Metadata-Version: 2.4
 Name: smartystreets_python_sdk
-Version: 5.7.0
+Version: 6.0.1
 Summary: An official library to help Python developers easily access the SmartyStreets APIs
 Home-page: https://github.com/smartystreets/smartystreets-python-sdk
-Download-URL: https://github.com/smartystreets/smartystreets-python-sdk/tarball/5.7.0
+Download-URL: https://github.com/smartystreets/smartystreets-python-sdk/tarball/6.0.1
 Author: SmartyStreets SDK Team
 Author-email: support@smartystreets.com
 License: Apache 2

{smartystreets_python_sdk-5.7.0 → smartystreets_python_sdk-6.0.1}/setup.py

@@ -1,22 +1,10 @@
 from smartystreets_python_sdk_version import __version__
 
-from setuptools import setup
+from setuptools import find_packages, setup
 
 setup(
     name='smartystreets_python_sdk',
-    packages=[
-        'smartystreets_python_sdk',
-        'smartystreets_python_sdk_version',
-        'smartystreets_python_sdk.us_street',
-        'smartystreets_python_sdk.us_zipcode',
-        'smartystreets_python_sdk.us_extract',
-        'smartystreets_python_sdk.international_street',
-        'smartystreets_python_sdk.us_reverse_geo',
-        'smartystreets_python_sdk.us_autocomplete_pro',
-        'smartystreets_python_sdk.international_autocomplete',
-        'smartystreets_python_sdk.international_postal_code',
-        'smartystreets_python_sdk.us_enrichment'
-    ],
+    packages=find_packages(include=['smartystreets_python_sdk*', 'smartystreets_python_sdk_version*']),
     version=__version__,
     description='An official library to help Python developers easily access the SmartyStreets APIs',
     long_description='Official Python library for SmartyStreets',

{smartystreets_python_sdk-5.7.0 → smartystreets_python_sdk-6.0.1}/smartystreets_python_sdk/custom_header_sender.py

@@ -14,6 +14,9 @@ class CustomHeaderSender:
     def build_request(self, smarty_request):
         request = Request(url=smarty_request.url_prefix, params=smarty_request.parameters)
         request.headers = self.apply_headers()
+        if smarty_request.headers:
+            for key, value in smarty_request.headers.items():
+                request.headers[key] = value
         if smarty_request.payload:
             request.data = smarty_request.payload
             request.method = 'POST'

{smartystreets_python_sdk-5.7.0 → smartystreets_python_sdk-6.0.1}/smartystreets_python_sdk/errors.py

@@ -22,3 +22,5 @@ SERVICE_UNAVAILABLE = "Service Unavailable. Try again later."
 
 GATEWAY_TIMEOUT = "The upstream data provider did not respond in a timely fashion and the request failed. " \
                   "A serious, yet rare occurrence indeed."
+
+NOT_MODIFIED = "Not Modified: The requested record has not been modified since the previous request with the Etag value."

{smartystreets_python_sdk-5.7.0 → smartystreets_python_sdk-6.0.1}/smartystreets_python_sdk/exceptions.py

@@ -44,3 +44,9 @@ class GatewayTimeoutError(SmartyException):
 
 class BatchFullError(SmartyException):
     pass
+
+
+class NotModifiedError(SmartyException):
+    def __init__(self, message=None, response_etag=None):
+        super().__init__(message)
+        self.response_etag = response_etag

{smartystreets_python_sdk-5.7.0 → smartystreets_python_sdk-6.0.1}/smartystreets_python_sdk/request.py

@@ -10,3 +10,4 @@ class Request:
         self.referer = None
         self.content_type = 'application/json'
         self.auth = None
+        self.headers = {}

{smartystreets_python_sdk-5.7.0 → smartystreets_python_sdk-6.0.1}/smartystreets_python_sdk/requests_sender.py

@@ -55,6 +55,9 @@ def build_request(smarty_request):
         request.headers['Content-Type'] = smarty_request.content_type
         if smarty_request.referer:
             request.headers['Referer'] = smarty_request.referer
+        if smarty_request.headers:
+            for key, value in smarty_request.headers.items():
+                request.headers[key] = value
         if smarty_request.auth:
             request.auth = smarty_request.auth
         if smarty_request.payload:

{smartystreets_python_sdk-5.7.0 → smartystreets_python_sdk-6.0.1}/smartystreets_python_sdk/response.py

@@ -10,3 +10,12 @@ class Response:
             return None
         else:
             return self.headers[header]
+
+    def find_header(self, name):
+        if self.headers is None:
+            return None
+        target = name.lower()
+        for key, value in self.headers.items():
+            if key.lower() == target:
+                return value
+        return None

{smartystreets_python_sdk-5.7.0 → smartystreets_python_sdk-6.0.1}/smartystreets_python_sdk/status_code_sender.py

@@ -25,10 +25,12 @@ class StatusCodeSender:
         response = self.inner.send(request)
 
         if not response.error:
-            if response.status_code != 429:
-                response.error = statuses.get(response.status_code)
-            else:
+            if response.status_code == 304:
+                response.error = exceptions.NotModifiedError(errors.NOT_MODIFIED, response.find_header('etag'))
+            elif response.status_code == 429:
                 response.error = self.parse_rate_limit_response(response)
+            else:
+                response.error = statuses.get(response.status_code)
 
         return response
 

smartystreets_python_sdk-6.0.1/smartystreets_python_sdk/us_enrichment/__init__.py

@@ -0,0 +1,14 @@
+from .business import BusinessDetailAttributes, BusinessDetailResponse, BusinessEntry, BusinessSummaryResponse
+from .client import Client
+from .lookup import (
+    BusinessDetailLookup,
+    BusinessLookup,
+    GeoReferenceLookup,
+    Lookup,
+    LookupBase,
+    PrincipalLookup,
+    RiskLookup,
+    SecondaryCountLookup,
+    SecondaryLookup,
+)
+from .response import *

smartystreets_python_sdk-6.0.1/smartystreets_python_sdk/us_enrichment/business/__init__.py

@@ -0,0 +1,2 @@
+from .summary import BusinessSummaryResponse, BusinessEntry
+from .detail import BusinessDetailResponse, BusinessDetailAttributes

smartystreets_python_sdk-6.0.1/smartystreets_python_sdk/us_enrichment/business/detail.py

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

smartystreets_python_sdk-6.0.1/smartystreets_python_sdk/us_enrichment/business/summary.py

@@ -0,0 +1,15 @@
+class BusinessEntry:
+    def __init__(self, obj):
+        self.company_name = obj.get('company_name', None)
+        self.business_id = obj.get('business_id', None)
+
+
+class BusinessSummaryResponse:
+    def __init__(self, obj):
+        self.smarty_key = obj.get('smarty_key', None)
+        self.data_set_name = obj.get('data_set_name', None)
+        businesses = obj.get('businesses', None)
+        if businesses is None:
+            self.businesses = []
+        else:
+            self.businesses = [BusinessEntry(b) for b in businesses]

smartystreets_python_sdk-6.0.1/smartystreets_python_sdk/us_enrichment/client.py

@@ -0,0 +1,206 @@
+from urllib.parse import quote
+
+from smartystreets_python_sdk import Request
+from smartystreets_python_sdk.exceptions import SmartyException
+from .business import BusinessSummaryResponse, BusinessDetailResponse
+from .lookup import (
+    BusinessDetailLookup,
+    BusinessLookup,
+    GeoReferenceLookup,
+    Lookup,
+    PrincipalLookup,
+    RiskLookup,
+    SecondaryCountLookup,
+    SecondaryLookup,
+)
+from .response import Response
+
+
+class Client:
+    def __init__(self, sender, serializer):
+        """
+        It is recommended to instantiate this class using ClientBuilder.build_us_enrichment_api_client()
+        """
+        self.sender = sender
+        self.serializer = serializer
+
+    def send_property_principal_lookup(self, lookup):
+        if isinstance(lookup, str):
+            l = PrincipalLookup(lookup)
+            send_lookup(self, l)
+            return l.result
+        else:
+            lookup.dataset = 'property'
+            lookup.dataSubset = 'principal'
+            send_lookup(self, lookup)
+            return lookup.result
+
+    def send_geo_reference_lookup(self, lookup):
+        if isinstance(lookup, str):
+            l = GeoReferenceLookup(lookup)
+            send_lookup(self, l)
+            return l.result
+        else:
+            lookup.dataset = 'geo-reference'
+            lookup.dataSubset = None
+            send_lookup(self, lookup)
+            return lookup.result
+
+    def send_risk_lookup(self, lookup):
+        if isinstance(lookup, str):
+            l = RiskLookup(lookup)
+            send_lookup(self, l)
+            return l.result
+        else:
+            lookup.dataset = 'risk'
+            lookup.dataSubset = None
+            send_lookup(self, lookup)
+            return lookup.result
+
+    def send_secondary_lookup(self, lookup):
+        if isinstance(lookup, str):
+            l = SecondaryLookup(lookup)
+            send_lookup(self, l)
+            return l.result
+        else:
+            lookup.dataset = 'secondary'
+            lookup.dataSubset = None
+            send_lookup(self, lookup)
+            return lookup.result
+
+    def send_secondary_count_lookup(self, lookup):
+        if isinstance(lookup, str):
+            l = SecondaryCountLookup(lookup)
+            send_lookup(self, l)
+            return l.result
+        else:
+            lookup.dataset = 'secondary'
+            lookup.dataSubset = 'count'
+            send_lookup(self, lookup)
+            return lookup.result
+
+    def send_generic_lookup(self, lookup, dataset, dataSubset):
+        if isinstance(lookup, str):
+            l = Lookup(lookup, dataset, dataSubset)
+            send_lookup(self, l)
+            return l.result
+        else:
+            lookup.dataset = dataset
+            lookup.dataSubset = dataSubset
+            send_lookup(self, lookup)
+            return lookup.result
+
+    def send_business_lookup(self, lookup):
+        if isinstance(lookup, str):
+            l = BusinessLookup(lookup)
+            send_lookup(self, l, BusinessSummaryResponse)
+            return l.result
+        else:
+            lookup.dataset = 'business'
+            lookup.dataSubset = None
+            send_lookup(self, lookup, BusinessSummaryResponse)
+            return lookup.result
+
+    def send_business_detail_lookup(self, lookup):
+        if isinstance(lookup, str):
+            l = BusinessDetailLookup(lookup)
+            send_business_detail_lookup(self, l)
+            return l.result
+        else:
+            send_business_detail_lookup(self, lookup)
+            return lookup.result
+
+
+def send_lookup(client: Client, lookup, response_class=Response):
+    """
+    Sends a Lookup object to the US Enrichment API and stores the result in the Lookup's result field.
+    """
+    if lookup is None or (
+        _is_blank(getattr(lookup, 'smartykey', None))
+        and _is_blank(getattr(lookup, 'street', None))
+        and _is_blank(getattr(lookup, 'freeform', None))
+    ):
+        raise SmartyException("Lookup requires one of 'smartykey', 'street', or 'freeform' to be set")
+
+    request = build_request(lookup)
+    raw = _dispatch(client, request, lookup)
+    lookup.result = [response_class(candidate) for candidate in raw]
+    return lookup.result
+
+
+def send_business_detail_lookup(client: Client, lookup):
+    if lookup is None or _is_blank(getattr(lookup, 'business_id', None)):
+        raise SmartyException("BusinessDetailLookup requires a non-empty 'business_id'")
+
+    request = Request()
+    request.url_components = 'business/' + quote(lookup.business_id, safe='')
+    request.parameters = _common_parameters(lookup)
+    _apply_etag_header(request, lookup)
+
+    raw = _dispatch(client, request, lookup)
+    if not raw:
+        lookup.result = None
+    elif len(raw) > 1:
+        raise SmartyException(
+            "business detail response contained {} results; expected at most 1".format(len(raw))
+        )
+    else:
+        lookup.result = BusinessDetailResponse(raw[0])
+    return lookup.result
+
+
+def build_request(lookup):
+    request = Request()
+    request.url_components = _url_components(lookup)
+    request.parameters = _address_parameters(lookup)
+    request.parameters.update(_common_parameters(lookup))
+    _apply_etag_header(request, lookup)
+    return request
+
+
+def _url_components(lookup):
+    if lookup.smartykey is not None:
+        base = lookup.smartykey + "/" + lookup.dataset
+    else:
+        base = 'search/' + lookup.dataset
+    if lookup.dataSubset is None:
+        return base
+    return base + "/" + lookup.dataSubset
+
+
+def _address_parameters(lookup):
+    params = {}
+    for key in ('freeform', 'street', 'city', 'state', 'zipcode', 'features'):
+        value = getattr(lookup, key, None)
+        if value:
+            params[key] = value
+    return params
+
+
+def _common_parameters(lookup):
+    params = {}
+    if lookup.include_array:
+        params['include'] = ','.join(lookup.include_array)
+    if lookup.exclude_array:
+        params['exclude'] = ','.join(lookup.exclude_array)
+    for key, value in lookup.custom_parameter_array.items():
+        params[key] = value
+    return params
+
+
+def _apply_etag_header(request, lookup):
+    if lookup.request_etag is not None:
+        request.headers['Etag'] = lookup.request_etag
+
+
+def _dispatch(client, request, lookup):
+    response = client.sender.send(request)
+    lookup.response_etag = response.find_header('etag')
+    if response.error:
+        raise response.error
+    raw = client.serializer.deserialize(response.payload)
+    return raw or []
+
+
+def _is_blank(value):
+    return value is None or (isinstance(value, str) and value.strip() == '')

{smartystreets_python_sdk-5.7.0 → smartystreets_python_sdk-6.0.1}/smartystreets_python_sdk/us_enrichment/lookup.py

@@ -4,15 +4,36 @@ geoReferenceDataset = "geo-reference"
 riskDataset = "risk"
 secondaryDataset = "secondary"
 countDataSubset = "count"
+businessDataset = "business"
 noneDataSubset = None
 
-class Lookup:
-    def __init__(self, smartykey = None, dataset = None, dataSubset = None, features = None, freeform = None, street = None, city = None, state = None, zipcode = None):
+
+class LookupBase:
+    def __init__(self):
+        self.include_array = []
+        self.exclude_array = []
+        self.request_etag = None
+        self.response_etag = None
+        self.custom_parameter_array = {}
+
+    def add_custom_parameter(self, parameter, value):
+        self.custom_parameter_array[parameter] = value
+
+    def add_include_attribute(self, attribute):
+        if attribute not in self.include_array:
+            self.include_array.append(attribute)
+
+    def add_exclude_attribute(self, attribute):
+        if attribute not in self.exclude_array:
+            self.exclude_array.append(attribute)
+
+
+class Lookup(LookupBase):
+    def __init__(self, smartykey=None, dataset=None, dataSubset=None, features=None, freeform=None, street=None, city=None, state=None, zipcode=None):
+        super().__init__()
         self.smartykey = smartykey
         self.dataset = dataset
         self.dataSubset = dataSubset
-        self.include_array = []
-        self.exclude_array = []
         self.features = features
         self.freeform = freeform
         self.street = street
@@ -20,35 +41,40 @@ class Lookup:
         self.state = state
         self.zipcode = zipcode
         self.result = []
-        self.custom_parameter_array = {}
-    
-    def add_custom_parameter(self, parameter, value):
-        self.custom_parameter_array[parameter] = value
 
-    def add_include_attribute(self, attribute):
-        if (attribute not in self.include_array):
-            self.include_array.append(attribute)
-    
-    def add_exclude_attribute(self, attribute):
-        if (attribute not in self.exclude_array):
-            self.exclude_array.append(attribute)
 
 class PrincipalLookup(Lookup):
-    def __init__(self, smartykey = None):
+    def __init__(self, smartykey=None):
         super().__init__(smartykey, propertyDataset, principalDataSubset)
 
+
 class GeoReferenceLookup(Lookup):
-    def __init__(self, smartykey = None):
+    def __init__(self, smartykey=None):
         super().__init__(smartykey, geoReferenceDataset, noneDataSubset)
 
+
 class RiskLookup(Lookup):
-    def __init__(self, smartykey = None):
+    def __init__(self, smartykey=None):
         super().__init__(smartykey, riskDataset, noneDataSubset)
 
+
 class SecondaryLookup(Lookup):
-    def __init__(self, smartykey = None):
+    def __init__(self, smartykey=None):
         super().__init__(smartykey, secondaryDataset, noneDataSubset)
 
+
 class SecondaryCountLookup(Lookup):
-    def __init__(self, smartykey = None):
-        super().__init__(smartykey, secondaryDataset, countDataSubset)
+    def __init__(self, smartykey=None):
+        super().__init__(smartykey, secondaryDataset, countDataSubset)
+
+
+class BusinessLookup(Lookup):
+    def __init__(self, smartykey=None):
+        super().__init__(smartykey, businessDataset, noneDataSubset)
+
+
+class BusinessDetailLookup(LookupBase):
+    def __init__(self, business_id=None):
+        super().__init__()
+        self.business_id = business_id
+        self.result = None

{smartystreets_python_sdk-5.7.0 → smartystreets_python_sdk-6.0.1}/smartystreets_python_sdk.egg-info/PKG-INFO

@@ -1,9 +1,9 @@
 Metadata-Version: 2.4
 Name: smartystreets_python_sdk
-Version: 5.7.0
+Version: 6.0.1
 Summary: An official library to help Python developers easily access the SmartyStreets APIs
 Home-page: https://github.com/smartystreets/smartystreets-python-sdk
-Download-URL: https://github.com/smartystreets/smartystreets-python-sdk/tarball/5.7.0
+Download-URL: https://github.com/smartystreets/smartystreets-python-sdk/tarball/6.0.1
 Author: SmartyStreets SDK Team
 Author-email: support@smartystreets.com
 License: Apache 2

{smartystreets_python_sdk-5.7.0 → smartystreets_python_sdk-6.0.1}/smartystreets_python_sdk.egg-info/SOURCES.txt

@@ -54,6 +54,9 @@ smartystreets_python_sdk/us_enrichment/__init__.py
 smartystreets_python_sdk/us_enrichment/client.py
 smartystreets_python_sdk/us_enrichment/lookup.py
 smartystreets_python_sdk/us_enrichment/response.py
+smartystreets_python_sdk/us_enrichment/business/__init__.py
+smartystreets_python_sdk/us_enrichment/business/detail.py
+smartystreets_python_sdk/us_enrichment/business/summary.py
 smartystreets_python_sdk/us_extract/__init__.py
 smartystreets_python_sdk/us_extract/address.py
 smartystreets_python_sdk/us_extract/client.py

{smartystreets_python_sdk-5.7.0 → smartystreets_python_sdk-6.0.1}/smartystreets_python_sdk_version/__init__.py

@@ -1,2 +1,2 @@
 __version__ = '0.0.0'  # DO NOT EDIT (this is updated by a build job when a new release is published)
-__version__="5.7.0"
+__version__="6.0.1"

smartystreets_python_sdk-5.7.0/smartystreets_python_sdk/us_enrichment/__init__.py

@@ -1,2 +0,0 @@
-from .client import Client
-from .response import *

smartystreets_python_sdk-5.7.0/smartystreets_python_sdk/us_enrichment/client.py

@@ -1,158 +0,0 @@
-from smartystreets_python_sdk import Request
-from smartystreets_python_sdk.exceptions import SmartyException
-from .lookup import PrincipalLookup, GeoReferenceLookup, RiskLookup, SecondaryLookup, SecondaryCountLookup, Lookup
-from .response import Response
-
-
-class Client:
-    def __init__(self, sender, serializer):
-        """
-        It is recommended to instantiate this class using ClientBuilder.build_us_enrichment_api_client()
-        """
-        self.sender = sender
-        self.serializer = serializer
-
-    def send_property_principal_lookup(self, lookup):
-        if isinstance(lookup, str):
-            l = PrincipalLookup(lookup)
-            send_lookup(self, l)
-            return l.result
-        else:
-            lookup.dataset = 'property'
-            lookup.dataSubset = 'principal'
-            send_lookup(self, lookup)
-            return lookup.result
-    
-    def send_geo_reference_lookup(self, lookup):
-        if isinstance(lookup, str):
-            l = GeoReferenceLookup(lookup)
-            send_lookup(self, l)
-            return l.result
-        else:
-            lookup.dataset = 'geo-reference'
-            lookup.dataSubset = None
-            send_lookup(self, lookup)
-            return lookup.result
-    
-    def send_risk_lookup(self, lookup):
-        if isinstance(lookup, str):
-            l = RiskLookup(lookup)
-            send_lookup(self, l)
-            return l.result
-        else:
-            lookup.dataset = 'risk'
-            lookup.dataSubset = None
-            send_lookup(self, lookup)
-            return lookup.result
-
-    def send_secondary_lookup(self, lookup):
-        if isinstance(lookup, str):
-            l = SecondaryLookup(lookup)
-            send_lookup(self, l)
-            return l.result
-        else:
-            lookup.dataset = 'secondary'
-            lookup.dataSubset = None
-            send_lookup(self, lookup)
-            return lookup.result
-    
-    def send_secondary_count_lookup(self, lookup):
-        if isinstance(lookup, str):
-            l = SecondaryCountLookup(lookup)
-            send_lookup(self, l)
-            return l.result
-        else:
-            lookup.dataset = 'secondary'
-            lookup.dataSubset = 'count'
-            send_lookup(self, lookup)
-            return lookup.result
-    
-    def send_generic_lookup(self, lookup, dataset, dataSubset):
-        if isinstance(lookup, str):
-            l = Lookup(lookup, dataset, dataSubset)
-            send_lookup(self, l)
-            return l.result
-        else:
-            lookup.dataset = dataset
-            lookup.dataSubset = dataSubset
-            send_lookup(self, lookup)
-            return lookup.result
-
-
-def send_lookup(client: Client, lookup):
-    """
-    Sends a Lookup object to the US Enrichment API and stores the result in the Lookup's result field.
-    """
-    if lookup is None or (lookup.smartykey is None and lookup.street is None and lookup.freeform is None):
-        raise SmartyException('Client.send() requires a Lookup with either the "smartykey", "street, or "freeform" field set as a string')
-
-    request = build_request(lookup)
-
-    response = client.sender.send(request)
-    if response.error:
-        raise response.error
-
-    response = client.serializer.deserialize(response.payload)
-    result = []
-    for candidate in response:
-        result.append(Response(candidate))
-    lookup.result = result
-    return result
-
-
-def build_request(lookup):
-    request = Request()
-    if lookup.smartykey != None:
-        if lookup.dataSubset == None:
-            request.url_components = lookup.smartykey + "/" + lookup.dataset
-            request.parameters = remap_keys(lookup)
-            return request
-    
-        request.url_components = lookup.smartykey + "/" + lookup.dataset + "/" + lookup.dataSubset
-        request.parameters = remap_keys(lookup)
-
-        return request
-    else:
-        if lookup.dataSubset == None:
-            request.url_components = 'search/' + lookup.dataset
-            request.parameters = remap_keys(lookup)
-            return request
-    
-        request.url_components = 'search/' + lookup.dataset + "/" + lookup.dataSubset
-
-        request.parameters = remap_keys(lookup)
-        return request
-    
-def remap_keys(lookup):
-    converted_lookup = {}
-
-    if (lookup.freeform != None):
-        add_field(converted_lookup, 'freeform', lookup.freeform)
-    if (lookup.street != None):
-        add_field(converted_lookup, 'street', lookup.street)
-    if (lookup.city != None):
-        add_field(converted_lookup, 'city', lookup.city)
-    if (lookup.state != None):
-        add_field(converted_lookup, 'state', lookup.state)
-    if (lookup.zipcode != None):
-        add_field(converted_lookup, 'zipcode', lookup.zipcode)
-    if (lookup.include_array != None):
-        add_field(converted_lookup, 'include', build_filter_string(lookup.include_array))
-    if (lookup.exclude_array != None):
-        add_field(converted_lookup, 'exclude', build_filter_string(lookup.exclude_array))
-    if (lookup.features != None):
-        add_field(converted_lookup, 'features', lookup.features)
-
-
-    for parameter in lookup.custom_parameter_array:
-        add_field(converted_lookup, parameter, lookup.custom_parameter_array[parameter])
-
-    return converted_lookup
-
-
-def add_field(converted_lookup, key, value):
-    if value:
-        converted_lookup[key] = value
-
-def build_filter_string(filter_list):
-    return ','.join(filter_list or []) or None