smartystreets-javascript-sdk 7.3.1 → 7.4.1

package/dist/types/us_autocomplete_pro/Lookup.d.ts

@@ -0,0 +1,28 @@
+export = Lookup;
+/**
+ * In addition to holding all of the input data for this lookup, this class also<br>
+ *     will contain the result of the lookup after it comes back from the API.
+ *     @see "https://www.smarty.com/docs/cloud/us-autocomplete-api#pro-http-request-input-fields"
+ */
+declare class Lookup {
+    /**
+     * @param search The beginning of an address. This is required to be set.
+     */
+    constructor(search: any);
+    result: any[];
+    search: any;
+    selected: any;
+    maxResults: any;
+    includeOnlyCities: any[];
+    includeOnlyStates: any[];
+    includeOnlyZIPCodes: any[];
+    excludeStates: any[];
+    preferCities: any[];
+    preferStates: any[];
+    preferZIPCodes: any[];
+    preferRatio: any;
+    preferGeolocation: any;
+    source: any;
+    customParameters: {};
+    addCustomParameter(key: any, value: any): void;
+}

package/dist/types/us_autocomplete_pro/Suggestion.d.ts

@@ -0,0 +1,14 @@
+export = Suggestion;
+/**
+ * @see "https://www.smarty.com/docs/cloud/us-autocomplete-api#pro-http-response"
+ */
+declare class Suggestion {
+    constructor(responseData: any);
+    streetLine: any;
+    secondary: any;
+    city: any;
+    state: any;
+    zipcode: any;
+    entries: any;
+    source: any;
+}

package/dist/types/us_enrichment/Client.d.ts

@@ -0,0 +1,10 @@
+export = Client;
+declare class Client {
+    constructor(sender: any);
+    sender: any;
+    sendPrincipal(lookup: any): Promise<any>;
+    sendFinancial(lookup: any): Promise<any>;
+    sendGeo(lookup: any): Promise<any>;
+    sendSecondary(lookup: any): Promise<any>;
+    sendSecondaryCount(lookup: any): Promise<any>;
+}

package/dist/types/us_enrichment/Lookup.d.ts

@@ -0,0 +1,13 @@
+export = Lookup;
+declare class Lookup {
+    constructor(smartyKey: any, include: any, exclude: any, dataset: any, dataSubset: any);
+    smartyKey: any;
+    include: any;
+    exclude: any;
+    dataset: any;
+    dataSubset: any;
+    features: any;
+    response: {};
+    customParameters: {};
+    addCustomParameter(key: any, value: any): void;
+}

package/dist/types/us_enrichment/Response.d.ts

@@ -0,0 +1,20 @@
+export class Response {
+    constructor(responseData: any);
+    smartyKey: any;
+    dataSetName: any;
+    dataSubsetName: any;
+    attributes: {};
+}
+export class FinancialResponse {
+    constructor(responseData: any);
+    smartyKey: any;
+    dataSetName: any;
+    dataSubsetName: any;
+    attributes: {};
+}
+export class GeoResponse {
+    constructor(responseData: any);
+    smartyKey: any;
+    dataSetName: any;
+    attributes: {};
+}

package/dist/types/us_extract/Address.d.ts

@@ -0,0 +1,13 @@
+export = Address;
+/**
+ * @see <a href="https://www.smarty.com/docs/cloud/us-extract-api#http-response-status">Smarty US Extract API docs</a>
+ */
+declare class Address {
+    constructor(responseData: any);
+    text: any;
+    verified: any;
+    line: any;
+    start: any;
+    end: any;
+    candidates: any;
+}

package/dist/types/us_extract/Client.d.ts

@@ -0,0 +1,10 @@
+export = Client;
+/**
+ * This client sends lookups to the Smarty US Extract API, <br>
+ *     and attaches the results to the Lookup objects.
+ */
+declare class Client {
+    constructor(sender: any);
+    sender: any;
+    send(lookup: any): Promise<any>;
+}

package/dist/types/us_extract/Lookup.d.ts

