smartystreets-javascript-sdk 8.1.0 → 8.2.1

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

@@ -0,0 +1,250 @@
+export interface IntlStreetComponents {
+    countryIso3: string | undefined;
+    superAdministrativeArea: string | undefined;
+    administrativeArea: string | undefined;
+    administrativeAreaIso2: string | undefined;
+    administrativeAreaShort: string | undefined;
+    administrativeAreaLong: string | undefined;
+    subAdministrativeArea: string | undefined;
+    dependentLocality: string | undefined;
+    dependentLocalityName: string | undefined;
+    doubleDependentLocality: string | undefined;
+    locality: string | undefined;
+    postalCode: string | undefined;
+    postalCodeShort: string | undefined;
+    postalCodeExtra: string | undefined;
+    premise: string | undefined;
+    premiseExtra: string | undefined;
+    premisePrefixNumber: string | undefined;
+    premiseNumber: string | undefined;
+    premiseType: string | undefined;
+    thoroughfare: string | undefined;
+    thoroughfarePredirection: string | undefined;
+    thoroughfarePostdirection: string | undefined;
+    thoroughfareName: string | undefined;
+    thoroughfareTrailingType: string | undefined;
+    thoroughfareType: string | undefined;
+    dependentThoroughfare: string | undefined;
+    dependentThoroughfarePredirection: string | undefined;
+    dependentThoroughfarePostdirection: string | undefined;
+    dependentThoroughfareName: string | undefined;
+    dependentThoroughfareTrailingType: string | undefined;
+    dependentThoroughfareType: string | undefined;
+    building: string | undefined;
+    buildingLeadingType: string | undefined;
+    buildingName: string | undefined;
+    buildingTrailingType: string | undefined;
+    subBuildingType: string | undefined;
+    subBuildingNumber: string | undefined;
+    subBuildingName: string | undefined;
+    subBuilding: string | undefined;
+    levelType: string | undefined;
+    levelNumber: string | undefined;
+    postBox: string | undefined;
+    postBoxType: string | undefined;
+    postBoxNumber: string | undefined;
+    additionalContent: string | undefined;
+    deliveryInstallation: string | undefined;
+    deliveryInstallationType: string | undefined;
+    deliveryInstallationQualifierName: string | undefined;
+    route: string | undefined;
+    routeNumber: string | undefined;
+    routeType: string | undefined;
+}
+export interface IntlChangesComponents {
+    countryIso3: string | undefined;
+    superAdministrativeArea: string | undefined;
+    administrativeArea: string | undefined;
+    administrativeAreaIso2: string | undefined;
+    administrativeAreaShort: string | undefined;
+    administrativeAreaLong: string | undefined;
+    subAdministrativeArea: string | undefined;
+    dependentLocality: string | undefined;
+    dependentLocalityName: string | undefined;
+    doubleDependentLocality: string | undefined;
+    locality: string | undefined;
+    postalCode: string | undefined;
+    postalCodeShort: string | undefined;
+    postalCodeExtra: string | undefined;
+    premise: string | undefined;
+    premiseExtra: string | undefined;
+    premisePrefixNumber: string | undefined;
+    premiseNumber: string | undefined;
+    premiseType: string | undefined;
+    thoroughfare: string | undefined;
+    thoroughfarePredirection: string | undefined;
+    thoroughfarePostdirection: string | undefined;
+    thoroughfareName: string | undefined;
+    thoroughfareTrailingType: string | undefined;
+    thoroughfareType: string | undefined;
+    dependentThoroughfare: string | undefined;
+    dependentThoroughfarePredirection: string | undefined;
+    dependentThoroughfarePostdirection: string | undefined;
+    dependentThoroughfareName: string | undefined;
+    dependentThoroughfareTrailingType: string | undefined;
+    dependentThoroughfareType: string | undefined;
+    building: string | undefined;
+    buildingLeadingType: string | undefined;
+    buildingName: string | undefined;
+    buildingTrailingType: string | undefined;
+    subBuildingType: string | undefined;
+    subBuildingNumber: string | undefined;
+    subBuildingName: string | undefined;
+    subBuilding: string | undefined;
+    levelType: string | undefined;
+    levelNumber: string | undefined;
+    postBox: string | undefined;
+    postBoxType: string | undefined;
+    postBoxNumber: string | undefined;
+}
+export interface IntlChanges {
+    organization: string | undefined;
+    address1: string | undefined;
+    address2: string | undefined;
+    address3: string | undefined;
+    address4: string | undefined;
+    address5: string | undefined;
+    address6: string | undefined;
+    address7: string | undefined;
+    address8: string | undefined;
+    address9: string | undefined;
+    address10: string | undefined;
+    address11: string | undefined;
+    address12: string | undefined;
+    components: IntlChangesComponents;
+}
+export interface IntlStreetAnalysis {
+    verificationStatus: string | undefined;
+    addressPrecision: string | undefined;
+    maxAddressPrecision: string | undefined;
+    changes: IntlChanges;
+}
+export interface IntlStreetMetadata {
+    latitude: number | undefined;
+    longitude: number | undefined;
+    geocodePrecision: string | undefined;
+    maxGeocodePrecision: string | undefined;
+    addressFormat: string | undefined;
+    occupantUse: string | undefined;
+}
+interface RawIntlStreetRawComponents {
+    country_iso_3?: string;
+    super_administrative_area?: string;
+    administrative_area?: string;
+    administrative_area_iso2?: string;
+    administrative_area_short?: string;
+    administrative_area_long?: string;
+    sub_administrative_area?: string;
+    dependent_locality?: string;
+    dependent_locality_name?: string;
+    double_dependent_locality?: string;
+    locality?: string;
+    postal_code?: string;
+    postal_code_short?: string;
+    postal_code_extra?: string;
+    premise?: string;
+    premise_extra?: string;
+    premise_prefix_number?: string;
+    premise_number?: string;
+    premise_type?: string;
+    thoroughfare?: string;
+    thoroughfare_predirection?: string;
+    thoroughfare_postdirection?: string;
+    thoroughfare_name?: string;
+    thoroughfare_trailing_type?: string;
+    thoroughfare_type?: string;
+    dependent_thoroughfare?: string;
+    dependent_thoroughfare_predirection?: string;
+    dependent_thoroughfare_postdirection?: string;
+    dependent_thoroughfare_name?: string;
+    dependent_thoroughfare_trailing_type?: string;
+    dependent_thoroughfare_type?: string;
+    building?: string;
+    building_leading_type?: string;
+    building_name?: string;
+    building_trailing_type?: string;
+    sub_building_type?: string;
+    sub_building_number?: string;
+    sub_building_name?: string;
+    sub_building?: string;
+    level_type?: string;
+    level_number?: string;
+    post_box?: string;
+    post_box_type?: string;
+    post_box_number?: string;
+    additional_content?: string;
+    delivery_installation?: string;
+    delivery_installation_type?: string;
+    delivery_installation_qualifier_name?: string;
+    route?: string;
+    route_number?: string;
+    route_type?: string;
+}
+interface RawIntlChanges {
+    organization?: string;
+    address1?: string;
+    address2?: string;
+    address3?: string;
+    address4?: string;
+    address5?: string;
+    address6?: string;
+    address7?: string;
+    address8?: string;
+    address9?: string;
+    address10?: string;
+    address11?: string;
+    address12?: string;
+    components?: RawIntlStreetRawComponents;
+}
+interface RawIntlStreetAnalysis {
+    verification_status?: string;
+    address_precision?: string;
+    max_address_precision?: string;
+    changes?: RawIntlChanges;
+}
+interface RawIntlStreetMetadata {
+    latitude?: number;
+    longitude?: number;
+    geocode_precision?: string;
+    max_geocode_precision?: string;
+    address_format?: string;
+    occupant_use?: string;
+}
+export interface RawIntlStreetCandidate {
+    organization?: string;
+    address1?: string;
+    address2?: string;
+    address3?: string;
+    address4?: string;
+    address5?: string;
+    address6?: string;
+    address7?: string;
+    address8?: string;
+    address9?: string;
+    address10?: string;
+    address11?: string;
+    address12?: string;
+    components?: RawIntlStreetRawComponents;
+    analysis?: RawIntlStreetAnalysis;
+    metadata?: RawIntlStreetMetadata;
+}
+export default class Candidate {
+    organization: string;
+    address1: string;
+    address2: string;
+    address3: string;
+    address4: string;
+    address5: string;
+    address6: string;
+    address7: string;
+    address8: string;
+    address9: string;
+    address10: string;
+    address11: string;
+    address12: string;
+    components: IntlStreetComponents;
+    analysis: IntlStreetAnalysis;
+    metadata: IntlStreetMetadata;
+    constructor(responseData: RawIntlStreetCandidate);
+}
+export {};

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

