smartystreets-javascript-sdk 8.2.0 → 8.2.1

package/dist/types/ClientBuilder.d.ts

@@ -1,126 +0,0 @@
-export = ClientBuilder;
-/**
- * The ClientBuilder class helps you build a client object for one of the supported Smarty APIs.<br>
- * You can use ClientBuilder's methods to customize settings like maximum retries or timeout duration. These methods<br>
- * are chainable, so you can usually get set up with one line of code.
- */
-declare class ClientBuilder {
-    constructor(signer: any);
-    signer: any;
-    httpSender: any;
-    maxRetries: number;
-    maxTimeout: number;
-    baseUrl: any;
-    proxy: {
-        host: any;
-        port: any;
-        protocol: any;
-    } | undefined;
-    customHeaders: {};
-    appendHeaders: {};
-    debug: boolean | undefined;
-    licenses: any[];
-    customQueries: Map<any, any>;
-    /**
-     * @param retries The maximum number of times to retry sending the request to the API. (Default is 5)
-     * @return ClientBuilder <b>this</b> to accommodate method chaining.
-     */
-    withMaxRetries(retries: any): this;
-    /**
-     * @param timeout The maximum time (in milliseconds) to wait for a connection, and also to wait for <br>
-     *                   the response to be read. (Default is 10000)
-     * @return ClientBuilder <b>this</b> to accommodate method chaining.
-     */
-    withMaxTimeout(timeout: any): this;
-    /**
-     * @param sender Default is a series of nested senders. See <b>buildSender()</b>.
-     * @return ClientBuilder <b>this</b> to accommodate method chaining.
-     */
-    withSender(sender: any): this;
-    /**
-     * This may be useful when using a local installation of the Smarty APIs.
-     * @param url Defaults to the URL for the API corresponding to the <b>Client</b> object being built.
-     * @return ClientBuilder <b>this</b> to accommodate method chaining.
-     */
-    withBaseUrl(url: any): this;
-    /**
-     * Use this to specify a proxy through which to send all lookups.
-     * @param host The host of the proxy server (do not include the port).
-     * @param port The port on the proxy server to which you wish to connect.
-     * @param protocol The protocol on the proxy server to which you wish to connect. If the proxy server uses HTTPS, then you must set the protocol to 'https'.
-     * @param username The username to login to the proxy.
-     * @param password The password to login to the proxy.
-     * @return ClientBuilder <b>this</b> to accommodate method chaining.
-     */
-    withProxy(host: any, port: any, protocol: any, username: any, password: any): this;
-    /**
-     * Use this to add any additional headers you need.
-     * @param customHeaders A String to Object <b>Map</b> of header name/value pairs.
-     * @return ClientBuilder <b>this</b> to accommodate method chaining.
-     */
-    withCustomHeaders(customHeaders: any): this;
-    /**
-     * Appends the provided value to the existing header value using the specified separator,
-     * rather than replacing it. This is useful for single-value headers like User-Agent.
-     * @param key The header name.
-     * @param value The value to append.
-     * @param separator The separator to use when joining values.
-     * @return ClientBuilder <b>this</b> to accommodate method chaining.
-     */
-    withAppendedHeader(key: any, value: any, separator: any): this;
-    /**
-     * Enables debug mode, which will print information about the HTTP request and response to console.log
-     * @return ClientBuilder <b>this</b> to accommodate method chaining.
-     */
-    withDebug(): this;
-    /**
-     * Allows the caller to specify the subscription license (aka "track") they wish to use.
-     * @param licenses A String Array of licenses.
-     * @returns ClientBuilder <b>this</b> to accommodate method chaining.
-     */
-    withLicenses(licenses: any): this;
-    /**
-     * Allows the caller to specify key and value pair that is added to the request
-     * @param {string} key - The query parameter key
-     * @param {string} value - The query parameter value
-     * @return ClientBuilder <b>this</b> to accommodate method chaining.
-     */
-    withCustomQuery(key: string, value: string): this;
-    /**
-     * Allows the caller to specify key and value pair and appends the value associated with the key, seperated by a comma.
-     * @param {string} key - The query parameter key
-     * @param {string} value - The query parameter value
-     * @return ClientBuilder <b>this</b> to accommodate method chaining.
-     */
-    withCustomCommaSeperatedQuery(key: string, value: string): this;
-    /**
-     * Adds to the request query to use the component analysis feature.
-     * @return ClientBuilder <b>this</b> to accommodate method chaining.
-     */
-    withFeatureComponentAnalysis(): this;
-    /**
-     * Adds to the request query to use the financial history feature.
-     * @return ClientBuilder <b>this</b> to accommodate method chaining.
-     */
-    withFinancialHistory(): this;
-    /**
-     * Adds to the request query to use the occupant use feature.
-     * @return ClientBuilder <b>this</b> to accommodate method chaining.
-     */
-    withOccupantUse(): this;
-    /**
-     * withFeatureIANATimeZone turns on the IANA timezone feature for the request.
-     */
-    withFeatureIANATimeZone(): this;
-    buildSender(): any;
-    buildClient(baseUrl: any, Client: any): any;
-    buildUsStreetApiClient(): any;
-    buildUsZipcodeClient(): any;
-    buildInternationalPostalCodeClient(): any;
-    buildUsAutocompleteProClient(): any;
-    buildUsExtractClient(): any;
-    buildInternationalStreetClient(): any;
-    buildUsReverseGeoClient(): any;
-    buildInternationalAddressAutocompleteClient(): any;
-    buildUsEnrichmentClient(): any;
-}

