smartystreets-javascript-sdk 8.2.1 → 8.2.2

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

@@ -1,18 +0,0 @@
-import Candidate, { RawUsStreetCandidate } from "../us_street/Candidate.js";
-export interface RawExtractAddress {
-    text?: string;
-    verified?: boolean;
-    line?: number;
-    start?: number;
-    end?: number;
-    api_output?: RawUsStreetCandidate[];
-}
-export default class Address {
-    text: string;
-    verified: boolean;
-    line: number;
-    start: number;
-    end: number;
-    candidates: Candidate[];
-    constructor(responseData: RawExtractAddress);
-}

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

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

@@ -1,12 +0,0 @@
-import Result from "./Result.js";
-export default class Lookup {
-    result: Result;
-    text: string;
-    html: boolean | undefined;
-    aggressive: boolean | undefined;
-    addressesHaveLineBreaks: boolean | undefined;
-    addressesPerLine: number | undefined;
-    customParameters: Record<string, string>;
-    constructor(text: string);
-    addCustomParameter(key: string, value: string): void;
-}

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

@@ -1,26 +0,0 @@
-import Address, { RawExtractAddress } from "./Address.js";
-export interface ExtractMeta {
-    lines: number | undefined;
-    unicode: boolean | undefined;
-    addressCount: number | undefined;
-    verifiedCount: number | undefined;
-    bytes: number | undefined;
-    characterCount: number | undefined;
-}
-interface RawExtractMeta {
-    lines?: number;
-    unicode?: boolean;
-    address_count?: number;
-    verified_count?: number;
-    bytes?: number;
-    character_count?: number;
-}
-export default class Result {
-    meta: ExtractMeta;
-    addresses: Address[];
-    constructor({ meta, addresses }: {
-        meta: RawExtractMeta;
-        addresses: RawExtractAddress[];
-    });
-}
-export {};

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

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

@@ -1,10 +0,0 @@
-import Response from "./Response.js";
-export default class Lookup {
-    latitude: string;
-    longitude: string;
-    source: string;
-    response: Response;
-    customParameters: Record<string, string>;
-    constructor(latitude: number, longitude: number, source?: string);
-    addCustomParameter(key: string, value: string): void;
-}

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

@@ -1,9 +0,0 @@
-import Result, { RawReverseGeoResult } from "./Result.js";
-interface RawReverseGeoResponse {
-    results: RawReverseGeoResult[];
-}
-export default class Response {
-    results: Result[];
-    constructor(responseData?: RawReverseGeoResponse);
-}
-export {};

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

@@ -1,41 +0,0 @@
-import type { CoordinateLicense } from "../us_street/Candidate.js";
-export interface ReverseGeoAddress {
-    street: string | undefined;
-    city: string | undefined;
-    stateAbbreviation: string | undefined;
-    zipcode: string | undefined;
-    source: string | undefined;
-    smartyKey: string | undefined;
-}
-export interface ReverseGeoCoordinate {
-    latitude: number | undefined;
-    longitude: number | undefined;
-    accuracy: string | undefined;
-    license: CoordinateLicense | undefined;
-}
-interface RawReverseGeoAddress {
-    street?: string;
-    city?: string;
-    state_abbreviation?: string;
-    zipcode?: string;
-    source?: string;
-    smarty_key?: string;
-}
-interface RawReverseGeoCoordinate {
-    latitude?: number;
-    longitude?: number;
-    accuracy?: string;
-    license?: number;
-}
-export interface RawReverseGeoResult {
-    distance?: number;
-    address?: RawReverseGeoAddress;
-    coordinate?: RawReverseGeoCoordinate;
-}
-export default class Result {
-    distance: number;
-    address: ReverseGeoAddress;
-    coordinate: ReverseGeoCoordinate;
-    constructor(responseData: RawReverseGeoResult);
-}
-export {};

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

