higherdata-sdk 0.4.0 → 0.5.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 +837 -31
- package/dist/index.js +379 -72
- package/package.json +1 -1
package/dist/index.js
CHANGED
|
@@ -34,6 +34,7 @@ var TOOL_NAMES = [
|
|
|
34
34
|
"crm.get_enrichment_options",
|
|
35
35
|
"crm.get_setup",
|
|
36
36
|
"crm.get_sync_setup",
|
|
37
|
+
"crm.list_enrichment_jobs",
|
|
37
38
|
"crm.push",
|
|
38
39
|
"crm.search",
|
|
39
40
|
"crm.status",
|
|
@@ -66,6 +67,7 @@ var TOOL_NAMES = [
|
|
|
66
67
|
"lists.get",
|
|
67
68
|
"lists.refresh",
|
|
68
69
|
"lists.run",
|
|
70
|
+
"lists.status",
|
|
69
71
|
"lookup.company",
|
|
70
72
|
"lookup.find",
|
|
71
73
|
"lookup.person",
|
|
@@ -1138,6 +1140,11 @@ var TOOL_CATALOG = [
|
|
|
1138
1140
|
"type": "string",
|
|
1139
1141
|
"maxLength": 120
|
|
1140
1142
|
},
|
|
1143
|
+
"domain": {
|
|
1144
|
+
"description": "Exact normalized company domain. Company searches only.",
|
|
1145
|
+
"type": "string",
|
|
1146
|
+
"maxLength": 253
|
|
1147
|
+
},
|
|
1141
1148
|
"missingField": {
|
|
1142
1149
|
"description": "Only records with an empty synced property.",
|
|
1143
1150
|
"type": "string",
|
|
@@ -1420,6 +1427,44 @@ var TOOL_CATALOG = [
|
|
|
1420
1427
|
"additionalProperties": false
|
|
1421
1428
|
}
|
|
1422
1429
|
},
|
|
1430
|
+
{
|
|
1431
|
+
"name": "crm.list_enrichment_jobs",
|
|
1432
|
+
"description": "List your CRM enrichment previews and proposal jobs in this space, newest first. History contains no record samples.",
|
|
1433
|
+
"risk": "read",
|
|
1434
|
+
"scopes": [
|
|
1435
|
+
"crm:write"
|
|
1436
|
+
],
|
|
1437
|
+
"input": {
|
|
1438
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
1439
|
+
"type": "object",
|
|
1440
|
+
"properties": {
|
|
1441
|
+
"cursor": {
|
|
1442
|
+
"description": "Continuation from the previous history page.",
|
|
1443
|
+
"type": "object",
|
|
1444
|
+
"properties": {
|
|
1445
|
+
"createdAt": {
|
|
1446
|
+
"type": "string",
|
|
1447
|
+
"format": "date-time",
|
|
1448
|
+
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
|
|
1449
|
+
"description": "Creation time of the last job on the previous page."
|
|
1450
|
+
},
|
|
1451
|
+
"id": {
|
|
1452
|
+
"type": "string",
|
|
1453
|
+
"format": "uuid",
|
|
1454
|
+
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
|
|
1455
|
+
"description": "Id of the last job on the previous page."
|
|
1456
|
+
}
|
|
1457
|
+
},
|
|
1458
|
+
"required": [
|
|
1459
|
+
"createdAt",
|
|
1460
|
+
"id"
|
|
1461
|
+
],
|
|
1462
|
+
"additionalProperties": false
|
|
1463
|
+
}
|
|
1464
|
+
},
|
|
1465
|
+
"additionalProperties": false
|
|
1466
|
+
}
|
|
1467
|
+
},
|
|
1423
1468
|
{
|
|
1424
1469
|
"name": "crm.push",
|
|
1425
1470
|
"description": "Propose CRM changes for human review. Creates a pending-approval change set. It never dispatches a HubSpot write; approve fields and call changes.apply separately. Dry run returns the proposal only.",
|
|
@@ -1820,6 +1865,11 @@ var TOOL_CATALOG = [
|
|
|
1820
1865
|
"type": "string",
|
|
1821
1866
|
"maxLength": 120
|
|
1822
1867
|
},
|
|
1868
|
+
"domain": {
|
|
1869
|
+
"description": "Exact normalized company domain. Company searches only.",
|
|
1870
|
+
"type": "string",
|
|
1871
|
+
"maxLength": 253
|
|
1872
|
+
},
|
|
1823
1873
|
"missingField": {
|
|
1824
1874
|
"description": "Only records with an empty synced property.",
|
|
1825
1875
|
"type": "string",
|
|
@@ -4376,6 +4426,36 @@ var TOOL_CATALOG = [
|
|
|
4376
4426
|
"filters": {
|
|
4377
4427
|
"type": "object",
|
|
4378
4428
|
"properties": {
|
|
4429
|
+
"companyNames": {
|
|
4430
|
+
"description": "Company name prefixes. Match any name.",
|
|
4431
|
+
"minItems": 1,
|
|
4432
|
+
"maxItems": 5,
|
|
4433
|
+
"type": "array",
|
|
4434
|
+
"items": {
|
|
4435
|
+
"type": "string",
|
|
4436
|
+
"minLength": 1,
|
|
4437
|
+
"maxLength": 120,
|
|
4438
|
+
"pattern": "\\S"
|
|
4439
|
+
}
|
|
4440
|
+
},
|
|
4441
|
+
"excludeCompanyNames": {
|
|
4442
|
+
"description": "Company name prefixes to leave out.",
|
|
4443
|
+
"minItems": 1,
|
|
4444
|
+
"maxItems": 5,
|
|
4445
|
+
"type": "array",
|
|
4446
|
+
"items": {
|
|
4447
|
+
"type": "string",
|
|
4448
|
+
"minLength": 1,
|
|
4449
|
+
"maxLength": 120,
|
|
4450
|
+
"pattern": "\\S"
|
|
4451
|
+
}
|
|
4452
|
+
},
|
|
4453
|
+
"domain": {
|
|
4454
|
+
"description": "Company website domain. Exact host matching; root sites rank first.",
|
|
4455
|
+
"type": "string",
|
|
4456
|
+
"minLength": 1,
|
|
4457
|
+
"maxLength": 320
|
|
4458
|
+
},
|
|
4379
4459
|
"countryCodes": {
|
|
4380
4460
|
"description": "Two-letter country codes to include.",
|
|
4381
4461
|
"minItems": 1,
|
|
@@ -4547,9 +4627,7 @@ var TOOL_CATALOG = [
|
|
|
4547
4627
|
"type": "array",
|
|
4548
4628
|
"items": {
|
|
4549
4629
|
"type": "string",
|
|
4550
|
-
"
|
|
4551
|
-
"maxLength": 120,
|
|
4552
|
-
"pattern": "\\S"
|
|
4630
|
+
"pattern": "^[0-9]{6}$"
|
|
4553
4631
|
}
|
|
4554
4632
|
},
|
|
4555
4633
|
"excludeNaics2022Codes": {
|
|
@@ -4559,9 +4637,7 @@ var TOOL_CATALOG = [
|
|
|
4559
4637
|
"type": "array",
|
|
4560
4638
|
"items": {
|
|
4561
4639
|
"type": "string",
|
|
4562
|
-
"
|
|
4563
|
-
"maxLength": 120,
|
|
4564
|
-
"pattern": "\\S"
|
|
4640
|
+
"pattern": "^[0-9]{6}$"
|
|
4565
4641
|
}
|
|
4566
4642
|
},
|
|
4567
4643
|
"fundingTypes": {
|
|
@@ -4690,12 +4766,6 @@ var TOOL_CATALOG = [
|
|
|
4690
4766
|
"maxLength": 320
|
|
4691
4767
|
}
|
|
4692
4768
|
},
|
|
4693
|
-
"domain": {
|
|
4694
|
-
"description": "Website domain. Matching is exact on the host, and a root site ranks first.",
|
|
4695
|
-
"type": "string",
|
|
4696
|
-
"minLength": 1,
|
|
4697
|
-
"maxLength": 320
|
|
4698
|
-
},
|
|
4699
4769
|
"insights": {
|
|
4700
4770
|
"description": "Insights filters. Supply at least one.",
|
|
4701
4771
|
"type": "object",
|
|
@@ -5399,6 +5469,36 @@ var TOOL_CATALOG = [
|
|
|
5399
5469
|
"filters": {
|
|
5400
5470
|
"type": "object",
|
|
5401
5471
|
"properties": {
|
|
5472
|
+
"companyNames": {
|
|
5473
|
+
"description": "Company name alternatives or a domain. Finds the 50 closest token or prefix matches, ignoring punctuation, accents and legal suffixes.",
|
|
5474
|
+
"minItems": 1,
|
|
5475
|
+
"maxItems": 5,
|
|
5476
|
+
"type": "array",
|
|
5477
|
+
"items": {
|
|
5478
|
+
"type": "string",
|
|
5479
|
+
"minLength": 1,
|
|
5480
|
+
"maxLength": 120,
|
|
5481
|
+
"pattern": "\\S"
|
|
5482
|
+
}
|
|
5483
|
+
},
|
|
5484
|
+
"excludeCompanyNames": {
|
|
5485
|
+
"description": "Company name prefixes to leave out.",
|
|
5486
|
+
"minItems": 1,
|
|
5487
|
+
"maxItems": 5,
|
|
5488
|
+
"type": "array",
|
|
5489
|
+
"items": {
|
|
5490
|
+
"type": "string",
|
|
5491
|
+
"minLength": 1,
|
|
5492
|
+
"maxLength": 120,
|
|
5493
|
+
"pattern": "\\S"
|
|
5494
|
+
}
|
|
5495
|
+
},
|
|
5496
|
+
"domain": {
|
|
5497
|
+
"description": "Company website domain. Exact host matching; root sites rank first.",
|
|
5498
|
+
"type": "string",
|
|
5499
|
+
"minLength": 1,
|
|
5500
|
+
"maxLength": 320
|
|
5501
|
+
},
|
|
5402
5502
|
"countryCodes": {
|
|
5403
5503
|
"description": "Two-letter country codes to include.",
|
|
5404
5504
|
"minItems": 1,
|
|
@@ -5498,9 +5598,7 @@ var TOOL_CATALOG = [
|
|
|
5498
5598
|
"type": "array",
|
|
5499
5599
|
"items": {
|
|
5500
5600
|
"type": "string",
|
|
5501
|
-
"
|
|
5502
|
-
"maxLength": 120,
|
|
5503
|
-
"pattern": "\\S"
|
|
5601
|
+
"pattern": "^[0-9]{6}$"
|
|
5504
5602
|
}
|
|
5505
5603
|
},
|
|
5506
5604
|
"excludeNaics2022Codes": {
|
|
@@ -5510,9 +5608,7 @@ var TOOL_CATALOG = [
|
|
|
5510
5608
|
"type": "array",
|
|
5511
5609
|
"items": {
|
|
5512
5610
|
"type": "string",
|
|
5513
|
-
"
|
|
5514
|
-
"maxLength": 120,
|
|
5515
|
-
"pattern": "\\S"
|
|
5611
|
+
"pattern": "^[0-9]{6}$"
|
|
5516
5612
|
}
|
|
5517
5613
|
},
|
|
5518
5614
|
"fundingTypes": {
|
|
@@ -5641,6 +5737,25 @@ var TOOL_CATALOG = [
|
|
|
5641
5737
|
"maxLength": 320
|
|
5642
5738
|
}
|
|
5643
5739
|
},
|
|
5740
|
+
"personNames": {
|
|
5741
|
+
"description": "Person name alternatives. Requires a company name, domain or id. Matches first or last name for one token, or first and last name for two tokens, ignoring case and accents.",
|
|
5742
|
+
"minItems": 1,
|
|
5743
|
+
"maxItems": 5,
|
|
5744
|
+
"type": "array",
|
|
5745
|
+
"items": {
|
|
5746
|
+
"type": "string",
|
|
5747
|
+
"minLength": 1,
|
|
5748
|
+
"maxLength": 120,
|
|
5749
|
+
"pattern": "\\S"
|
|
5750
|
+
}
|
|
5751
|
+
},
|
|
5752
|
+
"email": {
|
|
5753
|
+
"description": "Exact work email address, matched through the email index.",
|
|
5754
|
+
"type": "string",
|
|
5755
|
+
"maxLength": 320,
|
|
5756
|
+
"format": "email",
|
|
5757
|
+
"pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"
|
|
5758
|
+
},
|
|
5644
5759
|
"personCities": {
|
|
5645
5760
|
"description": "Person cities to include. Requires personCountryCodes.",
|
|
5646
5761
|
"minItems": 1,
|
|
@@ -6197,7 +6312,7 @@ var TOOL_CATALOG = [
|
|
|
6197
6312
|
},
|
|
6198
6313
|
{
|
|
6199
6314
|
"name": "lists.refresh",
|
|
6200
|
-
"description": "Preview or refresh a static selection or audience in bounded pages. Record
|
|
6315
|
+
"description": "Preview or refresh a static selection or audience in bounded pages. Record caps keep the first matching records that fit. New-record caps can block a refresh before changes. Dry run reports additions, flags and removals.",
|
|
6201
6316
|
"risk": "write_local",
|
|
6202
6317
|
"scopes": [
|
|
6203
6318
|
"data:read",
|
|
@@ -6229,7 +6344,7 @@ var TOOL_CATALOG = [
|
|
|
6229
6344
|
},
|
|
6230
6345
|
{
|
|
6231
6346
|
"name": "lists.run",
|
|
6232
|
-
"description": "Queue a
|
|
6347
|
+
"description": "Queue a background preview or refresh. Only one job runs per list. Owners and admins can refresh dynamic lists now, including the current release. Dry run reports the proposed release without queueing.",
|
|
6233
6348
|
"risk": "write_local",
|
|
6234
6349
|
"scopes": [
|
|
6235
6350
|
"data:read",
|
|
@@ -6244,6 +6359,15 @@ var TOOL_CATALOG = [
|
|
|
6244
6359
|
"format": "uuid",
|
|
6245
6360
|
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
|
|
6246
6361
|
"description": "Saved list id."
|
|
6362
|
+
},
|
|
6363
|
+
"purpose": {
|
|
6364
|
+
"default": "refresh",
|
|
6365
|
+
"description": "Preview counts without changing records, or refresh using the saved caps.",
|
|
6366
|
+
"type": "string",
|
|
6367
|
+
"enum": [
|
|
6368
|
+
"preview",
|
|
6369
|
+
"refresh"
|
|
6370
|
+
]
|
|
6247
6371
|
}
|
|
6248
6372
|
},
|
|
6249
6373
|
"required": [
|
|
@@ -6252,6 +6376,37 @@ var TOOL_CATALOG = [
|
|
|
6252
6376
|
"additionalProperties": false
|
|
6253
6377
|
}
|
|
6254
6378
|
},
|
|
6379
|
+
{
|
|
6380
|
+
"name": "lists.status",
|
|
6381
|
+
"description": "Read the progress and count-only summary of a background list preview or refresh.",
|
|
6382
|
+
"risk": "read",
|
|
6383
|
+
"scopes": [
|
|
6384
|
+
"data:read"
|
|
6385
|
+
],
|
|
6386
|
+
"input": {
|
|
6387
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
6388
|
+
"type": "object",
|
|
6389
|
+
"properties": {
|
|
6390
|
+
"id": {
|
|
6391
|
+
"type": "string",
|
|
6392
|
+
"format": "uuid",
|
|
6393
|
+
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
|
|
6394
|
+
"description": "Saved list id."
|
|
6395
|
+
},
|
|
6396
|
+
"runId": {
|
|
6397
|
+
"type": "string",
|
|
6398
|
+
"format": "uuid",
|
|
6399
|
+
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
|
|
6400
|
+
"description": "Background run id returned by lists.run."
|
|
6401
|
+
}
|
|
6402
|
+
},
|
|
6403
|
+
"required": [
|
|
6404
|
+
"id",
|
|
6405
|
+
"runId"
|
|
6406
|
+
],
|
|
6407
|
+
"additionalProperties": false
|
|
6408
|
+
}
|
|
6409
|
+
},
|
|
6255
6410
|
{
|
|
6256
6411
|
"name": "lookup.company",
|
|
6257
6412
|
"description": "Look up a company by exactly one domain, exact name (optionally with location), or opaque hdo_ id. Returns bounded candidates and ambiguity metadata. Insights fields and filters require the Insights or Unlimited plan.",
|
|
@@ -6560,6 +6715,36 @@ var TOOL_CATALOG = [
|
|
|
6560
6715
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
6561
6716
|
"type": "object",
|
|
6562
6717
|
"properties": {
|
|
6718
|
+
"companyNames": {
|
|
6719
|
+
"description": "Company name prefixes. Match any name.",
|
|
6720
|
+
"minItems": 1,
|
|
6721
|
+
"maxItems": 5,
|
|
6722
|
+
"type": "array",
|
|
6723
|
+
"items": {
|
|
6724
|
+
"type": "string",
|
|
6725
|
+
"minLength": 1,
|
|
6726
|
+
"maxLength": 120,
|
|
6727
|
+
"pattern": "\\S"
|
|
6728
|
+
}
|
|
6729
|
+
},
|
|
6730
|
+
"excludeCompanyNames": {
|
|
6731
|
+
"description": "Company name prefixes to leave out.",
|
|
6732
|
+
"minItems": 1,
|
|
6733
|
+
"maxItems": 5,
|
|
6734
|
+
"type": "array",
|
|
6735
|
+
"items": {
|
|
6736
|
+
"type": "string",
|
|
6737
|
+
"minLength": 1,
|
|
6738
|
+
"maxLength": 120,
|
|
6739
|
+
"pattern": "\\S"
|
|
6740
|
+
}
|
|
6741
|
+
},
|
|
6742
|
+
"domain": {
|
|
6743
|
+
"description": "Company website domain. Exact host matching; root sites rank first.",
|
|
6744
|
+
"type": "string",
|
|
6745
|
+
"minLength": 1,
|
|
6746
|
+
"maxLength": 320
|
|
6747
|
+
},
|
|
6563
6748
|
"countryCodes": {
|
|
6564
6749
|
"description": "Two-letter country codes to include.",
|
|
6565
6750
|
"minItems": 1,
|
|
@@ -6731,9 +6916,7 @@ var TOOL_CATALOG = [
|
|
|
6731
6916
|
"type": "array",
|
|
6732
6917
|
"items": {
|
|
6733
6918
|
"type": "string",
|
|
6734
|
-
"
|
|
6735
|
-
"maxLength": 120,
|
|
6736
|
-
"pattern": "\\S"
|
|
6919
|
+
"pattern": "^[0-9]{6}$"
|
|
6737
6920
|
}
|
|
6738
6921
|
},
|
|
6739
6922
|
"excludeNaics2022Codes": {
|
|
@@ -6743,9 +6926,7 @@ var TOOL_CATALOG = [
|
|
|
6743
6926
|
"type": "array",
|
|
6744
6927
|
"items": {
|
|
6745
6928
|
"type": "string",
|
|
6746
|
-
"
|
|
6747
|
-
"maxLength": 120,
|
|
6748
|
-
"pattern": "\\S"
|
|
6929
|
+
"pattern": "^[0-9]{6}$"
|
|
6749
6930
|
}
|
|
6750
6931
|
},
|
|
6751
6932
|
"fundingTypes": {
|
|
@@ -6887,12 +7068,6 @@ var TOOL_CATALOG = [
|
|
|
6887
7068
|
"minLength": 1,
|
|
6888
7069
|
"maxLength": 2048
|
|
6889
7070
|
},
|
|
6890
|
-
"domain": {
|
|
6891
|
-
"description": "Website domain. Matching is exact on the host, and a root site ranks first.",
|
|
6892
|
-
"type": "string",
|
|
6893
|
-
"minLength": 1,
|
|
6894
|
-
"maxLength": 320
|
|
6895
|
-
},
|
|
6896
7071
|
"insights": {
|
|
6897
7072
|
"description": "Insights filters. Supply at least one.",
|
|
6898
7073
|
"type": "object",
|
|
@@ -7595,6 +7770,36 @@ var TOOL_CATALOG = [
|
|
|
7595
7770
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
7596
7771
|
"type": "object",
|
|
7597
7772
|
"properties": {
|
|
7773
|
+
"companyNames": {
|
|
7774
|
+
"description": "Company name prefixes. Match any name.",
|
|
7775
|
+
"minItems": 1,
|
|
7776
|
+
"maxItems": 5,
|
|
7777
|
+
"type": "array",
|
|
7778
|
+
"items": {
|
|
7779
|
+
"type": "string",
|
|
7780
|
+
"minLength": 1,
|
|
7781
|
+
"maxLength": 120,
|
|
7782
|
+
"pattern": "\\S"
|
|
7783
|
+
}
|
|
7784
|
+
},
|
|
7785
|
+
"excludeCompanyNames": {
|
|
7786
|
+
"description": "Company name prefixes to leave out.",
|
|
7787
|
+
"minItems": 1,
|
|
7788
|
+
"maxItems": 5,
|
|
7789
|
+
"type": "array",
|
|
7790
|
+
"items": {
|
|
7791
|
+
"type": "string",
|
|
7792
|
+
"minLength": 1,
|
|
7793
|
+
"maxLength": 120,
|
|
7794
|
+
"pattern": "\\S"
|
|
7795
|
+
}
|
|
7796
|
+
},
|
|
7797
|
+
"domain": {
|
|
7798
|
+
"description": "Company website domain. Exact host matching; root sites rank first.",
|
|
7799
|
+
"type": "string",
|
|
7800
|
+
"minLength": 1,
|
|
7801
|
+
"maxLength": 320
|
|
7802
|
+
},
|
|
7598
7803
|
"countryCodes": {
|
|
7599
7804
|
"description": "Two-letter country codes to include.",
|
|
7600
7805
|
"minItems": 1,
|
|
@@ -7766,9 +7971,7 @@ var TOOL_CATALOG = [
|
|
|
7766
7971
|
"type": "array",
|
|
7767
7972
|
"items": {
|
|
7768
7973
|
"type": "string",
|
|
7769
|
-
"
|
|
7770
|
-
"maxLength": 120,
|
|
7771
|
-
"pattern": "\\S"
|
|
7974
|
+
"pattern": "^[0-9]{6}$"
|
|
7772
7975
|
}
|
|
7773
7976
|
},
|
|
7774
7977
|
"excludeNaics2022Codes": {
|
|
@@ -7778,9 +7981,7 @@ var TOOL_CATALOG = [
|
|
|
7778
7981
|
"type": "array",
|
|
7779
7982
|
"items": {
|
|
7780
7983
|
"type": "string",
|
|
7781
|
-
"
|
|
7782
|
-
"maxLength": 120,
|
|
7783
|
-
"pattern": "\\S"
|
|
7984
|
+
"pattern": "^[0-9]{6}$"
|
|
7784
7985
|
}
|
|
7785
7986
|
},
|
|
7786
7987
|
"fundingTypes": {
|
|
@@ -7909,12 +8110,6 @@ var TOOL_CATALOG = [
|
|
|
7909
8110
|
"maxLength": 320
|
|
7910
8111
|
}
|
|
7911
8112
|
},
|
|
7912
|
-
"domain": {
|
|
7913
|
-
"description": "Website domain. Matching is exact on the host, and a root site ranks first.",
|
|
7914
|
-
"type": "string",
|
|
7915
|
-
"minLength": 1,
|
|
7916
|
-
"maxLength": 320
|
|
7917
|
-
},
|
|
7918
8113
|
"insights": {
|
|
7919
8114
|
"description": "Insights filters. Supply at least one.",
|
|
7920
8115
|
"type": "object",
|
|
@@ -8602,7 +8797,7 @@ var TOOL_CATALOG = [
|
|
|
8602
8797
|
},
|
|
8603
8798
|
{
|
|
8604
8799
|
"name": "search.facets",
|
|
8605
|
-
"description": "Read
|
|
8800
|
+
"description": "Read release-built country, state, industry, NAICS, funding, department, seniority and role family values from HigherData Core, with optional country-scoped company, person or job city suggestions. Eligible plans also receive technology product suggestions.",
|
|
8606
8801
|
"risk": "read",
|
|
8607
8802
|
"scopes": [
|
|
8608
8803
|
"data:read"
|
|
@@ -8701,7 +8896,7 @@ var TOOL_CATALOG = [
|
|
|
8701
8896
|
},
|
|
8702
8897
|
{
|
|
8703
8898
|
"name": "search.people",
|
|
8704
|
-
"description": "Find people in HigherData Core, with 1 to 5 positive company HQ country codes or industries required unless
|
|
8899
|
+
"description": "Find people in HigherData Core, with 1 to 5 positive company HQ country codes or industries required unless a company id, company name, domain or indexed email scopes the search. Person names require a company scope. Person, job and company location use distinct filters; each city filter requires its corresponding country. Company-scoped contacts also support legacy contactLocation filters. Pages contain at most 50 people and opaque ids. ",
|
|
8705
8900
|
"risk": "read",
|
|
8706
8901
|
"scopes": [
|
|
8707
8902
|
"data:read"
|
|
@@ -8710,6 +8905,36 @@ var TOOL_CATALOG = [
|
|
|
8710
8905
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
8711
8906
|
"type": "object",
|
|
8712
8907
|
"properties": {
|
|
8908
|
+
"companyNames": {
|
|
8909
|
+
"description": "Company name alternatives or a domain. Finds the 50 closest token or prefix matches, ignoring punctuation, accents and legal suffixes.",
|
|
8910
|
+
"minItems": 1,
|
|
8911
|
+
"maxItems": 5,
|
|
8912
|
+
"type": "array",
|
|
8913
|
+
"items": {
|
|
8914
|
+
"type": "string",
|
|
8915
|
+
"minLength": 1,
|
|
8916
|
+
"maxLength": 120,
|
|
8917
|
+
"pattern": "\\S"
|
|
8918
|
+
}
|
|
8919
|
+
},
|
|
8920
|
+
"excludeCompanyNames": {
|
|
8921
|
+
"description": "Company name prefixes to leave out.",
|
|
8922
|
+
"minItems": 1,
|
|
8923
|
+
"maxItems": 5,
|
|
8924
|
+
"type": "array",
|
|
8925
|
+
"items": {
|
|
8926
|
+
"type": "string",
|
|
8927
|
+
"minLength": 1,
|
|
8928
|
+
"maxLength": 120,
|
|
8929
|
+
"pattern": "\\S"
|
|
8930
|
+
}
|
|
8931
|
+
},
|
|
8932
|
+
"domain": {
|
|
8933
|
+
"description": "Company website domain. Exact host matching; root sites rank first.",
|
|
8934
|
+
"type": "string",
|
|
8935
|
+
"minLength": 1,
|
|
8936
|
+
"maxLength": 320
|
|
8937
|
+
},
|
|
8713
8938
|
"countryCodes": {
|
|
8714
8939
|
"description": "Two-letter country codes to include.",
|
|
8715
8940
|
"minItems": 1,
|
|
@@ -8809,9 +9034,7 @@ var TOOL_CATALOG = [
|
|
|
8809
9034
|
"type": "array",
|
|
8810
9035
|
"items": {
|
|
8811
9036
|
"type": "string",
|
|
8812
|
-
"
|
|
8813
|
-
"maxLength": 120,
|
|
8814
|
-
"pattern": "\\S"
|
|
9037
|
+
"pattern": "^[0-9]{6}$"
|
|
8815
9038
|
}
|
|
8816
9039
|
},
|
|
8817
9040
|
"excludeNaics2022Codes": {
|
|
@@ -8821,9 +9044,7 @@ var TOOL_CATALOG = [
|
|
|
8821
9044
|
"type": "array",
|
|
8822
9045
|
"items": {
|
|
8823
9046
|
"type": "string",
|
|
8824
|
-
"
|
|
8825
|
-
"maxLength": 120,
|
|
8826
|
-
"pattern": "\\S"
|
|
9047
|
+
"pattern": "^[0-9]{6}$"
|
|
8827
9048
|
}
|
|
8828
9049
|
},
|
|
8829
9050
|
"fundingTypes": {
|
|
@@ -8952,6 +9173,25 @@ var TOOL_CATALOG = [
|
|
|
8952
9173
|
"maxLength": 320
|
|
8953
9174
|
}
|
|
8954
9175
|
},
|
|
9176
|
+
"personNames": {
|
|
9177
|
+
"description": "Person name alternatives. Requires a company name, domain or id. Matches first or last name for one token, or first and last name for two tokens, ignoring case and accents.",
|
|
9178
|
+
"minItems": 1,
|
|
9179
|
+
"maxItems": 5,
|
|
9180
|
+
"type": "array",
|
|
9181
|
+
"items": {
|
|
9182
|
+
"type": "string",
|
|
9183
|
+
"minLength": 1,
|
|
9184
|
+
"maxLength": 120,
|
|
9185
|
+
"pattern": "\\S"
|
|
9186
|
+
}
|
|
9187
|
+
},
|
|
9188
|
+
"email": {
|
|
9189
|
+
"description": "Exact work email address, matched through the email index.",
|
|
9190
|
+
"type": "string",
|
|
9191
|
+
"maxLength": 320,
|
|
9192
|
+
"format": "email",
|
|
9193
|
+
"pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"
|
|
9194
|
+
},
|
|
8955
9195
|
"personCities": {
|
|
8956
9196
|
"description": "Person cities to include. Requires personCountryCodes.",
|
|
8957
9197
|
"minItems": 1,
|
|
@@ -9436,6 +9676,36 @@ var TOOL_CATALOG = [
|
|
|
9436
9676
|
"filters": {
|
|
9437
9677
|
"type": "object",
|
|
9438
9678
|
"properties": {
|
|
9679
|
+
"companyNames": {
|
|
9680
|
+
"description": "Company name prefixes. Match any name.",
|
|
9681
|
+
"minItems": 1,
|
|
9682
|
+
"maxItems": 5,
|
|
9683
|
+
"type": "array",
|
|
9684
|
+
"items": {
|
|
9685
|
+
"type": "string",
|
|
9686
|
+
"minLength": 1,
|
|
9687
|
+
"maxLength": 120,
|
|
9688
|
+
"pattern": "\\S"
|
|
9689
|
+
}
|
|
9690
|
+
},
|
|
9691
|
+
"excludeCompanyNames": {
|
|
9692
|
+
"description": "Company name prefixes to leave out.",
|
|
9693
|
+
"minItems": 1,
|
|
9694
|
+
"maxItems": 5,
|
|
9695
|
+
"type": "array",
|
|
9696
|
+
"items": {
|
|
9697
|
+
"type": "string",
|
|
9698
|
+
"minLength": 1,
|
|
9699
|
+
"maxLength": 120,
|
|
9700
|
+
"pattern": "\\S"
|
|
9701
|
+
}
|
|
9702
|
+
},
|
|
9703
|
+
"domain": {
|
|
9704
|
+
"description": "Company website domain. Exact host matching; root sites rank first.",
|
|
9705
|
+
"type": "string",
|
|
9706
|
+
"minLength": 1,
|
|
9707
|
+
"maxLength": 320
|
|
9708
|
+
},
|
|
9439
9709
|
"countryCodes": {
|
|
9440
9710
|
"description": "Two-letter country codes to include.",
|
|
9441
9711
|
"minItems": 1,
|
|
@@ -9607,9 +9877,7 @@ var TOOL_CATALOG = [
|
|
|
9607
9877
|
"type": "array",
|
|
9608
9878
|
"items": {
|
|
9609
9879
|
"type": "string",
|
|
9610
|
-
"
|
|
9611
|
-
"maxLength": 120,
|
|
9612
|
-
"pattern": "\\S"
|
|
9880
|
+
"pattern": "^[0-9]{6}$"
|
|
9613
9881
|
}
|
|
9614
9882
|
},
|
|
9615
9883
|
"excludeNaics2022Codes": {
|
|
@@ -9619,9 +9887,7 @@ var TOOL_CATALOG = [
|
|
|
9619
9887
|
"type": "array",
|
|
9620
9888
|
"items": {
|
|
9621
9889
|
"type": "string",
|
|
9622
|
-
"
|
|
9623
|
-
"maxLength": 120,
|
|
9624
|
-
"pattern": "\\S"
|
|
9890
|
+
"pattern": "^[0-9]{6}$"
|
|
9625
9891
|
}
|
|
9626
9892
|
},
|
|
9627
9893
|
"fundingTypes": {
|
|
@@ -9750,12 +10016,6 @@ var TOOL_CATALOG = [
|
|
|
9750
10016
|
"maxLength": 320
|
|
9751
10017
|
}
|
|
9752
10018
|
},
|
|
9753
|
-
"domain": {
|
|
9754
|
-
"description": "Website domain. Matching is exact on the host, and a root site ranks first.",
|
|
9755
|
-
"type": "string",
|
|
9756
|
-
"minLength": 1,
|
|
9757
|
-
"maxLength": 320
|
|
9758
|
-
},
|
|
9759
10019
|
"insights": {
|
|
9760
10020
|
"description": "Insights filters. Supply at least one.",
|
|
9761
10021
|
"type": "object",
|
|
@@ -10459,6 +10719,36 @@ var TOOL_CATALOG = [
|
|
|
10459
10719
|
"filters": {
|
|
10460
10720
|
"type": "object",
|
|
10461
10721
|
"properties": {
|
|
10722
|
+
"companyNames": {
|
|
10723
|
+
"description": "Company name alternatives or a domain. Finds the 50 closest token or prefix matches, ignoring punctuation, accents and legal suffixes.",
|
|
10724
|
+
"minItems": 1,
|
|
10725
|
+
"maxItems": 5,
|
|
10726
|
+
"type": "array",
|
|
10727
|
+
"items": {
|
|
10728
|
+
"type": "string",
|
|
10729
|
+
"minLength": 1,
|
|
10730
|
+
"maxLength": 120,
|
|
10731
|
+
"pattern": "\\S"
|
|
10732
|
+
}
|
|
10733
|
+
},
|
|
10734
|
+
"excludeCompanyNames": {
|
|
10735
|
+
"description": "Company name prefixes to leave out.",
|
|
10736
|
+
"minItems": 1,
|
|
10737
|
+
"maxItems": 5,
|
|
10738
|
+
"type": "array",
|
|
10739
|
+
"items": {
|
|
10740
|
+
"type": "string",
|
|
10741
|
+
"minLength": 1,
|
|
10742
|
+
"maxLength": 120,
|
|
10743
|
+
"pattern": "\\S"
|
|
10744
|
+
}
|
|
10745
|
+
},
|
|
10746
|
+
"domain": {
|
|
10747
|
+
"description": "Company website domain. Exact host matching; root sites rank first.",
|
|
10748
|
+
"type": "string",
|
|
10749
|
+
"minLength": 1,
|
|
10750
|
+
"maxLength": 320
|
|
10751
|
+
},
|
|
10462
10752
|
"countryCodes": {
|
|
10463
10753
|
"description": "Two-letter country codes to include.",
|
|
10464
10754
|
"minItems": 1,
|
|
@@ -10558,9 +10848,7 @@ var TOOL_CATALOG = [
|
|
|
10558
10848
|
"type": "array",
|
|
10559
10849
|
"items": {
|
|
10560
10850
|
"type": "string",
|
|
10561
|
-
"
|
|
10562
|
-
"maxLength": 120,
|
|
10563
|
-
"pattern": "\\S"
|
|
10851
|
+
"pattern": "^[0-9]{6}$"
|
|
10564
10852
|
}
|
|
10565
10853
|
},
|
|
10566
10854
|
"excludeNaics2022Codes": {
|
|
@@ -10570,9 +10858,7 @@ var TOOL_CATALOG = [
|
|
|
10570
10858
|
"type": "array",
|
|
10571
10859
|
"items": {
|
|
10572
10860
|
"type": "string",
|
|
10573
|
-
"
|
|
10574
|
-
"maxLength": 120,
|
|
10575
|
-
"pattern": "\\S"
|
|
10861
|
+
"pattern": "^[0-9]{6}$"
|
|
10576
10862
|
}
|
|
10577
10863
|
},
|
|
10578
10864
|
"fundingTypes": {
|
|
@@ -10701,6 +10987,25 @@ var TOOL_CATALOG = [
|
|
|
10701
10987
|
"maxLength": 320
|
|
10702
10988
|
}
|
|
10703
10989
|
},
|
|
10990
|
+
"personNames": {
|
|
10991
|
+
"description": "Person name alternatives. Requires a company name, domain or id. Matches first or last name for one token, or first and last name for two tokens, ignoring case and accents.",
|
|
10992
|
+
"minItems": 1,
|
|
10993
|
+
"maxItems": 5,
|
|
10994
|
+
"type": "array",
|
|
10995
|
+
"items": {
|
|
10996
|
+
"type": "string",
|
|
10997
|
+
"minLength": 1,
|
|
10998
|
+
"maxLength": 120,
|
|
10999
|
+
"pattern": "\\S"
|
|
11000
|
+
}
|
|
11001
|
+
},
|
|
11002
|
+
"email": {
|
|
11003
|
+
"description": "Exact work email address, matched through the email index.",
|
|
11004
|
+
"type": "string",
|
|
11005
|
+
"maxLength": 320,
|
|
11006
|
+
"format": "email",
|
|
11007
|
+
"pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"
|
|
11008
|
+
},
|
|
10704
11009
|
"personCities": {
|
|
10705
11010
|
"description": "Person cities to include. Requires personCountryCodes.",
|
|
10706
11011
|
"minItems": 1,
|
|
@@ -11478,16 +11783,18 @@ var TOOL_CATALOG = [
|
|
|
11478
11783
|
import { z } from "zod";
|
|
11479
11784
|
var failure = z.object({ error: z.union([z.string(), z.object({ code: z.string().max(128), message: z.string().max(2048).optional(), retry_after: z.number().nonnegative().finite().optional() })]) });
|
|
11480
11785
|
var HigherDataError = class extends Error {
|
|
11481
|
-
constructor(message, code, status = 0, retryAfter2) {
|
|
11786
|
+
constructor(message, code, status = 0, retryAfter2, requestId) {
|
|
11482
11787
|
super(message);
|
|
11483
11788
|
this.code = code;
|
|
11484
11789
|
this.status = status;
|
|
11485
11790
|
this.retryAfter = retryAfter2;
|
|
11791
|
+
this.requestId = requestId;
|
|
11486
11792
|
this.name = "HigherDataError";
|
|
11487
11793
|
}
|
|
11488
11794
|
code;
|
|
11489
11795
|
status;
|
|
11490
11796
|
retryAfter;
|
|
11797
|
+
requestId;
|
|
11491
11798
|
};
|
|
11492
11799
|
var limits = z.object({ maxRetries: z.number().int().min(0).max(5), timeoutMs: z.number().int().min(1).max(3e5), maxRetryDelayMs: z.number().int().min(0).max(3e5) });
|
|
11493
11800
|
var MAX_RESPONSE = 8 * 1024 * 1024;
|
|
@@ -11507,7 +11814,7 @@ function retryAfter(response, data, now) {
|
|
|
11507
11814
|
}
|
|
11508
11815
|
function apiError(response, data, now) {
|
|
11509
11816
|
const parsed = failure.safeParse(data), error = parsed.success ? parsed.data.error : null;
|
|
11510
|
-
return new HigherDataError(typeof error === "object" && error?.message ? error.message : "The HigherData API request failed.", typeof error === "string" ? error : error?.code ?? "http_error", response.status, retryAfter(response, data, now));
|
|
11817
|
+
return new HigherDataError(typeof error === "object" && error?.message ? error.message : "The HigherData API request failed.", typeof error === "string" ? error : error?.code ?? "http_error", response.status, retryAfter(response, data, now), response.headers.get("x-request-id") ?? void 0);
|
|
11511
11818
|
}
|
|
11512
11819
|
async function responseJson(response) {
|
|
11513
11820
|
if (!response.body) throw new HigherDataError("The API returned an invalid response.", "invalid_response");
|