@@ -0,0 +1,23 @@
+export = Lookup;
+/**
+ * In addition to holding all of the input data for this lookup, this class also<br>
+ *     will contain the result of the lookup after it comes back from the API.
+ *     @see "https://www.smarty.com/docs/cloud/us-extract-api#http-request-input-fields"
+ */
+declare class Lookup {
+    /**
+     * @param text The text that is to have addresses extracted out of it for verification (required)
+     */
+    constructor(text: any);
+    result: {
+        meta: {};
+        addresses: never[];
+    };
+    text: any;
+    html: any;
+    aggressive: any;
+    addressesHaveLineBreaks: any;
+    addressesPerLine: any;
+    customParameters: {};
+    addCustomParameter(key: any, value: any): void;
+}

package/dist/types/us_extract/Result.d.ts

@@ -0,0 +1,19 @@
+export = Result;
+/**
+ * @see <a href="https://www.smarty.com/docs/cloud/us-extract-api#http-response-status">Smarty US Extract API docs</a>
+ */
+declare class Result {
+    constructor({ meta, addresses }: {
+        meta: any;
+        addresses: any;
+    });
+    meta: {
+        lines: any;
+        unicode: any;
+        addressCount: any;
+        verifiedCount: any;
+        bytes: any;
+        characterCount: any;
+    };
+    addresses: any;
+}

package/dist/types/us_reverse_geo/Client.d.ts

@@ -0,0 +1,10 @@
+export = Client;
+/**
+ * This client sends lookups to the Smarty US Reverse Geo API, <br>
+ *     and attaches the results to the appropriate Lookup objects.
+ */
+declare class Client {
+    constructor(sender: any);
+    sender: any;
+    send(lookup: any): Promise<any>;
+}

package/dist/types/us_reverse_geo/Lookup.d.ts

@@ -0,0 +1,16 @@
+export = Lookup;
+/**
+ * In addition to holding all of the input data for this lookup, this class also<br>
+ *     will contain the result of the lookup after it comes back from the API.
+ *     @see "https://www.smarty.com/docs/cloud/us-street-api#input-fields"
+ */
+declare class Lookup {
+    constructor(latitude: any, longitude: any, source?: string);
+    latitude: any;
+    longitude: any;
+    source: string;
+    response: Response;
+    customParameters: {};
+    addCustomParameter(key: any, value: any): void;
+}
+import Response = require("./Response");

package/dist/types/us_reverse_geo/Response.d.ts

@@ -0,0 +1,8 @@
+export = Response;
+/**
+ * The SmartyResponse contains the response from a call to the US Reverse Geo API.
+ */
+declare class Response {
+    constructor(responseData: any);
+    results: any[];
+}

package/dist/types/us_reverse_geo/Result.d.ts

@@ -0,0 +1,13 @@
+export = Result;
+/**
+ * A candidate is a possible match for an address that was submitted.<br>
+ *     A lookup can have multiple candidates if the address was ambiguous.
+ *
+ * @see "https://www.smarty.com/docs/cloud/us-reverse-geo-api#result"
+ */
+declare class Result {
+    constructor(responseData: any);
+    distance: any;
+    address: {};
+    coordinate: {};
+}

package/dist/types/us_street/Candidate.d.ts

@@ -0,0 +1,22 @@
+export = Candidate;
+/**
+ * A candidate is a possible match for an address that was submitted.<br>
+ *     A lookup can have multiple candidates if the address was ambiguous, and<br>
+ *     the maxCandidates field is set higher than 1.
+ *
+ * @see "https://www.smarty.com/docs/cloud/us-street-api#root"
+ */
+declare class Candidate {
+    constructor(responseData: any);
+    inputIndex: any;
+    candidateIndex: any;
+    addressee: any;
+    deliveryLine1: any;
+    deliveryLine2: any;
+    lastLine: any;
+    deliveryPointBarcode: any;
+    smartyKey: any;
+    components: {};
+    metadata: {};
+    analysis: {};
+}

package/dist/types/us_street/Client.d.ts