@@ -1,189 +0,0 @@
-export type CoordinateLicense = "SmartyStreets" | "SmartyStreets Proprietary" | (string & {});
-export interface MatchInfo {
-    status: string | undefined;
-    change: string[] | undefined;
-}
-export interface UsStreetComponents {
-    urbanization: string | undefined;
-    primaryNumber: string | undefined;
-    streetName: string | undefined;
-    streetPredirection: string | undefined;
-    streetPostdirection: string | undefined;
-    streetSuffix: string | undefined;
-    secondaryNumber: string | undefined;
-    secondaryDesignator: string | undefined;
-    extraSecondaryNumber: string | undefined;
-    extraSecondaryDesignator: string | undefined;
-    pmbDesignator: string | undefined;
-    pmbNumber: string | undefined;
-    cityName: string | undefined;
-    defaultCityName: string | undefined;
-    state: string | undefined;
-    zipCode: string | undefined;
-    plus4Code: string | undefined;
-    deliveryPoint: string | undefined;
-    deliveryPointCheckDigit: string | undefined;
-}
-export interface UsStreetMetadata {
-    recordType: string | undefined;
-    zipType: string | undefined;
-    countyFips: string | undefined;
-    countyName: string | undefined;
-    carrierRoute: string | undefined;
-    congressionalDistrict: string | undefined;
-    buildingDefaultIndicator: string | undefined;
-    rdi: string | undefined;
-    elotSequence: string | undefined;
-    elotSort: string | undefined;
-    latitude: number | undefined;
-    longitude: number | undefined;
-    coordinateLicense: CoordinateLicense | undefined;
-    precision: string | undefined;
-    timeZone: string | undefined;
-    utcOffset: number | undefined;
-    obeysDst: boolean | undefined;
-    ianaTimeZone: string | undefined;
-    ianaUtcOffset: number | undefined;
-    ianaDst: string | undefined;
-    isEwsMatch: boolean | undefined;
-}
-export interface AnalysisComponents {
-    primaryNumber: MatchInfo;
-    streetPredirection: MatchInfo;
-    streetName: MatchInfo;
-    streetPostdirection: MatchInfo;
-    streetSuffix: MatchInfo;
-    secondaryNumber: MatchInfo;
-    secondaryDesignator: MatchInfo;
-    extraSecondaryNumber: MatchInfo;
-    extraSecondaryDesignator: MatchInfo;
-    cityName: MatchInfo;
-    stateAbbreviation: MatchInfo;
-    zipCode: MatchInfo;
-    plus4Code: MatchInfo;
-    urbanization: MatchInfo;
-}
-export interface UsStreetAnalysis {
-    dpvMatchCode: string | undefined;
-    dpvFootnotes: string | undefined;
-    cmra: string | undefined;
-    vacant: string | undefined;
-    noStat: string | undefined;
-    active: string | undefined;
-    isEwsMatch: boolean | undefined;
-    footnotes: string | undefined;
-    lacsLinkCode: string | undefined;
-    lacsLinkIndicator: string | undefined;
-    isSuiteLinkMatch: boolean | undefined;
-    enhancedMatch: string | undefined;
-    components: AnalysisComponents;
-}
-interface RawUsStreetComponents {
-    urbanization?: string;
-    primary_number?: string;
-    street_name?: string;
-    street_predirection?: string;
-    street_postdirection?: string;
-    street_suffix?: string;
-    secondary_number?: string;
-    secondary_designator?: string;
-    extra_secondary_number?: string;
-    extra_secondary_designator?: string;
-    pmb_designator?: string;
-    pmb_number?: string;
-    city_name?: string;
-    default_city_name?: string;
-    state_abbreviation?: string;
-    zipcode?: string;
-    plus4_code?: string;
-    delivery_point?: string;
-    delivery_point_check_digit?: string;
-}
-interface RawUsStreetMetadata {
-    record_type?: string;
-    zip_type?: string;
-    county_fips?: string;
-    county_name?: string;
-    carrier_route?: string;
-    congressional_district?: string;
-    building_default_indicator?: string;
-    rdi?: string;
-    elot_sequence?: string;
-    elot_sort?: string;
-    latitude?: number;
-    longitude?: number;
-    coordinate_license?: number;
-    precision?: string;
-    time_zone?: string;
-    utc_offset?: number;
-    dst?: boolean;
-    iana_time_zone?: string;
-    iana_utc_offset?: number;
-    iana_dst?: string;
-    ews_match?: boolean;
-}
-interface RawMatchInfo {
-    status?: string;
-    change?: string[];
-}
-interface RawUsStreetAnalysisComponents {
-    primary_number?: RawMatchInfo;
-    street_predirection?: RawMatchInfo;
-    street_name?: RawMatchInfo;
-    street_postdirection?: RawMatchInfo;
-    street_suffix?: RawMatchInfo;
-    secondary_number?: RawMatchInfo;
-    secondary_designator?: RawMatchInfo;
-    extra_secondary_number?: RawMatchInfo;
-    extra_secondary_designator?: RawMatchInfo;
-    city_name?: RawMatchInfo;
-    state_abbreviation?: RawMatchInfo;
-    zipcode?: RawMatchInfo;
-    plus4_code?: RawMatchInfo;
-    urbanization?: RawMatchInfo;
-}
-interface RawUsStreetAnalysis {
-    dpv_match_code?: string;
-    dpv_footnotes?: string;
-    dpv_cmra?: string;
-    dpv_vacant?: string;
-    dpv_no_stat?: string;
-    active?: string;
-    ews_match?: boolean;
-    footnotes?: string;
-    lacslink_code?: string;
-    lacslink_indicator?: string;
-    suitelink_match?: boolean;
-    enhanced_match?: string;
-    components?: RawUsStreetAnalysisComponents;
-}
-export interface RawUsStreetCandidate {
-    input_id?: string;
-    input_index?: number;
-    candidate_index?: number;
-    addressee?: string;
-    delivery_line_1?: string;
-    delivery_line_2?: string;
-    last_line?: string;
-    delivery_point_barcode?: string;
-    smarty_key?: string;
-    components?: RawUsStreetComponents;
-    metadata?: RawUsStreetMetadata;
-    analysis?: RawUsStreetAnalysis;
-}
-export default class Candidate {
-    inputId: string;
-    inputIndex: number;
-    candidateIndex: number;
-    addressee: string;
-    deliveryLine1: string;
-    deliveryLine2: string;
-    lastLine: string;
-    deliveryPointBarcode: string;
-    smartyKey: string;
-    components: UsStreetComponents;
-    metadata: UsStreetMetadata;
-    analysis: UsStreetAnalysis;
-    constructor(responseData: RawUsStreetCandidate);
-}
-export {};

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

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

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

