@graph8/sdk 0.265.0 → 0.293.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 (178) hide show
  1. package/README.md +3 -3
  2. package/dist/index.d.mts +734 -28
  3. package/dist/index.d.ts +734 -28
  4. package/dist/index.js +15 -5
  5. package/dist/index.js.map +1 -1
  6. package/dist/index.mjs +15 -5
  7. package/dist/index.mjs.map +1 -1
  8. package/dist/react.d.mts +728 -26
  9. package/dist/react.d.ts +728 -26
  10. package/dist/react.js +14 -4
  11. package/dist/react.js.map +1 -1
  12. package/dist/react.mjs +14 -4
  13. package/dist/react.mjs.map +1 -1
  14. package/dist/types/core.d.ts +2 -0
  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 +6 -2
  18. package/dist/types/search.d.ts +25 -1
  19. package/dist/types/version.d.ts +2 -2
  20. package/docs/agents.md +8 -7
  21. package/docs/api/README.md +4 -4
  22. package/docs/api/accounts.d.ts +6 -0
  23. package/docs/api/adCampaigns.d.ts +6 -0
  24. package/docs/api/adCreatives.d.ts +6 -0
  25. package/docs/api/agency.d.ts +6 -0
  26. package/docs/api/agent.d.ts +6 -0
  27. package/docs/api/agents.d.ts +6 -0
  28. package/docs/api/aiInbox.d.ts +6 -0
  29. package/docs/api/analytics.d.ts +32 -1
  30. package/docs/api/analytics.md +2 -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 +14 -0
  43. package/docs/api/assertUpsert.md +5 -0
  44. package/docs/api/audienceSyncs.d.ts +14 -0
  45. package/docs/api/audienceSyncs.md +16 -0
  46. package/docs/api/brandKit.d.ts +6 -0
  47. package/docs/api/bugReports.d.ts +6 -0
  48. package/docs/api/by-path.md +3 -0
  49. package/docs/api/calendarInvites.d.ts +6 -0
  50. package/docs/api/campaignWorkflows.d.ts +6 -0
  51. package/docs/api/campaigns.d.ts +6 -0
  52. package/docs/api/channels.d.ts +6 -0
  53. package/docs/api/cliCampaigns.d.ts +6 -0
  54. package/docs/api/cliPipelines.d.ts +6 -0
  55. package/docs/api/clickHouse.d.ts +6 -0
  56. package/docs/api/companies.d.ts +17 -3
  57. package/docs/api/companies.md +13 -3
  58. package/docs/api/companyIntelligence.d.ts +6 -0
  59. package/docs/api/contacts.d.ts +26 -5
  60. package/docs/api/contacts.md +17 -6
  61. package/docs/api/content.d.ts +6 -0
  62. package/docs/api/contentGridSkills.d.ts +6 -0
  63. package/docs/api/copilot.d.ts +6 -0
  64. package/docs/api/crmSyncs.d.ts +6 -0
  65. package/docs/api/customerSuccess.d.ts +6 -0
  66. package/docs/api/deals.d.ts +6 -0
  67. package/docs/api/deliverability.d.ts +6 -0
  68. package/docs/api/desk.d.ts +6 -0
  69. package/docs/api/dialer.d.ts +6 -0
  70. package/docs/api/documents.d.ts +6 -0
  71. package/docs/api/duplicates.d.ts +6 -0
  72. package/docs/api/eSignature.d.ts +6 -0
  73. package/docs/api/enrichment.d.ts +82 -2
  74. package/docs/api/enrichment.md +76 -1
  75. package/docs/api/events.d.ts +6 -0
  76. package/docs/api/fields.d.ts +30 -3
  77. package/docs/api/fields.md +15 -4
  78. package/docs/api/forms.d.ts +6 -0
  79. package/docs/api/gtmCampaigns.d.ts +6 -0
  80. package/docs/api/gtmContext.d.ts +6 -0
  81. package/docs/api/gtmDeliverability.d.ts +6 -0
  82. package/docs/api/gtmKnowledgeBase.d.ts +6 -0
  83. package/docs/api/gtmLibrary.d.ts +6 -0
  84. package/docs/api/imageLibrary.d.ts +6 -0
  85. package/docs/api/imports.d.ts +6 -0
  86. package/docs/api/inbox.d.ts +6 -0
  87. package/docs/api/install.d.ts +32 -0
  88. package/docs/api/install.md +18 -0
  89. package/docs/api/installedApps.d.ts +6 -0
  90. package/docs/api/integrationStatus.d.ts +6 -0
  91. package/docs/api/integrations.d.ts +6 -0
  92. package/docs/api/intent.d.ts +32 -1
  93. package/docs/api/intent.md +23 -0
  94. package/docs/api/knowledge.d.ts +6 -0
  95. package/docs/api/knowledgeBase.d.ts +6 -0
  96. package/docs/api/landingPages.d.ts +6 -0
  97. package/docs/api/leads.d.ts +6 -0
  98. package/docs/api/library.d.ts +6 -0
  99. package/docs/api/linkedIn.d.ts +6 -0
  100. package/docs/api/linkedInOutreach.d.ts +6 -0
  101. package/docs/api/lists.d.ts +22 -0
  102. package/docs/api/lists.md +24 -2
  103. package/docs/api/logs.d.ts +6 -0
  104. package/docs/api/mailboxes.d.ts +6 -0
  105. package/docs/api/marketingIntelligence.d.ts +40 -0
  106. package/docs/api/marketingIntelligence.md +20 -0
  107. package/docs/api/marketplace.d.ts +6 -0
  108. package/docs/api/mcp.d.ts +6 -0
  109. package/docs/api/me.d.ts +6 -0
  110. package/docs/api/meetings.d.ts +6 -0
  111. package/docs/api/newsletter.d.ts +6 -0
  112. package/docs/api/notes.d.ts +6 -0
  113. package/docs/api/notifications.d.ts +6 -0
  114. package/docs/api/objects.d.ts +6 -0
  115. package/docs/api/openSearch.d.ts +6 -0
  116. package/docs/api/ops.d.ts +6 -0
  117. package/docs/api/orgGovernance.d.ts +6 -0
  118. package/docs/api/orgVideos.d.ts +6 -0
  119. package/docs/api/organizationSettings.d.ts +6 -0
  120. package/docs/api/phoneNumbers.d.ts +6 -0
  121. package/docs/api/profile.d.ts +6 -0
  122. package/docs/api/programmaticPages.d.ts +6 -0
  123. package/docs/api/providerDomains.d.ts +6 -0
  124. package/docs/api/providerUsage.d.ts +6 -0
  125. package/docs/api/public.d.ts +6 -0
  126. package/docs/api/publicCopilot.d.ts +6 -0
  127. package/docs/api/publicSignals.d.ts +6 -0
  128. package/docs/api/publicVisitors.d.ts +6 -0
  129. package/docs/api/quotes.d.ts +6 -0
  130. package/docs/api/radarReports.d.ts +6 -0
  131. package/docs/api/recordRoles.d.ts +6 -0
  132. package/docs/api/repos.d.ts +6 -0
  133. package/docs/api/research.d.ts +6 -0
  134. package/docs/api/revenue.d.ts +6 -0
  135. package/docs/api/revenueAnalytics.d.ts +6 -0
  136. package/docs/api/revenueLifecycle.d.ts +11 -1
  137. package/docs/api/revenueLifecycle.md +11 -2
  138. package/docs/api/revenueRecords.d.ts +6 -0
  139. package/docs/api/roles.d.ts +49 -2
  140. package/docs/api/roles.md +65 -1
  141. package/docs/api/salesCoach.d.ts +6 -0
  142. package/docs/api/scans.d.ts +6 -0
  143. package/docs/api/scheduleBuy.d.ts +6 -0
  144. package/docs/api/scraping.d.ts +6 -0
  145. package/docs/api/search.d.ts +9 -1
  146. package/docs/api/search.md +3 -2
  147. package/docs/api/seo.d.ts +6 -0
  148. package/docs/api/sequenceLifecycle.d.ts +6 -0
  149. package/docs/api/sequences.d.ts +6 -0
  150. package/docs/api/settings.d.ts +6 -0
  151. package/docs/api/signals.d.ts +6 -0
  152. package/docs/api/signatures.d.ts +6 -0
  153. package/docs/api/snippet.d.ts +72 -2
  154. package/docs/api/snippet.md +73 -4
  155. package/docs/api/socialPublishing.d.ts +6 -0
  156. package/docs/api/studioDocuments.d.ts +6 -0
  157. package/docs/api/support.d.ts +6 -0
  158. package/docs/api/suppressions.d.ts +10 -0
  159. package/docs/api/suppressions.md +2 -0
  160. package/docs/api/surveys.d.ts +6 -0
  161. package/docs/api/tasks.d.ts +6 -0
  162. package/docs/api/teamMembers.d.ts +6 -0
  163. package/docs/api/teams.d.ts +6 -0
  164. package/docs/api/usage.d.ts +6 -0
  165. package/docs/api/visitors.d.ts +32 -0
  166. package/docs/api/visitors.md +12 -0
  167. package/docs/api/voice.d.ts +6 -0
  168. package/docs/api/webAnalytics.d.ts +288 -0
  169. package/docs/api/webAnalytics.md +144 -0
  170. package/docs/api/webChat.d.ts +6 -0
  171. package/docs/api/webhooks.d.ts +6 -0
  172. package/docs/api/websiteEditor.d.ts +6 -0
  173. package/docs/api/work.d.ts +6 -0
  174. package/docs/api/workbench.d.ts +6 -0
  175. package/docs/api/workflows.d.ts +6 -0
  176. package/docs/api/workflows.md +6 -0
  177. package/docs/sdk-clients.md +5 -5
  178. package/package.json +1 -1