@@ -0,0 +1,15 @@
+export = Client;
+/**
+ * This client sends lookups to the Smarty US Street API, <br>
+ *     and attaches the results to the appropriate Lookup objects.
+ */
+declare class Client {
+    constructor(sender: any);
+    sender: any;
+    /**
+     * Sends up to 100 lookups for validation.
+     * @param data may be a Lookup object, or a Batch which must contain between 1 and 100 Lookup objects
+     * @throws SmartyException
+     */
+    send(data: any): Promise<any>;
+}

package/dist/types/us_street/Lookup.d.ts

@@ -0,0 +1,26 @@
+export = Lookup;
+/**
+ * In addition to holding all of the input data for this lookup, this class also<br>
+ *     will contain the result of the lookup after it comes back from the API.
+ *     @see "https://www.smarty.com/docs/cloud/us-street-api#input-fields"
+ */
+declare class Lookup {
+    constructor(street: any, street2: any, secondary: any, city: any, state: any, zipCode: any, lastLine: any, addressee: any, urbanization: any, match: any, maxCandidates: any, inputId: any, format: any, countySource: any);
+    street: any;
+    street2: any;
+    secondary: any;
+    city: any;
+    state: any;
+    zipCode: any;
+    lastLine: any;
+    addressee: any;
+    urbanization: any;
+    match: any;
+    maxCandidates: any;
+    inputId: any;
+    format: any;
+    countySource: any;
+    result: any[];
+    customParameters: {};
+    addCustomParameter(key: any, value: any): void;
+}

package/dist/types/us_zipcode/Client.d.ts

@@ -0,0 +1,15 @@
+export = Client;
+/**
+ * This client sends lookups to the Smarty US ZIP Code API, <br>
+ *     and attaches the results to the appropriate Lookup objects.
+ */
+declare class Client {
+    constructor(sender: any);
+    sender: any;
+    /**
+     * Sends up to 100 lookups for validation.
+     * @param data May be a Lookup object, or a Batch which must contain between 1 and 100 Lookup objects
+     * @throws SmartyException
+     */
+    send(data: any): Promise<any>;
+}

package/dist/types/us_zipcode/Lookup.d.ts

@@ -0,0 +1,16 @@
+export = Lookup;
+/**
+ * In addition to holding all of the input data for this lookup, this class also<br>
+ *     will contain the result of the lookup after it comes back from the API.
+ *     @see "https://www.smarty.com/docs/cloud/us-zipcode-api#http-request-input-fields"
+ */
+declare class Lookup {
+    constructor(city: any, state: any, zipCode: any, inputId: any);
+    city: any;
+    state: any;
+    zipCode: any;
+    inputId: any;
+    result: any[];
+    customParameters: {};
+    addCustomParameter(key: any, value: any): void;
+}

package/dist/types/us_zipcode/Result.d.ts

@@ -0,0 +1,13 @@
+export = Result;
+/**
+ * @see "https://www.smarty.com/docs/cloud/us-zipcode-api#root"
+ */
+declare class Result {
+    constructor(responseData: any);
+    inputIndex: any;
+    status: any;
+    reason: any;
+    valid: boolean;
+    cities: any;
+    zipcodes: any;
+}

package/dist/types/util/Sleeper.d.ts

@@ -0,0 +1,4 @@
+export default class Sleeper {
+    constructor();
+    sleep(seconds: number): Promise<void>;
+}

package/dist/types/util/apiToSDKKeyMap.d.ts