@@ -1,24 +0,0 @@
-import Candidate from "./Candidate.js";
-export type MatchStrategy = "strict" | "invalid" | "enhanced" | (string & {});
-export type OutputFormat = "default" | "project-usa" | (string & {});
-export type CountySource = "postal" | "geographic" | (string & {});
-export default class Lookup {
-    street: string | undefined;
-    street2: string | undefined;
-    secondary: string | undefined;
-    city: string | undefined;
-    state: string | undefined;
-    zipCode: string | undefined;
-    lastLine: string | undefined;
-    addressee: string | undefined;
-    urbanization: string | undefined;
-    match: MatchStrategy | undefined;
-    maxCandidates: number | undefined;
-    inputId: string | undefined;
-    format: OutputFormat | undefined;
-    countySource: CountySource | undefined;
-    result: Candidate[];
-    customParameters: Record<string, string>;
-    constructor(street?: string, street2?: string, secondary?: string, city?: string, state?: string, zipCode?: string, lastLine?: string, addressee?: string, urbanization?: string, match?: MatchStrategy, maxCandidates?: number, inputId?: string, format?: OutputFormat, countySource?: CountySource);
-    addCustomParameter(key: string, value: string): void;
-}

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

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

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

@@ -1,11 +0,0 @@
-import Result from "./Result.js";
-export default class Lookup {
-    city: string | undefined;
-    state: string | undefined;
-    zipCode: string | undefined;
-    inputId: string | undefined;
-    result: Result[];
-    customParameters: Record<string, string>;
-    constructor(city?: string, state?: string, zipCode?: string, inputId?: string);
-    addCustomParameter(key: string, value: string): void;
-}

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

