higherdata-sdk 0.5.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 +683 -38
  2. package/dist/index.js +2333 -526
  3. package/package.json +1 -1
package/dist/index.d.ts CHANGED
@@ -783,7 +783,7 @@ interface components {
783
783
  excludeOrganizationIds?: string[];
784
784
  /** @description Website domains to leave out. */
785
785
  excludeDomains?: string[];
786
- /** @description Person name alternatives. Requires a company name, domain or id. Matches first or last name for one token, or first and last name for two tokens, ignoring case and accents. */
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
787
  personNames?: string[];
788
788
  /**
789
789
  * Format: email
@@ -1285,7 +1285,7 @@ interface components {
1285
1285
  excludeOrganizationIds?: string[];
1286
1286
  /** @description Website domains to leave out. */
1287
1287
  excludeDomains?: string[];
1288
- /** @description Person name alternatives. Requires a company name, domain or id. Matches first or last name for one token, or first and last name for two tokens, ignoring case and accents. */
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
1289
  personNames?: string[];
1290
1290
  /**
1291
1291
  * Format: email
@@ -1826,7 +1826,7 @@ interface components {
1826
1826
  excludeOrganizationIds?: string[];
1827
1827
  /** @description Website domains to leave out. */
1828
1828
  excludeDomains?: string[];
1829
- /** @description Person name alternatives. Requires a company name, domain or id. Matches first or last name for one token, or first and last name for two tokens, ignoring case and accents. */
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
1830
  personNames?: string[];
1831
1831
  /**
1832
1832
  * Format: email
@@ -2328,7 +2328,7 @@ interface components {
2328
2328
  excludeOrganizationIds?: string[];
2329
2329
  /** @description Website domains to leave out. */
2330
2330
  excludeDomains?: string[];
2331
- /** @description Person name alternatives. Requires a company name, domain or id. Matches first or last name for one token, or first and last name for two tokens, ignoring case and accents. */
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
2332
  personNames?: string[];
2333
2333
  /**
2334
2334
  * Format: email
@@ -3772,6 +3772,7 @@ interface components {
3772
3772
  phase: "preview" | "create";
3773
3773
  /** @enum {string} */
3774
3774
  status: "queued" | "running" | "ready" | "completed" | "failed";
3775
+ checkingRecords?: number;
3775
3776
  counts: {
3776
3777
  scanned: number;
3777
3778
  changed: number;
@@ -3905,6 +3906,7 @@ interface components {
3905
3906
  phase: "preview" | "create";
3906
3907
  /** @enum {string} */
3907
3908
  status: "queued" | "running" | "ready" | "completed" | "failed";
3909
+ checkingRecords?: number;
3908
3910
  counts: {
3909
3911
  scanned: number;
3910
3912
  changed: number;
@@ -4184,6 +4186,7 @@ interface components {
4184
4186
  phase: "preview" | "create";
4185
4187
  /** @enum {string} */
4186
4188
  status: "queued" | "running" | "ready" | "completed" | "failed";
4189
+ checkingRecords?: number;
4187
4190
  counts: {
4188
4191
  scanned: number;
4189
4192
  changed: number;
@@ -5558,6 +5561,15 @@ interface components {
5558
5561
  }[];
5559
5562
  restoreWarning: string;
5560
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
+ }[];
5561
5573
  comparison?: {
5562
5574
  /** @enum {string} */
5563
5575
  objectType: "companies" | "contacts";
@@ -6120,7 +6132,7 @@ interface components {
6120
6132
  excludeOrganizationIds?: string[];
6121
6133
  /** @description Website domains to leave out. */
6122
6134
  excludeDomains?: string[];
6123
- /** @description Person name alternatives. Requires a company name, domain or id. Matches first or last name for one token, or first and last name for two tokens, ignoring case and accents. */
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. */
6124
6136
  personNames?: string[];
6125
6137
  /**
6126
6138
  * Format: email
@@ -6602,7 +6614,7 @@ interface components {
6602
6614
  excludeOrganizationIds?: string[];
6603
6615
  /** @description Website domains to leave out. */
6604
6616
  excludeDomains?: string[];
6605
- /** @description Person name alternatives. Requires a company name, domain or id. Matches first or last name for one token, or first and last name for two tokens, ignoring case and accents. */
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. */
6606
6618
  personNames?: string[];
6607
6619
  /**
6608
6620
  * Format: email
@@ -7094,7 +7106,7 @@ interface components {
7094
7106
  excludeOrganizationIds?: string[];
7095
7107
  /** @description Website domains to leave out. */
7096
7108
  excludeDomains?: string[];
7097
- /** @description Person name alternatives. Requires a company name, domain or id. Matches first or last name for one token, or first and last name for two tokens, ignoring case and accents. */
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. */
7098
7110
  personNames?: string[];
7099
7111
  /**
7100
7112
  * Format: email
@@ -7572,7 +7584,7 @@ interface components {
7572
7584
  excludeOrganizationIds?: string[];
7573
7585
  /** @description Website domains to leave out. */
7574
7586
  excludeDomains?: string[];
7575
- /** @description Person name alternatives. Requires a company name, domain or id. Matches first or last name for one token, or first and last name for two tokens, ignoring case and accents. */
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. */
7576
7588
  personNames?: string[];
7577
7589
  /**
7578
7590
  * Format: email
@@ -7657,6 +7669,10 @@ interface components {
7657
7669
  excludePersonIds?: string[];
7658
7670
  /** @description Email addresses to leave out. */
7659
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;
7660
7676
  /** @description Limit contacts to this company. This uses the company-indexed contact path and does not require country or industry filters. */
7661
7677
  companyId?: string;
7662
7678
  /** @description Contact location filters. Requires companyId. */
@@ -8106,7 +8122,7 @@ interface components {
8106
8122
  excludeOrganizationIds?: string[];
8107
8123
  /** @description Website domains to leave out. */
8108
8124
  excludeDomains?: string[];
8109
- /** @description Person name alternatives. Requires a company name, domain or id. Matches first or last name for one token, or first and last name for two tokens, ignoring case and accents. */
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. */
8110
8126
  personNames?: string[];
8111
8127
  /**
8112
8128
  * Format: email
@@ -8575,7 +8591,7 @@ interface components {
8575
8591
  excludeOrganizationIds?: string[];
8576
8592
  /** @description Website domains to leave out. */
8577
8593
  excludeDomains?: string[];
8578
- /** @description Person name alternatives. Requires a company name, domain or id. Matches first or last name for one token, or first and last name for two tokens, ignoring case and accents. */
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. */
8579
8595
  personNames?: string[];
8580
8596
  /**
8581
8597
  * Format: email
@@ -8660,6 +8676,10 @@ interface components {
8660
8676
  excludePersonIds?: string[];
8661
8677
  /** @description Email addresses to leave out. */
8662
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;
8663
8683
  /** @description Limit contacts to this company. This uses the company-indexed contact path and does not require country or industry filters. */
8664
8684
  companyId?: string;
8665
8685
  /** @description Contact location filters. Requires companyId. */
@@ -9235,7 +9255,7 @@ interface components {
9235
9255
  excludeOrganizationIds?: string[];
9236
9256
  /** @description Website domains to leave out. */
9237
9257
  excludeDomains?: string[];
9238
- /** @description Person name alternatives. Requires a company name, domain or id. Matches first or last name for one token, or first and last name for two tokens, ignoring case and accents. */
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. */
9239
9259
  personNames?: string[];
9240
9260
  /**
9241
9261
  * Format: email
@@ -9320,6 +9340,10 @@ interface components {
9320
9340
  excludePersonIds?: string[];
9321
9341
  /** @description Email addresses to leave out. */
9322
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;
9323
9347
  /** @description Limit contacts to this company. This uses the company-indexed contact path and does not require country or industry filters. */
9324
9348
  companyId?: string;
9325
9349
  /** @description Contact location filters. Requires companyId. */
@@ -9733,7 +9757,7 @@ interface components {
9733
9757
  excludeOrganizationIds?: string[];
9734
9758
  /** @description Website domains to leave out. */
9735
9759
  excludeDomains?: string[];
9736
- /** @description Person name alternatives. Requires a company name, domain or id. Matches first or last name for one token, or first and last name for two tokens, ignoring case and accents. */
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. */
9737
9761
  personNames?: string[];
9738
9762
  /**
9739
9763
  * Format: email
@@ -9818,6 +9842,10 @@ interface components {
9818
9842
  excludePersonIds?: string[];
9819
9843
  /** @description Email addresses to leave out. */
9820
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;
9821
9849
  /** @description Limit contacts to this company. This uses the company-indexed contact path and does not require country or industry filters. */
9822
9850
  companyId?: string;
9823
9851
  /** @description Contact location filters. Requires companyId. */
@@ -10235,7 +10263,7 @@ interface components {
10235
10263
  excludeOrganizationIds?: string[];
10236
10264
  /** @description Website domains to leave out. */
10237
10265
  excludeDomains?: string[];
10238
- /** @description Person name alternatives. Requires a company name, domain or id. Matches first or last name for one token, or first and last name for two tokens, ignoring case and accents. */
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. */
10239
10267
  personNames?: string[];
10240
10268
  /**
10241
10269
  * Format: email
@@ -10320,6 +10348,10 @@ interface components {
10320
10348
  excludePersonIds?: string[];
10321
10349
  /** @description Email addresses to leave out. */
10322
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;
10323
10355
  /** @description Limit contacts to this company. This uses the company-indexed contact path and does not require country or industry filters. */
10324
10356
  companyId?: string;
10325
10357
  /** @description Contact location filters. Requires companyId. */
@@ -10785,7 +10817,7 @@ interface components {
10785
10817
  excludeOrganizationIds?: string[];
10786
10818
  /** @description Website domains to leave out. */
10787
10819
  excludeDomains?: string[];
10788
- /** @description Person name alternatives. Requires a company name, domain or id. Matches first or last name for one token, or first and last name for two tokens, ignoring case and accents. */
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. */
10789
10821
  personNames?: string[];
10790
10822
  /**
10791
10823
  * Format: email
@@ -10870,6 +10902,10 @@ interface components {
10870
10902
  excludePersonIds?: string[];
10871
10903
  /** @description Email addresses to leave out. */
10872
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;
10873
10909
  /** @description Limit contacts to this company. This uses the company-indexed contact path and does not require country or industry filters. */
10874
10910
  companyId?: string;
10875
10911
  /** @description Contact location filters. Requires companyId. */
@@ -12410,6 +12446,191 @@ interface components {
12410
12446
  isIcpBaseline?: boolean;
12411
12447
  zeroResults: boolean;
12412
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
+ };
12413
12634
  "search.facets.input": {
12414
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. */
12415
12636
  cities?: {
@@ -12653,7 +12874,7 @@ interface components {
12653
12874
  excludeOrganizationIds?: string[];
12654
12875
  /** @description Website domains to leave out. */
12655
12876
  excludeDomains?: string[];
12656
- /** @description Person name alternatives. Requires a company name, domain or id. Matches first or last name for one token, or first and last name for two tokens, ignoring case and accents. */
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. */
12657
12878
  personNames?: string[];
12658
12879
  /**
12659
12880
  * Format: email
@@ -12738,6 +12959,10 @@ interface components {
12738
12959
  excludePersonIds?: string[];
12739
12960
  /** @description Email addresses to leave out. */
12740
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;
12741
12966
  /** @description Limit contacts to this company. This uses the company-indexed contact path and does not require country or industry filters. */
12742
12967
  companyId?: string;
12743
12968
  /** @description Contact location filters. Requires companyId. */
@@ -12819,7 +13044,7 @@ interface components {
12819
13044
  excludeOrganizationIds?: string[];
12820
13045
  /** @description Website domains to leave out. */
12821
13046
  excludeDomains?: string[];
12822
- /** @description Person name alternatives. Requires a company name, domain or id. Matches first or last name for one token, or first and last name for two tokens, ignoring case and accents. */
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. */
12823
13048
  personNames?: string[];
12824
13049
  /**
12825
13050
  * Format: email
@@ -12911,6 +13136,10 @@ interface components {
12911
13136
  limit?: number;
12912
13137
  /** @description Cursor from the previous page. Omit it for the first page. */
12913
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;
12914
13143
  /** @description Limit contacts to this company. This uses the company-indexed contact path and does not require country or industry filters. */
12915
13144
  companyId?: string;
12916
13145
  /** @description Contact location filters. Requires companyId. */
@@ -12977,27 +13206,317 @@ interface components {
12977
13206
  suppressionSources?: string[];
12978
13207
  zeroResults: boolean;
12979
13208
  };
12980
- "searches.list.input": {
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[];
12981
13268
  /**
12982
- * Format: uuid
12983
- * @description Saved search id to reopen.
13269
+ * @description Whether the company has a website.
13270
+ * @enum {string}
12984
13271
  */
12985
- id?: string;
13272
+ websiteAvailability?: "any" | "available" | "missing";
12986
13273
  /**
12987
- * @description Maximum records in this page.
12988
- * @default 50
13274
+ * @description Whether the company has a LinkedIn page.
13275
+ * @enum {string}
12989
13276
  */
12990
- limit?: number;
12991
- /** @description Cursor from the previous page. Omit it for the first page. */
12992
- cursor?: string;
12993
- };
12994
- "searches.list.output": {
12995
- searches: {
12996
- /** Format: uuid */
12997
- id: string;
12998
- name: string;
12999
- criteria: {
13000
- /**
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
+ };
13499
+ "searches.list.input": {
13500
+ /**
13501
+ * Format: uuid
13502
+ * @description Saved search id to reopen.
13503
+ */
13504
+ id?: string;
13505
+ /**
13506
+ * @description Maximum records in this page.
13507
+ * @default 50
13508
+ */
13509
+ limit?: number;
13510
+ /** @description Cursor from the previous page. Omit it for the first page. */
13511
+ cursor?: string;
13512
+ };
13513
+ "searches.list.output": {
13514
+ searches: {
13515
+ /** Format: uuid */
13516
+ id: string;
13517
+ name: string;
13518
+ criteria: {
13519
+ /**
13001
13520
  * @description These filters match companies.
13002
13521
  * @constant
13003
13522
  */
@@ -13361,7 +13880,7 @@ interface components {
13361
13880
  excludeOrganizationIds?: string[];
13362
13881
  /** @description Website domains to leave out. */
13363
13882
  excludeDomains?: string[];
13364
- /** @description Person name alternatives. Requires a company name, domain or id. Matches first or last name for one token, or first and last name for two tokens, ignoring case and accents. */
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. */
13365
13884
  personNames?: string[];
13366
13885
  /**
13367
13886
  * Format: email
@@ -13446,6 +13965,10 @@ interface components {
13446
13965
  excludePersonIds?: string[];
13447
13966
  /** @description Email addresses to leave out. */
13448
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;
13449
13972
  /** @description Limit contacts to this company. This uses the company-indexed contact path and does not require country or industry filters. */
13450
13973
  companyId?: string;
13451
13974
  /** @description Contact location filters. Requires companyId. */
@@ -13834,7 +14357,7 @@ interface components {
13834
14357
  excludeOrganizationIds?: string[];
13835
14358
  /** @description Website domains to leave out. */
13836
14359
  excludeDomains?: string[];
13837
- /** @description Person name alternatives. Requires a company name, domain or id. Matches first or last name for one token, or first and last name for two tokens, ignoring case and accents. */
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. */
13838
14361
  personNames?: string[];
13839
14362
  /**
13840
14363
  * Format: email
@@ -13919,6 +14442,10 @@ interface components {
13919
14442
  excludePersonIds?: string[];
13920
14443
  /** @description Email addresses to leave out. */
13921
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;
13922
14449
  /** @description Limit contacts to this company. This uses the company-indexed contact path and does not require country or industry filters. */
13923
14450
  companyId?: string;
13924
14451
  /** @description Contact location filters. Requires companyId. */
@@ -14304,7 +14831,7 @@ interface components {
14304
14831
  excludeOrganizationIds?: string[];
14305
14832
  /** @description Website domains to leave out. */
14306
14833
  excludeDomains?: string[];
14307
- /** @description Person name alternatives. Requires a company name, domain or id. Matches first or last name for one token, or first and last name for two tokens, ignoring case and accents. */
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. */
14308
14835
  personNames?: string[];
14309
14836
  /**
14310
14837
  * Format: email
@@ -14389,6 +14916,10 @@ interface components {
14389
14916
  excludePersonIds?: string[];
14390
14917
  /** @description Email addresses to leave out. */
14391
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;
14392
14923
  /** @description Limit contacts to this company. This uses the company-indexed contact path and does not require country or industry filters. */
14393
14924
  companyId?: string;
14394
14925
  /** @description Contact location filters. Requires companyId. */
@@ -14774,7 +15305,7 @@ interface components {
14774
15305
  excludeOrganizationIds?: string[];
14775
15306
  /** @description Website domains to leave out. */
14776
15307
  excludeDomains?: string[];
14777
- /** @description Person name alternatives. Requires a company name, domain or id. Matches first or last name for one token, or first and last name for two tokens, ignoring case and accents. */
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. */
14778
15309
  personNames?: string[];
14779
15310
  /**
14780
15311
  * Format: email
@@ -14859,6 +15390,10 @@ interface components {
14859
15390
  excludePersonIds?: string[];
14860
15391
  /** @description Email addresses to leave out. */
14861
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;
14862
15397
  /** @description Limit contacts to this company. This uses the company-indexed contact path and does not require country or industry filters. */
14863
15398
  companyId?: string;
14864
15399
  /** @description Contact location filters. Requires companyId. */
@@ -18983,6 +19518,61 @@ interface operations {
18983
19518
  };
18984
19519
  };
18985
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
+ };
18986
19576
  "search.facets": {
18987
19577
  parameters: {
18988
19578
  query?: {
@@ -19148,6 +19738,61 @@ interface operations {
19148
19738
  };
19149
19739
  };
19150
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
+ };
19151
19796
  "searches.list": {
19152
19797
  parameters: {
19153
19798
  query?: {
@@ -19644,7 +20289,7 @@ interface operations {
19644
20289
  };
19645
20290
  };
19646
20291
  }
19647
- 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.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"];
19648
20293
  type ToolName = typeof TOOL_NAMES[number];
19649
20294
  type ToolInput<N extends ToolName> = operations[N]["requestBody"]["content"]["application/json"];
19650
20295
  type ToolOutput<N extends ToolName> = operations[N]["responses"][200]["content"]["application/json"];