@graph8/sdk 0.264.0 → 0.277.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 (165) hide show
  1. package/README.md +3 -3
  2. package/dist/index.d.mts +140 -24
  3. package/dist/index.d.ts +140 -24
  4. package/dist/index.js +14 -5
  5. package/dist/index.js.map +1 -1
  6. package/dist/index.mjs +14 -5
  7. package/dist/index.mjs.map +1 -1
  8. package/dist/react.d.mts +139 -22
  9. package/dist/react.d.ts +139 -22
  10. package/dist/react.js +13 -4
  11. package/dist/react.js.map +1 -1
  12. package/dist/react.mjs +13 -4
  13. package/dist/react.mjs.map +1 -1
  14. package/dist/types/core.d.ts +3 -1
  15. package/dist/types/enrich.d.ts +11 -4
  16. package/dist/types/index.d.ts +1 -1
  17. package/dist/types/react.d.ts +7 -3
  18. package/dist/types/search.d.ts +25 -1
  19. package/dist/types/version.d.ts +2 -2
  20. package/dist/types/webhooks.d.ts +2 -2
  21. package/docs/agents.md +7 -6
  22. package/docs/api/README.md +2 -2
  23. package/docs/api/accounts.d.ts +6 -0
  24. package/docs/api/adCampaigns.d.ts +6 -0
  25. package/docs/api/adCreatives.d.ts +6 -0
  26. package/docs/api/agency.d.ts +6 -0
  27. package/docs/api/agent.d.ts +6 -0
  28. package/docs/api/agents.d.ts +6 -0
  29. package/docs/api/aiInbox.d.ts +6 -0
  30. package/docs/api/analytics.d.ts +6 -0
  31. package/docs/api/apiKeys.d.ts +6 -0
  32. package/docs/api/appDeployments.d.ts +6 -0
  33. package/docs/api/appDomains.d.ts +6 -0
  34. package/docs/api/appLogs.d.ts +6 -0
  35. package/docs/api/appObjects.d.ts +6 -0
  36. package/docs/api/appPages.d.ts +6 -0
  37. package/docs/api/appPlatformTokens.d.ts +6 -0
  38. package/docs/api/appointments.d.ts +20 -2
  39. package/docs/api/appointments.md +27 -11
  40. package/docs/api/apps.d.ts +6 -0
  41. package/docs/api/apps.md +7 -5
  42. package/docs/api/assertUpsert.d.ts +12 -0
  43. package/docs/api/assertUpsert.md +4 -0
  44. package/docs/api/audienceSyncs.d.ts +6 -0
  45. package/docs/api/brandKit.d.ts +6 -0
  46. package/docs/api/bugReports.d.ts +6 -0
  47. package/docs/api/by-path.md +1 -0
  48. package/docs/api/calendarInvites.d.ts +6 -0
  49. package/docs/api/campaignWorkflows.d.ts +6 -0
  50. package/docs/api/campaigns.d.ts +6 -0
  51. package/docs/api/channels.d.ts +6 -0
  52. package/docs/api/cliCampaigns.d.ts +6 -0
  53. package/docs/api/cliPipelines.d.ts +6 -0
  54. package/docs/api/clickHouse.d.ts +6 -0
  55. package/docs/api/companies.d.ts +10 -2
  56. package/docs/api/companies.md +9 -2
  57. package/docs/api/companyIntelligence.d.ts +6 -0
  58. package/docs/api/contacts.d.ts +19 -4
  59. package/docs/api/contacts.md +13 -5
  60. package/docs/api/content.d.ts +6 -0
  61. package/docs/api/contentGridSkills.d.ts +6 -0
  62. package/docs/api/copilot.d.ts +6 -0
  63. package/docs/api/crmSyncs.d.ts +6 -0
  64. package/docs/api/customerSuccess.d.ts +6 -0
  65. package/docs/api/deals.d.ts +6 -0
  66. package/docs/api/deliverability.d.ts +6 -0
  67. package/docs/api/desk.d.ts +6 -0
  68. package/docs/api/dialer.d.ts +6 -0
  69. package/docs/api/documents.d.ts +6 -0
  70. package/docs/api/duplicates.d.ts +6 -0
  71. package/docs/api/eSignature.d.ts +6 -0
  72. package/docs/api/enrichment.d.ts +6 -0
  73. package/docs/api/events.d.ts +6 -0
  74. package/docs/api/fields.d.ts +6 -0
  75. package/docs/api/forms.d.ts +6 -0
  76. package/docs/api/gtmCampaigns.d.ts +6 -0
  77. package/docs/api/gtmContext.d.ts +6 -0
  78. package/docs/api/gtmDeliverability.d.ts +6 -0
  79. package/docs/api/gtmKnowledgeBase.d.ts +6 -0
  80. package/docs/api/gtmLibrary.d.ts +6 -0
  81. package/docs/api/imageLibrary.d.ts +6 -0
  82. package/docs/api/imports.d.ts +6 -0
  83. package/docs/api/inbox.d.ts +6 -0
  84. package/docs/api/install.d.ts +6 -0
  85. package/docs/api/installedApps.d.ts +6 -0
  86. package/docs/api/integrationStatus.d.ts +6 -0
  87. package/docs/api/integrations.d.ts +6 -0
  88. package/docs/api/intent.d.ts +6 -0
  89. package/docs/api/knowledge.d.ts +6 -0
  90. package/docs/api/knowledgeBase.d.ts +6 -0
  91. package/docs/api/landingPages.d.ts +6 -0
  92. package/docs/api/leads.d.ts +6 -0
  93. package/docs/api/library.d.ts +6 -0
  94. package/docs/api/linkedIn.d.ts +6 -0
  95. package/docs/api/linkedInOutreach.d.ts +6 -0
  96. package/docs/api/lists.d.ts +13 -0
  97. package/docs/api/lists.md +7 -0
  98. package/docs/api/logs.d.ts +6 -0
  99. package/docs/api/mailboxes.d.ts +6 -0
  100. package/docs/api/marketplace.d.ts +6 -0
  101. package/docs/api/mcp.d.ts +6 -0
  102. package/docs/api/me.d.ts +6 -0
  103. package/docs/api/meetings.d.ts +6 -0
  104. package/docs/api/newsletter.d.ts +6 -0
  105. package/docs/api/notes.d.ts +6 -0
  106. package/docs/api/notifications.d.ts +6 -0
  107. package/docs/api/objects.d.ts +6 -0
  108. package/docs/api/openSearch.d.ts +6 -0
  109. package/docs/api/ops.d.ts +6 -0
  110. package/docs/api/orgGovernance.d.ts +6 -0
  111. package/docs/api/orgVideos.d.ts +6 -0
  112. package/docs/api/organizationSettings.d.ts +6 -0
  113. package/docs/api/phoneNumbers.d.ts +6 -0
  114. package/docs/api/profile.d.ts +6 -0
  115. package/docs/api/programmaticPages.d.ts +6 -0
  116. package/docs/api/providerDomains.d.ts +6 -0
  117. package/docs/api/providerUsage.d.ts +6 -0
  118. package/docs/api/public.d.ts +6 -0
  119. package/docs/api/publicCopilot.d.ts +6 -0
  120. package/docs/api/publicSignals.d.ts +6 -0
  121. package/docs/api/publicVisitors.d.ts +6 -0
  122. package/docs/api/quotes.d.ts +6 -0
  123. package/docs/api/radarReports.d.ts +6 -0
  124. package/docs/api/recordRoles.d.ts +6 -0
  125. package/docs/api/repos.d.ts +6 -0
  126. package/docs/api/research.d.ts +6 -0
  127. package/docs/api/revenue.d.ts +6 -0
  128. package/docs/api/revenueAnalytics.d.ts +6 -0
  129. package/docs/api/revenueLifecycle.d.ts +11 -1
  130. package/docs/api/revenueLifecycle.md +11 -2
  131. package/docs/api/revenueRecords.d.ts +6 -0
  132. package/docs/api/roles.d.ts +49 -2
  133. package/docs/api/roles.md +65 -1
  134. package/docs/api/salesCoach.d.ts +6 -0
  135. package/docs/api/scans.d.ts +6 -0
  136. package/docs/api/scheduleBuy.d.ts +6 -0
  137. package/docs/api/scraping.d.ts +6 -0
  138. package/docs/api/search.d.ts +9 -1
  139. package/docs/api/search.md +3 -2
  140. package/docs/api/seo.d.ts +6 -0
  141. package/docs/api/sequenceLifecycle.d.ts +6 -0
  142. package/docs/api/sequences.d.ts +6 -0
  143. package/docs/api/settings.d.ts +6 -0
  144. package/docs/api/signals.d.ts +6 -0
  145. package/docs/api/signatures.d.ts +6 -0
  146. package/docs/api/snippet.d.ts +6 -0
  147. package/docs/api/socialPublishing.d.ts +6 -0
  148. package/docs/api/studioDocuments.d.ts +6 -0
  149. package/docs/api/support.d.ts +6 -0
  150. package/docs/api/suppressions.d.ts +6 -0
  151. package/docs/api/surveys.d.ts +6 -0
  152. package/docs/api/tasks.d.ts +6 -0
  153. package/docs/api/teamMembers.d.ts +6 -0
  154. package/docs/api/teams.d.ts +6 -0
  155. package/docs/api/usage.d.ts +6 -0
  156. package/docs/api/visitors.d.ts +6 -0
  157. package/docs/api/voice.d.ts +6 -0
  158. package/docs/api/webChat.d.ts +6 -0
  159. package/docs/api/webhooks.d.ts +6 -0
  160. package/docs/api/websiteEditor.d.ts +6 -0
  161. package/docs/api/work.d.ts +6 -0
  162. package/docs/api/workbench.d.ts +6 -0
  163. package/docs/api/workflows.d.ts +6 -0
  164. package/docs/sdk-clients.md +5 -5
  165. package/package.json +1 -1