@@ -1,67 +0,0 @@
-export interface CityEntry {
-    city: string;
-    stateAbbreviation: string;
-    state: string;
-    mailableCity: boolean;
-}
-export interface AlternateCounty {
-    countyFips: string;
-    countyName: string;
-    stateAbbreviation: string;
-    state: string;
-}
-export interface ZipcodeEntry {
-    zipcode: string;
-    zipcodeType: string;
-    defaultCity: string;
-    countyFips: string;
-    countyName: string;
-    latitude: number;
-    longitude: number;
-    precision: string;
-    stateAbbreviation: string;
-    state: string;
-    alternateCounties: AlternateCounty[];
-}
-interface RawAlternateCounty {
-    county_fips?: string;
-    county_name?: string;
-    state_abbreviation?: string;
-    state?: string;
-}
-interface RawCityState {
-    city?: string;
-    state_abbreviation?: string;
-    state?: string;
-    mailable_city?: boolean;
-}
-interface RawZipcode {
-    zipcode?: string;
-    zipcode_type?: string;
-    default_city?: string;
-    county_fips?: string;
-    county_name?: string;
-    latitude?: number;
-    longitude?: number;
-    precision?: string;
-    state_abbreviation?: string;
-    state?: string;
-    alternate_counties?: RawAlternateCounty[];
-}
-export interface RawZipcodeResult {
-    input_index?: number;
-    status?: string;
-    reason?: string;
-    city_states?: RawCityState[];
-    zipcodes?: RawZipcode[];
-}
-export default class Result {
-    inputIndex: number;
-    status: string | undefined;
-    reason: string | undefined;
-    valid: boolean;
-    cities: CityEntry[];
-    zipcodes: ZipcodeEntry[];
-    constructor(responseData: RawZipcodeResult);
-}
-export {};

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

@@ -1,13 +0,0 @@
-interface ApiToSDKKeyMap {
-    usStreet: Record<string, string>;
-    usAutocompletePro: Record<string, string>;
-    usZipcode: Record<string, string>;
-    internationalStreet: Record<string, string>;
-    internationalAddressAutocomplete: Record<string, string>;
-    usReverseGeo: Record<string, string>;
-    usExtract: Record<string, string>;
-    usEnrichment: Record<string, string>;
-    internationalPostalCode: Record<string, string>;
-}
-declare const apiToSDKKeyMap: ApiToSDKKeyMap;
-export default apiToSDKKeyMap;

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

@@ -1,25 +0,0 @@
-import StaticCredentials from "../StaticCredentials.js";
-import SharedCredentials from "../SharedCredentials.js";
-import BasicAuthCredentials from "../BasicAuthCredentials.js";
-type Credentials = StaticCredentials | SharedCredentials | BasicAuthCredentials;
-declare function buildUsStreetApiClient(credentials: Credentials): import("../us_street/Client.js").default;
-declare function buildUsAutocompleteProApiClient(credentials: Credentials): import("../us_autocomplete_pro/Client.js").default;
-declare function buildUsExtractApiClient(credentials: Credentials): import("../us_extract/Client.js").default;
-declare function buildUsZipcodeApiClient(credentials: Credentials): import("../us_zipcode/Client.js").default;
-declare function buildInternationalStreetApiClient(credentials: Credentials): import("../international_street/Client.js").default;
-declare function buildUsReverseGeoApiClient(credentials: Credentials): import("../us_reverse_geo/Client.js").default;
-declare function buildInternationalAddressAutocompleteApiClient(credentials: Credentials): import("../international_address_autocomplete/Client.js").default;
-declare function buildUsEnrichmentApiClient(credentials: Credentials): import("../us_enrichment/Client.js").default;
-declare function buildInternationalPostalCodeApiClient(credentials: Credentials): import("../international_postal_code/Client.js").default;
-declare const _default: {
-    usStreet: typeof buildUsStreetApiClient;
-    usAutocompletePro: typeof buildUsAutocompleteProApiClient;
-    usExtract: typeof buildUsExtractApiClient;
-    usZipcode: typeof buildUsZipcodeApiClient;
-    internationalStreet: typeof buildInternationalStreetApiClient;
-    usReverseGeo: typeof buildUsReverseGeoApiClient;
-    internationalAddressAutocomplete: typeof buildInternationalAddressAutocompleteApiClient;
-    usEnrichment: typeof buildUsEnrichmentApiClient;
-    internationalPostalCode: typeof buildInternationalPostalCodeApiClient;
-};
-export default _default;

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

