Merge pull request #63 from smartystreets/eric/add-custom-parameter

 - Added add_custom_parameter functionality for all APIs

Author: RyanLCox1

examples/international_autocomplete_example.py

@@ -21,14 +21,21 @@ def run():
     #
     # credentials = StaticCredentials(auth_id, auth_token)
 
+    client = ClientBuilder(credentials).build_international_autocomplete_api_client()
+
+    # (Advanced) Uncomment the below line to explicitly specify a license value
+    # client = ClientBuilder(credentials).with_licenses(["international-autocomplete-v2-cloud"]).build_international_autocomplete_api_client()
+
     # The appropriate license values to be used for your subscriptions
     # can be found on the Subscriptions page of the account dashboard.
     # https://www.smartystreets.com/docs/cloud/licensing
-    client = ClientBuilder(credentials).with_licenses(["international-autocomplete-v2-cloud"]) \
-        .build_international_autocomplete_api_client()
+    
     lookup = InternationalAutocompleteLookup('Louis')
     lookup.country = "FRA"
 
+    # Uncomment the below line to add a custom parameter
+    # lookup.add_custom_parameter("parameter", "value")
+
     client.send(lookup)
 
     print('*** Result with no filter ***')

examples/international_example.py

@@ -21,11 +21,14 @@ def run():
     #
     # credentials = StaticCredentials(auth_id, auth_token)
 
+    client = ClientBuilder(credentials).build_international_street_api_client()
+
+    # (Advanced) Uncomment the below line to explicitly specify a license value
+    # client = ClientBuilder(credentials).with_licenses(['international-global-plus-cloud']).build_international_street_api_client()
+
     # The appropriate license values to be used for your subscriptions
     # can be found on the Subscription page of the account dashboard.
     # https://www.smartystreets.com/docs/cloud/licensing
-    client = ClientBuilder(credentials).with_licenses(['international-global-plus-cloud'])\
-        .build_international_street_api_client()
 
     # Documentation for input fields can be found at:
     # https://smartystreets.com/docs/cloud/international-street-api#http-input-fields
@@ -41,6 +44,9 @@ def run():
     lookup.country = "Brazil"
     lookup.postal_code = "02516-050"
 
+    # Uncomment the below line to add a custom parameter
+    # lookup.add_custom_parameter("parameter", "value")
+
     candidates = client.send(lookup)  # The candidates are also stored in the lookup's 'result' field.
 
     first_candidate = candidates[0]

examples/us_autocomplete_pro_example.py

@@ -27,12 +27,20 @@ def run():
     #
     # credentials = StaticCredentials(auth_id, auth_token)
 
+    client = ClientBuilder(credentials).build_us_autocomplete_pro_api_client()
+
+    # (Advanced) Uncomment the below line to explicitly specify a license value
+    # client = ClientBuilder(credentials).with_licenses(["us-autocomplete-pro-cloud"]).build_us_autocomplete_pro_api_client()
+
     # The appropriate license values to be used for your subscriptions
     # can be found on the Subscriptions page of the account dashboard.
     # https://www.smartystreets.com/docs/cloud/licensing
-    client = ClientBuilder(credentials).with_licenses(["us-autocomplete-pro-cloud"]).build_us_autocomplete_pro_api_client()
+    
     lookup = AutocompleteProLookup('1042 W Center')
 
+    # Uncomment the below line to add a custom parameter
+    # lookup.add_custom_parameter("parameter", "value")
+
     client.send(lookup)
 
     print('*** Result with no filter ***')

examples/us_enrichment_example.py

@@ -23,10 +23,15 @@ def run():
     #
     # credentials = StaticCredentials(auth_id, auth_token)
 
+    client = ClientBuilder(credentials).build_us_enrichment_api_client()
+
+    # (Advanced) Uncomment the below line to explicitly specify a license value
+    # client = ClientBuilder(credentials).with_licenses(["us-property-data-principal-cloud"]).build_us_enrichment_api_client()
+
     # The appropriate license values to be used for your subscriptions
     # can be found on the Subscriptions page of the account dashboard.
     # https://www.smartystreets.com/docs/cloud/licensing
-    client = ClientBuilder(credentials).with_licenses(["us-property-data-principal-cloud"]).build_us_enrichment_api_client()
+
     # client = ClientBuilder(credentials).with_custom_header({'User-Agent': 'smartystreets ([email protected])', 'Content-Type': 'application/json'}).build_us_enrichment_api_client()
     # client = ClientBuilder(credentials).with_http_proxy('localhost:8080', 'user', 'password').build_us_street_api_client()
     # Uncomment the line above to try it with a proxy instead
@@ -41,6 +46,17 @@ def run():
     lookup.state = "NJ"
     lookup.zipcode = "08876"
 
