@parseapi/sdk 1.7.0 → 1.9.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/dist/index.d.ts CHANGED
@@ -305,7 +305,22 @@ interface Vat {
305
305
  from?: string;
306
306
  deep?: Deep<VatDeep>;
307
307
  }
308
- interface Iban {
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
- deep?: Deep<IbanDeep>;
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 Npi {
323
- /** Normalized 10-digit NPI. Invalid input still echoes the fold. */
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
- /** Exists in the CMS NPPES registry. */
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
- /** On the OIG exclusion list. */
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<NpiDeep>;
437
+ deep?: Deep<ProviderDeep>;
348
438
  }
349
- interface NpiEnrollment {
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 NpiDeep {
356
- /** In the published Medicare FFS enrollment extract. */
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
- /** On the CMS opt-out affidavit list. Matched by NPI only. */
452
+ /** NPI-only match in the stored CMS opt-out affidavit list. Null when unavailable. */
359
453
  opt_out?: boolean | null;
360
- /** Enrollment rows. [] when medicare is false. */
361
- enrollments?: NpiEnrollment[] | null;
362
- /** Date CMS deactivated the NPI, YYYY-MM-DD. Null when still active. */
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 {
@@ -436,7 +530,7 @@ interface VinRecall {
436
530
  summary: string | null;
437
531
  }
438
532
  interface VinDeep {
439
- /** Open recall campaigns for the decoded vehicle. [] when none, null when the registry did not answer. */
533
+ /** Recall campaigns for the decoded year, make and model. [] when none, null when the registry did not answer. */
440
534
  recalls?: VinRecall[] | null;
441
535
  series: string | null;
442
536
  doors: number | null;
@@ -572,20 +666,23 @@ interface Mac {
572
666
  local: boolean | null;
573
667
  multicast: boolean | null;
574
668
  }
575
- /** Card-prefix reference data. Null means unknown, not an invalid payment card. */
576
- interface Bin {
669
+ /** Network identity from reviewed prefix rules; null means unknown or ambiguous. */
670
+ interface Card {
577
671
  bin: string;
578
- /** Actual longest matched prefix. May be shorter than the input. */
579
- prefix: string | null;
580
- country: string | null;
581
- issuer: string | null;
582
- /** Network key (visa, amex) or co-branded combination. */
583
672
  brand: string | null;
584
- /** Display name for brand (American Express). */
585
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;
586
684
  type: string | null;
587
685
  prepaid: boolean | null;
588
- deep?: Record<string, never>;
589
686
  }
590
687
  /** A published DNS record. Value is DNS presentation text, including TXT quoting. */
591
688
  interface DnsRecord {
@@ -1035,6 +1132,180 @@ interface Company {
1035
1132
  postal: string | null;
1036
1133
  deep?: Deep<CompanyDeep>;
1037
1134
  }
1135
+ /** Directory listing claims. Exchange and symbol remain separate from legal identifiers. */
1136
+ interface CompanyProfileListing {
1137
+ exchange: string;
1138
+ symbol: string;
1139
+ }
1140
+ interface CompanyProfileAddress {
1141
+ type: string;
1142
+ street: string | null;
1143
+ city: string | null;
1144
+ state: string | null;
1145
+ postal: string | null;
1146
+ country: string | null;
1147
+ }
1148
+ interface CompanyProfileJurisdiction {
1149
+ country: string | null;
1150
+ state: string | null;
1151
+ }
1152
+ interface CompanyProfileWebsite {
1153
+ domain: string;
1154
+ url: string | null;
1155
+ }
1156
+ interface CompanyProfileIdentifier {
1157
+ type: string;
1158
+ authority: string;
1159
+ value: string;
1160
+ }
1161
+ interface CompanyProfileIndustry {
1162
+ type: string;
1163
+ code: string;
1164
+ name: string | null;
1165
+ }
1166
+ /** Source-stated founding value. Precision is year, month, day, or a future open value. */
1167
+ interface CompanyProfileFounding {
1168
+ value: string;
1169
+ precision: string;
1170
+ }
1171
+ /** Reported workforce count for the stated basis, scope and measurement date. */
1172
+ interface CompanyProfileEmployees {
1173
+ count: number;
1174
+ as_of: string;
1175
+ /** Open string: headcount, full_time or full_time_equivalent. Older responses omit it. */
1176
+ basis?: string | null;
1177
+ /** Open string, currently legal_entity or consolidated_group. */
1178
+ scope: string;
1179
+ /** Open string, currently reported. */
1180
+ method: string;
1181
+ approximate: boolean;
1182
+ }
1183
+ /** Legal form recorded by a register; codes remain open strings. */
1184
+ interface CompanyProfileRegistrationLegalForm {
1185
+ code: string;
1186
+ name: string;
1187
+ }
1188
+ /** Source-recorded principal address. State and country_raw are not inferred ISO codes. */
1189
+ interface CompanyProfileRegistrationAddress {
1190
+ kind: string;
1191
+ line1: string | null;
1192
+ line2: string | null;
1193
+ city: string | null;
1194
+ state: string | null;
1195
+ postal: string | null;
1196
+ country_raw: string | null;
1197
+ }
1198
+ /** Registry-scoped legal facts; registration does not establish current operation or tax exemption. */
1199
+ interface CompanyProfileRegistration {
1200
+ authority: string;
1201
+ number: string;
1202
+ jurisdiction: CompanyProfileJurisdiction;
1203
+ role: string;
1204
+ legal_form: CompanyProfileRegistrationLegalForm;
1205
+ status: string;
1206
+ /** This register's reported entity-form date, not universal incorporation or founding. */
1207
+ formation_date: string | null;
1208
+ address: CompanyProfileRegistrationAddress | null;
1209
+ }
1210
+ /** Attribution for selected enrichment fields, not the whole company profile. */
1211
+ interface CompanyProfileSource {
1212
+ type: string;
1213
+ url: string;
1214
+ fields: string[];
1215
+ observed_at: string;
1216
+ /** Explicit source update timestamp or null; employee measurement dates remain in as_of. */
1217
+ updated_at: string | null;
1218
+ }
1219
+ /** Selected public business contacts. Purpose is source-reported or null. */
1220
+ interface CompanyProfilePhone {
1221
+ number: string;
1222
+ kind: string | null;
1223
+ }
1224
+ interface CompanyProfileEmail {
1225
+ address: string;
1226
+ kind: string | null;
1227
+ }
1228
+ /** An associated domain and its recorded URL, when known. */
1229
+ type CompanyProfileDomain = CompanyProfileWebsite;
1230
+ interface CompanySocialProfile {
1231
+ platform: string | null;
1232
+ url: string;
1233
+ handle: string | null;
1234
+ }
1235
+ interface CompanyPhoneNumber {
1236
+ number: string;
1237
+ type: string | null;
1238
+ }
1239
+ interface CompanyEmailAddress {
1240
+ address: string;
1241
+ type: string | null;
1242
+ }
1243
+ /** Directory detail, distinct from national-number CompanyDeep. Missing or null facts remain unknown. */
1244
+ interface CompanyProfileDeep {
1245
+ legal_name?: string | null;
1246
+ aliases?: string[] | null;
1247
+ jurisdiction?: CompanyProfileJurisdiction | null;
1248
+ status?: string | null;
1249
+ domains?: CompanyProfileDomain[] | null;
1250
+ social_profiles?: CompanySocialProfile[] | null;
1251
+ phone_numbers?: CompanyPhoneNumber[] | null;
1252
+ email_addresses?: CompanyEmailAddress[] | null;
1253
+ /** Earlier directory responses. */
1254
+ websites?: CompanyProfileWebsite[] | null;
1255
+ identifiers?: CompanyProfileIdentifier[] | null;
1256
+ incorporated?: string | null;
1257
+ addresses?: CompanyProfileAddress[] | null;
1258
+ industries?: CompanyProfileIndustry[] | null;
1259
+ parent?: string | null;
1260
+ description?: string | null;
1261
+ /** Returned asset URL only. The SDK does not fetch it. */
1262
+ logo?: string | null;
1263
+ socials?: string[] | null;
1264
+ phones?: CompanyProfilePhone[] | null;
1265
+ emails?: CompanyProfileEmail[] | null;
1266
+ /** Founding claim, distinct from legal incorporation. Year-only dates stay year-only. */
1267
+ founded?: CompanyProfileFounding | null;
1268
+ employees?: CompanyProfileEmployees | null;
1269
+ /** Empty means no admitted registration facts; older editions may omit this member. */
1270
+ registrations?: CompanyProfileRegistration[] | null;
1271
+ sources?: CompanyProfileSource[] | null;
1272
+ }
1273
+ interface CompanyProfile {
1274
+ id: string;
1275
+ name: string;
1276
+ country: string | null;
1277
+ website: string | null;
1278
+ listings: CompanyProfileListing[] | null;
1279
+ address: CompanyProfileAddress | null;
1280
+ deep?: Deep<CompanyProfileDeep>;
1281
+ }
1282
+ /** Why a candidate matched. Field/type/authority/exchange values remain extensible strings. */
1283
+ interface CompanyMatch {
1284
+ field?: string | null;
1285
+ value?: string | null;
1286
+ type?: string | null;
1287
+ authority?: string | null;
1288
+ exchange?: string | null;
1289
+ }
1290
+ interface CompanyCandidate extends CompanyProfile {
1291
+ match: CompanyMatch;
1292
+ }
1293
+ interface CompanySearch {
1294
+ companies: CompanyCandidate[];
1295
+ next: string | null;
1296
+ }
1297
+ /** Edition counts describe the records available, not all companies in a country. */
1298
+ interface CompanyCoverage {
1299
+ scope: string;
1300
+ label: string;
1301
+ description: string;
1302
+ snapshot_at: string;
1303
+ companies: number;
1304
+ countries: string[];
1305
+ with_website: number;
1306
+ with_listings: number;
1307
+ with_address: number;
1308
+ }
1038
1309
  /** A direct child industry code. */
1039
1310
  interface NaicsChild {
1040
1311
  naics: string;
@@ -1208,7 +1479,9 @@ interface PostalDeep {
1208
1479
  /** Median annual property tax payable on owner-occupied homes in this statistical area. Null when unsupported, missing or censored. */
1209
1480
  property_tax?: PropertyTax | null;
1210
1481
  }
1211
- interface IbanDeep {
1482
+ interface BankDeep {
1483
+ /** Source edition and exact match grain, not coverage or account verification. */
1484
+ directory?: BankDirectory;
1212
1485
  /** Two check digits as a string, keeping a leading zero. */
1213
1486
  checksum: string | null;
1214
1487
  /** Branch identifier when that country has one. */
@@ -1387,6 +1660,95 @@ interface TimeLocation {
1387
1660
  truncated: boolean;
1388
1661
  source: string;
1389
1662
  }
1663
+ type Industry = Naics;
1664
+ type IndustryChild = NaicsChild;
1665
+ type IndustryCorrection = NaicsCorrection;
1666
+ type IndustryDeep = NaicsDeep;
1667
+ type IndustryExclusion = NaicsExclusion;
1668
+ type IndustryMatch = NaicsMatch;
1669
+ type IndustrySearch = NaicsSearch;
1670
+ type IndustrySearchItem = NaicsSearchItem;
1671
+ type Vehicle = Vin;
1672
+ type VehicleDeep = VinDeep;
1673
+ type VehicleRecall = VinRecall;
1674
+ interface Iban {
1675
+ iban: string | null;
1676
+ valid: boolean;
1677
+ country: string | null;
1678
+ /** Print form in groups of four, for display. Null when invalid. */
1679
+ formatted: string | null;
1680
+ /** Bank identifier parsed from the number, not a name. */
1681
+ bank: string | null;
1682
+ /** Institution name from the national bank-code directory. Null when unsourced. */
1683
+ bank_name: string | null;
1684
+ /** BIC from that same directory. Null when unsourced or missing. */
1685
+ bic: string | null;
1686
+ deep?: Deep<IbanDeep>;
1687
+ }
1688
+ interface Npi {
1689
+ /** Normalized 10-digit NPI. Invalid input still echoes the fold. */
1690
+ npi: string | null;
1691
+ valid: boolean;
1692
+ /** Exists in the CMS NPPES registry. */
1693
+ registered: boolean | null;
1694
+ active: boolean | null;
1695
+ /** On the OIG exclusion list. */
1696
+ excluded: boolean | null;
1697
+ /** individual or organization. */
1698
+ type: string | null;
1699
+ name: string | null;
1700
+ first: string | null;
1701
+ last: string | null;
1702
+ credential: string | null;
1703
+ specialty: string | null;
1704
+ /** NUCC taxonomy code. */
1705
+ taxonomy: string | null;
1706
+ address: string | null;
1707
+ city: string | null;
1708
+ state: string | null;
1709
+ state_name: string | null;
1710
+ postal: string | null;
1711
+ country: string | null;
1712
+ phone: string | null;
1713
+ deep?: Deep<NpiDeep>;
1714
+ }
1715
+ interface NpiEnrollment {
1716
+ /** part_a, part_b, practitioner, dme, order_refer, mdpp. Null when the code is unknown. */
1717
+ type: string | null;
1718
+ specialty: string | null;
1719
+ state: string | null;
1720
+ }
1721
+ interface NpiDeep {
1722
+ /** In the published Medicare FFS enrollment extract. */
1723
+ medicare?: boolean | null;
1724
+ /** On the CMS opt-out affidavit list. Matched by NPI only. */
1725
+ opt_out?: boolean | null;
1726
+ /** Enrollment rows. [] when medicare is false. */
1727
+ enrollments?: NpiEnrollment[] | null;
1728
+ /** Date CMS deactivated the NPI, YYYY-MM-DD. Null when still active. */
1729
+ deactivated_at: string | null;
1730
+ }
1731
+ interface Bin {
1732
+ bin: string;
1733
+ /** Actual longest matched prefix. May be shorter than the input. */
1734
+ prefix: string | null;
1735
+ country: string | null;
1736
+ issuer: string | null;
1737
+ /** Network key (visa, amex) or co-branded combination. */
1738
+ brand: string | null;
1739
+ /** Display name for brand (American Express). */
1740
+ brand_name: string | null;
1741
+ type: string | null;
1742
+ prepaid: boolean | null;
1743
+ deep?: Record<string, never>;
1744
+ }
1745
+ interface IbanDeep {
1746
+ /** Two check digits as a string, keeping a leading zero. */
1747
+ checksum: string | null;
1748
+ /** Branch identifier when that country has one. */
1749
+ branch: string | null;
1750
+ account: string | null;
1751
+ }
1390
1752
 
1391
1753
  /** A proposed task contains operation counts, never lookup inputs. */
1392
1754
  interface PreflightOperation {
@@ -1494,7 +1856,9 @@ declare class ParseAPIError extends Error {
1494
1856
  readonly docs: string | null;
1495
1857
  /** Send this if you contact support */
1496
1858
  readonly requestId: string | null;
1497
- constructor(status: number, code: string, message: string, docs: string | null, requestId: string | null);
1859
+ /** Original Retry-After response header, when supplied. */
1860
+ readonly retryAfter: string | null;
1861
+ constructor(status: number, code: string, message: string, docs: string | null, requestId: string | null, retryAfter?: string | null);
1498
1862
  }
1499
1863
  /** Optional output language for supported display fields. Input parsing stays unchanged. */
1500
1864
  interface LanguageOption {
@@ -1586,6 +1950,30 @@ type AddressSearchOptions = {
1586
1950
  type CompanyOptions = LanguageOption & {
1587
1951
  country?: string;
1588
1952
  } & DeepOption & RequestOptions;
1953
+ /** Refetch a directory company by its stable co_ ID. */
1954
+ type CompanyIdOptions = DeepOption & RequestOptions;
1955
+ /** Choose at most one selector, or discover by country, exact industry. The API validates filters and cursors. */
1956
+ type CompanySearchOptions = {
1957
+ /** Company name search. Sent as q. */
1958
+ query?: string;
1959
+ domain?: string;
1960
+ ticker?: string;
1961
+ identifier?: string;
1962
+ /** ISO2 country filter. */
1963
+ country?: string;
1964
+ /** Exact four-digit SIC code string, preserving leading zeros. Requires industry_type. */
1965
+ industry?: string;
1966
+ /** Industry namespace; currently sic. Requires industry. */
1967
+ industry_type?: string;
1968
+ /** Exchange filter for ticker searches. */
1969
+ exchange?: string;
1970
+ /** Issuing authority filter for identifier searches. */
1971
+ authority?: string;
1972
+ limit?: number;
1973
+ /** Opaque next-page cursor. Keep the same selector and filters. */
1974
+ cursor?: string;
1975
+ } & DeepOption & RequestOptions;
1976
+ type CompanyCoverageOptions = RequestOptions;
1589
1977
  /** `deep: true` requests a metered deliverability check. No automatic retries by default. */
1590
1978
  type EmailOptions = DeepOption & RequestOptions;
1591
1979
  /** `deep: true` requests a metered registry check where supported. `from` is your own VAT number. */
@@ -1593,10 +1981,13 @@ type VatOptions = {
1593
1981
  country?: string;
1594
1982
  from?: string;
1595
1983
  } & DeepOption & RequestOptions;
1596
- type IbanOptions = {
1984
+ type BankOptions = {
1597
1985
  country?: string;
1598
1986
  } & DeepOption & RequestOptions;
1599
- type NpiOptions = LanguageOption & DeepOption & RequestOptions;
1987
+ type BankRequirementsOptions = {
1988
+ format?: string;
1989
+ } & RequestOptions;
1990
+ type ProviderOptions = LanguageOption & DeepOption & RequestOptions;
1600
1991
  /** Country resolves national-number ambiguity. Deep adds numbering-plan geography on every plan. */
1601
1992
  type PhoneOptions = {
1602
1993
  country?: string;
@@ -1619,8 +2010,8 @@ type StackOptions = {
1619
2010
  type DomainOptions = DeepOption & RequestOptions;
1620
2011
  type AsnOptions = LanguageOption & RequestOptions;
1621
2012
  type MacOptions = RequestOptions;
1622
- /** Card-prefix reference lookup. Deep returns an empty object on every plan. */
1623
- type BinOptions = DeepOption & RequestOptions;
2013
+ /** Request controls for a card-prefix reference lookup. */
2014
+ type CardOptions = DeepOption & RequestOptions;
1624
2015
  /** Parse a measurement, optionally converting it. Locale and system resolve explicit ambiguity. */
1625
2016
  type MeasureOptions = {
1626
2017
  to?: string;
@@ -1639,10 +2030,11 @@ type DnsOptions = {
1639
2030
  type MxOptions = RequestOptions;
1640
2031
  type UseragentOptions = DeepOption & RequestOptions;
1641
2032
  type VinOptions = DeepOption & RequestOptions;
2033
+ type VehicleOptions = VinOptions;
1642
2034
  /** US NAICS 2022 code lookup, using pooled requests. */
1643
- type NaicsOptions = DeepOption & RequestOptions;
2035
+ type IndustryOptions = DeepOption & RequestOptions;
1644
2036
  /** Keyword search. Limit defaults to 10 and accepts 1-50. */
1645
- type NaicsSearchOptions = {
2037
+ type IndustrySearchOptions = {
1646
2038
  limit?: number;
1647
2039
  } & DeepOption & RequestOptions;
1648
2040
  /** 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. */
@@ -1784,7 +2176,14 @@ declare function parseAPI(apiKey?: string, options?: ParseAPIOptions): {
1784
2176
  /** Find address suggestions using the context supplied. Prefer postal, or city and state, from the form. ip is an optional end-user locality hint for server-side calls. An empty result has reason more_input, missing_context or no_matches. Suggestions have reason null. Operational failures are errors. */
1785
2177
  search: (query: string, opts?: AddressSearchOptions) => Promise<AddressSearch>;
1786
2178
  };
1787
- company: (number: string, opts?: CompanyOptions) => Promise<Company>;
2179
+ company: ((number: string, opts?: CompanyOptions) => Promise<Company>) & {
2180
+ /** Look up a stable directory ID. Requested deep belongs to this profile. */
2181
+ id: (id: string, opts?: CompanyIdOptions) => Promise<CompanyProfile>;
2182
+ /** Return candidates without selecting a match. Use one selector, country, exact industry, filters. */
2183
+ search: (opts: CompanySearchOptions) => Promise<CompanySearch>;
2184
+ /** Describe the directory edition and its counts. Counts do not establish complete country coverage. */
2185
+ coverage: (opts?: CompanyCoverageOptions) => Promise<CompanyCoverage>;
2186
+ };
1788
2187
  /**
1789
2188
  * Parse an email and check its format and domain.
1790
2189
  * `deep: true` explicitly requests a metered deliverability check using included checks or enabled on-demand usage.
@@ -1794,7 +2193,14 @@ declare function parseAPI(apiKey?: string, options?: ParseAPIOptions): {
1794
2193
  /** Check VAT format and checksum. `deep: true` requests a metered registry check where supported, with no automatic retries by default. */
1795
2194
  vat: (number: string, opts?: VatOptions) => Promise<Vat>;
1796
2195
  iban: (iban: string, opts?: IbanOptions) => Promise<Iban>;
2196
+ bin: (bin: string, opts?: BinOptions) => Promise<Bin>;
1797
2197
  npi: (npi: string, opts?: NpiOptions) => Promise<Npi>;
2198
+ bank: (iban: string, opts?: BankOptions) => Promise<Bank>;
2199
+ /** Check US routing/account syntax using POST. Does not verify ownership, existence or ACH eligibility. */
2200
+ bankUsAch: (input: BankUsAchInput, opts?: RequestOptions) => Promise<BankUsAch>;
2201
+ /** Describe supported input fields and check scope; this does not establish country directory coverage. */
2202
+ bankRequirements: (country: string, opts?: BankRequirementsOptions) => Promise<BankRequirements>;
2203
+ provider: (npi: string, opts?: ProviderOptions) => Promise<Provider>;
1798
2204
  /** Parse a phone number and its formats. Pass country for national numbers when needed. Deep adds numbering-plan geography. */
1799
2205
  phone: (number: string, opts?: PhoneOptions) => Promise<Phone>;
1800
2206
  /** Request a metered carrier lookup. No automatic retries by default. */
@@ -1809,8 +2215,8 @@ declare function parseAPI(apiKey?: string, options?: ParseAPIOptions): {
1809
2215
  domain: (domain: string, opts?: DomainOptions) => Promise<Domain>;
1810
2216
  asn: (asn: string, opts?: AsnOptions) => Promise<Asn>;
1811
2217
  mac: (mac: string, opts?: MacOptions) => Promise<Mac>;
1812
- /** Look up a 6-11 digit card prefix. Keep leading zeros in the input string. */
1813
- bin: (bin: string, opts?: BinOptions) => Promise<Bin>;
2218
+ /** Look up a 2-11 digit card prefix. Keep leading zeros in the input string. */
2219
+ card: (bin: string, opts?: CardOptions) => Promise<Card>;
1814
2220
  /** Parse a measurement or convert it to `to`. Without `to`, use its type's canonical unit. Invalid input is plain data with `valid: false`. */
1815
2221
  measure: ((measure: string, opts?: MeasureOptions) => Promise<Measure>) & {
1816
2222
  /** Discover reviewed units. Pass `unit` to find compatible conversion targets. */
@@ -1820,10 +2226,17 @@ declare function parseAPI(apiKey?: string, options?: ParseAPIOptions): {
1820
2226
  dns: (domain: string, opts?: DnsOptions) => Promise<Dns>;
1821
2227
  mx: (domain: string, opts?: MxOptions) => Promise<Mx>;
1822
2228
  useragent: (ua: string, opts?: UseragentOptions) => Promise<Useragent>;
2229
+ /** Identify a vehicle by VIN. Paid deep adds specifications and model-level recall campaigns. */
2230
+ vehicle: (vin: string, opts?: VehicleOptions) => Promise<Vehicle>;
2231
+ /** Compatibility entry for VIN callers. */
1823
2232
  vin: (vin: string, opts?: VinOptions) => Promise<Vin>;
1824
2233
  /** US NAICS 2022 definitions and hierarchy. */
1825
- naics: ((code: string, opts?: NaicsOptions) => Promise<Naics>) & {
1826
- search: (query: string, opts?: NaicsSearchOptions) => Promise<NaicsSearch>;
2234
+ industry: ((code: string, opts?: IndustryOptions) => Promise<Industry>) & {
2235
+ search: (query: string, opts?: IndustrySearchOptions) => Promise<IndustrySearch>;
2236
+ };
2237
+ /** Compatibility name for industry. */
2238
+ naics: ((code: string, opts?: IndustryOptions) => Promise<Industry>) & {
2239
+ search: (query: string, opts?: IndustrySearchOptions) => Promise<IndustrySearch>;
1827
2240
  };
1828
2241
  /** 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. */
1829
2242
  tariff: ((code: string, opts?: TariffOptions) => Promise<Tariff>) & {
@@ -1864,5 +2277,13 @@ declare function parseAPI(apiKey?: string, options?: ParseAPIOptions): {
1864
2277
  };
1865
2278
  };
1866
2279
  type ParseAPIClient = ReturnType<typeof parseAPI>;
2280
+ /** Existing NAICS options remain source compatible. */
2281
+ type NaicsOptions = IndustryOptions;
2282
+ type NaicsSearchOptions = IndustrySearchOptions;
2283
+ type IbanOptions = {
2284
+ country?: string;
2285
+ } & DeepOption & RequestOptions;
2286
+ type NpiOptions = LanguageOption & DeepOption & RequestOptions;
2287
+ type BinOptions = DeepOption & RequestOptions;
1867
2288
 
1868
- 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 };
2289
+ 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 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 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 };