@@ -0,0 +1,92 @@
+export namespace usStreet {
+    let street: string;
+    let street2: string;
+    let secondary: string;
+    let city: string;
+    let state: string;
+    let zipcode: string;
+    let lastline: string;
+    let addressee: string;
+    let urbanization: string;
+    let match: string;
+    let format: string;
+    let candidates: string;
+    let county_source: string;
+}
+export namespace usAutocompletePro {
+    let search: string;
+    let selected: string;
+    let max_results: string;
+    let include_only_cities: string;
+    let include_only_states: string;
+    let include_only_zip_codes: string;
+    let exclude_states: string;
+    let prefer_cities: string;
+    let prefer_states: string;
+    let prefer_zip_codes: string;
+    let prefer_ratio: string;
+    let prefer_geolocation: string;
+    let source: string;
+}
+export namespace usZipcode {
+    let city_1: string;
+    export { city_1 as city };
+    let state_1: string;
+    export { state_1 as state };
+    let zipcode_1: string;
+    export { zipcode_1 as zipcode };
+}
+export namespace internationalStreet {
+    let country: string;
+    let freeform: string;
+    let address1: string;
+    let address2: string;
+    let address3: string;
+    let address4: string;
+    let organization: string;
+    let locality: string;
+    let administrative_area: string;
+    let postal_code: string;
+    let geocode: string;
+    let language: string;
+}
+export namespace internationalAddressAutocomplete {
+    let search_1: string;
+    export { search_1 as search };
+    let country_1: string;
+    export { country_1 as country };
+    let max_results_1: string;
+    export { max_results_1 as max_results };
+    export let include_only_administrative_area: string;
+    export let include_only_locality: string;
+    export let include_only_postal_code: string;
+}
+export namespace usReverseGeo {
+    export let latitude: string;
+    export let longitude: string;
+    let source_1: string;
+    export { source_1 as source };
+}
+export namespace usExtract {
+    let html: string;
+    let aggressive: string;
+    let addr_line_breaks: string;
+    let addr_per_line: string;
+}
+export namespace usEnrichment {
+    let include: string;
+    let exclude: string;
+    let dataset: string;
+    let data_subset: string;
+}
+export namespace internationalPostalCode {
+    export let input_id: string;
+    let country_2: string;
+    export { country_2 as country };
+    let locality_1: string;
+    export { locality_1 as locality };
+    let administrative_area_1: string;
+    export { administrative_area_1 as administrative_area };
+    let postal_code_1: string;
+    export { postal_code_1 as postal_code };
+}

package/dist/types/util/buildClients.d.ts

@@ -0,0 +1,10 @@
+declare function buildUsStreetApiClient(credentials: any): any;
+declare function buildUsAutocompleteProApiClient(credentials: any): any;
+declare function buildUsExtractApiClient(credentials: any): any;
+declare function buildUsZipcodeApiClient(credentials: any): any;
+declare function buildInternationalStreetApiClient(credentials: any): any;
+declare function buildUsReverseGeoApiClient(credentials: any): any;
+declare function buildInternationalAddressAutocompleteApiClient(credentials: any): any;
+declare function buildUsEnrichmentApiClient(credentials: any): any;
+declare function buildInternationalPostalCodeApiClient(credentials: any): any;
+export { buildUsStreetApiClient as usStreet, buildUsAutocompleteProApiClient as usAutocompletePro, buildUsExtractApiClient as usExtract, buildUsZipcodeApiClient as usZipcode, buildInternationalStreetApiClient as internationalStreet, buildUsReverseGeoApiClient as usReverseGeo, buildInternationalAddressAutocompleteApiClient as internationalAddressAutocomplete, buildUsEnrichmentApiClient as usEnrichment, buildInternationalPostalCodeApiClient as internationalPostalCode };

package/dist/types/util/buildInputData.d.ts

@@ -0,0 +1,2 @@
+declare function _exports(lookup: any, keyTranslationFormat: any): {};
+export = _exports;

package/dist/types/util/buildSmartyResponse.d.ts

@@ -0,0 +1,2 @@
+export function buildSmartyResponse(response: any, error: any): Response;
+import Response = require("../Response.js");

package/dist/types/util/sendBatch.d.ts

@@ -0,0 +1,2 @@
+declare function _exports(batch: any, sender: any, Result: any, keyTranslationFormat: any): Promise<any>;
+export = _exports;

package/package.json

@@ -1,6 +1,6 @@
 {
  "name": "smartystreets-javascript-sdk",
- "version": "7.3.1",
+ "version": "7.4.1",
  "description": "Quick and easy Smarty address validation.",
  "keywords": [
   "smarty",