@parseapi/sdk 1.11.2 → 1.11.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +2 -25
- package/dist/index.cjs +1 -31
- package/dist/index.d.cts +1 -211
- package/dist/index.d.ts +1 -211
- package/dist/index.js +1 -31
- package/package.json +1 -2
package/README.md
CHANGED
|
@@ -74,7 +74,7 @@ const country = await parse.country('DE', { lang: 'fr' });
|
|
|
74
74
|
```
|
|
75
75
|
|
|
76
76
|
Only supported display fields change. Missing translations keep their source
|
|
77
|
-
names. IDs, native-name fields, numeric facts, Date input `format`, and
|
|
77
|
+
names. IDs, native-name fields, numeric facts, Date input `format`, and
|
|
78
78
|
input `locale` retain their meaning. Omitting `lang` preserves the existing
|
|
79
79
|
behavior and does not inherit a previous request's choice.
|
|
80
80
|
|
|
@@ -115,7 +115,6 @@ One method per endpoint, named after the route.
|
|
|
115
115
|
await parse.ip('8.8.8.8');
|
|
116
116
|
await parse.ip.self();
|
|
117
117
|
await parse.email('hello@gmail.com');
|
|
118
|
-
await parse.bank('DE89370400440532013000');
|
|
119
118
|
await parse.card('424242');
|
|
120
119
|
await parse.phone('+14155552671');
|
|
121
120
|
await parse.carrier('+14155552671');
|
|
@@ -168,7 +167,6 @@ await parse.point(36.0726, -79.792);
|
|
|
168
167
|
await parse.weather(40.7128, -74.006);
|
|
169
168
|
await parse.domain('example.com');
|
|
170
169
|
await parse.asn('AS13335');
|
|
171
|
-
await parse.mac('00:1B:63:84:45:E6');
|
|
172
170
|
await parse.mx('example.com');
|
|
173
171
|
await parse.dns('example.com');
|
|
174
172
|
await parse.dns('_dmarc.example.com', { type: 'TXT' });
|
|
@@ -241,19 +239,6 @@ Timezone discovery accepts country, IANA area, exact signed offset, abbreviation
|
|
|
241
239
|
|
|
242
240
|
Source deep adds `standard_offset`, `standard_offset_seconds`, signed `dst_offset_seconds` and `season`. Seasonal adjustments can be negative. `season` describes the current DST-flag interval, or the next within 400 days, with actual before/after transition facts and signed `change_seconds`. Unknown boundaries remain null. These fields are optional and nullable, and destination deep stays compact.
|
|
243
241
|
|
|
244
|
-
## Measurements
|
|
245
|
-
|
|
246
|
-
```ts
|
|
247
|
-
const result = await parse.measure('5 ft 11 in', { to: 'cm' });
|
|
248
|
-
const units = await parse.measure.units({ unit: 'm' });
|
|
249
|
-
```
|
|
250
|
-
|
|
251
|
-
`amount` is a decimal string, such as `"180.34"`. Without `to`, the API returns the canonical unit for the measurement type. Pass `locale` for number formatting and `system` (`us` or `imperial`) when a customary unit needs context. Ambiguous input returns `valid: false`, a `reason`, and available `choices`. Invalid or incompatible target units use the normal API error.
|
|
252
|
-
|
|
253
|
-
Successful HTTP JSON contains `measure`, `valid`, `type`, `amount`, and `unit`. Invalid input adds `reason`. `choices` appears only when unit alternatives are available. The typed client keeps `reason` readable as `null` and `choices` as `[]` when omitted, while JSON serialization retains the API response shape.
|
|
254
|
-
|
|
255
|
-
Unit discovery accepts optional `query`, `type`, and `unit` filters. `unit` selects compatible targets. Omit the filters for the reviewed catalog. Both operations use pooled requests.
|
|
256
|
-
|
|
257
242
|
## Place statistics and optional detail
|
|
258
243
|
|
|
259
244
|
Australian postal lookups include core `localities` with suburb choices (`city`, `state`, `state_name`) on every plan. Null or an omitted field means unknown, while `[]` means the reviewed reference has no eligible choices. `city` stays null when the source is ambiguous, even if there is only one eligible choice. Let the user select their suburb and keep manual entry available. These are geographic choices, not mailing-address verification. [G-NAF source, adaptations and licence](https://parseapi.com/legal/attribution#postal-au).
|
|
@@ -280,16 +265,8 @@ Address search uses context from the form: prefer postal, or city and state. An
|
|
|
280
265
|
|
|
281
266
|
HLR reports status at the last check. `live` means assigned and `connected` means reachable at that check. Cached results may be returned. Null means unconfirmed. Deep diagnostics stay within the same metered lookup.
|
|
282
267
|
|
|
283
|
-
Bank returns core `checks` for input, country, length, structure, checksum and national rules, plus an `issues` list. States are `passed`, `failed`, `not_checked` or `not_supported`. Unsupported national checking is not a failure. `valid` covers the implemented format and checksum rules, not account existence, ownership or payment reachability. Directory names and BICs may be null independently. Older responses may omit `checks` and `issues`, and future states and issue codes remain strings. Pass the original input unchanged so the API can report invalid characters. Deep `account` remains the BBAN remainder.
|
|
284
|
-
|
|
285
268
|
Bank inputs use `POST /bank` JSON bodies, keeping IBAN and account values out of request URLs. Pass original strings; the server owns normalization and validation. Avoid logging request bodies. IBAN deep adds the branch identifier and account remainder.
|
|
286
269
|
|
|
287
|
-
Use country requirements to build supported input fields. US ACH has an explicit helper with no deep option. It checks the routing format/ABA checksum and account-field syntax; `account_checksum` is `not_supported`. It preserves account characters and leading zeros. A nullable bank name is routing-directory identity, not account existence, ownership or ACH eligibility. The examples below are synthetic test inputs, not payment instructions.
|
|
288
|
-
|
|
289
|
-
```ts
|
|
290
|
-
await parse.bankRequirements('US', { format: 'us_ach' });
|
|
291
|
-
await parse.bankUsAch({ routing: '011000015', account: '0001234567' });
|
|
292
|
-
```
|
|
293
270
|
|
|
294
271
|
## Deep
|
|
295
272
|
|
|
@@ -300,7 +277,7 @@ Choose enrichment for the question you need answered.
|
|
|
300
277
|
| IP | Richer IP fields included with a paid plan. No separate check meter. |
|
|
301
278
|
| Domain | Registration dates, registrar, status and DNSSEC, included with a paid plan. Use `dns` for DNS records and `mx` for mail routing. |
|
|
302
279
|
| Email | A metered mailbox check with deliverability, catch-all, status, reason and address hints, using included email checks or enabled on-demand usage. |
|
|
303
|
-
| Phone, Time, Date,
|
|
280
|
+
| Phone, Time, Date, Language, Emoji, Point | Optional detail in the same pooled request on every plan. |
|
|
304
281
|
| Country, State, District, City, Postal | The place profile on paid plans, including demographic and tax facts where held. |
|
|
305
282
|
| Name, Industry | Name evidence or the industry definition profile on paid plans. |
|
|
306
283
|
| Company (national number) | The complete product detail bag on paid plans. |
|
package/dist/index.cjs
CHANGED
|
@@ -285,7 +285,7 @@ var EmojiCatalog = class {
|
|
|
285
285
|
};
|
|
286
286
|
|
|
287
287
|
// src/index.ts
|
|
288
|
-
var VERSION = "1.11.
|
|
288
|
+
var VERSION = "1.11.4";
|
|
289
289
|
var API_VERSION = "2.0.0";
|
|
290
290
|
var DEFAULT_BASE_URL = "https://api.parseapi.com";
|
|
291
291
|
var DEFAULT_TIMEOUT_MS = 1e4;
|
|
@@ -599,14 +599,7 @@ function parseAPI(apiKey, options = {}) {
|
|
|
599
599
|
* Deep checks default to one attempt. An explicit retry count can repeat paid usage.
|
|
600
600
|
*/
|
|
601
601
|
email: (email, opts) => request(`/email/${enc(email)}`, deepQuery(opts), void 0, opts),
|
|
602
|
-
// Keep existing callers on their established HTTP contracts.
|
|
603
|
-
iban: (iban, opts) => request(`/iban/${enc(iban)}`, { country: opts?.country, ...deepQuery(opts) }, void 0, opts),
|
|
604
602
|
bin: (bin, opts) => request(`/bin/${enc(bin)}`, { deep: opts?.deep }, void 0, opts),
|
|
605
|
-
bank: (iban, opts) => request("/bank", void 0, void 0, opts, { iban, country: opts?.country, deep: opts?.deep }),
|
|
606
|
-
/** Check US routing/account syntax using POST. Does not verify ownership, existence or ACH eligibility. */
|
|
607
|
-
bankUsAch: (input, opts) => request("/bank", void 0, void 0, opts, { format: "us_ach", country: "US", routing: input.routing, account: input.account }),
|
|
608
|
-
/** Describe supported input fields and check scope; this does not establish country directory coverage. */
|
|
609
|
-
bankRequirements: (country, opts) => request("/bank/requirements", { country, format: opts?.format }, void 0, opts),
|
|
610
603
|
/** Parse a phone number and its formats. Pass country for national numbers when needed. Deep adds numbering-plan geography. */
|
|
611
604
|
phone: (number, opts) => request(`/phone/${enc(number)}`, { country: opts?.country, ...deepQuery(opts) }, void 0, opts),
|
|
612
605
|
/** Request a metered carrier lookup. No automatic retries by default. */
|
|
@@ -620,7 +613,6 @@ function parseAPI(apiKey, options = {}) {
|
|
|
620
613
|
/** Check whether a domain is registered. Deep adds registration dates, registrar, status and DNSSEC on paid plans. */
|
|
621
614
|
domain: (domain, opts) => request(`/domain/${enc(domain)}`, deepQuery(opts), void 0, opts),
|
|
622
615
|
asn: (asn, opts) => request(`/asn/${enc(asn)}`, void 0, void 0, opts),
|
|
623
|
-
mac: (mac, opts) => request(`/mac/${enc(mac)}`, void 0, void 0, opts),
|
|
624
616
|
/** Look up a 2-11 digit card prefix. Keep leading zeros in the input string. */
|
|
625
617
|
card: async (bin, opts) => {
|
|
626
618
|
if (typeof bin !== "string" || bin.length > 64 || !/^[0-9]{2,11}$/.test(bin.replace(/[ \t\r\n-]/g, ""))) {
|
|
@@ -628,19 +620,6 @@ function parseAPI(apiKey, options = {}) {
|
|
|
628
620
|
}
|
|
629
621
|
return request(`/card/${enc(bin)}`, deepQuery(opts), void 0, opts);
|
|
630
622
|
},
|
|
631
|
-
/** Parse a measurement or convert it to `to`. Without `to`, use its type's canonical unit. Invalid input is plain data with `valid: false`. */
|
|
632
|
-
measure: Object.assign(
|
|
633
|
-
async (measure, opts) => {
|
|
634
|
-
const result = await request(`/measure/${enc(measure)}`, { to: opts?.to, locale: opts?.locale, system: opts?.system }, void 0, opts);
|
|
635
|
-
if (!Object.prototype.hasOwnProperty.call(result, "reason")) Object.defineProperty(result, "reason", { value: null, writable: true, configurable: true });
|
|
636
|
-
if (!Object.prototype.hasOwnProperty.call(result, "choices")) Object.defineProperty(result, "choices", { value: [], writable: true, configurable: true });
|
|
637
|
-
return result;
|
|
638
|
-
},
|
|
639
|
-
{
|
|
640
|
-
/** Discover reviewed units. Pass `unit` to find compatible conversion targets. */
|
|
641
|
-
units: (opts) => request("/measure/units", { q: opts?.query, type: opts?.type, unit: opts?.unit }, void 0, opts)
|
|
642
|
-
}
|
|
643
|
-
),
|
|
644
623
|
/** Look up DNS records with TTLs. Type selects the question and may include its CNAME chain. Pooled on every plan. */
|
|
645
624
|
dns: (domain, opts) => request(`/dns/${enc(domain)}`, { type: opts?.type }, void 0, opts),
|
|
646
625
|
mx: (domain, opts) => request(`/mx/${enc(domain)}`, void 0, void 0, opts),
|
|
@@ -649,15 +628,6 @@ function parseAPI(apiKey, options = {}) {
|
|
|
649
628
|
industry,
|
|
650
629
|
/** Compatibility name for industry. */
|
|
651
630
|
naics: industry,
|
|
652
|
-
currency: Object.assign(
|
|
653
|
-
(code, opts) => request(`/currency/${enc(code)}`, deepQuery(opts), void 0, opts),
|
|
654
|
-
{
|
|
655
|
-
rate: (base, quote, opts) => request(`/currency/${enc(base)}/${enc(quote)}`, {
|
|
656
|
-
date: opts?.date,
|
|
657
|
-
amount: opts?.amount
|
|
658
|
-
}, void 0, opts)
|
|
659
|
-
}
|
|
660
|
-
),
|
|
661
631
|
language: (code, opts) => request(`/language/${enc(code)}`, deepQuery(opts), void 0, opts),
|
|
662
632
|
name: (name, opts) => request(`/name/${enc(name)}`, { country: opts?.country, ...deepQuery(opts), name_locale: opts?.name_locale }, void 0, opts),
|
|
663
633
|
/** Current local time, UTC by default. With to or targets, offsetless at is source wall time. */
|
package/dist/index.d.cts
CHANGED
|
@@ -8,31 +8,6 @@
|
|
|
8
8
|
type Deep<T> = Partial<{
|
|
9
9
|
[K in keyof T]: T[K] | null;
|
|
10
10
|
}>;
|
|
11
|
-
interface MeasureChoice {
|
|
12
|
-
unit: string;
|
|
13
|
-
name: string;
|
|
14
|
-
}
|
|
15
|
-
/** A parsed measurement. Amount is a decimal string, preserving the API's precision. */
|
|
16
|
-
interface Measure {
|
|
17
|
-
measure: string;
|
|
18
|
-
valid: boolean;
|
|
19
|
-
type: string | null;
|
|
20
|
-
amount: string | null;
|
|
21
|
-
unit: string | null;
|
|
22
|
-
/** Failure reason. Omitted wire fields remain readable as null. */
|
|
23
|
-
reason: string | null;
|
|
24
|
-
/** Unit alternatives. Omitted wire fields remain readable as an empty array. */
|
|
25
|
-
choices: MeasureChoice[];
|
|
26
|
-
}
|
|
27
|
-
interface MeasureUnit {
|
|
28
|
-
unit: string;
|
|
29
|
-
name: string;
|
|
30
|
-
type: string;
|
|
31
|
-
aliases: string[];
|
|
32
|
-
}
|
|
33
|
-
interface MeasureUnits {
|
|
34
|
-
units: MeasureUnit[];
|
|
35
|
-
}
|
|
36
11
|
interface IpDeep {
|
|
37
12
|
state: string;
|
|
38
13
|
city: string;
|
|
@@ -284,88 +259,6 @@ interface Email {
|
|
|
284
259
|
disposable: boolean;
|
|
285
260
|
deep?: Deep<EmailDeep>;
|
|
286
261
|
}
|
|
287
|
-
/** Ordered IBAN checks. States are open strings for future API values. */
|
|
288
|
-
interface BankChecks {
|
|
289
|
-
input: string;
|
|
290
|
-
country: string;
|
|
291
|
-
length: string;
|
|
292
|
-
structure: string;
|
|
293
|
-
checksum: string;
|
|
294
|
-
national: string;
|
|
295
|
-
}
|
|
296
|
-
/** A validation issue. Fields and codes remain open strings. */
|
|
297
|
-
interface BankIssue {
|
|
298
|
-
field: string;
|
|
299
|
-
code: string;
|
|
300
|
-
message: string;
|
|
301
|
-
}
|
|
302
|
-
interface Bank {
|
|
303
|
-
iban: string | null;
|
|
304
|
-
valid: boolean;
|
|
305
|
-
country: string | null;
|
|
306
|
-
/** Print form in groups of four, for display. Null when invalid. */
|
|
307
|
-
formatted: string | null;
|
|
308
|
-
/** Bank identifier parsed from the number, not a name. */
|
|
309
|
-
bank: string | null;
|
|
310
|
-
/** Institution name from the national bank-code directory. Null when unsourced. */
|
|
311
|
-
bank_name: string | null;
|
|
312
|
-
/** BIC from that same directory. Null when unsourced or missing. */
|
|
313
|
-
bic: string | null;
|
|
314
|
-
/** Core check results. Older responses may omit them. */
|
|
315
|
-
checks?: BankChecks;
|
|
316
|
-
/** First blocking validation issue, or an empty list. Older responses may omit it. */
|
|
317
|
-
issues?: BankIssue[];
|
|
318
|
-
deep?: Deep<BankDeep>;
|
|
319
|
-
}
|
|
320
|
-
/** Directory evidence is optional and present only when a lookup ran. */
|
|
321
|
-
interface BankDirectory {
|
|
322
|
-
edition: string;
|
|
323
|
-
country: string;
|
|
324
|
-
/** bank, branch, prefix or none; remains open for future API values. */
|
|
325
|
-
match: string;
|
|
326
|
-
}
|
|
327
|
-
interface BankRequirementField {
|
|
328
|
-
key: string;
|
|
329
|
-
label: string;
|
|
330
|
-
required: boolean;
|
|
331
|
-
type: string;
|
|
332
|
-
length?: number;
|
|
333
|
-
min_length?: number;
|
|
334
|
-
max_length?: number;
|
|
335
|
-
max_input_length?: number;
|
|
336
|
-
length_unit?: string;
|
|
337
|
-
pattern?: string;
|
|
338
|
-
normalization?: string;
|
|
339
|
-
}
|
|
340
|
-
interface BankRequirements {
|
|
341
|
-
country: string;
|
|
342
|
-
format: string;
|
|
343
|
-
supported: boolean;
|
|
344
|
-
fields: BankRequirementField[];
|
|
345
|
-
checks: Record<string, string>;
|
|
346
|
-
limitations: string[];
|
|
347
|
-
}
|
|
348
|
-
/** US ACH syntax/checksum analysis; no account or payment verification. */
|
|
349
|
-
interface BankUsAchInput {
|
|
350
|
-
routing: string;
|
|
351
|
-
account: string;
|
|
352
|
-
}
|
|
353
|
-
interface BankUsAchChecks {
|
|
354
|
-
routing_format: string;
|
|
355
|
-
routing_checksum: string;
|
|
356
|
-
account_format: string;
|
|
357
|
-
account_checksum: string;
|
|
358
|
-
}
|
|
359
|
-
interface BankUsAch {
|
|
360
|
-
format: string;
|
|
361
|
-
country: string;
|
|
362
|
-
routing: string | null;
|
|
363
|
-
account: string | null;
|
|
364
|
-
valid: boolean;
|
|
365
|
-
bank_name: string | null;
|
|
366
|
-
checks: BankUsAchChecks;
|
|
367
|
-
issues: BankIssue[];
|
|
368
|
-
}
|
|
369
262
|
interface Phone {
|
|
370
263
|
phone: string | null;
|
|
371
264
|
valid: boolean;
|
|
@@ -460,14 +353,6 @@ interface Asn {
|
|
|
460
353
|
country: string | null;
|
|
461
354
|
country_name: string | null;
|
|
462
355
|
}
|
|
463
|
-
/** A normalized 48-bit address. Vendor names the registered assignment holder. */
|
|
464
|
-
interface Mac {
|
|
465
|
-
mac: string;
|
|
466
|
-
valid: boolean;
|
|
467
|
-
vendor: string | null;
|
|
468
|
-
local: boolean | null;
|
|
469
|
-
multicast: boolean | null;
|
|
470
|
-
}
|
|
471
356
|
/** Network identity from reviewed prefix rules; null means unknown or ambiguous. */
|
|
472
357
|
interface Card {
|
|
473
358
|
bin: string;
|
|
@@ -546,14 +431,6 @@ interface Useragent {
|
|
|
546
431
|
mobile: boolean;
|
|
547
432
|
deep?: Deep<UseragentDeep>;
|
|
548
433
|
}
|
|
549
|
-
interface Currency {
|
|
550
|
-
currency: string;
|
|
551
|
-
name: string;
|
|
552
|
-
symbol: string | null;
|
|
553
|
-
symbol_native: string | null;
|
|
554
|
-
digits: number | null;
|
|
555
|
-
deep?: Deep<CurrencyDeep>;
|
|
556
|
-
}
|
|
557
434
|
/** One language by BCP 47 shortest code (en) or ISO 639-3 (eng). Codes are lowercase. */
|
|
558
435
|
interface Language {
|
|
559
436
|
language: string;
|
|
@@ -574,17 +451,6 @@ interface Name {
|
|
|
574
451
|
suffix: string | null;
|
|
575
452
|
deep?: Deep<NameDeep>;
|
|
576
453
|
}
|
|
577
|
-
interface CurrencyRate {
|
|
578
|
-
base: string;
|
|
579
|
-
quote: string;
|
|
580
|
-
rate: number;
|
|
581
|
-
date: string;
|
|
582
|
-
/** With amount= only: echo of the amount asked. */
|
|
583
|
-
amount?: number;
|
|
584
|
-
/** With amount= only: amount times rate, rounded to the quote currency minor-unit digits. */
|
|
585
|
-
converted?: number;
|
|
586
|
-
source?: string;
|
|
587
|
-
}
|
|
588
454
|
interface TimezoneNextDst {
|
|
589
455
|
at: string;
|
|
590
456
|
dst: boolean;
|
|
@@ -1407,15 +1273,6 @@ interface PostalDeep {
|
|
|
1407
1273
|
/** Median annual property tax payable on owner-occupied homes in this statistical area. Null when unsupported, missing or censored. */
|
|
1408
1274
|
property_tax?: PropertyTax | null;
|
|
1409
1275
|
}
|
|
1410
|
-
interface BankDeep {
|
|
1411
|
-
/** Source edition and exact match grain, not coverage or account verification. */
|
|
1412
|
-
directory?: BankDirectory;
|
|
1413
|
-
/** Two check digits as a string, keeping a leading zero. */
|
|
1414
|
-
checksum?: string | null;
|
|
1415
|
-
/** Branch identifier when that country has one. */
|
|
1416
|
-
branch: string | null;
|
|
1417
|
-
account: string | null;
|
|
1418
|
-
}
|
|
1419
1276
|
interface PhoneDeep {
|
|
1420
1277
|
/** NPA-derived state code (US/CA). */
|
|
1421
1278
|
state: string | null;
|
|
@@ -1441,11 +1298,6 @@ interface HlrDeep {
|
|
|
1441
1298
|
mcc: string | null;
|
|
1442
1299
|
mnc: string | null;
|
|
1443
1300
|
}
|
|
1444
|
-
interface CurrencyDeep {
|
|
1445
|
-
numeric: number | null;
|
|
1446
|
-
name_plural: string | null;
|
|
1447
|
-
countries: string[];
|
|
1448
|
-
}
|
|
1449
1301
|
interface LanguageDeep {
|
|
1450
1302
|
iso3: string | null;
|
|
1451
1303
|
countries: string[];
|
|
@@ -1600,20 +1452,6 @@ type IndustryExclusion = NaicsExclusion;
|
|
|
1600
1452
|
type IndustryMatch = NaicsMatch;
|
|
1601
1453
|
type IndustrySearch = NaicsSearch;
|
|
1602
1454
|
type IndustrySearchItem = NaicsSearchItem;
|
|
1603
|
-
interface Iban {
|
|
1604
|
-
iban: string | null;
|
|
1605
|
-
valid: boolean;
|
|
1606
|
-
country: string | null;
|
|
1607
|
-
/** Print form in groups of four, for display. Null when invalid. */
|
|
1608
|
-
formatted: string | null;
|
|
1609
|
-
/** Bank identifier parsed from the number, not a name. */
|
|
1610
|
-
bank: string | null;
|
|
1611
|
-
/** Institution name from the national bank-code directory. Null when unsourced. */
|
|
1612
|
-
bank_name: string | null;
|
|
1613
|
-
/** BIC from that same directory. Null when unsourced or missing. */
|
|
1614
|
-
bic: string | null;
|
|
1615
|
-
deep?: Deep<IbanDeep>;
|
|
1616
|
-
}
|
|
1617
1455
|
interface Bin {
|
|
1618
1456
|
bin: string;
|
|
1619
1457
|
/** Actual longest matched prefix. May be shorter than the input. */
|
|
@@ -1628,13 +1466,6 @@ interface Bin {
|
|
|
1628
1466
|
prepaid: boolean | null;
|
|
1629
1467
|
deep?: Record<string, never>;
|
|
1630
1468
|
}
|
|
1631
|
-
interface IbanDeep {
|
|
1632
|
-
/** Two check digits as a string, keeping a leading zero. */
|
|
1633
|
-
checksum: string | null;
|
|
1634
|
-
/** Branch identifier when that country has one. */
|
|
1635
|
-
branch: string | null;
|
|
1636
|
-
account: string | null;
|
|
1637
|
-
}
|
|
1638
1469
|
interface EmojiParse {
|
|
1639
1470
|
emojis: (Emoji & {
|
|
1640
1471
|
positions: EmojiPosition[];
|
|
@@ -2083,12 +1914,6 @@ type CompanySearchOptions = {
|
|
|
2083
1914
|
type CompanyCoverageOptions = RequestOptions;
|
|
2084
1915
|
/** `deep: true` requests a metered deliverability check. No automatic retries by default. */
|
|
2085
1916
|
type EmailOptions = DeepOption & RequestOptions;
|
|
2086
|
-
type BankOptions = {
|
|
2087
|
-
country?: string;
|
|
2088
|
-
} & DeepOption & RequestOptions;
|
|
2089
|
-
type BankRequirementsOptions = {
|
|
2090
|
-
format?: string;
|
|
2091
|
-
} & RequestOptions;
|
|
2092
1917
|
/** Country resolves national-number ambiguity. Deep adds numbering-plan geography on every plan. */
|
|
2093
1918
|
type PhoneOptions = {
|
|
2094
1919
|
country?: string;
|
|
@@ -2110,20 +1935,8 @@ type StackOptions = {
|
|
|
2110
1935
|
} & DeepOption & RequestOptions;
|
|
2111
1936
|
type DomainOptions = DeepOption & RequestOptions;
|
|
2112
1937
|
type AsnOptions = LanguageOption & RequestOptions;
|
|
2113
|
-
type MacOptions = RequestOptions;
|
|
2114
1938
|
/** Request controls for a card-prefix reference lookup. */
|
|
2115
1939
|
type CardOptions = DeepOption & RequestOptions;
|
|
2116
|
-
/** Parse a measurement, optionally converting it. Locale and system resolve explicit ambiguity. */
|
|
2117
|
-
type MeasureOptions = {
|
|
2118
|
-
to?: string;
|
|
2119
|
-
locale?: string;
|
|
2120
|
-
system?: 'us' | 'imperial';
|
|
2121
|
-
} & RequestOptions;
|
|
2122
|
-
type MeasureUnitsOptions = LanguageOption & {
|
|
2123
|
-
query?: string;
|
|
2124
|
-
type?: string;
|
|
2125
|
-
unit?: string;
|
|
2126
|
-
} & RequestOptions;
|
|
2127
1940
|
/** Published DNS records. Omit type to check all ten supported types. Values retain DNS presentation syntax. */
|
|
2128
1941
|
type DnsOptions = {
|
|
2129
1942
|
type?: string;
|
|
@@ -2136,11 +1949,6 @@ type IndustryOptions = DeepOption & RequestOptions;
|
|
|
2136
1949
|
type IndustrySearchOptions = {
|
|
2137
1950
|
limit?: number;
|
|
2138
1951
|
} & DeepOption & RequestOptions;
|
|
2139
|
-
type CurrencyOptions = LanguageOption & DeepOption & RequestOptions;
|
|
2140
|
-
type CurrencyRateOptions = {
|
|
2141
|
-
date?: string;
|
|
2142
|
-
amount?: number;
|
|
2143
|
-
} & RequestOptions;
|
|
2144
1952
|
type LanguageOptions = LanguageOption & DeepOption & RequestOptions;
|
|
2145
1953
|
/** Country scopes paid deep gender evidence. Name locale selects formatting rules without changing parsing. */
|
|
2146
1954
|
type NameOptions = {
|
|
@@ -2308,13 +2116,7 @@ declare function parseAPI(apiKey?: string, options?: ParseAPIOptions): {
|
|
|
2308
2116
|
* Deep checks default to one attempt. An explicit retry count can repeat paid usage.
|
|
2309
2117
|
*/
|
|
2310
2118
|
email: (email: string, opts?: EmailOptions) => Promise<Email>;
|
|
2311
|
-
iban: (iban: string, opts?: IbanOptions) => Promise<Iban>;
|
|
2312
2119
|
bin: (bin: string, opts?: BinOptions) => Promise<Bin>;
|
|
2313
|
-
bank: (iban: string, opts?: BankOptions) => Promise<Bank>;
|
|
2314
|
-
/** Check US routing/account syntax using POST. Does not verify ownership, existence or ACH eligibility. */
|
|
2315
|
-
bankUsAch: (input: BankUsAchInput, opts?: RequestOptions) => Promise<BankUsAch>;
|
|
2316
|
-
/** Describe supported input fields and check scope; this does not establish country directory coverage. */
|
|
2317
|
-
bankRequirements: (country: string, opts?: BankRequirementsOptions) => Promise<BankRequirements>;
|
|
2318
2120
|
/** Parse a phone number and its formats. Pass country for national numbers when needed. Deep adds numbering-plan geography. */
|
|
2319
2121
|
phone: (number: string, opts?: PhoneOptions) => Promise<Phone>;
|
|
2320
2122
|
/** Request a metered carrier lookup. No automatic retries by default. */
|
|
@@ -2328,14 +2130,8 @@ declare function parseAPI(apiKey?: string, options?: ParseAPIOptions): {
|
|
|
2328
2130
|
/** Check whether a domain is registered. Deep adds registration dates, registrar, status and DNSSEC on paid plans. */
|
|
2329
2131
|
domain: (domain: string, opts?: DomainOptions) => Promise<Domain>;
|
|
2330
2132
|
asn: (asn: string, opts?: AsnOptions) => Promise<Asn>;
|
|
2331
|
-
mac: (mac: string, opts?: MacOptions) => Promise<Mac>;
|
|
2332
2133
|
/** Look up a 2-11 digit card prefix. Keep leading zeros in the input string. */
|
|
2333
2134
|
card: (bin: string, opts?: CardOptions) => Promise<Card>;
|
|
2334
|
-
/** Parse a measurement or convert it to `to`. Without `to`, use its type's canonical unit. Invalid input is plain data with `valid: false`. */
|
|
2335
|
-
measure: ((measure: string, opts?: MeasureOptions) => Promise<Measure>) & {
|
|
2336
|
-
/** Discover reviewed units. Pass `unit` to find compatible conversion targets. */
|
|
2337
|
-
units: (opts?: MeasureUnitsOptions) => Promise<MeasureUnits>;
|
|
2338
|
-
};
|
|
2339
2135
|
/** Look up DNS records with TTLs. Type selects the question and may include its CNAME chain. Pooled on every plan. */
|
|
2340
2136
|
dns: (domain: string, opts?: DnsOptions) => Promise<Dns>;
|
|
2341
2137
|
mx: (domain: string, opts?: MxOptions) => Promise<Mx>;
|
|
@@ -2348,9 +2144,6 @@ declare function parseAPI(apiKey?: string, options?: ParseAPIOptions): {
|
|
|
2348
2144
|
naics: ((code: string, opts?: IndustryOptions) => Promise<Industry>) & {
|
|
2349
2145
|
search: (query: string, opts?: IndustrySearchOptions) => Promise<IndustrySearch>;
|
|
2350
2146
|
};
|
|
2351
|
-
currency: ((code: string, opts?: CurrencyOptions) => Promise<Currency>) & {
|
|
2352
|
-
rate: (base: string, quote: string, opts?: CurrencyRateOptions) => Promise<CurrencyRate>;
|
|
2353
|
-
};
|
|
2354
2147
|
language: (code: string, opts?: LanguageOptions) => Promise<Language>;
|
|
2355
2148
|
name: (name: string, opts?: NameOptions) => Promise<Name>;
|
|
2356
2149
|
/** Current local time, UTC by default. With to or targets, offsetless at is source wall time. */
|
|
@@ -2393,9 +2186,6 @@ type ParseAPIClient = ReturnType<typeof parseAPI>;
|
|
|
2393
2186
|
/** Existing NAICS options remain source compatible. */
|
|
2394
2187
|
type NaicsOptions = IndustryOptions;
|
|
2395
2188
|
type NaicsSearchOptions = IndustrySearchOptions;
|
|
2396
|
-
type IbanOptions = {
|
|
2397
|
-
country?: string;
|
|
2398
|
-
} & DeepOption & RequestOptions;
|
|
2399
2189
|
type BinOptions = DeepOption & RequestOptions;
|
|
2400
2190
|
type CityScopeOptions = {
|
|
2401
2191
|
country?: string;
|
|
@@ -2485,4 +2275,4 @@ interface CityNearbyCall {
|
|
|
2485
2275
|
(name: string, opts: CityNearbyOptions): Promise<CityNearby | CityCollection>;
|
|
2486
2276
|
}
|
|
2487
2277
|
|
|
2488
|
-
export { type Address, type AddressOptions, type AddressSearch, type AddressSearchOptions, type AddressSuggestion, type AgentTask, type AgentTaskInput, type AgentTaskLookupInput, type AgentTaskResult, type Asn, type AsnOptions, type
|
|
2278
|
+
export { type Address, type AddressOptions, type AddressSearch, type AddressSearchOptions, type AddressSuggestion, type AgentTask, type AgentTaskInput, type AgentTaskLookupInput, type AgentTaskResult, type Asn, type AsnOptions, type Bin, type BinOptions, type Caller, type CallerOptions, type Card, type CardDeep, type CardOptions, type Carrier, type CarrierDeep, type CarrierOptions, type City, type CityAmbiguityCandidate, type CityAncestorsOptions, type CityCollection, type CityCollectionFilters, type CityDeep, type CityDistance, type CityDistanceOptions, type CityGrain, type CityIdCall, type CityIdOptions, type CityList, type CityListOptions, type CityLookupCall, type CityMatch, type CityNearby, type CityNearbyCall, type CityNearbyCoordinates, type CityNearbyCoordinatesOptions, type CityNearbyOptions, type CityNearest, type CityNearestCall, type CityNearestOptions, type CityOptions, type CityPagingOptions, type CityParent, type CityRelations, type CityRelationsOptions, type CityResource, type CityResponseOptions, type CityScopeOptions, type CitySearch, type CitySearchCall, type CitySearchOptions, type CitySort, type Company, type CompanyCandidate, type CompanyCountry, type CompanyCoverage, type CompanyCoverageOptions, type CompanyDeep, type CompanyEmailAddress, type CompanyIdOptions, type CompanyMatch, type CompanyOptions, type CompanyPhoneNumber, type CompanyProfile, type CompanyProfileAddress, type CompanyProfileDeep, type CompanyProfileDomain, type CompanyProfileEmail, type CompanyProfileEmployees, type CompanyProfileFounding, type CompanyProfileIdentifier, type CompanyProfileIndustry, type CompanyProfileJurisdiction, type CompanyProfileListing, type CompanyProfilePhone, type CompanyProfileRegistration, type CompanyProfileRegistrationAddress, type CompanyProfileRegistrationLegalForm, type CompanyProfileSource, type CompanyProfileWebsite, type CompanySearch, type CompanySearchOptions, type CompanySocialProfile, type Continent, type ContinentCountries, type ContinentCountriesOptions, type ContinentCountryItem, type ContinentOptions, type Country, type CountryDeep, type CountryElevationPoint, type CountryEmergency, type CountryOptions, type CountryStateItem, type CountryStates, type CountryStatesOptions, type DateInfo, type DateInfoDeep, type DateOptions, type DateTodayOptions, type Deep, type District, type DistrictDeep, type DistrictOptions, type Dns, type DnsOptions, type DnsRecord, type Domain, type DomainDeep, type DomainOptions, type DomainRegistration, type Elevation, type ElevationLocations, type ElevationOptions, type Email, type EmailDeep, type EmailOptions, type Emoji, type EmojiArtwork, type EmojiArtworkSource, type EmojiBrowse, type EmojiBrowseOptions, EmojiCatalog, type EmojiCatalogConvertOptions, type EmojiCatalogData, EmojiCatalogError, type EmojiCatalogLocalization, type EmojiCatalogLookupOptions, type EmojiCatalogOptions, type EmojiCatalogParseOptions, type EmojiCatalogRegexOptions, type EmojiCatalogScope, type EmojiCatalogSearchFacts, type EmojiCatalogSearchOptions, type EmojiCategories, type EmojiCategory, type EmojiConversion, type EmojiConvertOptions, type EmojiDeep, type EmojiMetadata, type EmojiNativeSearchFacts, type EmojiNotice, type EmojiOptions, type EmojiParse, type EmojiParseOptions, type EmojiPosition, type EmojiSearch, type EmojiSearchOptions, type EmojiShortcodeSourceMetadata, type EmojiSkin, type EmojiSource, type EmojiUnresolved, type EmojiVariant, type Hlr, type HlrDeep, type HlrOptions, type Holiday, type HolidayDate, type HolidayDateOptions, type HolidayOptions, type HolidayYear, type Industry, type IndustryChild, type IndustryCorrection, type IndustryDeep, type IndustryExclusion, type IndustryMatch, type IndustryOptions, type IndustrySearch, type IndustrySearchItem, type IndustrySearchOptions, type Ip, type IpDeep, type IpOptions, type IpSelfOptions, type Language, type LanguageDeep, type LanguageOption, type LanguageOptions, type Mx, type MxOptions, type MxRecord, type Naics, type NaicsChild, type NaicsCorrection, type NaicsDeep, type NaicsExclusion, type NaicsMatch, type NaicsOptions, type NaicsSearch, type NaicsSearchItem, type NaicsSearchOptions, type Name, type NameDeep, type NameOptions, type ParseAPIClient, ParseAPIError, type ParseAPIOptions, type Phone, type PhoneDeep, type PhoneOptions, type Point, type PointCity, type PointDeep, type PointOptions, type Postal, type PostalDeep, type PostalDistance, type PostalDistanceEnd, type PostalDistanceOptions, type PostalLocality, type PostalMetro, type PostalMetrosDeep, type PostalNearby, type PostalNearbyItem, type PostalNearbyOptions, type PostalOptions, type Preflight, type PreflightCost, type PreflightEmailCapacity, type PreflightOperation, type PreflightOperationEstimate, type PreflightPooledCapacity, type PreflightSpendCapacity, type PreflightTask, type PropertyTax, type RequestOptions, type Stack, type StackOptions, type StackTechnology, type State, type StateDeep, type StateDistrictDeep, type StateDistrictItem, type StateDistricts, type StateDistrictsOptions, type StateOptions, type Time, type TimeAtOptions, type TimeLocation, type TimeLocationCandidate, type TimeLocationInput, type TimeOptions, type TimeResolution, type TimeResolutionAlternative, type TimeSeason, type TimeTransition, type TimeTransitionState, type TimeZoneEntry, type TimeZones, type TimeZonesOptions, type Timezone, type TimezoneAtOptions, type TimezoneConversionTarget, type TimezoneConversionTargetDeep, type TimezoneDeep, type TimezoneNextDst, type TimezoneOptions, type Useragent, type UseragentBrowserBrand, type UseragentBrowserDeep, type UseragentDeep, type UseragentDeviceDeep, type UseragentEngineDeep, type UseragentOptions, type UseragentOsDeep, type Weather, type WeatherAir, type WeatherAlert, type WeatherCurrent, type WeatherCurrentDeep, type WeatherDay, type WeatherDeep, type WeatherForecastPeriod, type WeatherHistory, type WeatherHour, type WeatherMinute, type WeatherOptions, type WeatherStation, parseAPI };
|
package/dist/index.d.ts
CHANGED
|
@@ -8,31 +8,6 @@
|
|
|
8
8
|
type Deep<T> = Partial<{
|
|
9
9
|
[K in keyof T]: T[K] | null;
|
|
10
10
|
}>;
|
|
11
|
-
interface MeasureChoice {
|
|
12
|
-
unit: string;
|
|
13
|
-
name: string;
|
|
14
|
-
}
|
|
15
|
-
/** A parsed measurement. Amount is a decimal string, preserving the API's precision. */
|
|
16
|
-
interface Measure {
|
|
17
|
-
measure: string;
|
|
18
|
-
valid: boolean;
|
|
19
|
-
type: string | null;
|
|
20
|
-
amount: string | null;
|
|
21
|
-
unit: string | null;
|
|
22
|
-
/** Failure reason. Omitted wire fields remain readable as null. */
|
|
23
|
-
reason: string | null;
|
|
24
|
-
/** Unit alternatives. Omitted wire fields remain readable as an empty array. */
|
|
25
|
-
choices: MeasureChoice[];
|
|
26
|
-
}
|
|
27
|
-
interface MeasureUnit {
|
|
28
|
-
unit: string;
|
|
29
|
-
name: string;
|
|
30
|
-
type: string;
|
|
31
|
-
aliases: string[];
|
|
32
|
-
}
|
|
33
|
-
interface MeasureUnits {
|
|
34
|
-
units: MeasureUnit[];
|
|
35
|
-
}
|
|
36
11
|
interface IpDeep {
|
|
37
12
|
state: string;
|
|
38
13
|
city: string;
|
|
@@ -284,88 +259,6 @@ interface Email {
|
|
|
284
259
|
disposable: boolean;
|
|
285
260
|
deep?: Deep<EmailDeep>;
|
|
286
261
|
}
|
|
287
|
-
/** Ordered IBAN checks. States are open strings for future API values. */
|
|
288
|
-
interface BankChecks {
|
|
289
|
-
input: string;
|
|
290
|
-
country: string;
|
|
291
|
-
length: string;
|
|
292
|
-
structure: string;
|
|
293
|
-
checksum: string;
|
|
294
|
-
national: string;
|
|
295
|
-
}
|
|
296
|
-
/** A validation issue. Fields and codes remain open strings. */
|
|
297
|
-
interface BankIssue {
|
|
298
|
-
field: string;
|
|
299
|
-
code: string;
|
|
300
|
-
message: string;
|
|
301
|
-
}
|
|
302
|
-
interface Bank {
|
|
303
|
-
iban: string | null;
|
|
304
|
-
valid: boolean;
|
|
305
|
-
country: string | null;
|
|
306
|
-
/** Print form in groups of four, for display. Null when invalid. */
|
|
307
|
-
formatted: string | null;
|
|
308
|
-
/** Bank identifier parsed from the number, not a name. */
|
|
309
|
-
bank: string | null;
|
|
310
|
-
/** Institution name from the national bank-code directory. Null when unsourced. */
|
|
311
|
-
bank_name: string | null;
|
|
312
|
-
/** BIC from that same directory. Null when unsourced or missing. */
|
|
313
|
-
bic: string | null;
|
|
314
|
-
/** Core check results. Older responses may omit them. */
|
|
315
|
-
checks?: BankChecks;
|
|
316
|
-
/** First blocking validation issue, or an empty list. Older responses may omit it. */
|
|
317
|
-
issues?: BankIssue[];
|
|
318
|
-
deep?: Deep<BankDeep>;
|
|
319
|
-
}
|
|
320
|
-
/** Directory evidence is optional and present only when a lookup ran. */
|
|
321
|
-
interface BankDirectory {
|
|
322
|
-
edition: string;
|
|
323
|
-
country: string;
|
|
324
|
-
/** bank, branch, prefix or none; remains open for future API values. */
|
|
325
|
-
match: string;
|
|
326
|
-
}
|
|
327
|
-
interface BankRequirementField {
|
|
328
|
-
key: string;
|
|
329
|
-
label: string;
|
|
330
|
-
required: boolean;
|
|
331
|
-
type: string;
|
|
332
|
-
length?: number;
|
|
333
|
-
min_length?: number;
|
|
334
|
-
max_length?: number;
|
|
335
|
-
max_input_length?: number;
|
|
336
|
-
length_unit?: string;
|
|
337
|
-
pattern?: string;
|
|
338
|
-
normalization?: string;
|
|
339
|
-
}
|
|
340
|
-
interface BankRequirements {
|
|
341
|
-
country: string;
|
|
342
|
-
format: string;
|
|
343
|
-
supported: boolean;
|
|
344
|
-
fields: BankRequirementField[];
|
|
345
|
-
checks: Record<string, string>;
|
|
346
|
-
limitations: string[];
|
|
347
|
-
}
|
|
348
|
-
/** US ACH syntax/checksum analysis; no account or payment verification. */
|
|
349
|
-
interface BankUsAchInput {
|
|
350
|
-
routing: string;
|
|
351
|
-
account: string;
|
|
352
|
-
}
|
|
353
|
-
interface BankUsAchChecks {
|
|
354
|
-
routing_format: string;
|
|
355
|
-
routing_checksum: string;
|
|
356
|
-
account_format: string;
|
|
357
|
-
account_checksum: string;
|
|
358
|
-
}
|
|
359
|
-
interface BankUsAch {
|
|
360
|
-
format: string;
|
|
361
|
-
country: string;
|
|
362
|
-
routing: string | null;
|
|
363
|
-
account: string | null;
|
|
364
|
-
valid: boolean;
|
|
365
|
-
bank_name: string | null;
|
|
366
|
-
checks: BankUsAchChecks;
|
|
367
|
-
issues: BankIssue[];
|
|
368
|
-
}
|
|
369
262
|
interface Phone {
|
|
370
263
|
phone: string | null;
|
|
371
264
|
valid: boolean;
|
|
@@ -460,14 +353,6 @@ interface Asn {
|
|
|
460
353
|
country: string | null;
|
|
461
354
|
country_name: string | null;
|
|
462
355
|
}
|
|
463
|
-
/** A normalized 48-bit address. Vendor names the registered assignment holder. */
|
|
464
|
-
interface Mac {
|
|
465
|
-
mac: string;
|
|
466
|
-
valid: boolean;
|
|
467
|
-
vendor: string | null;
|
|
468
|
-
local: boolean | null;
|
|
469
|
-
multicast: boolean | null;
|
|
470
|
-
}
|
|
471
356
|
/** Network identity from reviewed prefix rules; null means unknown or ambiguous. */
|
|
472
357
|
interface Card {
|
|
473
358
|
bin: string;
|
|
@@ -546,14 +431,6 @@ interface Useragent {
|
|
|
546
431
|
mobile: boolean;
|
|
547
432
|
deep?: Deep<UseragentDeep>;
|
|
548
433
|
}
|
|
549
|
-
interface Currency {
|
|
550
|
-
currency: string;
|
|
551
|
-
name: string;
|
|
552
|
-
symbol: string | null;
|
|
553
|
-
symbol_native: string | null;
|
|
554
|
-
digits: number | null;
|
|
555
|
-
deep?: Deep<CurrencyDeep>;
|
|
556
|
-
}
|
|
557
434
|
/** One language by BCP 47 shortest code (en) or ISO 639-3 (eng). Codes are lowercase. */
|
|
558
435
|
interface Language {
|
|
559
436
|
language: string;
|
|
@@ -574,17 +451,6 @@ interface Name {
|
|
|
574
451
|
suffix: string | null;
|
|
575
452
|
deep?: Deep<NameDeep>;
|
|
576
453
|
}
|
|
577
|
-
interface CurrencyRate {
|
|
578
|
-
base: string;
|
|
579
|
-
quote: string;
|
|
580
|
-
rate: number;
|
|
581
|
-
date: string;
|
|
582
|
-
/** With amount= only: echo of the amount asked. */
|
|
583
|
-
amount?: number;
|
|
584
|
-
/** With amount= only: amount times rate, rounded to the quote currency minor-unit digits. */
|
|
585
|
-
converted?: number;
|
|
586
|
-
source?: string;
|
|
587
|
-
}
|
|
588
454
|
interface TimezoneNextDst {
|
|
589
455
|
at: string;
|
|
590
456
|
dst: boolean;
|
|
@@ -1407,15 +1273,6 @@ interface PostalDeep {
|
|
|
1407
1273
|
/** Median annual property tax payable on owner-occupied homes in this statistical area. Null when unsupported, missing or censored. */
|
|
1408
1274
|
property_tax?: PropertyTax | null;
|
|
1409
1275
|
}
|
|
1410
|
-
interface BankDeep {
|
|
1411
|
-
/** Source edition and exact match grain, not coverage or account verification. */
|
|
1412
|
-
directory?: BankDirectory;
|
|
1413
|
-
/** Two check digits as a string, keeping a leading zero. */
|
|
1414
|
-
checksum?: string | null;
|
|
1415
|
-
/** Branch identifier when that country has one. */
|
|
1416
|
-
branch: string | null;
|
|
1417
|
-
account: string | null;
|
|
1418
|
-
}
|
|
1419
1276
|
interface PhoneDeep {
|
|
1420
1277
|
/** NPA-derived state code (US/CA). */
|
|
1421
1278
|
state: string | null;
|
|
@@ -1441,11 +1298,6 @@ interface HlrDeep {
|
|
|
1441
1298
|
mcc: string | null;
|
|
1442
1299
|
mnc: string | null;
|
|
1443
1300
|
}
|
|
1444
|
-
interface CurrencyDeep {
|
|
1445
|
-
numeric: number | null;
|
|
1446
|
-
name_plural: string | null;
|
|
1447
|
-
countries: string[];
|
|
1448
|
-
}
|
|
1449
1301
|
interface LanguageDeep {
|
|
1450
1302
|
iso3: string | null;
|
|
1451
1303
|
countries: string[];
|
|
@@ -1600,20 +1452,6 @@ type IndustryExclusion = NaicsExclusion;
|
|
|
1600
1452
|
type IndustryMatch = NaicsMatch;
|
|
1601
1453
|
type IndustrySearch = NaicsSearch;
|
|
1602
1454
|
type IndustrySearchItem = NaicsSearchItem;
|
|
1603
|
-
interface Iban {
|
|
1604
|
-
iban: string | null;
|
|
1605
|
-
valid: boolean;
|
|
1606
|
-
country: string | null;
|
|
1607
|
-
/** Print form in groups of four, for display. Null when invalid. */
|
|
1608
|
-
formatted: string | null;
|
|
1609
|
-
/** Bank identifier parsed from the number, not a name. */
|
|
1610
|
-
bank: string | null;
|
|
1611
|
-
/** Institution name from the national bank-code directory. Null when unsourced. */
|
|
1612
|
-
bank_name: string | null;
|
|
1613
|
-
/** BIC from that same directory. Null when unsourced or missing. */
|
|
1614
|
-
bic: string | null;
|
|
1615
|
-
deep?: Deep<IbanDeep>;
|
|
1616
|
-
}
|
|
1617
1455
|
interface Bin {
|
|
1618
1456
|
bin: string;
|
|
1619
1457
|
/** Actual longest matched prefix. May be shorter than the input. */
|
|
@@ -1628,13 +1466,6 @@ interface Bin {
|
|
|
1628
1466
|
prepaid: boolean | null;
|
|
1629
1467
|
deep?: Record<string, never>;
|
|
1630
1468
|
}
|
|
1631
|
-
interface IbanDeep {
|
|
1632
|
-
/** Two check digits as a string, keeping a leading zero. */
|
|
1633
|
-
checksum: string | null;
|
|
1634
|
-
/** Branch identifier when that country has one. */
|
|
1635
|
-
branch: string | null;
|
|
1636
|
-
account: string | null;
|
|
1637
|
-
}
|
|
1638
1469
|
interface EmojiParse {
|
|
1639
1470
|
emojis: (Emoji & {
|
|
1640
1471
|
positions: EmojiPosition[];
|
|
@@ -2083,12 +1914,6 @@ type CompanySearchOptions = {
|
|
|
2083
1914
|
type CompanyCoverageOptions = RequestOptions;
|
|
2084
1915
|
/** `deep: true` requests a metered deliverability check. No automatic retries by default. */
|
|
2085
1916
|
type EmailOptions = DeepOption & RequestOptions;
|
|
2086
|
-
type BankOptions = {
|
|
2087
|
-
country?: string;
|
|
2088
|
-
} & DeepOption & RequestOptions;
|
|
2089
|
-
type BankRequirementsOptions = {
|
|
2090
|
-
format?: string;
|
|
2091
|
-
} & RequestOptions;
|
|
2092
1917
|
/** Country resolves national-number ambiguity. Deep adds numbering-plan geography on every plan. */
|
|
2093
1918
|
type PhoneOptions = {
|
|
2094
1919
|
country?: string;
|
|
@@ -2110,20 +1935,8 @@ type StackOptions = {
|
|
|
2110
1935
|
} & DeepOption & RequestOptions;
|
|
2111
1936
|
type DomainOptions = DeepOption & RequestOptions;
|
|
2112
1937
|
type AsnOptions = LanguageOption & RequestOptions;
|
|
2113
|
-
type MacOptions = RequestOptions;
|
|
2114
1938
|
/** Request controls for a card-prefix reference lookup. */
|
|
2115
1939
|
type CardOptions = DeepOption & RequestOptions;
|
|
2116
|
-
/** Parse a measurement, optionally converting it. Locale and system resolve explicit ambiguity. */
|
|
2117
|
-
type MeasureOptions = {
|
|
2118
|
-
to?: string;
|
|
2119
|
-
locale?: string;
|
|
2120
|
-
system?: 'us' | 'imperial';
|
|
2121
|
-
} & RequestOptions;
|
|
2122
|
-
type MeasureUnitsOptions = LanguageOption & {
|
|
2123
|
-
query?: string;
|
|
2124
|
-
type?: string;
|
|
2125
|
-
unit?: string;
|
|
2126
|
-
} & RequestOptions;
|
|
2127
1940
|
/** Published DNS records. Omit type to check all ten supported types. Values retain DNS presentation syntax. */
|
|
2128
1941
|
type DnsOptions = {
|
|
2129
1942
|
type?: string;
|
|
@@ -2136,11 +1949,6 @@ type IndustryOptions = DeepOption & RequestOptions;
|
|
|
2136
1949
|
type IndustrySearchOptions = {
|
|
2137
1950
|
limit?: number;
|
|
2138
1951
|
} & DeepOption & RequestOptions;
|
|
2139
|
-
type CurrencyOptions = LanguageOption & DeepOption & RequestOptions;
|
|
2140
|
-
type CurrencyRateOptions = {
|
|
2141
|
-
date?: string;
|
|
2142
|
-
amount?: number;
|
|
2143
|
-
} & RequestOptions;
|
|
2144
1952
|
type LanguageOptions = LanguageOption & DeepOption & RequestOptions;
|
|
2145
1953
|
/** Country scopes paid deep gender evidence. Name locale selects formatting rules without changing parsing. */
|
|
2146
1954
|
type NameOptions = {
|
|
@@ -2308,13 +2116,7 @@ declare function parseAPI(apiKey?: string, options?: ParseAPIOptions): {
|
|
|
2308
2116
|
* Deep checks default to one attempt. An explicit retry count can repeat paid usage.
|
|
2309
2117
|
*/
|
|
2310
2118
|
email: (email: string, opts?: EmailOptions) => Promise<Email>;
|
|
2311
|
-
iban: (iban: string, opts?: IbanOptions) => Promise<Iban>;
|
|
2312
2119
|
bin: (bin: string, opts?: BinOptions) => Promise<Bin>;
|
|
2313
|
-
bank: (iban: string, opts?: BankOptions) => Promise<Bank>;
|
|
2314
|
-
/** Check US routing/account syntax using POST. Does not verify ownership, existence or ACH eligibility. */
|
|
2315
|
-
bankUsAch: (input: BankUsAchInput, opts?: RequestOptions) => Promise<BankUsAch>;
|
|
2316
|
-
/** Describe supported input fields and check scope; this does not establish country directory coverage. */
|
|
2317
|
-
bankRequirements: (country: string, opts?: BankRequirementsOptions) => Promise<BankRequirements>;
|
|
2318
2120
|
/** Parse a phone number and its formats. Pass country for national numbers when needed. Deep adds numbering-plan geography. */
|
|
2319
2121
|
phone: (number: string, opts?: PhoneOptions) => Promise<Phone>;
|
|
2320
2122
|
/** Request a metered carrier lookup. No automatic retries by default. */
|
|
@@ -2328,14 +2130,8 @@ declare function parseAPI(apiKey?: string, options?: ParseAPIOptions): {
|
|
|
2328
2130
|
/** Check whether a domain is registered. Deep adds registration dates, registrar, status and DNSSEC on paid plans. */
|
|
2329
2131
|
domain: (domain: string, opts?: DomainOptions) => Promise<Domain>;
|
|
2330
2132
|
asn: (asn: string, opts?: AsnOptions) => Promise<Asn>;
|
|
2331
|
-
mac: (mac: string, opts?: MacOptions) => Promise<Mac>;
|
|
2332
2133
|
/** Look up a 2-11 digit card prefix. Keep leading zeros in the input string. */
|
|
2333
2134
|
card: (bin: string, opts?: CardOptions) => Promise<Card>;
|
|
2334
|
-
/** Parse a measurement or convert it to `to`. Without `to`, use its type's canonical unit. Invalid input is plain data with `valid: false`. */
|
|
2335
|
-
measure: ((measure: string, opts?: MeasureOptions) => Promise<Measure>) & {
|
|
2336
|
-
/** Discover reviewed units. Pass `unit` to find compatible conversion targets. */
|
|
2337
|
-
units: (opts?: MeasureUnitsOptions) => Promise<MeasureUnits>;
|
|
2338
|
-
};
|
|
2339
2135
|
/** Look up DNS records with TTLs. Type selects the question and may include its CNAME chain. Pooled on every plan. */
|
|
2340
2136
|
dns: (domain: string, opts?: DnsOptions) => Promise<Dns>;
|
|
2341
2137
|
mx: (domain: string, opts?: MxOptions) => Promise<Mx>;
|
|
@@ -2348,9 +2144,6 @@ declare function parseAPI(apiKey?: string, options?: ParseAPIOptions): {
|
|
|
2348
2144
|
naics: ((code: string, opts?: IndustryOptions) => Promise<Industry>) & {
|
|
2349
2145
|
search: (query: string, opts?: IndustrySearchOptions) => Promise<IndustrySearch>;
|
|
2350
2146
|
};
|
|
2351
|
-
currency: ((code: string, opts?: CurrencyOptions) => Promise<Currency>) & {
|
|
2352
|
-
rate: (base: string, quote: string, opts?: CurrencyRateOptions) => Promise<CurrencyRate>;
|
|
2353
|
-
};
|
|
2354
2147
|
language: (code: string, opts?: LanguageOptions) => Promise<Language>;
|
|
2355
2148
|
name: (name: string, opts?: NameOptions) => Promise<Name>;
|
|
2356
2149
|
/** Current local time, UTC by default. With to or targets, offsetless at is source wall time. */
|
|
@@ -2393,9 +2186,6 @@ type ParseAPIClient = ReturnType<typeof parseAPI>;
|
|
|
2393
2186
|
/** Existing NAICS options remain source compatible. */
|
|
2394
2187
|
type NaicsOptions = IndustryOptions;
|
|
2395
2188
|
type NaicsSearchOptions = IndustrySearchOptions;
|
|
2396
|
-
type IbanOptions = {
|
|
2397
|
-
country?: string;
|
|
2398
|
-
} & DeepOption & RequestOptions;
|
|
2399
2189
|
type BinOptions = DeepOption & RequestOptions;
|
|
2400
2190
|
type CityScopeOptions = {
|
|
2401
2191
|
country?: string;
|
|
@@ -2485,4 +2275,4 @@ interface CityNearbyCall {
|
|
|
2485
2275
|
(name: string, opts: CityNearbyOptions): Promise<CityNearby | CityCollection>;
|
|
2486
2276
|
}
|
|
2487
2277
|
|
|
2488
|
-
export { type Address, type AddressOptions, type AddressSearch, type AddressSearchOptions, type AddressSuggestion, type AgentTask, type AgentTaskInput, type AgentTaskLookupInput, type AgentTaskResult, type Asn, type AsnOptions, type
|
|
2278
|
+
export { type Address, type AddressOptions, type AddressSearch, type AddressSearchOptions, type AddressSuggestion, type AgentTask, type AgentTaskInput, type AgentTaskLookupInput, type AgentTaskResult, type Asn, type AsnOptions, type Bin, type BinOptions, type Caller, type CallerOptions, type Card, type CardDeep, type CardOptions, type Carrier, type CarrierDeep, type CarrierOptions, type City, type CityAmbiguityCandidate, type CityAncestorsOptions, type CityCollection, type CityCollectionFilters, type CityDeep, type CityDistance, type CityDistanceOptions, type CityGrain, type CityIdCall, type CityIdOptions, type CityList, type CityListOptions, type CityLookupCall, type CityMatch, type CityNearby, type CityNearbyCall, type CityNearbyCoordinates, type CityNearbyCoordinatesOptions, type CityNearbyOptions, type CityNearest, type CityNearestCall, type CityNearestOptions, type CityOptions, type CityPagingOptions, type CityParent, type CityRelations, type CityRelationsOptions, type CityResource, type CityResponseOptions, type CityScopeOptions, type CitySearch, type CitySearchCall, type CitySearchOptions, type CitySort, type Company, type CompanyCandidate, type CompanyCountry, type CompanyCoverage, type CompanyCoverageOptions, type CompanyDeep, type CompanyEmailAddress, type CompanyIdOptions, type CompanyMatch, type CompanyOptions, type CompanyPhoneNumber, type CompanyProfile, type CompanyProfileAddress, type CompanyProfileDeep, type CompanyProfileDomain, type CompanyProfileEmail, type CompanyProfileEmployees, type CompanyProfileFounding, type CompanyProfileIdentifier, type CompanyProfileIndustry, type CompanyProfileJurisdiction, type CompanyProfileListing, type CompanyProfilePhone, type CompanyProfileRegistration, type CompanyProfileRegistrationAddress, type CompanyProfileRegistrationLegalForm, type CompanyProfileSource, type CompanyProfileWebsite, type CompanySearch, type CompanySearchOptions, type CompanySocialProfile, type Continent, type ContinentCountries, type ContinentCountriesOptions, type ContinentCountryItem, type ContinentOptions, type Country, type CountryDeep, type CountryElevationPoint, type CountryEmergency, type CountryOptions, type CountryStateItem, type CountryStates, type CountryStatesOptions, type DateInfo, type DateInfoDeep, type DateOptions, type DateTodayOptions, type Deep, type District, type DistrictDeep, type DistrictOptions, type Dns, type DnsOptions, type DnsRecord, type Domain, type DomainDeep, type DomainOptions, type DomainRegistration, type Elevation, type ElevationLocations, type ElevationOptions, type Email, type EmailDeep, type EmailOptions, type Emoji, type EmojiArtwork, type EmojiArtworkSource, type EmojiBrowse, type EmojiBrowseOptions, EmojiCatalog, type EmojiCatalogConvertOptions, type EmojiCatalogData, EmojiCatalogError, type EmojiCatalogLocalization, type EmojiCatalogLookupOptions, type EmojiCatalogOptions, type EmojiCatalogParseOptions, type EmojiCatalogRegexOptions, type EmojiCatalogScope, type EmojiCatalogSearchFacts, type EmojiCatalogSearchOptions, type EmojiCategories, type EmojiCategory, type EmojiConversion, type EmojiConvertOptions, type EmojiDeep, type EmojiMetadata, type EmojiNativeSearchFacts, type EmojiNotice, type EmojiOptions, type EmojiParse, type EmojiParseOptions, type EmojiPosition, type EmojiSearch, type EmojiSearchOptions, type EmojiShortcodeSourceMetadata, type EmojiSkin, type EmojiSource, type EmojiUnresolved, type EmojiVariant, type Hlr, type HlrDeep, type HlrOptions, type Holiday, type HolidayDate, type HolidayDateOptions, type HolidayOptions, type HolidayYear, type Industry, type IndustryChild, type IndustryCorrection, type IndustryDeep, type IndustryExclusion, type IndustryMatch, type IndustryOptions, type IndustrySearch, type IndustrySearchItem, type IndustrySearchOptions, type Ip, type IpDeep, type IpOptions, type IpSelfOptions, type Language, type LanguageDeep, type LanguageOption, type LanguageOptions, type Mx, type MxOptions, type MxRecord, type Naics, type NaicsChild, type NaicsCorrection, type NaicsDeep, type NaicsExclusion, type NaicsMatch, type NaicsOptions, type NaicsSearch, type NaicsSearchItem, type NaicsSearchOptions, type Name, type NameDeep, type NameOptions, type ParseAPIClient, ParseAPIError, type ParseAPIOptions, type Phone, type PhoneDeep, type PhoneOptions, type Point, type PointCity, type PointDeep, type PointOptions, type Postal, type PostalDeep, type PostalDistance, type PostalDistanceEnd, type PostalDistanceOptions, type PostalLocality, type PostalMetro, type PostalMetrosDeep, type PostalNearby, type PostalNearbyItem, type PostalNearbyOptions, type PostalOptions, type Preflight, type PreflightCost, type PreflightEmailCapacity, type PreflightOperation, type PreflightOperationEstimate, type PreflightPooledCapacity, type PreflightSpendCapacity, type PreflightTask, type PropertyTax, type RequestOptions, type Stack, type StackOptions, type StackTechnology, type State, type StateDeep, type StateDistrictDeep, type StateDistrictItem, type StateDistricts, type StateDistrictsOptions, type StateOptions, type Time, type TimeAtOptions, type TimeLocation, type TimeLocationCandidate, type TimeLocationInput, type TimeOptions, type TimeResolution, type TimeResolutionAlternative, type TimeSeason, type TimeTransition, type TimeTransitionState, type TimeZoneEntry, type TimeZones, type TimeZonesOptions, type Timezone, type TimezoneAtOptions, type TimezoneConversionTarget, type TimezoneConversionTargetDeep, type TimezoneDeep, type TimezoneNextDst, type TimezoneOptions, type Useragent, type UseragentBrowserBrand, type UseragentBrowserDeep, type UseragentDeep, type UseragentDeviceDeep, type UseragentEngineDeep, type UseragentOptions, type UseragentOsDeep, type Weather, type WeatherAir, type WeatherAlert, type WeatherCurrent, type WeatherCurrentDeep, type WeatherDay, type WeatherDeep, type WeatherForecastPeriod, type WeatherHistory, type WeatherHour, type WeatherMinute, type WeatherOptions, type WeatherStation, parseAPI };
|
package/dist/index.js
CHANGED
|
@@ -256,7 +256,7 @@ var EmojiCatalog = class {
|
|
|
256
256
|
};
|
|
257
257
|
|
|
258
258
|
// src/index.ts
|
|
259
|
-
var VERSION = "1.11.
|
|
259
|
+
var VERSION = "1.11.4";
|
|
260
260
|
var API_VERSION = "2.0.0";
|
|
261
261
|
var DEFAULT_BASE_URL = "https://api.parseapi.com";
|
|
262
262
|
var DEFAULT_TIMEOUT_MS = 1e4;
|
|
@@ -570,14 +570,7 @@ function parseAPI(apiKey, options = {}) {
|
|
|
570
570
|
* Deep checks default to one attempt. An explicit retry count can repeat paid usage.
|
|
571
571
|
*/
|
|
572
572
|
email: (email, opts) => request(`/email/${enc(email)}`, deepQuery(opts), void 0, opts),
|
|
573
|
-
// Keep existing callers on their established HTTP contracts.
|
|
574
|
-
iban: (iban, opts) => request(`/iban/${enc(iban)}`, { country: opts?.country, ...deepQuery(opts) }, void 0, opts),
|
|
575
573
|
bin: (bin, opts) => request(`/bin/${enc(bin)}`, { deep: opts?.deep }, void 0, opts),
|
|
576
|
-
bank: (iban, opts) => request("/bank", void 0, void 0, opts, { iban, country: opts?.country, deep: opts?.deep }),
|
|
577
|
-
/** Check US routing/account syntax using POST. Does not verify ownership, existence or ACH eligibility. */
|
|
578
|
-
bankUsAch: (input, opts) => request("/bank", void 0, void 0, opts, { format: "us_ach", country: "US", routing: input.routing, account: input.account }),
|
|
579
|
-
/** Describe supported input fields and check scope; this does not establish country directory coverage. */
|
|
580
|
-
bankRequirements: (country, opts) => request("/bank/requirements", { country, format: opts?.format }, void 0, opts),
|
|
581
574
|
/** Parse a phone number and its formats. Pass country for national numbers when needed. Deep adds numbering-plan geography. */
|
|
582
575
|
phone: (number, opts) => request(`/phone/${enc(number)}`, { country: opts?.country, ...deepQuery(opts) }, void 0, opts),
|
|
583
576
|
/** Request a metered carrier lookup. No automatic retries by default. */
|
|
@@ -591,7 +584,6 @@ function parseAPI(apiKey, options = {}) {
|
|
|
591
584
|
/** Check whether a domain is registered. Deep adds registration dates, registrar, status and DNSSEC on paid plans. */
|
|
592
585
|
domain: (domain, opts) => request(`/domain/${enc(domain)}`, deepQuery(opts), void 0, opts),
|
|
593
586
|
asn: (asn, opts) => request(`/asn/${enc(asn)}`, void 0, void 0, opts),
|
|
594
|
-
mac: (mac, opts) => request(`/mac/${enc(mac)}`, void 0, void 0, opts),
|
|
595
587
|
/** Look up a 2-11 digit card prefix. Keep leading zeros in the input string. */
|
|
596
588
|
card: async (bin, opts) => {
|
|
597
589
|
if (typeof bin !== "string" || bin.length > 64 || !/^[0-9]{2,11}$/.test(bin.replace(/[ \t\r\n-]/g, ""))) {
|
|
@@ -599,19 +591,6 @@ function parseAPI(apiKey, options = {}) {
|
|
|
599
591
|
}
|
|
600
592
|
return request(`/card/${enc(bin)}`, deepQuery(opts), void 0, opts);
|
|
601
593
|
},
|
|
602
|
-
/** Parse a measurement or convert it to `to`. Without `to`, use its type's canonical unit. Invalid input is plain data with `valid: false`. */
|
|
603
|
-
measure: Object.assign(
|
|
604
|
-
async (measure, opts) => {
|
|
605
|
-
const result = await request(`/measure/${enc(measure)}`, { to: opts?.to, locale: opts?.locale, system: opts?.system }, void 0, opts);
|
|
606
|
-
if (!Object.prototype.hasOwnProperty.call(result, "reason")) Object.defineProperty(result, "reason", { value: null, writable: true, configurable: true });
|
|
607
|
-
if (!Object.prototype.hasOwnProperty.call(result, "choices")) Object.defineProperty(result, "choices", { value: [], writable: true, configurable: true });
|
|
608
|
-
return result;
|
|
609
|
-
},
|
|
610
|
-
{
|
|
611
|
-
/** Discover reviewed units. Pass `unit` to find compatible conversion targets. */
|
|
612
|
-
units: (opts) => request("/measure/units", { q: opts?.query, type: opts?.type, unit: opts?.unit }, void 0, opts)
|
|
613
|
-
}
|
|
614
|
-
),
|
|
615
594
|
/** Look up DNS records with TTLs. Type selects the question and may include its CNAME chain. Pooled on every plan. */
|
|
616
595
|
dns: (domain, opts) => request(`/dns/${enc(domain)}`, { type: opts?.type }, void 0, opts),
|
|
617
596
|
mx: (domain, opts) => request(`/mx/${enc(domain)}`, void 0, void 0, opts),
|
|
@@ -620,15 +599,6 @@ function parseAPI(apiKey, options = {}) {
|
|
|
620
599
|
industry,
|
|
621
600
|
/** Compatibility name for industry. */
|
|
622
601
|
naics: industry,
|
|
623
|
-
currency: Object.assign(
|
|
624
|
-
(code, opts) => request(`/currency/${enc(code)}`, deepQuery(opts), void 0, opts),
|
|
625
|
-
{
|
|
626
|
-
rate: (base, quote, opts) => request(`/currency/${enc(base)}/${enc(quote)}`, {
|
|
627
|
-
date: opts?.date,
|
|
628
|
-
amount: opts?.amount
|
|
629
|
-
}, void 0, opts)
|
|
630
|
-
}
|
|
631
|
-
),
|
|
632
602
|
language: (code, opts) => request(`/language/${enc(code)}`, deepQuery(opts), void 0, opts),
|
|
633
603
|
name: (name, opts) => request(`/name/${enc(name)}`, { country: opts?.country, ...deepQuery(opts), name_locale: opts?.name_locale }, void 0, opts),
|
|
634
604
|
/** Current local time, UTC by default. With to or targets, offsetless at is source wall time. */
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@parseapi/sdk",
|
|
3
|
-
"version": "1.11.
|
|
3
|
+
"version": "1.11.4",
|
|
4
4
|
"description": "Official ParseAPI client for Node and TypeScript. One key, minimal JSON, fast.",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"parseapi",
|
|
@@ -10,7 +10,6 @@
|
|
|
10
10
|
"phone validation",
|
|
11
11
|
"postal",
|
|
12
12
|
"timezone",
|
|
13
|
-
"currency",
|
|
14
13
|
"weather"
|
|
15
14
|
],
|
|
16
15
|
"license": "MIT",
|