higherdata-sdk 0.4.0 → 0.6.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.
Files changed (3) hide show
  1. package/dist/index.d.ts +1482 -31
  2. package/dist/index.js +2492 -378
  3. package/package.json +1 -1
package/dist/index.d.ts CHANGED
@@ -389,6 +389,7 @@ interface components {
389
389
  changeSetId?: string;
390
390
  jobId?: string;
391
391
  count?: number;
392
+ isIcpBaseline?: boolean;
392
393
  allowance?: number | null;
393
394
  remaining?: number | null;
394
395
  icp?: {
@@ -433,6 +434,12 @@ interface components {
433
434
  }[];
434
435
  };
435
436
  companyFilters: {
437
+ /** @description Company name prefixes. Match any name. */
438
+ companyNames?: string[];
439
+ /** @description Company name prefixes to leave out. */
440
+ excludeCompanyNames?: string[];
441
+ /** @description Company website domain. Exact host matching; root sites rank first. */
442
+ domain?: string;
436
443
  /** @description Two-letter country codes to include. */
437
444
  countryCodes?: string[];
438
445
  /** @description State or region codes to include. */
@@ -710,6 +717,12 @@ interface components {
710
717
  };
711
718
  };
712
719
  peopleFilters: {
720
+ /** @description Company name alternatives or a domain. Finds the 50 closest token or prefix matches, ignoring punctuation, accents and legal suffixes. */
721
+ companyNames?: string[];
722
+ /** @description Company name prefixes to leave out. */
723
+ excludeCompanyNames?: string[];
724
+ /** @description Company website domain. Exact host matching; root sites rank first. */
725
+ domain?: string;
713
726
  /** @description Two-letter country codes to include. */
714
727
  countryCodes?: string[];
715
728
  /** @description State or region codes to include. */
@@ -770,6 +783,13 @@ interface components {
770
783
  excludeOrganizationIds?: string[];
771
784
  /** @description Website domains to leave out. */
772
785
  excludeDomains?: string[];
786
+ /** @description Person name alternatives. Add a company name, domain or id for common names and typo matching. Every non-particle token matches in any order, ignoring case, accents and punctuation. Scoped searches allow one edit per token of at least five letters. */
787
+ personNames?: string[];
788
+ /**
789
+ * Format: email
790
+ * @description Exact work email address, matched through the email index.
791
+ */
792
+ email?: string;
773
793
  /** @description Person cities to include. Requires personCountryCodes. */
774
794
  personCities?: string[];
775
795
  /** @description Person cities to leave out. Requires personCountryCodes. */
@@ -871,6 +891,7 @@ interface components {
871
891
  changeSetId?: string;
872
892
  jobId?: string;
873
893
  count?: number;
894
+ isIcpBaseline?: boolean;
874
895
  allowance?: number | null;
875
896
  remaining?: number | null;
876
897
  icp?: {
@@ -915,6 +936,12 @@ interface components {
915
936
  }[];
916
937
  };
917
938
  companyFilters: {
939
+ /** @description Company name prefixes. Match any name. */
940
+ companyNames?: string[];
941
+ /** @description Company name prefixes to leave out. */
942
+ excludeCompanyNames?: string[];
943
+ /** @description Company website domain. Exact host matching; root sites rank first. */
944
+ domain?: string;
918
945
  /** @description Two-letter country codes to include. */
919
946
  countryCodes?: string[];
920
947
  /** @description State or region codes to include. */
@@ -1192,6 +1219,12 @@ interface components {
1192
1219
  };
1193
1220
  };
1194
1221
  peopleFilters: {
1222
+ /** @description Company name alternatives or a domain. Finds the 50 closest token or prefix matches, ignoring punctuation, accents and legal suffixes. */
1223
+ companyNames?: string[];
1224
+ /** @description Company name prefixes to leave out. */
1225
+ excludeCompanyNames?: string[];
1226
+ /** @description Company website domain. Exact host matching; root sites rank first. */
1227
+ domain?: string;
1195
1228
  /** @description Two-letter country codes to include. */
1196
1229
  countryCodes?: string[];
1197
1230
  /** @description State or region codes to include. */
@@ -1252,6 +1285,13 @@ interface components {
1252
1285
  excludeOrganizationIds?: string[];
1253
1286
  /** @description Website domains to leave out. */
1254
1287
  excludeDomains?: string[];
1288
+ /** @description Person name alternatives. Add a company name, domain or id for common names and typo matching. Every non-particle token matches in any order, ignoring case, accents and punctuation. Scoped searches allow one edit per token of at least five letters. */
1289
+ personNames?: string[];
1290
+ /**
1291
+ * Format: email
1292
+ * @description Exact work email address, matched through the email index.
1293
+ */
1294
+ email?: string;
1255
1295
  /** @description Person cities to include. Requires personCountryCodes. */
1256
1296
  personCities?: string[];
1257
1297
  /** @description Person cities to leave out. Requires personCountryCodes. */
@@ -1392,6 +1432,7 @@ interface components {
1392
1432
  changeSetId?: string;
1393
1433
  jobId?: string;
1394
1434
  count?: number;
1435
+ isIcpBaseline?: boolean;
1395
1436
  allowance?: number | null;
1396
1437
  remaining?: number | null;
1397
1438
  icp?: {
@@ -1436,6 +1477,12 @@ interface components {
1436
1477
  }[];
1437
1478
  };
1438
1479
  companyFilters: {
1480
+ /** @description Company name prefixes. Match any name. */
1481
+ companyNames?: string[];
1482
+ /** @description Company name prefixes to leave out. */
1483
+ excludeCompanyNames?: string[];
1484
+ /** @description Company website domain. Exact host matching; root sites rank first. */
1485
+ domain?: string;
1439
1486
  /** @description Two-letter country codes to include. */
1440
1487
  countryCodes?: string[];
1441
1488
  /** @description State or region codes to include. */
@@ -1713,6 +1760,12 @@ interface components {
1713
1760
  };
1714
1761
  };
1715
1762
  peopleFilters: {
1763
+ /** @description Company name alternatives or a domain. Finds the 50 closest token or prefix matches, ignoring punctuation, accents and legal suffixes. */
1764
+ companyNames?: string[];
1765
+ /** @description Company name prefixes to leave out. */
1766
+ excludeCompanyNames?: string[];
1767
+ /** @description Company website domain. Exact host matching; root sites rank first. */
1768
+ domain?: string;
1716
1769
  /** @description Two-letter country codes to include. */
1717
1770
  countryCodes?: string[];
1718
1771
  /** @description State or region codes to include. */
@@ -1773,6 +1826,13 @@ interface components {
1773
1826
  excludeOrganizationIds?: string[];
1774
1827
  /** @description Website domains to leave out. */
1775
1828
  excludeDomains?: string[];
1829
+ /** @description Person name alternatives. Add a company name, domain or id for common names and typo matching. Every non-particle token matches in any order, ignoring case, accents and punctuation. Scoped searches allow one edit per token of at least five letters. */
1830
+ personNames?: string[];
1831
+ /**
1832
+ * Format: email
1833
+ * @description Exact work email address, matched through the email index.
1834
+ */
1835
+ email?: string;
1776
1836
  /** @description Person cities to include. Requires personCountryCodes. */
1777
1837
  personCities?: string[];
1778
1838
  /** @description Person cities to leave out. Requires personCountryCodes. */
@@ -1874,6 +1934,7 @@ interface components {
1874
1934
  changeSetId?: string;
1875
1935
  jobId?: string;
1876
1936
  count?: number;
1937
+ isIcpBaseline?: boolean;
1877
1938
  allowance?: number | null;
1878
1939
  remaining?: number | null;
1879
1940
  icp?: {
@@ -1918,6 +1979,12 @@ interface components {
1918
1979
  }[];
1919
1980
  };
1920
1981
  companyFilters: {
1982
+ /** @description Company name prefixes. Match any name. */
1983
+ companyNames?: string[];
1984
+ /** @description Company name prefixes to leave out. */
1985
+ excludeCompanyNames?: string[];
1986
+ /** @description Company website domain. Exact host matching; root sites rank first. */
1987
+ domain?: string;
1921
1988
  /** @description Two-letter country codes to include. */
1922
1989
  countryCodes?: string[];
1923
1990
  /** @description State or region codes to include. */
@@ -2195,6 +2262,12 @@ interface components {
2195
2262
  };
2196
2263
  };
2197
2264
  peopleFilters: {
2265
+ /** @description Company name alternatives or a domain. Finds the 50 closest token or prefix matches, ignoring punctuation, accents and legal suffixes. */
2266
+ companyNames?: string[];
2267
+ /** @description Company name prefixes to leave out. */
2268
+ excludeCompanyNames?: string[];
2269
+ /** @description Company website domain. Exact host matching; root sites rank first. */
2270
+ domain?: string;
2198
2271
  /** @description Two-letter country codes to include. */
2199
2272
  countryCodes?: string[];
2200
2273
  /** @description State or region codes to include. */
@@ -2255,6 +2328,13 @@ interface components {
2255
2328
  excludeOrganizationIds?: string[];
2256
2329
  /** @description Website domains to leave out. */
2257
2330
  excludeDomains?: string[];
2331
+ /** @description Person name alternatives. Add a company name, domain or id for common names and typo matching. Every non-particle token matches in any order, ignoring case, accents and punctuation. Scoped searches allow one edit per token of at least five letters. */
2332
+ personNames?: string[];
2333
+ /**
2334
+ * Format: email
2335
+ * @description Exact work email address, matched through the email index.
2336
+ */
2337
+ email?: string;
2258
2338
  /** @description Person cities to include. Requires personCountryCodes. */
2259
2339
  personCities?: string[];
2260
2340
  /** @description Person cities to leave out. Requires personCountryCodes. */
@@ -3044,10 +3124,14 @@ interface components {
3044
3124
  fromChangeId: string | null;
3045
3125
  }[];
3046
3126
  samples?: {
3047
- /** @description CRM record id. */
3048
3127
  id: string;
3049
3128
  label: string;
3050
3129
  url: string | null;
3130
+ locations?: {
3131
+ /** @description CRM property name. */
3132
+ field: string;
3133
+ value: string;
3134
+ }[];
3051
3135
  }[];
3052
3136
  scannedRecords?: number;
3053
3137
  changedRecords?: number;
@@ -3381,6 +3465,8 @@ interface components {
3381
3465
  objectType: "companies" | "contacts";
3382
3466
  /** @description Text matched against a company's name or domain, a contact's email, or a deal's name. */
3383
3467
  query?: string;
3468
+ /** @description Exact normalized company domain. Company searches only. */
3469
+ domain?: string;
3384
3470
  /** @description Only records with an empty synced property. */
3385
3471
  missingField?: string;
3386
3472
  /**
@@ -3543,10 +3629,14 @@ interface components {
3543
3629
  fromChangeId: string | null;
3544
3630
  }[];
3545
3631
  samples?: {
3546
- /** @description CRM record id. */
3547
3632
  id: string;
3548
3633
  label: string;
3549
3634
  url: string | null;
3635
+ locations?: {
3636
+ /** @description CRM property name. */
3637
+ field: string;
3638
+ value: string;
3639
+ }[];
3550
3640
  }[];
3551
3641
  scannedRecords?: number;
3552
3642
  changedRecords?: number;
@@ -3682,6 +3772,7 @@ interface components {
3682
3772
  phase: "preview" | "create";
3683
3773
  /** @enum {string} */
3684
3774
  status: "queued" | "running" | "ready" | "completed" | "failed";
3775
+ checkingRecords?: number;
3685
3776
  counts: {
3686
3777
  scanned: number;
3687
3778
  changed: number;
@@ -3705,6 +3796,11 @@ interface components {
3705
3796
  id: string;
3706
3797
  label: string;
3707
3798
  url: string | null;
3799
+ locations?: {
3800
+ /** @description CRM property name. */
3801
+ field: string;
3802
+ value: string;
3803
+ }[];
3708
3804
  }[];
3709
3805
  maxRecords: number;
3710
3806
  error: string | null;
@@ -3810,6 +3906,7 @@ interface components {
3810
3906
  phase: "preview" | "create";
3811
3907
  /** @enum {string} */
3812
3908
  status: "queued" | "running" | "ready" | "completed" | "failed";
3909
+ checkingRecords?: number;
3813
3910
  counts: {
3814
3911
  scanned: number;
3815
3912
  changed: number;
@@ -3833,6 +3930,11 @@ interface components {
3833
3930
  id: string;
3834
3931
  label: string;
3835
3932
  url: string | null;
3933
+ locations?: {
3934
+ /** @description CRM property name. */
3935
+ field: string;
3936
+ value: string;
3937
+ }[];
3836
3938
  }[];
3837
3939
  maxRecords: number;
3838
3940
  error: string | null;
@@ -4027,6 +4129,111 @@ interface components {
4027
4129
  source: "rules" | "ai";
4028
4130
  } | null;
4029
4131
  };
4132
+ "crm.list_enrichment_jobs.input": {
4133
+ /** @description Continuation from the previous history page. */
4134
+ cursor?: {
4135
+ /**
4136
+ * Format: date-time
4137
+ * @description Creation time of the last job on the previous page.
4138
+ */
4139
+ createdAt: string;
4140
+ /**
4141
+ * Format: uuid
4142
+ * @description Id of the last job on the previous page.
4143
+ */
4144
+ id: string;
4145
+ };
4146
+ };
4147
+ "crm.list_enrichment_jobs.output": {
4148
+ items: {
4149
+ /** Format: uuid */
4150
+ id: string;
4151
+ releaseId: string | null;
4152
+ selection: {
4153
+ /**
4154
+ * @description CRM object to enrich.
4155
+ * @enum {string}
4156
+ */
4157
+ objectType: "companies" | "contacts";
4158
+ /** @description Synced writable CRM properties to fill. */
4159
+ fields: string[];
4160
+ /** @description Which CRM records to include. */
4161
+ filter: {
4162
+ /**
4163
+ * @description Select all cached records for this object.
4164
+ * @constant
4165
+ */
4166
+ kind: "all";
4167
+ } | {
4168
+ /**
4169
+ * @description Select records with an empty chosen field.
4170
+ * @constant
4171
+ */
4172
+ kind: "missing";
4173
+ /** @description CRM property name. */
4174
+ field: string;
4175
+ } | {
4176
+ /**
4177
+ * @description Select members of a connected HubSpot list.
4178
+ * @constant
4179
+ */
4180
+ kind: "list";
4181
+ /** @description HubSpot list id from crm.get_enrichment_options. */
4182
+ id: string;
4183
+ };
4184
+ };
4185
+ /** @enum {string} */
4186
+ phase: "preview" | "create";
4187
+ /** @enum {string} */
4188
+ status: "queued" | "running" | "ready" | "completed" | "failed";
4189
+ checkingRecords?: number;
4190
+ counts: {
4191
+ scanned: number;
4192
+ changed: number;
4193
+ matched: number;
4194
+ reasons: {
4195
+ [key: string]: number;
4196
+ };
4197
+ };
4198
+ preview: {
4199
+ scanned: number;
4200
+ changed: number;
4201
+ matched: number;
4202
+ reasons: {
4203
+ [key: string]: number;
4204
+ };
4205
+ } | null;
4206
+ proposalCount: number;
4207
+ firstProposalId: string | null;
4208
+ totalRecords: number;
4209
+ samples: {
4210
+ id: string;
4211
+ label: string;
4212
+ url: string | null;
4213
+ locations?: {
4214
+ /** @description CRM property name. */
4215
+ field: string;
4216
+ value: string;
4217
+ }[];
4218
+ }[];
4219
+ maxRecords: number;
4220
+ error: string | null;
4221
+ /** Format: date-time */
4222
+ createdAt: string;
4223
+ }[];
4224
+ nextCursor: {
4225
+ /**
4226
+ * Format: date-time
4227
+ * @description Creation time of the last job on the previous page.
4228
+ */
4229
+ createdAt: string;
4230
+ /**
4231
+ * Format: uuid
4232
+ * @description Id of the last job on the previous page.
4233
+ */
4234
+ id: string;
4235
+ } | null;
4236
+ };
4030
4237
  "crm.push.input": {
4031
4238
  /** @description CRM changes to plan. Each item is one operation. */
4032
4239
  proposals: ({
@@ -4312,10 +4519,14 @@ interface components {
4312
4519
  fromChangeId: string | null;
4313
4520
  }[];
4314
4521
  samples?: {
4315
- /** @description CRM record id. */
4316
4522
  id: string;
4317
4523
  label: string;
4318
4524
  url: string | null;
4525
+ locations?: {
4526
+ /** @description CRM property name. */
4527
+ field: string;
4528
+ value: string;
4529
+ }[];
4319
4530
  }[];
4320
4531
  scannedRecords?: number;
4321
4532
  changedRecords?: number;
@@ -4334,6 +4545,8 @@ interface components {
4334
4545
  objectType: "companies" | "contacts" | "deals";
4335
4546
  /** @description Text matched against a company's name or domain, a contact's email, or a deal's name. */
4336
4547
  query?: string;
4548
+ /** @description Exact normalized company domain. Company searches only. */
4549
+ domain?: string;
4337
4550
  /** @description Only records with an empty synced property. */
4338
4551
  missingField?: string;
4339
4552
  /**
@@ -4521,7 +4734,7 @@ interface components {
4521
4734
  "email.find.output": {
4522
4735
  requestId: string | null;
4523
4736
  /** @enum {string} */
4524
- status: "planned" | "queued" | "running" | "complete" | "failed";
4737
+ status: "planned" | "queued" | "running" | "complete" | "failed" | "ambiguous";
4525
4738
  email: string | null;
4526
4739
  result: {
4527
4740
  /** @enum {string} */
@@ -4552,6 +4765,13 @@ interface components {
4552
4765
  pattern: string | null;
4553
4766
  releaseId: string | null;
4554
4767
  }[];
4768
+ companyCandidates?: {
4769
+ id: string;
4770
+ name: string | null;
4771
+ domain: string | null;
4772
+ location: string | null;
4773
+ }[];
4774
+ message?: string;
4555
4775
  retryAfter: number | null;
4556
4776
  };
4557
4777
  "email.verify.input": {
@@ -4570,7 +4790,7 @@ interface components {
4570
4790
  "email.verify.output": {
4571
4791
  requestId: string | null;
4572
4792
  /** @enum {string} */
4573
- status: "planned" | "queued" | "running" | "complete" | "failed";
4793
+ status: "planned" | "queued" | "running" | "complete" | "failed" | "ambiguous";
4574
4794
  email: string | null;
4575
4795
  result: {
4576
4796
  /** @enum {string} */
@@ -4601,6 +4821,13 @@ interface components {
4601
4821
  pattern: string | null;
4602
4822
  releaseId: string | null;
4603
4823
  }[];
4824
+ companyCandidates?: {
4825
+ id: string;
4826
+ name: string | null;
4827
+ domain: string | null;
4828
+ location: string | null;
4829
+ }[];
4830
+ message?: string;
4604
4831
  retryAfter: number | null;
4605
4832
  };
4606
4833
  "enrich.bulk.input": {
@@ -5269,6 +5496,27 @@ interface components {
5269
5496
  connectionId: string;
5270
5497
  }[];
5271
5498
  nextCursor: string | null;
5499
+ summary?: {
5500
+ connectionId: string | null;
5501
+ /** Format: date-time */
5502
+ asOf: string;
5503
+ gaps: {
5504
+ emptyCompany: number;
5505
+ missingFields: number;
5506
+ };
5507
+ orphans: {
5508
+ /** @enum {string} */
5509
+ objectType: "contacts" | "deals";
5510
+ /** @enum {string} */
5511
+ match: "proposed" | "ambiguous" | "none";
5512
+ /** @enum {string} */
5513
+ band: "high" | "medium" | "low";
5514
+ count: number;
5515
+ }[];
5516
+ lastFullAt: string | null;
5517
+ lastScanAt: string | null;
5518
+ incomplete: boolean;
5519
+ };
5272
5520
  };
5273
5521
  "hygiene.merge.input": {
5274
5522
  /**
@@ -5313,6 +5561,32 @@ interface components {
5313
5561
  }[];
5314
5562
  restoreWarning: string;
5315
5563
  changeSetId: string | null;
5564
+ mergeProgress?: {
5565
+ /** Format: uuid */
5566
+ changeId: string;
5567
+ /** @description CRM record id. */
5568
+ losingId: string;
5569
+ /** @enum {string} */
5570
+ status: "applying" | "applied" | "failed";
5571
+ error: string | null;
5572
+ }[];
5573
+ comparison?: {
5574
+ /** @enum {string} */
5575
+ objectType: "companies" | "contacts";
5576
+ portalId: string;
5577
+ records: {
5578
+ id: string;
5579
+ /** Format: date-time */
5580
+ updatedAt: string;
5581
+ properties: {
5582
+ [key: string]: string | null;
5583
+ };
5584
+ }[];
5585
+ writableFields: string[];
5586
+ survivingValues: {
5587
+ [key: string]: string | null;
5588
+ };
5589
+ };
5316
5590
  };
5317
5591
  "hygiene.orphans.input": {
5318
5592
  /**
@@ -5360,6 +5634,27 @@ interface components {
5360
5634
  connectionId: string;
5361
5635
  }[];
5362
5636
  nextCursor: string | null;
5637
+ summary?: {
5638
+ connectionId: string | null;
5639
+ /** Format: date-time */
5640
+ asOf: string;
5641
+ gaps: {
5642
+ emptyCompany: number;
5643
+ missingFields: number;
5644
+ };
5645
+ orphans: {
5646
+ /** @enum {string} */
5647
+ objectType: "contacts" | "deals";
5648
+ /** @enum {string} */
5649
+ match: "proposed" | "ambiguous" | "none";
5650
+ /** @enum {string} */
5651
+ band: "high" | "medium" | "low";
5652
+ count: number;
5653
+ }[];
5654
+ lastFullAt: string | null;
5655
+ lastScanAt: string | null;
5656
+ incomplete: boolean;
5657
+ };
5363
5658
  };
5364
5659
  "hygiene.repair.input": {
5365
5660
  /** @description Orphan ids to associate with a company. */
@@ -5488,6 +5783,12 @@ interface components {
5488
5783
  }[];
5489
5784
  };
5490
5785
  companyFilters: {
5786
+ /** @description Company name prefixes. Match any name. */
5787
+ companyNames?: string[];
5788
+ /** @description Company name prefixes to leave out. */
5789
+ excludeCompanyNames?: string[];
5790
+ /** @description Company website domain. Exact host matching; root sites rank first. */
5791
+ domain?: string;
5491
5792
  /** @description Two-letter country codes to include. */
5492
5793
  countryCodes?: string[];
5493
5794
  /** @description State or region codes to include. */
@@ -5765,6 +6066,12 @@ interface components {
5765
6066
  };
5766
6067
  };
5767
6068
  peopleFilters: {
6069
+ /** @description Company name alternatives or a domain. Finds the 50 closest token or prefix matches, ignoring punctuation, accents and legal suffixes. */
6070
+ companyNames?: string[];
6071
+ /** @description Company name prefixes to leave out. */
6072
+ excludeCompanyNames?: string[];
6073
+ /** @description Company website domain. Exact host matching; root sites rank first. */
6074
+ domain?: string;
5768
6075
  /** @description Two-letter country codes to include. */
5769
6076
  countryCodes?: string[];
5770
6077
  /** @description State or region codes to include. */
@@ -5825,6 +6132,13 @@ interface components {
5825
6132
  excludeOrganizationIds?: string[];
5826
6133
  /** @description Website domains to leave out. */
5827
6134
  excludeDomains?: string[];
6135
+ /** @description Person name alternatives. Add a company name, domain or id for common names and typo matching. Every non-particle token matches in any order, ignoring case, accents and punctuation. Scoped searches allow one edit per token of at least five letters. */
6136
+ personNames?: string[];
6137
+ /**
6138
+ * Format: email
6139
+ * @description Exact work email address, matched through the email index.
6140
+ */
6141
+ email?: string;
5828
6142
  /** @description Person cities to include. Requires personCountryCodes. */
5829
6143
  personCities?: string[];
5830
6144
  /** @description Person cities to leave out. Requires personCountryCodes. */
@@ -5951,6 +6265,12 @@ interface components {
5951
6265
  }[];
5952
6266
  };
5953
6267
  companyFilters: {
6268
+ /** @description Company name prefixes. Match any name. */
6269
+ companyNames?: string[];
6270
+ /** @description Company name prefixes to leave out. */
6271
+ excludeCompanyNames?: string[];
6272
+ /** @description Company website domain. Exact host matching; root sites rank first. */
6273
+ domain?: string;
5954
6274
  /** @description Two-letter country codes to include. */
5955
6275
  countryCodes?: string[];
5956
6276
  /** @description State or region codes to include. */
@@ -6228,6 +6548,12 @@ interface components {
6228
6548
  };
6229
6549
  };
6230
6550
  peopleFilters: {
6551
+ /** @description Company name alternatives or a domain. Finds the 50 closest token or prefix matches, ignoring punctuation, accents and legal suffixes. */
6552
+ companyNames?: string[];
6553
+ /** @description Company name prefixes to leave out. */
6554
+ excludeCompanyNames?: string[];
6555
+ /** @description Company website domain. Exact host matching; root sites rank first. */
6556
+ domain?: string;
6231
6557
  /** @description Two-letter country codes to include. */
6232
6558
  countryCodes?: string[];
6233
6559
  /** @description State or region codes to include. */
@@ -6288,6 +6614,13 @@ interface components {
6288
6614
  excludeOrganizationIds?: string[];
6289
6615
  /** @description Website domains to leave out. */
6290
6616
  excludeDomains?: string[];
6617
+ /** @description Person name alternatives. Add a company name, domain or id for common names and typo matching. Every non-particle token matches in any order, ignoring case, accents and punctuation. Scoped searches allow one edit per token of at least five letters. */
6618
+ personNames?: string[];
6619
+ /**
6620
+ * Format: email
6621
+ * @description Exact work email address, matched through the email index.
6622
+ */
6623
+ email?: string;
6291
6624
  /** @description Person cities to include. Requires personCountryCodes. */
6292
6625
  personCities?: string[];
6293
6626
  /** @description Person cities to leave out. Requires personCountryCodes. */
@@ -6424,6 +6757,12 @@ interface components {
6424
6757
  }[];
6425
6758
  };
6426
6759
  companyFilters: {
6760
+ /** @description Company name prefixes. Match any name. */
6761
+ companyNames?: string[];
6762
+ /** @description Company name prefixes to leave out. */
6763
+ excludeCompanyNames?: string[];
6764
+ /** @description Company website domain. Exact host matching; root sites rank first. */
6765
+ domain?: string;
6427
6766
  /** @description Two-letter country codes to include. */
6428
6767
  countryCodes?: string[];
6429
6768
  /** @description State or region codes to include. */
@@ -6701,6 +7040,12 @@ interface components {
6701
7040
  };
6702
7041
  };
6703
7042
  peopleFilters: {
7043
+ /** @description Company name alternatives or a domain. Finds the 50 closest token or prefix matches, ignoring punctuation, accents and legal suffixes. */
7044
+ companyNames?: string[];
7045
+ /** @description Company name prefixes to leave out. */
7046
+ excludeCompanyNames?: string[];
7047
+ /** @description Company website domain. Exact host matching; root sites rank first. */
7048
+ domain?: string;
6704
7049
  /** @description Two-letter country codes to include. */
6705
7050
  countryCodes?: string[];
6706
7051
  /** @description State or region codes to include. */
@@ -6761,6 +7106,13 @@ interface components {
6761
7106
  excludeOrganizationIds?: string[];
6762
7107
  /** @description Website domains to leave out. */
6763
7108
  excludeDomains?: string[];
7109
+ /** @description Person name alternatives. Add a company name, domain or id for common names and typo matching. Every non-particle token matches in any order, ignoring case, accents and punctuation. Scoped searches allow one edit per token of at least five letters. */
7110
+ personNames?: string[];
7111
+ /**
7112
+ * Format: email
7113
+ * @description Exact work email address, matched through the email index.
7114
+ */
7115
+ email?: string;
6764
7116
  /** @description Person cities to include. Requires personCountryCodes. */
6765
7117
  personCities?: string[];
6766
7118
  /** @description Person cities to leave out. Requires personCountryCodes. */
@@ -6875,6 +7227,12 @@ interface components {
6875
7227
  kind: "companies";
6876
7228
  /** @description Company filters saved on this list or search. */
6877
7229
  filters: {
7230
+ /** @description Company name prefixes. Match any name. */
7231
+ companyNames?: string[];
7232
+ /** @description Company name prefixes to leave out. */
7233
+ excludeCompanyNames?: string[];
7234
+ /** @description Company website domain. Exact host matching; root sites rank first. */
7235
+ domain?: string;
6878
7236
  /** @description Two-letter country codes to include. */
6879
7237
  countryCodes?: string[];
6880
7238
  /** @description State or region codes to include. */
@@ -6951,8 +7309,6 @@ interface components {
6951
7309
  excludeOrganizationIds?: string[];
6952
7310
  /** @description Website domains to leave out. */
6953
7311
  excludeDomains?: string[];
6954
- /** @description Website domain. Matching is exact on the host, and a root site ranks first. */
6955
- domain?: string;
6956
7312
  /** @description Insights filters. Supply at least one. */
6957
7313
  insights?: {
6958
7314
  /** @description Monthly organic visits. */
@@ -7162,6 +7518,12 @@ interface components {
7162
7518
  kind: "people";
7163
7519
  /** @description People filters saved on this list or search. */
7164
7520
  filters: {
7521
+ /** @description Company name alternatives or a domain. Finds the 50 closest token or prefix matches, ignoring punctuation, accents and legal suffixes. */
7522
+ companyNames?: string[];
7523
+ /** @description Company name prefixes to leave out. */
7524
+ excludeCompanyNames?: string[];
7525
+ /** @description Company website domain. Exact host matching; root sites rank first. */
7526
+ domain?: string;
7165
7527
  /** @description Two-letter country codes to include. */
7166
7528
  countryCodes?: string[];
7167
7529
  /** @description State or region codes to include. */
@@ -7222,6 +7584,13 @@ interface components {
7222
7584
  excludeOrganizationIds?: string[];
7223
7585
  /** @description Website domains to leave out. */
7224
7586
  excludeDomains?: string[];
7587
+ /** @description Person name alternatives. Add a company name, domain or id for common names and typo matching. Every non-particle token matches in any order, ignoring case, accents and punctuation. Scoped searches allow one edit per token of at least five letters. */
7588
+ personNames?: string[];
7589
+ /**
7590
+ * Format: email
7591
+ * @description Exact work email address, matched through the email index.
7592
+ */
7593
+ email?: string;
7225
7594
  /** @description Person cities to include. Requires personCountryCodes. */
7226
7595
  personCities?: string[];
7227
7596
  /** @description Person cities to leave out. Requires personCountryCodes. */
@@ -7300,6 +7669,10 @@ interface components {
7300
7669
  excludePersonIds?: string[];
7301
7670
  /** @description Email addresses to leave out. */
7302
7671
  excludeEmails?: string[];
7672
+ /** @description First name tokens, using accent-folded fuzzy matching. Requires companyId. */
7673
+ firstName?: string;
7674
+ /** @description Last name tokens, using accent-folded fuzzy matching. Requires companyId. */
7675
+ lastName?: string;
7303
7676
  /** @description Limit contacts to this company. This uses the company-indexed contact path and does not require country or industry filters. */
7304
7677
  companyId?: string;
7305
7678
  /** @description Contact location filters. Requires companyId. */
@@ -7318,6 +7691,7 @@ interface components {
7318
7691
  /** @enum {string} */
7319
7692
  lastRunStatus: "never" | "queued" | "running" | "complete" | "failed";
7320
7693
  lastRunAt: string | null;
7694
+ lastRunNotice?: string | null;
7321
7695
  /** Format: date-time */
7322
7696
  createdAt: string;
7323
7697
  /** Format: date-time */
@@ -7399,6 +7773,12 @@ interface components {
7399
7773
  }[];
7400
7774
  };
7401
7775
  companyFilters: {
7776
+ /** @description Company name prefixes. Match any name. */
7777
+ companyNames?: string[];
7778
+ /** @description Company name prefixes to leave out. */
7779
+ excludeCompanyNames?: string[];
7780
+ /** @description Company website domain. Exact host matching; root sites rank first. */
7781
+ domain?: string;
7402
7782
  /** @description Two-letter country codes to include. */
7403
7783
  countryCodes?: string[];
7404
7784
  /** @description State or region codes to include. */
@@ -7676,6 +8056,12 @@ interface components {
7676
8056
  };
7677
8057
  };
7678
8058
  peopleFilters: {
8059
+ /** @description Company name alternatives or a domain. Finds the 50 closest token or prefix matches, ignoring punctuation, accents and legal suffixes. */
8060
+ companyNames?: string[];
8061
+ /** @description Company name prefixes to leave out. */
8062
+ excludeCompanyNames?: string[];
8063
+ /** @description Company website domain. Exact host matching; root sites rank first. */
8064
+ domain?: string;
7679
8065
  /** @description Two-letter country codes to include. */
7680
8066
  countryCodes?: string[];
7681
8067
  /** @description State or region codes to include. */
@@ -7736,6 +8122,13 @@ interface components {
7736
8122
  excludeOrganizationIds?: string[];
7737
8123
  /** @description Website domains to leave out. */
7738
8124
  excludeDomains?: string[];
8125
+ /** @description Person name alternatives. Add a company name, domain or id for common names and typo matching. Every non-particle token matches in any order, ignoring case, accents and punctuation. Scoped searches allow one edit per token of at least five letters. */
8126
+ personNames?: string[];
8127
+ /**
8128
+ * Format: email
8129
+ * @description Exact work email address, matched through the email index.
8130
+ */
8131
+ email?: string;
7739
8132
  /** @description Person cities to include. Requires personCountryCodes. */
7740
8133
  personCities?: string[];
7741
8134
  /** @description Person cities to leave out. Requires personCountryCodes. */
@@ -7841,6 +8234,12 @@ interface components {
7841
8234
  kind: "companies";
7842
8235
  /** @description Company filters saved on this list or search. */
7843
8236
  filters: {
8237
+ /** @description Company name prefixes. Match any name. */
8238
+ companyNames?: string[];
8239
+ /** @description Company name prefixes to leave out. */
8240
+ excludeCompanyNames?: string[];
8241
+ /** @description Company website domain. Exact host matching; root sites rank first. */
8242
+ domain?: string;
7844
8243
  /** @description Two-letter country codes to include. */
7845
8244
  countryCodes?: string[];
7846
8245
  /** @description State or region codes to include. */
@@ -7917,8 +8316,6 @@ interface components {
7917
8316
  excludeOrganizationIds?: string[];
7918
8317
  /** @description Website domains to leave out. */
7919
8318
  excludeDomains?: string[];
7920
- /** @description Website domain. Matching is exact on the host, and a root site ranks first. */
7921
- domain?: string;
7922
8319
  /** @description Insights filters. Supply at least one. */
7923
8320
  insights?: {
7924
8321
  /** @description Monthly organic visits. */
@@ -8128,6 +8525,12 @@ interface components {
8128
8525
  kind: "people";
8129
8526
  /** @description People filters saved on this list or search. */
8130
8527
  filters: {
8528
+ /** @description Company name alternatives or a domain. Finds the 50 closest token or prefix matches, ignoring punctuation, accents and legal suffixes. */
8529
+ companyNames?: string[];
8530
+ /** @description Company name prefixes to leave out. */
8531
+ excludeCompanyNames?: string[];
8532
+ /** @description Company website domain. Exact host matching; root sites rank first. */
8533
+ domain?: string;
8131
8534
  /** @description Two-letter country codes to include. */
8132
8535
  countryCodes?: string[];
8133
8536
  /** @description State or region codes to include. */
@@ -8188,6 +8591,13 @@ interface components {
8188
8591
  excludeOrganizationIds?: string[];
8189
8592
  /** @description Website domains to leave out. */
8190
8593
  excludeDomains?: string[];
8594
+ /** @description Person name alternatives. Add a company name, domain or id for common names and typo matching. Every non-particle token matches in any order, ignoring case, accents and punctuation. Scoped searches allow one edit per token of at least five letters. */
8595
+ personNames?: string[];
8596
+ /**
8597
+ * Format: email
8598
+ * @description Exact work email address, matched through the email index.
8599
+ */
8600
+ email?: string;
8191
8601
  /** @description Person cities to include. Requires personCountryCodes. */
8192
8602
  personCities?: string[];
8193
8603
  /** @description Person cities to leave out. Requires personCountryCodes. */
@@ -8266,6 +8676,10 @@ interface components {
8266
8676
  excludePersonIds?: string[];
8267
8677
  /** @description Email addresses to leave out. */
8268
8678
  excludeEmails?: string[];
8679
+ /** @description First name tokens, using accent-folded fuzzy matching. Requires companyId. */
8680
+ firstName?: string;
8681
+ /** @description Last name tokens, using accent-folded fuzzy matching. Requires companyId. */
8682
+ lastName?: string;
8269
8683
  /** @description Limit contacts to this company. This uses the company-indexed contact path and does not require country or industry filters. */
8270
8684
  companyId?: string;
8271
8685
  /** @description Contact location filters. Requires companyId. */
@@ -8284,6 +8698,7 @@ interface components {
8284
8698
  /** @enum {string} */
8285
8699
  lastRunStatus: "never" | "queued" | "running" | "complete" | "failed";
8286
8700
  lastRunAt: string | null;
8701
+ lastRunNotice?: string | null;
8287
8702
  /** Format: date-time */
8288
8703
  createdAt: string;
8289
8704
  /** Format: date-time */
@@ -8483,6 +8898,12 @@ interface components {
8483
8898
  kind: "companies";
8484
8899
  /** @description Company filters saved on this list or search. */
8485
8900
  filters: {
8901
+ /** @description Company name prefixes. Match any name. */
8902
+ companyNames?: string[];
8903
+ /** @description Company name prefixes to leave out. */
8904
+ excludeCompanyNames?: string[];
8905
+ /** @description Company website domain. Exact host matching; root sites rank first. */
8906
+ domain?: string;
8486
8907
  /** @description Two-letter country codes to include. */
8487
8908
  countryCodes?: string[];
8488
8909
  /** @description State or region codes to include. */
@@ -8559,8 +8980,6 @@ interface components {
8559
8980
  excludeOrganizationIds?: string[];
8560
8981
  /** @description Website domains to leave out. */
8561
8982
  excludeDomains?: string[];
8562
- /** @description Website domain. Matching is exact on the host, and a root site ranks first. */
8563
- domain?: string;
8564
8983
  /** @description Insights filters. Supply at least one. */
8565
8984
  insights?: {
8566
8985
  /** @description Monthly organic visits. */
@@ -8770,6 +9189,12 @@ interface components {
8770
9189
  kind: "people";
8771
9190
  /** @description People filters saved on this list or search. */
8772
9191
  filters: {
9192
+ /** @description Company name alternatives or a domain. Finds the 50 closest token or prefix matches, ignoring punctuation, accents and legal suffixes. */
9193
+ companyNames?: string[];
9194
+ /** @description Company name prefixes to leave out. */
9195
+ excludeCompanyNames?: string[];
9196
+ /** @description Company website domain. Exact host matching; root sites rank first. */
9197
+ domain?: string;
8773
9198
  /** @description Two-letter country codes to include. */
8774
9199
  countryCodes?: string[];
8775
9200
  /** @description State or region codes to include. */
@@ -8830,6 +9255,13 @@ interface components {
8830
9255
  excludeOrganizationIds?: string[];
8831
9256
  /** @description Website domains to leave out. */
8832
9257
  excludeDomains?: string[];
9258
+ /** @description Person name alternatives. Add a company name, domain or id for common names and typo matching. Every non-particle token matches in any order, ignoring case, accents and punctuation. Scoped searches allow one edit per token of at least five letters. */
9259
+ personNames?: string[];
9260
+ /**
9261
+ * Format: email
9262
+ * @description Exact work email address, matched through the email index.
9263
+ */
9264
+ email?: string;
8833
9265
  /** @description Person cities to include. Requires personCountryCodes. */
8834
9266
  personCities?: string[];
8835
9267
  /** @description Person cities to leave out. Requires personCountryCodes. */
@@ -8908,6 +9340,10 @@ interface components {
8908
9340
  excludePersonIds?: string[];
8909
9341
  /** @description Email addresses to leave out. */
8910
9342
  excludeEmails?: string[];
9343
+ /** @description First name tokens, using accent-folded fuzzy matching. Requires companyId. */
9344
+ firstName?: string;
9345
+ /** @description Last name tokens, using accent-folded fuzzy matching. Requires companyId. */
9346
+ lastName?: string;
8911
9347
  /** @description Limit contacts to this company. This uses the company-indexed contact path and does not require country or industry filters. */
8912
9348
  companyId?: string;
8913
9349
  /** @description Contact location filters. Requires companyId. */
@@ -8964,6 +9400,12 @@ interface components {
8964
9400
  kind: "companies";
8965
9401
  /** @description Company filters saved on this list or search. */
8966
9402
  filters: {
9403
+ /** @description Company name prefixes. Match any name. */
9404
+ companyNames?: string[];
9405
+ /** @description Company name prefixes to leave out. */
9406
+ excludeCompanyNames?: string[];
9407
+ /** @description Company website domain. Exact host matching; root sites rank first. */
9408
+ domain?: string;
8967
9409
  /** @description Two-letter country codes to include. */
8968
9410
  countryCodes?: string[];
8969
9411
  /** @description State or region codes to include. */
@@ -9040,8 +9482,6 @@ interface components {
9040
9482
  excludeOrganizationIds?: string[];
9041
9483
  /** @description Website domains to leave out. */
9042
9484
  excludeDomains?: string[];
9043
- /** @description Website domain. Matching is exact on the host, and a root site ranks first. */
9044
- domain?: string;
9045
9485
  /** @description Insights filters. Supply at least one. */
9046
9486
  insights?: {
9047
9487
  /** @description Monthly organic visits. */
@@ -9251,6 +9691,12 @@ interface components {
9251
9691
  kind: "people";
9252
9692
  /** @description People filters saved on this list or search. */
9253
9693
  filters: {
9694
+ /** @description Company name alternatives or a domain. Finds the 50 closest token or prefix matches, ignoring punctuation, accents and legal suffixes. */
9695
+ companyNames?: string[];
9696
+ /** @description Company name prefixes to leave out. */
9697
+ excludeCompanyNames?: string[];
9698
+ /** @description Company website domain. Exact host matching; root sites rank first. */
9699
+ domain?: string;
9254
9700
  /** @description Two-letter country codes to include. */
9255
9701
  countryCodes?: string[];
9256
9702
  /** @description State or region codes to include. */
@@ -9311,6 +9757,13 @@ interface components {
9311
9757
  excludeOrganizationIds?: string[];
9312
9758
  /** @description Website domains to leave out. */
9313
9759
  excludeDomains?: string[];
9760
+ /** @description Person name alternatives. Add a company name, domain or id for common names and typo matching. Every non-particle token matches in any order, ignoring case, accents and punctuation. Scoped searches allow one edit per token of at least five letters. */
9761
+ personNames?: string[];
9762
+ /**
9763
+ * Format: email
9764
+ * @description Exact work email address, matched through the email index.
9765
+ */
9766
+ email?: string;
9314
9767
  /** @description Person cities to include. Requires personCountryCodes. */
9315
9768
  personCities?: string[];
9316
9769
  /** @description Person cities to leave out. Requires personCountryCodes. */
@@ -9389,6 +9842,10 @@ interface components {
9389
9842
  excludePersonIds?: string[];
9390
9843
  /** @description Email addresses to leave out. */
9391
9844
  excludeEmails?: string[];
9845
+ /** @description First name tokens, using accent-folded fuzzy matching. Requires companyId. */
9846
+ firstName?: string;
9847
+ /** @description Last name tokens, using accent-folded fuzzy matching. Requires companyId. */
9848
+ lastName?: string;
9392
9849
  /** @description Limit contacts to this company. This uses the company-indexed contact path and does not require country or industry filters. */
9393
9850
  companyId?: string;
9394
9851
  /** @description Contact location filters. Requires companyId. */
@@ -9407,6 +9864,7 @@ interface components {
9407
9864
  /** @enum {string} */
9408
9865
  lastRunStatus: "never" | "queued" | "running" | "complete" | "failed";
9409
9866
  lastRunAt: string | null;
9867
+ lastRunNotice?: string | null;
9410
9868
  /** Format: date-time */
9411
9869
  createdAt: string;
9412
9870
  /** Format: date-time */
@@ -9448,6 +9906,12 @@ interface components {
9448
9906
  kind: "companies";
9449
9907
  /** @description Company filters saved on this list or search. */
9450
9908
  filters: {
9909
+ /** @description Company name prefixes. Match any name. */
9910
+ companyNames?: string[];
9911
+ /** @description Company name prefixes to leave out. */
9912
+ excludeCompanyNames?: string[];
9913
+ /** @description Company website domain. Exact host matching; root sites rank first. */
9914
+ domain?: string;
9451
9915
  /** @description Two-letter country codes to include. */
9452
9916
  countryCodes?: string[];
9453
9917
  /** @description State or region codes to include. */
@@ -9524,8 +9988,6 @@ interface components {
9524
9988
  excludeOrganizationIds?: string[];
9525
9989
  /** @description Website domains to leave out. */
9526
9990
  excludeDomains?: string[];
9527
- /** @description Website domain. Matching is exact on the host, and a root site ranks first. */
9528
- domain?: string;
9529
9991
  /** @description Insights filters. Supply at least one. */
9530
9992
  insights?: {
9531
9993
  /** @description Monthly organic visits. */
@@ -9735,6 +10197,12 @@ interface components {
9735
10197
  kind: "people";
9736
10198
  /** @description People filters saved on this list or search. */
9737
10199
  filters: {
10200
+ /** @description Company name alternatives or a domain. Finds the 50 closest token or prefix matches, ignoring punctuation, accents and legal suffixes. */
10201
+ companyNames?: string[];
10202
+ /** @description Company name prefixes to leave out. */
10203
+ excludeCompanyNames?: string[];
10204
+ /** @description Company website domain. Exact host matching; root sites rank first. */
10205
+ domain?: string;
9738
10206
  /** @description Two-letter country codes to include. */
9739
10207
  countryCodes?: string[];
9740
10208
  /** @description State or region codes to include. */
@@ -9795,6 +10263,13 @@ interface components {
9795
10263
  excludeOrganizationIds?: string[];
9796
10264
  /** @description Website domains to leave out. */
9797
10265
  excludeDomains?: string[];
10266
+ /** @description Person name alternatives. Add a company name, domain or id for common names and typo matching. Every non-particle token matches in any order, ignoring case, accents and punctuation. Scoped searches allow one edit per token of at least five letters. */
10267
+ personNames?: string[];
10268
+ /**
10269
+ * Format: email
10270
+ * @description Exact work email address, matched through the email index.
10271
+ */
10272
+ email?: string;
9798
10273
  /** @description Person cities to include. Requires personCountryCodes. */
9799
10274
  personCities?: string[];
9800
10275
  /** @description Person cities to leave out. Requires personCountryCodes. */
@@ -9873,6 +10348,10 @@ interface components {
9873
10348
  excludePersonIds?: string[];
9874
10349
  /** @description Email addresses to leave out. */
9875
10350
  excludeEmails?: string[];
10351
+ /** @description First name tokens, using accent-folded fuzzy matching. Requires companyId. */
10352
+ firstName?: string;
10353
+ /** @description Last name tokens, using accent-folded fuzzy matching. Requires companyId. */
10354
+ lastName?: string;
9876
10355
  /** @description Limit contacts to this company. This uses the company-indexed contact path and does not require country or industry filters. */
9877
10356
  companyId?: string;
9878
10357
  /** @description Contact location filters. Requires companyId. */
@@ -9981,6 +10460,12 @@ interface components {
9981
10460
  kind: "companies";
9982
10461
  /** @description Company filters saved on this list or search. */
9983
10462
  filters: {
10463
+ /** @description Company name prefixes. Match any name. */
10464
+ companyNames?: string[];
10465
+ /** @description Company name prefixes to leave out. */
10466
+ excludeCompanyNames?: string[];
10467
+ /** @description Company website domain. Exact host matching; root sites rank first. */
10468
+ domain?: string;
9984
10469
  /** @description Two-letter country codes to include. */
9985
10470
  countryCodes?: string[];
9986
10471
  /** @description State or region codes to include. */
@@ -10057,8 +10542,6 @@ interface components {
10057
10542
  excludeOrganizationIds?: string[];
10058
10543
  /** @description Website domains to leave out. */
10059
10544
  excludeDomains?: string[];
10060
- /** @description Website domain. Matching is exact on the host, and a root site ranks first. */
10061
- domain?: string;
10062
10545
  /** @description Insights filters. Supply at least one. */
10063
10546
  insights?: {
10064
10547
  /** @description Monthly organic visits. */
@@ -10268,6 +10751,12 @@ interface components {
10268
10751
  kind: "people";
10269
10752
  /** @description People filters saved on this list or search. */
10270
10753
  filters: {
10754
+ /** @description Company name alternatives or a domain. Finds the 50 closest token or prefix matches, ignoring punctuation, accents and legal suffixes. */
10755
+ companyNames?: string[];
10756
+ /** @description Company name prefixes to leave out. */
10757
+ excludeCompanyNames?: string[];
10758
+ /** @description Company website domain. Exact host matching; root sites rank first. */
10759
+ domain?: string;
10271
10760
  /** @description Two-letter country codes to include. */
10272
10761
  countryCodes?: string[];
10273
10762
  /** @description State or region codes to include. */
@@ -10328,6 +10817,13 @@ interface components {
10328
10817
  excludeOrganizationIds?: string[];
10329
10818
  /** @description Website domains to leave out. */
10330
10819
  excludeDomains?: string[];
10820
+ /** @description Person name alternatives. Add a company name, domain or id for common names and typo matching. Every non-particle token matches in any order, ignoring case, accents and punctuation. Scoped searches allow one edit per token of at least five letters. */
10821
+ personNames?: string[];
10822
+ /**
10823
+ * Format: email
10824
+ * @description Exact work email address, matched through the email index.
10825
+ */
10826
+ email?: string;
10331
10827
  /** @description Person cities to include. Requires personCountryCodes. */
10332
10828
  personCities?: string[];
10333
10829
  /** @description Person cities to leave out. Requires personCountryCodes. */
@@ -10406,6 +10902,10 @@ interface components {
10406
10902
  excludePersonIds?: string[];
10407
10903
  /** @description Email addresses to leave out. */
10408
10904
  excludeEmails?: string[];
10905
+ /** @description First name tokens, using accent-folded fuzzy matching. Requires companyId. */
10906
+ firstName?: string;
10907
+ /** @description Last name tokens, using accent-folded fuzzy matching. Requires companyId. */
10908
+ lastName?: string;
10409
10909
  /** @description Limit contacts to this company. This uses the company-indexed contact path and does not require country or industry filters. */
10410
10910
  companyId?: string;
10411
10911
  /** @description Contact location filters. Requires companyId. */
@@ -10424,6 +10924,7 @@ interface components {
10424
10924
  /** @enum {string} */
10425
10925
  lastRunStatus: "never" | "queued" | "running" | "complete" | "failed";
10426
10926
  lastRunAt: string | null;
10927
+ lastRunNotice?: string | null;
10427
10928
  /** Format: date-time */
10428
10929
  createdAt: string;
10429
10930
  /** Format: date-time */
@@ -10490,6 +10991,21 @@ interface components {
10490
10991
  lastSeenAt: string;
10491
10992
  }[];
10492
10993
  runs: {
10994
+ /** @enum {string} */
10995
+ purpose?: "preview" | "refresh";
10996
+ checkedCount?: number;
10997
+ summary?: {
10998
+ releaseId: string;
10999
+ /** Format: date */
11000
+ releaseDate: string;
11001
+ added: number;
11002
+ flagged: number;
11003
+ removed: number;
11004
+ capped?: boolean;
11005
+ blocked: boolean;
11006
+ notice: string | null;
11007
+ executed: boolean;
11008
+ } | null;
10493
11009
  /** Format: uuid */
10494
11010
  id: string;
10495
11011
  /** Format: uuid */
@@ -10538,6 +11054,7 @@ interface components {
10538
11054
  added: number;
10539
11055
  flagged: number;
10540
11056
  removed: number;
11057
+ capped?: boolean;
10541
11058
  blocked: boolean;
10542
11059
  notice: string | null;
10543
11060
  executed: boolean;
@@ -10548,11 +11065,32 @@ interface components {
10548
11065
  * @description Saved list id.
10549
11066
  */
10550
11067
  id: string;
11068
+ /**
11069
+ * @description Preview counts without changing records, or refresh using the saved caps.
11070
+ * @default refresh
11071
+ * @enum {string}
11072
+ */
11073
+ purpose?: "preview" | "refresh";
10551
11074
  };
10552
11075
  "lists.run.output": {
10553
11076
  executed: boolean;
10554
11077
  dispatched: boolean;
10555
11078
  run: {
11079
+ /** @enum {string} */
11080
+ purpose?: "preview" | "refresh";
11081
+ checkedCount?: number;
11082
+ summary?: {
11083
+ releaseId: string;
11084
+ /** Format: date */
11085
+ releaseDate: string;
11086
+ added: number;
11087
+ flagged: number;
11088
+ removed: number;
11089
+ capped?: boolean;
11090
+ blocked: boolean;
11091
+ notice: string | null;
11092
+ executed: boolean;
11093
+ } | null;
10556
11094
  /** Format: uuid */
10557
11095
  id: string;
10558
11096
  /** Format: uuid */
@@ -10585,6 +11123,58 @@ interface components {
10585
11123
  releaseDate: string;
10586
11124
  };
10587
11125
  };
11126
+ "lists.status.input": {
11127
+ /**
11128
+ * Format: uuid
11129
+ * @description Saved list id.
11130
+ */
11131
+ id: string;
11132
+ /**
11133
+ * Format: uuid
11134
+ * @description Background run id returned by lists.run.
11135
+ */
11136
+ runId: string;
11137
+ };
11138
+ "lists.status.output": {
11139
+ /** @enum {string} */
11140
+ purpose?: "preview" | "refresh";
11141
+ checkedCount?: number;
11142
+ summary?: {
11143
+ releaseId: string;
11144
+ /** Format: date */
11145
+ releaseDate: string;
11146
+ added: number;
11147
+ flagged: number;
11148
+ removed: number;
11149
+ capped?: boolean;
11150
+ blocked: boolean;
11151
+ notice: string | null;
11152
+ executed: boolean;
11153
+ } | null;
11154
+ /** Format: uuid */
11155
+ id: string;
11156
+ /** Format: uuid */
11157
+ listId: string;
11158
+ releaseId: string;
11159
+ /** Format: date */
11160
+ releaseDate: string;
11161
+ /** @enum {string} */
11162
+ status: "queued" | "running" | "complete" | "failed";
11163
+ companyCount: number;
11164
+ peopleCount: number;
11165
+ newCompanies: number;
11166
+ newPeople: number;
11167
+ errorCode: string | null;
11168
+ /** Format: date-time */
11169
+ createdAt: string;
11170
+ completedAt: string | null;
11171
+ /** @default 0 */
11172
+ added: number;
11173
+ /** @default 0 */
11174
+ flagged: number;
11175
+ /** @default 0 */
11176
+ removed: number;
11177
+ };
10588
11178
  "lookup.company.input": {
10589
11179
  /** @description Website domain. Matching is exact on the host. */
10590
11180
  domain: string;
@@ -11150,6 +11740,12 @@ interface components {
11150
11740
  zeroResults: boolean;
11151
11741
  };
11152
11742
  "search.companies.input": {
11743
+ /** @description Company name prefixes. Match any name. */
11744
+ companyNames?: string[];
11745
+ /** @description Company name prefixes to leave out. */
11746
+ excludeCompanyNames?: string[];
11747
+ /** @description Company website domain. Exact host matching; root sites rank first. */
11748
+ domain?: string;
11153
11749
  /** @description Two-letter country codes to include. */
11154
11750
  countryCodes?: string[];
11155
11751
  /** @description State or region codes to include. */
@@ -11233,8 +11829,6 @@ interface components {
11233
11829
  limit?: number;
11234
11830
  /** @description Cursor from the previous page. Omit it for the first page. */
11235
11831
  cursor?: string;
11236
- /** @description Website domain. Matching is exact on the host, and a root site ranks first. */
11237
- domain?: string;
11238
11832
  /** @description Insights filters. Supply at least one. */
11239
11833
  insights?: {
11240
11834
  /** @description Monthly organic visits. */
@@ -11563,6 +12157,12 @@ interface components {
11563
12157
  zeroResults: boolean;
11564
12158
  };
11565
12159
  "search.count.input": {
12160
+ /** @description Company name prefixes. Match any name. */
12161
+ companyNames?: string[];
12162
+ /** @description Company name prefixes to leave out. */
12163
+ excludeCompanyNames?: string[];
12164
+ /** @description Company website domain. Exact host matching; root sites rank first. */
12165
+ domain?: string;
11566
12166
  /** @description Two-letter country codes to include. */
11567
12167
  countryCodes?: string[];
11568
12168
  /** @description State or region codes to include. */
@@ -11639,8 +12239,6 @@ interface components {
11639
12239
  excludeOrganizationIds?: string[];
11640
12240
  /** @description Website domains to leave out. */
11641
12241
  excludeDomains?: string[];
11642
- /** @description Website domain. Matching is exact on the host, and a root site ranks first. */
11643
- domain?: string;
11644
12242
  /** @description Insights filters. Supply at least one. */
11645
12243
  insights?: {
11646
12244
  /** @description Monthly organic visits. */
@@ -11848,6 +12446,191 @@ interface components {
11848
12446
  isIcpBaseline?: boolean;
11849
12447
  zeroResults: boolean;
11850
12448
  };
12449
+ "search.count_people.input": {
12450
+ /** @description People filters to count. */
12451
+ filters: {
12452
+ /** @description Company name alternatives or a domain. Finds the 50 closest token or prefix matches, ignoring punctuation, accents and legal suffixes. */
12453
+ companyNames?: string[];
12454
+ /** @description Company name prefixes to leave out. */
12455
+ excludeCompanyNames?: string[];
12456
+ /** @description Company website domain. Exact host matching; root sites rank first. */
12457
+ domain?: string;
12458
+ /** @description Two-letter country codes to include. */
12459
+ countryCodes?: string[];
12460
+ /** @description State or region codes to include. */
12461
+ stateCodes?: string[];
12462
+ /** @description Industries to include. */
12463
+ industries?: string[];
12464
+ /** @description Two-letter country codes to leave out. */
12465
+ excludeCountryCodes?: string[];
12466
+ /** @description State or region codes to leave out. */
12467
+ excludeStateCodes?: string[];
12468
+ /** @description Industries to leave out. */
12469
+ excludeIndustries?: string[];
12470
+ /** @description Lowest employee count to include. */
12471
+ employeeCountMin?: number;
12472
+ /** @description Highest employee count to include. */
12473
+ employeeCountMax?: number;
12474
+ /** @description Lowest annual revenue to include, in US dollars. */
12475
+ revenueMinUsd?: number;
12476
+ /** @description Highest annual revenue to include, in US dollars. */
12477
+ revenueMaxUsd?: number;
12478
+ /** @description NAICS 2022 codes to include. */
12479
+ naics2022Codes?: string[];
12480
+ /** @description NAICS 2022 codes to leave out. */
12481
+ excludeNaics2022Codes?: string[];
12482
+ /** @description Funding round types to include. */
12483
+ fundingTypes?: string[];
12484
+ /** @description Funding round types to leave out. */
12485
+ excludeFundingTypes?: string[];
12486
+ /** @description Keywords to match. A company can match any of them. */
12487
+ keywords?: string[];
12488
+ /** @description Keywords the company must match. */
12489
+ requiredKeywords?: string[];
12490
+ /** @description Keyword groups. The company must match every group, and any keyword inside a group. */
12491
+ requiredKeywordGroups?: string[][];
12492
+ /** @description Keywords that remove a company. */
12493
+ excludeKeywords?: string[];
12494
+ /**
12495
+ * @description Whether the company has a website.
12496
+ * @enum {string}
12497
+ */
12498
+ websiteAvailability?: "any" | "available" | "missing";
12499
+ /**
12500
+ * @description Whether the company has a LinkedIn page.
12501
+ * @enum {string}
12502
+ */
12503
+ linkedinAvailability?: "any" | "available" | "missing";
12504
+ /**
12505
+ * Format: date
12506
+ * @description Include funding on or after this date.
12507
+ */
12508
+ fundingDateAfter?: string;
12509
+ /**
12510
+ * Format: date
12511
+ * @description Include funding on or before this date.
12512
+ */
12513
+ fundingDateBefore?: string;
12514
+ /** @description Opaque company ids (hdo_) to leave out. */
12515
+ excludeOrganizationIds?: string[];
12516
+ /** @description Website domains to leave out. */
12517
+ excludeDomains?: string[];
12518
+ /** @description Person name alternatives. Add a company name, domain or id for common names and typo matching. Every non-particle token matches in any order, ignoring case, accents and punctuation. Scoped searches allow one edit per token of at least five letters. */
12519
+ personNames?: string[];
12520
+ /**
12521
+ * Format: email
12522
+ * @description Exact work email address, matched through the email index.
12523
+ */
12524
+ email?: string;
12525
+ /** @description Person cities to include. Requires personCountryCodes. */
12526
+ personCities?: string[];
12527
+ /** @description Person cities to leave out. Requires personCountryCodes. */
12528
+ excludePersonCities?: string[];
12529
+ /** @description Person state or region codes to include. */
12530
+ personStateCodes?: string[];
12531
+ /** @description Person state or region codes to leave out. */
12532
+ excludePersonStateCodes?: string[];
12533
+ /** @description Person country codes to include. */
12534
+ personCountryCodes?: string[];
12535
+ /** @description Person country codes to leave out. */
12536
+ excludePersonCountryCodes?: string[];
12537
+ /** @description Job cities to include. Requires jobCountryCodes. */
12538
+ jobCities?: string[];
12539
+ /** @description Job cities to leave out. Requires jobCountryCodes. */
12540
+ excludeJobCities?: string[];
12541
+ /** @description Job state or region codes to include. */
12542
+ jobStateCodes?: string[];
12543
+ /** @description Job state or region codes to leave out. */
12544
+ excludeJobStateCodes?: string[];
12545
+ /** @description Job country codes to include. */
12546
+ jobCountryCodes?: string[];
12547
+ /** @description Job country codes to leave out. */
12548
+ excludeJobCountryCodes?: string[];
12549
+ /** @description Company HQ cities to include. Requires countryCodes. */
12550
+ companyCities?: string[];
12551
+ /** @description Company HQ cities to leave out. Requires countryCodes. */
12552
+ excludeCompanyCities?: string[];
12553
+ /** @description Earliest company founding year. */
12554
+ companyFoundedYearMin?: number;
12555
+ /** @description Latest company founding year. */
12556
+ companyFoundedYearMax?: number;
12557
+ /**
12558
+ * Format: date
12559
+ * @description Include jobs started on or after this date.
12560
+ */
12561
+ jobStartDateAfter?: string;
12562
+ /**
12563
+ * Format: date
12564
+ * @description Include jobs started on or before this date.
12565
+ */
12566
+ jobStartDateBefore?: string;
12567
+ /** @description Job title keywords to match. A person can match any of them. */
12568
+ titleKeywords?: string[];
12569
+ /** @description Job title keywords the person must match. */
12570
+ requiredTitleKeywords?: string[];
12571
+ /** @description Job title keyword groups. The person must match every group, and any keyword inside a group. */
12572
+ requiredTitleKeywordGroups?: string[][];
12573
+ /** @description Job title keywords that remove a person. */
12574
+ excludeTitleKeywords?: string[];
12575
+ /** @description Job functions to include. */
12576
+ jobFunctions?: string[];
12577
+ /** @description Job functions to leave out. */
12578
+ excludeJobFunctions?: string[];
12579
+ /** @description Job levels to include. */
12580
+ jobLevels?: string[];
12581
+ /** @description Job levels to leave out. */
12582
+ excludeJobLevels?: string[];
12583
+ /** @description Go-to-market role families to include. */
12584
+ gtmRoleFamilies?: string[];
12585
+ /** @description Go-to-market role families to leave out. */
12586
+ excludeGtmRoleFamilies?: string[];
12587
+ /** @description When true, only people with a verified work email are returned. */
12588
+ requireVerifiedEmail?: boolean;
12589
+ /**
12590
+ * @description Whether the person has an email address.
12591
+ * @enum {string}
12592
+ */
12593
+ emailAvailability?: "any" | "available" | "missing";
12594
+ /**
12595
+ * @description Whether the person has a phone number.
12596
+ * @enum {string}
12597
+ */
12598
+ phoneAvailability?: "any" | "available" | "missing";
12599
+ /** @description Opaque person ids (hdp_) to leave out. */
12600
+ excludePersonIds?: string[];
12601
+ /** @description Email addresses to leave out. */
12602
+ excludeEmails?: string[];
12603
+ /** @description First name tokens, using accent-folded fuzzy matching. Requires companyId. */
12604
+ firstName?: string;
12605
+ /** @description Last name tokens, using accent-folded fuzzy matching. Requires companyId. */
12606
+ lastName?: string;
12607
+ /** @description Limit contacts to this company. This uses the company-indexed contact path and does not require country or industry filters. */
12608
+ companyId?: string;
12609
+ /** @description Contact location filters. Requires companyId. */
12610
+ contactLocation?: {
12611
+ /** @description Person or job location country codes. */
12612
+ countryCodes?: string[];
12613
+ /** @description Person or job location state codes. */
12614
+ stateCodes?: string[];
12615
+ /** @description Person or job location cities. */
12616
+ cities?: string[];
12617
+ };
12618
+ };
12619
+ /**
12620
+ * @description Explicitly run a detailed capped count instead of a rollup estimate. Never enable for live filtering.
12621
+ * @default false
12622
+ */
12623
+ exact?: boolean;
12624
+ };
12625
+ "search.count_people.output": {
12626
+ personCount: number;
12627
+ exact: boolean;
12628
+ releaseId: string;
12629
+ omittedFilters: string[];
12630
+ /** @enum {string} */
12631
+ source: "rollup" | "exact";
12632
+ exactCostUsd: number;
12633
+ };
11851
12634
  "search.facets.input": {
11852
12635
  /** @description Get only city suggestions for these countries; omit this field for other suggestions. Person and job cities require a company country or industry. */
11853
12636
  cities?: {
@@ -11871,25 +12654,48 @@ interface components {
11871
12654
  countryCode: string;
11872
12655
  count: number;
11873
12656
  }[];
12657
+ /** @default [] */
12658
+ jobFunctions: {
12659
+ value: string;
12660
+ label?: string;
12661
+ count: number;
12662
+ }[];
12663
+ /** @default [] */
12664
+ jobLevels: {
12665
+ value: string;
12666
+ label?: string;
12667
+ count: number;
12668
+ }[];
12669
+ /** @default [] */
12670
+ gtmRoleFamilies: {
12671
+ value: string;
12672
+ label?: string;
12673
+ count: number;
12674
+ }[];
11874
12675
  industries: {
11875
12676
  value: string;
12677
+ label?: string;
11876
12678
  count: number;
11877
12679
  }[];
11878
12680
  countryCodes: {
11879
12681
  value: string;
12682
+ label?: string;
11880
12683
  count: number;
11881
12684
  }[];
11882
12685
  stateCodes: {
11883
12686
  value: string;
12687
+ label?: string;
11884
12688
  count: number;
11885
12689
  }[];
11886
12690
  fundingTypes: {
11887
12691
  value: string;
12692
+ label?: string;
11888
12693
  count: number;
11889
12694
  }[];
11890
12695
  /** @default [] */
11891
12696
  naics2022Codes: {
11892
12697
  value: string;
12698
+ label?: string;
11893
12699
  count: number;
11894
12700
  }[];
11895
12701
  /** @default {} */
@@ -11914,6 +12720,12 @@ interface components {
11914
12720
  /** @constant */
11915
12721
  kind: "companies";
11916
12722
  filters: {
12723
+ /** @description Company name prefixes. Match any name. */
12724
+ companyNames?: string[];
12725
+ /** @description Company name prefixes to leave out. */
12726
+ excludeCompanyNames?: string[];
12727
+ /** @description Company website domain. Exact host matching; root sites rank first. */
12728
+ domain?: string;
11917
12729
  /** @description Two-letter country codes to include. */
11918
12730
  countryCodes?: string[];
11919
12731
  /** @description State or region codes to include. */
@@ -11996,6 +12808,12 @@ interface components {
11996
12808
  /** @constant */
11997
12809
  kind: "people";
11998
12810
  filters: {
12811
+ /** @description Company name alternatives or a domain. Finds the 50 closest token or prefix matches, ignoring punctuation, accents and legal suffixes. */
12812
+ companyNames?: string[];
12813
+ /** @description Company name prefixes to leave out. */
12814
+ excludeCompanyNames?: string[];
12815
+ /** @description Company website domain. Exact host matching; root sites rank first. */
12816
+ domain?: string;
11999
12817
  /** @description Two-letter country codes to include. */
12000
12818
  countryCodes?: string[];
12001
12819
  /** @description State or region codes to include. */
@@ -12056,6 +12874,13 @@ interface components {
12056
12874
  excludeOrganizationIds?: string[];
12057
12875
  /** @description Website domains to leave out. */
12058
12876
  excludeDomains?: string[];
12877
+ /** @description Person name alternatives. Add a company name, domain or id for common names and typo matching. Every non-particle token matches in any order, ignoring case, accents and punctuation. Scoped searches allow one edit per token of at least five letters. */
12878
+ personNames?: string[];
12879
+ /**
12880
+ * Format: email
12881
+ * @description Exact work email address, matched through the email index.
12882
+ */
12883
+ email?: string;
12059
12884
  /** @description Person cities to include. Requires personCountryCodes. */
12060
12885
  personCities?: string[];
12061
12886
  /** @description Person cities to leave out. Requires personCountryCodes. */
@@ -12134,6 +12959,10 @@ interface components {
12134
12959
  excludePersonIds?: string[];
12135
12960
  /** @description Email addresses to leave out. */
12136
12961
  excludeEmails?: string[];
12962
+ /** @description First name tokens, using accent-folded fuzzy matching. Requires companyId. */
12963
+ firstName?: string;
12964
+ /** @description Last name tokens, using accent-folded fuzzy matching. Requires companyId. */
12965
+ lastName?: string;
12137
12966
  /** @description Limit contacts to this company. This uses the company-indexed contact path and does not require country or industry filters. */
12138
12967
  companyId?: string;
12139
12968
  /** @description Contact location filters. Requires companyId. */
@@ -12149,6 +12978,12 @@ interface components {
12149
12978
  explanation: string;
12150
12979
  };
12151
12980
  "search.people.input": {
12981
+ /** @description Company name alternatives or a domain. Finds the 50 closest token or prefix matches, ignoring punctuation, accents and legal suffixes. */
12982
+ companyNames?: string[];
12983
+ /** @description Company name prefixes to leave out. */
12984
+ excludeCompanyNames?: string[];
12985
+ /** @description Company website domain. Exact host matching; root sites rank first. */
12986
+ domain?: string;
12152
12987
  /** @description Two-letter country codes to include. */
12153
12988
  countryCodes?: string[];
12154
12989
  /** @description State or region codes to include. */
@@ -12209,6 +13044,13 @@ interface components {
12209
13044
  excludeOrganizationIds?: string[];
12210
13045
  /** @description Website domains to leave out. */
12211
13046
  excludeDomains?: string[];
13047
+ /** @description Person name alternatives. Add a company name, domain or id for common names and typo matching. Every non-particle token matches in any order, ignoring case, accents and punctuation. Scoped searches allow one edit per token of at least five letters. */
13048
+ personNames?: string[];
13049
+ /**
13050
+ * Format: email
13051
+ * @description Exact work email address, matched through the email index.
13052
+ */
13053
+ email?: string;
12212
13054
  /** @description Person cities to include. Requires personCountryCodes. */
12213
13055
  personCities?: string[];
12214
13056
  /** @description Person cities to leave out. Requires personCountryCodes. */
@@ -12294,6 +13136,10 @@ interface components {
12294
13136
  limit?: number;
12295
13137
  /** @description Cursor from the previous page. Omit it for the first page. */
12296
13138
  cursor?: string;
13139
+ /** @description First name tokens, using accent-folded fuzzy matching. Requires companyId. */
13140
+ firstName?: string;
13141
+ /** @description Last name tokens, using accent-folded fuzzy matching. Requires companyId. */
13142
+ lastName?: string;
12297
13143
  /** @description Limit contacts to this company. This uses the company-indexed contact path and does not require country or industry filters. */
12298
13144
  companyId?: string;
12299
13145
  /** @description Contact location filters. Requires companyId. */
@@ -12312,6 +13158,16 @@ interface components {
12312
13158
  excludeListId?: string;
12313
13159
  };
12314
13160
  "search.people.output": {
13161
+ companyScope?: {
13162
+ query: string;
13163
+ truncated: boolean;
13164
+ companies: {
13165
+ /** @description Opaque company id (hdo_). */
13166
+ id: string;
13167
+ companyName: string | null;
13168
+ normalizedDomain: string | null;
13169
+ }[];
13170
+ };
12315
13171
  items: {
12316
13172
  /** @description Opaque person id (hdp_). */
12317
13173
  id: string;
@@ -12350,6 +13206,296 @@ interface components {
12350
13206
  suppressionSources?: string[];
12351
13207
  zeroResults: boolean;
12352
13208
  };
13209
+ "search.preview_company_count.input": {
13210
+ /** @description Company name prefixes. Match any name. */
13211
+ companyNames?: string[];
13212
+ /** @description Company name prefixes to leave out. */
13213
+ excludeCompanyNames?: string[];
13214
+ /** @description Company website domain. Exact host matching; root sites rank first. */
13215
+ domain?: string;
13216
+ /** @description Two-letter country codes to include. */
13217
+ countryCodes?: string[];
13218
+ /** @description State or region codes to include. */
13219
+ stateCodes?: string[];
13220
+ /** @description Company HQ cities to include. Requires countryCodes. */
13221
+ cities?: string[];
13222
+ /** @description Company HQ cities to leave out. Requires countryCodes. */
13223
+ excludeCities?: string[];
13224
+ /** @description Company HQ postcode prefixes to include. */
13225
+ postcodes?: string[];
13226
+ /** @description Company HQ postcode prefixes to leave out. */
13227
+ excludePostcodes?: string[];
13228
+ /** @description Earliest company founding year. */
13229
+ foundedYearMin?: number;
13230
+ /** @description Latest company founding year. */
13231
+ foundedYearMax?: number;
13232
+ /** @description Lowest total company funding, in US dollars. */
13233
+ totalFundingMinUsd?: number;
13234
+ /** @description Highest total company funding, in US dollars. */
13235
+ totalFundingMaxUsd?: number;
13236
+ /** @description Industries to include. */
13237
+ industries?: string[];
13238
+ /** @description Two-letter country codes to leave out. */
13239
+ excludeCountryCodes?: string[];
13240
+ /** @description State or region codes to leave out. */
13241
+ excludeStateCodes?: string[];
13242
+ /** @description Industries to leave out. */
13243
+ excludeIndustries?: string[];
13244
+ /** @description Lowest employee count to include. */
13245
+ employeeCountMin?: number;
13246
+ /** @description Highest employee count to include. */
13247
+ employeeCountMax?: number;
13248
+ /** @description Lowest annual revenue to include, in US dollars. */
13249
+ revenueMinUsd?: number;
13250
+ /** @description Highest annual revenue to include, in US dollars. */
13251
+ revenueMaxUsd?: number;
13252
+ /** @description NAICS 2022 codes to include. */
13253
+ naics2022Codes?: string[];
13254
+ /** @description NAICS 2022 codes to leave out. */
13255
+ excludeNaics2022Codes?: string[];
13256
+ /** @description Funding round types to include. */
13257
+ fundingTypes?: string[];
13258
+ /** @description Funding round types to leave out. */
13259
+ excludeFundingTypes?: string[];
13260
+ /** @description Keywords to match. A company can match any of them. */
13261
+ keywords?: string[];
13262
+ /** @description Keywords the company must match. */
13263
+ requiredKeywords?: string[];
13264
+ /** @description Keyword groups. The company must match every group, and any keyword inside a group. */
13265
+ requiredKeywordGroups?: string[][];
13266
+ /** @description Keywords that remove a company. */
13267
+ excludeKeywords?: string[];
13268
+ /**
13269
+ * @description Whether the company has a website.
13270
+ * @enum {string}
13271
+ */
13272
+ websiteAvailability?: "any" | "available" | "missing";
13273
+ /**
13274
+ * @description Whether the company has a LinkedIn page.
13275
+ * @enum {string}
13276
+ */
13277
+ linkedinAvailability?: "any" | "available" | "missing";
13278
+ /**
13279
+ * Format: date
13280
+ * @description Include funding on or after this date.
13281
+ */
13282
+ fundingDateAfter?: string;
13283
+ /**
13284
+ * Format: date
13285
+ * @description Include funding on or before this date.
13286
+ */
13287
+ fundingDateBefore?: string;
13288
+ /** @description Opaque company ids (hdo_) to leave out. */
13289
+ excludeOrganizationIds?: string[];
13290
+ /** @description Website domains to leave out. */
13291
+ excludeDomains?: string[];
13292
+ /** @description Insights filters. Supply at least one. */
13293
+ insights?: {
13294
+ /** @description Monthly organic visits. */
13295
+ monthlyOrganicTraffic?: {
13296
+ /** @description Lower bound, inclusive. */
13297
+ min?: number;
13298
+ /** @description Upper bound, inclusive. */
13299
+ max?: number;
13300
+ };
13301
+ /** @description Monthly paid visits. */
13302
+ monthlyPaidTraffic?: {
13303
+ /** @description Lower bound, inclusive. */
13304
+ min?: number;
13305
+ /** @description Upper bound, inclusive. */
13306
+ max?: number;
13307
+ };
13308
+ /** @description Monthly visits, organic and paid. */
13309
+ totalMonthlyTraffic?: {
13310
+ /** @description Lower bound, inclusive. */
13311
+ min?: number;
13312
+ /** @description Upper bound, inclusive. */
13313
+ max?: number;
13314
+ };
13315
+ /** @description Monthly Google ad spend, in cents. */
13316
+ monthlyGoogleAdSpendCents?: {
13317
+ /** @description Lower bound, inclusive, in cents. */
13318
+ min?: number;
13319
+ /** @description Upper bound, inclusive, in cents. */
13320
+ max?: number;
13321
+ };
13322
+ /** @description Latest funding round amount, in cents. */
13323
+ lastFundingAmountCents?: {
13324
+ /** @description Lower bound, inclusive, in cents. */
13325
+ min?: number;
13326
+ /** @description Upper bound, inclusive, in cents. */
13327
+ max?: number;
13328
+ };
13329
+ /** @description Total funding raised, in cents. */
13330
+ totalFundingAmountCents?: {
13331
+ /** @description Lower bound, inclusive, in cents. */
13332
+ min?: number;
13333
+ /** @description Upper bound, inclusive, in cents. */
13334
+ max?: number;
13335
+ };
13336
+ /** @description Employee growth rate, as reported in the release. Negative values include shrinking teams. */
13337
+ employeeGrowthRate?: {
13338
+ /** @description Lower bound, inclusive, for the reported growth rate. */
13339
+ min?: number;
13340
+ /** @description Upper bound, inclusive, for the reported growth rate. */
13341
+ max?: number;
13342
+ };
13343
+ /** @description Account executive open roles. */
13344
+ accountExecutiveOpenRoles?: {
13345
+ /** @description Minimum open roles, inclusive. */
13346
+ min?: number;
13347
+ /** @description Maximum open roles, inclusive. */
13348
+ max?: number;
13349
+ };
13350
+ /** @description Business development open roles. */
13351
+ businessDevelopmentOpenRoles?: {
13352
+ /** @description Minimum open roles, inclusive. */
13353
+ min?: number;
13354
+ /** @description Maximum open roles, inclusive. */
13355
+ max?: number;
13356
+ };
13357
+ /** @description Customer success open roles. */
13358
+ customerSuccessOpenRoles?: {
13359
+ /** @description Minimum open roles, inclusive. */
13360
+ min?: number;
13361
+ /** @description Maximum open roles, inclusive. */
13362
+ max?: number;
13363
+ };
13364
+ /** @description Demand generation open roles. */
13365
+ demandGenerationOpenRoles?: {
13366
+ /** @description Minimum open roles, inclusive. */
13367
+ min?: number;
13368
+ /** @description Maximum open roles, inclusive. */
13369
+ max?: number;
13370
+ };
13371
+ /** @description DevOps open roles. */
13372
+ devopsOpenRoles?: {
13373
+ /** @description Minimum open roles, inclusive. */
13374
+ min?: number;
13375
+ /** @description Maximum open roles, inclusive. */
13376
+ max?: number;
13377
+ };
13378
+ /** @description Governance, risk and compliance open roles. */
13379
+ grcOpenRoles?: {
13380
+ /** @description Minimum open roles, inclusive. */
13381
+ min?: number;
13382
+ /** @description Maximum open roles, inclusive. */
13383
+ max?: number;
13384
+ };
13385
+ /** @description IT open roles. */
13386
+ itOpenRoles?: {
13387
+ /** @description Minimum open roles, inclusive. */
13388
+ min?: number;
13389
+ /** @description Maximum open roles, inclusive. */
13390
+ max?: number;
13391
+ };
13392
+ /** @description Marketing open roles. */
13393
+ marketingOpenRoles?: {
13394
+ /** @description Minimum open roles, inclusive. */
13395
+ min?: number;
13396
+ /** @description Maximum open roles, inclusive. */
13397
+ max?: number;
13398
+ };
13399
+ /** @description Network infrastructure open roles. */
13400
+ networkInfrastructureOpenRoles?: {
13401
+ /** @description Minimum open roles, inclusive. */
13402
+ min?: number;
13403
+ /** @description Maximum open roles, inclusive. */
13404
+ max?: number;
13405
+ };
13406
+ /** @description Operations open roles. */
13407
+ operationsOpenRoles?: {
13408
+ /** @description Minimum open roles, inclusive. */
13409
+ min?: number;
13410
+ /** @description Maximum open roles, inclusive. */
13411
+ max?: number;
13412
+ };
13413
+ /** @description Sales open roles. */
13414
+ salesOpenRoles?: {
13415
+ /** @description Minimum open roles, inclusive. */
13416
+ min?: number;
13417
+ /** @description Maximum open roles, inclusive. */
13418
+ max?: number;
13419
+ };
13420
+ /** @description Security open roles. */
13421
+ securityOpenRoles?: {
13422
+ /** @description Minimum open roles, inclusive. */
13423
+ min?: number;
13424
+ /** @description Maximum open roles, inclusive. */
13425
+ max?: number;
13426
+ };
13427
+ /** @description Apple App Store rating, from 0 to 5. */
13428
+ appStoreRating?: {
13429
+ /** @description Minimum rating, inclusive, from 0 to 5. */
13430
+ min?: number;
13431
+ /** @description Maximum rating, inclusive, from 0 to 5. */
13432
+ max?: number;
13433
+ };
13434
+ /** @description Google Play rating, from 0 to 5. */
13435
+ playStoreRating?: {
13436
+ /** @description Minimum rating, inclusive, from 0 to 5. */
13437
+ min?: number;
13438
+ /** @description Maximum rating, inclusive, from 0 to 5. */
13439
+ max?: number;
13440
+ };
13441
+ /** @description CRM product names. Match any reported product, ignoring case and surrounding spaces. */
13442
+ crmTechnology?: string[];
13443
+ /** @description Exclude CRM product names. Companies with no reported product remain included. */
13444
+ excludeCrmTechnology?: string[];
13445
+ /** @description Marketing automation product names. Match any reported product, ignoring case and surrounding spaces. */
13446
+ marketingAutomationTechnology?: string[];
13447
+ /** @description Exclude Marketing automation product names. Companies with no reported product remain included. */
13448
+ excludeMarketingAutomationTechnology?: string[];
13449
+ /** @description ABM product names. Match any reported product, ignoring case and surrounding spaces. */
13450
+ abmTechnology?: string[];
13451
+ /** @description Exclude ABM product names. Companies with no reported product remain included. */
13452
+ excludeAbmTechnology?: string[];
13453
+ /** @description Sales automation product names. Match any reported product, ignoring case and surrounding spaces. */
13454
+ salesAutomationTechnology?: string[];
13455
+ /** @description Exclude Sales automation product names. Companies with no reported product remain included. */
13456
+ excludeSalesAutomationTechnology?: string[];
13457
+ /** @description Analytics product names. Match any reported product, ignoring case and surrounding spaces. */
13458
+ analyticsTechnology?: string[];
13459
+ /** @description Exclude Analytics product names. Companies with no reported product remain included. */
13460
+ excludeAnalyticsTechnology?: string[];
13461
+ /** @description CMS product names. Match any reported product, ignoring case and surrounding spaces. */
13462
+ cmsTechnology?: string[];
13463
+ /** @description Exclude CMS product names. Companies with no reported product remain included. */
13464
+ excludeCmsTechnology?: string[];
13465
+ /** @description Cloud provider product names. Match any reported product, ignoring case and surrounding spaces. */
13466
+ cloudProviderTechnology?: string[];
13467
+ /** @description Exclude Cloud provider product names. Companies with no reported product remain included. */
13468
+ excludeCloudProviderTechnology?: string[];
13469
+ /** @description Ecommerce product names. Match any reported product, ignoring case and surrounding spaces. */
13470
+ ecommerceTechnology?: string[];
13471
+ /** @description Exclude Ecommerce product names. Companies with no reported product remain included. */
13472
+ excludeEcommerceTechnology?: string[];
13473
+ /** @description ERP product names. Match any reported product, ignoring case and surrounding spaces. */
13474
+ erpTechnology?: string[];
13475
+ /** @description Exclude ERP product names. Companies with no reported product remain included. */
13476
+ excludeErpTechnology?: string[];
13477
+ /** @description Application security product names. Match any reported product, ignoring case and surrounding spaces. */
13478
+ applicationSecurityTechnology?: string[];
13479
+ /** @description Exclude Application security product names. Companies with no reported product remain included. */
13480
+ excludeApplicationSecurityTechnology?: string[];
13481
+ /** @description Cloud security product names. Match any reported product, ignoring case and surrounding spaces. */
13482
+ cloudSecurityTechnology?: string[];
13483
+ /** @description Exclude Cloud security product names. Companies with no reported product remain included. */
13484
+ excludeCloudSecurityTechnology?: string[];
13485
+ /** @description Email security product names. Match any reported product, ignoring case and surrounding spaces. */
13486
+ emailSecurityTechnology?: string[];
13487
+ /** @description Exclude Email security product names. Companies with no reported product remain included. */
13488
+ excludeEmailSecurityTechnology?: string[];
13489
+ /** @description Technology categories the company must have. */
13490
+ technologyPresent?: ("crm" | "marketingAutomation" | "abm" | "salesAutomation" | "analytics" | "cms" | "cloudProvider" | "ecommerce" | "erp" | "security")[];
13491
+ };
13492
+ };
13493
+ "search.preview_company_count.output": {
13494
+ companyCount: number;
13495
+ estimatedContactCount: number | null;
13496
+ isIcpBaseline?: boolean;
13497
+ releaseId: string;
13498
+ };
12353
13499
  "searches.list.input": {
12354
13500
  /**
12355
13501
  * Format: uuid
@@ -12377,6 +13523,12 @@ interface components {
12377
13523
  kind: "companies";
12378
13524
  /** @description Company filters saved on this list or search. */
12379
13525
  filters: {
13526
+ /** @description Company name prefixes. Match any name. */
13527
+ companyNames?: string[];
13528
+ /** @description Company name prefixes to leave out. */
13529
+ excludeCompanyNames?: string[];
13530
+ /** @description Company website domain. Exact host matching; root sites rank first. */
13531
+ domain?: string;
12380
13532
  /** @description Two-letter country codes to include. */
12381
13533
  countryCodes?: string[];
12382
13534
  /** @description State or region codes to include. */
@@ -12453,8 +13605,6 @@ interface components {
12453
13605
  excludeOrganizationIds?: string[];
12454
13606
  /** @description Website domains to leave out. */
12455
13607
  excludeDomains?: string[];
12456
- /** @description Website domain. Matching is exact on the host, and a root site ranks first. */
12457
- domain?: string;
12458
13608
  /** @description Insights filters. Supply at least one. */
12459
13609
  insights?: {
12460
13610
  /** @description Monthly organic visits. */
@@ -12664,6 +13814,12 @@ interface components {
12664
13814
  kind: "people";
12665
13815
  /** @description People filters saved on this list or search. */
12666
13816
  filters: {
13817
+ /** @description Company name alternatives or a domain. Finds the 50 closest token or prefix matches, ignoring punctuation, accents and legal suffixes. */
13818
+ companyNames?: string[];
13819
+ /** @description Company name prefixes to leave out. */
13820
+ excludeCompanyNames?: string[];
13821
+ /** @description Company website domain. Exact host matching; root sites rank first. */
13822
+ domain?: string;
12667
13823
  /** @description Two-letter country codes to include. */
12668
13824
  countryCodes?: string[];
12669
13825
  /** @description State or region codes to include. */
@@ -12724,6 +13880,13 @@ interface components {
12724
13880
  excludeOrganizationIds?: string[];
12725
13881
  /** @description Website domains to leave out. */
12726
13882
  excludeDomains?: string[];
13883
+ /** @description Person name alternatives. Add a company name, domain or id for common names and typo matching. Every non-particle token matches in any order, ignoring case, accents and punctuation. Scoped searches allow one edit per token of at least five letters. */
13884
+ personNames?: string[];
13885
+ /**
13886
+ * Format: email
13887
+ * @description Exact work email address, matched through the email index.
13888
+ */
13889
+ email?: string;
12727
13890
  /** @description Person cities to include. Requires personCountryCodes. */
12728
13891
  personCities?: string[];
12729
13892
  /** @description Person cities to leave out. Requires personCountryCodes. */
@@ -12802,6 +13965,10 @@ interface components {
12802
13965
  excludePersonIds?: string[];
12803
13966
  /** @description Email addresses to leave out. */
12804
13967
  excludeEmails?: string[];
13968
+ /** @description First name tokens, using accent-folded fuzzy matching. Requires companyId. */
13969
+ firstName?: string;
13970
+ /** @description Last name tokens, using accent-folded fuzzy matching. Requires companyId. */
13971
+ lastName?: string;
12805
13972
  /** @description Limit contacts to this company. This uses the company-indexed contact path and does not require country or industry filters. */
12806
13973
  companyId?: string;
12807
13974
  /** @description Contact location filters. Requires companyId. */
@@ -12833,6 +14000,12 @@ interface components {
12833
14000
  kind: "companies";
12834
14001
  /** @description Company filters saved on this list or search. */
12835
14002
  filters: {
14003
+ /** @description Company name prefixes. Match any name. */
14004
+ companyNames?: string[];
14005
+ /** @description Company name prefixes to leave out. */
14006
+ excludeCompanyNames?: string[];
14007
+ /** @description Company website domain. Exact host matching; root sites rank first. */
14008
+ domain?: string;
12836
14009
  /** @description Two-letter country codes to include. */
12837
14010
  countryCodes?: string[];
12838
14011
  /** @description State or region codes to include. */
@@ -12909,8 +14082,6 @@ interface components {
12909
14082
  excludeOrganizationIds?: string[];
12910
14083
  /** @description Website domains to leave out. */
12911
14084
  excludeDomains?: string[];
12912
- /** @description Website domain. Matching is exact on the host, and a root site ranks first. */
12913
- domain?: string;
12914
14085
  /** @description Insights filters. Supply at least one. */
12915
14086
  insights?: {
12916
14087
  /** @description Monthly organic visits. */
@@ -13120,6 +14291,12 @@ interface components {
13120
14291
  kind: "people";
13121
14292
  /** @description People filters saved on this list or search. */
13122
14293
  filters: {
14294
+ /** @description Company name alternatives or a domain. Finds the 50 closest token or prefix matches, ignoring punctuation, accents and legal suffixes. */
14295
+ companyNames?: string[];
14296
+ /** @description Company name prefixes to leave out. */
14297
+ excludeCompanyNames?: string[];
14298
+ /** @description Company website domain. Exact host matching; root sites rank first. */
14299
+ domain?: string;
13123
14300
  /** @description Two-letter country codes to include. */
13124
14301
  countryCodes?: string[];
13125
14302
  /** @description State or region codes to include. */
@@ -13180,6 +14357,13 @@ interface components {
13180
14357
  excludeOrganizationIds?: string[];
13181
14358
  /** @description Website domains to leave out. */
13182
14359
  excludeDomains?: string[];
14360
+ /** @description Person name alternatives. Add a company name, domain or id for common names and typo matching. Every non-particle token matches in any order, ignoring case, accents and punctuation. Scoped searches allow one edit per token of at least five letters. */
14361
+ personNames?: string[];
14362
+ /**
14363
+ * Format: email
14364
+ * @description Exact work email address, matched through the email index.
14365
+ */
14366
+ email?: string;
13183
14367
  /** @description Person cities to include. Requires personCountryCodes. */
13184
14368
  personCities?: string[];
13185
14369
  /** @description Person cities to leave out. Requires personCountryCodes. */
@@ -13258,6 +14442,10 @@ interface components {
13258
14442
  excludePersonIds?: string[];
13259
14443
  /** @description Email addresses to leave out. */
13260
14444
  excludeEmails?: string[];
14445
+ /** @description First name tokens, using accent-folded fuzzy matching. Requires companyId. */
14446
+ firstName?: string;
14447
+ /** @description Last name tokens, using accent-folded fuzzy matching. Requires companyId. */
14448
+ lastName?: string;
13261
14449
  /** @description Limit contacts to this company. This uses the company-indexed contact path and does not require country or industry filters. */
13262
14450
  companyId?: string;
13263
14451
  /** @description Contact location filters. Requires companyId. */
@@ -13286,6 +14474,12 @@ interface components {
13286
14474
  kind: "companies";
13287
14475
  /** @description Company filters saved on this list or search. */
13288
14476
  filters: {
14477
+ /** @description Company name prefixes. Match any name. */
14478
+ companyNames?: string[];
14479
+ /** @description Company name prefixes to leave out. */
14480
+ excludeCompanyNames?: string[];
14481
+ /** @description Company website domain. Exact host matching; root sites rank first. */
14482
+ domain?: string;
13289
14483
  /** @description Two-letter country codes to include. */
13290
14484
  countryCodes?: string[];
13291
14485
  /** @description State or region codes to include. */
@@ -13362,8 +14556,6 @@ interface components {
13362
14556
  excludeOrganizationIds?: string[];
13363
14557
  /** @description Website domains to leave out. */
13364
14558
  excludeDomains?: string[];
13365
- /** @description Website domain. Matching is exact on the host, and a root site ranks first. */
13366
- domain?: string;
13367
14559
  /** @description Insights filters. Supply at least one. */
13368
14560
  insights?: {
13369
14561
  /** @description Monthly organic visits. */
@@ -13573,6 +14765,12 @@ interface components {
13573
14765
  kind: "people";
13574
14766
  /** @description People filters saved on this list or search. */
13575
14767
  filters: {
14768
+ /** @description Company name alternatives or a domain. Finds the 50 closest token or prefix matches, ignoring punctuation, accents and legal suffixes. */
14769
+ companyNames?: string[];
14770
+ /** @description Company name prefixes to leave out. */
14771
+ excludeCompanyNames?: string[];
14772
+ /** @description Company website domain. Exact host matching; root sites rank first. */
14773
+ domain?: string;
13576
14774
  /** @description Two-letter country codes to include. */
13577
14775
  countryCodes?: string[];
13578
14776
  /** @description State or region codes to include. */
@@ -13633,6 +14831,13 @@ interface components {
13633
14831
  excludeOrganizationIds?: string[];
13634
14832
  /** @description Website domains to leave out. */
13635
14833
  excludeDomains?: string[];
14834
+ /** @description Person name alternatives. Add a company name, domain or id for common names and typo matching. Every non-particle token matches in any order, ignoring case, accents and punctuation. Scoped searches allow one edit per token of at least five letters. */
14835
+ personNames?: string[];
14836
+ /**
14837
+ * Format: email
14838
+ * @description Exact work email address, matched through the email index.
14839
+ */
14840
+ email?: string;
13636
14841
  /** @description Person cities to include. Requires personCountryCodes. */
13637
14842
  personCities?: string[];
13638
14843
  /** @description Person cities to leave out. Requires personCountryCodes. */
@@ -13711,6 +14916,10 @@ interface components {
13711
14916
  excludePersonIds?: string[];
13712
14917
  /** @description Email addresses to leave out. */
13713
14918
  excludeEmails?: string[];
14919
+ /** @description First name tokens, using accent-folded fuzzy matching. Requires companyId. */
14920
+ firstName?: string;
14921
+ /** @description Last name tokens, using accent-folded fuzzy matching. Requires companyId. */
14922
+ lastName?: string;
13714
14923
  /** @description Limit contacts to this company. This uses the company-indexed contact path and does not require country or industry filters. */
13715
14924
  companyId?: string;
13716
14925
  /** @description Contact location filters. Requires companyId. */
@@ -13739,6 +14948,12 @@ interface components {
13739
14948
  kind: "companies";
13740
14949
  /** @description Company filters saved on this list or search. */
13741
14950
  filters: {
14951
+ /** @description Company name prefixes. Match any name. */
14952
+ companyNames?: string[];
14953
+ /** @description Company name prefixes to leave out. */
14954
+ excludeCompanyNames?: string[];
14955
+ /** @description Company website domain. Exact host matching; root sites rank first. */
14956
+ domain?: string;
13742
14957
  /** @description Two-letter country codes to include. */
13743
14958
  countryCodes?: string[];
13744
14959
  /** @description State or region codes to include. */
@@ -13815,8 +15030,6 @@ interface components {
13815
15030
  excludeOrganizationIds?: string[];
13816
15031
  /** @description Website domains to leave out. */
13817
15032
  excludeDomains?: string[];
13818
- /** @description Website domain. Matching is exact on the host, and a root site ranks first. */
13819
- domain?: string;
13820
15033
  /** @description Insights filters. Supply at least one. */
13821
15034
  insights?: {
13822
15035
  /** @description Monthly organic visits. */
@@ -14026,6 +15239,12 @@ interface components {
14026
15239
  kind: "people";
14027
15240
  /** @description People filters saved on this list or search. */
14028
15241
  filters: {
15242
+ /** @description Company name alternatives or a domain. Finds the 50 closest token or prefix matches, ignoring punctuation, accents and legal suffixes. */
15243
+ companyNames?: string[];
15244
+ /** @description Company name prefixes to leave out. */
15245
+ excludeCompanyNames?: string[];
15246
+ /** @description Company website domain. Exact host matching; root sites rank first. */
15247
+ domain?: string;
14029
15248
  /** @description Two-letter country codes to include. */
14030
15249
  countryCodes?: string[];
14031
15250
  /** @description State or region codes to include. */
@@ -14086,6 +15305,13 @@ interface components {
14086
15305
  excludeOrganizationIds?: string[];
14087
15306
  /** @description Website domains to leave out. */
14088
15307
  excludeDomains?: string[];
15308
+ /** @description Person name alternatives. Add a company name, domain or id for common names and typo matching. Every non-particle token matches in any order, ignoring case, accents and punctuation. Scoped searches allow one edit per token of at least five letters. */
15309
+ personNames?: string[];
15310
+ /**
15311
+ * Format: email
15312
+ * @description Exact work email address, matched through the email index.
15313
+ */
15314
+ email?: string;
14089
15315
  /** @description Person cities to include. Requires personCountryCodes. */
14090
15316
  personCities?: string[];
14091
15317
  /** @description Person cities to leave out. Requires personCountryCodes. */
@@ -14164,6 +15390,10 @@ interface components {
14164
15390
  excludePersonIds?: string[];
14165
15391
  /** @description Email addresses to leave out. */
14166
15392
  excludeEmails?: string[];
15393
+ /** @description First name tokens, using accent-folded fuzzy matching. Requires companyId. */
15394
+ firstName?: string;
15395
+ /** @description Last name tokens, using accent-folded fuzzy matching. Requires companyId. */
15396
+ lastName?: string;
14167
15397
  /** @description Limit contacts to this company. This uses the company-indexed contact path and does not require country or industry filters. */
14168
15398
  companyId?: string;
14169
15399
  /** @description Contact location filters. Requires companyId. */
@@ -16143,6 +17373,61 @@ interface operations {
16143
17373
  };
16144
17374
  };
16145
17375
  };
17376
+ "crm.list_enrichment_jobs": {
17377
+ parameters: {
17378
+ query?: {
17379
+ /** @description Set false for a dry run. A write returns what it would change. */
17380
+ execute?: boolean;
17381
+ };
17382
+ header?: {
17383
+ /** @description Space slug. A key limited to one space must name that space. */
17384
+ "x-higherdata-space"?: string;
17385
+ /** @description Retrying with the same key charges once. A settled read runs again with Idempotent-Replayed. A settled write returns the original request id. A key still in progress returns 409. */
17386
+ "Idempotency-Key"?: string;
17387
+ };
17388
+ path?: never;
17389
+ cookie?: never;
17390
+ };
17391
+ requestBody: {
17392
+ content: {
17393
+ "application/json": components["schemas"]["crm.list_enrichment_jobs.input"];
17394
+ };
17395
+ };
17396
+ responses: {
17397
+ /** @description Tool result. */
17398
+ 200: {
17399
+ headers: {
17400
+ /** @description Capacity of the tightest request bucket (10 seconds of rate). Zero before admission or on unmetered endpoints. */
17401
+ "RateLimit-Limit"?: number;
17402
+ /** @description Whole requests remaining after this admission. */
17403
+ "RateLimit-Remaining"?: number;
17404
+ /** @description Seconds until refill or the enforced cap resets. */
17405
+ "RateLimit-Reset"?: number;
17406
+ [name: string]: unknown;
17407
+ };
17408
+ content: {
17409
+ "application/json": components["schemas"]["crm.list_enrichment_jobs.output"];
17410
+ };
17411
+ };
17412
+ /** @description Tool or request error. RATE_LIMITED and LIMIT_EXCEEDED return 429 with Retry-After. Email verification allowances, customer caps and protective ceilings refuse the request. */
17413
+ default: {
17414
+ headers: {
17415
+ /** @description Capacity of the tightest request bucket (10 seconds of rate). Zero before admission or on unmetered endpoints. */
17416
+ "RateLimit-Limit"?: number;
17417
+ /** @description Whole requests remaining after this admission. */
17418
+ "RateLimit-Remaining"?: number;
17419
+ /** @description Seconds until refill or the enforced cap resets. */
17420
+ "RateLimit-Reset"?: number;
17421
+ /** @description Seconds before retrying. */
17422
+ "Retry-After"?: number;
17423
+ [name: string]: unknown;
17424
+ };
17425
+ content: {
17426
+ "application/json": components["schemas"]["Error"];
17427
+ };
17428
+ };
17429
+ };
17430
+ };
16146
17431
  "crm.push": {
16147
17432
  parameters: {
16148
17433
  query?: {
@@ -17903,6 +19188,61 @@ interface operations {
17903
19188
  };
17904
19189
  };
17905
19190
  };
19191
+ "lists.status": {
19192
+ parameters: {
19193
+ query?: {
19194
+ /** @description Set false for a dry run. A write returns what it would change. */
19195
+ execute?: boolean;
19196
+ };
19197
+ header?: {
19198
+ /** @description Space slug. A key limited to one space must name that space. */
19199
+ "x-higherdata-space"?: string;
19200
+ /** @description Retrying with the same key charges once. A settled read runs again with Idempotent-Replayed. A settled write returns the original request id. A key still in progress returns 409. */
19201
+ "Idempotency-Key"?: string;
19202
+ };
19203
+ path?: never;
19204
+ cookie?: never;
19205
+ };
19206
+ requestBody: {
19207
+ content: {
19208
+ "application/json": components["schemas"]["lists.status.input"];
19209
+ };
19210
+ };
19211
+ responses: {
19212
+ /** @description Tool result. */
19213
+ 200: {
19214
+ headers: {
19215
+ /** @description Capacity of the tightest request bucket (10 seconds of rate). Zero before admission or on unmetered endpoints. */
19216
+ "RateLimit-Limit"?: number;
19217
+ /** @description Whole requests remaining after this admission. */
19218
+ "RateLimit-Remaining"?: number;
19219
+ /** @description Seconds until refill or the enforced cap resets. */
19220
+ "RateLimit-Reset"?: number;
19221
+ [name: string]: unknown;
19222
+ };
19223
+ content: {
19224
+ "application/json": components["schemas"]["lists.status.output"];
19225
+ };
19226
+ };
19227
+ /** @description Tool or request error. RATE_LIMITED and LIMIT_EXCEEDED return 429 with Retry-After. Email verification allowances, customer caps and protective ceilings refuse the request. */
19228
+ default: {
19229
+ headers: {
19230
+ /** @description Capacity of the tightest request bucket (10 seconds of rate). Zero before admission or on unmetered endpoints. */
19231
+ "RateLimit-Limit"?: number;
19232
+ /** @description Whole requests remaining after this admission. */
19233
+ "RateLimit-Remaining"?: number;
19234
+ /** @description Seconds until refill or the enforced cap resets. */
19235
+ "RateLimit-Reset"?: number;
19236
+ /** @description Seconds before retrying. */
19237
+ "Retry-After"?: number;
19238
+ [name: string]: unknown;
19239
+ };
19240
+ content: {
19241
+ "application/json": components["schemas"]["Error"];
19242
+ };
19243
+ };
19244
+ };
19245
+ };
17906
19246
  "lookup.company": {
17907
19247
  parameters: {
17908
19248
  query?: {
@@ -18178,6 +19518,61 @@ interface operations {
18178
19518
  };
18179
19519
  };
18180
19520
  };
19521
+ "search.count_people": {
19522
+ parameters: {
19523
+ query?: {
19524
+ /** @description Set false for a dry run. A write returns what it would change. */
19525
+ execute?: boolean;
19526
+ };
19527
+ header?: {
19528
+ /** @description Space slug. A key limited to one space must name that space. */
19529
+ "x-higherdata-space"?: string;
19530
+ /** @description Retrying with the same key charges once. A settled read runs again with Idempotent-Replayed. A settled write returns the original request id. A key still in progress returns 409. */
19531
+ "Idempotency-Key"?: string;
19532
+ };
19533
+ path?: never;
19534
+ cookie?: never;
19535
+ };
19536
+ requestBody: {
19537
+ content: {
19538
+ "application/json": components["schemas"]["search.count_people.input"];
19539
+ };
19540
+ };
19541
+ responses: {
19542
+ /** @description Tool result. */
19543
+ 200: {
19544
+ headers: {
19545
+ /** @description Capacity of the tightest request bucket (10 seconds of rate). Zero before admission or on unmetered endpoints. */
19546
+ "RateLimit-Limit"?: number;
19547
+ /** @description Whole requests remaining after this admission. */
19548
+ "RateLimit-Remaining"?: number;
19549
+ /** @description Seconds until refill or the enforced cap resets. */
19550
+ "RateLimit-Reset"?: number;
19551
+ [name: string]: unknown;
19552
+ };
19553
+ content: {
19554
+ "application/json": components["schemas"]["search.count_people.output"];
19555
+ };
19556
+ };
19557
+ /** @description Tool or request error. RATE_LIMITED and LIMIT_EXCEEDED return 429 with Retry-After. Email verification allowances, customer caps and protective ceilings refuse the request. */
19558
+ default: {
19559
+ headers: {
19560
+ /** @description Capacity of the tightest request bucket (10 seconds of rate). Zero before admission or on unmetered endpoints. */
19561
+ "RateLimit-Limit"?: number;
19562
+ /** @description Whole requests remaining after this admission. */
19563
+ "RateLimit-Remaining"?: number;
19564
+ /** @description Seconds until refill or the enforced cap resets. */
19565
+ "RateLimit-Reset"?: number;
19566
+ /** @description Seconds before retrying. */
19567
+ "Retry-After"?: number;
19568
+ [name: string]: unknown;
19569
+ };
19570
+ content: {
19571
+ "application/json": components["schemas"]["Error"];
19572
+ };
19573
+ };
19574
+ };
19575
+ };
18181
19576
  "search.facets": {
18182
19577
  parameters: {
18183
19578
  query?: {
@@ -18343,6 +19738,61 @@ interface operations {
18343
19738
  };
18344
19739
  };
18345
19740
  };
19741
+ "search.preview_company_count": {
19742
+ parameters: {
19743
+ query?: {
19744
+ /** @description Set false for a dry run. A write returns what it would change. */
19745
+ execute?: boolean;
19746
+ };
19747
+ header?: {
19748
+ /** @description Space slug. A key limited to one space must name that space. */
19749
+ "x-higherdata-space"?: string;
19750
+ /** @description Retrying with the same key charges once. A settled read runs again with Idempotent-Replayed. A settled write returns the original request id. A key still in progress returns 409. */
19751
+ "Idempotency-Key"?: string;
19752
+ };
19753
+ path?: never;
19754
+ cookie?: never;
19755
+ };
19756
+ requestBody: {
19757
+ content: {
19758
+ "application/json": components["schemas"]["search.preview_company_count.input"];
19759
+ };
19760
+ };
19761
+ responses: {
19762
+ /** @description Tool result. */
19763
+ 200: {
19764
+ headers: {
19765
+ /** @description Capacity of the tightest request bucket (10 seconds of rate). Zero before admission or on unmetered endpoints. */
19766
+ "RateLimit-Limit"?: number;
19767
+ /** @description Whole requests remaining after this admission. */
19768
+ "RateLimit-Remaining"?: number;
19769
+ /** @description Seconds until refill or the enforced cap resets. */
19770
+ "RateLimit-Reset"?: number;
19771
+ [name: string]: unknown;
19772
+ };
19773
+ content: {
19774
+ "application/json": components["schemas"]["search.preview_company_count.output"];
19775
+ };
19776
+ };
19777
+ /** @description Tool or request error. RATE_LIMITED and LIMIT_EXCEEDED return 429 with Retry-After. Email verification allowances, customer caps and protective ceilings refuse the request. */
19778
+ default: {
19779
+ headers: {
19780
+ /** @description Capacity of the tightest request bucket (10 seconds of rate). Zero before admission or on unmetered endpoints. */
19781
+ "RateLimit-Limit"?: number;
19782
+ /** @description Whole requests remaining after this admission. */
19783
+ "RateLimit-Remaining"?: number;
19784
+ /** @description Seconds until refill or the enforced cap resets. */
19785
+ "RateLimit-Reset"?: number;
19786
+ /** @description Seconds before retrying. */
19787
+ "Retry-After"?: number;
19788
+ [name: string]: unknown;
19789
+ };
19790
+ content: {
19791
+ "application/json": components["schemas"]["Error"];
19792
+ };
19793
+ };
19794
+ };
19795
+ };
18346
19796
  "searches.list": {
18347
19797
  parameters: {
18348
19798
  query?: {
@@ -18839,7 +20289,7 @@ interface operations {
18839
20289
  };
18840
20290
  };
18841
20291
  }
18842
- declare const TOOL_NAMES: readonly ["account.create_invite", "account.create_key", "account.get_members", "account.get_start", "account.limits", "account.list_keys", "account.refresh_invite", "account.remove_member", "account.revoke_invite", "account.revoke_key", "account.update_member", "account.update_start", "account.usage", "account.whoami", "agent.get", "agent.run", "changes.apply", "changes.approve", "changes.get", "changes.list", "changes.reject", "changes.restore", "crm.configure", "crm.configure_sync", "crm.enrich", "crm.enrich_job", "crm.get", "crm.get_enrichment_job", "crm.get_enrichment_options", "crm.get_setup", "crm.get_sync_setup", "crm.push", "crm.search", "crm.status", "email.find", "email.verify", "enrich.bulk", "enrich.company", "enrich.map_columns", "enrich.person", "hygiene.auto_merge_configure", "hygiene.configure", "hygiene.dismiss", "hygiene.duplicates", "hygiene.gaps", "hygiene.merge", "hygiene.orphans", "hygiene.repair", "icp.create", "icp.get", "icp.preview", "icp.propose", "icp.run", "jobs.cancel", "jobs.download", "jobs.get", "jobs.list", "lists.add", "lists.create", "lists.export", "lists.get", "lists.refresh", "lists.run", "lookup.company", "lookup.find", "lookup.person", "search.companies", "search.count", "search.facets", "search.filters_from_text", "search.people", "searches.list", "searches.save", "suppress.add", "suppress.check", "suppress.create_list", "suppress.export", "suppress.import", "suppress.lists", "suppress.remove"];
20292
+ declare const TOOL_NAMES: readonly ["account.create_invite", "account.create_key", "account.get_members", "account.get_start", "account.limits", "account.list_keys", "account.refresh_invite", "account.remove_member", "account.revoke_invite", "account.revoke_key", "account.update_member", "account.update_start", "account.usage", "account.whoami", "agent.get", "agent.run", "changes.apply", "changes.approve", "changes.get", "changes.list", "changes.reject", "changes.restore", "crm.configure", "crm.configure_sync", "crm.enrich", "crm.enrich_job", "crm.get", "crm.get_enrichment_job", "crm.get_enrichment_options", "crm.get_setup", "crm.get_sync_setup", "crm.list_enrichment_jobs", "crm.push", "crm.search", "crm.status", "email.find", "email.verify", "enrich.bulk", "enrich.company", "enrich.map_columns", "enrich.person", "hygiene.auto_merge_configure", "hygiene.configure", "hygiene.dismiss", "hygiene.duplicates", "hygiene.gaps", "hygiene.merge", "hygiene.orphans", "hygiene.repair", "icp.create", "icp.get", "icp.preview", "icp.propose", "icp.run", "jobs.cancel", "jobs.download", "jobs.get", "jobs.list", "lists.add", "lists.create", "lists.export", "lists.get", "lists.refresh", "lists.run", "lists.status", "lookup.company", "lookup.find", "lookup.person", "search.companies", "search.count", "search.count_people", "search.facets", "search.filters_from_text", "search.people", "search.preview_company_count", "searches.list", "searches.save", "suppress.add", "suppress.check", "suppress.create_list", "suppress.export", "suppress.import", "suppress.lists", "suppress.remove"];
18843
20293
  type ToolName = typeof TOOL_NAMES[number];
18844
20294
  type ToolInput<N extends ToolName> = operations[N]["requestBody"]["content"]["application/json"];
18845
20295
  type ToolOutput<N extends ToolName> = operations[N]["responses"][200]["content"]["application/json"];
@@ -18856,7 +20306,8 @@ declare class HigherDataError extends Error {
18856
20306
  readonly code: string;
18857
20307
  readonly status: number;
18858
20308
  readonly retryAfter?: number | undefined;
18859
- constructor(message: string, code: string, status?: number, retryAfter?: number | undefined);
20309
+ readonly requestId?: string | undefined;
20310
+ constructor(message: string, code: string, status?: number, retryAfter?: number | undefined, requestId?: string | undefined);
18860
20311
  }
18861
20312
  type ClientOptions = {
18862
20313
  apiKey?: string;