@parseapi/sdk 0.2.0 → 0.3.0

package/dist/index.d.ts

@@ -296,6 +296,10 @@ interface Iban {
     checksum: string | null;
     /** Bank identifier parsed from the number, not a name. */
     bank: string | null;
+    /** Institution name from the national bank-code directory. Null when unsourced. */
+    bank_name: string | null;
+    /** BIC from that same directory. Null when unsourced or missing. */
+    bic: string | null;
     /** Branch identifier when that country has one. */
     branch: string | null;
     account: string | null;
@@ -307,6 +311,8 @@ interface Npi {
     /** Exists in the CMS NPPES registry. */
     registered: boolean | null;
     active: boolean | null;
+    /** Date CMS deactivated the NPI, YYYY-MM-DD. Null when still active. */
+    deactivated_at: string | null;
     /** On the OIG exclusion list. */
     excluded: boolean | null;
     /** individual or organization. */
@@ -341,7 +347,7 @@ interface NpiDeep {
     /** Enrollment rows. [] when medicare is false. */
     enrollments?: NpiEnrollment[] | null;
 }
-interface HtsMeasure {
+interface TariffMeasure {
     /** Chapter 99 heading, dotted (9903.01.24). */
     heading: string;
     /** The measure text verbatim. */
@@ -353,15 +359,15 @@ interface HtsMeasure {
     /** Expires, ISO YYYY-MM-DD. Null when open-ended. */
     until: string | null;
 }
-interface HtsDeep {
+interface TariffDeep {
     /** The origin country the measures were resolved for. */
     origin?: string | null;
     /** Composed ad valorem percent. Null when the components do not compose cleanly. */
     effective_rate?: number | null;
     /** Every Chapter 99 tariff measure that applies to this code from this origin. */
-    measures?: HtsMeasure[] | null;
+    measures?: TariffMeasure[] | null;
 }
-interface Hts {
+interface Tariff {
     /** Normalized code with dots (8471.30.01.00). */
     hts: string;
     /** The schedule line verbatim. */
@@ -378,18 +384,18 @@ interface Hts {
     other: string | null;
     /** The official release that answered (2026HTSRev17). */
     revision: string;
-    deep?: Deep<HtsDeep>;
+    deep?: Deep<TariffDeep>;
 }
-interface HtsSearchHit {
+interface TariffSearchHit {
     hts: string;
     description: string;
     general: string | null;
 }
-interface HtsSearch {
+interface TariffSearch {
     q: string;
     revision: string;
     /** Up to 20 tariff lines, best match first. */
-    lines: HtsSearchHit[];
+    lines: TariffSearchHit[];
 }
 interface VinRecall {
     /** Government campaign number. */
@@ -444,6 +450,8 @@ interface Phone {
     /** NPA-derived state code (US/CA). */
     state: string | null;
     state_name: string | null;
+    /** Numbering-plan IANA zone. Null when the prefix covers more than one zone, or invalid. Not the handset. */
+    timezone: string | null;
     national: string | null;
     international: string | null;
     /** Always empty. The metered proves are their own endpoints: carrier, caller, hlr. */
@@ -517,6 +525,21 @@ interface Domain {
     available: boolean;
     deep?: Deep<DomainDeep>;
 }
+/** Network identity for an autonomous system number. */
+interface Asn {
+    asn: number;
+    name: string | null;
+    country: string | null;
+    country_name: string | null;
+}
+/** A normalized 48-bit address. Vendor names the registered assignment holder. */
+interface Mac {
+    mac: string;
+    valid: boolean;
+    vendor: string | null;
+    local: boolean | null;
+    multicast: boolean | null;
+}
 interface Mx {
     domain: string;
     mx: MxRecord[];
@@ -869,6 +892,78 @@ interface EmojiSearch {
     q: string;
     emojis: Emoji[];
 }
+interface Address {
+    address: string | null;
+    valid: boolean;
+    registered: boolean | null;
+    number: string | null;
+    street: string | null;
+    unit: string | null;
+    city: string | null;
+    district: string | null;
+    district_name: string | null;
+    state: string | null;
+    state_name: string | null;
+    postal: string | null;
+    country: string | null;
+    country_name: string | null;
+    latitude: number | null;
+    longitude: number | null;
+    deep?: Record<string, unknown>;
+}
+interface AddressSuggestion {
+    address: string;
+    number: string | null;
+    street: string | null;
+    unit: string | null;
+    city: string | null;
+    state: string | null;
+    postal: string | null;
+    latitude: number | null;
+    longitude: number | null;
+}
+interface AddressSearch {
+    q: string;
+    postal?: string | null;
+    city?: string | null;
+    state?: string | null;
+    country?: string | null;
+    addresses: AddressSuggestion[];
+}
+interface CompanyCountry {
+    name: string | null;
+    blocs: string[];
+    tax: string | null;
+}
+interface CompanyDeep {
+    country: CompanyCountry | null;
+    postal: Postal | null;
+    city: City | null;
+}
+interface Company {
+    company: string | null;
+    valid: boolean;
+    registered: boolean | null;
+    country: string | null;
+    type: string | null;
+    name: string | null;
+    active: boolean | null;
+    activity: string | null;
+    address: string | null;
+    city: string | null;
+    state: string | null;
+    state_name: string | null;
+    postal: string | null;
+    country_name: string | null;
+    vat: string | null;
+    gst: boolean | null;
+    acn: string | null;
+    siren: string | null;
+    siege: boolean | null;
+    kind: string | null;
+    invoice: string | null;
+    deep?: Deep<CompanyDeep>;
+}
 
 /** Every non-2xx response from the API. Branch on `code`, never on `message`. */
 declare class ParseAPIError extends Error {
@@ -882,146 +977,222 @@ declare class ParseAPIError extends Error {
     readonly requestId: string | null;
     constructor(status: number, code: string, message: string, docs: string | null, requestId: string | null);
 }
+interface RequestOptions {
+    /** Cancel this call, including any retry wait. */
+    signal?: AbortSignal;
+    /** Timeout for each attempt, in milliseconds. Overrides the client setting. */
+    timeoutMs?: number;
+    /** Explicit retry count. Paid attempts can each consume usage. */
+    retries?: number;
+}
 interface ParseAPIOptions {
     /** Override https://api.parseapi.com (tests, canaries). Also read from PARSEAPI_BASE_URL. */
     baseUrl?: string;
     /** Per-attempt timeout in milliseconds. Default 10000. */
     timeoutMs?: number;
-    /** Retries after the first attempt on network errors / 429 / 5xx. Default 2, 0 disables. */
+    /** Retries after the first attempt on network errors / 429 / 5xx. Default 2 for ordinary calls, 0 for paid checks. An explicit count overrides both. */
     retries?: number;
     /** Custom fetch implementation (instrumentation, proxies). */
     fetch?: typeof fetch;
 }
+type IpOptions = DeepOption & RequestOptions;
+type IpSelfOptions = DeepOption & RequestOptions;
+type ContinentOptions = RequestOptions;
+type ContinentCountriesOptions = RequestOptions;
+type BlocOptions = RequestOptions;
+type BlocCountriesOptions = RequestOptions;
+type CountryOptions = RequestOptions;
+type CountryStatesOptions = RequestOptions;
+type StateOptions = {
+    country?: string;
+} & RequestOptions;
+type StateDistrictsOptions = {
+    country?: string;
+} & RequestOptions;
+type DistrictOptions = {
+    country?: string;
+    state?: string;
+} & RequestOptions;
+type CityOptions = {
+    country?: string;
+    state?: string;
+} & RequestOptions;
+type CityIdOptions = RequestOptions;
+type CitySearchOptions = {
+    country?: string;
+    state?: string;
+    limit?: number;
+} & RequestOptions;
+type CityNearestOptions = RequestOptions;
+type CityNearbyOptions = {
+    radius?: number;
+    unit?: 'km' | 'mi';
+    country?: string;
+    state?: string;
+    limit?: number;
+} & RequestOptions;
+type PostalOptions = {
+    country?: string;
+} & RequestOptions;
+type PostalNearbyOptions = {
+    country?: string;
+    radius?: number;
+    unit?: 'km' | 'mi';
+} & RequestOptions;
+type PostalDistanceOptions = {
+    country?: string;
+} & RequestOptions;
+type AddressOptions = {
+    country?: string;
+} & DeepOption & RequestOptions;
+type AddressSearchOptions = {
+    country?: string;
+    postal?: string;
+    city?: string;
+    state?: string;
+    ip?: string;
+} & RequestOptions;
+type CompanyOptions = {
+    country?: string;
+} & DeepOption & RequestOptions;
+type EmailOptions = DeepOption & RequestOptions;
+type VatOptions = {
+    country?: string;
+    from?: string;
+} & DeepOption & RequestOptions;
+type IbanOptions = {
+    country?: string;
+} & RequestOptions;
+type NpiOptions = DeepOption & RequestOptions;
+type PhoneOptions = {
+    country?: string;
+} & DeepOption & RequestOptions;
+type CarrierOptions = {
+    country?: string;
+} & RequestOptions;
+type CallerOptions = {
+    country?: string;
+} & RequestOptions;
+type HlrOptions = {
+    country?: string;
+} & RequestOptions;
+type DomainOptions = DeepOption & RequestOptions;
+type AsnOptions = RequestOptions;
+type MacOptions = RequestOptions;
+type MxOptions = RequestOptions;
+type UseragentOptions = DeepOption & RequestOptions;
+type VinOptions = DeepOption & RequestOptions;
+type TariffOptions = {
+    origin?: string;
+} & DeepOption & RequestOptions;
+type TariffSearchOptions = RequestOptions;
+type CurrencyOptions = RequestOptions;
+type CurrencyRateOptions = {
+    date?: string;
+    amount?: number;
+} & RequestOptions;
+type LanguageOptions = RequestOptions;
+type NameOptions = RequestOptions;
+type TimezoneOptions = {
+    at?: string;
+    to?: string;
+} & RequestOptions;
+type TimezoneAtOptions = {
+    at?: string;
+} & RequestOptions;
+type DateOptions = {
+    format?: 'mdy' | 'dmy';
+    to?: string;
+} & RequestOptions;
+type DateTodayOptions = {
+    to?: string;
+} & RequestOptions;
+type HolidayOptions = {
+    year?: number;
+} & RequestOptions;
+type HolidayDateOptions = RequestOptions;
+type ElevationOptions = RequestOptions;
+type PointOptions = DeepOption & RequestOptions;
+type WeatherOptions = DeepOption & {
+    date?: string;
+} & RequestOptions;
+type EmojiOptions = RequestOptions;
+type EmojiSearchOptions = {
+    limit?: number;
+} & RequestOptions;
 interface DeepOption {
-    /** Request the nested deep object. Paid on most endpoints. */
+    /** Request richer fields. Availability and usage depend on the endpoint. */
     deep?: boolean;
 }
 declare function parseAPI(apiKey?: string, options?: ParseAPIOptions): {
-    ip: ((ip: string, opts?: DeepOption) => Promise<Ip>) & {
-        self: (opts?: DeepOption) => Promise<Ip>;
+    ip: ((ip: string, opts?: IpOptions) => Promise<Ip>) & {
+        self: (opts?: IpSelfOptions) => Promise<Ip>;
+    };
+    continent: ((code: string, opts?: ContinentOptions) => Promise<Continent>) & {
+        countries: (code: string, opts?: ContinentCountriesOptions) => Promise<ContinentCountries>;
     };
-    continent: ((code: string) => Promise<Continent>) & {
-        countries: (code: string) => Promise<ContinentCountries>;
+    bloc: ((code: string, opts?: BlocOptions) => Promise<Bloc>) & {
+        countries: (code: string, opts?: BlocCountriesOptions) => Promise<BlocCountries>;
     };
-    bloc: ((code: string) => Promise<Bloc>) & {
-        countries: (code: string) => Promise<BlocCountries>;
+    country: ((code: string, opts?: CountryOptions) => Promise<Country>) & {
+        states: (code: string, opts?: CountryStatesOptions) => Promise<CountryStates>;
     };
-    country: ((code: string) => Promise<Country>) & {
-        states: (code: string) => Promise<CountryStates>;
+    state: ((code: string, opts?: StateOptions) => Promise<State>) & {
+        districts: (code: string, opts?: StateDistrictsOptions) => Promise<StateDistricts>;
     };
-    state: ((code: string, opts?: {
-        country?: string;
-    }) => Promise<State>) & {
-        districts: (code: string, opts?: {
-            country?: string;
-        }) => Promise<StateDistricts>;
+    district: (code: string, opts?: DistrictOptions) => Promise<District>;
+    city: ((name: string, opts?: CityOptions) => Promise<City>) & {
+        id: (id: string, opts?: CityIdOptions) => Promise<City>;
+        search: (query: string, opts?: CitySearchOptions) => Promise<CitySearch>;
+        nearest: (lat: number, lon: number, opts?: CityNearestOptions) => Promise<CityNearest>;
+        nearby: (name: string, opts?: CityNearbyOptions) => Promise<CityNearby>;
     };
-    district: (code: string, opts?: {
-        country?: string;
-        state?: string;
-    }) => Promise<District>;
-    city: ((name: string, opts?: {
-        country?: string;
-        state?: string;
-    }) => Promise<City>) & {
-        id: (id: string) => Promise<City>;
-        search: (q: string, opts?: {
-            country?: string;
-            state?: string;
-            limit?: number;
-        }) => Promise<CitySearch>;
-        nearest: (lat: number, lon: number) => Promise<CityNearest>;
-        nearby: (name: string, opts?: {
-            radius?: number;
-            unit?: "km" | "mi";
-            country?: string;
-            state?: string;
-            limit?: number;
-        }) => Promise<CityNearby>;
+    postal: ((code: string, opts?: PostalOptions) => Promise<Postal>) & {
+        nearby: (code: string, opts?: PostalNearbyOptions) => Promise<PostalNearby>;
+        distance: (from: string, to: string, opts?: PostalDistanceOptions) => Promise<PostalDistance>;
     };
-    postal: ((code: string, opts?: {
-        country?: string;
-    }) => Promise<Postal>) & {
-        nearby: (code: string, opts?: {
-            country?: string;
-            radius?: number;
-            unit?: "km" | "mi";
-        }) => Promise<PostalNearby>;
-        distance: (from: string, to: string, opts?: {
-            country?: string;
-        }) => Promise<PostalDistance>;
+    address: ((address: string, opts?: AddressOptions) => Promise<Address>) & {
+        search: (query: string, opts?: AddressSearchOptions) => Promise<AddressSearch>;
     };
-    email: (email: string, opts?: DeepOption) => Promise<Email>;
-    vat: (number: string, opts?: {
-        country?: string;
-        from?: string;
-    } & DeepOption) => Promise<Vat>;
-    iban: (iban: string, opts?: {
-        country?: string;
-    }) => Promise<Iban>;
-    npi: (npi: string, opts?: DeepOption) => Promise<Npi>;
-    phone: (number: string, opts?: {
-        country?: string;
-    } & DeepOption) => Promise<Phone>;
-    carrier: (number: string, opts?: {
-        country?: string;
-    }) => Promise<Carrier>;
-    caller: (number: string, opts?: {
-        country?: string;
-    }) => Promise<Caller>;
-    hlr: (number: string, opts?: {
-        country?: string;
-    }) => Promise<Hlr>;
-    domain: (domain: string, opts?: DeepOption) => Promise<Domain>;
-    mx: (domain: string) => Promise<Mx>;
-    useragent: (ua: string, opts?: DeepOption) => Promise<Useragent>;
-    vin: (vin: string, opts?: DeepOption) => Promise<Vin>;
-    hts: ((code: string, opts?: {
-        origin?: string;
-    } & DeepOption) => Promise<Hts>) & {
-        search: (q: string) => Promise<HtsSearch>;
+    company: (number: string, opts?: CompanyOptions) => Promise<Company>;
+    email: (email: string, opts?: EmailOptions) => Promise<Email>;
+    vat: (number: string, opts?: VatOptions) => Promise<Vat>;
+    iban: (iban: string, opts?: IbanOptions) => Promise<Iban>;
+    npi: (npi: string, opts?: NpiOptions) => Promise<Npi>;
+    phone: (number: string, opts?: PhoneOptions) => Promise<Phone>;
+    carrier: (number: string, opts?: CarrierOptions) => Promise<Carrier>;
+    caller: (number: string, opts?: CallerOptions) => Promise<Caller>;
+    hlr: (number: string, opts?: HlrOptions) => Promise<Hlr>;
+    domain: (domain: string, opts?: DomainOptions) => Promise<Domain>;
+    asn: (asn: string, opts?: AsnOptions) => Promise<Asn>;
+    mac: (mac: string, opts?: MacOptions) => Promise<Mac>;
+    mx: (domain: string, opts?: MxOptions) => Promise<Mx>;
+    useragent: (ua: string, opts?: UseragentOptions) => Promise<Useragent>;
+    vin: (vin: string, opts?: VinOptions) => Promise<Vin>;
+    tariff: ((code: string, opts?: TariffOptions) => Promise<Tariff>) & {
+        search: (query: string, opts?: TariffSearchOptions) => Promise<TariffSearch>;
     };
-    currency: ((code: string) => Promise<Currency>) & {
-        rate: (base: string, quote: string, opts?: {
-            date?: string;
-            amount?: number;
-        }) => Promise<CurrencyRate>;
+    currency: ((code: string, opts?: CurrencyOptions) => Promise<Currency>) & {
+        rate: (base: string, quote: string, opts?: CurrencyRateOptions) => Promise<CurrencyRate>;
     };
-    language: (code: string) => Promise<Language>;
-    name: (name: string) => Promise<Name>;
-    timezone: {
-        (id: string, opts?: {
-            at?: string;
-            to?: string;
-        }): Promise<Timezone>;
-        (lat: number, lon: number, opts?: {
-            at?: string;
-        }): Promise<Timezone>;
+    language: (code: string, opts?: LanguageOptions) => Promise<Language>;
+    name: (name: string, opts?: NameOptions) => Promise<Name>;
+    timezone: ((id: string, opts?: TimezoneOptions) => Promise<Timezone>) & {
+        at: (lat: number, lon: number, opts?: TimezoneAtOptions) => Promise<Timezone>;
     };
-    date: ((date: string, opts?: {
-        format?: "mdy" | "dmy";
-        to?: string;
-    }) => Promise<DateInfo>) & {
-        today: (opts?: {
-            to?: string;
-        }) => Promise<DateInfo>;
+    date: ((date: string, opts?: DateOptions) => Promise<DateInfo>) & {
+        today: (opts?: DateTodayOptions) => Promise<DateInfo>;
     };
-    holiday: ((country: string, opts?: {
-        year?: number;
-    }) => Promise<HolidayYear>) & {
-        date: (country: string, date: string) => Promise<HolidayDate>;
+    holiday: ((country: string, opts?: HolidayOptions) => Promise<HolidayYear>) & {
+        date: (country: string, date: string, opts?: HolidayDateOptions) => Promise<HolidayDate>;
     };
-    elevation: (lat: number, lon: number) => Promise<Elevation>;
-    point: (lat: number, lon: number, opts?: DeepOption) => Promise<Point>;
-    weather: (lat: number, lon: number, opts?: DeepOption & {
-        date?: string;
-    }) => Promise<Weather>;
-    emoji: ((emoji: string) => Promise<Emoji>) & {
-        search: (q: string, opts?: {
-            limit?: number;
-        }) => Promise<EmojiSearch>;
+    elevation: (lat: number, lon: number, opts?: ElevationOptions) => Promise<Elevation>;
+    point: (lat: number, lon: number, opts?: PointOptions) => Promise<Point>;
+    weather: (lat: number, lon: number, opts?: WeatherOptions) => Promise<Weather>;
+    emoji: ((emoji: string, opts?: EmojiOptions) => Promise<Emoji>) & {
+        search: (query: string, opts?: EmojiSearchOptions) => Promise<EmojiSearch>;
     };
 };
 type ParseAPIClient = ReturnType<typeof parseAPI>;
 
-export { type Bloc, type BlocCountries, type BlocCountryItem, type Caller, type Carrier, type City, type CityNearby, type CityNearest, type CitySearch, type Continent, type ContinentCountries, type ContinentCountryItem, type Country, type CountryStateItem, type CountryStates, type Currency, type CurrencyRate, type DateInfo, type Deep, type District, type Domain, type DomainDeep, type DomainRegistration, type Elevation, type Email, type EmailDeep, type Emoji, type EmojiSearch, type EmojiSkin, type Hlr, type Holiday, type HolidayDate, type HolidayYear, type Hts, type HtsDeep, type HtsMeasure, type HtsSearch, type HtsSearchHit, type Iban, type Ip, type IpDeep, type Language, type Mx, type MxRecord, type Name, type Npi, type NpiDeep, type NpiEnrollment, type ParseAPIClient, ParseAPIError, type ParseAPIOptions, type Phone, type Point, type PointDeep, type Postal, type PostalDistance, type PostalDistanceEnd, type PostalNearby, type PostalNearbyItem, type State, type StateDistrictItem, type StateDistricts, type Timezone, type TimezoneConversionTarget, type TimezoneNextDst, type Useragent, type UseragentBrowserBrand, type UseragentBrowserDeep, type UseragentDeep, type UseragentDeviceDeep, type UseragentEngineDeep, type UseragentOsDeep, type Vat, type VatAddress, type VatDeep, type Vin, type VinDeep, type VinRecall, type Weather, type WeatherAir, type WeatherAlert, type WeatherCurrent, type WeatherDay, type WeatherDeep, type WeatherForecastPeriod, type WeatherHistory, type WeatherHour, type WeatherMinute, type WeatherSource, type WeatherStation, parseAPI };
+export { type Address, type AddressOptions, type AddressSearch, type AddressSearchOptions, type AddressSuggestion, type Asn, type AsnOptions, type Bloc, type BlocCountries, type BlocCountriesOptions, type BlocCountryItem, type BlocOptions, type Caller, type CallerOptions, type Carrier, type CarrierOptions, type City, type CityIdOptions, type CityNearby, type CityNearbyOptions, type CityNearest, type CityNearestOptions, type CityOptions, type CitySearch, type CitySearchOptions, type Company, type CompanyCountry, type CompanyDeep, type CompanyOptions, type Continent, type ContinentCountries, type ContinentCountriesOptions, type ContinentCountryItem, type ContinentOptions, type Country, type CountryOptions, type CountryStateItem, type CountryStates, type CountryStatesOptions, type Currency, type CurrencyOptions, type CurrencyRate, type CurrencyRateOptions, type DateInfo, type DateOptions, type DateTodayOptions, type Deep, type District, type DistrictOptions, type Domain, type DomainDeep, type DomainOptions, type DomainRegistration, type Elevation, type ElevationOptions, type Email, type EmailDeep, type EmailOptions, type Emoji, type EmojiOptions, type EmojiSearch, type EmojiSearchOptions, type EmojiSkin, type Hlr, type HlrOptions, type Holiday, type HolidayDate, type HolidayDateOptions, type HolidayOptions, type HolidayYear, type Iban, type IbanOptions, type Ip, type IpDeep, type IpOptions, type IpSelfOptions, type Language, type LanguageOptions, type Mac, type MacOptions, type Mx, type MxOptions, type MxRecord, type Name, type NameOptions, type Npi, type NpiDeep, type NpiEnrollment, type NpiOptions, type ParseAPIClient, ParseAPIError, type ParseAPIOptions, type Phone, type PhoneOptions, type Point, type PointDeep, type PointOptions, type Postal, type PostalDistance, type PostalDistanceEnd, type PostalDistanceOptions, type PostalNearby, type PostalNearbyItem, type PostalNearbyOptions, type PostalOptions, type RequestOptions, type State, type StateDistrictItem, type StateDistricts, type StateDistrictsOptions, type StateOptions, type Tariff, type TariffDeep, type TariffMeasure, type TariffOptions, type TariffSearch, type TariffSearchHit, type TariffSearchOptions, type Timezone, type TimezoneAtOptions, type TimezoneConversionTarget, type TimezoneNextDst, type TimezoneOptions, type Useragent, type UseragentBrowserBrand, type UseragentBrowserDeep, type UseragentDeep, type UseragentDeviceDeep, type UseragentEngineDeep, type UseragentOptions, type UseragentOsDeep, type Vat, type VatAddress, type VatDeep, type VatOptions, type Vin, type VinDeep, type VinOptions, type VinRecall, type Weather, type WeatherAir, type WeatherAlert, type WeatherCurrent, type WeatherDay, type WeatherDeep, type WeatherForecastPeriod, type WeatherHistory, type WeatherHour, type WeatherMinute, type WeatherOptions, type WeatherSource, type WeatherStation, parseAPI };