smartystreets-javascript-sdk 7.4.0 → 8.0.0

package/dist/types/Request.d.ts

@@ -0,0 +1,13 @@
+export = Request;
+declare class Request {
+    constructor(payload: any, headers?: {
+        "Content-Type": string;
+    });
+    baseUrl: string;
+    baseUrlParam: string;
+    payload: any;
+    headers: {
+        "Content-Type": string;
+    };
+    parameters: {};
+}

package/dist/types/Response.d.ts

@@ -0,0 +1,8 @@
+export = Response;
+declare class Response {
+    constructor(statusCode: any, payload: any, error: any, headers: any);
+    statusCode: any;
+    payload: any;
+    error: any;
+    headers: any;
+}

package/dist/types/RetrySender.d.ts

@@ -0,0 +1,13 @@
+import { Request, Response, Sender, Sleeper } from "./types";
+export default class RetrySender {
+    private maxRetries;
+    private statusToRetry;
+    private statusTooManyRequests;
+    private maxBackoffDuration;
+    private inner;
+    private sleeper;
+    constructor(maxRetries: number | undefined, inner: Sender, sleeper: Sleeper);
+    send(request: Request): Promise<Response>;
+    private backoff;
+    private rateLimitBackOff;
+}

package/dist/types/SharedCredentials.d.ts

@@ -0,0 +1,7 @@
+import { Request } from "./types.js";
+export default class SharedCredentials {
+    private authId;
+    private hostName;
+    constructor(authId: string, hostName?: string);
+    sign(request: Request): void;
+}

package/dist/types/SigningSender.d.ts

@@ -0,0 +1,11 @@
+import { Request, Response, Sender } from "./types.js";
+interface Signer {
+    sign(request: Request): void;
+}
+export default class SigningSender {
+    private signer;
+    private sender;
+    constructor(innerSender: Sender, signer: Signer);
+    send(request: Request): Promise<Response>;
+}
+export {};

package/dist/types/StaticCredentials.d.ts

@@ -0,0 +1,7 @@
+import { Request } from "./types";
+export default class StaticCredentials {
+    private authId;
+    private authToken;
+    constructor(authId: string, authToken: string);
+    sign(request: Request): void;
+}

package/dist/types/StatusCodeSender.d.ts

@@ -0,0 +1,6 @@
+export = StatusCodeSender;
+declare class StatusCodeSender {
+    constructor(innerSender: any);
+    sender: any;
+    send(request: any): Promise<any>;
+}

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

@@ -0,0 +1,6 @@
+export = Client;
+declare class Client {
+    constructor(sender: any);
+    sender: any;
+    send(lookup: any): Promise<any>;
+}

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

@@ -0,0 +1,15 @@
+export = Lookup;
+declare class Lookup {
+    constructor({ search, addressId, country, maxResults, includeOnlyLocality, includeOnlyPostalCode }?: {
+        maxResults?: number | undefined;
+    });
+    result: any[];
+    search: any;
+    addressId: any;
+    country: any;
+    maxResults: number;
+    includeOnlyLocality: any;
+    includeOnlyPostalCode: any;
+    customParameters: {};
+    addCustomParameter(key: any, value: any): void;
+}

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

@@ -0,0 +1,14 @@
+export = Suggestion;
+declare class Suggestion {
+    constructor(responseData: any);
+    street: any;
+    locality: any;
+    administrativeArea: any;
+    administrativeAreaShort: any;
+    administrativeAreaLong: any;
+    postalCode: any;
+    countryIso3: any;
+    entries: any;
+    addressText: any;
+    addressId: any;
+}

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

@@ -0,0 +1,15 @@
+export = Client;
+/**
+ * This client sends lookups to the Smarty International Postal Code API, <br>
+ *     and attaches the results to the appropriate Lookup objects.
+ */
+declare class Client {
+    constructor(sender: any);
+    sender: any;
+    /**
+     * Sends a single lookup for validation.
+     * @param data A Lookup object
+     * @throws SmartyException
+     */
+    send(lookup: any): Promise<any>;
+}

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

@@ -0,0 +1,17 @@
+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/international-postal-code-api#http-request-input-fields"
+ */
+declare class Lookup {
+    constructor(country: any, postalCode: any, administrativeArea: any, locality: any, inputId: any);
+    inputId: any;
+    country: any;
+    postalCode: any;
+    administrativeArea: any;
+    locality: any;
+    result: any[];
+    customParameters: {};
+    addCustomParameter(key: any, value: any): void;
+}

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

@@ -0,0 +1,18 @@
+export = Result;
+/**
+ * @see "https://www.smarty.com/docs/cloud/international-postal-code-api#output-fields"
+ */
+declare class Result {
+    constructor(responseData: any);
+    inputId: any;
+    administrativeArea: any;
+    superAdministrativeArea: any;
+    subAdministrativeArea: any;
+    locality: any;
+    dependentLocality: any;
+    dependentLocalityName: any;
+    doubleDependentLocality: any;
+    postalCode: any;
+    postalCodeExtra: any;
+    countryIso3: any;
+}

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

@@ -0,0 +1,26 @@
+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.
+ *
+ * @see "https://www.smarty.com/docs/cloud/international-street-api#root"
+ */
+declare class Candidate {
+    constructor(responseData: any);
+    organization: any;
+    address1: any;
+    address2: any;
+    address3: any;
+    address4: any;
+    address5: any;
+    address6: any;
+    address7: any;
+    address8: any;
+    address9: any;
+    address10: any;
+    address11: any;
+    address12: any;
+    components: {};
+    analysis: {};
+    metadata: {};
+}

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

@@ -0,0 +1,10 @@
+export = Client;
+/**
+ * This client sends lookups to the Smarty International Street 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/international_street/Lookup.d.ts

@@ -0,0 +1,29 @@
+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.
+ *     <p><b>Note: </b><i>Lookups must have certain required fields set with non-blank values. <br>
+ *         These can be found at the URL below.</i></p>
+ *     @see "https://www.smarty.com/docs/cloud/international-street-api#http-input-fields"
+ */
+declare class Lookup {
+    constructor(country: any, freeform: any);
+    result: any[];
+    country: any;
+    freeform: any;
+    address1: any;
+    address2: any;
+    address3: any;
+    address4: any;
+    organization: any;
+    locality: any;
+    administrativeArea: any;
+    postalCode: any;
+    geocode: any;
+    language: any;
+    inputId: any;
+    ensureEnoughInfo(): boolean;
+    ensureValidData(): boolean;
+    customParameters: {};
+    addCustomParameter(key: any, value: any): void;
+}

package/dist/types/types.d.ts

@@ -0,0 +1,28 @@
+export interface Request {
+    baseUrl: string;
+    baseUrlParam: string;
+    payload: string | object | null;
+    headers: Record<string, string>;
+    parameters: Record<string, string | number>;
+}
+export interface Response {
+    statusCode: number;
+    payload: object[] | object | string | null;
+    error: Error | null;
+    headers: Record<string, string>;
+}
+export interface Sender {
+    send(request: Request): Promise<Response>;
+}
+export interface Sleeper {
+    sleep(seconds: number): Promise<void>;
+}
+export interface MockSenderInstance extends Sender {
+    statusCodes: string[];
+    headers?: Record<string, unknown> | undefined;
+    error?: string | undefined;
+    currentStatusCodeIndex: number;
+}
+export interface MockSleeperInstance extends Sleeper {
+    sleepDurations: number[];
+}

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

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

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>;
+}