@@ -1,6 +0,0 @@
-interface LookupLike {
-    customParameters?: Record<string, string>;
-    [key: string]: any;
-}
-export default function buildInputData(lookup: LookupLike, keyTranslationFormat: Record<string, string>): Record<string, string | number>;
-export {};

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

@@ -1,9 +0,0 @@
-import Response from "../Response.js";
-interface AxiosLikeResponse {
-    status: number;
-    data?: object[] | object | string | null | undefined;
-    error?: any;
-    headers?: Record<string, any> | undefined;
-}
-export declare function buildSmartyResponse(response?: AxiosLikeResponse, error?: Error): Response;
-export {};

package/dist/types/src/util/buildUsStreetInputData.d.ts

@@ -1,2 +0,0 @@
-import Lookup from "../us_street/Lookup.js";
-export default function buildUsStreetInputData(lookup: Lookup): Record<string, string | number>;

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

@@ -1,5 +0,0 @@
-import Batch from "../Batch.js";
-import { Sender } from "../types.js";
-export default function sendBatch(batch: Batch, sender: Sender, Result: new (data: any) => {
-    inputIndex: number;
-}, keyTranslationFormat: Record<string, string> | null, customBuildInputData?: (lookup: any) => Record<string, string | number>): Promise<Batch>;

package/dist/types/tests/fixtures/MockSleeper.d.ts

@@ -1,5 +0,0 @@
-export default class MockSleeper {
-    sleepDurations: number[];
-    constructor();
-    sleep(ms: number): void;
-}

package/dist/types/tests/fixtures/mock_senders.d.ts

@@ -1,25 +0,0 @@
-import Response from "../../src/Response.js";
-import { Request as IRequest, Response as IResponse } from "../../src/types.js";
-export declare class MockSender {
-    request: {
-        payload: string | object | null;
-        parameters: Record<string, string | number>;
-        baseUrlParam: string;
-    };
-    constructor();
-    send(clientRequest: IRequest): Promise<IResponse>;
-}
-export declare class MockSenderWithResponse {
-    private expectedPayload;
-    private expectedError;
-    constructor(expectedPayload: object[] | object | string | null, expectedError?: Error | null);
-    send(): Promise<IResponse>;
-}
-export declare class MockSenderWithStatusCodesAndHeaders {
-    statusCodes: number[];
-    headers: Record<string, unknown> | undefined;
-    error: string | undefined;
-    currentStatusCodeIndex: number;
-    constructor(statusCodes: number[], headers?: Record<string, unknown>, error?: string);
-    send(_request: IRequest): Response;
-}

package/dist/types/tests/international_address_autocomplete/test_Client.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/types/tests/international_address_autocomplete/test_Lookup.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/types/tests/international_postal_code/test_Client.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/types/tests/international_postal_code/test_Lookup.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/types/tests/international_postal_code/test_Result.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/types/tests/international_street/test_Candidate.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/types/tests/international_street/test_Client.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/types/tests/international_street/test_Lookup.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/types/tests/test_AgentSender.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/types/tests/test_BaseUrlSender.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/types/tests/test_BasicAuthCredentials.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/types/tests/test_Batch.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/types/tests/test_ClientBuilder.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/types/tests/test_CustomHeaderSender.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/types/tests/test_CustomQuerySender.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/types/tests/test_ExtractExample.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/types/tests/test_HttpSender.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/types/tests/test_LicenseSender.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/types/tests/test_RetrySender.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/types/tests/test_SigningSender.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/types/tests/test_StatusCodeSender.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/types/tests/us_autocomplete_pro/test_Client.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/types/tests/us_autocomplete_pro/test_Lookup.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/types/tests/us_autocomplete_pro/test_Suggestion.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/types/tests/us_enrichment/test_Client.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/types/tests/us_enrichment/test_Lookup.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/types/tests/us_enrichment/test_Response.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/types/tests/us_extract/test_Address.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/types/tests/us_extract/test_Client.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/types/tests/us_extract/test_Lookup.d.ts

@@ -1 +0,0 @@
-export {};