Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
47 changes: 14 additions & 33 deletions examples/us_street.js
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
const SmartySDK = require("smartystreets-javascript-sdk");
const SmartySDK = require("../dist/cjs/index.cjs");
const SmartyCore = SmartySDK.core;
const Lookup = SmartySDK.usStreet.Lookup;

Expand All @@ -8,7 +8,8 @@ const Lookup = SmartySDK.usStreet.Lookup;
// const credentials = new SmartyCore.StaticCredentials(authId, authToken);

// for client-side requests (browser/mobile), use this code:
let key = process.env.SMARTY_EMBEDDED_KEY;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think that it's important we keep this line as it adds context to the comment above. Maybe there could be a comment added after, such as... let key = process.env.SMARTY_EMBEDDED_KEY // "your key".
Also, is there any reason we couldn't freshen this up by changing let -> const? I don't think this variable needs to be mutable, does it?

// Note: key must be a string
let key = "your key";
const credentials = new SmartyCore.SharedCredentials(key);

// The appropriate license values to be used for your subscriptions
Expand All @@ -23,37 +24,17 @@ let client = clientBuilder.buildUsStreetApiClient();
// https://www.smarty.com/docs/us-street-api#input-fields

let lookup1 = new Lookup();
lookup1.inputId = "24601"; // Optional ID from your system
lookup1.addressee = "John Doe";
lookup1.street = "330 N 100 W";
lookup1.street2 = "closet under the stairs";
lookup1.secondary = "APT 2";
lookup1.urbanization = ""; // Only applies to Puerto Rico addresses
lookup1.city = "Provo";
lookup1.state = "Utah";
lookup1.zipCode = "84601";
lookup1.maxCandidates = 3;
lookup1.match = "invalid"; // "invalid" is the most permissive match,
// this will always return at least one result even if the address is invalid.
// Refer to the documentation for additional MatchStrategy options.

let lookup2 = new Lookup();
lookup2.street = "1600 Amphitheater Pkwy";
lookup2.lastLine = "Mountainview, CA";
lookup2.maxCandidates = 5;

let lookup3 = new Lookup();
lookup3.inputId = "8675309";
lookup3.street = "1600 Amphitheatre Parkway Mountain View, CA 94043";
lookup3.maxCandidates = 1;

// NOTE: batches are not supported when using SharedCredentials.
let batch = new SmartyCore.Batch();
batch.add(lookup1);
batch.add(lookup2);
batch.add(lookup3);

await handleResponse(batch);
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just out of curiosity... Is there a reason why we don't want to showcase batching in the example anymore?

lookup1.street = "805 Tye Crossing Ct";
lookup1.city = "Burleson";
lookup1.state = "TX";
lookup1.zipCode = "76028";
lookup1.candidates = 10;
lookup1.match = "enhanced";
// lookup1.countySource = "geographic";

(async () => {
await handleResponse(lookup1);
})();

function handleSuccess(response) {
response.lookups.map(lookup => console.log(lookup.result));
Expand Down
18 changes: 17 additions & 1 deletion src/us_street/Lookup.js
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,22 @@
* @see "https://www.smarty.com/docs/cloud/us-street-api#input-fields"
*/
class Lookup {
constructor(street, street2, secondary, city, state, zipCode, lastLine, addressee, urbanization, match, maxCandidates, inputId, format) {
constructor(
street,
street2,
secondary,
city,
state,
zipCode,
lastLine,
addressee,
urbanization,
match,
maxCandidates,
inputId,
format,
countySource,
) {
this.street = street;
this.street2 = street2;
this.secondary = secondary;
Expand All @@ -18,6 +33,7 @@ class Lookup {
this.maxCandidates = maxCandidates;
this.inputId = inputId;
this.format = format;
this.countySource = countySource;
this.result = [];
}
}
Expand Down
1 change: 1 addition & 0 deletions src/util/apiToSDKKeyMap.js
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ module.exports = {
"match": "match",
"format": "format",
"candidates": "maxCandidates",
"county_source": "countySource"
},
usAutocompletePro: {
search: "search",
Expand Down
Loading