@parseapi/sdk 1.6.0 → 1.8.0
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 +74 -13
- package/dist/index.cjs +57 -24
- package/dist/index.d.cts +275 -40
- package/dist/index.d.ts +275 -40
- package/dist/index.js +57 -24
- package/package.json +1 -1
package/dist/index.d.cts
CHANGED
|
@@ -305,7 +305,22 @@ interface Vat {
|
|
|
305
305
|
from?: string;
|
|
306
306
|
deep?: Deep<VatDeep>;
|
|
307
307
|
}
|
|
308
|
-
|
|
308
|
+
/** Ordered IBAN checks. States are open strings for future API values. */
|
|
309
|
+
interface BankChecks {
|
|
310
|
+
input: string;
|
|
311
|
+
country: string;
|
|
312
|
+
length: string;
|
|
313
|
+
structure: string;
|
|
314
|
+
checksum: string;
|
|
315
|
+
national: string;
|
|
316
|
+
}
|
|
317
|
+
/** A validation issue. Fields and codes remain open strings. */
|
|
318
|
+
interface BankIssue {
|
|
319
|
+
field: string;
|
|
320
|
+
code: string;
|
|
321
|
+
message: string;
|
|
322
|
+
}
|
|
323
|
+
interface Bank {
|
|
309
324
|
iban: string | null;
|
|
310
325
|
valid: boolean;
|
|
311
326
|
country: string | null;
|
|
@@ -317,16 +332,91 @@ interface Iban {
|
|
|
317
332
|
bank_name: string | null;
|
|
318
333
|
/** BIC from that same directory. Null when unsourced or missing. */
|
|
319
334
|
bic: string | null;
|
|
320
|
-
|
|
335
|
+
/** Core check results. Older responses may omit them. */
|
|
336
|
+
checks?: BankChecks;
|
|
337
|
+
/** First blocking validation issue, or an empty list. Older responses may omit it. */
|
|
338
|
+
issues?: BankIssue[];
|
|
339
|
+
deep?: Deep<BankDeep>;
|
|
340
|
+
}
|
|
341
|
+
/** Directory evidence is optional and present only when a lookup ran. */
|
|
342
|
+
interface BankDirectory {
|
|
343
|
+
edition: string;
|
|
344
|
+
country: string;
|
|
345
|
+
/** bank, branch, prefix or none; remains open for future API values. */
|
|
346
|
+
match: string;
|
|
321
347
|
}
|
|
322
|
-
interface
|
|
323
|
-
|
|
348
|
+
interface BankRequirementField {
|
|
349
|
+
key: string;
|
|
350
|
+
label: string;
|
|
351
|
+
required: boolean;
|
|
352
|
+
type: string;
|
|
353
|
+
length?: number;
|
|
354
|
+
min_length?: number;
|
|
355
|
+
max_length?: number;
|
|
356
|
+
max_input_length?: number;
|
|
357
|
+
length_unit?: string;
|
|
358
|
+
pattern?: string;
|
|
359
|
+
normalization?: string;
|
|
360
|
+
}
|
|
361
|
+
interface BankRequirements {
|
|
362
|
+
country: string;
|
|
363
|
+
format: string;
|
|
364
|
+
supported: boolean;
|
|
365
|
+
fields: BankRequirementField[];
|
|
366
|
+
checks: Record<string, string>;
|
|
367
|
+
limitations: string[];
|
|
368
|
+
}
|
|
369
|
+
/** US ACH syntax/checksum analysis; no account or payment verification. */
|
|
370
|
+
interface BankUsAchInput {
|
|
371
|
+
routing: string;
|
|
372
|
+
account: string;
|
|
373
|
+
}
|
|
374
|
+
interface BankUsAchChecks {
|
|
375
|
+
routing_format: string;
|
|
376
|
+
routing_checksum: string;
|
|
377
|
+
account_format: string;
|
|
378
|
+
account_checksum: string;
|
|
379
|
+
}
|
|
380
|
+
interface BankUsAch {
|
|
381
|
+
format: string;
|
|
382
|
+
country: string;
|
|
383
|
+
routing: string | null;
|
|
384
|
+
account: string | null;
|
|
385
|
+
valid: boolean;
|
|
386
|
+
bank_name: string | null;
|
|
387
|
+
checks: BankUsAchChecks;
|
|
388
|
+
issues: BankIssue[];
|
|
389
|
+
}
|
|
390
|
+
interface ProviderTaxonomy {
|
|
391
|
+
taxonomy?: string | null;
|
|
392
|
+
specialty?: string | null;
|
|
393
|
+
primary?: boolean | null;
|
|
394
|
+
license?: string | null;
|
|
395
|
+
state?: string | null;
|
|
396
|
+
}
|
|
397
|
+
interface ProviderSource {
|
|
398
|
+
edition?: string | null;
|
|
399
|
+
published_at?: string | null;
|
|
400
|
+
through?: string | null;
|
|
401
|
+
imported_at?: string | null;
|
|
402
|
+
}
|
|
403
|
+
interface ProviderSources {
|
|
404
|
+
nppes?: ProviderSource | null;
|
|
405
|
+
leie?: ProviderSource | null;
|
|
406
|
+
pecos?: ProviderSource | null;
|
|
407
|
+
optout?: ProviderSource | null;
|
|
408
|
+
}
|
|
409
|
+
interface Provider {
|
|
410
|
+
sources?: ProviderSources | null;
|
|
411
|
+
/** Input with accepted separators removed; null when empty. Invalid values remain visible. */
|
|
324
412
|
npi: string | null;
|
|
413
|
+
/** Format and NPI checksum only; does not verify a provider or credentials. */
|
|
325
414
|
valid: boolean;
|
|
326
|
-
/**
|
|
415
|
+
/** Found in the stored NPPES snapshot. Null when input is invalid. */
|
|
327
416
|
registered: boolean | null;
|
|
417
|
+
/** Recorded NPI activation status. Null when unknown; not licensure or practice status. */
|
|
328
418
|
active: boolean | null;
|
|
329
|
-
/**
|
|
419
|
+
/** NPI-only match in the stored OIG LEIE file. False is not complete exclusion clearance. */
|
|
330
420
|
excluded: boolean | null;
|
|
331
421
|
/** individual or organization. */
|
|
332
422
|
type: string | null;
|
|
@@ -344,22 +434,26 @@ interface Npi {
|
|
|
344
434
|
postal: string | null;
|
|
345
435
|
country: string | null;
|
|
346
436
|
phone: string | null;
|
|
347
|
-
deep?: Deep<
|
|
437
|
+
deep?: Deep<ProviderDeep>;
|
|
348
438
|
}
|
|
349
|
-
interface
|
|
439
|
+
interface ProviderEnrollment {
|
|
350
440
|
/** part_a, part_b, practitioner, dme, order_refer, mdpp. Null when the code is unknown. */
|
|
351
441
|
type: string | null;
|
|
352
442
|
specialty: string | null;
|
|
353
443
|
state: string | null;
|
|
354
444
|
}
|
|
355
|
-
interface
|
|
356
|
-
|
|
445
|
+
interface ProviderDeep {
|
|
446
|
+
enumerated_at?: string | null;
|
|
447
|
+
updated_at?: string | null;
|
|
448
|
+
reactivated_at?: string | null;
|
|
449
|
+
taxonomies?: ProviderTaxonomy[] | null;
|
|
450
|
+
/** Present in the stored Medicare FFS enrollment extract; not payment eligibility. */
|
|
357
451
|
medicare?: boolean | null;
|
|
358
|
-
/**
|
|
452
|
+
/** NPI-only match in the stored CMS opt-out affidavit list. Null when unavailable. */
|
|
359
453
|
opt_out?: boolean | null;
|
|
360
|
-
/**
|
|
361
|
-
enrollments?:
|
|
362
|
-
/**
|
|
454
|
+
/** Stored enrollment rows. Null when unavailable; [] when no rows are returned. */
|
|
455
|
+
enrollments?: ProviderEnrollment[] | null;
|
|
456
|
+
/** Recorded NPI deactivation date, YYYY-MM-DD. Null when active or unavailable. */
|
|
363
457
|
deactivated_at: string | null;
|
|
364
458
|
}
|
|
365
459
|
interface TariffMeasure {
|
|
@@ -377,11 +471,13 @@ interface TariffMeasure {
|
|
|
377
471
|
conditional?: boolean | null;
|
|
378
472
|
}
|
|
379
473
|
interface TariffDeep {
|
|
474
|
+
/** Open-string explanation when effective_rate is null. */
|
|
475
|
+
reason?: string | null;
|
|
380
476
|
/** The origin country the measures were resolved for. */
|
|
381
477
|
origin?: string | null;
|
|
382
|
-
/** Composed ad valorem percent. Null when the components do not compose cleanly. */
|
|
478
|
+
/** Composed ad valorem percent for matched stored measures only, not complete duty or landed cost. Null when the components do not compose cleanly. */
|
|
383
479
|
effective_rate?: number | null;
|
|
384
|
-
/**
|
|
480
|
+
/** Matching stored Chapter 99 schedule measures for this code and goods origin. */
|
|
385
481
|
measures?: TariffMeasure[] | null;
|
|
386
482
|
/** Units of quantity (No., kg). */
|
|
387
483
|
units: string[];
|
|
@@ -391,6 +487,10 @@ interface TariffDeep {
|
|
|
391
487
|
other: string | null;
|
|
392
488
|
}
|
|
393
489
|
interface Tariff {
|
|
490
|
+
/** Exact immutable edition. Older servers may omit it. */
|
|
491
|
+
edition?: string;
|
|
492
|
+
/** Answering date, or null for an undated edition query. */
|
|
493
|
+
date?: string | null;
|
|
394
494
|
/** Normalized code with dots (8471.30.01.00). */
|
|
395
495
|
hts: string;
|
|
396
496
|
/** The schedule line verbatim. */
|
|
@@ -407,8 +507,14 @@ interface TariffSearchHit {
|
|
|
407
507
|
hts: string;
|
|
408
508
|
description: string;
|
|
409
509
|
general: string | null;
|
|
510
|
+
/** Parent descriptions, outermost first. Older responses may omit this context. */
|
|
511
|
+
lineage?: string[] | null;
|
|
410
512
|
}
|
|
411
513
|
interface TariffSearch {
|
|
514
|
+
/** Exact immutable edition. Older servers may omit it. */
|
|
515
|
+
edition?: string;
|
|
516
|
+
/** Answering date, or null for an undated edition query. */
|
|
517
|
+
date?: string | null;
|
|
412
518
|
q: string;
|
|
413
519
|
revision: string;
|
|
414
520
|
/** Up to 20 tariff lines, best match first. */
|
|
@@ -424,7 +530,7 @@ interface VinRecall {
|
|
|
424
530
|
summary: string | null;
|
|
425
531
|
}
|
|
426
532
|
interface VinDeep {
|
|
427
|
-
/**
|
|
533
|
+
/** Recall campaigns for the decoded year, make and model. [] when none, null when the registry did not answer. */
|
|
428
534
|
recalls?: VinRecall[] | null;
|
|
429
535
|
series: string | null;
|
|
430
536
|
doors: number | null;
|
|
@@ -560,20 +666,23 @@ interface Mac {
|
|
|
560
666
|
local: boolean | null;
|
|
561
667
|
multicast: boolean | null;
|
|
562
668
|
}
|
|
563
|
-
/**
|
|
564
|
-
interface
|
|
669
|
+
/** Network identity from reviewed prefix rules; null means unknown or ambiguous. */
|
|
670
|
+
interface Card {
|
|
565
671
|
bin: string;
|
|
566
|
-
/** Actual longest matched prefix. May be shorter than the input. */
|
|
567
|
-
prefix: string | null;
|
|
568
|
-
country: string | null;
|
|
569
|
-
issuer: string | null;
|
|
570
|
-
/** Network key (visa, amex) or co-branded combination. */
|
|
571
672
|
brand: string | null;
|
|
572
|
-
/** Display name for brand (American Express). */
|
|
573
673
|
brand_name: string | null;
|
|
674
|
+
/** SVG URL, with a generic-card fallback. */
|
|
675
|
+
logo: string;
|
|
676
|
+
/** Included only when requested; pooled on every plan. */
|
|
677
|
+
deep?: CardDeep;
|
|
678
|
+
}
|
|
679
|
+
interface CardDeep {
|
|
680
|
+
/** Longest recorded matching prefix; may be shorter than bin. */
|
|
681
|
+
prefix: string | null;
|
|
682
|
+
issuer: string | null;
|
|
683
|
+
country: string | null;
|
|
574
684
|
type: string | null;
|
|
575
685
|
prepaid: boolean | null;
|
|
576
|
-
deep?: Record<string, never>;
|
|
577
686
|
}
|
|
578
687
|
/** A published DNS record. Value is DNS presentation text, including TXT quoting. */
|
|
579
688
|
interface DnsRecord {
|
|
@@ -1196,7 +1305,9 @@ interface PostalDeep {
|
|
|
1196
1305
|
/** Median annual property tax payable on owner-occupied homes in this statistical area. Null when unsupported, missing or censored. */
|
|
1197
1306
|
property_tax?: PropertyTax | null;
|
|
1198
1307
|
}
|
|
1199
|
-
interface
|
|
1308
|
+
interface BankDeep {
|
|
1309
|
+
/** Source edition and exact match grain, not coverage or account verification. */
|
|
1310
|
+
directory?: BankDirectory;
|
|
1200
1311
|
/** Two check digits as a string, keeping a leading zero. */
|
|
1201
1312
|
checksum: string | null;
|
|
1202
1313
|
/** Branch identifier when that country has one. */
|
|
@@ -1375,6 +1486,95 @@ interface TimeLocation {
|
|
|
1375
1486
|
truncated: boolean;
|
|
1376
1487
|
source: string;
|
|
1377
1488
|
}
|
|
1489
|
+
type Industry = Naics;
|
|
1490
|
+
type IndustryChild = NaicsChild;
|
|
1491
|
+
type IndustryCorrection = NaicsCorrection;
|
|
1492
|
+
type IndustryDeep = NaicsDeep;
|
|
1493
|
+
type IndustryExclusion = NaicsExclusion;
|
|
1494
|
+
type IndustryMatch = NaicsMatch;
|
|
1495
|
+
type IndustrySearch = NaicsSearch;
|
|
1496
|
+
type IndustrySearchItem = NaicsSearchItem;
|
|
1497
|
+
type Vehicle = Vin;
|
|
1498
|
+
type VehicleDeep = VinDeep;
|
|
1499
|
+
type VehicleRecall = VinRecall;
|
|
1500
|
+
interface Iban {
|
|
1501
|
+
iban: string | null;
|
|
1502
|
+
valid: boolean;
|
|
1503
|
+
country: string | null;
|
|
1504
|
+
/** Print form in groups of four, for display. Null when invalid. */
|
|
1505
|
+
formatted: string | null;
|
|
1506
|
+
/** Bank identifier parsed from the number, not a name. */
|
|
1507
|
+
bank: string | null;
|
|
1508
|
+
/** Institution name from the national bank-code directory. Null when unsourced. */
|
|
1509
|
+
bank_name: string | null;
|
|
1510
|
+
/** BIC from that same directory. Null when unsourced or missing. */
|
|
1511
|
+
bic: string | null;
|
|
1512
|
+
deep?: Deep<IbanDeep>;
|
|
1513
|
+
}
|
|
1514
|
+
interface Npi {
|
|
1515
|
+
/** Normalized 10-digit NPI. Invalid input still echoes the fold. */
|
|
1516
|
+
npi: string | null;
|
|
1517
|
+
valid: boolean;
|
|
1518
|
+
/** Exists in the CMS NPPES registry. */
|
|
1519
|
+
registered: boolean | null;
|
|
1520
|
+
active: boolean | null;
|
|
1521
|
+
/** On the OIG exclusion list. */
|
|
1522
|
+
excluded: boolean | null;
|
|
1523
|
+
/** individual or organization. */
|
|
1524
|
+
type: string | null;
|
|
1525
|
+
name: string | null;
|
|
1526
|
+
first: string | null;
|
|
1527
|
+
last: string | null;
|
|
1528
|
+
credential: string | null;
|
|
1529
|
+
specialty: string | null;
|
|
1530
|
+
/** NUCC taxonomy code. */
|
|
1531
|
+
taxonomy: string | null;
|
|
1532
|
+
address: string | null;
|
|
1533
|
+
city: string | null;
|
|
1534
|
+
state: string | null;
|
|
1535
|
+
state_name: string | null;
|
|
1536
|
+
postal: string | null;
|
|
1537
|
+
country: string | null;
|
|
1538
|
+
phone: string | null;
|
|
1539
|
+
deep?: Deep<NpiDeep>;
|
|
1540
|
+
}
|
|
1541
|
+
interface NpiEnrollment {
|
|
1542
|
+
/** part_a, part_b, practitioner, dme, order_refer, mdpp. Null when the code is unknown. */
|
|
1543
|
+
type: string | null;
|
|
1544
|
+
specialty: string | null;
|
|
1545
|
+
state: string | null;
|
|
1546
|
+
}
|
|
1547
|
+
interface NpiDeep {
|
|
1548
|
+
/** In the published Medicare FFS enrollment extract. */
|
|
1549
|
+
medicare?: boolean | null;
|
|
1550
|
+
/** On the CMS opt-out affidavit list. Matched by NPI only. */
|
|
1551
|
+
opt_out?: boolean | null;
|
|
1552
|
+
/** Enrollment rows. [] when medicare is false. */
|
|
1553
|
+
enrollments?: NpiEnrollment[] | null;
|
|
1554
|
+
/** Date CMS deactivated the NPI, YYYY-MM-DD. Null when still active. */
|
|
1555
|
+
deactivated_at: string | null;
|
|
1556
|
+
}
|
|
1557
|
+
interface Bin {
|
|
1558
|
+
bin: string;
|
|
1559
|
+
/** Actual longest matched prefix. May be shorter than the input. */
|
|
1560
|
+
prefix: string | null;
|
|
1561
|
+
country: string | null;
|
|
1562
|
+
issuer: string | null;
|
|
1563
|
+
/** Network key (visa, amex) or co-branded combination. */
|
|
1564
|
+
brand: string | null;
|
|
1565
|
+
/** Display name for brand (American Express). */
|
|
1566
|
+
brand_name: string | null;
|
|
1567
|
+
type: string | null;
|
|
1568
|
+
prepaid: boolean | null;
|
|
1569
|
+
deep?: Record<string, never>;
|
|
1570
|
+
}
|
|
1571
|
+
interface IbanDeep {
|
|
1572
|
+
/** Two check digits as a string, keeping a leading zero. */
|
|
1573
|
+
checksum: string | null;
|
|
1574
|
+
/** Branch identifier when that country has one. */
|
|
1575
|
+
branch: string | null;
|
|
1576
|
+
account: string | null;
|
|
1577
|
+
}
|
|
1378
1578
|
|
|
1379
1579
|
/** A proposed task contains operation counts, never lookup inputs. */
|
|
1380
1580
|
interface PreflightOperation {
|
|
@@ -1482,7 +1682,9 @@ declare class ParseAPIError extends Error {
|
|
|
1482
1682
|
readonly docs: string | null;
|
|
1483
1683
|
/** Send this if you contact support */
|
|
1484
1684
|
readonly requestId: string | null;
|
|
1485
|
-
|
|
1685
|
+
/** Original Retry-After response header, when supplied. */
|
|
1686
|
+
readonly retryAfter: string | null;
|
|
1687
|
+
constructor(status: number, code: string, message: string, docs: string | null, requestId: string | null, retryAfter?: string | null);
|
|
1486
1688
|
}
|
|
1487
1689
|
/** Optional output language for supported display fields. Input parsing stays unchanged. */
|
|
1488
1690
|
interface LanguageOption {
|
|
@@ -1581,10 +1783,13 @@ type VatOptions = {
|
|
|
1581
1783
|
country?: string;
|
|
1582
1784
|
from?: string;
|
|
1583
1785
|
} & DeepOption & RequestOptions;
|
|
1584
|
-
type
|
|
1786
|
+
type BankOptions = {
|
|
1585
1787
|
country?: string;
|
|
1586
1788
|
} & DeepOption & RequestOptions;
|
|
1587
|
-
type
|
|
1789
|
+
type BankRequirementsOptions = {
|
|
1790
|
+
format?: string;
|
|
1791
|
+
} & RequestOptions;
|
|
1792
|
+
type ProviderOptions = LanguageOption & DeepOption & RequestOptions;
|
|
1588
1793
|
/** Country resolves national-number ambiguity. Deep adds numbering-plan geography on every plan. */
|
|
1589
1794
|
type PhoneOptions = {
|
|
1590
1795
|
country?: string;
|
|
@@ -1607,8 +1812,8 @@ type StackOptions = {
|
|
|
1607
1812
|
type DomainOptions = DeepOption & RequestOptions;
|
|
1608
1813
|
type AsnOptions = LanguageOption & RequestOptions;
|
|
1609
1814
|
type MacOptions = RequestOptions;
|
|
1610
|
-
/**
|
|
1611
|
-
type
|
|
1815
|
+
/** Request controls for a card-prefix reference lookup. */
|
|
1816
|
+
type CardOptions = DeepOption & RequestOptions;
|
|
1612
1817
|
/** Parse a measurement, optionally converting it. Locale and system resolve explicit ambiguity. */
|
|
1613
1818
|
type MeasureOptions = {
|
|
1614
1819
|
to?: string;
|
|
@@ -1627,18 +1832,26 @@ type DnsOptions = {
|
|
|
1627
1832
|
type MxOptions = RequestOptions;
|
|
1628
1833
|
type UseragentOptions = DeepOption & RequestOptions;
|
|
1629
1834
|
type VinOptions = DeepOption & RequestOptions;
|
|
1835
|
+
type VehicleOptions = VinOptions;
|
|
1630
1836
|
/** US NAICS 2022 code lookup, using pooled requests. */
|
|
1631
|
-
type
|
|
1837
|
+
type IndustryOptions = DeepOption & RequestOptions;
|
|
1632
1838
|
/** Keyword search. Limit defaults to 10 and accepts 1-50. */
|
|
1633
|
-
type
|
|
1839
|
+
type IndustrySearchOptions = {
|
|
1634
1840
|
limit?: number;
|
|
1635
1841
|
} & DeepOption & RequestOptions;
|
|
1636
1842
|
/** Look up the general US duty schedule line. Paid deep adds units and the special and other schedule columns. Add origin with deep to resolve country-specific measures. Without origin, schedule detail remains available and origin-dependent fields are null. A null effective rate is not a zero rate. */
|
|
1637
1843
|
type TariffOptions = {
|
|
1638
1844
|
/** Origin country (ISO2). With paid deep, resolves country-specific measures. */
|
|
1639
1845
|
origin?: string;
|
|
1846
|
+
/** Exact immutable edition fingerprint. */
|
|
1847
|
+
edition?: string;
|
|
1848
|
+
/** YYYY-MM-DD, accepted only with verified source coverage. */
|
|
1849
|
+
date?: string;
|
|
1640
1850
|
} & DeepOption & RequestOptions;
|
|
1641
|
-
type TariffSearchOptions =
|
|
1851
|
+
type TariffSearchOptions = {
|
|
1852
|
+
edition?: string;
|
|
1853
|
+
date?: string;
|
|
1854
|
+
} & RequestOptions;
|
|
1642
1855
|
type CurrencyOptions = LanguageOption & DeepOption & RequestOptions;
|
|
1643
1856
|
type CurrencyRateOptions = {
|
|
1644
1857
|
date?: string;
|
|
@@ -1775,7 +1988,14 @@ declare function parseAPI(apiKey?: string, options?: ParseAPIOptions): {
|
|
|
1775
1988
|
/** Check VAT format and checksum. `deep: true` requests a metered registry check where supported, with no automatic retries by default. */
|
|
1776
1989
|
vat: (number: string, opts?: VatOptions) => Promise<Vat>;
|
|
1777
1990
|
iban: (iban: string, opts?: IbanOptions) => Promise<Iban>;
|
|
1991
|
+
bin: (bin: string, opts?: BinOptions) => Promise<Bin>;
|
|
1778
1992
|
npi: (npi: string, opts?: NpiOptions) => Promise<Npi>;
|
|
1993
|
+
bank: (iban: string, opts?: BankOptions) => Promise<Bank>;
|
|
1994
|
+
/** Check US routing/account syntax using POST. Does not verify ownership, existence or ACH eligibility. */
|
|
1995
|
+
bankUsAch: (input: BankUsAchInput, opts?: RequestOptions) => Promise<BankUsAch>;
|
|
1996
|
+
/** Describe supported input fields and check scope; this does not establish country directory coverage. */
|
|
1997
|
+
bankRequirements: (country: string, opts?: BankRequirementsOptions) => Promise<BankRequirements>;
|
|
1998
|
+
provider: (npi: string, opts?: ProviderOptions) => Promise<Provider>;
|
|
1779
1999
|
/** Parse a phone number and its formats. Pass country for national numbers when needed. Deep adds numbering-plan geography. */
|
|
1780
2000
|
phone: (number: string, opts?: PhoneOptions) => Promise<Phone>;
|
|
1781
2001
|
/** Request a metered carrier lookup. No automatic retries by default. */
|
|
@@ -1790,8 +2010,8 @@ declare function parseAPI(apiKey?: string, options?: ParseAPIOptions): {
|
|
|
1790
2010
|
domain: (domain: string, opts?: DomainOptions) => Promise<Domain>;
|
|
1791
2011
|
asn: (asn: string, opts?: AsnOptions) => Promise<Asn>;
|
|
1792
2012
|
mac: (mac: string, opts?: MacOptions) => Promise<Mac>;
|
|
1793
|
-
/** Look up a
|
|
1794
|
-
|
|
2013
|
+
/** Look up a 2-11 digit card prefix. Keep leading zeros in the input string. */
|
|
2014
|
+
card: (bin: string, opts?: CardOptions) => Promise<Card>;
|
|
1795
2015
|
/** Parse a measurement or convert it to `to`. Without `to`, use its type's canonical unit. Invalid input is plain data with `valid: false`. */
|
|
1796
2016
|
measure: ((measure: string, opts?: MeasureOptions) => Promise<Measure>) & {
|
|
1797
2017
|
/** Discover reviewed units. Pass `unit` to find compatible conversion targets. */
|
|
@@ -1801,10 +2021,17 @@ declare function parseAPI(apiKey?: string, options?: ParseAPIOptions): {
|
|
|
1801
2021
|
dns: (domain: string, opts?: DnsOptions) => Promise<Dns>;
|
|
1802
2022
|
mx: (domain: string, opts?: MxOptions) => Promise<Mx>;
|
|
1803
2023
|
useragent: (ua: string, opts?: UseragentOptions) => Promise<Useragent>;
|
|
2024
|
+
/** Identify a vehicle by VIN. Paid deep adds specifications and model-level recall campaigns. */
|
|
2025
|
+
vehicle: (vin: string, opts?: VehicleOptions) => Promise<Vehicle>;
|
|
2026
|
+
/** Compatibility entry for VIN callers. */
|
|
1804
2027
|
vin: (vin: string, opts?: VinOptions) => Promise<Vin>;
|
|
1805
2028
|
/** US NAICS 2022 definitions and hierarchy. */
|
|
1806
|
-
|
|
1807
|
-
search: (query: string, opts?:
|
|
2029
|
+
industry: ((code: string, opts?: IndustryOptions) => Promise<Industry>) & {
|
|
2030
|
+
search: (query: string, opts?: IndustrySearchOptions) => Promise<IndustrySearch>;
|
|
2031
|
+
};
|
|
2032
|
+
/** Compatibility name for industry. */
|
|
2033
|
+
naics: ((code: string, opts?: IndustryOptions) => Promise<Industry>) & {
|
|
2034
|
+
search: (query: string, opts?: IndustrySearchOptions) => Promise<IndustrySearch>;
|
|
1808
2035
|
};
|
|
1809
2036
|
/** Look up the general US duty schedule line. Paid deep adds units and the special and other schedule columns. Add origin with deep to resolve country-specific measures. Without origin, schedule detail remains available and origin-dependent fields are null. A null effective rate is not a zero rate. */
|
|
1810
2037
|
tariff: ((code: string, opts?: TariffOptions) => Promise<Tariff>) & {
|
|
@@ -1845,5 +2072,13 @@ declare function parseAPI(apiKey?: string, options?: ParseAPIOptions): {
|
|
|
1845
2072
|
};
|
|
1846
2073
|
};
|
|
1847
2074
|
type ParseAPIClient = ReturnType<typeof parseAPI>;
|
|
2075
|
+
/** Existing NAICS options remain source compatible. */
|
|
2076
|
+
type NaicsOptions = IndustryOptions;
|
|
2077
|
+
type NaicsSearchOptions = IndustrySearchOptions;
|
|
2078
|
+
type IbanOptions = {
|
|
2079
|
+
country?: string;
|
|
2080
|
+
} & DeepOption & RequestOptions;
|
|
2081
|
+
type NpiOptions = LanguageOption & DeepOption & RequestOptions;
|
|
2082
|
+
type BinOptions = DeepOption & RequestOptions;
|
|
1848
2083
|
|
|
1849
|
-
export { type Address, type AddressOptions, type AddressSearch, type AddressSearchOptions, type AddressSuggestion, type Asn, type AsnOptions, type Bin, type BinOptions, type Bloc, type BlocCountries, type BlocCountriesOptions, type BlocCountryItem, type BlocOptions, type Caller, type CallerOptions, type Carrier, type CarrierDeep, type CarrierOptions, type City, type CityDeep, 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 CountryDeep, type CountryElevationPoint, type CountryEmergency, type CountryOptions, type CountryStateItem, type CountryStates, type CountryStatesOptions, type Currency, type CurrencyDeep, type CurrencyOptions, type CurrencyRate, type CurrencyRateOptions, 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 EmojiDeep, type EmojiOptions, type EmojiSearch, type EmojiSearchOptions, type EmojiSkin, type Hlr, type HlrDeep, type HlrOptions, type Holiday, type HolidayDate, type HolidayDateOptions, type HolidayOptions, type HolidayYear, type Iban, type IbanDeep, type IbanOptions, type Ip, type IpDeep, type IpOptions, type IpSelfOptions, type Language, type LanguageDeep, type LanguageOption, type LanguageOptions, type Mac, type MacOptions, type Measure, type MeasureChoice, type MeasureOptions, type MeasureUnit, type MeasureUnits, type MeasureUnitsOptions, 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 Npi, type NpiDeep, type NpiEnrollment, type NpiOptions, 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 Tariff, type TariffDeep, type TariffMeasure, type TariffOptions, type TariffSearch, type TariffSearchHit, type TariffSearchOptions, 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 Vat, type VatAddress, type VatDeep, type VatOptions, type Vin, type VinDeep, type VinOptions, type VinRecall, 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 };
|
|
2084
|
+
export { type Address, type AddressOptions, type AddressSearch, type AddressSearchOptions, type AddressSuggestion, type Asn, type AsnOptions, type Bank, type BankChecks, type BankDeep, type BankDirectory, type BankIssue, type BankOptions, type BankRequirementField, type BankRequirements, type BankRequirementsOptions, type BankUsAch, type BankUsAchChecks, type BankUsAchInput, type Bin, type BinOptions, type Bloc, type BlocCountries, type BlocCountriesOptions, type BlocCountryItem, type BlocOptions, type Caller, type CallerOptions, type Card, type CardDeep, type CardOptions, type Carrier, type CarrierDeep, type CarrierOptions, type City, type CityDeep, 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 CountryDeep, type CountryElevationPoint, type CountryEmergency, type CountryOptions, type CountryStateItem, type CountryStates, type CountryStatesOptions, type Currency, type CurrencyDeep, type CurrencyOptions, type CurrencyRate, type CurrencyRateOptions, 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 EmojiDeep, type EmojiOptions, type EmojiSearch, type EmojiSearchOptions, type EmojiSkin, type Hlr, type HlrDeep, type HlrOptions, type Holiday, type HolidayDate, type HolidayDateOptions, type HolidayOptions, type HolidayYear, type Iban, type IbanDeep, type IbanOptions, 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 Mac, type MacOptions, type Measure, type MeasureChoice, type MeasureOptions, type MeasureUnit, type MeasureUnits, type MeasureUnitsOptions, 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 Npi, type NpiDeep, type NpiEnrollment, type NpiOptions, 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 Provider, type ProviderDeep, type ProviderEnrollment, type ProviderOptions, type ProviderSource, type ProviderSources, type ProviderTaxonomy, type RequestOptions, type Stack, type StackOptions, type StackTechnology, type State, type StateDeep, type StateDistrictDeep, type StateDistrictItem, type StateDistricts, type StateDistrictsOptions, type StateOptions, type Tariff, type TariffDeep, type TariffMeasure, type TariffOptions, type TariffSearch, type TariffSearchHit, type TariffSearchOptions, 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 Vat, type VatAddress, type VatDeep, type VatOptions, type Vehicle, type VehicleDeep, type VehicleOptions, type VehicleRecall, type Vin, type VinDeep, type VinOptions, type VinRecall, 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 };
|