@@ -0,0 +1,7 @@
+import { Sender } from "../types.js";
+import Lookup from "./Lookup.js";
+export default class Client {
+    private sender;
+    constructor(sender: Sender);
+    send(lookup: Lookup): Promise<Lookup>;
+}

package/dist/types/src/international_street/Lookup.d.ts

@@ -0,0 +1,24 @@
+import Candidate from "./Candidate.js";
+export type Language = "native" | "latin" | (string & {});
+export type Geocode = "true" | (string & {});
+export default class Lookup {
+    result: Candidate[];
+    country: string | undefined;
+    freeform: string | undefined;
+    address1: string | undefined;
+    address2: string | undefined;
+    address3: string | undefined;
+    address4: string | undefined;
+    organization: string | undefined;
+    locality: string | undefined;
+    administrativeArea: string | undefined;
+    postalCode: string | undefined;
+    geocode: Geocode | undefined;
+    language: Language | undefined;
+    inputId: string | undefined;
+    customParameters: Record<string, string>;
+    constructor(country?: string, freeform?: string);
+    addCustomParameter(key: string, value: string): void;
+    ensureEnoughInfo(): boolean;
+    ensureValidData(): boolean;
+}

package/dist/types/{types.d.ts → src/types.d.ts}

@@ -17,8 +17,18 @@ export interface Sender {
 export interface Sleeper {
     sleep(seconds: number): Promise<void>;
 }
+export interface Signer {
+    sign(request: Request): void;
+}
+export interface BaseLookup {
+    inputId?: string | number | undefined;
+    customParameters: Record<string, string>;
+    result: {
+        inputIndex: number;
+    }[];
+}
 export interface MockSenderInstance extends Sender {
-    statusCodes: string[];
+    statusCodes: number[];
     headers?: Record<string, unknown> | undefined;
     error?: string | undefined;
     currentStatusCodeIndex: number;

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

@@ -0,0 +1,7 @@
+import { Sender } from "../types.js";
+import Lookup from "./Lookup.js";
+export default class Client {
+    private sender;
+    constructor(sender: Sender);
+    send(lookup: Lookup): Promise<Lookup>;
+}

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

@@ -0,0 +1,21 @@
+import Suggestion from "./Suggestion.js";
+export type Geolocation = "city" | "none" | (string & {});
+export default class Lookup {
+    result: Suggestion[];
+    search: string | undefined;
+    selected: string | undefined;
+    maxResults: number | undefined;
+    includeOnlyCities: string[];
+    includeOnlyStates: string[];
+    includeOnlyZIPCodes: string[];
+    excludeStates: string[];
+    preferCities: string[];
+    preferStates: string[];
+    preferZIPCodes: string[];
+    preferRatio: number | undefined;
+    preferGeolocation: Geolocation | undefined;
+    source: string | undefined;
+    customParameters: Record<string, string>;
+    constructor(search?: string);
+    addCustomParameter(key: string, value: string): void;
+}

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

@@ -0,0 +1,19 @@
+export interface RawUsAutocompleteSuggestion {
+    street_line?: string;
+    secondary?: string;
+    city?: string;
+    state?: string;
+    zipcode?: string;
+    entries?: number;
+    source?: string;
+}
+export default class Suggestion {
+    streetLine: string;
+    secondary: string;
+    city: string;
+    state: string;
+    zipcode: string;
+    entries: number;
+    source: string | undefined;
+    constructor(responseData: RawUsAutocompleteSuggestion);
+}

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

@@ -0,0 +1,11 @@
+import { Sender } from "../types.js";
+import Lookup from "./Lookup.js";
+export default class Client {
+    private sender;
+    constructor(sender: Sender);
+    sendPrincipal(lookup: Lookup): Promise<Lookup>;
+    sendFinancial(lookup: Lookup): Promise<Lookup>;
+    sendGeo(lookup: Lookup): Promise<Lookup>;
+    sendSecondary(lookup: Lookup): Promise<Lookup>;
+    sendSecondaryCount(lookup: Lookup): Promise<Lookup>;
+}

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

@@ -0,0 +1,13 @@
+import { Response, FinancialResponse, GeoResponse } from "./Response.js";
+export default class Lookup {
+    smartyKey: string | undefined;
+    include: string | undefined;
+    exclude: string | undefined;
+    dataset: string | undefined;
+    dataSubset: string | undefined;
+    features: string | undefined;
+    response: Response | FinancialResponse | GeoResponse;
+    customParameters: Record<string, string>;
+    constructor(smartyKey?: string, include?: string, exclude?: string, dataset?: string, dataSubset?: string);
+    addCustomParameter(key: string, value: string): void;
+}