+    # Uncomment the below lines to add attributes to the "include" parameter
+    # lookup.add_include_attribute('assessed_improvement_percent')
+    # lookup.add_include_attribute('assessed_improvement_value')
+
+    # Uncomment the below lines to add attributes to the "exclude" parameter
+    # lookup.add_exclude_attribute('assessed_land_value')
+    # lookup.add_exclude_attribute('assessed_value')
+
+    # Uncomment the below line to add a custom parameter
+    # lookup.add_custom_parameter("parameter", "value")
+
     freeform_lookup.freeform = "56 Union Ave Somerville NJ 08876"
 
     try:

examples/us_extract_example.py

@@ -40,6 +40,9 @@ def run():
     lookup.addresses_per_line = 1
     lookup.match = MatchType.ENHANCED
 
+    # Uncomment the below line to add a custom parameter
+    # lookup.add_custom_parameter("parameter", "value")
+
     result = client.send(lookup)
 
     metadata = result.metadata

examples/us_reverse_geo_example.py

@@ -21,16 +21,23 @@ def run():
     #
     # credentials = StaticCredentials(auth_id, auth_token)
 
+    client = ClientBuilder(credentials).build_us_reverse_geo_api_client()
+
+    # (Advanced) Uncomment the below line to explicitly specify a license value
+    # client = ClientBuilder(credentials).with_licenses(["us-reverse-geocoding-cloud"]).build_us_reverse_geo_api_client()
+
     # The appropriate license values to be used for your subscriptions
     # can be found on the Subscriptions page of the account dashboard.
     # https://www.smartystreets.com/docs/cloud/licensing
-    client = ClientBuilder(credentials).with_licenses(["us-reverse-geocoding-cloud"]).build_us_reverse_geo_api_client()
 
     # Documentation for input fields can be found at:
     # https://smartystreets.com/docs/cloud/us-reverse-geo-api#http-input-fields
 
     lookup = Lookup(40.111111, -111.111111)
 
+    # Uncomment the below line to add a custom parameter
+    # lookup.add_custom_parameter("parameter", "value")
+
     results = client.send(lookup)
 
     for result in results:

examples/us_street_multiple_addresses_example.py

@@ -11,21 +11,26 @@ def run():
 
     # We recommend storing your secret keys in environment variables instead---it's safer!
     # for client-side requests (browser/mobile), use this code:
-    key = os.environ['SMARTY_AUTH_WEB']
-    hostname = os.environ['SMARTY_WEBSITE_DOMAIN']
+    # key = os.environ['SMARTY_AUTH_WEB']
+    # hostname = os.environ['SMARTY_WEBSITE_DOMAIN']
 
-    credentials = SharedCredentials(key, hostname)
+    # credentials = SharedCredentials(key, hostname)
 
     # for server-to-server requests, use this code:
-    # auth_id = os.environ['SMARTY_AUTH_ID']
-    # auth_token = os.environ['SMARTY_AUTH_TOKEN']
-    #
-    # credentials = StaticCredentials(auth_id, auth_token)
+    auth_id = os.environ['SMARTY_AUTH_ID']
+    auth_token = os.environ['SMARTY_AUTH_TOKEN']
+    
+    credentials = StaticCredentials(auth_id, auth_token)
+
+    client = ClientBuilder(credentials).build_us_street_api_client()
+
+    # (Advanced) Uncomment the below line to explicitly specify a license value
+    # client = ClientBuilder(credentials).with_licenses(['us-core-cloud']).build_us_street_api_client()
 
     # The appropriate license values to be used for your subscriptions
     # can be found on the Subscription page of the account dashboard.
     # https://www.smartystreets.com/docs/cloud/licensing
-    client = ClientBuilder(credentials).with_licenses(['us-core-cloud']).build_us_street_api_client()
+    
     batch = Batch()
 
     # Documentation for input fields can be found at:
@@ -44,6 +49,9 @@ def run():
                                         # this will always return at least one result even if the address is invalid.
                                         # Refer to the documentation for additional Match Strategy options.
 
+    # Uncomment the below line to add a custom parameter
+    # batch[0].add_custom_parameter("parameter", "value")
+
     batch.add(StreetLookup("1 Rosedale, Baltimore, Maryland"))  # Freeform addresses work too.
     batch[1].candidates = 10  # Allows up to ten possible matches to be returned (default is 1).
 

examples/us_street_single_address_example.py

@@ -23,10 +23,15 @@ def run():
 
     # credentials = StaticCredentials(auth_id, auth_token)
 