@@ -69,6 +69,8 @@ Returns per campaign:
69
69
  | `query.limit` | `integer` | no | Number of campaigns to return default `50` |
70
70
  | `query.sort_by` | `"visitors" \| "meetings_booked" \| "reply_rate" \| "engaged_pct"` | no | Sort by this metric (descending) default `"visitors"` |
71
71
  | `query.write_key` | `string \| null` | no | Comma-separated public keys to filter by |
72
+ | `query.include_bots` | `boolean` | no | Count bot and crawler traffic too. Off by default: page views from self-identified crawlers, headless browsers, HTTP libraries and datacenter/cloud networks are excluded. Set true for the raw, unfiltered counts these reports returned before the filter existed. default `false` |
73
+ | `query.include_internal` | `boolean` | no | Count internal traffic too. Off by default: page views on the graph8 app (app.graph8.com) and local development hosts, and browsers identified as your own team members (member emails and your company email domains), are excluded. default `false` |
72
74
  | `headers.X-Org-Id` | `string \| null` | no | |
73
75
 
74
76
  **Returns** `MarketingResponse`: the envelope `{ data: Record<string, unknown> | Array<unknown>, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
@@ -117,6 +119,8 @@ Only includes pages with at least 10 unique visitors.
117
119
  | `query.limit` | `integer` | no | Number of pages to return default `50` |
118
120
  | `query.sort_by` | `"views" \| "meetings_booked" \| "reply_rate" \| "unique_visitors"` | no | Sort by this metric (descending) default `"views"` |
119
121
  | `query.write_key` | `string \| null` | no | Comma-separated public keys to filter by |
122
+ | `query.include_bots` | `boolean` | no | Count bot and crawler traffic too. Off by default: page views from self-identified crawlers, headless browsers, HTTP libraries and datacenter/cloud networks are excluded. Set true for the raw, unfiltered counts these reports returned before the filter existed. default `false` |
123
+ | `query.include_internal` | `boolean` | no | Count internal traffic too. Off by default: page views on the graph8 app (app.graph8.com) and local development hosts, and browsers identified as your own team members (member emails and your company email domains), are excluded. default `false` |
120
124
  | `headers.X-Org-Id` | `string \| null` | no | |
121
125
 
122
126
  **Returns** `MarketingResponse`: the envelope `{ data: Record<string, unknown> | Array<unknown>, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
@@ -154,6 +158,8 @@ Shows which entry pages drive best business outcomes.
154
158
  | `query.days` | `integer` | no | Number of days to analyze default `30` |
155
159
  | `query.limit` | `integer` | no | Number of pages to return default `50` |
156
160
  | `query.write_key` | `string \| null` | no | Comma-separated public keys to filter by |
161
+ | `query.include_bots` | `boolean` | no | Count bot and crawler traffic too. Off by default: page views from self-identified crawlers, headless browsers, HTTP libraries and datacenter/cloud networks are excluded. Set true for the raw, unfiltered counts these reports returned before the filter existed. default `false` |
162
+ | `query.include_internal` | `boolean` | no | Count internal traffic too. Off by default: page views on the graph8 app (app.graph8.com) and local development hosts, and browsers identified as your own team members (member emails and your company email domains), are excluded. default `false` |
157
163
  | `headers.X-Org-Id` | `string \| null` | no | |
158
164
 
159
165
  **Returns** `MarketingResponse`: the envelope `{ data: Record<string, unknown> | Array<unknown>, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
@@ -197,6 +203,8 @@ Returns:
197
203
  |---|---|---|---|
198
204
  | `query.days` | `integer` | no | Number of days to analyze default `30` |
199
205
  | `query.write_key` | `string \| null` | no | Comma-separated public keys to filter by |
206
+ | `query.include_bots` | `boolean` | no | Count bot and crawler traffic too. Off by default: page views from self-identified crawlers, headless browsers, HTTP libraries and datacenter/cloud networks are excluded. Set true for the raw, unfiltered counts these reports returned before the filter existed. default `false` |
207
+ | `query.include_internal` | `boolean` | no | Count internal traffic too. Off by default: page views on the graph8 app (app.graph8.com) and local development hosts, and browsers identified as your own team members (member emails and your company email domains), are excluded. default `false` |
200
208
  | `headers.X-Org-Id` | `string \| null` | no | |
201
209
 
202
210
  **Returns** `MarketingResponse`: the envelope `{ data: Record<string, unknown> | Array<unknown>, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
@@ -236,6 +244,8 @@ Campaign -> Visitors -> Identified -> Engaged -> Outbound -> Replies -> Meetings
236
244
  | `query.days` | `integer` | no | Number of days to analyze default `30` |
237
245
  | `query.limit` | `integer` | no | Number of campaigns to return default `50` |
238
246
  | `query.write_key` | `string \| null` | no | Comma-separated public keys to filter by |
247
+ | `query.include_bots` | `boolean` | no | Count bot and crawler traffic too. Off by default: page views from self-identified crawlers, headless browsers, HTTP libraries and datacenter/cloud networks are excluded. Set true for the raw, unfiltered counts these reports returned before the filter existed. default `false` |
248
+ | `query.include_internal` | `boolean` | no | Count internal traffic too. Off by default: page views on the graph8 app (app.graph8.com) and local development hosts, and browsers identified as your own team members (member emails and your company email domains), are excluded. default `false` |
239
249
  | `headers.X-Org-Id` | `string \| null` | no | |
240
250
 
241
251
  **Returns** `MarketingResponse`: the envelope `{ data: Record<string, unknown> | Array<unknown>, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
@@ -272,6 +282,8 @@ Channels: Direct, Paid Search, Paid Social, Organic Search, Organic Social, etc.
272
282
  |---|---|---|---|
273
283
  | `query.days` | `integer` | no | Number of days to analyze default `30` |
274
284
  | `query.write_key` | `string \| null` | no | Comma-separated public keys to filter by |
285
+ | `query.include_bots` | `boolean` | no | Count bot and crawler traffic too. Off by default: page views from self-identified crawlers, headless browsers, HTTP libraries and datacenter/cloud networks are excluded. Set true for the raw, unfiltered counts these reports returned before the filter existed. default `false` |
286
+ | `query.include_internal` | `boolean` | no | Count internal traffic too. Off by default: page views on the graph8 app (app.graph8.com) and local development hosts, and browsers identified as your own team members (member emails and your company email domains), are excluded. default `false` |
275
287
  | `headers.X-Org-Id` | `string \| null` | no | |
276
288
 
277
289
  **Returns** `MarketingResponse`: the envelope `{ data: Record<string, unknown> | Array<unknown>, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
@@ -309,6 +321,8 @@ Only includes pages with at least 10 visitors.
309
321
  | `query.days` | `integer` | no | Number of days to analyze default `30` |
310
322
  | `query.limit` | `integer` | no | Number of pages to return default `50` |
311
323
  | `query.write_key` | `string \| null` | no | Comma-separated public keys to filter by |
324
+ | `query.include_bots` | `boolean` | no | Count bot and crawler traffic too. Off by default: page views from self-identified crawlers, headless browsers, HTTP libraries and datacenter/cloud networks are excluded. Set true for the raw, unfiltered counts these reports returned before the filter existed. default `false` |
325
+ | `query.include_internal` | `boolean` | no | Count internal traffic too. Off by default: page views on the graph8 app (app.graph8.com) and local development hosts, and browsers identified as your own team members (member emails and your company email domains), are excluded. default `false` |
312
326
  | `headers.X-Org-Id` | `string \| null` | no | |
313
327
 
314
328
  **Returns** `MarketingResponse`: the envelope `{ data: Record<string, unknown> | Array<unknown>, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
@@ -356,6 +370,8 @@ This is the key differentiator: connecting web behavior to outbound outcomes.
356
370
  |---|---|---|---|
357
371
  | `query.days` | `integer` | no | Number of days to analyze default `30` |
358
372
  | `query.write_key` | `string \| null` | no | Comma-separated public keys to filter by |
373
+ | `query.include_bots` | `boolean` | no | Count bot and crawler traffic too. Off by default: page views from self-identified crawlers, headless browsers, HTTP libraries and datacenter/cloud networks are excluded. Set true for the raw, unfiltered counts these reports returned before the filter existed. default `false` |
374
+ | `query.include_internal` | `boolean` | no | Count internal traffic too. Off by default: page views on the graph8 app (app.graph8.com) and local development hosts, and browsers identified as your own team members (member emails and your company email domains), are excluded. default `false` |
359
375
  | `headers.X-Org-Id` | `string \| null` | no | |
360
376
 
361
377
  **Returns** `MarketingResponse`: the envelope `{ data: Record<string, unknown> | Array<unknown>, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
@@ -400,6 +416,8 @@ See the SITE FILTER SCOPE block in `queries/outbound_bridge.py`.
400
416
  |---|---|---|---|
401
417
  | `query.days` | `integer` | no | Number of days to analyze default `30` |
402
418
  | `query.write_key` | `string \| null` | no | Comma-separated public keys to filter by |
419
+ | `query.include_bots` | `boolean` | no | Count bot and crawler traffic too. Off by default: page views from self-identified crawlers, headless browsers, HTTP libraries and datacenter/cloud networks are excluded. Set true for the raw, unfiltered counts these reports returned before the filter existed. default `false` |
420
+ | `query.include_internal` | `boolean` | no | Count internal traffic too. Off by default: page views on the graph8 app (app.graph8.com) and local development hosts, and browsers identified as your own team members (member emails and your company email domains), are excluded. default `false` |
403
421
  | `headers.X-Org-Id` | `string \| null` | no | |
404
422
 
405
423
  **Returns** `MarketingResponse`: the envelope `{ data: Record<string, unknown> | Array<unknown>, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
@@ -441,6 +459,8 @@ Use this to identify which web behaviors predict outbound success.
441
459
  | `query.days` | `integer` | no | Number of days to analyze default `30` |
442
460
  | `query.limit` | `integer` | no | Number of sources to return default `10` |
443
461
  | `query.write_key` | `string \| null` | no | Comma-separated public keys to filter by |
462
+ | `query.include_bots` | `boolean` | no | Count bot and crawler traffic too. Off by default: page views from self-identified crawlers, headless browsers, HTTP libraries and datacenter/cloud networks are excluded. Set true for the raw, unfiltered counts these reports returned before the filter existed. default `false` |
463
+ | `query.include_internal` | `boolean` | no | Count internal traffic too. Off by default: page views on the graph8 app (app.graph8.com) and local development hosts, and browsers identified as your own team members (member emails and your company email domains), are excluded. default `false` |
444
464
  | `headers.X-Org-Id` | `string \| null` | no | |
445
465
 
446
466
  **Returns** `MarketingResponse`: the envelope `{ data: Record<string, unknown> | Array<unknown>, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
@@ -2971,10 +2971,16 @@ export interface PaginationMeta {
2971
2971
  limit: number;
2972
2972
  /** 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. */
2973
2973
  next_cursor?: string | null;
2974
+ /** 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. */
2975
+ notes?: Array<string> | null;
2974
2976
  /** Current page number (1-indexed) */
2975
2977
  page: number;
2976
2978
  /** Total number of items */
2977
2979
  total: number;
2980
+ /** 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. */
2981
+ total_available?: number | null;
2982
+ /** 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. */
2983
+ total_is_lower_bound?: boolean | null;
2978
2984
  }
2979
2985
 
2980
2986
  export interface PlanTerms {
package/docs/api/mcp.d.ts CHANGED
@@ -62,8 +62,14 @@ export interface PaginationMeta {
62
62
  limit: number;
63
63
  /** 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. */
64
64
  next_cursor?: string | null;
65
+ /** 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. */
66
+ notes?: Array<string> | null;
65
67
  /** Current page number (1-indexed) */
66
68
  page: number;
67
69
  /** Total number of items */
68
70
  total: number;
71
+ /** 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. */
72
+ total_available?: number | null;
73
+ /** 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. */
74
+ total_is_lower_bound?: boolean | null;
69
75
  }
package/docs/api/me.d.ts CHANGED
@@ -47,8 +47,14 @@ export interface PaginationMeta {
47
47
  limit: number;
48
48
  /** 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. */
49
49
  next_cursor?: string | null;
50
+ /** 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. */
51
+ notes?: Array<string> | null;
50
52
  /** Current page number (1-indexed) */
51
53
  page: number;
52
54
  /** Total number of items */
53
55
  total: number;
56
+ /** 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. */
57
+ total_available?: number | null;
58
+ /** 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. */
59
+ total_is_lower_bound?: boolean | null;
54
60
  }
@@ -532,8 +532,14 @@ export interface PaginationMeta {
532
532
  limit: number;
533
533
  /** 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. */
534
534
  next_cursor?: string | null;
535
+ /** 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. */
536
+ notes?: Array<string> | null;
535
537
  /** Current page number (1-indexed) */
536
538
  page: number;
537
539
  /** Total number of items */
538
540
  total: number;
541
+ /** 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. */
542
+ total_available?: number | null;
543
+ /** 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. */
544
+ total_is_lower_bound?: boolean | null;
539
545
  }
@@ -1422,10 +1422,16 @@ export interface PaginationMeta {
1422
1422
  limit: number;
1423
1423
  /** 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. */
1424
1424
  next_cursor?: string | null;
1425
+ /** 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. */
1426
+ notes?: Array<string> | null;
1425
1427
  /** Current page number (1-indexed) */
1426
1428
  page: number;
1427
1429
  /** Total number of items */
1428
1430
  total: number;
1431
+ /** 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. */
1432
+ total_available?: number | null;
1433
+ /** 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. */
1434
+ total_is_lower_bound?: boolean | null;
1429
1435
  }
1430
1436
 
1431
1437
  /** Rewrite ONE element with an AI instruction. THIS SPENDS AI CREDIT. */
@@ -483,10 +483,16 @@ export interface PaginationMeta {
483
483
  limit: number;
484
484
  /** 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. */
485
485
  next_cursor?: string | null;
486
+ /** 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. */
487
+ notes?: Array<string> | null;
486
488
  /** Current page number (1-indexed) */
487
489
  page: number;
488
490
  /** Total number of items */
489
491
  total: number;
492
+ /** 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. */
493
+ total_available?: number | null;
494
+ /** 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. */
495
+ total_is_lower_bound?: boolean | null;
490
496
  }
491
497
 
492
498
  /** Mirrors `GlobalNoteCreateRequest`. */
@@ -87,8 +87,14 @@ export interface PaginationMeta {
87
87
  limit: number;
88
88
  /** 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. */
89
89
  next_cursor?: string | null;
90
+ /** 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. */
91
+ notes?: Array<string> | null;
90
92
  /** Current page number (1-indexed) */
91
93
  page: number;
92
94
  /** Total number of items */
93
95
  total: number;
96
+ /** 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. */
97
+ total_available?: number | null;
98
+ /** 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. */
99
+ total_is_lower_bound?: boolean | null;
94
100
  }
@@ -527,10 +527,16 @@ export interface PaginationMeta {
527
527
  limit: number;
528
528
  /** 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. */
529
529
  next_cursor?: string | null;
530
+ /** 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. */
531
+ notes?: Array<string> | null;
530
532
  /** Current page number (1-indexed) */
531
533
  page: number;
532
534
  /** Total number of items */
533
535
  total: number;
536
+ /** 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. */
537
+ total_available?: number | null;
538
+ /** 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. */
539
+ total_is_lower_bound?: boolean | null;
534
540
  }
535
541
 
536
542
  /**
@@ -227,8 +227,14 @@ export interface PaginationMeta {
227
227
  limit: number;
228
228
  /** 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. */
229
229
  next_cursor?: string | null;
230
+ /** 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. */
231
+ notes?: Array<string> | null;
230
232
  /** Current page number (1-indexed) */
231
233
  page: number;
232
234
  /** Total number of items */
233
235
  total: number;
236
+ /** 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. */
237
+ total_available?: number | null;
238
+ /** 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. */
239
+ total_is_lower_bound?: boolean | null;
234
240
  }
package/docs/api/ops.d.ts CHANGED
@@ -292,8 +292,14 @@ export interface PaginationMeta {
292
292
  limit: number;
293
293
  /** 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. */
294
294
  next_cursor?: string | null;
295
+ /** 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. */
296
+ notes?: Array<string> | null;
295
297
  /** Current page number (1-indexed) */
296
298
  page: number;
297
299
  /** Total number of items */
298
300
  total: number;
301
+ /** 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. */
302
+ total_available?: number | null;
303
+ /** 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. */
304
+ total_is_lower_bound?: boolean | null;
299
305
  }
@@ -359,10 +359,16 @@ export interface PaginationMeta {
359
359
  limit: number;
360
360
  /** 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. */
361
361
  next_cursor?: string | null;
362
+ /** 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. */
363
+ notes?: Array<string> | null;
362
364
  /** Current page number (1-indexed) */
363
365
  page: number;
364
366
  /** Total number of items */
365
367
  total: number;
368
+ /** 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. */
369
+ total_available?: number | null;
370
+ /** 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. */
371
+ total_is_lower_bound?: boolean | null;
366
372
  }
367
373
 
368
374
  export interface RepLimitsOverrideRequest {
@@ -177,8 +177,14 @@ export interface PaginationMeta {
177
177
  limit: number;
178
178
  /** 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. */
179
179
  next_cursor?: string | null;
180
+ /** 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. */
181
+ notes?: Array<string> | null;
180
182
  /** Current page number (1-indexed) */
181
183
  page: number;
182
184
  /** Total number of items */
183
185
  total: number;
186
+ /** 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. */
187
+ total_available?: number | null;
188
+ /** 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. */
189
+ total_is_lower_bound?: boolean | null;
184
190
  }
@@ -578,10 +578,16 @@ export interface PaginationMeta {
578
578
  limit: number;
579
579
  /** 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. */
580
580
  next_cursor?: string | null;
581
+ /** 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. */
582
+ notes?: Array<string> | null;
581
583
  /** Current page number (1-indexed) */
582
584
  page: number;
583
585
  /** Total number of items */
584
586
  total: number;
587
+ /** 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. */
588
+ total_available?: number | null;
589
+ /** 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. */
590
+ total_is_lower_bound?: boolean | null;
585
591
  }
586
592
 
587
593
  /**
@@ -303,10 +303,16 @@ export interface PaginationMeta {
303
303
  limit: number;
304
304
  /** 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. */
305
305
  next_cursor?: string | null;
306
+ /** 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. */
307
+ notes?: Array<string> | null;
306
308
  /** Current page number (1-indexed) */
307
309
  page: number;
308
310
  /** Total number of items */
309
311
  total: number;
312
+ /** 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. */
313
+ total_available?: number | null;
314
+ /** 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. */
315
+ total_is_lower_bound?: boolean | null;
310
316
  }
311
317
 
312
318
  /** The org's A2P brand and campaign registration state. */
@@ -248,10 +248,16 @@ export interface PaginationMeta {
248
248
  limit: number;
249
249
  /** 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. */
250
250
  next_cursor?: string | null;
251
+ /** 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. */
252
+ notes?: Array<string> | null;
251
253
  /** Current page number (1-indexed) */
252
254
  page: number;
253
255
  /** Total number of items */
254
256
  total: number;
257
+ /** 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. */
258
+ total_available?: number | null;
259
+ /** 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. */
260
+ total_is_lower_bound?: boolean | null;
255
261
  }
256
262
 
257
263
  /**
@@ -327,10 +327,16 @@ export interface PaginationMeta {
327
327
  limit: number;
328
328
  /** 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. */
329
329
  next_cursor?: string | null;
330
+ /** 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. */
331
+ notes?: Array<string> | null;
330
332
  /** Current page number (1-indexed) */
331
333
  page: number;
332
334
  /** Total number of items */
333
335
  total: number;
336
+ /** 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. */
337
+ total_available?: number | null;
338
+ /** 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. */
339
+ total_is_lower_bound?: boolean | null;
334
340
  }
335
341
 
336
342
  /** A lifecycle action on many generated pages (or all, for the deploy actions). */
@@ -832,10 +832,16 @@ export interface PaginationMeta {
832
832
  limit: number;
833
833
  /** 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. */
834
834
  next_cursor?: string | null;
835
+ /** 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. */
836
+ notes?: Array<string> | null;
835
837
  /** Current page number (1-indexed) */
836
838
  page: number;
837
839
  /** Total number of items */
838
840
  total: number;
841
+ /** 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. */
842
+ total_available?: number | null;
843
+ /** 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. */
844
+ total_is_lower_bound?: boolean | null;
839
845
  }
840
846
 
841
847
  /** A sending domain owned (or connected) by the org. */
@@ -112,10 +112,16 @@ export interface PaginationMeta {
112
112
  limit: number;
113
113
  /** 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. */
114
114
  next_cursor?: string | null;
115
+ /** 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. */
116
+ notes?: Array<string> | null;
115
117
  /** Current page number (1-indexed) */
116
118
  page: number;
117
119
  /** Total number of items */
118
120
  total: number;
121
+ /** 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. */
122
+ total_available?: number | null;
123
+ /** 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. */
124
+ total_is_lower_bound?: boolean | null;
119
125
  }
120
126
 
121
127
  /** Usage figures per provider, or the result of a refresh/sync. */
@@ -48,10 +48,16 @@ export interface PaginationMeta {
48
48
  limit: number;
49
49
  /** 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. */
50
50
  next_cursor?: string | null;
51
+ /** 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. */
52
+ notes?: Array<string> | null;
51
53
  /** Current page number (1-indexed) */
52
54
  page: number;
53
55
  /** Total number of items */
54
56
  total: number;
57
+ /** 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. */
58
+ total_available?: number | null;
59
+ /** 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. */
60
+ total_is_lower_bound?: boolean | null;
55
61
  }
56
62
 
57
63
  export interface PublicEnrichRequest {
@@ -48,10 +48,16 @@ export interface PaginationMeta {
48
48
  limit: number;
49
49
  /** 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. */
50
50
  next_cursor?: string | null;
51
+ /** 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. */
52
+ notes?: Array<string> | null;
51
53
  /** Current page number (1-indexed) */
52
54
  page: number;
53
55
  /** Total number of items */
54
56
  total: number;
57
+ /** 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. */
58
+ total_available?: number | null;
59
+ /** 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. */
60
+ total_is_lower_bound?: boolean | null;
55
61
  }
56
62
 
57
63
  export interface PublicCopilotRequest {
@@ -59,8 +59,14 @@ export interface PaginationMeta {
59
59
  limit: number;
60
60
  /** 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. */
61
61
  next_cursor?: string | null;
62
+ /** 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. */
63
+ notes?: Array<string> | null;
62
64
  /** Current page number (1-indexed) */
63
65
  page: number;
64
66
  /** Total number of items */
65
67
  total: number;
68
+ /** 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. */
69
+ total_available?: number | null;
70
+ /** 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. */
71
+ total_is_lower_bound?: boolean | null;
66
72
  }
@@ -74,10 +74,16 @@ export interface PaginationMeta {
74
74
  limit: number;
75
75
  /** 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. */
76
76
  next_cursor?: string | null;
77
+ /** 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. */
78
+ notes?: Array<string> | null;
77
79
  /** Current page number (1-indexed) */
78
80
  page: number;
79
81
  /** Total number of items */
80
82
  total: number;
83
+ /** 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. */
84
+ total_available?: number | null;
85
+ /** 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. */
86
+ total_is_lower_bound?: boolean | null;
81
87
  }
82
88
 
83
89
  export interface VisitorCompanyResponse {
@@ -1171,10 +1171,16 @@ export interface PaginationMeta {
1171
1171
  limit: number;
1172
1172
  /** 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. */
1173
1173
  next_cursor?: string | null;
1174
+ /** 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. */
1175
+ notes?: Array<string> | null;
1174
1176
  /** Current page number (1-indexed) */
1175
1177
  page: number;
1176
1178
  /** Total number of items */
1177
1179
  total: number;
1180
+ /** 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. */
1181
+ total_available?: number | null;
1182
+ /** 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. */
1183
+ total_is_lower_bound?: boolean | null;
1178
1184
  }
1179
1185
 
1180
1186
  /**
@@ -182,10 +182,16 @@ export interface PaginationMeta {
182
182
  limit: number;
183
183
  /** 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. */
184
184
  next_cursor?: string | null;
185
+ /** 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. */
186
+ notes?: Array<string> | null;
185
187
  /** Current page number (1-indexed) */
186
188
  page: number;
187
189
  /** Total number of items */
188
190
  total: number;
191
+ /** 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. */
192
+ total_available?: number | null;
193
+ /** 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. */
194
+ total_is_lower_bound?: boolean | null;
189
195
  }
190
196
 
191
197
  export interface RadarCaseFileActionRequest {
@@ -125,10 +125,16 @@ export interface PaginationMeta {
125
125
  limit: number;
126
126
  /** 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. */
127
127
  next_cursor?: string | null;
128
+ /** 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. */
129
+ notes?: Array<string> | null;
128
130
  /** Current page number (1-indexed) */
129
131
  page: number;
130
132
  /** Total number of items */
131
133
  total: number;
134
+ /** 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. */
135
+ total_available?: number | null;
136
+ /** 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. */
137
+ total_is_lower_bound?: boolean | null;
132
138
  }
133
139
 
134
140
  export interface RecordRoleAssignRequest {
@@ -125,10 +125,16 @@ export interface PaginationMeta {
125
125
  limit: number;
126
126
  /** 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. */
127
127
  next_cursor?: string | null;
128
+ /** 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. */
129
+ notes?: Array<string> | null;
128
130
  /** Current page number (1-indexed) */
129
131
  page: number;
130
132
  /** Total number of items */
131
133
  total: number;
134
+ /** 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. */
135
+ total_available?: number | null;
136
+ /** 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. */
137
+ total_is_lower_bound?: boolean | null;
132
138
  }
133
139
 
134
140
  export interface RepoResponse {
@@ -265,10 +265,16 @@ export interface PaginationMeta {
265
265
  limit: number;
266
266
  /** 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. */
267
267
  next_cursor?: string | null;
268
+ /** 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. */
269
+ notes?: Array<string> | null;
268
270
  /** Current page number (1-indexed) */
269
271
  page: number;
270
272
  /** Total number of items */
271
273
  total: number;
274
+ /** 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. */
275
+ total_available?: number | null;
276
+ /** 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. */
277
+ total_is_lower_bound?: boolean | null;
272
278
  }
273
279
 
274
280
  /** Re-run one failed report. SPENDS CREDIT. */
@@ -318,10 +318,16 @@ export interface PaginationMeta {
318
318
  limit: number;
319
319
  /** 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. */
320
320
  next_cursor?: string | null;
321
+ /** 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. */
322
+ notes?: Array<string> | null;
321
323
  /** Current page number (1-indexed) */
322
324
  page: number;
323
325
  /** Total number of items */
324
326
  total: number;
327
+ /** 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. */
328
+ total_available?: number | null;
329
+ /** 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. */
330
+ total_is_lower_bound?: boolean | null;
325
331
  }
326
332
 
327
333
  /**
@@ -137,10 +137,16 @@ export interface PaginationMeta {
137
137
  limit: number;
138
138
  /** 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. */
139
139
  next_cursor?: string | null;
140
+ /** 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. */
141
+ notes?: Array<string> | null;
140
142
  /** Current page number (1-indexed) */
141
143
  page: number;
142
144
  /** Total number of items */
143
145
  total: number;
146
+ /** 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. */
147
+ total_available?: number | null;
148
+ /** 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. */
149
+ total_is_lower_bound?: boolean | null;
144
150
  }
145
151
 
146
152
  /** A dashboard or rollup, as the app computes it. */