@parseapi/sdk 1.12.4 → 1.12.6
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +23 -14
- package/dist/index.cjs +3 -3
- package/dist/index.d.cts +69 -29
- package/dist/index.d.ts +69 -29
- package/dist/index.js +3 -3
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -106,6 +106,15 @@ names. IDs, native-name fields, numeric facts, Date input `format`, and
|
|
|
106
106
|
input `locale` retain their meaning. Omitting `lang` preserves the existing
|
|
107
107
|
behavior and does not inherit a previous request's choice.
|
|
108
108
|
|
|
109
|
+
## ISO identifiers
|
|
110
|
+
|
|
111
|
+
Country uses `iso_alpha3` and `iso_numeric`, State uses the full
|
|
112
|
+
`iso_subdivision` code such as `US-CA`, Language uses `iso_alpha3`, and Currency
|
|
113
|
+
uses `iso_numeric`. Primary `country`, `state`, `language` and `currency` codes
|
|
114
|
+
keep their meaning. Results retain the selected API contract's exact keys,
|
|
115
|
+
values, nulls and nesting. Earlier server contracts retain their earlier ISO
|
|
116
|
+
spellings. Use the existing lookup methods for each resource.
|
|
117
|
+
|
|
109
118
|
## Calls
|
|
110
119
|
|
|
111
120
|
Search the company directory, then refetch an ID you have chosen:
|
|
@@ -189,8 +198,8 @@ await parse.date.today();
|
|
|
189
198
|
await parse.holiday('US', { year: 2026 });
|
|
190
199
|
await parse.holiday.date('US', '2026-12-25');
|
|
191
200
|
await parse.elevation(35.2271, -80.8431);
|
|
192
|
-
await parse.elevation.points([[
|
|
193
|
-
await parse.elevation.path([[
|
|
201
|
+
await parse.elevation.points([[39.7392, -104.9903], [39.75, -104.98]]);
|
|
202
|
+
await parse.elevation.path([[39.7392, -104.9903], [39.75, -104.98]], 100);
|
|
194
203
|
await parse.point(36.0726, -79.792);
|
|
195
204
|
await parse.weather(40.7128, -74.006);
|
|
196
205
|
await parse.domain('example.com');
|
|
@@ -215,9 +224,11 @@ DNS uses pooled requests on every plan. Omit `type` to check A, AAAA, CNAME, MX,
|
|
|
215
224
|
|
|
216
225
|
## Elevation
|
|
217
226
|
|
|
218
|
-
`elevation(lat, lon)` returns one sample with meters, feet and grid resolution in meters. `elevation.points(...)` accepts up to 512 `[lat, lon]` pairs, a `lat,lon|lat,lon` string, or `enc:` followed by a Google encoded polyline. Its `points` array preserves input order and duplicate coordinates. Unknown samples stay null, and negative elevations and known zero values are preserved. Each list uses one pooled request. The SDK automatically uses JSON POST for long URLs and numeric coordinates that JavaScript expresses in exponent notation.
|
|
227
|
+
`elevation(lat, lon)` returns one sample with meters, feet and grid resolution in meters. `elevation.points(...)` accepts up to 512 points per local batch as `[lat, lon]` pairs, a `lat,lon|lat,lon` string, or `enc:` followed by a Google encoded polyline. Its `points` array preserves input order and duplicate coordinates. Unknown samples stay null, and negative elevations and known zero values are preserved. Each accepted local list uses one pooled request. The SDK automatically uses JSON POST for long URLs and numeric coordinates that JavaScript expresses in exponent notation.
|
|
219
228
|
|
|
220
|
-
`elevation.path(path, samples)` accepts the same input formats with 2-512 path vertices and a required integer sample count from 2 to 512. Its `points` array includes both endpoints, with samples spaced uniformly by cumulative great-circle distance along the path. Each segment follows the shortest arc. A segment with antipodal endpoints is rejected because it does not define a unique arc.
|
|
229
|
+
`elevation.path(path, samples)` accepts the same input formats with 2-512 path vertices and a required integer sample count from 2 to 512. Its `points` array includes both endpoints, with samples spaced uniformly by cumulative great-circle distance along the path. Each segment follows the shortest arc. A segment with antipodal endpoints is rejected because it does not define a unique arc. Each accepted local path uses one pooled request and automatically selects JSON POST for a long URL.
|
|
230
|
+
|
|
231
|
+
Each local batch is limited to 25 km between any two coordinates and 12 distinct terrain files in total across the fine grid and all possible global fallback files. For paths, both the supplied vertices and generated samples must fit the 25 km span. The terrain file budget applies to the sampled coordinates. This is a span limit, not a limit on cumulative path length. Send longer or more spread-out routes in shorter sections. An over-limit batch returns HTTP 400. GET, POST and polylines use the same limits. The SDK does not silently split or discard coordinates.
|
|
221
232
|
|
|
222
233
|
## Time
|
|
223
234
|
|
|
@@ -269,9 +280,7 @@ Source deep adds `standard_offset`, `standard_offset_seconds`, signed `dst_offse
|
|
|
269
280
|
|
|
270
281
|
## Place statistics and optional detail
|
|
271
282
|
|
|
272
|
-
Country Core contains the everyday reference: `name`, `name_full`, `name_local`, demonym and country
|
|
273
|
-
|
|
274
|
-
Read `name_full` from current responses. The older `full_name` type member remains available for earlier payloads; responses are returned as received, with null values preserved. Historical Deep fields remain readable in earlier responses; they are not added to the current wire result.
|
|
283
|
+
Country Core contains the everyday reference: `name`, `name_full`, `name_local`, demonym, `iso_alpha3` and `iso_numeric` country identifiers, continent, region and subregion, currency, calling code, `flag`, language and timezone codes, borders, bloc memberships and `capital: { name, lat, lon }`. Paid Deep adds specialist detail, including population, total area and national statistics. `gdp_usd` and `gdp_per_capita_usd` are current US dollars; `population_growth_percent`, `urban_population_percent` and `internet_users_percent` use a 0–100 percent scale (growth can be negative or exceed 100). GDP per person and these three percentages round once to two decimals in the API response. `elevation_average` is average terrain elevation in meters; `lowest_point.elevation` and `highest_point.elevation` keep their point-specific meaning. Unknown stays null and a known zero stays zero. Country tax references are grouped once as `deep.tax: { name, rate }`; the rate remains a percentage. Read capital from the Core object and read the tax name and rate from the Deep tax object.
|
|
275
284
|
|
|
276
285
|
Australian postal lookups include core `localities` with suburb choices (`city`, `state`, `state_name`) on every plan. Null or an omitted field means unknown, while `[]` means the reviewed reference has no eligible choices. `city` stays null when the source is ambiguous, even if there is only one eligible choice. Let the user select their suburb and keep manual entry available. These are geographic choices, not mailing-address verification. [G-NAF source, adaptations and licence](https://parseapi.com/legal/attribution#postal-au).
|
|
277
286
|
|
|
@@ -412,10 +421,10 @@ console.log(basic.at, detail.deep?.next_dst);
|
|
|
412
421
|
|
|
413
422
|
## Domain results with unknown availability
|
|
414
423
|
|
|
415
|
-
Use `
|
|
424
|
+
Use `domain` when deciding whether a domain is registered. It returns `available: true` for unregistered, `false` for registered, and `null` when the registry answer is unknown.
|
|
416
425
|
|
|
417
426
|
```ts
|
|
418
|
-
const result = await parse.
|
|
427
|
+
const result = await parse.domain('example.com', { deep: true });
|
|
419
428
|
if (result.available === null) {
|
|
420
429
|
console.log('Registration could not be determined');
|
|
421
430
|
} else {
|
|
@@ -425,19 +434,19 @@ if (result.available === null) {
|
|
|
425
434
|
|
|
426
435
|
This makes one ordinary Domain lookup with the same options, authentication and retry policy. Registration detail may be partial. Missing or null `dnssec` is unknown, while `false` is a known negative. Missing or null `status` is unknown, while `[]` is a known empty list.
|
|
427
436
|
|
|
428
|
-
The
|
|
437
|
+
The ordinary `Domain` type represents unknown availability as `null`. The existing `domainResult` method and its result type remain available.
|
|
429
438
|
|
|
430
439
|
## Stack API
|
|
431
440
|
|
|
432
441
|
```typescript
|
|
433
|
-
import type {
|
|
442
|
+
import type { Stack } from '@parseapi/sdk';
|
|
434
443
|
|
|
435
|
-
const result:
|
|
444
|
+
const result: Stack = await parse.stack("example.com");
|
|
436
445
|
```
|
|
437
446
|
|
|
438
|
-
Pass a public hostname without a scheme, path, port or IP address. Stack checks static homepage HTML and response headers. It returns the checked URL, original `checked_at` time and eight technology arrays.
|
|
447
|
+
Pass a public hostname without a scheme, path, port or IP address. Stack checks static homepage HTML and response headers. It returns the checked URL, original `checked_at` time and eight technology arrays. The existing `stack()` method returns this `Stack` model.
|
|
439
448
|
|
|
440
|
-
`cms`, `servers`, `frameworks`, `ecommerce`, `analytics`, `chat`, `payments` and `hosting` are arrays because a site can use several technologies in each category. Each entry contains `technology`, `name` and nullable `version`. Technology codes are open strings. A successful check uses empty arrays for categories with no matches. When no HTML page could be checked, `checked_at` and all categories are null. Unknown or conflicting versions are null.
|
|
449
|
+
`cms`, `servers`, `frameworks`, `ecommerce`, `analytics`, `chat`, `payments` and `hosting` are arrays because a site can use several technologies in each category. Each entry contains `technology`, `name` and nullable `version`. Technology codes are open strings. A successful check uses empty arrays for categories with no matches. When no HTML page could be checked, `checked_at` and all categories are null. Unknown or conflicting versions are null. Detections describe the checked homepage.
|
|
441
450
|
|
|
442
451
|
Successful checks may be reused for up to 24 hours. `pretty` optionally formats the wire JSON. Stack uses your plan's request allowance and API version 2.0.0 selected by this client.
|
|
443
452
|
|
package/dist/index.cjs
CHANGED
|
@@ -448,7 +448,7 @@ var EmojiCatalog = class {
|
|
|
448
448
|
};
|
|
449
449
|
|
|
450
450
|
// src/index.ts
|
|
451
|
-
var VERSION = "1.12.
|
|
451
|
+
var VERSION = "1.12.6";
|
|
452
452
|
var API_VERSION = "2.0.0";
|
|
453
453
|
var DEFAULT_BASE_URL = "https://api.parseapi.com";
|
|
454
454
|
var DEFAULT_TIMEOUT_MS = 1e4;
|
|
@@ -750,9 +750,9 @@ function parseAPI(apiKey, options = {}) {
|
|
|
750
750
|
caller: (number, opts) => request(`/caller/${enc(number)}`, { country: opts?.country }, void 0, opts),
|
|
751
751
|
/** 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. */
|
|
752
752
|
hlr: (number, opts) => request(`/hlr/${enc(number)}`, { country: opts?.country, ...deepQuery(opts) }, void 0, opts),
|
|
753
|
-
/** Identify
|
|
753
|
+
/** Identify technologies in static homepage HTML and response headers. */
|
|
754
754
|
stack: (domain, opts) => request(`/stack/${enc(domain)}`, { ...deepQuery(opts), pretty: opts?.pretty }, void 0, opts),
|
|
755
|
-
/** Check
|
|
755
|
+
/** Check registration: available is true, false or null when unknown. Paid Deep adds available registration details. */
|
|
756
756
|
domain: (domain, opts) => request(`/domain/${enc(domain)}`, deepQuery(opts), void 0, opts),
|
|
757
757
|
/** Check domain registration while preserving unknown availability and partial detail. */
|
|
758
758
|
domainResult: (domain, opts) => request(`/domain/${enc(domain)}`, deepQuery(opts), void 0, opts),
|
package/dist/index.d.cts
CHANGED
|
@@ -72,7 +72,13 @@ interface Country {
|
|
|
72
72
|
deep?: Deep<CountryDeep>;
|
|
73
73
|
/** IANA timezones used by the country. */
|
|
74
74
|
timezones: string[] | null;
|
|
75
|
+
/** ISO 3166-1 alpha-3 country code. */
|
|
76
|
+
iso_alpha3?: string | null;
|
|
77
|
+
/** ISO 3166-1 numeric country code. */
|
|
78
|
+
iso_numeric?: number | null;
|
|
79
|
+
/** @deprecated Older servers use iso3. Read iso_alpha3 on the current contract. */
|
|
75
80
|
iso3?: string | null;
|
|
81
|
+
/** @deprecated Older servers use numeric. Read iso_numeric on the current contract. */
|
|
76
82
|
numeric?: number | null;
|
|
77
83
|
/** Official long name. */
|
|
78
84
|
name_full?: string | null;
|
|
@@ -114,9 +120,14 @@ interface State {
|
|
|
114
120
|
country_name: string | null;
|
|
115
121
|
latitude: number | null;
|
|
116
122
|
longitude: number | null;
|
|
117
|
-
timezone: string | null;
|
|
118
123
|
timezones: string[];
|
|
119
|
-
|
|
124
|
+
/** Full ISO 3166-2 subdivision code, including its country prefix. */
|
|
125
|
+
iso_subdivision?: string | null;
|
|
126
|
+
/** @deprecated Legacy candidate spelling. Read iso_subdivision on the current contract. */
|
|
127
|
+
iso?: string | null;
|
|
128
|
+
fips: string | null;
|
|
129
|
+
area_codes: string[] | null;
|
|
130
|
+
capital: StateCapital;
|
|
120
131
|
deep?: Deep<StateDeep>;
|
|
121
132
|
}
|
|
122
133
|
interface StateDistrictItem {
|
|
@@ -147,7 +158,6 @@ interface District {
|
|
|
147
158
|
country_name: string | null;
|
|
148
159
|
latitude: number | null;
|
|
149
160
|
longitude: number | null;
|
|
150
|
-
timezone: string | null;
|
|
151
161
|
timezones: string[];
|
|
152
162
|
deep?: Deep<DistrictDeep>;
|
|
153
163
|
}
|
|
@@ -349,11 +359,6 @@ interface Stack {
|
|
|
349
359
|
url: string;
|
|
350
360
|
/** Time of the check, or null when no HTML page could be checked. */
|
|
351
361
|
checked_at: string | null;
|
|
352
|
-
scope: 'homepage' | 'site';
|
|
353
|
-
/** Number of successfully checked HTML pages. */
|
|
354
|
-
pages: number;
|
|
355
|
-
/** True for homepage-only or incomplete bounded checks; null when no HTML page could be checked. False never guarantees every page was visited. */
|
|
356
|
-
partial: boolean | null;
|
|
357
362
|
/** Collections are null when no HTML page could be checked and empty when no matches were found. */
|
|
358
363
|
cms: StackTechnology[] | null;
|
|
359
364
|
servers: StackTechnology[] | null;
|
|
@@ -368,19 +373,21 @@ interface Stack {
|
|
|
368
373
|
}
|
|
369
374
|
interface DomainRegistration {
|
|
370
375
|
registered: boolean;
|
|
371
|
-
created
|
|
372
|
-
updated
|
|
373
|
-
expires
|
|
374
|
-
registrar
|
|
375
|
-
status
|
|
376
|
-
|
|
376
|
+
created?: string | null;
|
|
377
|
+
updated?: string | null;
|
|
378
|
+
expires?: string | null;
|
|
379
|
+
registrar?: string | null;
|
|
380
|
+
status?: string[] | null;
|
|
381
|
+
/** Missing or null is unknown; false is a known unsigned observation. */
|
|
382
|
+
dnssec?: boolean | null;
|
|
377
383
|
}
|
|
378
384
|
interface DomainDeep {
|
|
379
385
|
registration: DomainRegistration;
|
|
380
386
|
}
|
|
381
387
|
interface Domain {
|
|
382
388
|
domain: string;
|
|
383
|
-
|
|
389
|
+
/** true means unregistered, false means registered, null means unknown. */
|
|
390
|
+
available: boolean | null;
|
|
384
391
|
deep?: Deep<DomainDeep>;
|
|
385
392
|
}
|
|
386
393
|
/** Network identity for an autonomous system number. */
|
|
@@ -476,6 +483,11 @@ interface Language {
|
|
|
476
483
|
script: string | null;
|
|
477
484
|
direction: 'ltr' | 'rtl' | string;
|
|
478
485
|
deep?: Deep<LanguageDeep>;
|
|
486
|
+
/** ISO 639-3 language code. */
|
|
487
|
+
iso_alpha3?: string | null;
|
|
488
|
+
/** @deprecated Older servers use iso3. Read iso_alpha3 on the current contract. */
|
|
489
|
+
iso3?: string | null;
|
|
490
|
+
countries?: string[] | null;
|
|
479
491
|
}
|
|
480
492
|
/** 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. */
|
|
481
493
|
interface Name {
|
|
@@ -1189,7 +1201,9 @@ interface CountryDeep {
|
|
|
1189
1201
|
urban_population?: number | null;
|
|
1190
1202
|
/** Share of population using the internet, from 0 to 100. */
|
|
1191
1203
|
internet_users?: number | null;
|
|
1204
|
+
/** @deprecated Older deep contract. Current ISO identifiers live in Core. */
|
|
1192
1205
|
iso3: string;
|
|
1206
|
+
/** @deprecated Older deep contract. Current iso_numeric lives in Core. */
|
|
1193
1207
|
numeric: number;
|
|
1194
1208
|
full_name: string | null;
|
|
1195
1209
|
demonym: string | null;
|
|
@@ -1250,18 +1264,19 @@ interface CountryElevationPoint {
|
|
|
1250
1264
|
elevation: number;
|
|
1251
1265
|
}
|
|
1252
1266
|
interface StateDeep {
|
|
1267
|
+
/** @deprecated Older deep contract. Read Core iso_subdivision on the current contract. */
|
|
1268
|
+
iso_3166_2?: string | null;
|
|
1253
1269
|
population: number | null;
|
|
1254
1270
|
/** @deprecated No longer returned. Retained for source compatibility. */
|
|
1255
1271
|
population_period?: string | null;
|
|
1256
1272
|
/** Total area in km2. */
|
|
1257
1273
|
area: number | null;
|
|
1258
|
-
|
|
1259
|
-
|
|
1260
|
-
|
|
1261
|
-
|
|
1262
|
-
|
|
1263
|
-
|
|
1264
|
-
tax_rate: number | null;
|
|
1274
|
+
tax: StateTax;
|
|
1275
|
+
/** @deprecated Historical Deep read members. */
|
|
1276
|
+
fips?: string | null;
|
|
1277
|
+
capital?: string | null;
|
|
1278
|
+
area_codes?: string[];
|
|
1279
|
+
tax_rate?: number | null;
|
|
1265
1280
|
}
|
|
1266
1281
|
interface DistrictDeep {
|
|
1267
1282
|
population: number | null;
|
|
@@ -1353,8 +1368,10 @@ interface HlrDeep {
|
|
|
1353
1368
|
mnc: string | null;
|
|
1354
1369
|
}
|
|
1355
1370
|
interface LanguageDeep {
|
|
1356
|
-
|
|
1357
|
-
|
|
1371
|
+
/** @deprecated Older deep contract. Read Core iso_alpha3 on the current contract. */
|
|
1372
|
+
iso3?: string | null;
|
|
1373
|
+
/** @deprecated Older deep contract. Current country associations live in Core. */
|
|
1374
|
+
countries?: string[] | null;
|
|
1358
1375
|
}
|
|
1359
1376
|
interface NameDeep {
|
|
1360
1377
|
gender: 'male' | 'female' | null;
|
|
@@ -1602,6 +1619,29 @@ interface CityNearbyCoordinates extends CityCollection {
|
|
|
1602
1619
|
radius: number;
|
|
1603
1620
|
unit: string;
|
|
1604
1621
|
}
|
|
1622
|
+
/** Minimal related records returned in Company Core. Rich Deep records stay separate. */
|
|
1623
|
+
interface CompanyIndustryReference {
|
|
1624
|
+
type: string;
|
|
1625
|
+
code: string;
|
|
1626
|
+
}
|
|
1627
|
+
interface CompanyPhoneReference {
|
|
1628
|
+
number: string;
|
|
1629
|
+
country?: string | null;
|
|
1630
|
+
e164?: string | null;
|
|
1631
|
+
}
|
|
1632
|
+
interface CompanyEmailReference {
|
|
1633
|
+
address: string;
|
|
1634
|
+
}
|
|
1635
|
+
interface StateTax {
|
|
1636
|
+
name: string | null;
|
|
1637
|
+
/** Reference rate in percent. Choose the geographic scope for the task. */
|
|
1638
|
+
rate: number | null;
|
|
1639
|
+
}
|
|
1640
|
+
interface StateCapital {
|
|
1641
|
+
name: string | null;
|
|
1642
|
+
lat: number | null;
|
|
1643
|
+
lon: number | null;
|
|
1644
|
+
}
|
|
1605
1645
|
|
|
1606
1646
|
/** Every non-2xx response from the API. Branch on `code`, never on `message`. */
|
|
1607
1647
|
declare class ParseAPIError extends Error {
|
|
@@ -1871,8 +1911,8 @@ interface DomainResult {
|
|
|
1871
1911
|
available: boolean | null;
|
|
1872
1912
|
deep?: Deep<DomainResultDeep>;
|
|
1873
1913
|
}
|
|
1874
|
-
/**
|
|
1875
|
-
type StackResult =
|
|
1914
|
+
/** Alias for the current Stack response. */
|
|
1915
|
+
type StackResult = Stack;
|
|
1876
1916
|
|
|
1877
1917
|
interface EmojiCatalogLookupOptions {
|
|
1878
1918
|
deep?: boolean;
|
|
@@ -2277,9 +2317,9 @@ declare function parseAPI(apiKey?: string, options?: ParseAPIOptions): {
|
|
|
2277
2317
|
caller: (number: string, opts?: CallerOptions) => Promise<Caller>;
|
|
2278
2318
|
/** 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. */
|
|
2279
2319
|
hlr: (number: string, opts?: HlrOptions) => Promise<Hlr>;
|
|
2280
|
-
/** Identify
|
|
2320
|
+
/** Identify technologies in static homepage HTML and response headers. */
|
|
2281
2321
|
stack: (domain: string, opts?: StackOptions) => Promise<Stack>;
|
|
2282
|
-
/** Check
|
|
2322
|
+
/** Check registration: available is true, false or null when unknown. Paid Deep adds available registration details. */
|
|
2283
2323
|
domain: (domain: string, opts?: DomainOptions) => Promise<Domain>;
|
|
2284
2324
|
/** Check domain registration while preserving unknown availability and partial detail. */
|
|
2285
2325
|
domainResult: (domain: string, opts?: DomainOptions) => Promise<DomainResult>;
|
|
@@ -2429,4 +2469,4 @@ interface CityNearbyCall {
|
|
|
2429
2469
|
(name: string, opts: CityNearbyOptions): Promise<CityNearby | CityCollection>;
|
|
2430
2470
|
}
|
|
2431
2471
|
|
|
2432
|
-
export { type Address, type AddressOptions, type AddressSearch, type AddressSearchOptions, type AddressSuggestion, type AgentTask, type AgentTaskInput, type AgentTaskLookupInput, type AgentTaskResult, type Asn, type AsnOptions, BULK_CHECKS, type Bin, type BinOptions, ParseAPIError as BulkAPIError, type BulkClient, type BulkClientOptions, type BulkJob, type BulkPreview, type BulkPreviewInput, type BulkQuote, type BulkRequestOptions, type BulkResult, type BulkStartInput, type BulkStatus, type BulkUpload, type BulkUploadInput, type Caller, type CallerOptions, type Card, type CardDeep, type CardOptions, type Carrier, type CarrierDeep, type CarrierOptions, type City, type CityAmbiguityCandidate, type CityAncestorsOptions, type CityCollection, type CityCollectionFilters, type CityDeep, type CityDistance, type CityDistanceOptions, type CityGrain, type CityIdCall, type CityIdOptions, type CityList, type CityListOptions, type CityLookupCall, type CityMatch, type CityNearby, type CityNearbyCall, type CityNearbyCoordinates, type CityNearbyCoordinatesOptions, type CityNearbyOptions, type CityNearest, type CityNearestCall, type CityNearestOptions, type CityOptions, type CityPagingOptions, type CityParent, type CityRelations, type CityRelationsOptions, type CityResource, type CityResponseOptions, type CityScopeOptions, type CitySearch, type CitySearchCall, type CitySearchOptions, type CitySort, type Company, type CompanyCandidate, type CompanyCountry, type CompanyCoverage, type CompanyCoverageOptions, type CompanyDeep, type CompanyEmailAddress, type CompanyIdOptions, type CompanyMatch, type CompanyOptions, type CompanyPhoneNumber, type CompanyProfile, type CompanyProfileAddress, type CompanyProfileDeep, type CompanyProfileDomain, type CompanyProfileEmail, type CompanyProfileEmployees, type CompanyProfileFounding, type CompanyProfileIdentifier, type CompanyProfileIndustry, type CompanyProfileJurisdiction, type CompanyProfileListing, type CompanyProfilePhone, type CompanyProfileRegistration, type CompanyProfileRegistrationAddress, type CompanyProfileRegistrationLegalForm, type CompanyProfileSource, type CompanyProfileWebsite, type CompanySearch, type CompanySearchOptions, type CompanySocialProfile, type Continent, type ContinentCountries, type ContinentCountriesOptions, type ContinentCountryItem, type ContinentOptions, type Country, type CountryCapital, type CountryDeep, type CountryElevationPoint, type CountryEmergency, type CountryOptions, type CountryStateItem, type CountryStates, type CountryStatesOptions, type CountryTax, 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 DomainRegistrationResult, type DomainResult, type DomainResultDeep, type Elevation, type ElevationLocations, type ElevationOptions, type Email, type EmailDeep, type EmailOptions, type Emoji, type EmojiArtwork, type EmojiArtworkSource, type EmojiBrowse, type EmojiBrowseOptions, EmojiCatalog, type EmojiCatalogConvertOptions, type EmojiCatalogData, EmojiCatalogError, type EmojiCatalogLocalization, type EmojiCatalogLookupOptions, type EmojiCatalogOptions, type EmojiCatalogParseOptions, type EmojiCatalogRegexOptions, type EmojiCatalogScope, type EmojiCatalogSearchFacts, type EmojiCatalogSearchOptions, type EmojiCategories, type EmojiCategory, type EmojiConversion, type EmojiConvertOptions, type EmojiDeep, type EmojiMetadata, type EmojiNativeSearchFacts, type EmojiNotice, type EmojiOptions, type EmojiParse, type EmojiParseOptions, type EmojiPosition, type EmojiSearch, type EmojiSearchOptions, type EmojiShortcodeSourceMetadata, type EmojiSkin, type EmojiSource, type EmojiUnresolved, type EmojiVariant, type Hlr, type HlrDeep, type HlrOptions, type Holiday, type HolidayDate, type HolidayDateOptions, type HolidayOptions, type HolidayYear, type Industry, type IndustryChild, type IndustryCorrection, type IndustryDeep, type IndustryExclusion, type IndustryMatch, type IndustryOptions, type IndustrySearch, type IndustrySearchItem, type IndustrySearchOptions, type Ip, type IpDeep, type IpOptions, type IpSelfOptions, type Language, type LanguageDeep, type LanguageOption, type LanguageOptions, type Mx, type MxOptions, type MxRecord, type Naics, type NaicsChild, type NaicsCorrection, type NaicsDeep, type NaicsExclusion, type NaicsMatch, type NaicsOptions, type NaicsSearch, type NaicsSearchItem, type NaicsSearchOptions, type Name, type NameDeep, type NameOptions, type ParseAPIClient, ParseAPIError, type ParseAPIOptions, type Phone, type PhoneDeep, type PhoneOptions, type Point, type PointCity, type PointDeep, type PointOptions, type Postal, type PostalDeep, type PostalDistance, type PostalDistanceEnd, type PostalDistanceOptions, type PostalLocality, type PostalMetro, type PostalMetrosDeep, type PostalNearby, type PostalNearbyItem, type PostalNearbyOptions, type PostalOptions, type Preflight, type PreflightCost, type PreflightEmailCapacity, type PreflightOperation, type PreflightOperationEstimate, type PreflightPooledCapacity, type PreflightSpendCapacity, type PreflightTask, type PropertyTax, type RequestOptions, type Stack, type StackOptions, type StackResult, type StackTechnology, type State, type StateDeep, type StateDistrictDeep, type StateDistrictItem, type StateDistricts, type StateDistrictsOptions, type StateOptions, type Time, type TimeAtOptions, type TimeLocation, type TimeLocationCandidate, type TimeLocationInput, type TimeOptions, type TimeResolution, type TimeResolutionAlternative, type TimeSeason, type TimeTransition, type TimeTransitionState, type TimeZoneEntry, type TimeZones, type TimeZonesOptions, type Timezone, type TimezoneAtOptions, type TimezoneConversionTarget, type TimezoneConversionTargetDeep, type TimezoneDeep, type TimezoneNextDst, type TimezoneOptions, type Useragent, type UseragentBrowserBrand, type UseragentBrowserDeep, type UseragentDeep, type UseragentDeviceDeep, type UseragentEngineDeep, type UseragentOptions, type UseragentOsDeep, type Weather, type WeatherAir, type WeatherAlert, type WeatherCurrent, type WeatherCurrentDeep, type WeatherDay, type WeatherDeep, type WeatherForecastPeriod, type WeatherHistory, type WeatherHour, type WeatherMinute, type WeatherOptions, type WeatherStation, createBulkClient, parseAPI };
|
|
2472
|
+
export { type Address, type AddressOptions, type AddressSearch, type AddressSearchOptions, type AddressSuggestion, type AgentTask, type AgentTaskInput, type AgentTaskLookupInput, type AgentTaskResult, type Asn, type AsnOptions, BULK_CHECKS, type Bin, type BinOptions, ParseAPIError as BulkAPIError, type BulkClient, type BulkClientOptions, type BulkJob, type BulkPreview, type BulkPreviewInput, type BulkQuote, type BulkRequestOptions, type BulkResult, type BulkStartInput, type BulkStatus, type BulkUpload, type BulkUploadInput, type Caller, type CallerOptions, type Card, type CardDeep, type CardOptions, type Carrier, type CarrierDeep, type CarrierOptions, type City, type CityAmbiguityCandidate, type CityAncestorsOptions, type CityCollection, type CityCollectionFilters, type CityDeep, type CityDistance, type CityDistanceOptions, type CityGrain, type CityIdCall, type CityIdOptions, type CityList, type CityListOptions, type CityLookupCall, type CityMatch, type CityNearby, type CityNearbyCall, type CityNearbyCoordinates, type CityNearbyCoordinatesOptions, type CityNearbyOptions, type CityNearest, type CityNearestCall, type CityNearestOptions, type CityOptions, type CityPagingOptions, type CityParent, type CityRelations, type CityRelationsOptions, type CityResource, type CityResponseOptions, type CityScopeOptions, type CitySearch, type CitySearchCall, type CitySearchOptions, type CitySort, type Company, type CompanyCandidate, type CompanyCountry, type CompanyCoverage, type CompanyCoverageOptions, type CompanyDeep, type CompanyEmailAddress, type CompanyEmailReference, type CompanyIdOptions, type CompanyIndustryReference, type CompanyMatch, type CompanyOptions, type CompanyPhoneNumber, type CompanyPhoneReference, 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 CountryCapital, type CountryDeep, type CountryElevationPoint, type CountryEmergency, type CountryOptions, type CountryStateItem, type CountryStates, type CountryStatesOptions, type CountryTax, 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 DomainRegistrationResult, type DomainResult, type DomainResultDeep, type Elevation, type ElevationLocations, type ElevationOptions, type Email, type EmailDeep, type EmailOptions, type Emoji, type EmojiArtwork, type EmojiArtworkSource, type EmojiBrowse, type EmojiBrowseOptions, EmojiCatalog, type EmojiCatalogConvertOptions, type EmojiCatalogData, EmojiCatalogError, type EmojiCatalogLocalization, type EmojiCatalogLookupOptions, type EmojiCatalogOptions, type EmojiCatalogParseOptions, type EmojiCatalogRegexOptions, type EmojiCatalogScope, type EmojiCatalogSearchFacts, type EmojiCatalogSearchOptions, type EmojiCategories, type EmojiCategory, type EmojiConversion, type EmojiConvertOptions, type EmojiDeep, type EmojiMetadata, type EmojiNativeSearchFacts, type EmojiNotice, type EmojiOptions, type EmojiParse, type EmojiParseOptions, type EmojiPosition, type EmojiSearch, type EmojiSearchOptions, type EmojiShortcodeSourceMetadata, type EmojiSkin, type EmojiSource, type EmojiUnresolved, type EmojiVariant, type Hlr, type HlrDeep, type HlrOptions, type Holiday, type HolidayDate, type HolidayDateOptions, type HolidayOptions, type HolidayYear, type Industry, type IndustryChild, type IndustryCorrection, type IndustryDeep, type IndustryExclusion, type IndustryMatch, type IndustryOptions, type IndustrySearch, type IndustrySearchItem, type IndustrySearchOptions, type Ip, type IpDeep, type IpOptions, type IpSelfOptions, type Language, type LanguageDeep, type LanguageOption, type LanguageOptions, type Mx, type MxOptions, type MxRecord, type Naics, type NaicsChild, type NaicsCorrection, type NaicsDeep, type NaicsExclusion, type NaicsMatch, type NaicsOptions, type NaicsSearch, type NaicsSearchItem, type NaicsSearchOptions, type Name, type NameDeep, type NameOptions, type ParseAPIClient, ParseAPIError, type ParseAPIOptions, type Phone, type PhoneDeep, type PhoneOptions, type Point, type PointCity, type PointDeep, type PointOptions, type Postal, type PostalDeep, type PostalDistance, type PostalDistanceEnd, type PostalDistanceOptions, type PostalLocality, type PostalMetro, type PostalMetrosDeep, type PostalNearby, type PostalNearbyItem, type PostalNearbyOptions, type PostalOptions, type Preflight, type PreflightCost, type PreflightEmailCapacity, type PreflightOperation, type PreflightOperationEstimate, type PreflightPooledCapacity, type PreflightSpendCapacity, type PreflightTask, type PropertyTax, type RequestOptions, type Stack, type StackOptions, type StackResult, type StackTechnology, type State, type StateCapital, type StateDeep, type StateDistrictDeep, type StateDistrictItem, type StateDistricts, type StateDistrictsOptions, type StateOptions, type StateTax, type Time, type TimeAtOptions, type TimeLocation, type TimeLocationCandidate, type TimeLocationInput, type TimeOptions, type TimeResolution, type TimeResolutionAlternative, type TimeSeason, type TimeTransition, type TimeTransitionState, type TimeZoneEntry, type TimeZones, type TimeZonesOptions, type Timezone, type TimezoneAtOptions, type TimezoneConversionTarget, type TimezoneConversionTargetDeep, type TimezoneDeep, type TimezoneNextDst, type TimezoneOptions, type Useragent, type UseragentBrowserBrand, type UseragentBrowserDeep, type UseragentDeep, type UseragentDeviceDeep, type UseragentEngineDeep, type UseragentOptions, type UseragentOsDeep, type Weather, type WeatherAir, type WeatherAlert, type WeatherCurrent, type WeatherCurrentDeep, type WeatherDay, type WeatherDeep, type WeatherForecastPeriod, type WeatherHistory, type WeatherHour, type WeatherMinute, type WeatherOptions, type WeatherStation, createBulkClient, parseAPI };
|
package/dist/index.d.ts
CHANGED
|
@@ -72,7 +72,13 @@ interface Country {
|
|
|
72
72
|
deep?: Deep<CountryDeep>;
|
|
73
73
|
/** IANA timezones used by the country. */
|
|
74
74
|
timezones: string[] | null;
|
|
75
|
+
/** ISO 3166-1 alpha-3 country code. */
|
|
76
|
+
iso_alpha3?: string | null;
|
|
77
|
+
/** ISO 3166-1 numeric country code. */
|
|
78
|
+
iso_numeric?: number | null;
|
|
79
|
+
/** @deprecated Older servers use iso3. Read iso_alpha3 on the current contract. */
|
|
75
80
|
iso3?: string | null;
|
|
81
|
+
/** @deprecated Older servers use numeric. Read iso_numeric on the current contract. */
|
|
76
82
|
numeric?: number | null;
|
|
77
83
|
/** Official long name. */
|
|
78
84
|
name_full?: string | null;
|
|
@@ -114,9 +120,14 @@ interface State {
|
|
|
114
120
|
country_name: string | null;
|
|
115
121
|
latitude: number | null;
|
|
116
122
|
longitude: number | null;
|
|
117
|
-
timezone: string | null;
|
|
118
123
|
timezones: string[];
|
|
119
|
-
|
|
124
|
+
/** Full ISO 3166-2 subdivision code, including its country prefix. */
|
|
125
|
+
iso_subdivision?: string | null;
|
|
126
|
+
/** @deprecated Legacy candidate spelling. Read iso_subdivision on the current contract. */
|
|
127
|
+
iso?: string | null;
|
|
128
|
+
fips: string | null;
|
|
129
|
+
area_codes: string[] | null;
|
|
130
|
+
capital: StateCapital;
|
|
120
131
|
deep?: Deep<StateDeep>;
|
|
121
132
|
}
|
|
122
133
|
interface StateDistrictItem {
|
|
@@ -147,7 +158,6 @@ interface District {
|
|
|
147
158
|
country_name: string | null;
|
|
148
159
|
latitude: number | null;
|
|
149
160
|
longitude: number | null;
|
|
150
|
-
timezone: string | null;
|
|
151
161
|
timezones: string[];
|
|
152
162
|
deep?: Deep<DistrictDeep>;
|
|
153
163
|
}
|
|
@@ -349,11 +359,6 @@ interface Stack {
|
|
|
349
359
|
url: string;
|
|
350
360
|
/** Time of the check, or null when no HTML page could be checked. */
|
|
351
361
|
checked_at: string | null;
|
|
352
|
-
scope: 'homepage' | 'site';
|
|
353
|
-
/** Number of successfully checked HTML pages. */
|
|
354
|
-
pages: number;
|
|
355
|
-
/** True for homepage-only or incomplete bounded checks; null when no HTML page could be checked. False never guarantees every page was visited. */
|
|
356
|
-
partial: boolean | null;
|
|
357
362
|
/** Collections are null when no HTML page could be checked and empty when no matches were found. */
|
|
358
363
|
cms: StackTechnology[] | null;
|
|
359
364
|
servers: StackTechnology[] | null;
|
|
@@ -368,19 +373,21 @@ interface Stack {
|
|
|
368
373
|
}
|
|
369
374
|
interface DomainRegistration {
|
|
370
375
|
registered: boolean;
|
|
371
|
-
created
|
|
372
|
-
updated
|
|
373
|
-
expires
|
|
374
|
-
registrar
|
|
375
|
-
status
|
|
376
|
-
|
|
376
|
+
created?: string | null;
|
|
377
|
+
updated?: string | null;
|
|
378
|
+
expires?: string | null;
|
|
379
|
+
registrar?: string | null;
|
|
380
|
+
status?: string[] | null;
|
|
381
|
+
/** Missing or null is unknown; false is a known unsigned observation. */
|
|
382
|
+
dnssec?: boolean | null;
|
|
377
383
|
}
|
|
378
384
|
interface DomainDeep {
|
|
379
385
|
registration: DomainRegistration;
|
|
380
386
|
}
|
|
381
387
|
interface Domain {
|
|
382
388
|
domain: string;
|
|
383
|
-
|
|
389
|
+
/** true means unregistered, false means registered, null means unknown. */
|
|
390
|
+
available: boolean | null;
|
|
384
391
|
deep?: Deep<DomainDeep>;
|
|
385
392
|
}
|
|
386
393
|
/** Network identity for an autonomous system number. */
|
|
@@ -476,6 +483,11 @@ interface Language {
|
|
|
476
483
|
script: string | null;
|
|
477
484
|
direction: 'ltr' | 'rtl' | string;
|
|
478
485
|
deep?: Deep<LanguageDeep>;
|
|
486
|
+
/** ISO 639-3 language code. */
|
|
487
|
+
iso_alpha3?: string | null;
|
|
488
|
+
/** @deprecated Older servers use iso3. Read iso_alpha3 on the current contract. */
|
|
489
|
+
iso3?: string | null;
|
|
490
|
+
countries?: string[] | null;
|
|
479
491
|
}
|
|
480
492
|
/** 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. */
|
|
481
493
|
interface Name {
|
|
@@ -1189,7 +1201,9 @@ interface CountryDeep {
|
|
|
1189
1201
|
urban_population?: number | null;
|
|
1190
1202
|
/** Share of population using the internet, from 0 to 100. */
|
|
1191
1203
|
internet_users?: number | null;
|
|
1204
|
+
/** @deprecated Older deep contract. Current ISO identifiers live in Core. */
|
|
1192
1205
|
iso3: string;
|
|
1206
|
+
/** @deprecated Older deep contract. Current iso_numeric lives in Core. */
|
|
1193
1207
|
numeric: number;
|
|
1194
1208
|
full_name: string | null;
|
|
1195
1209
|
demonym: string | null;
|
|
@@ -1250,18 +1264,19 @@ interface CountryElevationPoint {
|
|
|
1250
1264
|
elevation: number;
|
|
1251
1265
|
}
|
|
1252
1266
|
interface StateDeep {
|
|
1267
|
+
/** @deprecated Older deep contract. Read Core iso_subdivision on the current contract. */
|
|
1268
|
+
iso_3166_2?: string | null;
|
|
1253
1269
|
population: number | null;
|
|
1254
1270
|
/** @deprecated No longer returned. Retained for source compatibility. */
|
|
1255
1271
|
population_period?: string | null;
|
|
1256
1272
|
/** Total area in km2. */
|
|
1257
1273
|
area: number | null;
|
|
1258
|
-
|
|
1259
|
-
|
|
1260
|
-
|
|
1261
|
-
|
|
1262
|
-
|
|
1263
|
-
|
|
1264
|
-
tax_rate: number | null;
|
|
1274
|
+
tax: StateTax;
|
|
1275
|
+
/** @deprecated Historical Deep read members. */
|
|
1276
|
+
fips?: string | null;
|
|
1277
|
+
capital?: string | null;
|
|
1278
|
+
area_codes?: string[];
|
|
1279
|
+
tax_rate?: number | null;
|
|
1265
1280
|
}
|
|
1266
1281
|
interface DistrictDeep {
|
|
1267
1282
|
population: number | null;
|
|
@@ -1353,8 +1368,10 @@ interface HlrDeep {
|
|
|
1353
1368
|
mnc: string | null;
|
|
1354
1369
|
}
|
|
1355
1370
|
interface LanguageDeep {
|
|
1356
|
-
|
|
1357
|
-
|
|
1371
|
+
/** @deprecated Older deep contract. Read Core iso_alpha3 on the current contract. */
|
|
1372
|
+
iso3?: string | null;
|
|
1373
|
+
/** @deprecated Older deep contract. Current country associations live in Core. */
|
|
1374
|
+
countries?: string[] | null;
|
|
1358
1375
|
}
|
|
1359
1376
|
interface NameDeep {
|
|
1360
1377
|
gender: 'male' | 'female' | null;
|
|
@@ -1602,6 +1619,29 @@ interface CityNearbyCoordinates extends CityCollection {
|
|
|
1602
1619
|
radius: number;
|
|
1603
1620
|
unit: string;
|
|
1604
1621
|
}
|
|
1622
|
+
/** Minimal related records returned in Company Core. Rich Deep records stay separate. */
|
|
1623
|
+
interface CompanyIndustryReference {
|
|
1624
|
+
type: string;
|
|
1625
|
+
code: string;
|
|
1626
|
+
}
|
|
1627
|
+
interface CompanyPhoneReference {
|
|
1628
|
+
number: string;
|
|
1629
|
+
country?: string | null;
|
|
1630
|
+
e164?: string | null;
|
|
1631
|
+
}
|
|
1632
|
+
interface CompanyEmailReference {
|
|
1633
|
+
address: string;
|
|
1634
|
+
}
|
|
1635
|
+
interface StateTax {
|
|
1636
|
+
name: string | null;
|
|
1637
|
+
/** Reference rate in percent. Choose the geographic scope for the task. */
|
|
1638
|
+
rate: number | null;
|
|
1639
|
+
}
|
|
1640
|
+
interface StateCapital {
|
|
1641
|
+
name: string | null;
|
|
1642
|
+
lat: number | null;
|
|
1643
|
+
lon: number | null;
|
|
1644
|
+
}
|
|
1605
1645
|
|
|
1606
1646
|
/** Every non-2xx response from the API. Branch on `code`, never on `message`. */
|
|
1607
1647
|
declare class ParseAPIError extends Error {
|
|
@@ -1871,8 +1911,8 @@ interface DomainResult {
|
|
|
1871
1911
|
available: boolean | null;
|
|
1872
1912
|
deep?: Deep<DomainResultDeep>;
|
|
1873
1913
|
}
|
|
1874
|
-
/**
|
|
1875
|
-
type StackResult =
|
|
1914
|
+
/** Alias for the current Stack response. */
|
|
1915
|
+
type StackResult = Stack;
|
|
1876
1916
|
|
|
1877
1917
|
interface EmojiCatalogLookupOptions {
|
|
1878
1918
|
deep?: boolean;
|
|
@@ -2277,9 +2317,9 @@ declare function parseAPI(apiKey?: string, options?: ParseAPIOptions): {
|
|
|
2277
2317
|
caller: (number: string, opts?: CallerOptions) => Promise<Caller>;
|
|
2278
2318
|
/** 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. */
|
|
2279
2319
|
hlr: (number: string, opts?: HlrOptions) => Promise<Hlr>;
|
|
2280
|
-
/** Identify
|
|
2320
|
+
/** Identify technologies in static homepage HTML and response headers. */
|
|
2281
2321
|
stack: (domain: string, opts?: StackOptions) => Promise<Stack>;
|
|
2282
|
-
/** Check
|
|
2322
|
+
/** Check registration: available is true, false or null when unknown. Paid Deep adds available registration details. */
|
|
2283
2323
|
domain: (domain: string, opts?: DomainOptions) => Promise<Domain>;
|
|
2284
2324
|
/** Check domain registration while preserving unknown availability and partial detail. */
|
|
2285
2325
|
domainResult: (domain: string, opts?: DomainOptions) => Promise<DomainResult>;
|
|
@@ -2429,4 +2469,4 @@ interface CityNearbyCall {
|
|
|
2429
2469
|
(name: string, opts: CityNearbyOptions): Promise<CityNearby | CityCollection>;
|
|
2430
2470
|
}
|
|
2431
2471
|
|
|
2432
|
-
export { type Address, type AddressOptions, type AddressSearch, type AddressSearchOptions, type AddressSuggestion, type AgentTask, type AgentTaskInput, type AgentTaskLookupInput, type AgentTaskResult, type Asn, type AsnOptions, BULK_CHECKS, type Bin, type BinOptions, ParseAPIError as BulkAPIError, type BulkClient, type BulkClientOptions, type BulkJob, type BulkPreview, type BulkPreviewInput, type BulkQuote, type BulkRequestOptions, type BulkResult, type BulkStartInput, type BulkStatus, type BulkUpload, type BulkUploadInput, type Caller, type CallerOptions, type Card, type CardDeep, type CardOptions, type Carrier, type CarrierDeep, type CarrierOptions, type City, type CityAmbiguityCandidate, type CityAncestorsOptions, type CityCollection, type CityCollectionFilters, type CityDeep, type CityDistance, type CityDistanceOptions, type CityGrain, type CityIdCall, type CityIdOptions, type CityList, type CityListOptions, type CityLookupCall, type CityMatch, type CityNearby, type CityNearbyCall, type CityNearbyCoordinates, type CityNearbyCoordinatesOptions, type CityNearbyOptions, type CityNearest, type CityNearestCall, type CityNearestOptions, type CityOptions, type CityPagingOptions, type CityParent, type CityRelations, type CityRelationsOptions, type CityResource, type CityResponseOptions, type CityScopeOptions, type CitySearch, type CitySearchCall, type CitySearchOptions, type CitySort, type Company, type CompanyCandidate, type CompanyCountry, type CompanyCoverage, type CompanyCoverageOptions, type CompanyDeep, type CompanyEmailAddress, type CompanyIdOptions, type CompanyMatch, type CompanyOptions, type CompanyPhoneNumber, type CompanyProfile, type CompanyProfileAddress, type CompanyProfileDeep, type CompanyProfileDomain, type CompanyProfileEmail, type CompanyProfileEmployees, type CompanyProfileFounding, type CompanyProfileIdentifier, type CompanyProfileIndustry, type CompanyProfileJurisdiction, type CompanyProfileListing, type CompanyProfilePhone, type CompanyProfileRegistration, type CompanyProfileRegistrationAddress, type CompanyProfileRegistrationLegalForm, type CompanyProfileSource, type CompanyProfileWebsite, type CompanySearch, type CompanySearchOptions, type CompanySocialProfile, type Continent, type ContinentCountries, type ContinentCountriesOptions, type ContinentCountryItem, type ContinentOptions, type Country, type CountryCapital, type CountryDeep, type CountryElevationPoint, type CountryEmergency, type CountryOptions, type CountryStateItem, type CountryStates, type CountryStatesOptions, type CountryTax, 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 DomainRegistrationResult, type DomainResult, type DomainResultDeep, type Elevation, type ElevationLocations, type ElevationOptions, type Email, type EmailDeep, type EmailOptions, type Emoji, type EmojiArtwork, type EmojiArtworkSource, type EmojiBrowse, type EmojiBrowseOptions, EmojiCatalog, type EmojiCatalogConvertOptions, type EmojiCatalogData, EmojiCatalogError, type EmojiCatalogLocalization, type EmojiCatalogLookupOptions, type EmojiCatalogOptions, type EmojiCatalogParseOptions, type EmojiCatalogRegexOptions, type EmojiCatalogScope, type EmojiCatalogSearchFacts, type EmojiCatalogSearchOptions, type EmojiCategories, type EmojiCategory, type EmojiConversion, type EmojiConvertOptions, type EmojiDeep, type EmojiMetadata, type EmojiNativeSearchFacts, type EmojiNotice, type EmojiOptions, type EmojiParse, type EmojiParseOptions, type EmojiPosition, type EmojiSearch, type EmojiSearchOptions, type EmojiShortcodeSourceMetadata, type EmojiSkin, type EmojiSource, type EmojiUnresolved, type EmojiVariant, type Hlr, type HlrDeep, type HlrOptions, type Holiday, type HolidayDate, type HolidayDateOptions, type HolidayOptions, type HolidayYear, type Industry, type IndustryChild, type IndustryCorrection, type IndustryDeep, type IndustryExclusion, type IndustryMatch, type IndustryOptions, type IndustrySearch, type IndustrySearchItem, type IndustrySearchOptions, type Ip, type IpDeep, type IpOptions, type IpSelfOptions, type Language, type LanguageDeep, type LanguageOption, type LanguageOptions, type Mx, type MxOptions, type MxRecord, type Naics, type NaicsChild, type NaicsCorrection, type NaicsDeep, type NaicsExclusion, type NaicsMatch, type NaicsOptions, type NaicsSearch, type NaicsSearchItem, type NaicsSearchOptions, type Name, type NameDeep, type NameOptions, type ParseAPIClient, ParseAPIError, type ParseAPIOptions, type Phone, type PhoneDeep, type PhoneOptions, type Point, type PointCity, type PointDeep, type PointOptions, type Postal, type PostalDeep, type PostalDistance, type PostalDistanceEnd, type PostalDistanceOptions, type PostalLocality, type PostalMetro, type PostalMetrosDeep, type PostalNearby, type PostalNearbyItem, type PostalNearbyOptions, type PostalOptions, type Preflight, type PreflightCost, type PreflightEmailCapacity, type PreflightOperation, type PreflightOperationEstimate, type PreflightPooledCapacity, type PreflightSpendCapacity, type PreflightTask, type PropertyTax, type RequestOptions, type Stack, type StackOptions, type StackResult, type StackTechnology, type State, type StateDeep, type StateDistrictDeep, type StateDistrictItem, type StateDistricts, type StateDistrictsOptions, type StateOptions, type Time, type TimeAtOptions, type TimeLocation, type TimeLocationCandidate, type TimeLocationInput, type TimeOptions, type TimeResolution, type TimeResolutionAlternative, type TimeSeason, type TimeTransition, type TimeTransitionState, type TimeZoneEntry, type TimeZones, type TimeZonesOptions, type Timezone, type TimezoneAtOptions, type TimezoneConversionTarget, type TimezoneConversionTargetDeep, type TimezoneDeep, type TimezoneNextDst, type TimezoneOptions, type Useragent, type UseragentBrowserBrand, type UseragentBrowserDeep, type UseragentDeep, type UseragentDeviceDeep, type UseragentEngineDeep, type UseragentOptions, type UseragentOsDeep, type Weather, type WeatherAir, type WeatherAlert, type WeatherCurrent, type WeatherCurrentDeep, type WeatherDay, type WeatherDeep, type WeatherForecastPeriod, type WeatherHistory, type WeatherHour, type WeatherMinute, type WeatherOptions, type WeatherStation, createBulkClient, parseAPI };
|
|
2472
|
+
export { type Address, type AddressOptions, type AddressSearch, type AddressSearchOptions, type AddressSuggestion, type AgentTask, type AgentTaskInput, type AgentTaskLookupInput, type AgentTaskResult, type Asn, type AsnOptions, BULK_CHECKS, type Bin, type BinOptions, ParseAPIError as BulkAPIError, type BulkClient, type BulkClientOptions, type BulkJob, type BulkPreview, type BulkPreviewInput, type BulkQuote, type BulkRequestOptions, type BulkResult, type BulkStartInput, type BulkStatus, type BulkUpload, type BulkUploadInput, type Caller, type CallerOptions, type Card, type CardDeep, type CardOptions, type Carrier, type CarrierDeep, type CarrierOptions, type City, type CityAmbiguityCandidate, type CityAncestorsOptions, type CityCollection, type CityCollectionFilters, type CityDeep, type CityDistance, type CityDistanceOptions, type CityGrain, type CityIdCall, type CityIdOptions, type CityList, type CityListOptions, type CityLookupCall, type CityMatch, type CityNearby, type CityNearbyCall, type CityNearbyCoordinates, type CityNearbyCoordinatesOptions, type CityNearbyOptions, type CityNearest, type CityNearestCall, type CityNearestOptions, type CityOptions, type CityPagingOptions, type CityParent, type CityRelations, type CityRelationsOptions, type CityResource, type CityResponseOptions, type CityScopeOptions, type CitySearch, type CitySearchCall, type CitySearchOptions, type CitySort, type Company, type CompanyCandidate, type CompanyCountry, type CompanyCoverage, type CompanyCoverageOptions, type CompanyDeep, type CompanyEmailAddress, type CompanyEmailReference, type CompanyIdOptions, type CompanyIndustryReference, type CompanyMatch, type CompanyOptions, type CompanyPhoneNumber, type CompanyPhoneReference, 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 CountryCapital, type CountryDeep, type CountryElevationPoint, type CountryEmergency, type CountryOptions, type CountryStateItem, type CountryStates, type CountryStatesOptions, type CountryTax, 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 DomainRegistrationResult, type DomainResult, type DomainResultDeep, type Elevation, type ElevationLocations, type ElevationOptions, type Email, type EmailDeep, type EmailOptions, type Emoji, type EmojiArtwork, type EmojiArtworkSource, type EmojiBrowse, type EmojiBrowseOptions, EmojiCatalog, type EmojiCatalogConvertOptions, type EmojiCatalogData, EmojiCatalogError, type EmojiCatalogLocalization, type EmojiCatalogLookupOptions, type EmojiCatalogOptions, type EmojiCatalogParseOptions, type EmojiCatalogRegexOptions, type EmojiCatalogScope, type EmojiCatalogSearchFacts, type EmojiCatalogSearchOptions, type EmojiCategories, type EmojiCategory, type EmojiConversion, type EmojiConvertOptions, type EmojiDeep, type EmojiMetadata, type EmojiNativeSearchFacts, type EmojiNotice, type EmojiOptions, type EmojiParse, type EmojiParseOptions, type EmojiPosition, type EmojiSearch, type EmojiSearchOptions, type EmojiShortcodeSourceMetadata, type EmojiSkin, type EmojiSource, type EmojiUnresolved, type EmojiVariant, type Hlr, type HlrDeep, type HlrOptions, type Holiday, type HolidayDate, type HolidayDateOptions, type HolidayOptions, type HolidayYear, type Industry, type IndustryChild, type IndustryCorrection, type IndustryDeep, type IndustryExclusion, type IndustryMatch, type IndustryOptions, type IndustrySearch, type IndustrySearchItem, type IndustrySearchOptions, type Ip, type IpDeep, type IpOptions, type IpSelfOptions, type Language, type LanguageDeep, type LanguageOption, type LanguageOptions, type Mx, type MxOptions, type MxRecord, type Naics, type NaicsChild, type NaicsCorrection, type NaicsDeep, type NaicsExclusion, type NaicsMatch, type NaicsOptions, type NaicsSearch, type NaicsSearchItem, type NaicsSearchOptions, type Name, type NameDeep, type NameOptions, type ParseAPIClient, ParseAPIError, type ParseAPIOptions, type Phone, type PhoneDeep, type PhoneOptions, type Point, type PointCity, type PointDeep, type PointOptions, type Postal, type PostalDeep, type PostalDistance, type PostalDistanceEnd, type PostalDistanceOptions, type PostalLocality, type PostalMetro, type PostalMetrosDeep, type PostalNearby, type PostalNearbyItem, type PostalNearbyOptions, type PostalOptions, type Preflight, type PreflightCost, type PreflightEmailCapacity, type PreflightOperation, type PreflightOperationEstimate, type PreflightPooledCapacity, type PreflightSpendCapacity, type PreflightTask, type PropertyTax, type RequestOptions, type Stack, type StackOptions, type StackResult, type StackTechnology, type State, type StateCapital, type StateDeep, type StateDistrictDeep, type StateDistrictItem, type StateDistricts, type StateDistrictsOptions, type StateOptions, type StateTax, type Time, type TimeAtOptions, type TimeLocation, type TimeLocationCandidate, type TimeLocationInput, type TimeOptions, type TimeResolution, type TimeResolutionAlternative, type TimeSeason, type TimeTransition, type TimeTransitionState, type TimeZoneEntry, type TimeZones, type TimeZonesOptions, type Timezone, type TimezoneAtOptions, type TimezoneConversionTarget, type TimezoneConversionTargetDeep, type TimezoneDeep, type TimezoneNextDst, type TimezoneOptions, type Useragent, type UseragentBrowserBrand, type UseragentBrowserDeep, type UseragentDeep, type UseragentDeviceDeep, type UseragentEngineDeep, type UseragentOptions, type UseragentOsDeep, type Weather, type WeatherAir, type WeatherAlert, type WeatherCurrent, type WeatherCurrentDeep, type WeatherDay, type WeatherDeep, type WeatherForecastPeriod, type WeatherHistory, type WeatherHour, type WeatherMinute, type WeatherOptions, type WeatherStation, createBulkClient, parseAPI };
|
package/dist/index.js
CHANGED
|
@@ -416,7 +416,7 @@ var EmojiCatalog = class {
|
|
|
416
416
|
};
|
|
417
417
|
|
|
418
418
|
// src/index.ts
|
|
419
|
-
var VERSION = "1.12.
|
|
419
|
+
var VERSION = "1.12.6";
|
|
420
420
|
var API_VERSION = "2.0.0";
|
|
421
421
|
var DEFAULT_BASE_URL = "https://api.parseapi.com";
|
|
422
422
|
var DEFAULT_TIMEOUT_MS = 1e4;
|
|
@@ -718,9 +718,9 @@ function parseAPI(apiKey, options = {}) {
|
|
|
718
718
|
caller: (number, opts) => request(`/caller/${enc(number)}`, { country: opts?.country }, void 0, opts),
|
|
719
719
|
/** 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. */
|
|
720
720
|
hlr: (number, opts) => request(`/hlr/${enc(number)}`, { country: opts?.country, ...deepQuery(opts) }, void 0, opts),
|
|
721
|
-
/** Identify
|
|
721
|
+
/** Identify technologies in static homepage HTML and response headers. */
|
|
722
722
|
stack: (domain, opts) => request(`/stack/${enc(domain)}`, { ...deepQuery(opts), pretty: opts?.pretty }, void 0, opts),
|
|
723
|
-
/** Check
|
|
723
|
+
/** Check registration: available is true, false or null when unknown. Paid Deep adds available registration details. */
|
|
724
724
|
domain: (domain, opts) => request(`/domain/${enc(domain)}`, deepQuery(opts), void 0, opts),
|
|
725
725
|
/** Check domain registration while preserving unknown availability and partial detail. */
|
|
726
726
|
domainResult: (domain, opts) => request(`/domain/${enc(domain)}`, deepQuery(opts), void 0, opts),
|