@@ -245,7 +245,7 @@ const result = await g8.api.contacts.batchContactRelated({ body: { contact_ids:
245
245
  Full records for up to 100 contacts in ONE request. Writes nothing.
246
246
 
247
247
  Use this instead of looping `GET /contacts/{contact_id}`: `GET /contacts`
248
- returns 17 fields per contact, and the loop spends one rate-limit slot per
248
+ returns a lean summary per contact, and the loop spends one rate-limit slot per
249
249
  contact to get the other fields. Each item is exactly what the per-contact
250
250
  route returns, through the same access check. A contact that does not exist
251
251
  or is outside the key's scope comes back `found: false`, rather than failing
@@ -544,6 +544,7 @@ Other envelope fields: `pagination` (PaginationMeta).
544
544
  | `custom_fields` | `CustomFieldWriteReport` | no | |
545
545
  | `merged` | `boolean` | no | default `false` |
546
546
  | `validation_errors` | `Array<string>` | no | |
547
+ | `warnings` | `Array<string>` | no | Advisory notes about values saved as sent that look wrong (e.g. an unrecognised seniority or country). Empty when the input is clean. |
547
548
 
548
549
  **Example**
549
550
 
@@ -1879,15 +1880,15 @@ List contacts with optional filtering and pagination.
1879
1880
  |---|---|---|---|
1880
1881
  | `query.page` | `integer` | no | Page number (1-indexed) default `1` |
1881
1882
  | `query.limit` | `integer` | no | Items per page (max 200) default `50` |
1882
- | `query.email` | `string \| null` | no | Filter by work email (exact match) |
1883
+ | `query.email` | `string \| null` | no | Filter by work email (exact match, case-insensitive; surrounding spaces ignored) |
1883
1884
  | `query.list_id` | `integer \| null` | no | Filter by list ID |
1884
1885
  | `query.name` | `string \| null` | no | Filter by first or last name (partial match) |
1885
1886
  | `query.job_title` | `string \| null` | no | Filter by job title (partial match) |
1886
- | `query.seniority_level` | `string \| null` | no | Filter by seniority level (exact match) |
1887
+ | `query.seniority_level` | `string \| null` | no | Filter by seniority level (exact match, case-insensitive). Spellings of the same level match each other: VP = Vice President; SVP/EVP = SVP = EVP = Senior/Executive Vice President; C-Suite = C-Level = CXO. Pass several levels comma-separated to match any of them, e.g. `VP,SVP/EVP`. |
1887
1888
  | `query.company_name` | `string \| null` | no | Filter by company name (partial match) |
1888
1889
  | `query.company_id` | `integer \| null` | no | Filter by company ID |
1889
- | `query.country` | `string \| null` | no | Filter by country (exact match) |
1890
- | `query.state` | `string \| null` | no | Filter by state (exact match) |
1890
+ | `query.country` | `string \| null` | no | Filter by country (exact match, case-insensitive; surrounding spaces ignored). Common aliases match each other: United States = US = USA; United Kingdom = UK. |
1891
+ | `query.state` | `string \| null` | no | Filter by state (exact match, case-insensitive; surrounding spaces ignored) |
1891
1892
  | `query.city` | `string \| null` | no | Filter by city (partial match) |
1892
1893
  | `query.job_department` | `string \| null` | no | Filter by job department (partial match) |
1893
1894
  | `query.industry` | `string \| null` | no | Filter by company industry (partial match) |
@@ -1902,8 +1903,14 @@ Other envelope fields: `pagination` (PaginationMeta).
1902
1903
  | Field | Type | Required | Description |
1903
1904
  |---|---|---|---|
1904
1905
  | `city` | `string \| null` | no | |
1906
+ | `company_domain` | `string \| null` | no | |
1907
+ | `company_employee_count` | `string \| null` | no | |
1905
1908
  | `company_id` | `integer \| null` | no | |
1909
+ | `company_industry` | `string \| null` | no | |
1910
+ | `company_name` | `string \| null` | no | |
1911
+ | `company_website` | `string \| null` | no | |
1906
1912
  | `country` | `string \| null` | no | |
1913
+ | `created_at` | `string \| null` | no | |
1907
1914
  | `custom_fields` | `Record<string, string \| null> \| null` | no | |
1908
1915
  | `direct_phone` | `string \| null` | no | |
1909
1916
  | `first_name` | `string \| null` | no | |
@@ -1917,6 +1924,7 @@ Other envelope fields: `pagination` (PaginationMeta).
1917
1924
  | `owner_name` | `string \| null` | no | |
1918
1925
  | `seniority_level` | `string \| null` | no | |
1919
1926
  | `state` | `string \| null` | no | |
1927
+ | `updated_at` | `string \| null` | no | |
1920
1928
  | `work_email` | `string \| null` | no | |
1921
1929
 
1922
1930
  **Example**
@@ -893,10 +893,16 @@ export interface PaginationMeta {
893
893
  limit: number;
894
894
  /** Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers. */
895
895
  next_cursor?: string | null;
896
+ /** Search endpoints only: plain-language notes about the result, e.g. that more records match than can be paged, or that a reversed `between` range was put in order. */
897
+ notes?: Array<string> | null;
896
898
  /** Current page number (1-indexed) */
897
899
  page: number;
898
900
  /** Total number of items */
899
901
  total: number;
902
+ /** Search endpoints only: how many records really match, when known. Can be larger than `total`, which is capped at the 10,000 results that can be paged. For company search this is a distinct-company estimate. Null when unknown; absent outside search. */
903
+ total_available?: number | null;
904
+ /** Search endpoints only: true when more records match than `total` shows (the result set is larger than the 10,000 results that can be paged). Absent outside search. */
905
+ total_is_lower_bound?: boolean | null;
900
906
  }
901
907
 
902
908
  /**
@@ -170,8 +170,14 @@ export interface PaginationMeta {
170
170
  limit: number;
171
171
  /** Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers. */
172
172
  next_cursor?: string | null;
173
+ /** Search endpoints only: plain-language notes about the result, e.g. that more records match than can be paged, or that a reversed `between` range was put in order. */
174
+ notes?: Array<string> | null;
173
175
  /** Current page number (1-indexed) */
174
176
  page: number;
175
177
  /** Total number of items */
176
178
  total: number;
179
+ /** Search endpoints only: how many records really match, when known. Can be larger than `total`, which is capped at the 10,000 results that can be paged. For company search this is a distinct-company estimate. Null when unknown; absent outside search. */
180
+ total_available?: number | null;
181
+ /** Search endpoints only: true when more records match than `total` shows (the result set is larger than the 10,000 results that can be paged). Absent outside search. */
182
+ total_is_lower_bound?: boolean | null;
177
183
  }
@@ -819,10 +819,16 @@ export interface PaginationMeta {
819
819
  limit: number;
820
820
  /** Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers. */
821
821
  next_cursor?: string | null;
822
+ /** Search endpoints only: plain-language notes about the result, e.g. that more records match than can be paged, or that a reversed `between` range was put in order. */
823
+ notes?: Array<string> | null;
822
824
  /** Current page number (1-indexed) */
823
825
  page: number;
824
826
  /** Total number of items */
825
827
  total: number;
828
+ /** Search endpoints only: how many records really match, when known. Can be larger than `total`, which is capped at the 10,000 results that can be paged. For company search this is a distinct-company estimate. Null when unknown; absent outside search. */
829
+ total_available?: number | null;
830
+ /** Search endpoints only: true when more records match than `total` shows (the result set is larger than the 10,000 results that can be paged). Absent outside search. */
831
+ total_is_lower_bound?: boolean | null;
826
832
  }
827
833
 
828
834
  /** Mirror of `PersonalContactChoiceRequest`. */
@@ -208,8 +208,14 @@ export interface PaginationMeta {
208
208
  limit: number;
209
209
  /** Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers. */
210
210
  next_cursor?: string | null;
211
+ /** Search endpoints only: plain-language notes about the result, e.g. that more records match than can be paged, or that a reversed `between` range was put in order. */
212
+ notes?: Array<string> | null;
211
213
  /** Current page number (1-indexed) */
212
214
  page: number;
213
215
  /** Total number of items */
214
216
  total: number;
217
+ /** Search endpoints only: how many records really match, when known. Can be larger than `total`, which is capped at the 10,000 results that can be paged. For company search this is a distinct-company estimate. Null when unknown; absent outside search. */
218
+ total_available?: number | null;
219
+ /** Search endpoints only: true when more records match than `total` shows (the result set is larger than the 10,000 results that can be paged). Absent outside search. */
220
+ total_is_lower_bound?: boolean | null;
215
221
  }
@@ -484,8 +484,14 @@ export interface PaginationMeta {
484
484
  limit: number;
485
485
  /** Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers. */
486
486
  next_cursor?: string | null;
487
+ /** Search endpoints only: plain-language notes about the result, e.g. that more records match than can be paged, or that a reversed `between` range was put in order. */
488
+ notes?: Array<string> | null;
487
489
  /** Current page number (1-indexed) */
488
490
  page: number;
489
491
  /** Total number of items */
490
492
  total: number;
493
+ /** Search endpoints only: how many records really match, when known. Can be larger than `total`, which is capped at the 10,000 results that can be paged. For company search this is a distinct-company estimate. Null when unknown; absent outside search. */
494
+ total_available?: number | null;
495
+ /** Search endpoints only: true when more records match than `total` shows (the result set is larger than the 10,000 results that can be paged). Absent outside search. */
496
+ total_is_lower_bound?: boolean | null;
491
497
  }
@@ -1652,10 +1652,16 @@ export interface PaginationMeta {
1652
1652
  limit: number;
1653
1653
  /** Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers. */
1654
1654
  next_cursor?: string | null;
1655
+ /** Search endpoints only: plain-language notes about the result, e.g. that more records match than can be paged, or that a reversed `between` range was put in order. */
1656
+ notes?: Array<string> | null;
1655
1657
  /** Current page number (1-indexed) */
1656
1658
  page: number;
1657
1659
  /** Total number of items */
1658
1660
  total: number;
1661
+ /** Search endpoints only: how many records really match, when known. Can be larger than `total`, which is capped at the 10,000 results that can be paged. For company search this is a distinct-company estimate. Null when unknown; absent outside search. */
1662
+ total_available?: number | null;
1663
+ /** Search endpoints only: true when more records match than `total` shows (the result set is larger than the 10,000 results that can be paged). Absent outside search. */
1664
+ total_is_lower_bound?: boolean | null;
1659
1665
  }
1660
1666
 
1661
1667
  export interface PipelineResponse {
@@ -400,10 +400,16 @@ export interface PaginationMeta {
400
400
  limit: number;
401
401
  /** Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers. */
402
402
  next_cursor?: string | null;
403
+ /** Search endpoints only: plain-language notes about the result, e.g. that more records match than can be paged, or that a reversed `between` range was put in order. */
404
+ notes?: Array<string> | null;
403
405
  /** Current page number (1-indexed) */
404
406
  page: number;
405
407
  /** Total number of items */
406
408
  total: number;
409
+ /** Search endpoints only: how many records really match, when known. Can be larger than `total`, which is capped at the 10,000 results that can be paged. For company search this is a distinct-company estimate. Null when unknown; absent outside search. */
410
+ total_available?: number | null;
411
+ /** Search endpoints only: true when more records match than `total` shows (the result set is larger than the 10,000 results that can be paged). Absent outside search. */
412
+ total_is_lower_bound?: boolean | null;
407
413
  }
408
414
 
409
415
  export interface RetirementDecisionRequest {
@@ -1758,8 +1758,14 @@ export interface PaginationMeta {
1758
1758
  limit: number;
1759
1759
  /** Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers. */
1760
1760
  next_cursor?: string | null;
1761
+ /** Search endpoints only: plain-language notes about the result, e.g. that more records match than can be paged, or that a reversed `between` range was put in order. */
1762
+ notes?: Array<string> | null;
1761
1763
  /** Current page number (1-indexed) */
1762
1764
  page: number;
1763
1765
  /** Total number of items */
1764
1766
  total: number;
1767
+ /** Search endpoints only: how many records really match, when known. Can be larger than `total`, which is capped at the 10,000 results that can be paged. For company search this is a distinct-company estimate. Null when unknown; absent outside search. */
1768
+ total_available?: number | null;
1769
+ /** Search endpoints only: true when more records match than `total` shows (the result set is larger than the 10,000 results that can be paged). Absent outside search. */
1770
+ total_is_lower_bound?: boolean | null;
1765
1771
  }
@@ -1072,10 +1072,16 @@ export interface PaginationMeta {
1072
1072
  limit: number;
1073
1073
  /** Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers. */
1074
1074
  next_cursor?: string | null;
1075
+ /** Search endpoints only: plain-language notes about the result, e.g. that more records match than can be paged, or that a reversed `between` range was put in order. */
1076
+ notes?: Array<string> | null;
1075
1077
  /** Current page number (1-indexed) */
1076
1078
  page: number;
1077
1079
  /** Total number of items */
1078
1080
  total: number;
1081
+ /** Search endpoints only: how many records really match, when known. Can be larger than `total`, which is capped at the 10,000 results that can be paged. For company search this is a distinct-company estimate. Null when unknown; absent outside search. */
1082
+ total_available?: number | null;
1083
+ /** Search endpoints only: true when more records match than `total` shows (the result set is larger than the 10,000 results that can be paged). Absent outside search. */
1084
+ total_is_lower_bound?: boolean | null;
1079
1085
  }
1080
1086
 
1081
1087
  /**
@@ -854,10 +854,16 @@ export interface PaginationMeta {
854
854
  limit: number;
855
855
  /** Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers. */
856
856
  next_cursor?: string | null;
857
+ /** Search endpoints only: plain-language notes about the result, e.g. that more records match than can be paged, or that a reversed `between` range was put in order. */
858
+ notes?: Array<string> | null;
857
859
  /** Current page number (1-indexed) */
858
860
  page: number;
859
861
  /** Total number of items */
860
862
  total: number;
863
+ /** Search endpoints only: how many records really match, when known. Can be larger than `total`, which is capped at the 10,000 results that can be paged. For company search this is a distinct-company estimate. Null when unknown; absent outside search. */
864
+ total_available?: number | null;
865
+ /** Search endpoints only: true when more records match than `total` shows (the result set is larger than the 10,000 results that can be paged). Absent outside search. */
866
+ total_is_lower_bound?: boolean | null;
861
867
  }
862
868
 
863
869
  /**
@@ -184,10 +184,16 @@ export interface PaginationMeta {
184
184
  limit: number;
185
185
  /** Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers. */
186
186
  next_cursor?: string | null;
187
+ /** Search endpoints only: plain-language notes about the result, e.g. that more records match than can be paged, or that a reversed `between` range was put in order. */
188
+ notes?: Array<string> | null;
187
189
  /** Current page number (1-indexed) */
188
190
  page: number;
189
191
  /** Total number of items */
190
192
  total: number;
193
+ /** Search endpoints only: how many records really match, when known. Can be larger than `total`, which is capped at the 10,000 results that can be paged. For company search this is a distinct-company estimate. Null when unknown; absent outside search. */
194
+ total_available?: number | null;
195
+ /** Search endpoints only: true when more records match than `total` shows (the result set is larger than the 10,000 results that can be paged). Absent outside search. */
196
+ total_is_lower_bound?: boolean | null;
191
197
  }
192
198
 
193
199
  export interface RejectDuplicateRequest {
@@ -229,10 +229,16 @@ export interface PaginationMeta {
229
229
  limit: number;
230
230
  /** Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers. */
231
231
  next_cursor?: string | null;
232
+ /** Search endpoints only: plain-language notes about the result, e.g. that more records match than can be paged, or that a reversed `between` range was put in order. */
233
+ notes?: Array<string> | null;
232
234
  /** Current page number (1-indexed) */
233
235
  page: number;
234
236
  /** Total number of items */
235
237
  total: number;
238
+ /** Search endpoints only: how many records really match, when known. Can be larger than `total`, which is capped at the 10,000 results that can be paged. For company search this is a distinct-company estimate. Null when unknown; absent outside search. */
239
+ total_available?: number | null;
240
+ /** Search endpoints only: true when more records match than `total` shows (the result set is larger than the 10,000 results that can be paged). Absent outside search. */
241
+ total_is_lower_bound?: boolean | null;
236
242
  }
237
243
 
238
244
  /** Send a draft for signature. This EMAILS A REAL PERSON. */
@@ -2694,10 +2694,16 @@ export interface PaginationMeta {
2694
2694
  limit: number;
2695
2695
  /** Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers. */
2696
2696
  next_cursor?: string | null;
2697
+ /** Search endpoints only: plain-language notes about the result, e.g. that more records match than can be paged, or that a reversed `between` range was put in order. */
2698
+ notes?: Array<string> | null;
2697
2699
  /** Current page number (1-indexed) */
2698
2700
  page: number;
2699
2701
  /** Total number of items */
2700
2702
  total: number;
2703
+ /** Search endpoints only: how many records really match, when known. Can be larger than `total`, which is capped at the 10,000 results that can be paged. For company search this is a distinct-company estimate. Null when unknown; absent outside search. */
2704
+ total_available?: number | null;
2705
+ /** Search endpoints only: true when more records match than `total` shows (the result set is larger than the 10,000 results that can be paged). Absent outside search. */
2706
+ total_is_lower_bound?: boolean | null;
2701
2707
  }
2702
2708
 
2703
2709
  export interface PersonLookupRequest {
@@ -108,8 +108,14 @@ export interface PaginationMeta {
108
108
  limit: number;
109
109
  /** Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers. */
110
110
  next_cursor?: string | null;
111
+ /** Search endpoints only: plain-language notes about the result, e.g. that more records match than can be paged, or that a reversed `between` range was put in order. */
112
+ notes?: Array<string> | null;
111
113
  /** Current page number (1-indexed) */
112
114
  page: number;
113
115
  /** Total number of items */
114
116
  total: number;
117
+ /** Search endpoints only: how many records really match, when known. Can be larger than `total`, which is capped at the 10,000 results that can be paged. For company search this is a distinct-company estimate. Null when unknown; absent outside search. */
118
+ total_available?: number | null;
119
+ /** Search endpoints only: true when more records match than `total` shows (the result set is larger than the 10,000 results that can be paged). Absent outside search. */
120
+ total_is_lower_bound?: boolean | null;
115
121
  }
@@ -385,10 +385,16 @@ export interface PaginationMeta {
385
385
  limit: number;
386
386
  /** Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers. */
387
387
  next_cursor?: string | null;
388
+ /** Search endpoints only: plain-language notes about the result, e.g. that more records match than can be paged, or that a reversed `between` range was put in order. */
389
+ notes?: Array<string> | null;
388
390
  /** Current page number (1-indexed) */
389
391
  page: number;
390
392
  /** Total number of items */
391
393
  total: number;
394
+ /** Search endpoints only: how many records really match, when known. Can be larger than `total`, which is capped at the 10,000 results that can be paged. For company search this is a distinct-company estimate. Null when unknown; absent outside search. */
395
+ total_available?: number | null;
396
+ /** Search endpoints only: true when more records match than `total` shows (the result set is larger than the 10,000 results that can be paged). Absent outside search. */
397
+ total_is_lower_bound?: boolean | null;
392
398
  }
393
399
 
394
400
  /** One row (contact or company) plus the columns to set on it. */
@@ -1005,8 +1005,14 @@ export interface PaginationMeta {
1005
1005
  limit: number;
1006
1006
  /** Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers. */
1007
1007
  next_cursor?: string | null;
1008
+ /** Search endpoints only: plain-language notes about the result, e.g. that more records match than can be paged, or that a reversed `between` range was put in order. */
1009
+ notes?: Array<string> | null;
1008
1010
  /** Current page number (1-indexed) */
1009
1011
  page: number;
1010
1012
  /** Total number of items */
1011
1013
  total: number;
1014
+ /** Search endpoints only: how many records really match, when known. Can be larger than `total`, which is capped at the 10,000 results that can be paged. For company search this is a distinct-company estimate. Null when unknown; absent outside search. */
1015
+ total_available?: number | null;
1016
+ /** Search endpoints only: true when more records match than `total` shows (the result set is larger than the 10,000 results that can be paged). Absent outside search. */
1017
+ total_is_lower_bound?: boolean | null;
1012
1018
  }
@@ -585,10 +585,16 @@ export interface PaginationMeta {
585
585
  limit: number;
586
586
  /** Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers. */
587
587
  next_cursor?: string | null;
588
+ /** Search endpoints only: plain-language notes about the result, e.g. that more records match than can be paged, or that a reversed `between` range was put in order. */
589
+ notes?: Array<string> | null;
588
590
  /** Current page number (1-indexed) */
589
591
  page: number;
590
592
  /** Total number of items */
591
593
  total: number;
594
+ /** Search endpoints only: how many records really match, when known. Can be larger than `total`, which is capped at the 10,000 results that can be paged. For company search this is a distinct-company estimate. Null when unknown; absent outside search. */
595
+ total_available?: number | null;
596
+ /** Search endpoints only: true when more records match than `total` shows (the result set is larger than the 10,000 results that can be paged). Absent outside search. */
597
+ total_is_lower_bound?: boolean | null;
592
598
  }
593
599
 
594
600
  export interface SequenceStepRef {
@@ -1040,10 +1040,16 @@ export interface PaginationMeta {
1040
1040
  limit: number;
1041
1041
  /** Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers. */
1042
1042
  next_cursor?: string | null;
1043
+ /** Search endpoints only: plain-language notes about the result, e.g. that more records match than can be paged, or that a reversed `between` range was put in order. */
1044
+ notes?: Array<string> | null;
1043
1045
  /** Current page number (1-indexed) */
1044
1046
  page: number;
1045
1047
  /** Total number of items */
1046
1048
  total: number;
1049
+ /** Search endpoints only: how many records really match, when known. Can be larger than `total`, which is capped at the 10,000 results that can be paged. For company search this is a distinct-company estimate. Null when unknown; absent outside search. */
1050
+ total_available?: number | null;
1051
+ /** Search endpoints only: true when more records match than `total` shows (the result set is larger than the 10,000 results that can be paged). Absent outside search. */
1052
+ total_is_lower_bound?: boolean | null;
1047
1053
  }
1048
1054
 
1049
1055
  /** Mirrors `company_profile.SaveProfileRequest`. */
@@ -53,8 +53,14 @@ export interface PaginationMeta {
53
53
  limit: number;
54
54
  /** Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers. */
55
55
  next_cursor?: string | null;
56
+ /** Search endpoints only: plain-language notes about the result, e.g. that more records match than can be paged, or that a reversed `between` range was put in order. */
57
+ notes?: Array<string> | null;
56
58
  /** Current page number (1-indexed) */
57
59
  page: number;
58
60
  /** Total number of items */
59
61
  total: number;
62
+ /** Search endpoints only: how many records really match, when known. Can be larger than `total`, which is capped at the 10,000 results that can be paged. For company search this is a distinct-company estimate. Null when unknown; absent outside search. */
63
+ total_available?: number | null;
64
+ /** Search endpoints only: true when more records match than `total` shows (the result set is larger than the 10,000 results that can be paged). Absent outside search. */
65
+ total_is_lower_bound?: boolean | null;
60
66
  }
@@ -69,8 +69,14 @@ export interface PaginationMeta {
69
69
  limit: number;
70
70
  /** Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers. */
71
71
  next_cursor?: string | null;
72
+ /** Search endpoints only: plain-language notes about the result, e.g. that more records match than can be paged, or that a reversed `between` range was put in order. */
73
+ notes?: Array<string> | null;
72
74
  /** Current page number (1-indexed) */
73
75
  page: number;
74
76
  /** Total number of items */
75
77
  total: number;
78
+ /** Search endpoints only: how many records really match, when known. Can be larger than `total`, which is capped at the 10,000 results that can be paged. For company search this is a distinct-company estimate. Null when unknown; absent outside search. */
79
+ total_available?: number | null;
80
+ /** Search endpoints only: true when more records match than `total` shows (the result set is larger than the 10,000 results that can be paged). Absent outside search. */
81
+ total_is_lower_bound?: boolean | null;
76
82
  }
@@ -415,10 +415,16 @@ export interface PaginationMeta {
415
415
  limit: number;
416
416
  /** Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers. */
417
417
  next_cursor?: string | null;
418
+ /** Search endpoints only: plain-language notes about the result, e.g. that more records match than can be paged, or that a reversed `between` range was put in order. */
419
+ notes?: Array<string> | null;
418
420
  /** Current page number (1-indexed) */
419
421
  page: number;
420
422
  /** Total number of items */
421
423
  total: number;
424
+ /** Search endpoints only: how many records really match, when known. Can be larger than `total`, which is capped at the 10,000 results that can be paged. For company search this is a distinct-company estimate. Null when unknown; absent outside search. */
425
+ total_available?: number | null;
426
+ /** Search endpoints only: true when more records match than `total` shows (the result set is larger than the 10,000 results that can be paged). Absent outside search. */
427
+ total_is_lower_bound?: boolean | null;
422
428
  }
423
429
 
424
430
  export interface PersonaFillFromDocRequest {
@@ -317,10 +317,16 @@ export interface PaginationMeta {
317
317
  limit: number;
318
318
  /** Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers. */
319
319
  next_cursor?: string | null;
320
+ /** Search endpoints only: plain-language notes about the result, e.g. that more records match than can be paged, or that a reversed `between` range was put in order. */
321
+ notes?: Array<string> | null;
320
322
  /** Current page number (1-indexed) */
321
323
  page: number;
322
324
  /** Total number of items */
323
325
  total: number;
326
+ /** Search endpoints only: how many records really match, when known. Can be larger than `total`, which is capped at the 10,000 results that can be paged. For company search this is a distinct-company estimate. Null when unknown; absent outside search. */
327
+ total_available?: number | null;
328
+ /** Search endpoints only: true when more records match than `total` shows (the result set is larger than the 10,000 results that can be paged). Absent outside search. */
329
+ total_is_lower_bound?: boolean | null;
324
330
  }
325
331
 
326
332
  /**
@@ -150,8 +150,14 @@ export interface PaginationMeta {
150
150
  limit: number;
151
151
  /** Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers. */
152
152
  next_cursor?: string | null;
153
+ /** Search endpoints only: plain-language notes about the result, e.g. that more records match than can be paged, or that a reversed `between` range was put in order. */
154
+ notes?: Array<string> | null;
153
155
  /** Current page number (1-indexed) */
154
156
  page: number;
155
157
  /** Total number of items */
156
158
  total: number;
159
+ /** Search endpoints only: how many records really match, when known. Can be larger than `total`, which is capped at the 10,000 results that can be paged. For company search this is a distinct-company estimate. Null when unknown; absent outside search. */
160
+ total_available?: number | null;
161
+ /** Search endpoints only: true when more records match than `total` shows (the result set is larger than the 10,000 results that can be paged). Absent outside search. */
162
+ total_is_lower_bound?: boolean | null;
157
163
  }
@@ -633,10 +633,16 @@ export interface PaginationMeta {
633
633
  limit: number;
634
634
  /** Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers. */
635
635
  next_cursor?: string | null;
636
+ /** Search endpoints only: plain-language notes about the result, e.g. that more records match than can be paged, or that a reversed `between` range was put in order. */
637
+ notes?: Array<string> | null;
636
638
  /** Current page number (1-indexed) */
637
639
  page: number;
638
640
  /** Total number of items */
639
641
  total: number;
642
+ /** Search endpoints only: how many records really match, when known. Can be larger than `total`, which is capped at the 10,000 results that can be paged. For company search this is a distinct-company estimate. Null when unknown; absent outside search. */
643
+ total_available?: number | null;
644
+ /** Search endpoints only: true when more records match than `total` shows (the result set is larger than the 10,000 results that can be paged). Absent outside search. */
645
+ total_is_lower_bound?: boolean | null;
640
646
  }
641
647
 
642
648
  /** A named queue + filter combination. */
@@ -165,10 +165,16 @@ export interface PaginationMeta {
165
165
  limit: number;
166
166
  /** Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers. */
167
167
  next_cursor?: string | null;
168
+ /** Search endpoints only: plain-language notes about the result, e.g. that more records match than can be paged, or that a reversed `between` range was put in order. */
169
+ notes?: Array<string> | null;
168
170
  /** Current page number (1-indexed) */
169
171
  page: number;
170
172
  /** Total number of items */
171
173
  total: number;
174
+ /** Search endpoints only: how many records really match, when known. Can be larger than `total`, which is capped at the 10,000 results that can be paged. For company search this is a distinct-company estimate. Null when unknown; absent outside search. */
175
+ total_available?: number | null;
176
+ /** Search endpoints only: true when more records match than `total` shows (the result set is larger than the 10,000 results that can be paged). Absent outside search. */
177
+ total_is_lower_bound?: boolean | null;
172
178
  }
173
179
 
174
180
  export interface PatchResponse {
@@ -124,8 +124,14 @@ export interface PaginationMeta {
124
124
  limit: number;
125
125
  /** Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers. */
126
126
  next_cursor?: string | null;
127
+ /** Search endpoints only: plain-language notes about the result, e.g. that more records match than can be paged, or that a reversed `between` range was put in order. */
128
+ notes?: Array<string> | null;
127
129
  /** Current page number (1-indexed) */
128
130
  page: number;
129
131
  /** Total number of items */
130
132
  total: number;
133
+ /** Search endpoints only: how many records really match, when known. Can be larger than `total`, which is capped at the 10,000 results that can be paged. For company search this is a distinct-company estimate. Null when unknown; absent outside search. */
134
+ total_available?: number | null;
135
+ /** Search endpoints only: true when more records match than `total` shows (the result set is larger than the 10,000 results that can be paged). Absent outside search. */
136
+ total_is_lower_bound?: boolean | null;
131
137
  }
@@ -135,8 +135,14 @@ export interface PaginationMeta {
135
135
  limit: number;
136
136
  /** Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers. */
137
137
  next_cursor?: string | null;
138
+ /** Search endpoints only: plain-language notes about the result, e.g. that more records match than can be paged, or that a reversed `between` range was put in order. */
139
+ notes?: Array<string> | null;
138
140
  /** Current page number (1-indexed) */
139
141
  page: number;
140
142
  /** Total number of items */
141
143
  total: number;
144
+ /** Search endpoints only: how many records really match, when known. Can be larger than `total`, which is capped at the 10,000 results that can be paged. For company search this is a distinct-company estimate. Null when unknown; absent outside search. */
145
+ total_available?: number | null;
146
+ /** Search endpoints only: true when more records match than `total` shows (the result set is larger than the 10,000 results that can be paged). Absent outside search. */
147
+ total_is_lower_bound?: boolean | null;
142
148
  }
@@ -2046,10 +2046,16 @@ export interface PaginationMeta {
2046
2046
  limit: number;
2047
2047
  /** Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers. */
2048
2048
  next_cursor?: string | null;
2049
+ /** Search endpoints only: plain-language notes about the result, e.g. that more records match than can be paged, or that a reversed `between` range was put in order. */
2050
+ notes?: Array<string> | null;
2049
2051
  /** Current page number (1-indexed) */
2050
2052
  page: number;
2051
2053
  /** Total number of items */
2052
2054
  total: number;
2055
+ /** Search endpoints only: how many records really match, when known. Can be larger than `total`, which is capped at the 10,000 results that can be paged. For company search this is a distinct-company estimate. Null when unknown; absent outside search. */
2056
+ total_available?: number | null;
2057
+ /** Search endpoints only: true when more records match than `total` shows (the result set is larger than the 10,000 results that can be paged). Absent outside search. */
2058
+ total_is_lower_bound?: boolean | null;
2053
2059
  }
2054
2060
 
2055
2061
  /** Pull every CRM contact into graph8. */
@@ -468,10 +468,16 @@ export interface PaginationMeta {
468
468
  limit: number;
469
469
  /** Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers. */
470
470
  next_cursor?: string | null;
471
+ /** Search endpoints only: plain-language notes about the result, e.g. that more records match than can be paged, or that a reversed `between` range was put in order. */
472
+ notes?: Array<string> | null;
471
473
  /** Current page number (1-indexed) */
472
474
  page: number;
473
475
  /** Total number of items */
474
476
  total: number;
477
+ /** Search endpoints only: how many records really match, when known. Can be larger than `total`, which is capped at the 10,000 results that can be paged. For company search this is a distinct-company estimate. Null when unknown; absent outside search. */
478
+ total_available?: number | null;
479
+ /** Search endpoints only: true when more records match than `total` shows (the result set is larger than the 10,000 results that can be paged). Absent outside search. */
480
+ total_is_lower_bound?: boolean | null;
475
481
  }
476
482
 
477
483
  export interface UrlCompaniesRequest {
@@ -468,10 +468,16 @@ export interface PaginationMeta {
468
468
  limit: number;
469
469
  /** Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers. */
470
470
  next_cursor?: string | null;
471
+ /** Search endpoints only: plain-language notes about the result, e.g. that more records match than can be paged, or that a reversed `between` range was put in order. */
472
+ notes?: Array<string> | null;
471
473
  /** Current page number (1-indexed) */
472
474
  page: number;
473
475
  /** Total number of items */
474
476
  total: number;
477
+ /** Search endpoints only: how many records really match, when known. Can be larger than `total`, which is capped at the 10,000 results that can be paged. For company search this is a distinct-company estimate. Null when unknown; absent outside search. */
478
+ total_available?: number | null;
479
+ /** Search endpoints only: true when more records match than `total` shows (the result set is larger than the 10,000 results that can be paged). Absent outside search. */
480
+ total_is_lower_bound?: boolean | null;
475
481
  }
476
482
 
477
483
  /**
@@ -77,8 +77,14 @@ export interface PaginationMeta {
77
77
  limit: number;
78
78
  /** Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers. */
79
79
  next_cursor?: string | null;
80
+ /** Search endpoints only: plain-language notes about the result, e.g. that more records match than can be paged, or that a reversed `between` range was put in order. */
81
+ notes?: Array<string> | null;
80
82
  /** Current page number (1-indexed) */
81
83
  page: number;
82
84
  /** Total number of items */
83
85
  total: number;
86
+ /** Search endpoints only: how many records really match, when known. Can be larger than `total`, which is capped at the 10,000 results that can be paged. For company search this is a distinct-company estimate. Null when unknown; absent outside search. */
87
+ total_available?: number | null;
88
+ /** Search endpoints only: true when more records match than `total` shows (the result set is larger than the 10,000 results that can be paged). Absent outside search. */
89
+ total_is_lower_bound?: boolean | null;
84
90
  }
@@ -1330,10 +1330,16 @@ export interface PaginationMeta {
1330
1330
  limit: number;
1331
1331
  /** Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers. */
1332
1332
  next_cursor?: string | null;
1333
+ /** Search endpoints only: plain-language notes about the result, e.g. that more records match than can be paged, or that a reversed `between` range was put in order. */
1334
+ notes?: Array<string> | null;
1333
1335
  /** Current page number (1-indexed) */
1334
1336
  page: number;
1335
1337
  /** Total number of items */
1336
1338
  total: number;
1339
+ /** Search endpoints only: how many records really match, when known. Can be larger than `total`, which is capped at the 10,000 results that can be paged. For company search this is a distinct-company estimate. Null when unknown; absent outside search. */
1340
+ total_available?: number | null;
1341
+ /** Search endpoints only: true when more records match than `total` shows (the result set is larger than the 10,000 results that can be paged). Absent outside search. */
1342
+ total_is_lower_bound?: boolean | null;
1337
1343
  }
1338
1344
 
1339
1345
  /**