+    client = ClientBuilder(credentials).build_us_street_api_client()
+
+    # (Advanced) Uncomment the below line to explicitly specify a license value
+    # client = ClientBuilder(credentials).with_licenses(["us-core-cloud"]).build_us_street_api_client()
+
     # The appropriate license values to be used for your subscriptions
     # can be found on the Subscriptions page of the account dashboard.
     # https://www.smartystreets.com/docs/cloud/licensing
-    client = ClientBuilder(credentials).with_licenses(["us-core-cloud"]).build_us_street_api_client()
+
     # client = ClientBuilder(credentials).with_custom_header({'User-Agent': 'smartystreets ([email protected])', 'Content-Type': 'application/json'}).build_us_street_api_client()
     # client = ClientBuilder(credentials).with_http_proxy('localhost:8080', 'user', 'password').build_us_street_api_client()
     # Uncomment the line above to try it with a proxy instead
@@ -49,6 +54,9 @@ def run():
                                       # this will always return at least one result even if the address is invalid.
                                       # Refer to the documentation for additional Match Strategy options.
 
+    # Uncomment the below line to add a custom parameter
+    # lookup.add_custom_parameter("parameter", "value")
+
     try:
         client.send_lookup(lookup)
     except exceptions.SmartyException as err:

examples/us_zipcode_multiple_lookups_example.py

@@ -10,16 +10,16 @@ def run():
 
     # We recommend storing your secret keys in environment variables instead---it's safer!
     # for client-side requests (browser/mobile), use this code:
-    key = os.environ['SMARTY_AUTH_WEB']
-    hostname = os.environ['SMARTY_WEBSITE_DOMAIN']
+    # key = os.environ['SMARTY_AUTH_WEB']
+    # hostname = os.environ['SMARTY_WEBSITE_DOMAIN']
 
-    credentials = SharedCredentials(key, hostname)
+    # credentials = SharedCredentials(key, hostname)
 
     # for server-to-server requests, use this code:
-    # auth_id = os.environ['SMARTY_AUTH_ID']
-    # auth_token = os.environ['SMARTY_AUTH_TOKEN']
-    #
-    # credentials = StaticCredentials(auth_id, auth_token)
+    auth_id = os.environ['SMARTY_AUTH_ID']
+    auth_token = os.environ['SMARTY_AUTH_TOKEN']
+    
+    credentials = StaticCredentials(auth_id, auth_token)
 
     client = ClientBuilder(credentials).build_us_zipcode_api_client()
     batch = Batch()
@@ -31,6 +31,9 @@ def run():
     batch[0].input_id = "011889998819991197253"  # Optional ID from your system
     batch[0].zipcode = "12345"  # A Lookup may have a ZIP Code, city and state, or city, state, and ZIP Code
 
+    # Uncomment the below line to add a custom parameter
+    # batch[0].add_custom_parameter("parameter", "value")
+
     batch.add(ZIPCodeLookup())
     batch[1].city = "Phoenix"
     batch[1].state = "Arizona"

examples/us_zipcode_single_lookup_example.py

@@ -10,16 +10,16 @@ def run():
 
     # We recommend storing your secret keys in environment variables instead---it's safer!
     # for client-side requests (browser/mobile), use this code:
-    key = os.environ['SMARTY_AUTH_WEB']
-    hostname = os.environ['SMARTY_WEBSITE_DOMAIN']
+    #key = os.environ['SMARTY_AUTH_WEB']
+    #hostname = os.environ['SMARTY_WEBSITE_DOMAIN']
 
-    credentials = SharedCredentials(key, hostname)
+    #credentials = SharedCredentials(key, hostname)
 
     # for server-to-server requests, use this code:
-    # auth_id = os.environ['SMARTY_AUTH_ID']
-    # auth_token = os.environ['SMARTY_AUTH_TOKEN']
+    auth_id = os.environ['SMARTY_AUTH_ID']
+    auth_token = os.environ['SMARTY_AUTH_TOKEN']
     #
-    # credentials = StaticCredentials(auth_id, auth_token)
+    credentials = StaticCredentials(auth_id, auth_token)
 
     # Documentation for input fields can be found at:
     # https://smartystreet.com/docs/us-zipcode-api#input-fields
@@ -32,6 +32,9 @@ def run():
     lookup.state = "California"
     lookup.zipcode = "94043"
 
+    # Uncomment the below line to add a custom parameter
+    # lookup.add_custom_parameter("parameter", "value")
+
     try:
         client.send_lookup(lookup)
     except exceptions.SmartyException as err:
@@ -51,6 +54,7 @@ def run():
         print("\nZIP Code: " + zipcode.zipcode)
         print("Latitude: {}".format(zipcode.latitude))
         print("Longitude: {}".format(zipcode.longitude))
+        print("County: {}".format(zipcode.county_name))
 
 
 if __name__ == "__main__":