@parseapi/sdk 0.3.2 → 0.4.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
@@ -1,6 +1,6 @@
1
1
  /**
2
2
  * Response types for the ParseAPI public API.
3
- * Shapes are append-only upstream, so these only ever grow.
3
+ * Core answers the common task; optional deep reveals the reviewed detail.
4
4
  * Every field inside a deep object is optional and nullable: the API ships
5
5
  * `deep: {}` when deep was requested but is not unlocked on the plan.
6
6
  */
@@ -8,6 +8,29 @@
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
+ reason: string | null;
23
+ choices: MeasureChoice[];
24
+ }
25
+ interface MeasureUnit {
26
+ unit: string;
27
+ name: string;
28
+ type: string;
29
+ aliases: string[];
30
+ }
31
+ interface MeasureUnits {
32
+ units: MeasureUnit[];
33
+ }
11
34
  interface IpDeep {
12
35
  state: string;
13
36
  city: string;
@@ -33,6 +56,8 @@ interface Continent {
33
56
  region: string;
34
57
  subregion: string;
35
58
  population: number | null;
59
+ /** Reporting year or period for population (YYYY or YYYY-YYYY). Null when unknown or unverifiable. */
60
+ population_period?: string | null;
36
61
  area: number | null;
37
62
  emoji: string;
38
63
  }
@@ -64,30 +89,18 @@ interface BlocCountries {
64
89
  }
65
90
  interface Country {
66
91
  country: string;
67
- iso3: string;
68
- numeric: number;
69
92
  name: string;
70
- full_name: string | null;
71
- local_name: string | null;
72
- demonym: string | null;
73
- capital: string | null;
74
- capital_lat: number | null;
75
- capital_lon: number | null;
93
+ name_local: string | null;
76
94
  continent: string;
77
- region: string | null;
78
- subregion: string | null;
79
- population: number | null;
80
- area: number | null;
81
95
  currency: string | null;
82
96
  currency_name: string | null;
83
97
  currency_symbol: string | null;
84
- tld: string | null;
85
98
  calling_code: string | null;
86
99
  emoji: string | null;
87
100
  languages: string[];
88
- borders: string[];
89
- /** Bloc memberships (EU, SCHENGEN, NATO, ...). Empty when none. */
90
- blocs: string[];
101
+ deep?: Deep<CountryDeep>;
102
+ /** IANA timezones used by the country. */
103
+ timezones: string[] | null;
91
104
  }
92
105
  interface CountryStateItem {
93
106
  state: string;
@@ -101,28 +114,27 @@ interface CountryStates {
101
114
  interface State {
102
115
  state: string;
103
116
  name: string;
104
- local_name: string | null;
117
+ name_local: string | null;
105
118
  type: string | null;
106
119
  country: string;
107
120
  country_name: string | null;
108
121
  latitude: number | null;
109
122
  longitude: number | null;
110
- population: number | null;
111
- /** Total area in km2. */
112
- area: number | null;
113
123
  timezone: string | null;
114
124
  timezones: string[];
115
125
  iso_3166_2: string | null;
116
- fips: string | null;
117
- capital: string | null;
118
- area_codes: string[];
119
- tax: string | null;
120
- tax_rate: number | null;
126
+ deep?: Deep<StateDeep>;
121
127
  }
122
128
  interface StateDistrictItem {
123
- district: string;
124
- name: string;
129
+ district: string | null;
130
+ name: string | null;
125
131
  type: string | null;
132
+ deep?: Deep<StateDistrictDeep>;
133
+ }
134
+ interface StateDistrictDeep {
135
+ population: number | null;
136
+ /** Reporting year or period for population (YYYY or YYYY-YYYY). Null when unknown or unverifiable. */
137
+ population_period?: string | null;
126
138
  }
127
139
  interface StateDistricts {
128
140
  state: string;
@@ -141,23 +153,14 @@ interface District {
141
153
  country_name: string | null;
142
154
  latitude: number | null;
143
155
  longitude: number | null;
144
- population: number | null;
145
- /** Total area in km2 (land + water, or the official total). */
146
- area: number | null;
147
- /** Land area in km2. Null when the source publishes total only. */
148
- land_area: number | null;
149
- /** Water area in km2. Null when the source publishes total only. */
150
- water_area: number | null;
151
- seat: string | null;
152
156
  timezone: string | null;
153
157
  timezones: string[];
158
+ deep?: Deep<DistrictDeep>;
154
159
  }
155
160
  interface City {
156
161
  name: string;
157
- local_name: string | null;
162
+ name_local: string | null;
158
163
  type: string | null;
159
- /** What this city is the capital of: country, state, or null. */
160
- capital_of: 'country' | 'state' | null;
161
164
  state: string | null;
162
165
  state_name: string | null;
163
166
  district: string | null;
@@ -166,18 +169,10 @@ interface City {
166
169
  country_name: string | null;
167
170
  latitude: number | null;
168
171
  longitude: number | null;
169
- elevation: number | null;
170
- elevation_ft: number | null;
171
- population: number | null;
172
- /** Total area in km2 (land + water, or the official total). */
173
- area: number | null;
174
- /** Land area in km2. Null when the source publishes total only. */
175
- land_area: number | null;
176
- /** Water area in km2. Null when the source publishes total only. */
177
- water_area: number | null;
178
172
  timezone: string | null;
179
173
  /** Minted parse id (`city_` + 12 chars). Stable pin via `/city/id/{id}`. */
180
174
  id: string;
175
+ deep?: Deep<CityDeep>;
181
176
  }
182
177
  /** Nearest-city lookups add the distance from the query point. */
183
178
  interface CityNearest extends City {
@@ -222,20 +217,8 @@ interface Postal {
222
217
  country_name: string | null;
223
218
  latitude: number | null;
224
219
  longitude: number | null;
225
- elevation: number | null;
226
- elevation_ft: number | null;
227
- population: number | null;
228
- /** Total area in km2. Null when the source has no water split. */
229
- area: number | null;
230
- /** Land area in km2. Null where the source has none. */
231
- land_area: number | null;
232
- /** Water area in km2. Null where the source has none. */
233
- water_area: number | null;
234
220
  timezone: string | null;
235
- currency: string | null;
236
- neighbors: string[];
237
- /** Missing/null is unknown; [] is an observed result outside all covered areas. */
238
- metros?: PostalMetro[] | null;
221
+ deep?: Deep<PostalDeep>;
239
222
  }
240
223
  interface PostalNearbyItem {
241
224
  postal: string;
@@ -244,20 +227,20 @@ interface PostalNearbyItem {
244
227
  country: string;
245
228
  distance: number;
246
229
  distance_mi: number;
247
- metros?: PostalMetro[] | null;
230
+ deep?: Deep<PostalMetrosDeep>;
248
231
  }
249
232
  interface PostalNearby {
250
233
  postal: string;
251
234
  country: string;
252
235
  radius: number;
253
236
  unit: string;
254
- metros?: PostalMetro[] | null;
255
237
  nearby: PostalNearbyItem[];
238
+ deep?: Deep<PostalMetrosDeep>;
256
239
  }
257
240
  interface PostalDistanceEnd {
258
241
  postal: string;
259
242
  city: string | null;
260
- metros?: PostalMetro[] | null;
243
+ deep?: Deep<PostalMetrosDeep>;
261
244
  }
262
245
  interface PostalDistance {
263
246
  country: string;
@@ -291,7 +274,7 @@ interface VatDeep {
291
274
  name: string | null;
292
275
  address: VatAddress | null;
293
276
  consultation: string | null;
294
- /** Registry timestamp of this check, ISO. */
277
+ /** Registry-provided check time, or null when unavailable. */
295
278
  consulted_at: string | null;
296
279
  }
297
280
  interface Vat {
@@ -307,17 +290,13 @@ interface Iban {
307
290
  country: string | null;
308
291
  /** Print form in groups of four, for display. Null when invalid. */
309
292
  formatted: string | null;
310
- /** Two check digits as a string, keeping a leading zero. */
311
- checksum: string | null;
312
293
  /** Bank identifier parsed from the number, not a name. */
313
294
  bank: string | null;
314
295
  /** Institution name from the national bank-code directory. Null when unsourced. */
315
296
  bank_name: string | null;
316
297
  /** BIC from that same directory. Null when unsourced or missing. */
317
298
  bic: string | null;
318
- /** Branch identifier when that country has one. */
319
- branch: string | null;
320
- account: string | null;
299
+ deep?: Deep<IbanDeep>;
321
300
  }
322
301
  interface Npi {
323
302
  /** Normalized 10-digit NPI. Invalid input still echoes the fold. */
@@ -326,8 +305,6 @@ interface Npi {
326
305
  /** Exists in the CMS NPPES registry. */
327
306
  registered: boolean | null;
328
307
  active: boolean | null;
329
- /** Date CMS deactivated the NPI, YYYY-MM-DD. Null when still active. */
330
- deactivated_at: string | null;
331
308
  /** On the OIG exclusion list. */
332
309
  excluded: boolean | null;
333
310
  /** individual or organization. */
@@ -361,6 +338,8 @@ interface NpiDeep {
361
338
  opt_out?: boolean | null;
362
339
  /** Enrollment rows. [] when medicare is false. */
363
340
  enrollments?: NpiEnrollment[] | null;
341
+ /** Date CMS deactivated the NPI, YYYY-MM-DD. Null when still active. */
342
+ deactivated_at: string | null;
364
343
  }
365
344
  interface TariffMeasure {
366
345
  /** Chapter 99 heading, dotted (9903.01.24). */
@@ -373,6 +352,8 @@ interface TariffMeasure {
373
352
  from: string | null;
374
353
  /** Expires, ISO YYYY-MM-DD. Null when open-ended. */
375
354
  until: string | null;
355
+ /** True when the published measure has additional eligibility conditions. */
356
+ conditional?: boolean | null;
376
357
  }
377
358
  interface TariffDeep {
378
359
  /** The origin country the measures were resolved for. */
@@ -381,6 +362,12 @@ interface TariffDeep {
381
362
  effective_rate?: number | null;
382
363
  /** Every Chapter 99 tariff measure that applies to this code from this origin. */
383
364
  measures?: TariffMeasure[] | null;
365
+ /** Units of quantity (No., kg). */
366
+ units: string[];
367
+ /** Column 1 special rate, verbatim. */
368
+ special: string | null;
369
+ /** Column 2 rate, verbatim. */
370
+ other: string | null;
384
371
  }
385
372
  interface Tariff {
386
373
  /** Normalized code with dots (8471.30.01.00). */
@@ -389,14 +376,8 @@ interface Tariff {
389
376
  description: string;
390
377
  /** Parent descriptions from the schedule outline, outermost first. */
391
378
  lineage: string[];
392
- /** Units of quantity (No., kg). */
393
- units: string[];
394
379
  /** Column 1 general rate, verbatim. */
395
380
  general: string | null;
396
- /** Column 1 special rate, verbatim. */
397
- special: string | null;
398
- /** Column 2 rate, verbatim. */
399
- other: string | null;
400
381
  /** The official release that answered (2026HTSRev17). */
401
382
  revision: string;
402
383
  deep?: Deep<TariffDeep>;
@@ -424,20 +405,7 @@ interface VinRecall {
424
405
  interface VinDeep {
425
406
  /** Open recall campaigns for the decoded vehicle. [] when none, null when the registry did not answer. */
426
407
  recalls?: VinRecall[] | null;
427
- }
428
- interface Vin {
429
- /** Normalized VIN, uppercase, no spaces. Invalid input still echoes the fold. */
430
- vin: string | null;
431
- valid: boolean;
432
- year: number | null;
433
- make: string | null;
434
- model: string | null;
435
- trim: string | null;
436
408
  series: string | null;
437
- /** Body style (sedan, coupe, suv, pickup). */
438
- body: string | null;
439
- /** Vehicle type (passenger car, truck, motorcycle, bus, trailer). */
440
- type: string | null;
441
409
  doors: number | null;
442
410
  cylinders: number | null;
443
411
  /** Engine displacement in liters. */
@@ -454,6 +422,19 @@ interface Vin {
454
422
  plant_country: string | null;
455
423
  /** Gross vehicle weight rating class as filed. */
456
424
  gvwr: string | null;
425
+ }
426
+ interface Vin {
427
+ /** Normalized VIN, uppercase, no spaces. Invalid input still echoes the fold. */
428
+ vin: string | null;
429
+ valid: boolean;
430
+ year: number | null;
431
+ make: string | null;
432
+ model: string | null;
433
+ trim: string | null;
434
+ /** Body style (sedan, coupe, suv, pickup). */
435
+ body: string | null;
436
+ /** Vehicle type (passenger car, truck, motorcycle, bus, trailer). */
437
+ type: string | null;
457
438
  deep?: Deep<VinDeep>;
458
439
  }
459
440
  interface Phone {
@@ -462,15 +443,9 @@ interface Phone {
462
443
  country: string | null;
463
444
  /** What the numbering plan can see. Never voip (that is the carrier field's word). Null when invalid. */
464
445
  type: 'mobile' | 'landline' | 'toll_free' | 'unknown' | null;
465
- /** NPA-derived state code (US/CA). */
466
- state: string | null;
467
- state_name: string | null;
468
- /** Numbering-plan IANA zone. Null when the prefix covers more than one zone, or invalid. Not the handset. */
469
- timezone: string | null;
470
446
  national: string | null;
471
447
  international: string | null;
472
- /** Always empty. The metered proves are their own endpoints: carrier, caller, hlr. */
473
- deep?: Record<string, never>;
448
+ deep?: Deep<PhoneDeep>;
474
449
  }
475
450
  interface Carrier {
476
451
  phone: string | null;
@@ -482,10 +457,7 @@ interface Carrier {
482
457
  carrier: string | null;
483
458
  /** Carrier is a known burner number app. Null when carrier is unknown. */
484
459
  burner: boolean | null;
485
- /** Issuing rate-center city. */
486
- city: string | null;
487
- state: string | null;
488
- state_name: string | null;
460
+ deep?: Deep<CarrierDeep>;
489
461
  }
490
462
  interface Caller {
491
463
  phone: string | null;
@@ -498,20 +470,11 @@ interface Hlr {
498
470
  phone: string | null;
499
471
  valid: boolean;
500
472
  country: string | null;
501
- /** Assigned to a subscriber. Null when invalid. */
473
+ /** Assigned to a subscriber at the last check. Null means unconfirmed. */
502
474
  live: boolean | null;
503
- /** Handset reachable right now. Null means unconfirmed, never no. */
475
+ /** Handset reachable at the last check. Null means unconfirmed, never no. */
504
476
  connected: boolean | null;
505
- /** The six network extras fill on live HLR dips only. Null elsewhere (NANP, failover). */
506
- roaming: boolean | null;
507
- roaming_network: string | null;
508
- /** ISO2, uppercase. */
509
- roaming_country: string | null;
510
- /** Current serving network name. */
511
- network: string | null;
512
- original_network: string | null;
513
- mcc: string | null;
514
- mnc: string | null;
477
+ deep?: Deep<HlrDeep>;
515
478
  }
516
479
  interface MxRecord {
517
480
  priority: number;
@@ -527,12 +490,6 @@ interface DomainRegistration {
527
490
  dnssec: boolean;
528
491
  }
529
492
  interface DomainDeep {
530
- a: string[];
531
- aaaa: string[];
532
- ns: string[];
533
- mx: MxRecord[];
534
- txt: string[];
535
- mailhost: string;
536
493
  registration: DomainRegistration;
537
494
  }
538
495
  interface Domain {
@@ -555,6 +512,30 @@ interface Mac {
555
512
  local: boolean | null;
556
513
  multicast: boolean | null;
557
514
  }
515
+ /** Card-prefix reference data. Null means unknown, not an invalid payment card. */
516
+ interface Bin {
517
+ bin: string;
518
+ /** Actual longest matched prefix. May be shorter than the input. */
519
+ prefix: string | null;
520
+ country: string | null;
521
+ issuer: string | null;
522
+ brand: string | null;
523
+ type: string | null;
524
+ prepaid: boolean | null;
525
+ deep?: Record<string, never>;
526
+ }
527
+ /** A published DNS record. Value is DNS presentation text, including TXT quoting. */
528
+ interface DnsRecord {
529
+ name: string;
530
+ type: string;
531
+ /** Remaining cache lifetime in seconds. */
532
+ ttl: number;
533
+ value: string;
534
+ }
535
+ interface Dns {
536
+ domain: string;
537
+ records: DnsRecord[];
538
+ }
558
539
  interface Mx {
559
540
  domain: string;
560
541
  mx: MxRecord[];
@@ -605,23 +586,20 @@ interface Useragent {
605
586
  }
606
587
  interface Currency {
607
588
  currency: string;
608
- numeric: number | null;
609
589
  name: string;
610
- name_plural: string | null;
611
590
  symbol: string | null;
612
591
  symbol_native: string | null;
613
592
  digits: number | null;
614
- countries: string[];
593
+ deep?: Deep<CurrencyDeep>;
615
594
  }
616
595
  /** One language by BCP 47 shortest code (en) or ISO 639-3 (eng). Codes are lowercase. */
617
596
  interface Language {
618
597
  language: string;
619
- iso3: string | null;
620
598
  name: string;
621
- local_name: string | null;
599
+ name_local: string | null;
622
600
  script: string | null;
623
601
  direction: 'ltr' | 'rtl' | string;
624
- countries: string[];
602
+ deep?: Deep<LanguageDeep>;
625
603
  }
626
604
  /** A parsed person name. Junk input returns valid: false, never an error. Gender comes from dictionary data and is null when the data does not decide. */
627
605
  interface Name {
@@ -632,8 +610,7 @@ interface Name {
632
610
  middle: string | null;
633
611
  last: string | null;
634
612
  suffix: string | null;
635
- gender: 'male' | 'female' | null;
636
- salutation: 'Mr' | 'Ms' | null;
613
+ deep?: Deep<NameDeep>;
637
614
  }
638
615
  interface CurrencyRate {
639
616
  base: string;
@@ -656,26 +633,29 @@ interface Timezone {
656
633
  latitude?: number;
657
634
  longitude?: number;
658
635
  timezone: string | null;
659
- name: string | null;
660
636
  abbreviation: string | null;
661
637
  offset: string | null;
662
- offset_minutes: number | null;
663
638
  dst: boolean | null;
664
- next_dst: TimezoneNextDst | null;
665
- /** With to= only: the resolved wall time in the from zone, ISO with its UTC offset. */
666
- at?: string;
639
+ /** Resolved local ISO time with its UTC offset. */
640
+ at: string | null;
641
+ /** Unix seconds for the resolved instant. */
642
+ unix: number | null;
667
643
  /** With to= only: the other zone at the same instant. to.at is the converted time. */
668
- to?: TimezoneConversionTarget;
644
+ to?: TimezoneConversionTarget | null;
645
+ deep?: Deep<TimezoneDeep>;
646
+ }
647
+ /** Current time and timezone facts. Null clock fields mean the coordinates did not resolve. */
648
+ interface Time extends Timezone {
669
649
  }
670
650
  /** The other side of a timezone conversion. `at` is the converted wall time. */
671
651
  interface TimezoneConversionTarget {
672
652
  timezone: string;
673
- name: string | null;
674
653
  abbreviation: string | null;
675
654
  offset: string;
676
- offset_minutes: number;
677
655
  dst: boolean;
678
656
  at: string;
657
+ unix: number;
658
+ deep?: Deep<TimezoneConversionTargetDeep>;
679
659
  }
680
660
  /**
681
661
  * Calendar facts for one date. Junk or ambiguous input returns valid: false,
@@ -684,32 +664,18 @@ interface TimezoneConversionTarget {
684
664
  interface DateInfo {
685
665
  date: string;
686
666
  valid: boolean;
687
- year: number | null;
688
- month: number | null;
689
- month_name: string | null;
690
- day: number | null;
691
- /** ISO weekday, Monday 1 to Sunday 7. */
692
- weekday: number | null;
693
- weekday_name: string | null;
694
- /** ISO 8601 week number. */
695
- week: number | null;
696
- /** The year that ISO week belongs to. Differs from year around January 1. */
697
- week_year: number | null;
698
- day_of_year: number | null;
699
- quarter: number | null;
700
- leap: boolean | null;
701
- days_in_month: number | null;
702
667
  /** Unix time at midnight UTC of that date, seconds. */
703
668
  unix: number | null;
704
669
  /** With to= only: the other date, normalized ISO. */
705
670
  to?: string;
706
671
  /** With to= only: signed days to the other date. Future positive. */
707
672
  days?: number | null;
673
+ deep?: Deep<DateInfoDeep>;
708
674
  }
709
675
  interface Holiday {
710
676
  date: string;
711
677
  name: string;
712
- local_name: string | null;
678
+ name_local: string | null;
713
679
  /** 'public' for an official day off, 'observance' for cultural days. */
714
680
  type: string;
715
681
  regions: string[] | null;
@@ -733,8 +699,10 @@ interface Elevation {
733
699
  resolution: number | null;
734
700
  }
735
701
  interface PointDeep {
736
- city: CityNearest | null;
737
- timezone: Timezone | null;
702
+ city: PointCity | null;
703
+ elevation: number | null;
704
+ elevation_ft: number | null;
705
+ resolution: number | null;
738
706
  }
739
707
  interface Point {
740
708
  latitude: number;
@@ -745,10 +713,8 @@ interface Point {
745
713
  state_name: string | null;
746
714
  district: string | null;
747
715
  district_name: string | null;
748
- elevation: number | null;
749
- elevation_ft: number | null;
750
- resolution: number | null;
751
716
  deep?: Deep<PointDeep>;
717
+ timezone: string | null;
752
718
  }
753
719
  interface WeatherForecastPeriod {
754
720
  name: string;
@@ -844,24 +810,18 @@ interface WeatherDeep {
844
810
  air: WeatherAir | null;
845
811
  /** Only present when the call carried ?date=. */
846
812
  history?: WeatherHistory | null;
813
+ /** Specialist measurements for the same observed current conditions. */
814
+ current: WeatherCurrentDeep;
847
815
  }
848
816
  interface WeatherCurrent {
849
817
  temperature: number | null;
850
818
  temperature_f: number | null;
851
819
  feels_like: number | null;
852
820
  feels_like_f: number | null;
853
- dewpoint: number | null;
854
- dewpoint_f: number | null;
855
821
  humidity: number | null;
856
822
  wind_speed: number | null;
857
823
  wind_speed_mph: number | null;
858
- wind_gust: number | null;
859
- wind_gust_mph: number | null;
860
824
  wind_direction: number | null;
861
- pressure: number | null;
862
- pressure_inhg: number | null;
863
- visibility: number | null;
864
- visibility_mi: number | null;
865
825
  condition: string | null;
866
826
  condition_name: string | null;
867
827
  condition_emoji: string | null;
@@ -873,16 +833,11 @@ interface WeatherStation {
873
833
  distance: number | null;
874
834
  distance_mi: number | null;
875
835
  }
876
- interface WeatherSource {
877
- id: string;
878
- name: string | null;
879
- }
880
836
  interface Weather {
881
837
  latitude: number;
882
838
  longitude: number;
883
839
  current: WeatherCurrent;
884
840
  station: WeatherStation | null;
885
- source: WeatherSource;
886
841
  deep?: Deep<WeatherDeep>;
887
842
  }
888
843
  interface EmojiSkin {
@@ -895,13 +850,8 @@ interface Emoji {
895
850
  emoji: string;
896
851
  name: string;
897
852
  shortcodes: string[];
898
- codepoints: string[];
899
- hex: string;
900
853
  category: string | null;
901
- status: string | null;
902
- version: string | null;
903
- keywords: string[];
904
- skins: EmojiSkin[];
854
+ deep?: Deep<EmojiDeep>;
905
855
  }
906
856
  interface EmojiSearch {
907
857
  q: string;
@@ -944,16 +894,26 @@ interface AddressSearch {
944
894
  state?: string | null;
945
895
  country?: string | null;
946
896
  addresses: AddressSuggestion[];
897
+ /** Why suggestions are empty: more_input, missing_context or no_matches. Null with suggestions. Open to future values. Operational failures are errors. */
898
+ reason?: string | null;
947
899
  }
948
900
  interface CompanyCountry {
949
901
  name: string | null;
950
902
  blocs: string[];
903
+ /** Levy name, such as VAT, GST or sales tax. Null when unknown or not applicable. */
951
904
  tax: string | null;
952
905
  }
953
906
  interface CompanyDeep {
954
- country: CompanyCountry | null;
955
- postal: Postal | null;
956
- city: City | null;
907
+ activity: string | null;
908
+ state_name: string | null;
909
+ country_name: string | null;
910
+ vat: string | null;
911
+ gst: boolean | null;
912
+ acn: string | null;
913
+ siren: string | null;
914
+ siege: boolean | null;
915
+ kind: string | null;
916
+ invoice: string | null;
957
917
  }
958
918
  interface Company {
959
919
  company: string | null;
@@ -963,22 +923,303 @@ interface Company {
963
923
  type: string | null;
964
924
  name: string | null;
965
925
  active: boolean | null;
966
- activity: string | null;
967
926
  address: string | null;
968
927
  city: string | null;
969
928
  state: string | null;
970
- state_name: string | null;
971
929
  postal: string | null;
972
- country_name: string | null;
973
- vat: string | null;
974
- gst: boolean | null;
975
- acn: string | null;
976
- siren: string | null;
977
- siege: boolean | null;
978
- kind: string | null;
979
- invoice: string | null;
980
930
  deep?: Deep<CompanyDeep>;
981
931
  }
932
+ /** A direct child industry code. */
933
+ interface NaicsChild {
934
+ naics: string;
935
+ name: string;
936
+ }
937
+ /** A classification exclusion. Generic exclusions can have no linked codes. */
938
+ interface NaicsExclusion {
939
+ description: string;
940
+ codes: NaicsChild[];
941
+ }
942
+ /** A query token corrected only during typo fallback. */
943
+ interface NaicsCorrection {
944
+ from: string;
945
+ to: string;
946
+ }
947
+ /** The actual title, activity term or code that matched a search. */
948
+ interface NaicsMatch {
949
+ /** Currently name, term or naics. Future fields remain decodable. */
950
+ field: string;
951
+ text: string;
952
+ /** Empty for exact, plural and prefix matches. */
953
+ corrections: NaicsCorrection[];
954
+ }
955
+ /** US NAICS 2022 definition and hierarchy, including two-digit sector ranges. */
956
+ interface Naics {
957
+ naics: string;
958
+ name: string;
959
+ /** Hierarchy depth, from 2 (sector) to 6 (national industry). */
960
+ level: number;
961
+ parent: string | null;
962
+ parent_name: string | null;
963
+ /** Search evidence. Omitted on direct lookup and older responses. */
964
+ match?: NaicsMatch | null;
965
+ year: number;
966
+ country: string;
967
+ deep?: Deep<NaicsDeep>;
968
+ }
969
+ /** Search records inherit country and revision from their envelope. */
970
+ type NaicsSearchItem = Omit<Naics, 'country' | 'year'>;
971
+ interface NaicsSearch {
972
+ q: string;
973
+ year: number;
974
+ country: string;
975
+ results: NaicsSearchItem[];
976
+ }
977
+ interface CountryDeep {
978
+ iso3: string;
979
+ numeric: number;
980
+ full_name: string | null;
981
+ demonym: string | null;
982
+ capital: string | null;
983
+ capital_lat: number | null;
984
+ capital_lon: number | null;
985
+ region: string | null;
986
+ subregion: string | null;
987
+ population: number | null;
988
+ /** Reporting year or period for population (YYYY or YYYY-YYYY). Null when unknown or unverifiable. */
989
+ population_period?: string | null;
990
+ area: number | null;
991
+ tld: string | null;
992
+ /** Levy name, such as VAT, GST or sales tax. Null when unknown or not applicable. */
993
+ tax?: string | null;
994
+ /** Standard country reference rate in percent (19 means 19%). Null is unknown, zero is known zero. */
995
+ tax_rate?: number | null;
996
+ /** Tax registration number mask (9 is a digit, A is a letter). Describes format only. */
997
+ tax_id_format?: string | null;
998
+ /** Anchored tax registration number format regex. A match does not establish registration. */
999
+ tax_id_regex?: string | null;
1000
+ borders: string[];
1001
+ /** Bloc memberships (EU, SCHENGEN, NATO, ...). Empty when none. */
1002
+ blocs: string[];
1003
+ week_start: string | null;
1004
+ units: string | null;
1005
+ driving_side: string | null;
1006
+ plugs: string[] | null;
1007
+ voltage: number | null;
1008
+ frequency: number | null;
1009
+ emergency: CountryEmergency | null;
1010
+ postal_format: string | null;
1011
+ postal_regex: string | null;
1012
+ ioc: string | null;
1013
+ fifa: string | null;
1014
+ plate: string | null;
1015
+ }
1016
+ interface StateDeep {
1017
+ population: number | null;
1018
+ /** Reporting year or period for population (YYYY or YYYY-YYYY). Null when unknown or unverifiable. */
1019
+ population_period?: string | null;
1020
+ /** Total area in km2. */
1021
+ area: number | null;
1022
+ fips: string | null;
1023
+ capital: string | null;
1024
+ area_codes: string[];
1025
+ /** Levy name, such as VAT, GST or sales tax. Null when unknown or not applicable. */
1026
+ tax: string | null;
1027
+ /** State or province reference rate in percent. Country, state and postal rates are alternative references, not additive. */
1028
+ tax_rate: number | null;
1029
+ }
1030
+ interface DistrictDeep {
1031
+ population: number | null;
1032
+ /** Reporting year or period for population (YYYY or YYYY-YYYY). Null when unknown or unverifiable. */
1033
+ population_period?: string | null;
1034
+ /** Total area in km2 (land + water, or the official total). */
1035
+ area: number | null;
1036
+ /** Land area in km2. Null when the source publishes total only. */
1037
+ land_area: number | null;
1038
+ /** Water area in km2. Null when the source publishes total only. */
1039
+ water_area: number | null;
1040
+ seat: string | null;
1041
+ /** Median annual property tax payable on owner-occupied homes in this statistical area. Null when unsupported, missing or censored. */
1042
+ property_tax?: PropertyTax | null;
1043
+ }
1044
+ interface CityDeep {
1045
+ /** What this city is the capital of: country, state, or null. */
1046
+ capital_of: 'country' | 'state' | null;
1047
+ elevation: number | null;
1048
+ elevation_ft: number | null;
1049
+ population: number | null;
1050
+ /** Reporting year or period for population (YYYY or YYYY-YYYY). Null when unknown or unverifiable. */
1051
+ population_period?: string | null;
1052
+ /** Total area in km2 (land + water, or the official total). */
1053
+ area: number | null;
1054
+ /** Land area in km2. Null when the source publishes total only. */
1055
+ land_area: number | null;
1056
+ /** Water area in km2. Null when the source publishes total only. */
1057
+ water_area: number | null;
1058
+ }
1059
+ interface PostalDeep {
1060
+ elevation: number | null;
1061
+ elevation_ft: number | null;
1062
+ population: number | null;
1063
+ /** Reporting year or period for population (YYYY or YYYY-YYYY). Null when unknown or unverifiable. */
1064
+ population_period?: string | null;
1065
+ /** Total area in km2. Null when the source has no water split. */
1066
+ area: number | null;
1067
+ /** Land area in km2. Null where the source has none. */
1068
+ land_area: number | null;
1069
+ /** Water area in km2. Null where the source has none. */
1070
+ water_area: number | null;
1071
+ currency: string | null;
1072
+ /** Levy name, such as VAT, GST or sales tax. Null when unknown or not applicable. */
1073
+ tax?: string | null;
1074
+ /** Combined US ZIP reference rate in percent (7.9 means 7.9%). An exact address can differ. Null is unknown, zero is known zero. */
1075
+ tax_rate?: number | null;
1076
+ /** State component of the ZIP reference rate, in percent. Null when unknown. */
1077
+ tax_rate_state?: number | null;
1078
+ /** County component of the ZIP reference rate, in percent. Null when unknown. */
1079
+ tax_rate_county?: number | null;
1080
+ /** City component of the ZIP reference rate, in percent. Null when unknown. */
1081
+ tax_rate_city?: number | null;
1082
+ /** Special component of the ZIP reference rate, in percent. Null when unknown. */
1083
+ tax_rate_special?: number | null;
1084
+ neighbors: string[];
1085
+ /** Missing/null is unknown; [] is an observed result outside all covered areas. */
1086
+ metros?: PostalMetro[] | null;
1087
+ /** Median annual property tax payable on owner-occupied homes in this statistical area. Null when unsupported, missing or censored. */
1088
+ property_tax?: PropertyTax | null;
1089
+ }
1090
+ interface IbanDeep {
1091
+ /** Two check digits as a string, keeping a leading zero. */
1092
+ checksum: string | null;
1093
+ /** Branch identifier when that country has one. */
1094
+ branch: string | null;
1095
+ account: string | null;
1096
+ }
1097
+ interface PhoneDeep {
1098
+ /** NPA-derived state code (US/CA). */
1099
+ state: string | null;
1100
+ state_name: string | null;
1101
+ /** Numbering-plan IANA zone. Null when the prefix covers more than one zone, or invalid. Not the handset. */
1102
+ timezone: string | null;
1103
+ }
1104
+ interface CarrierDeep {
1105
+ /** Issuing rate-center city. */
1106
+ city: string | null;
1107
+ state: string | null;
1108
+ state_name: string | null;
1109
+ }
1110
+ interface HlrDeep {
1111
+ /** Network diagnostics available from the last check. Null when unconfirmed. */
1112
+ roaming: boolean | null;
1113
+ roaming_network: string | null;
1114
+ /** ISO2, uppercase. */
1115
+ roaming_country: string | null;
1116
+ /** Serving network name at the last check. */
1117
+ network: string | null;
1118
+ original_network: string | null;
1119
+ mcc: string | null;
1120
+ mnc: string | null;
1121
+ }
1122
+ interface CurrencyDeep {
1123
+ numeric: number | null;
1124
+ name_plural: string | null;
1125
+ countries: string[];
1126
+ }
1127
+ interface LanguageDeep {
1128
+ iso3: string | null;
1129
+ countries: string[];
1130
+ }
1131
+ interface NameDeep {
1132
+ /** Name membership is independent of gender. */
1133
+ known: boolean;
1134
+ /** Associated countries, not the person's nationality. */
1135
+ countries: string[];
1136
+ gender: 'male' | 'female' | null;
1137
+ salutation: 'Mr' | 'Ms' | null;
1138
+ }
1139
+ interface TimezoneDeep {
1140
+ name: string | null;
1141
+ /** Whole minutes, truncated toward zero for historical second offsets. */
1142
+ offset_minutes: number | null;
1143
+ offset_seconds?: number | null;
1144
+ next_dst: TimezoneNextDst | null;
1145
+ }
1146
+ interface TimezoneConversionTargetDeep {
1147
+ name: string | null;
1148
+ offset_minutes: number;
1149
+ offset_seconds?: number;
1150
+ }
1151
+ interface DateInfoDeep {
1152
+ year: number | null;
1153
+ month: number | null;
1154
+ month_name: string | null;
1155
+ day: number | null;
1156
+ /** ISO weekday, Monday 1 to Sunday 7. */
1157
+ weekday: number | null;
1158
+ weekday_name: string | null;
1159
+ /** ISO 8601 week number. */
1160
+ week: number | null;
1161
+ /** The year that ISO week belongs to. Differs from year around January 1. */
1162
+ week_year: number | null;
1163
+ day_of_year: number | null;
1164
+ quarter: number | null;
1165
+ leap: boolean | null;
1166
+ days_in_month: number | null;
1167
+ }
1168
+ interface EmojiDeep {
1169
+ codepoints: string[];
1170
+ hex: string;
1171
+ status: string | null;
1172
+ version: string | null;
1173
+ keywords: string[];
1174
+ skins: EmojiSkin[];
1175
+ }
1176
+ interface NaicsDeep {
1177
+ description: string | null;
1178
+ children: NaicsChild[];
1179
+ /** Classification exclusions. Omitted or null on older responses. */
1180
+ exclusions?: NaicsExclusion[] | null;
1181
+ }
1182
+ interface CountryEmergency {
1183
+ police: string | null;
1184
+ ambulance: string | null;
1185
+ fire: string | null;
1186
+ }
1187
+ interface PostalMetrosDeep {
1188
+ metros?: PostalMetro[] | null;
1189
+ }
1190
+ interface PointCity {
1191
+ name: string;
1192
+ name_local: string | null;
1193
+ type: string | null;
1194
+ state: string | null;
1195
+ state_name: string | null;
1196
+ country: string;
1197
+ country_name: string | null;
1198
+ latitude: number | null;
1199
+ longitude: number | null;
1200
+ distance: number;
1201
+ distance_mi: number;
1202
+ id: string;
1203
+ }
1204
+ interface WeatherCurrentDeep {
1205
+ dewpoint: number | null;
1206
+ dewpoint_f: number | null;
1207
+ wind_gust: number | null;
1208
+ wind_gust_mph: number | null;
1209
+ pressure: number | null;
1210
+ pressure_inhg: number | null;
1211
+ visibility: number | null;
1212
+ visibility_mi: number | null;
1213
+ }
1214
+ /** Property-tax estimate for an area, not a specific property. */
1215
+ interface PropertyTax {
1216
+ /** Median annual tax payable, in currency units adjusted to the final year of period. Not a tax rate or an individual property bill. */
1217
+ annual_median: number;
1218
+ /** ISO 4217 currency code, currently USD. */
1219
+ currency: string;
1220
+ /** Reporting period, YYYY-YYYY. Monetary amounts use the final year of this period. */
1221
+ period: string;
1222
+ }
982
1223
 
983
1224
  /** Every non-2xx response from the API. Branch on `code`, never on `message`. */
984
1225
  declare class ParseAPIError extends Error {
@@ -1010,137 +1251,191 @@ interface ParseAPIOptions {
1010
1251
  /** Custom fetch implementation (instrumentation, proxies). */
1011
1252
  fetch?: typeof fetch;
1012
1253
  }
1254
+ /** IP enrichment is included with a paid plan. `deep` does not use a separate check meter. */
1013
1255
  type IpOptions = DeepOption & RequestOptions;
1014
1256
  type IpSelfOptions = DeepOption & RequestOptions;
1015
1257
  type ContinentOptions = RequestOptions;
1016
1258
  type ContinentCountriesOptions = RequestOptions;
1017
1259
  type BlocOptions = RequestOptions;
1018
1260
  type BlocCountriesOptions = RequestOptions;
1019
- type CountryOptions = RequestOptions;
1261
+ type CountryOptions = DeepOption & RequestOptions;
1020
1262
  type CountryStatesOptions = RequestOptions;
1021
1263
  type StateOptions = {
1022
1264
  country?: string;
1023
- } & RequestOptions;
1265
+ } & DeepOption & RequestOptions;
1024
1266
  type StateDistrictsOptions = {
1025
1267
  country?: string;
1026
- } & RequestOptions;
1268
+ } & DeepOption & RequestOptions;
1027
1269
  type DistrictOptions = {
1028
1270
  country?: string;
1029
1271
  state?: string;
1030
- } & RequestOptions;
1272
+ } & DeepOption & RequestOptions;
1031
1273
  type CityOptions = {
1032
1274
  country?: string;
1033
1275
  state?: string;
1034
- } & RequestOptions;
1035
- type CityIdOptions = RequestOptions;
1276
+ } & DeepOption & RequestOptions;
1277
+ type CityIdOptions = DeepOption & RequestOptions;
1036
1278
  type CitySearchOptions = {
1037
1279
  country?: string;
1038
1280
  state?: string;
1039
1281
  limit?: number;
1040
- } & RequestOptions;
1041
- type CityNearestOptions = RequestOptions;
1282
+ } & DeepOption & RequestOptions;
1283
+ type CityNearestOptions = DeepOption & RequestOptions;
1042
1284
  type CityNearbyOptions = {
1043
1285
  radius?: number;
1044
1286
  unit?: 'km' | 'mi';
1045
1287
  country?: string;
1046
1288
  state?: string;
1047
1289
  limit?: number;
1048
- } & RequestOptions;
1290
+ } & DeepOption & RequestOptions;
1291
+ /** Pass country when known. Codes shared by multiple countries need it. */
1049
1292
  type PostalOptions = {
1050
1293
  country?: string;
1051
- } & RequestOptions;
1294
+ } & DeepOption & RequestOptions;
1052
1295
  type PostalNearbyOptions = {
1053
1296
  country?: string;
1054
1297
  radius?: number;
1055
1298
  unit?: 'km' | 'mi';
1056
- } & RequestOptions;
1299
+ } & DeepOption & RequestOptions;
1057
1300
  type PostalDistanceOptions = {
1058
1301
  country?: string;
1059
- } & RequestOptions;
1302
+ } & DeepOption & RequestOptions;
1060
1303
  type AddressOptions = {
1061
1304
  country?: string;
1062
1305
  } & DeepOption & RequestOptions;
1306
+ /** Address suggestions report why a result is empty. Operational failures remain errors. */
1063
1307
  type AddressSearchOptions = {
1308
+ /** Country scope. Pass the country known by the form. */
1064
1309
  country?: string;
1310
+ /** Postal-code scope from the form. */
1065
1311
  postal?: string;
1312
+ /** City scope, paired with state for US searches when no postal code is available. */
1066
1313
  city?: string;
1314
+ /** State scope for US searches. */
1067
1315
  state?: string;
1316
+ /** Actual end-user IP as an optional locality hint for server-side calls. */
1068
1317
  ip?: string;
1069
1318
  } & RequestOptions;
1070
1319
  type CompanyOptions = {
1071
1320
  country?: string;
1072
1321
  } & DeepOption & RequestOptions;
1322
+ /** `deep: true` requests a metered deliverability check. No automatic retries by default. */
1073
1323
  type EmailOptions = DeepOption & RequestOptions;
1324
+ /** `deep: true` requests a metered registry check where supported. `from` is your own VAT number. */
1074
1325
  type VatOptions = {
1075
1326
  country?: string;
1076
1327
  from?: string;
1077
1328
  } & DeepOption & RequestOptions;
1078
1329
  type IbanOptions = {
1079
1330
  country?: string;
1080
- } & RequestOptions;
1331
+ } & DeepOption & RequestOptions;
1081
1332
  type NpiOptions = DeepOption & RequestOptions;
1333
+ /** Country resolves national-number ambiguity. Deep adds numbering-plan geography on every plan. */
1082
1334
  type PhoneOptions = {
1083
1335
  country?: string;
1084
1336
  } & DeepOption & RequestOptions;
1337
+ /** Deep discloses location detail within the same carrier unit. */
1085
1338
  type CarrierOptions = {
1086
1339
  country?: string;
1087
- } & RequestOptions;
1340
+ } & DeepOption & RequestOptions;
1088
1341
  type CallerOptions = {
1089
1342
  country?: string;
1090
1343
  } & RequestOptions;
1344
+ /** Look up phone status at the last check. Live means assigned and connected means reachable at that check. Cached results may be returned. Null means unconfirmed. Deep adds network diagnostics within the same metered lookup. No automatic retries by default. */
1091
1345
  type HlrOptions = {
1092
1346
  country?: string;
1093
- } & RequestOptions;
1347
+ } & DeepOption & RequestOptions;
1094
1348
  type DomainOptions = DeepOption & RequestOptions;
1095
1349
  type AsnOptions = RequestOptions;
1096
1350
  type MacOptions = RequestOptions;
1351
+ /** Card-prefix reference lookup. Deep returns an empty object on every plan. */
1352
+ type BinOptions = DeepOption & RequestOptions;
1353
+ /** Parse a measurement, optionally converting it. Locale and system resolve explicit ambiguity. */
1354
+ type MeasureOptions = {
1355
+ to?: string;
1356
+ locale?: string;
1357
+ system?: 'us' | 'imperial';
1358
+ } & RequestOptions;
1359
+ type MeasureUnitsOptions = {
1360
+ query?: string;
1361
+ type?: string;
1362
+ unit?: string;
1363
+ } & RequestOptions;
1364
+ /** Published DNS records. Omit type to check all ten supported types. Values retain DNS presentation syntax. */
1365
+ type DnsOptions = {
1366
+ type?: string;
1367
+ } & RequestOptions;
1097
1368
  type MxOptions = RequestOptions;
1098
1369
  type UseragentOptions = DeepOption & RequestOptions;
1099
1370
  type VinOptions = DeepOption & RequestOptions;
1371
+ /** US NAICS 2022 code lookup, using pooled requests. */
1372
+ type NaicsOptions = DeepOption & RequestOptions;
1373
+ /** Keyword search. Limit defaults to 10 and accepts 1-50. */
1374
+ type NaicsSearchOptions = {
1375
+ limit?: number;
1376
+ } & DeepOption & RequestOptions;
1377
+ /** 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. */
1100
1378
  type TariffOptions = {
1379
+ /** Origin country (ISO2). With paid deep, resolves country-specific measures. */
1101
1380
  origin?: string;
1102
1381
  } & DeepOption & RequestOptions;
1103
1382
  type TariffSearchOptions = RequestOptions;
1104
- type CurrencyOptions = RequestOptions;
1383
+ type CurrencyOptions = DeepOption & RequestOptions;
1105
1384
  type CurrencyRateOptions = {
1106
1385
  date?: string;
1107
1386
  amount?: number;
1108
1387
  } & RequestOptions;
1109
- type LanguageOptions = RequestOptions;
1110
- type NameOptions = RequestOptions;
1388
+ type LanguageOptions = DeepOption & RequestOptions;
1389
+ /** Country is an ISO2 context for paid deep name evidence. */
1390
+ type NameOptions = {
1391
+ country?: string;
1392
+ } & DeepOption & RequestOptions;
1393
+ type TimeOptions = {
1394
+ at?: string;
1395
+ to?: string;
1396
+ } & DeepOption & RequestOptions;
1397
+ type TimeAtOptions = {
1398
+ at?: string;
1399
+ to?: string;
1400
+ } & DeepOption & RequestOptions;
1111
1401
  type TimezoneOptions = {
1112
1402
  at?: string;
1113
1403
  to?: string;
1114
- } & RequestOptions;
1404
+ } & DeepOption & RequestOptions;
1115
1405
  type TimezoneAtOptions = {
1116
1406
  at?: string;
1117
- } & RequestOptions;
1407
+ } & DeepOption & RequestOptions;
1118
1408
  type DateOptions = {
1119
1409
  format?: 'mdy' | 'dmy';
1120
1410
  to?: string;
1121
- } & RequestOptions;
1411
+ } & DeepOption & RequestOptions;
1122
1412
  type DateTodayOptions = {
1123
1413
  to?: string;
1124
- } & RequestOptions;
1414
+ } & DeepOption & RequestOptions;
1125
1415
  type HolidayOptions = {
1126
1416
  year?: number;
1127
1417
  } & RequestOptions;
1128
1418
  type HolidayDateOptions = RequestOptions;
1129
1419
  type ElevationOptions = RequestOptions;
1420
+ /** Resolve the country, state, district and timezone at coordinates. Deep adds terrain and compact nearest-city context on every plan. The timezone ID stays in core. The nearest city is null when none is within 200 km. */
1130
1421
  type PointOptions = DeepOption & RequestOptions;
1422
+ /** Get current conditions in metric and imperial units. Paid deep adds specialist current measurements, forecasts and related detail. With deep, date selects a past UTC day (YYYY-MM-DD) in deep.history alongside current conditions. Date alone does not request history. */
1131
1423
  type WeatherOptions = DeepOption & {
1424
+ /** Past UTC day, YYYY-MM-DD. Requires paid deep and populates deep.history alongside current. */
1132
1425
  date?: string;
1133
1426
  } & RequestOptions;
1134
- type EmojiOptions = RequestOptions;
1427
+ type EmojiOptions = DeepOption & RequestOptions;
1135
1428
  type EmojiSearchOptions = {
1136
1429
  limit?: number;
1137
- } & RequestOptions;
1430
+ } & DeepOption & RequestOptions;
1138
1431
  interface DeepOption {
1139
- /** Request richer fields. Availability and usage depend on the endpoint. */
1432
+ /** Request endpoint-specific enrichment. Email/VAT checks are metered. Reference depth can be pooled or included with a paid plan. See the operation's help. */
1140
1433
  deep?: boolean;
1141
1434
  }
1142
1435
  declare function parseAPI(apiKey?: string, options?: ParseAPIOptions): {
1436
+ /** Look up an IP. `deep: true` adds enrichment included with a paid plan, without a separate check meter. */
1143
1437
  ip: ((ip: string, opts?: IpOptions) => Promise<Ip>) & {
1438
+ /** Look up the public IP making this request. On a server, this is the server's IP. */
1144
1439
  self: (opts?: IpSelfOptions) => Promise<Ip>;
1145
1440
  };
1146
1441
  continent: ((code: string, opts?: ContinentOptions) => Promise<Continent>) & {
@@ -1162,28 +1457,55 @@ declare function parseAPI(apiKey?: string, options?: ParseAPIOptions): {
1162
1457
  nearest: (lat: number, lon: number, opts?: CityNearestOptions) => Promise<CityNearest>;
1163
1458
  nearby: (name: string, opts?: CityNearbyOptions) => Promise<CityNearby>;
1164
1459
  };
1460
+ /** Look up a postal area. Pass country when known. Check nullable latitude/longitude before another location lookup. */
1165
1461
  postal: ((code: string, opts?: PostalOptions) => Promise<Postal>) & {
1166
1462
  nearby: (code: string, opts?: PostalNearbyOptions) => Promise<PostalNearby>;
1167
1463
  distance: (from: string, to: string, opts?: PostalDistanceOptions) => Promise<PostalDistance>;
1168
1464
  };
1169
1465
  address: ((address: string, opts?: AddressOptions) => Promise<Address>) & {
1466
+ /** 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. */
1170
1467
  search: (query: string, opts?: AddressSearchOptions) => Promise<AddressSearch>;
1171
1468
  };
1172
1469
  company: (number: string, opts?: CompanyOptions) => Promise<Company>;
1470
+ /**
1471
+ * Parse an email and check its format and domain.
1472
+ * `deep: true` explicitly requests a metered deliverability check using included checks or enabled on-demand usage.
1473
+ * Deep checks default to one attempt. An explicit retry count can repeat paid usage.
1474
+ */
1173
1475
  email: (email: string, opts?: EmailOptions) => Promise<Email>;
1476
+ /** Check VAT format and checksum. `deep: true` requests a metered registry check where supported, with no automatic retries by default. */
1174
1477
  vat: (number: string, opts?: VatOptions) => Promise<Vat>;
1175
1478
  iban: (iban: string, opts?: IbanOptions) => Promise<Iban>;
1176
1479
  npi: (npi: string, opts?: NpiOptions) => Promise<Npi>;
1480
+ /** Parse a phone number and its formats. Pass country for national numbers when needed. Deep adds numbering-plan geography. */
1177
1481
  phone: (number: string, opts?: PhoneOptions) => Promise<Phone>;
1482
+ /** Request a metered carrier lookup. No automatic retries by default. */
1178
1483
  carrier: (number: string, opts?: CarrierOptions) => Promise<Carrier>;
1484
+ /** Request a metered caller-name lookup for a NANP number. No automatic retries by default. */
1179
1485
  caller: (number: string, opts?: CallerOptions) => Promise<Caller>;
1486
+ /** Look up phone status at the last check. Live means assigned and connected means reachable at that check. Cached results may be returned. Null means unconfirmed. Deep adds network diagnostics within the same metered lookup. No automatic retries by default. */
1180
1487
  hlr: (number: string, opts?: HlrOptions) => Promise<Hlr>;
1488
+ /** Check whether a domain is registered. Deep adds registration dates, registrar, status and DNSSEC on paid plans. */
1181
1489
  domain: (domain: string, opts?: DomainOptions) => Promise<Domain>;
1182
1490
  asn: (asn: string, opts?: AsnOptions) => Promise<Asn>;
1183
1491
  mac: (mac: string, opts?: MacOptions) => Promise<Mac>;
1492
+ /** Look up a 6-11 digit card prefix. Keep leading zeros in the input string. */
1493
+ bin: (bin: string, opts?: BinOptions) => Promise<Bin>;
1494
+ /** Parse a measurement or convert it to `to`. Without `to`, use its type's canonical unit. Invalid input is plain data with `valid: false`. */
1495
+ measure: ((measure: string, opts?: MeasureOptions) => Promise<Measure>) & {
1496
+ /** Discover reviewed units. Pass `unit` to find compatible conversion targets. */
1497
+ units: (opts?: MeasureUnitsOptions) => Promise<MeasureUnits>;
1498
+ };
1499
+ /** Look up DNS records with TTLs. Type selects the question and may include its CNAME chain. Pooled on every plan. */
1500
+ dns: (domain: string, opts?: DnsOptions) => Promise<Dns>;
1184
1501
  mx: (domain: string, opts?: MxOptions) => Promise<Mx>;
1185
1502
  useragent: (ua: string, opts?: UseragentOptions) => Promise<Useragent>;
1186
1503
  vin: (vin: string, opts?: VinOptions) => Promise<Vin>;
1504
+ /** US NAICS 2022 definitions and hierarchy. */
1505
+ naics: ((code: string, opts?: NaicsOptions) => Promise<Naics>) & {
1506
+ search: (query: string, opts?: NaicsSearchOptions) => Promise<NaicsSearch>;
1507
+ };
1508
+ /** 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. */
1187
1509
  tariff: ((code: string, opts?: TariffOptions) => Promise<Tariff>) & {
1188
1510
  search: (query: string, opts?: TariffSearchOptions) => Promise<TariffSearch>;
1189
1511
  };
@@ -1192,6 +1514,10 @@ declare function parseAPI(apiKey?: string, options?: ParseAPIOptions): {
1192
1514
  };
1193
1515
  language: (code: string, opts?: LanguageOptions) => Promise<Language>;
1194
1516
  name: (name: string, opts?: NameOptions) => Promise<Name>;
1517
+ /** Current local time, UTC by default. With to, offsetless at is source wall time. */
1518
+ time: ((timezone?: string, opts?: TimeOptions) => Promise<Time>) & {
1519
+ at: (lat: number, lon: number, opts?: TimeAtOptions) => Promise<Time>;
1520
+ };
1195
1521
  timezone: ((id: string, opts?: TimezoneOptions) => Promise<Timezone>) & {
1196
1522
  at: (lat: number, lon: number, opts?: TimezoneAtOptions) => Promise<Timezone>;
1197
1523
  };
@@ -1202,7 +1528,9 @@ declare function parseAPI(apiKey?: string, options?: ParseAPIOptions): {
1202
1528
  date: (country: string, date: string, opts?: HolidayDateOptions) => Promise<HolidayDate>;
1203
1529
  };
1204
1530
  elevation: (lat: number, lon: number, opts?: ElevationOptions) => Promise<Elevation>;
1531
+ /** Resolve the country, state, district and timezone at coordinates. Deep adds terrain and compact nearest-city context on every plan. The timezone ID stays in core. The nearest city is null when none is within 200 km. */
1205
1532
  point: (lat: number, lon: number, opts?: PointOptions) => Promise<Point>;
1533
+ /** Get current conditions in metric and imperial units. Paid deep adds specialist current measurements, forecasts and related detail. With deep, date selects a past UTC day (YYYY-MM-DD) in deep.history alongside current conditions. Date alone does not request history. */
1206
1534
  weather: (lat: number, lon: number, opts?: WeatherOptions) => Promise<Weather>;
1207
1535
  emoji: ((emoji: string, opts?: EmojiOptions) => Promise<Emoji>) & {
1208
1536
  search: (query: string, opts?: EmojiSearchOptions) => Promise<EmojiSearch>;
@@ -1210,4 +1538,4 @@ declare function parseAPI(apiKey?: string, options?: ParseAPIOptions): {
1210
1538
  };
1211
1539
  type ParseAPIClient = ReturnType<typeof parseAPI>;
1212
1540
 
1213
- export { type Address, type AddressOptions, type AddressSearch, type AddressSearchOptions, type AddressSuggestion, type Asn, type AsnOptions, type Bloc, type BlocCountries, type BlocCountriesOptions, type BlocCountryItem, type BlocOptions, type Caller, type CallerOptions, type Carrier, type CarrierOptions, type City, type CityIdOptions, type CityNearby, type CityNearbyOptions, type CityNearest, type CityNearestOptions, type CityOptions, type CitySearch, type CitySearchOptions, type Company, type CompanyCountry, type CompanyDeep, type CompanyOptions, type Continent, type ContinentCountries, type ContinentCountriesOptions, type ContinentCountryItem, type ContinentOptions, type Country, type CountryOptions, type CountryStateItem, type CountryStates, type CountryStatesOptions, type Currency, type CurrencyOptions, type CurrencyRate, type CurrencyRateOptions, type DateInfo, type DateOptions, type DateTodayOptions, type Deep, type District, type DistrictOptions, type Domain, type DomainDeep, type DomainOptions, type DomainRegistration, type Elevation, type ElevationOptions, type Email, type EmailDeep, type EmailOptions, type Emoji, type EmojiOptions, type EmojiSearch, type EmojiSearchOptions, type EmojiSkin, type Hlr, type HlrOptions, type Holiday, type HolidayDate, type HolidayDateOptions, type HolidayOptions, type HolidayYear, type Iban, type IbanOptions, type Ip, type IpDeep, type IpOptions, type IpSelfOptions, type Language, type LanguageOptions, type Mac, type MacOptions, type Mx, type MxOptions, type MxRecord, type Name, type NameOptions, type Npi, type NpiDeep, type NpiEnrollment, type NpiOptions, type ParseAPIClient, ParseAPIError, type ParseAPIOptions, type Phone, type PhoneOptions, type Point, type PointDeep, type PointOptions, type Postal, type PostalDistance, type PostalDistanceEnd, type PostalDistanceOptions, type PostalMetro, type PostalNearby, type PostalNearbyItem, type PostalNearbyOptions, type PostalOptions, type RequestOptions, type State, type StateDistrictItem, type StateDistricts, type StateDistrictsOptions, type StateOptions, type Tariff, type TariffDeep, type TariffMeasure, type TariffOptions, type TariffSearch, type TariffSearchHit, type TariffSearchOptions, type Timezone, type TimezoneAtOptions, type TimezoneConversionTarget, type TimezoneNextDst, type TimezoneOptions, type Useragent, type UseragentBrowserBrand, type UseragentBrowserDeep, type UseragentDeep, type UseragentDeviceDeep, type UseragentEngineDeep, type UseragentOptions, type UseragentOsDeep, type Vat, type VatAddress, type VatDeep, type VatOptions, type Vin, type VinDeep, type VinOptions, type VinRecall, type Weather, type WeatherAir, type WeatherAlert, type WeatherCurrent, type WeatherDay, type WeatherDeep, type WeatherForecastPeriod, type WeatherHistory, type WeatherHour, type WeatherMinute, type WeatherOptions, type WeatherSource, type WeatherStation, parseAPI };
1541
+ 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 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 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 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 PostalMetro, type PostalMetrosDeep, type PostalNearby, type PostalNearbyItem, type PostalNearbyOptions, type PostalOptions, type PropertyTax, type RequestOptions, 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 TimeOptions, 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 };