smartystreets-javascript-sdk 5.0.1 → 5.1.1

package/examples/us_enrichment.js

@@ -0,0 +1,43 @@
+const SmartySDK = require("smartystreets-javascript-sdk");
+const SmartyCore = SmartySDK.core;
+const Lookup = SmartySDK.usEnrichment.Lookup;
+
+// for Server-to-server requests, use this code:
+// let authId = process.env.SMARTY_AUTH_ID;
+// let authToken = process.env.SMARTY_AUTH_TOKEN;
+// const credentials = new SmartyCore.StaticCredentials(authId, authToken);
+
+// for client-side requests (browser/mobile), use this code:
+let key = process.env.SMARTY_EMBEDDED_KEY;
+const credentials = new SmartyCore.SharedCredentials(key);
+
+// The appropriate license values to be used for your subscriptions
+// can be found on the Subscription page of the account dashboard.
+// https://www.smarty.com/docs/cloud/licensing
+let clientBuilder = new SmartyCore.ClientBuilder(credentials).withLicenses(["us-property-data-principal-cloud"]);
+let client = clientBuilder.buildUsEnrichmentClient();
+console.log(client);
+
+// Documentation for input fields can be found at:
+// https://www.smarty.com/docs/us-street-api#input-fields
+
+let lookup = new Lookup("7");
+
+handleResponse(lookup).then();
+
+function handleSuccess(response) {
+    response.lookups.map(lookup => console.log(lookup.result));
+}
+
+function handleError(response) {
+    console.log(response);
+}
+
+async function handleResponse(lookup) {
+    try {
+        const result = await client.sendPrincipal(lookup);
+        handleSuccess(result);
+    } catch(err) {
+        handleError(err);
+    }
+}

package/index.js

@@ -34,4 +34,8 @@ module.exports = {
 		Lookup: require("./src/international_address_autocomplete/Lookup"),
 		Suggestion: require("./src/international_address_autocomplete/Suggestion"),
 	},
+	usEnrichment: {
+		Lookup: require("./src/us_enrichment/Lookup"),
+		Response: require("./src/us_enrichment/Response"),
+	},
 };

package/package.json

@@ -1,6 +1,6 @@
 {
  "name": "smartystreets-javascript-sdk",
- "version": "5.0.1",
+ "version": "5.1.1",
  "description": "Quick and easy Smarty address validation.",
  "keywords": [
   "smarty",
@@ -37,6 +37,7 @@
  },
  "dependencies": {
   "axios": "^1.6.2",
-  "axios-retry": "4.0.0"
+  "axios-retry": "4.0.0",
+  "smartystreets-javascript-sdk": "^5.1.1"
  }
 }

package/src/ClientBuilder.js

@@ -19,6 +19,7 @@ const UsExtractClient = require("./us_extract/Client");
 const InternationalStreetClient = require("./international_street/Client");
 const UsReverseGeoClient = require("./us_reverse_geo/Client");
 const InternationalAddressAutocompleteClient = require("./international_address_autocomplete/Client");
+const UsEnrichmentClient = require("./us_enrichment/Client");
 
 const INTERNATIONAL_STREET_API_URI = "https://international-street.api.smarty.com/verify";
 const US_AUTOCOMPLETE_PRO_API_URL = "https://us-autocomplete-pro.api.smarty.com/lookup";
@@ -27,6 +28,7 @@ const US_STREET_API_URL = "https://us-street.api.smarty.com/street-address";
 const US_ZIP_CODE_API_URL = "https://us-zipcode.api.smarty.com/lookup";
 const US_REVERSE_GEO_API_URL = "https://us-reverse-geo.api.smarty.com/lookup";
 const INTERNATIONAL_ADDRESS_AUTOCOMPLETE_API_URL = "https://international-autocomplete.api.smarty.com/v2/lookup";
+const US_ENRICHMENT_API_URL = "https://us-enrichment.api.smarty.com/lookup";
 
 /**
  * The ClientBuilder class helps you build a client object for one of the supported Smarty APIs.<br>
@@ -201,6 +203,10 @@ class ClientBuilder {
 	buildInternationalAddressAutocompleteClient() {
 		return this.buildClient(INTERNATIONAL_ADDRESS_AUTOCOMPLETE_API_URL, InternationalAddressAutocompleteClient);
 	}
+
+	buildUsEnrichmentClient() {
+		return this.buildClient(US_ENRICHMENT_API_URL, UsEnrichmentClient);
+	}
 }
 
 module.exports = ClientBuilder;

package/src/us_enrichment/Client.js

@@ -0,0 +1,72 @@
+const Errors = require("../Errors");
+const Request = require("../Request");
+const buildInputData = require("../util/buildInputData");
+const {usEnrichment: keyTranslationFormat} = require("../util/apiToSDKKeyMap");
+
+class Client {
+    constructor(sender) {
+        this.sender = sender;
+    }
+
+    sendPrincipal(lookup) {
+        if (typeof lookup === "undefined") throw new Errors.UndefinedLookupError();
+
+        let request = new Request();
+        request.parameters = buildInputData(lookup, keyTranslationFormat);
+
+        request.baseUrlParam = lookup.smartyKey + "/property/principal";
+
+        return new Promise((resolve, reject) => {
+            this.sender.send(request)
+                .then(response => {
+                    if (response.error) reject(response.error);
+
+                    lookup.response = response.payload;
+                    resolve(lookup);
+                })
+                .catch(reject);
+        });
+    }
+
+    sendFinancial(lookup) {
+        if (typeof lookup === "undefined") throw new Errors.UndefinedLookupError();
+
+        let request = new Request();
+        request.parameters = buildInputData(lookup, keyTranslationFormat);
+
+        request.baseUrlParam = lookup.smartyKey + "/property/financial";
+
+        return new Promise((resolve, reject) => {
+            this.sender.send(request)
+                .then(response => {
+                    if (response.error) reject(response.error);
+
+                    lookup.response = response.payload;
+                    resolve(lookup);
+                })
+                .catch(reject);
+        });
+    }
+
+    sendGeo(lookup) {
+        if (typeof lookup === "undefined") throw new Errors.UndefinedLookupError();
+
+        let request = new Request();
+        request.parameters = buildInputData(lookup, keyTranslationFormat);
+
+        request.baseUrlParam = lookup.smartyKey + "/geo-reference";
+
+        return new Promise((resolve, reject) => {
+            this.sender.send(request)
+                .then(response => {
+                    if (response.error) reject(response.error);
+
+                    lookup.response = response.payload;
+                    resolve(lookup);
+                })
+                .catch(reject);
+        });
+    }
+}
+
+module.exports = Client;

package/src/us_enrichment/Lookup.js

@@ -0,0 +1,13 @@
+class Lookup {
+    constructor(smartyKey, include, exclude, dataset, dataSubset) {
+        this.smartyKey = smartyKey;
+        this.include = include;
+        this.exclude = exclude;
+        this.dataset = dataset;
+        this.dataSubset = dataSubset;
+
+        this.response = {};
+    };
+}
+
+module.exports = Lookup;