package/dist/types/Errors.d.ts

@@ -1,42 +0,0 @@
-export class BatchFullError extends SmartyError {
-    constructor();
-}
-export class BatchEmptyError extends SmartyError {
-    constructor();
-}
-export class UndefinedLookupError extends SmartyError {
-    constructor();
-}
-export class BadCredentialsError extends SmartyError {
-    constructor();
-}
-export class PaymentRequiredError extends SmartyError {
-    constructor();
-}
-export class RequestEntityTooLargeError extends SmartyError {
-    constructor();
-}
-export class BadRequestError extends SmartyError {
-    constructor();
-}
-export class UnprocessableEntityError extends SmartyError {
-    constructor(message: any);
-}
-export class TooManyRequestsError extends SmartyError {
-    constructor();
-}
-export class InternalServerError extends SmartyError {
-    constructor();
-}
-export class ServiceUnavailableError extends SmartyError {
-    constructor();
-}
-export class GatewayTimeoutError extends SmartyError {
-    constructor();
-}
-export class DefaultError extends SmartyError {
-    constructor(message: any);
-}
-declare class SmartyError extends Error {
-}
-export {};

package/dist/types/HttpSender.d.ts

@@ -1,22 +0,0 @@
-export = HttpSender;
-declare class HttpSender {
-    constructor(timeout: number | undefined, proxyConfig: any, debug?: boolean);
-    axiosInstance: any;
-    timeout: number;
-    proxyConfig: any;
-    buildRequestConfig({ payload, parameters, headers, baseUrl }: {
-        payload: any;
-        parameters: any;
-        headers: any;
-        baseUrl: any;
-    }): {
-        method: string;
-        timeout: number;
-        params: any;
-        headers: any;
-        baseURL: any;
-        validateStatus: (status: any) => boolean;
-    };
-    send(request: any): Promise<any>;
-    enableDebug(): void;
-}

package/dist/types/InputData.d.ts

@@ -1,10 +0,0 @@
-export = InputData;
-declare class InputData {
-    constructor(lookup: any);
-    lookup: any;
-    data: {};
-    add(apiField: any, lookupField: any): void;
-    addCustomParameter(key: any, value: any): void;
-    formatData(field: any): any;
-    lookupFieldIsPopulated(lookupField: any): boolean;
-}

package/dist/types/LicenseSender.d.ts

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

package/dist/types/Request.d.ts

@@ -1,13 +0,0 @@
-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

@@ -1,8 +0,0 @@
-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/StatusCodeSender.d.ts

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

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

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

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

@@ -1,15 +0,0 @@
-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

@@ -1,14 +0,0 @@
-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

@@ -1,15 +0,0 @@
-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

@@ -1,17 +0,0 @@
-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

@@ -1,18 +0,0 @@
-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

@@ -1,26 +0,0 @@
-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

@@ -1,10 +0,0 @@
-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

@@ -1,29 +0,0 @@
-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/us_autocomplete_pro/Client.d.ts

@@ -1,10 +0,0 @@
-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

@@ -1,28 +0,0 @@
-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

@@ -1,14 +0,0 @@
-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

@@ -1,10 +0,0 @@
-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

@@ -1,13 +0,0 @@
-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

@@ -1,20 +0,0 @@
-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

@@ -1,13 +0,0 @@
-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

@@ -1,10 +0,0 @@
-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

@@ -1,23 +0,0 @@
-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

@@ -1,19 +0,0 @@
-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

@@ -1,10 +0,0 @@
-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

@@ -1,16 +0,0 @@
-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

@@ -1,8 +0,0 @@
-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

@@ -1,13 +0,0 @@
-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

@@ -1,22 +0,0 @@
-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: {};
-}