@graph8/sdk 0.251.0 → 0.262.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 (350) hide show
  1. package/README.md +9 -2
  2. package/dist/cli.js +216 -0
  3. package/dist/index.d.mts +105 -7
  4. package/dist/index.d.ts +105 -7
  5. package/dist/index.js +44 -3
  6. package/dist/index.js.map +1 -1
  7. package/dist/index.mjs +44 -3
  8. package/dist/index.mjs.map +1 -1
  9. package/dist/react.d.mts +103 -7
  10. package/dist/react.d.ts +103 -7
  11. package/dist/react.js +62 -11
  12. package/dist/react.js.map +1 -1
  13. package/dist/react.mjs +53 -12
  14. package/dist/react.mjs.map +1 -1
  15. package/dist/types/README.md +7 -0
  16. package/dist/types/agency.d.ts +20 -0
  17. package/dist/types/agentSetup.d.ts +57 -0
  18. package/dist/types/api.d.ts +127 -0
  19. package/dist/types/appClient.d.ts +99 -0
  20. package/dist/types/appPlatform.d.ts +269 -0
  21. package/dist/types/appTokens.d.ts +125 -0
  22. package/dist/types/apps.d.ts +130 -0
  23. package/dist/types/audiences.d.ts +88 -0
  24. package/dist/types/calendar.d.ts +55 -0
  25. package/dist/types/campaigns.d.ts +61 -0
  26. package/dist/types/chat.d.ts +35 -0
  27. package/dist/types/cli.d.ts +14 -0
  28. package/dist/types/companies.d.ts +123 -0
  29. package/dist/types/contacts.d.ts +200 -0
  30. package/dist/types/copilot.d.ts +31 -0
  31. package/dist/types/core.d.ts +1052 -0
  32. package/dist/types/deals.d.ts +215 -0
  33. package/dist/types/enrich.d.ts +51 -0
  34. package/dist/types/fields.d.ts +84 -0
  35. package/dist/types/forms.d.ts +16 -0
  36. package/dist/types/http.d.ts +141 -0
  37. package/dist/types/inbox.d.ts +123 -0
  38. package/dist/types/index.d.ts +63 -0
  39. package/dist/types/intent.d.ts +196 -0
  40. package/dist/types/lists.d.ts +44 -0
  41. package/dist/types/mailboxes.d.ts +240 -0
  42. package/dist/types/marketplace.d.ts +62 -0
  43. package/dist/types/meetings.d.ts +70 -0
  44. package/dist/types/newsletter.d.ts +212 -0
  45. package/dist/types/notes.d.ts +57 -0
  46. package/dist/types/objects.d.ts +281 -0
  47. package/dist/types/pipelines.d.ts +135 -0
  48. package/dist/types/quotes.d.ts +143 -0
  49. package/dist/types/react.d.ts +978 -0
  50. package/dist/types/search.d.ts +99 -0
  51. package/dist/types/sequences.d.ts +255 -0
  52. package/dist/types/signals.d.ts +28 -0
  53. package/dist/types/skills.d.ts +176 -0
  54. package/dist/types/snippet.d.ts +24 -0
  55. package/dist/types/studio.d.ts +161 -0
  56. package/dist/types/tasks.d.ts +101 -0
  57. package/dist/types/types.d.ts +45 -0
  58. package/dist/types/utils.d.ts +21 -0
  59. package/dist/types/version.d.ts +10 -0
  60. package/dist/types/visitors.d.ts +29 -0
  61. package/dist/types/voice.d.ts +304 -0
  62. package/dist/types/webhooks.d.ts +71 -0
  63. package/dist/types/workflows.d.ts +229 -0
  64. package/docs/agents.md +748 -0
  65. package/docs/api/README.md +165 -0
  66. package/docs/api/accounts.d.ts +396 -0
  67. package/docs/api/accounts.md +644 -0
  68. package/docs/api/adCampaigns.d.ts +707 -0
  69. package/docs/api/adCampaigns.md +1091 -0
  70. package/docs/api/adCreatives.d.ts +996 -0
  71. package/docs/api/adCreatives.md +1708 -0
  72. package/docs/api/agency.d.ts +556 -0
  73. package/docs/api/agency.md +845 -0
  74. package/docs/api/agent.d.ts +330 -0
  75. package/docs/api/agent.md +514 -0
  76. package/docs/api/agents.d.ts +1622 -0
  77. package/docs/api/agents.md +2860 -0
  78. package/docs/api/aiInbox.d.ts +1984 -0
  79. package/docs/api/aiInbox.md +3490 -0
  80. package/docs/api/analytics.d.ts +1273 -0
  81. package/docs/api/analytics.md +2095 -0
  82. package/docs/api/apiKeys.d.ts +252 -0
  83. package/docs/api/apiKeys.md +318 -0
  84. package/docs/api/appDeployments.d.ts +236 -0
  85. package/docs/api/appDeployments.md +471 -0
  86. package/docs/api/appDomains.d.ts +171 -0
  87. package/docs/api/appDomains.md +281 -0
  88. package/docs/api/appLogs.d.ts +120 -0
  89. package/docs/api/appLogs.md +159 -0
  90. package/docs/api/appObjects.d.ts +415 -0
  91. package/docs/api/appObjects.md +568 -0
  92. package/docs/api/appPages.d.ts +557 -0
  93. package/docs/api/appPages.md +796 -0
  94. package/docs/api/appPlatformTokens.d.ts +123 -0
  95. package/docs/api/appPlatformTokens.md +172 -0
  96. package/docs/api/appointments.d.ts +2361 -0
  97. package/docs/api/appointments.md +3917 -0
  98. package/docs/api/apps.d.ts +822 -0
  99. package/docs/api/apps.md +1342 -0
  100. package/docs/api/assertUpsert.d.ts +286 -0
  101. package/docs/api/assertUpsert.md +370 -0
  102. package/docs/api/audienceSyncs.d.ts +259 -0
  103. package/docs/api/audienceSyncs.md +395 -0
  104. package/docs/api/brandKit.d.ts +686 -0
  105. package/docs/api/brandKit.md +1133 -0
  106. package/docs/api/bugReports.d.ts +181 -0
  107. package/docs/api/bugReports.md +268 -0
  108. package/docs/api/by-path.md +3260 -0
  109. package/docs/api/calendarInvites.d.ts +117 -0
  110. package/docs/api/calendarInvites.md +148 -0
  111. package/docs/api/campaignWorkflows.d.ts +152 -0
  112. package/docs/api/campaignWorkflows.md +200 -0
  113. package/docs/api/campaigns.d.ts +721 -0
  114. package/docs/api/campaigns.md +1236 -0
  115. package/docs/api/channels.d.ts +171 -0
  116. package/docs/api/channels.md +235 -0
  117. package/docs/api/cliCampaigns.d.ts +205 -0
  118. package/docs/api/cliCampaigns.md +256 -0
  119. package/docs/api/cliPipelines.d.ts +324 -0
  120. package/docs/api/cliPipelines.md +562 -0
  121. package/docs/api/clickHouse.d.ts +115 -0
  122. package/docs/api/clickHouse.md +138 -0
  123. package/docs/api/companies.d.ts +1636 -0
  124. package/docs/api/companies.md +2211 -0
  125. package/docs/api/companyIntelligence.d.ts +299 -0
  126. package/docs/api/companyIntelligence.md +488 -0
  127. package/docs/api/contacts.d.ts +2173 -0
  128. package/docs/api/contacts.md +3143 -0
  129. package/docs/api/content.d.ts +968 -0
  130. package/docs/api/content.md +1667 -0
  131. package/docs/api/contentGridSkills.d.ts +177 -0
  132. package/docs/api/contentGridSkills.md +271 -0
  133. package/docs/api/copilot.d.ts +1017 -0
  134. package/docs/api/copilot.md +1765 -0
  135. package/docs/api/crmSyncs.d.ts +215 -0
  136. package/docs/api/crmSyncs.md +301 -0
  137. package/docs/api/customerSuccess.d.ts +491 -0
  138. package/docs/api/customerSuccess.md +776 -0
  139. package/docs/api/deals.d.ts +1697 -0
  140. package/docs/api/deals.md +2436 -0
  141. package/docs/api/deliverability.d.ts +418 -0
  142. package/docs/api/deliverability.md +677 -0
  143. package/docs/api/desk.d.ts +1765 -0
  144. package/docs/api/desk.md +3007 -0
  145. package/docs/api/dialer.d.ts +1185 -0
  146. package/docs/api/dialer.md +2166 -0
  147. package/docs/api/dialerAnalytics.d.ts +187 -0
  148. package/docs/api/dialerAnalytics.md +257 -0
  149. package/docs/api/documents.d.ts +895 -0
  150. package/docs/api/documents.md +1440 -0
  151. package/docs/api/duplicates.d.ts +195 -0
  152. package/docs/api/duplicates.md +315 -0
  153. package/docs/api/eSign.d.ts +38 -0
  154. package/docs/api/eSign.md +54 -0
  155. package/docs/api/eSignature.d.ts +242 -0
  156. package/docs/api/eSignature.md +341 -0
  157. package/docs/api/enrichment.d.ts +3207 -0
  158. package/docs/api/enrichment.md +5225 -0
  159. package/docs/api/events.d.ts +115 -0
  160. package/docs/api/events.md +105 -0
  161. package/docs/api/fields.d.ts +482 -0
  162. package/docs/api/fields.md +566 -0
  163. package/docs/api/forms.d.ts +1012 -0
  164. package/docs/api/forms.md +1542 -0
  165. package/docs/api/gtmCampaigns.d.ts +662 -0
  166. package/docs/api/gtmCampaigns.md +1044 -0
  167. package/docs/api/gtmContext.d.ts +1187 -0
  168. package/docs/api/gtmContext.md +2112 -0
  169. package/docs/api/gtmDeliverability.d.ts +60 -0
  170. package/docs/api/gtmDeliverability.md +63 -0
  171. package/docs/api/gtmKnowledgeBase.d.ts +76 -0
  172. package/docs/api/gtmKnowledgeBase.md +91 -0
  173. package/docs/api/gtmLaunchHelpers.d.ts +123 -0
  174. package/docs/api/gtmLaunchHelpers.md +148 -0
  175. package/docs/api/gtmLibrary.d.ts +448 -0
  176. package/docs/api/gtmLibrary.md +780 -0
  177. package/docs/api/health.d.ts +39 -0
  178. package/docs/api/health.md +58 -0
  179. package/docs/api/imageLibrary.d.ts +341 -0
  180. package/docs/api/imageLibrary.md +569 -0
  181. package/docs/api/imports.d.ts +157 -0
  182. package/docs/api/imports.md +174 -0
  183. package/docs/api/inbox.d.ts +709 -0
  184. package/docs/api/inbox.md +1067 -0
  185. package/docs/api/install.d.ts +213 -0
  186. package/docs/api/install.md +317 -0
  187. package/docs/api/installedApps.d.ts +131 -0
  188. package/docs/api/installedApps.md +241 -0
  189. package/docs/api/integrationStatus.d.ts +142 -0
  190. package/docs/api/integrationStatus.md +205 -0
  191. package/docs/api/integrations.d.ts +2327 -0
  192. package/docs/api/integrations.md +3791 -0
  193. package/docs/api/intent.d.ts +482 -0
  194. package/docs/api/intent.md +858 -0
  195. package/docs/api/knowledge.d.ts +501 -0
  196. package/docs/api/knowledge.md +843 -0
  197. package/docs/api/knowledgeBase.d.ts +84 -0
  198. package/docs/api/knowledgeBase.md +96 -0
  199. package/docs/api/landingPages.d.ts +1411 -0
  200. package/docs/api/landingPages.md +2488 -0
  201. package/docs/api/leads.d.ts +133 -0
  202. package/docs/api/leads.md +180 -0
  203. package/docs/api/library.d.ts +217 -0
  204. package/docs/api/library.md +338 -0
  205. package/docs/api/linkedIn.d.ts +227 -0
  206. package/docs/api/linkedIn.md +289 -0
  207. package/docs/api/linkedInOutreach.d.ts +727 -0
  208. package/docs/api/linkedInOutreach.md +990 -0
  209. package/docs/api/lists.d.ts +1106 -0
  210. package/docs/api/lists.md +1609 -0
  211. package/docs/api/logs.d.ts +71 -0
  212. package/docs/api/logs.md +70 -0
  213. package/docs/api/mailboxes.d.ts +1050 -0
  214. package/docs/api/mailboxes.md +1690 -0
  215. package/docs/api/marketingIntelligence.d.ts +256 -0
  216. package/docs/api/marketingIntelligence.md +454 -0
  217. package/docs/api/marketplace.d.ts +3173 -0
  218. package/docs/api/marketplace.md +5953 -0
  219. package/docs/api/mcp.d.ts +69 -0
  220. package/docs/api/mcp.md +69 -0
  221. package/docs/api/me.d.ts +54 -0
  222. package/docs/api/me.md +56 -0
  223. package/docs/api/meetings.d.ts +539 -0
  224. package/docs/api/meetings.md +747 -0
  225. package/docs/api/newsletter.d.ts +1613 -0
  226. package/docs/api/newsletter.md +2746 -0
  227. package/docs/api/notes.d.ts +517 -0
  228. package/docs/api/notes.md +888 -0
  229. package/docs/api/notifications.d.ts +94 -0
  230. package/docs/api/notifications.md +105 -0
  231. package/docs/api/objects.d.ts +621 -0
  232. package/docs/api/objects.md +1098 -0
  233. package/docs/api/openSearch.d.ts +234 -0
  234. package/docs/api/openSearch.md +297 -0
  235. package/docs/api/ops.d.ts +299 -0
  236. package/docs/api/ops.md +339 -0
  237. package/docs/api/orgGovernance.d.ts +393 -0
  238. package/docs/api/orgGovernance.md +623 -0
  239. package/docs/api/orgVideos.d.ts +184 -0
  240. package/docs/api/orgVideos.md +252 -0
  241. package/docs/api/organizationSettings.d.ts +626 -0
  242. package/docs/api/organizationSettings.md +911 -0
  243. package/docs/api/phoneNumbers.d.ts +484 -0
  244. package/docs/api/phoneNumbers.md +777 -0
  245. package/docs/api/profile.d.ts +329 -0
  246. package/docs/api/profile.md +540 -0
  247. package/docs/api/programmaticPages.d.ts +400 -0
  248. package/docs/api/programmaticPages.md +626 -0
  249. package/docs/api/providerDomains.d.ts +866 -0
  250. package/docs/api/providerDomains.md +1446 -0
  251. package/docs/api/providerUsage.d.ts +129 -0
  252. package/docs/api/providerUsage.md +186 -0
  253. package/docs/api/public.d.ts +69 -0
  254. package/docs/api/public.md +78 -0
  255. package/docs/api/publicCopilot.d.ts +67 -0
  256. package/docs/api/publicCopilot.md +80 -0
  257. package/docs/api/publicSignals.d.ts +66 -0
  258. package/docs/api/publicSignals.md +71 -0
  259. package/docs/api/publicVisitors.d.ts +97 -0
  260. package/docs/api/publicVisitors.md +118 -0
  261. package/docs/api/quotes.d.ts +1564 -0
  262. package/docs/api/quotes.md +2553 -0
  263. package/docs/api/radar.d.ts +808 -0
  264. package/docs/api/radar.md +1431 -0
  265. package/docs/api/radarReports.d.ts +208 -0
  266. package/docs/api/radarReports.md +306 -0
  267. package/docs/api/recordRoles.d.ts +143 -0
  268. package/docs/api/recordRoles.md +175 -0
  269. package/docs/api/repos.d.ts +146 -0
  270. package/docs/api/repos.md +211 -0
  271. package/docs/api/research.d.ts +295 -0
  272. package/docs/api/research.md +534 -0
  273. package/docs/api/revenue.d.ts +402 -0
  274. package/docs/api/revenue.md +608 -0
  275. package/docs/api/revenueAnalytics.d.ts +147 -0
  276. package/docs/api/revenueAnalytics.md +212 -0
  277. package/docs/api/revenueLifecycle.d.ts +207 -0
  278. package/docs/api/revenueLifecycle.md +274 -0
  279. package/docs/api/revenueRecords.d.ts +372 -0
  280. package/docs/api/revenueRecords.md +563 -0
  281. package/docs/api/roles.d.ts +431 -0
  282. package/docs/api/roles.md +812 -0
  283. package/docs/api/salesCoach.d.ts +877 -0
  284. package/docs/api/salesCoach.md +1540 -0
  285. package/docs/api/sandbox.d.ts +210 -0
  286. package/docs/api/sandbox.md +380 -0
  287. package/docs/api/scans.d.ts +104 -0
  288. package/docs/api/scans.md +136 -0
  289. package/docs/api/scheduleBuy.d.ts +293 -0
  290. package/docs/api/scheduleBuy.md +431 -0
  291. package/docs/api/scraping.d.ts +266 -0
  292. package/docs/api/scraping.md +383 -0
  293. package/docs/api/sdrAnalytics.d.ts +138 -0
  294. package/docs/api/sdrAnalytics.md +246 -0
  295. package/docs/api/search.d.ts +598 -0
  296. package/docs/api/search.md +866 -0
  297. package/docs/api/seo.d.ts +447 -0
  298. package/docs/api/seo.md +660 -0
  299. package/docs/api/sequenceLifecycle.d.ts +439 -0
  300. package/docs/api/sequenceLifecycle.md +513 -0
  301. package/docs/api/sequences.d.ts +1936 -0
  302. package/docs/api/sequences.md +3232 -0
  303. package/docs/api/settings.d.ts +448 -0
  304. package/docs/api/settings.md +731 -0
  305. package/docs/api/signals.d.ts +1441 -0
  306. package/docs/api/signals.md +2526 -0
  307. package/docs/api/signatures.d.ts +719 -0
  308. package/docs/api/signatures.md +1247 -0
  309. package/docs/api/skills.d.ts +230 -0
  310. package/docs/api/skills.md +466 -0
  311. package/docs/api/snippet.d.ts +85 -0
  312. package/docs/api/snippet.md +106 -0
  313. package/docs/api/socialPublishing.d.ts +824 -0
  314. package/docs/api/socialPublishing.md +1245 -0
  315. package/docs/api/studioDocuments.d.ts +244 -0
  316. package/docs/api/studioDocuments.md +348 -0
  317. package/docs/api/support.d.ts +90 -0
  318. package/docs/api/support.md +76 -0
  319. package/docs/api/suppressions.d.ts +241 -0
  320. package/docs/api/suppressions.md +343 -0
  321. package/docs/api/surveys.d.ts +847 -0
  322. package/docs/api/surveys.md +1223 -0
  323. package/docs/api/tasks.d.ts +813 -0
  324. package/docs/api/tasks.md +1344 -0
  325. package/docs/api/teamMembers.d.ts +668 -0
  326. package/docs/api/teamMembers.md +1040 -0
  327. package/docs/api/teams.d.ts +784 -0
  328. package/docs/api/teams.md +1395 -0
  329. package/docs/api/usage.d.ts +277 -0
  330. package/docs/api/usage.md +389 -0
  331. package/docs/api/visitors.d.ts +690 -0
  332. package/docs/api/visitors.md +1075 -0
  333. package/docs/api/voice.d.ts +4661 -0
  334. package/docs/api/voice.md +7905 -0
  335. package/docs/api/webAnalytics.d.ts +964 -0
  336. package/docs/api/webAnalytics.md +1452 -0
  337. package/docs/api/webChat.d.ts +1704 -0
  338. package/docs/api/webChat.md +2048 -0
  339. package/docs/api/webhooks.d.ts +251 -0
  340. package/docs/api/webhooks.md +386 -0
  341. package/docs/api/websiteEditor.d.ts +324 -0
  342. package/docs/api/websiteEditor.md +517 -0
  343. package/docs/api/work.d.ts +2298 -0
  344. package/docs/api/work.md +3096 -0
  345. package/docs/api/workbench.d.ts +2962 -0
  346. package/docs/api/workbench.md +4884 -0
  347. package/docs/api/workflows.d.ts +1218 -0
  348. package/docs/api/workflows.md +2302 -0
  349. package/docs/sdk-clients.md +4339 -0
  350. package/package.json +10 -3
@@ -0,0 +1,2962 @@
1
+ /* Generated by sdk/js/scripts/generate-agent-docs.ts from developer-contract/openapi.json. Regenerated on every build. */
2
+
3
+ /**
4
+ * Types for `g8.api.workbench` (Workbench): 107 operations.
5
+ *
6
+ * For reading. In code, import from the package instead:
7
+ * import type { ApiInput, ApiOutput, G8Contract } from "@graph8/sdk";
8
+ * type In = ApiInput<"add_workbench_column_workbench_tables__table_id__columns_post">;
9
+ *
10
+ * Reference with examples: workbench.md
11
+ */
12
+ /* eslint-disable */
13
+
14
+ /** `g8.api.workbench.<member>` -> the operationId it calls. */
15
+ export interface WorkbenchMembers {
16
+ addWorkbenchColumn: "add_workbench_column_workbench_tables__table_id__columns_post";
17
+ addWorkbenchRow: "add_workbench_row_workbench_tables__table_id__rows_post";
18
+ bulkDeleteWorkbenchRows: "bulk_delete_workbench_rows_workbench_tables__table_id__rows_bulk_delete_post";
19
+ bulkExtractWorkbenchColumns: "bulk_extract_workbench_columns_workbench_tables__table_id__columns_bulk_extract_post";
20
+ checkWorkbenchScraperToken: "check_workbench_scraper_token_workbench_scraper_providers__provider__check_token_get";
21
+ computeWorkbenchFormula: "compute_workbench_formula_workbench_tables__table_id__columns__col_id__compute_post";
22
+ configureWorkbenchAi: "configure_workbench_ai_workbench_tables__table_id__ai_configure_post";
23
+ configureWorkbenchColumnSource: "configure_workbench_column_source_workbench_tables__table_id__columns__col_id__sources_post";
24
+ configureWorkbenchFindPeople: "configure_workbench_find_people_workbench_tables__table_id__find_people_configure_post";
25
+ createWorkbenchAiGroup: "create_workbench_ai_group_workbench_tables__table_id__ai_groups_config_post";
26
+ createWorkbenchBindings: "create_workbench_bindings_workbench_bindings_post";
27
+ createWorkbenchConnection: "create_workbench_connection_workbench_tables__table_id__connections_post";
28
+ createWorkbenchFormulaColumns: "create_workbench_formula_columns_workbench_tables__table_id__formula_columns_post";
29
+ createWorkbenchPipeline: "create_workbench_pipeline_workbench_tables__table_id__pipelines_post";
30
+ createWorkbenchTable: "create_workbench_table_workbench_tables_post";
31
+ createWorkbenchTrigger: "create_workbench_trigger_workbench_tables__table_id__triggers_post";
32
+ deleteScraperProviderConnection: "delete_scraper_provider_connection_workbench_scraper_providers__provider__connection_delete";
33
+ deleteWorkbenchAiGroup: "delete_workbench_ai_group_workbench_tables__table_id__ai_groups__group_id__delete";
34
+ deleteWorkbenchBinding: "delete_workbench_binding_workbench_bindings__binding_id__delete";
35
+ deleteWorkbenchColumn: "delete_workbench_column_workbench_tables__table_id__columns__column_id__delete";
36
+ deleteWorkbenchConnection: "delete_workbench_connection_workbench_tables__table_id__connections__connection_id__delete";
37
+ deleteWorkbenchFindPeopleConfig: "delete_workbench_find_people_config_workbench_tables__table_id__find_people__config_id__delete";
38
+ deleteWorkbenchPipeline: "delete_workbench_pipeline_workbench_tables__table_id__pipelines__pipeline_id__delete";
39
+ deleteWorkbenchSchedule: "delete_workbench_schedule_workbench_tables__table_id__schedule_delete";
40
+ deleteWorkbenchTable: "delete_workbench_table_workbench_tables__table_id__delete";
41
+ deleteWorkbenchTrigger: "delete_workbench_trigger_workbench_tables__table_id__triggers__trigger_id__delete";
42
+ discoverWorkbenchFields: "discover_workbench_fields_workbench_tables__table_id__discover_fields_post";
43
+ estimateWorkbenchProviderScraperCredits: "estimate_workbench_provider_scraper_credits_workbench_scraper_providers__provider__credit_estimate_get";
44
+ estimateWorkbenchScraperCredits: "estimate_workbench_scraper_credits_workbench_scraper_credit_estimate_get";
45
+ expandWorkbenchArray: "expand_workbench_array_workbench_tables__table_id__expand_array_post";
46
+ exportWorkbenchAiFindPeople: "export_workbench_ai_find_people_workbench_tables__table_id__ai_groups__group_id__find_people_export_post";
47
+ exportWorkbenchTable: "export_workbench_table_workbench_tables__table_id__export_post";
48
+ extractWorkbenchColumn: "extract_workbench_column_workbench_tables__table_id__columns_extract_post";
49
+ generateWorkbenchPrompt: "generate_workbench_prompt_workbench_tables__table_id__ai_generate_prompt_post";
50
+ getScraperProviderConnection: "get_scraper_provider_connection_workbench_scraper_providers__provider__connection_get";
51
+ getWorkbenchAiFindPeopleRow: "get_workbench_ai_find_people_row_workbench_tables__table_id__ai_groups__group_id__find_people_rows__source_row_id__get";
52
+ getWorkbenchAiGroup: "get_workbench_ai_group_workbench_tables__table_id__ai_groups__group_id__get";
53
+ getWorkbenchAnalytics: "get_workbench_analytics_workbench_tables__table_id__analytics_get";
54
+ getWorkbenchColumnAiConfig: "get_workbench_column_ai_config_workbench_tables__table_id__columns__col_id__ai_config_get";
55
+ getWorkbenchHistory: "get_workbench_history_workbench_tables__table_id__history_get";
56
+ getWorkbenchLockedRowCount: "get_workbench_locked_row_count_workbench_tables__table_id__locked_row_count_get";
57
+ getWorkbenchMappingSuggestion: "get_workbench_mapping_suggestion_workbench_tables__table_id__suggest_mappings__job_id__get";
58
+ getWorkbenchPipeline: "get_workbench_pipeline_workbench_tables__table_id__pipelines__pipeline_id__get";
59
+ getWorkbenchRow: "get_workbench_row_workbench_tables__table_id__rows__row_id__get";
60
+ getWorkbenchSchedule: "get_workbench_schedule_workbench_tables__table_id__schedule_get";
61
+ getWorkbenchScraperRun: "get_workbench_scraper_run_workbench_tables__table_id__scraper_runs__run_id__get";
62
+ getWorkbenchTable: "get_workbench_table_workbench_tables__table_id__get";
63
+ getWorkbenchWaterfall: "get_workbench_waterfall_workbench_tables__table_id__waterfall_configs__column_id__get";
64
+ importWorkbenchDatafile: "import_workbench_datafile_workbench_tables__table_id__import_datafile_post";
65
+ importWorkbenchFromCrm: "import_workbench_from_crm_workbench_tables__table_id__import_crm_post";
66
+ importWorkbenchFromSearch: "import_workbench_from_search_workbench_tables__table_id__import_search_post";
67
+ listWorkbenchAiPresets: "list_workbench_ai_presets_workbench_ai_presets_get";
68
+ listWorkbenchBindings: "list_workbench_bindings_workbench_bindings_get";
69
+ listWorkbenchColumnSources: "list_workbench_column_sources_workbench_tables__table_id__columns__col_id__sources_get";
70
+ listWorkbenchColumns: "list_workbench_columns_workbench_tables__table_id__columns_get";
71
+ listWorkbenchConnections: "list_workbench_connections_workbench_tables__table_id__connections_get";
72
+ listWorkbenchEnrichmentConfigs: "list_workbench_enrichment_configs_workbench_tables__table_id__enrichment_configs_get";
73
+ listWorkbenchFindPeopleConfigs: "list_workbench_find_people_configs_workbench_tables__table_id__find_people_configs_get";
74
+ listWorkbenchFindPeopleContacts: "list_workbench_find_people_contacts_workbench_tables__table_id__find_people__config_id__contacts_get";
75
+ listWorkbenchPipelines: "list_workbench_pipelines_workbench_tables__table_id__pipelines_get";
76
+ listWorkbenchRows: "list_workbench_rows_workbench_tables__table_id__rows_get";
77
+ listWorkbenchScraperPresets: "list_workbench_scraper_presets_workbench_scraper_presets_get";
78
+ listWorkbenchScraperRuns: "list_workbench_scraper_runs_workbench_tables__table_id__scraper_runs_get";
79
+ listWorkbenchSourceCredentials: "list_workbench_source_credentials_workbench_source_credentials_get";
80
+ listWorkbenchTableAiPresets: "list_workbench_table_ai_presets_workbench_tables__table_id__ai_presets_get";
81
+ listWorkbenchTables: "list_workbench_tables_workbench_tables_get";
82
+ listWorkbenchTargetFields: "list_workbench_target_fields_workbench_target_fields_get";
83
+ listWorkbenchTriggers: "list_workbench_triggers_workbench_tables__table_id__triggers_get";
84
+ mapWorkbenchColumn: "map_workbench_column_workbench_tables__table_id__columns__column_id__mapping_put";
85
+ migrateWorkbenchLegacyAiConfig: "migrate_workbench_legacy_ai_config_workbench_tables__table_id__ai_migrate_legacy_post";
86
+ pasteImportWorkbenchRows: "paste_import_workbench_rows_workbench_tables__table_id__import_paste_post";
87
+ previewWorkbenchAi: "preview_workbench_ai_workbench_tables__table_id__ai_preview_post";
88
+ previewWorkbenchResearchImport: "preview_workbench_research_import_workbench_tables__table_id__import_search_research_preview_post";
89
+ previewWorkbenchSearchImport: "preview_workbench_search_import_workbench_tables__table_id__import_search_preview_post";
90
+ queryWorkbenchRows: "query_workbench_rows_workbench_tables__table_id__rows_query_post";
91
+ quoteWorkbenchAiRun: "quote_workbench_ai_run_workbench_tables__table_id__ai_validate_credits_post";
92
+ quoteWorkbenchFormulaGeneration: "quote_workbench_formula_generation_workbench_tables__table_id__formula_columns_generate_quote_get";
93
+ quoteWorkbenchUnlock: "quote_workbench_unlock_workbench_tables__table_id__unlock_quote_post";
94
+ quoteWorkbenchWaterfallRun: "quote_workbench_waterfall_run_workbench_tables__table_id__waterfall_configs__column_id__validate_credits_post";
95
+ regenerateWorkbenchKey: "regenerate_workbench_key_workbench_tables__table_id__regenerate_key_post";
96
+ reviewWorkbenchFindPeopleCandidates: "review_workbench_find_people_candidates_workbench_tables__table_id__ai_groups__group_id__find_people_review_get";
97
+ revokeWorkbenchColumnSource: "revoke_workbench_column_source_workbench_tables__table_id__columns__col_id__sources__source_type__delete";
98
+ runWorkbenchAi: "run_workbench_ai_workbench_tables__table_id__ai_run_all_post";
99
+ runWorkbenchAiGroup: "run_workbench_ai_group_workbench_tables__table_id__ai_groups__group_id__run_post";
100
+ runWorkbenchColumnAi: "run_workbench_column_ai_workbench_tables__table_id__columns__col_id__ai_run_post";
101
+ runWorkbenchDefaultAi: "run_workbench_default_ai_workbench_tables__table_id__ai_run_post";
102
+ runWorkbenchFindPeople: "run_workbench_find_people_workbench_tables__table_id__find_people__config_id__run_post";
103
+ runWorkbenchProviderScraper: "run_workbench_provider_scraper_workbench_tables__table_id__scraper_providers__provider__runs_post";
104
+ runWorkbenchScraper: "run_workbench_scraper_workbench_tables__table_id__scraper_runs_post";
105
+ runWorkbenchWaterfall: "run_workbench_waterfall_workbench_tables__table_id__waterfall_configs__column_id__run_post";
106
+ saveScraperProviderConnection: "save_scraper_provider_connection_workbench_scraper_providers__provider__connection_put";
107
+ saveWorkbenchColumnAiConfig: "save_workbench_column_ai_config_workbench_tables__table_id__columns__col_id__ai_config_put";
108
+ saveWorkbenchWaterfall: "save_workbench_waterfall_workbench_tables__table_id__waterfall_configs_post";
109
+ sendWorkbenchRowsToSequence: "send_workbench_rows_to_sequence_workbench_tables__table_id__send_to_sequence_post";
110
+ setWorkbenchAutoEnrich: "set_workbench_auto_enrich_workbench_tables__table_id__auto_enrich_put";
111
+ setWorkbenchSchedule: "set_workbench_schedule_workbench_tables__table_id__schedule_put";
112
+ skipWorkbenchFindPeopleCandidates: "skip_workbench_find_people_candidates_workbench_tables__table_id__ai_groups__group_id__find_people_skip_post";
113
+ suggestWorkbenchMappings: "suggest_workbench_mappings_workbench_tables__table_id__suggest_mappings_post";
114
+ syncWorkbenchConnection: "sync_workbench_connection_workbench_tables__table_id__connections__connection_id__sync_post";
115
+ testScraperProviderConnection: "test_scraper_provider_connection_workbench_scraper_providers__provider__connection_test_post";
116
+ unlockWorkbenchRows: "unlock_workbench_rows_workbench_tables__table_id__unlock_rows_post";
117
+ updateWorkbenchAiGroup: "update_workbench_ai_group_workbench_tables__table_id__ai_groups__group_id__put";
118
+ updateWorkbenchPipeline: "update_workbench_pipeline_workbench_tables__table_id__pipelines__pipeline_id__put";
119
+ updateWorkbenchRow: "update_workbench_row_workbench_tables__table_id__rows__row_id__patch";
120
+ updateWorkbenchTable: "update_workbench_table_workbench_tables__table_id__put";
121
+ updateWorkbenchTrigger: "update_workbench_trigger_workbench_tables__table_id__triggers__trigger_id__put";
122
+ updateWorkbenchWaterfall: "update_workbench_waterfall_workbench_tables__table_id__waterfall_configs__column_id__put";
123
+ }
124
+
125
+ /** Input and output of every `g8.api.workbench` operation, keyed by operationId. */
126
+ export interface WorkbenchOperations {
127
+ /**
128
+ * POST /workbench/tables/{table_id}/columns
129
+ * Add Workbench Column
130
+ * tier: write · scope: lists:write
131
+ */
132
+ add_workbench_column_workbench_tables__table_id__columns_post: {
133
+ input: {
134
+ path: {
135
+ /** Table id (UUID). */
136
+ table_id: string;
137
+ };
138
+ headers?: {
139
+ "X-Target-Org-Id"?: string | null;
140
+ };
141
+ body: WorkbenchColumnCreateRequest;
142
+ };
143
+ output: ApiResponse_dict_;
144
+ };
145
+ /**
146
+ * POST /workbench/tables/{table_id}/rows
147
+ * Add Workbench Row
148
+ * tier: write · scope: lists:write
149
+ */
150
+ add_workbench_row_workbench_tables__table_id__rows_post: {
151
+ input: {
152
+ path: {
153
+ /** Table id (UUID). */
154
+ table_id: string;
155
+ };
156
+ headers?: {
157
+ "X-Target-Org-Id"?: string | null;
158
+ };
159
+ body: WorkbenchRowCreateRequest;
160
+ };
161
+ output: ApiResponse_dict_;
162
+ };
163
+ /**
164
+ * POST /workbench/tables/{table_id}/rows/bulk-delete
165
+ * Bulk Delete Workbench Rows
166
+ * tier: destructive · scope: lists:delete
167
+ */
168
+ bulk_delete_workbench_rows_workbench_tables__table_id__rows_bulk_delete_post: {
169
+ input: {
170
+ path: {
171
+ /** Table id (UUID). */
172
+ table_id: string;
173
+ };
174
+ headers?: {
175
+ "X-Target-Org-Id"?: string | null;
176
+ };
177
+ body: WorkbenchRowsDeleteRequest;
178
+ };
179
+ output: ApiResponse_dict_;
180
+ };
181
+ /**
182
+ * POST /workbench/tables/{table_id}/columns/bulk-extract
183
+ * Bulk Extract Workbench Columns
184
+ * tier: write · scope: lists:write
185
+ */
186
+ bulk_extract_workbench_columns_workbench_tables__table_id__columns_bulk_extract_post: {
187
+ input: {
188
+ path: {
189
+ /** Workbench table id (UUID). */
190
+ table_id: string;
191
+ };
192
+ headers?: {
193
+ "X-Target-Org-Id"?: string | null;
194
+ };
195
+ body: BulkExtractRequest;
196
+ };
197
+ output: ApiResponse_EnrichmentPayload_;
198
+ };
199
+ /**
200
+ * GET /workbench/scraper/providers/{provider}/check-token
201
+ * Check Workbench Scraper Token
202
+ * tier: read · scope: lists:read
203
+ */
204
+ check_workbench_scraper_token_workbench_scraper_providers__provider__check_token_get: {
205
+ input: {
206
+ path: {
207
+ /** Which connected scraper provider. */
208
+ provider: "apify";
209
+ };
210
+ headers?: {
211
+ "X-Target-Org-Id"?: string | null;
212
+ };
213
+ };
214
+ output: ApiResponse_EnrichmentPayload_;
215
+ };
216
+ /**
217
+ * POST /workbench/tables/{table_id}/columns/{col_id}/compute
218
+ * Compute Workbench Formula
219
+ * tier: write · scope: lists:write
220
+ */
221
+ compute_workbench_formula_workbench_tables__table_id__columns__col_id__compute_post: {
222
+ input: {
223
+ path: {
224
+ /** Workbench table id (UUID). */
225
+ table_id: string;
226
+ /** The formula column to evaluate. */
227
+ col_id: number;
228
+ };
229
+ headers?: {
230
+ "X-Target-Org-Id"?: string | null;
231
+ };
232
+ };
233
+ output: ApiResponse_EnrichmentPayload_;
234
+ };
235
+ /**
236
+ * POST /workbench/tables/{table_id}/ai/configure
237
+ * Configure Workbench Ai
238
+ * tier: write · scope: lists:write
239
+ */
240
+ configure_workbench_ai_workbench_tables__table_id__ai_configure_post: {
241
+ input: {
242
+ path: {
243
+ /** Workbench table id (UUID). */
244
+ table_id: string;
245
+ };
246
+ headers?: {
247
+ "X-Target-Org-Id"?: string | null;
248
+ };
249
+ body: SaveStagingAIConfigRequest;
250
+ };
251
+ output: ApiResponse_EnrichmentPayload_;
252
+ };
253
+ /**
254
+ * POST /workbench/tables/{table_id}/columns/{col_id}/sources
255
+ * Configure Workbench Column Source
256
+ * tier: write · scope: lists:write
257
+ */
258
+ configure_workbench_column_source_workbench_tables__table_id__columns__col_id__sources_post: {
259
+ input: {
260
+ path: {
261
+ /** Workbench table id (UUID). */
262
+ table_id: string;
263
+ /** Column id. */
264
+ col_id: number;
265
+ };
266
+ headers?: {
267
+ "X-Target-Org-Id"?: string | null;
268
+ };
269
+ body: ConfigureRawSourceRequest;
270
+ };
271
+ output: ApiResponse_EnrichmentPayload_;
272
+ };
273
+ /**
274
+ * POST /workbench/tables/{table_id}/find-people/configure
275
+ * Configure Workbench Find People
276
+ * tier: billable · scope: lists:run
277
+ */
278
+ configure_workbench_find_people_workbench_tables__table_id__find_people_configure_post: {
279
+ input: {
280
+ path: {
281
+ /** Workbench table id (UUID). */
282
+ table_id: string;
283
+ };
284
+ headers?: {
285
+ "X-Target-Org-Id"?: string | null;
286
+ };
287
+ body: ConfigureStagingFindPeopleRequest;
288
+ };
289
+ output: ApiResponse_EnrichmentPayload_;
290
+ };
291
+ /**
292
+ * POST /workbench/tables/{table_id}/ai/groups/config
293
+ * Create Workbench Ai Group
294
+ * tier: write · scope: lists:write
295
+ */
296
+ create_workbench_ai_group_workbench_tables__table_id__ai_groups_config_post: {
297
+ input: {
298
+ path: {
299
+ /** Workbench table id (UUID). */
300
+ table_id: string;
301
+ };
302
+ headers?: {
303
+ "X-Target-Org-Id"?: string | null;
304
+ };
305
+ body: SaveAIConfigRequest;
306
+ };
307
+ output: ApiResponse_EnrichmentPayload_;
308
+ };
309
+ /**
310
+ * POST /workbench-bindings
311
+ * Create Workbench Bindings
312
+ * tier: write · scope: lists:write
313
+ */
314
+ create_workbench_bindings_workbench_bindings_post: {
315
+ input: {
316
+ headers?: {
317
+ "X-Target-Org-Id"?: string | null;
318
+ };
319
+ body: CreateWorkbenchBindingsRequest;
320
+ };
321
+ output: ApiResponse_EnrichmentListPayload_;
322
+ };
323
+ /**
324
+ * POST /workbench/tables/{table_id}/connections
325
+ * Create Workbench Connection
326
+ * tier: write · scope: lists:write
327
+ */
328
+ create_workbench_connection_workbench_tables__table_id__connections_post: {
329
+ input: {
330
+ path: {
331
+ /** Workbench table id (UUID). */
332
+ table_id: string;
333
+ };
334
+ headers?: {
335
+ "X-Target-Org-Id"?: string | null;
336
+ };
337
+ body: TableConnectionRequest;
338
+ };
339
+ output: ApiResponse_EnrichmentPayload_;
340
+ };
341
+ /**
342
+ * POST /workbench/tables/{table_id}/formula-columns
343
+ * Create Workbench Formula Columns
344
+ * tier: write · scope: lists:write
345
+ */
346
+ create_workbench_formula_columns_workbench_tables__table_id__formula_columns_post: {
347
+ input: {
348
+ path: {
349
+ /** Workbench table id (UUID). */
350
+ table_id: string;
351
+ };
352
+ headers?: {
353
+ "X-Target-Org-Id"?: string | null;
354
+ };
355
+ body: CreateFormulaColumnsRequest;
356
+ };
357
+ output: ApiResponse_EnrichmentPayload_;
358
+ };
359
+ /**
360
+ * POST /workbench/tables/{table_id}/pipelines
361
+ * Create Workbench Pipeline
362
+ * tier: billable · scope: lists:run
363
+ */
364
+ create_workbench_pipeline_workbench_tables__table_id__pipelines_post: {
365
+ input: {
366
+ path: {
367
+ /** Workbench table id (UUID). */
368
+ table_id: string;
369
+ };
370
+ headers?: {
371
+ "X-Target-Org-Id"?: string | null;
372
+ };
373
+ body: CreateWorkbenchPipelineRequest;
374
+ };
375
+ output: ApiResponse_EnrichmentPayload_;
376
+ };
377
+ /**
378
+ * POST /workbench/tables
379
+ * Create Workbench Table
380
+ * tier: write · scope: lists:write
381
+ */
382
+ create_workbench_table_workbench_tables_post: {
383
+ input: {
384
+ headers?: {
385
+ "X-Target-Org-Id"?: string | null;
386
+ };
387
+ body: WorkbenchTableCreateRequest;
388
+ };
389
+ output: ApiResponse_WorkbenchTable_;
390
+ };
391
+ /**
392
+ * POST /workbench/tables/{table_id}/triggers
393
+ * Create Workbench Trigger
394
+ * tier: billable · scope: lists:run
395
+ */
396
+ create_workbench_trigger_workbench_tables__table_id__triggers_post: {
397
+ input: {
398
+ path: {
399
+ /** Workbench table id (UUID). */
400
+ table_id: string;
401
+ };
402
+ headers?: {
403
+ "X-Target-Org-Id"?: string | null;
404
+ };
405
+ body: CreateTriggerRequest;
406
+ };
407
+ output: ApiResponse_EnrichmentPayload_;
408
+ };
409
+ /**
410
+ * DELETE /workbench/scraper/providers/{provider}/connection
411
+ * Delete Scraper Provider Connection
412
+ * tier: destructive · scope: lists:delete
413
+ */
414
+ delete_scraper_provider_connection_workbench_scraper_providers__provider__connection_delete: {
415
+ input: {
416
+ path: {
417
+ /** Which scraper provider. */
418
+ provider: "apify";
419
+ };
420
+ headers?: {
421
+ "X-Target-Org-Id"?: string | null;
422
+ };
423
+ };
424
+ output: ApiResponse_EnrichmentPayload_;
425
+ };
426
+ /**
427
+ * DELETE /workbench/tables/{table_id}/ai/groups/{group_id}
428
+ * Delete Workbench Ai Group
429
+ * tier: destructive · scope: lists:delete
430
+ */
431
+ delete_workbench_ai_group_workbench_tables__table_id__ai_groups__group_id__delete: {
432
+ input: {
433
+ path: {
434
+ /** Workbench table id (UUID). */
435
+ table_id: string;
436
+ /** AI group id (starts with `ai_enrich`). */
437
+ group_id: string;
438
+ };
439
+ headers?: {
440
+ "X-Target-Org-Id"?: string | null;
441
+ };
442
+ };
443
+ output: ApiResponse_EnrichmentPayload_;
444
+ };
445
+ /**
446
+ * DELETE /workbench-bindings/{binding_id}
447
+ * Delete Workbench Binding
448
+ * tier: destructive · scope: lists:delete
449
+ */
450
+ delete_workbench_binding_workbench_bindings__binding_id__delete: {
451
+ input: {
452
+ path: {
453
+ /** The binding to remove. */
454
+ binding_id: string;
455
+ };
456
+ headers?: {
457
+ "X-Target-Org-Id"?: string | null;
458
+ };
459
+ };
460
+ output: ApiResponse_EnrichmentPayload_;
461
+ };
462
+ /**
463
+ * DELETE /workbench/tables/{table_id}/columns/{column_id}
464
+ * Delete Workbench Column
465
+ * tier: destructive · scope: lists:delete
466
+ */
467
+ delete_workbench_column_workbench_tables__table_id__columns__column_id__delete: {
468
+ input: {
469
+ path: {
470
+ /** Table id (UUID). */
471
+ table_id: string;
472
+ /** Column id. */
473
+ column_id: number;
474
+ };
475
+ headers?: {
476
+ "X-Target-Org-Id"?: string | null;
477
+ };
478
+ };
479
+ output: ApiResponse_dict_;
480
+ };
481
+ /**
482
+ * DELETE /workbench/tables/{table_id}/connections/{connection_id}
483
+ * Delete Workbench Connection
484
+ * tier: destructive · scope: lists:delete
485
+ */
486
+ delete_workbench_connection_workbench_tables__table_id__connections__connection_id__delete: {
487
+ input: {
488
+ path: {
489
+ /** Workbench table id (UUID). */
490
+ table_id: string;
491
+ /** Connection id. */
492
+ connection_id: number;
493
+ };
494
+ headers?: {
495
+ "X-Target-Org-Id"?: string | null;
496
+ };
497
+ };
498
+ output: ApiResponse_EnrichmentPayload_;
499
+ };
500
+ /**
501
+ * DELETE /workbench/tables/{table_id}/find-people/{config_id}
502
+ * Delete Workbench Find People Config
503
+ * tier: destructive · scope: lists:delete
504
+ */
505
+ delete_workbench_find_people_config_workbench_tables__table_id__find_people__config_id__delete: {
506
+ input: {
507
+ path: {
508
+ /** Workbench table id (UUID). */
509
+ table_id: string;
510
+ /** Find-people configuration id (UUID). */
511
+ config_id: string;
512
+ };
513
+ headers?: {
514
+ "X-Target-Org-Id"?: string | null;
515
+ };
516
+ };
517
+ output: ApiResponse_EnrichmentPayload_;
518
+ };
519
+ /**
520
+ * DELETE /workbench/tables/{table_id}/pipelines/{pipeline_id}
521
+ * Delete Workbench Pipeline
522
+ * tier: destructive · scope: lists:delete
523
+ */
524
+ delete_workbench_pipeline_workbench_tables__table_id__pipelines__pipeline_id__delete: {
525
+ input: {
526
+ path: {
527
+ /** Workbench table id (UUID). */
528
+ table_id: string;
529
+ /** Pipeline id (UUID). */
530
+ pipeline_id: string;
531
+ };
532
+ headers?: {
533
+ "X-Target-Org-Id"?: string | null;
534
+ };
535
+ };
536
+ output: ApiResponse_EnrichmentPayload_;
537
+ };
538
+ /**
539
+ * DELETE /workbench/tables/{table_id}/schedule
540
+ * Delete Workbench Schedule
541
+ * tier: destructive · scope: lists:delete
542
+ */
543
+ delete_workbench_schedule_workbench_tables__table_id__schedule_delete: {
544
+ input: {
545
+ path: {
546
+ /** Workbench table id (UUID). */
547
+ table_id: string;
548
+ };
549
+ headers?: {
550
+ "X-Target-Org-Id"?: string | null;
551
+ };
552
+ };
553
+ output: ApiResponse_EnrichmentPayload_;
554
+ };
555
+ /**
556
+ * DELETE /workbench/tables/{table_id}
557
+ * Delete Workbench Table
558
+ * tier: destructive · scope: lists:delete
559
+ */
560
+ delete_workbench_table_workbench_tables__table_id__delete: {
561
+ input: {
562
+ path: {
563
+ /** Table id (UUID). */
564
+ table_id: string;
565
+ };
566
+ headers?: {
567
+ "X-Target-Org-Id"?: string | null;
568
+ };
569
+ };
570
+ output: ApiResponse_dict_;
571
+ };
572
+ /**
573
+ * DELETE /workbench/tables/{table_id}/triggers/{trigger_id}
574
+ * Delete Workbench Trigger
575
+ * tier: destructive · scope: lists:delete
576
+ */
577
+ delete_workbench_trigger_workbench_tables__table_id__triggers__trigger_id__delete: {
578
+ input: {
579
+ path: {
580
+ /** Workbench table id (UUID). */
581
+ table_id: string;
582
+ /** Trigger id. */
583
+ trigger_id: number;
584
+ };
585
+ headers?: {
586
+ "X-Target-Org-Id"?: string | null;
587
+ };
588
+ };
589
+ output: ApiResponse_EnrichmentPayload_;
590
+ };
591
+ /**
592
+ * POST /workbench/tables/{table_id}/discover-fields
593
+ * Discover Workbench Fields
594
+ * tier: write · scope: lists:write
595
+ */
596
+ discover_workbench_fields_workbench_tables__table_id__discover_fields_post: {
597
+ input: {
598
+ path: {
599
+ /** Workbench table id (UUID). */
600
+ table_id: string;
601
+ };
602
+ headers?: {
603
+ "X-Target-Org-Id"?: string | null;
604
+ };
605
+ body: DiscoverFieldsRequest;
606
+ };
607
+ output: ApiResponse_EnrichmentPayload_;
608
+ };
609
+ /**
610
+ * GET /workbench/scraper/providers/{provider}/credit-estimate
611
+ * Estimate Workbench Provider Scraper Credits
612
+ * tier: read · scope: lists:read
613
+ */
614
+ estimate_workbench_provider_scraper_credits_workbench_scraper_providers__provider__credit_estimate_get: {
615
+ input: {
616
+ path: {
617
+ /** Which connected scraper provider. */
618
+ provider: "apify";
619
+ };
620
+ query: {
621
+ /** The table the results would land in. */
622
+ table_id: string;
623
+ /** Ceiling on results the run would return. */
624
+ max_results: number;
625
+ /** Preset to price against. Omit for the provider's default rate. */
626
+ preset_id?: string | null;
627
+ /** Price the post-scrape enrichment too. */
628
+ auto_enrich?: boolean;
629
+ };
630
+ headers?: {
631
+ "X-Target-Org-Id"?: string | null;
632
+ };
633
+ };
634
+ output: ApiResponse_EnrichmentPayload_;
635
+ };
636
+ /**
637
+ * GET /workbench/scraper/credit-estimate
638
+ * Estimate Workbench Scraper Credits
639
+ * tier: read · scope: lists:read
640
+ */
641
+ estimate_workbench_scraper_credits_workbench_scraper_credit_estimate_get: {
642
+ input: {
643
+ query: {
644
+ /** The table the results would land in. */
645
+ table_id: string;
646
+ /** Ceiling on results the run would return. */
647
+ max_results: number;
648
+ /** Price the post-scrape enrichment too. Leave false and the quote covers the scrape ALONE - which is the number people misread. */
649
+ auto_enrich?: boolean;
650
+ };
651
+ headers?: {
652
+ "X-Target-Org-Id"?: string | null;
653
+ };
654
+ };
655
+ output: ApiResponse_EnrichmentPayload_;
656
+ };
657
+ /**
658
+ * POST /workbench/tables/{table_id}/expand-array
659
+ * Expand Workbench Array
660
+ * tier: write · scope: lists:write
661
+ */
662
+ expand_workbench_array_workbench_tables__table_id__expand_array_post: {
663
+ input: {
664
+ path: {
665
+ /** Workbench table id (UUID). */
666
+ table_id: string;
667
+ };
668
+ headers?: {
669
+ "X-Target-Org-Id"?: string | null;
670
+ };
671
+ body: ExpandArrayRequest;
672
+ };
673
+ output: ApiResponse_EnrichmentPayload_;
674
+ };
675
+ /**
676
+ * POST /workbench/tables/{table_id}/ai/groups/{group_id}/find-people/export
677
+ * Export Workbench Ai Find People
678
+ * tier: write · scope: lists:write
679
+ */
680
+ export_workbench_ai_find_people_workbench_tables__table_id__ai_groups__group_id__find_people_export_post: {
681
+ input: {
682
+ path: {
683
+ /** Workbench table id (UUID). */
684
+ table_id: string;
685
+ /** The AI group id. */
686
+ group_id: string;
687
+ };
688
+ headers?: {
689
+ "X-Target-Org-Id"?: string | null;
690
+ };
691
+ body: UpdateStagingAIFindPeopleCandidatesRequest;
692
+ };
693
+ output: ApiResponse_EnrichmentPayload_;
694
+ };
695
+ /**
696
+ * POST /workbench/tables/{table_id}/export
697
+ * Export Workbench Table
698
+ * tier: write · scope: lists:write
699
+ */
700
+ export_workbench_table_workbench_tables__table_id__export_post: {
701
+ input: {
702
+ path: {
703
+ /** Table id (UUID). */
704
+ table_id: string;
705
+ };
706
+ headers?: {
707
+ "X-Target-Org-Id"?: string | null;
708
+ };
709
+ body: WorkbenchExportRequest;
710
+ };
711
+ output: ApiResponse_dict_;
712
+ };
713
+ /**
714
+ * POST /workbench/tables/{table_id}/columns/extract
715
+ * Extract Workbench Column
716
+ * tier: write · scope: lists:write
717
+ */
718
+ extract_workbench_column_workbench_tables__table_id__columns_extract_post: {
719
+ input: {
720
+ path: {
721
+ /** Workbench table id (UUID). */
722
+ table_id: string;
723
+ };
724
+ headers?: {
725
+ "X-Target-Org-Id"?: string | null;
726
+ };
727
+ body: ExtractColumnRequest;
728
+ };
729
+ output: ApiResponse_EnrichmentPayload_;
730
+ };
731
+ /**
732
+ * POST /workbench/tables/{table_id}/ai/generate-prompt
733
+ * Generate Workbench Prompt
734
+ * tier: billable · scope: lists:run
735
+ */
736
+ generate_workbench_prompt_workbench_tables__table_id__ai_generate_prompt_post: {
737
+ input: {
738
+ path: {
739
+ /** Workbench table id (UUID). */
740
+ table_id: string;
741
+ };
742
+ headers?: {
743
+ "X-Target-Org-Id"?: string | null;
744
+ };
745
+ body: StagingPromptGeneratorRequest;
746
+ };
747
+ output: ApiResponse_EnrichmentPayload_;
748
+ };
749
+ /**
750
+ * GET /workbench/scraper/providers/{provider}/connection
751
+ * Get Scraper Provider Connection
752
+ * tier: read · scope: lists:read
753
+ */
754
+ get_scraper_provider_connection_workbench_scraper_providers__provider__connection_get: {
755
+ input: {
756
+ path: {
757
+ /** Which scraper provider. */
758
+ provider: "apify";
759
+ };
760
+ headers?: {
761
+ "X-Target-Org-Id"?: string | null;
762
+ };
763
+ };
764
+ output: ApiResponse_EnrichmentPayload_;
765
+ };
766
+ /**
767
+ * GET /workbench/tables/{table_id}/ai/groups/{group_id}/find-people/rows/{source_row_id}
768
+ * Get Workbench Ai Find People Row
769
+ * tier: read · scope: lists:read
770
+ */
771
+ get_workbench_ai_find_people_row_workbench_tables__table_id__ai_groups__group_id__find_people_rows__source_row_id__get: {
772
+ input: {
773
+ path: {
774
+ /** Workbench table id (UUID). */
775
+ table_id: string;
776
+ /** The AI group id. */
777
+ group_id: string;
778
+ /** The company row the candidates were found for. */
779
+ source_row_id: number;
780
+ };
781
+ headers?: {
782
+ "X-Target-Org-Id"?: string | null;
783
+ };
784
+ };
785
+ output: ApiResponse_EnrichmentPayload_;
786
+ };
787
+ /**
788
+ * GET /workbench/tables/{table_id}/ai/groups/{group_id}
789
+ * Get Workbench Ai Group
790
+ * tier: read · scope: lists:read
791
+ */
792
+ get_workbench_ai_group_workbench_tables__table_id__ai_groups__group_id__get: {
793
+ input: {
794
+ path: {
795
+ /** Workbench table id (UUID). */
796
+ table_id: string;
797
+ /** The AI group id. */
798
+ group_id: string;
799
+ };
800
+ headers?: {
801
+ "X-Target-Org-Id"?: string | null;
802
+ };
803
+ };
804
+ output: ApiResponse_EnrichmentPayload_;
805
+ };
806
+ /**
807
+ * GET /workbench/tables/{table_id}/analytics
808
+ * Get Workbench Analytics
809
+ * tier: read · scope: lists:read
810
+ */
811
+ get_workbench_analytics_workbench_tables__table_id__analytics_get: {
812
+ input: {
813
+ path: {
814
+ /** Workbench table id (UUID). */
815
+ table_id: string;
816
+ };
817
+ headers?: {
818
+ "X-Target-Org-Id"?: string | null;
819
+ };
820
+ };
821
+ output: ApiResponse_EnrichmentPayload_;
822
+ };
823
+ /**
824
+ * GET /workbench/tables/{table_id}/columns/{col_id}/ai-config
825
+ * Get Workbench Column Ai Config
826
+ * tier: read · scope: lists:read
827
+ */
828
+ get_workbench_column_ai_config_workbench_tables__table_id__columns__col_id__ai_config_get: {
829
+ input: {
830
+ path: {
831
+ /** Workbench table id (UUID). */
832
+ table_id: string;
833
+ /** Column id. */
834
+ col_id: number;
835
+ };
836
+ headers?: {
837
+ "X-Target-Org-Id"?: string | null;
838
+ };
839
+ };
840
+ output: ApiResponse_EnrichmentPayload_;
841
+ };
842
+ /**
843
+ * GET /workbench/tables/{table_id}/history
844
+ * Get Workbench History
845
+ * tier: read · scope: lists:read
846
+ */
847
+ get_workbench_history_workbench_tables__table_id__history_get: {
848
+ input: {
849
+ path: {
850
+ /** Workbench table id (UUID). */
851
+ table_id: string;
852
+ };
853
+ query?: {
854
+ limit?: number;
855
+ offset?: number;
856
+ };
857
+ headers?: {
858
+ "X-Target-Org-Id"?: string | null;
859
+ };
860
+ };
861
+ output: ApiResponse_EnrichmentPayload_;
862
+ };
863
+ /**
864
+ * GET /workbench/tables/{table_id}/locked-row-count
865
+ * Get Workbench Locked Row Count
866
+ * tier: read · scope: lists:read
867
+ */
868
+ get_workbench_locked_row_count_workbench_tables__table_id__locked_row_count_get: {
869
+ input: {
870
+ path: {
871
+ /** Workbench table id (UUID). */
872
+ table_id: string;
873
+ };
874
+ headers?: {
875
+ "X-Target-Org-Id"?: string | null;
876
+ };
877
+ };
878
+ output: ApiResponse_EnrichmentPayload_;
879
+ };
880
+ /**
881
+ * GET /workbench/tables/{table_id}/suggest-mappings/{job_id}
882
+ * Get Workbench Mapping Suggestion
883
+ * tier: read · scope: lists:read
884
+ */
885
+ get_workbench_mapping_suggestion_workbench_tables__table_id__suggest_mappings__job_id__get: {
886
+ input: {
887
+ path: {
888
+ /** Workbench table id (UUID). */
889
+ table_id: string;
890
+ /** Job id returned by `suggest-mappings`. */
891
+ job_id: string;
892
+ };
893
+ headers?: {
894
+ "X-Target-Org-Id"?: string | null;
895
+ };
896
+ };
897
+ output: ApiResponse_EnrichmentPayload_;
898
+ };
899
+ /**
900
+ * GET /workbench/tables/{table_id}/pipelines/{pipeline_id}
901
+ * Get Workbench Pipeline
902
+ * tier: read · scope: lists:read
903
+ */
904
+ get_workbench_pipeline_workbench_tables__table_id__pipelines__pipeline_id__get: {
905
+ input: {
906
+ path: {
907
+ /** Workbench table id (UUID). */
908
+ table_id: string;
909
+ /** Pipeline id (UUID). */
910
+ pipeline_id: string;
911
+ };
912
+ headers?: {
913
+ "X-Target-Org-Id"?: string | null;
914
+ };
915
+ };
916
+ output: ApiResponse_EnrichmentPayload_;
917
+ };
918
+ /**
919
+ * GET /workbench/tables/{table_id}/rows/{row_id}
920
+ * Get Workbench Row
921
+ * tier: read · scope: lists:read
922
+ */
923
+ get_workbench_row_workbench_tables__table_id__rows__row_id__get: {
924
+ input: {
925
+ path: {
926
+ /** Workbench table id (UUID). */
927
+ table_id: string;
928
+ /** Row id. */
929
+ row_id: number;
930
+ };
931
+ headers?: {
932
+ "X-Target-Org-Id"?: string | null;
933
+ };
934
+ };
935
+ output: ApiResponse_EnrichmentPayload_;
936
+ };
937
+ /**
938
+ * GET /workbench/tables/{table_id}/schedule
939
+ * Get Workbench Schedule
940
+ * tier: read · scope: lists:read
941
+ */
942
+ get_workbench_schedule_workbench_tables__table_id__schedule_get: {
943
+ input: {
944
+ path: {
945
+ /** Workbench table id (UUID). */
946
+ table_id: string;
947
+ };
948
+ headers?: {
949
+ "X-Target-Org-Id"?: string | null;
950
+ };
951
+ };
952
+ output: ApiResponse_EnrichmentPayload_;
953
+ };
954
+ /**
955
+ * GET /workbench/tables/{table_id}/scraper/runs/{run_id}
956
+ * Get Workbench Scraper Run
957
+ * tier: read · scope: lists:read
958
+ */
959
+ get_workbench_scraper_run_workbench_tables__table_id__scraper_runs__run_id__get: {
960
+ input: {
961
+ path: {
962
+ /** Workbench table id (UUID). */
963
+ table_id: string;
964
+ /** Scraper run id (UUID). */
965
+ run_id: string;
966
+ };
967
+ headers?: {
968
+ "X-Target-Org-Id"?: string | null;
969
+ };
970
+ };
971
+ output: ApiResponse_EnrichmentPayload_;
972
+ };
973
+ /**
974
+ * GET /workbench/tables/{table_id}
975
+ * Get Workbench Table
976
+ * tier: read · scope: lists:read
977
+ */
978
+ get_workbench_table_workbench_tables__table_id__get: {
979
+ input: {
980
+ path: {
981
+ /** Table id (UUID). */
982
+ table_id: string;
983
+ };
984
+ headers?: {
985
+ "X-Target-Org-Id"?: string | null;
986
+ };
987
+ };
988
+ output: ApiResponse_WorkbenchTable_;
989
+ };
990
+ /**
991
+ * GET /workbench/tables/{table_id}/waterfall/configs/{column_id}
992
+ * Get Workbench Waterfall
993
+ * tier: read · scope: lists:read
994
+ */
995
+ get_workbench_waterfall_workbench_tables__table_id__waterfall_configs__column_id__get: {
996
+ input: {
997
+ path: {
998
+ /** Workbench table id (UUID). */
999
+ table_id: string;
1000
+ /** The waterfall column id. */
1001
+ column_id: number;
1002
+ };
1003
+ headers?: {
1004
+ "X-Target-Org-Id"?: string | null;
1005
+ };
1006
+ };
1007
+ output: ApiResponse_EnrichmentPayload_;
1008
+ };
1009
+ /**
1010
+ * POST /workbench/tables/{table_id}/import/datafile
1011
+ * Import Workbench Datafile
1012
+ * tier: write · scope: lists:write
1013
+ */
1014
+ import_workbench_datafile_workbench_tables__table_id__import_datafile_post: {
1015
+ input: {
1016
+ path: {
1017
+ /** Workbench table id (UUID). */
1018
+ table_id: string;
1019
+ };
1020
+ headers?: {
1021
+ "X-Target-Org-Id"?: string | null;
1022
+ };
1023
+ body: DatafileImportRequest;
1024
+ };
1025
+ output: ApiResponse_EnrichmentPayload_;
1026
+ };
1027
+ /**
1028
+ * POST /workbench/tables/{table_id}/import/crm
1029
+ * Import Workbench From Crm
1030
+ * tier: external · scope: lists:run
1031
+ */
1032
+ import_workbench_from_crm_workbench_tables__table_id__import_crm_post: {
1033
+ input: {
1034
+ path: {
1035
+ /** Workbench table id (UUID). */
1036
+ table_id: string;
1037
+ };
1038
+ headers?: {
1039
+ "X-Target-Org-Id"?: string | null;
1040
+ };
1041
+ body: CRMImportRequest;
1042
+ };
1043
+ output: ApiResponse_EnrichmentPayload_;
1044
+ };
1045
+ /**
1046
+ * POST /workbench/tables/{table_id}/import/search
1047
+ * Import Workbench From Search
1048
+ * tier: billable · scope: lists:run
1049
+ */
1050
+ import_workbench_from_search_workbench_tables__table_id__import_search_post: {
1051
+ input: {
1052
+ path: {
1053
+ /** Workbench table id (UUID). */
1054
+ table_id: string;
1055
+ };
1056
+ headers?: {
1057
+ "X-Target-Org-Id"?: string | null;
1058
+ };
1059
+ body: WorkbenchSearchImportRequest;
1060
+ };
1061
+ output: ApiResponse_EnrichmentPayload_;
1062
+ };
1063
+ /**
1064
+ * GET /workbench/ai-presets
1065
+ * List Workbench Ai Presets
1066
+ * tier: read · scope: lists:read
1067
+ */
1068
+ list_workbench_ai_presets_workbench_ai_presets_get: {
1069
+ input: {
1070
+ headers?: {
1071
+ "X-Target-Org-Id"?: string | null;
1072
+ };
1073
+ };
1074
+ output: ApiResponse_EnrichmentListPayload_;
1075
+ };
1076
+ /**
1077
+ * GET /workbench-bindings
1078
+ * List Workbench Bindings
1079
+ * tier: read · scope: lists:read
1080
+ */
1081
+ list_workbench_bindings_workbench_bindings_get: {
1082
+ input: {
1083
+ query: {
1084
+ /** The list whose bindings to read. */
1085
+ list_id: number;
1086
+ /** Only this workflow's bindings. */
1087
+ workflow_id?: string | null;
1088
+ };
1089
+ headers?: {
1090
+ "X-Target-Org-Id"?: string | null;
1091
+ };
1092
+ };
1093
+ output: ApiResponse_EnrichmentListPayload_;
1094
+ };
1095
+ /**
1096
+ * GET /workbench/tables/{table_id}/columns/{col_id}/sources
1097
+ * List Workbench Column Sources
1098
+ * tier: read · scope: lists:read
1099
+ */
1100
+ list_workbench_column_sources_workbench_tables__table_id__columns__col_id__sources_get: {
1101
+ input: {
1102
+ path: {
1103
+ /** Workbench table id (UUID). */
1104
+ table_id: string;
1105
+ /** Column id. */
1106
+ col_id: number;
1107
+ };
1108
+ headers?: {
1109
+ "X-Target-Org-Id"?: string | null;
1110
+ };
1111
+ };
1112
+ output: ApiResponse_EnrichmentPayload_;
1113
+ };
1114
+ /**
1115
+ * GET /workbench/tables/{table_id}/columns
1116
+ * List Workbench Columns
1117
+ * tier: read · scope: lists:read
1118
+ */
1119
+ list_workbench_columns_workbench_tables__table_id__columns_get: {
1120
+ input: {
1121
+ path: {
1122
+ /** Table id (UUID). */
1123
+ table_id: string;
1124
+ };
1125
+ headers?: {
1126
+ "X-Target-Org-Id"?: string | null;
1127
+ };
1128
+ };
1129
+ output: ApiResponse_WorkbenchPage_;
1130
+ };
1131
+ /**
1132
+ * GET /workbench/tables/{table_id}/connections
1133
+ * List Workbench Connections
1134
+ * tier: read · scope: lists:read
1135
+ */
1136
+ list_workbench_connections_workbench_tables__table_id__connections_get: {
1137
+ input: {
1138
+ path: {
1139
+ /** Workbench table id (UUID). */
1140
+ table_id: string;
1141
+ };
1142
+ headers?: {
1143
+ "X-Target-Org-Id"?: string | null;
1144
+ };
1145
+ };
1146
+ output: ApiResponse_EnrichmentListPayload_;
1147
+ };
1148
+ /**
1149
+ * GET /workbench/tables/{table_id}/enrichment-configs
1150
+ * List Workbench Enrichment Configs
1151
+ * tier: read · scope: lists:read
1152
+ */
1153
+ list_workbench_enrichment_configs_workbench_tables__table_id__enrichment_configs_get: {
1154
+ input: {
1155
+ path: {
1156
+ /** Workbench table id (UUID). */
1157
+ table_id: string;
1158
+ };
1159
+ query?: {
1160
+ /** Narrow to one config kind. Omit for all of them. */
1161
+ type?: string | null;
1162
+ };
1163
+ headers?: {
1164
+ "X-Target-Org-Id"?: string | null;
1165
+ };
1166
+ };
1167
+ output: ApiResponse_EnrichmentListPayload_;
1168
+ };
1169
+ /**
1170
+ * GET /workbench/tables/{table_id}/find-people/configs
1171
+ * List Workbench Find People Configs
1172
+ * tier: read · scope: lists:read
1173
+ */
1174
+ list_workbench_find_people_configs_workbench_tables__table_id__find_people_configs_get: {
1175
+ input: {
1176
+ path: {
1177
+ /** Workbench table id (UUID). */
1178
+ table_id: string;
1179
+ };
1180
+ headers?: {
1181
+ "X-Target-Org-Id"?: string | null;
1182
+ };
1183
+ };
1184
+ output: ApiResponse_EnrichmentListPayload_;
1185
+ };
1186
+ /**
1187
+ * GET /workbench/tables/{table_id}/find-people/{config_id}/contacts
1188
+ * List Workbench Find People Contacts
1189
+ * tier: read · scope: lists:read
1190
+ */
1191
+ list_workbench_find_people_contacts_workbench_tables__table_id__find_people__config_id__contacts_get: {
1192
+ input: {
1193
+ path: {
1194
+ /** Workbench table id (UUID). */
1195
+ table_id: string;
1196
+ /** Find-people configuration id (UUID). */
1197
+ config_id: string;
1198
+ };
1199
+ query: {
1200
+ /** The company row. */
1201
+ source_row_id: number;
1202
+ limit?: number;
1203
+ };
1204
+ headers?: {
1205
+ "X-Target-Org-Id"?: string | null;
1206
+ };
1207
+ };
1208
+ output: ApiResponse_EnrichmentPayload_;
1209
+ };
1210
+ /**
1211
+ * GET /workbench/tables/{table_id}/pipelines
1212
+ * List Workbench Pipelines
1213
+ * tier: read · scope: lists:read
1214
+ */
1215
+ list_workbench_pipelines_workbench_tables__table_id__pipelines_get: {
1216
+ input: {
1217
+ path: {
1218
+ /** Workbench table id (UUID). */
1219
+ table_id: string;
1220
+ };
1221
+ headers?: {
1222
+ "X-Target-Org-Id"?: string | null;
1223
+ };
1224
+ };
1225
+ output: ApiResponse_EnrichmentListPayload_;
1226
+ };
1227
+ /**
1228
+ * GET /workbench/tables/{table_id}/rows
1229
+ * List Workbench Rows
1230
+ * tier: read · scope: lists:read
1231
+ */
1232
+ list_workbench_rows_workbench_tables__table_id__rows_get: {
1233
+ input: {
1234
+ path: {
1235
+ /** Table id (UUID). */
1236
+ table_id: string;
1237
+ };
1238
+ query?: {
1239
+ start_row?: number;
1240
+ end_row?: number;
1241
+ };
1242
+ headers?: {
1243
+ "X-Target-Org-Id"?: string | null;
1244
+ };
1245
+ };
1246
+ output: ApiResponse_WorkbenchPage_;
1247
+ };
1248
+ /**
1249
+ * GET /workbench/scraper/presets
1250
+ * List Workbench Scraper Presets
1251
+ * tier: read · scope: lists:read
1252
+ */
1253
+ list_workbench_scraper_presets_workbench_scraper_presets_get: {
1254
+ input: {
1255
+ headers?: {
1256
+ "X-Target-Org-Id"?: string | null;
1257
+ };
1258
+ };
1259
+ output: ApiResponse_EnrichmentListPayload_;
1260
+ };
1261
+ /**
1262
+ * GET /workbench/tables/{table_id}/scraper/runs
1263
+ * List Workbench Scraper Runs
1264
+ * tier: read · scope: lists:read
1265
+ */
1266
+ list_workbench_scraper_runs_workbench_tables__table_id__scraper_runs_get: {
1267
+ input: {
1268
+ path: {
1269
+ /** Workbench table id (UUID). */
1270
+ table_id: string;
1271
+ };
1272
+ query?: {
1273
+ limit?: number;
1274
+ offset?: number;
1275
+ };
1276
+ headers?: {
1277
+ "X-Target-Org-Id"?: string | null;
1278
+ };
1279
+ };
1280
+ output: ApiResponse_EnrichmentPayload_;
1281
+ };
1282
+ /**
1283
+ * GET /workbench/source-credentials
1284
+ * List Workbench Source Credentials
1285
+ * tier: read · scope: lists:read
1286
+ */
1287
+ list_workbench_source_credentials_workbench_source_credentials_get: {
1288
+ input: {
1289
+ headers?: {
1290
+ "X-Target-Org-Id"?: string | null;
1291
+ };
1292
+ };
1293
+ output: ApiResponse_EnrichmentListPayload_;
1294
+ };
1295
+ /**
1296
+ * GET /workbench/tables/{table_id}/ai-presets
1297
+ * List Workbench Table Ai Presets
1298
+ * tier: read · scope: lists:read
1299
+ */
1300
+ list_workbench_table_ai_presets_workbench_tables__table_id__ai_presets_get: {
1301
+ input: {
1302
+ path: {
1303
+ /** Workbench table id (UUID). */
1304
+ table_id: string;
1305
+ };
1306
+ headers?: {
1307
+ "X-Target-Org-Id"?: string | null;
1308
+ };
1309
+ };
1310
+ output: ApiResponse_EnrichmentListPayload_;
1311
+ };
1312
+ /**
1313
+ * GET /workbench/tables
1314
+ * List Workbench Tables
1315
+ * tier: read · scope: lists:read
1316
+ */
1317
+ list_workbench_tables_workbench_tables_get: {
1318
+ input: {
1319
+ query?: {
1320
+ page?: number;
1321
+ limit?: number;
1322
+ sort_field?: string;
1323
+ sort_order?: string;
1324
+ /** Substring match on the table name. */
1325
+ filter_name?: string | null;
1326
+ };
1327
+ headers?: {
1328
+ "X-Target-Org-Id"?: string | null;
1329
+ };
1330
+ };
1331
+ output: ApiResponse_WorkbenchTableList_;
1332
+ };
1333
+ /**
1334
+ * GET /workbench/target-fields
1335
+ * List Workbench Target Fields
1336
+ * tier: read · scope: lists:read
1337
+ */
1338
+ list_workbench_target_fields_workbench_target_fields_get: {
1339
+ input: {
1340
+ query?: {
1341
+ /** Which record kind the fields are for. */
1342
+ entity_type?: "contact" | "company";
1343
+ };
1344
+ headers?: {
1345
+ "X-Target-Org-Id"?: string | null;
1346
+ };
1347
+ };
1348
+ output: ApiResponse_EnrichmentListPayload_;
1349
+ };
1350
+ /**
1351
+ * GET /workbench/tables/{table_id}/triggers
1352
+ * List Workbench Triggers
1353
+ * tier: read · scope: lists:read
1354
+ */
1355
+ list_workbench_triggers_workbench_tables__table_id__triggers_get: {
1356
+ input: {
1357
+ path: {
1358
+ /** Workbench table id (UUID). */
1359
+ table_id: string;
1360
+ };
1361
+ headers?: {
1362
+ "X-Target-Org-Id"?: string | null;
1363
+ };
1364
+ };
1365
+ output: ApiResponse_EnrichmentListPayload_;
1366
+ };
1367
+ /**
1368
+ * PUT /workbench/tables/{table_id}/columns/{column_id}/mapping
1369
+ * Map Workbench Column
1370
+ * tier: write · scope: lists:write
1371
+ */
1372
+ map_workbench_column_workbench_tables__table_id__columns__column_id__mapping_put: {
1373
+ input: {
1374
+ path: {
1375
+ /** Table id (UUID). */
1376
+ table_id: string;
1377
+ /** Column id. */
1378
+ column_id: number;
1379
+ };
1380
+ headers?: {
1381
+ "X-Target-Org-Id"?: string | null;
1382
+ };
1383
+ body: WorkbenchColumnMappingRequest;
1384
+ };
1385
+ output: ApiResponse_dict_;
1386
+ };
1387
+ /**
1388
+ * POST /workbench/tables/{table_id}/ai/migrate-legacy
1389
+ * Migrate Workbench Legacy Ai Config
1390
+ * tier: write · scope: lists:write
1391
+ */
1392
+ migrate_workbench_legacy_ai_config_workbench_tables__table_id__ai_migrate_legacy_post: {
1393
+ input: {
1394
+ path: {
1395
+ /** Workbench table id (UUID). */
1396
+ table_id: string;
1397
+ };
1398
+ headers?: {
1399
+ "X-Target-Org-Id"?: string | null;
1400
+ };
1401
+ };
1402
+ output: ApiResponse_EnrichmentPayload_;
1403
+ };
1404
+ /**
1405
+ * POST /workbench/tables/{table_id}/import/paste
1406
+ * Paste Import Workbench Rows
1407
+ * tier: write · scope: lists:write
1408
+ */
1409
+ paste_import_workbench_rows_workbench_tables__table_id__import_paste_post: {
1410
+ input: {
1411
+ path: {
1412
+ /** Workbench table id (UUID). */
1413
+ table_id: string;
1414
+ };
1415
+ headers?: {
1416
+ "X-Target-Org-Id"?: string | null;
1417
+ };
1418
+ body: PasteImportRequest;
1419
+ };
1420
+ output: ApiResponse_EnrichmentPayload_;
1421
+ };
1422
+ /**
1423
+ * POST /workbench/tables/{table_id}/ai/preview
1424
+ * Preview Workbench Ai
1425
+ * tier: billable · scope: lists:run
1426
+ */
1427
+ preview_workbench_ai_workbench_tables__table_id__ai_preview_post: {
1428
+ input: {
1429
+ path: {
1430
+ /** Workbench table id (UUID). */
1431
+ table_id: string;
1432
+ };
1433
+ headers?: {
1434
+ "X-Target-Org-Id"?: string | null;
1435
+ };
1436
+ body?: RunStagingAIRequest | null;
1437
+ };
1438
+ output: ApiResponse_EnrichmentPayload_;
1439
+ };
1440
+ /**
1441
+ * POST /workbench/tables/{table_id}/import/search/research/preview
1442
+ * Preview Workbench Research Import
1443
+ * tier: billable · scope: lists:run
1444
+ */
1445
+ preview_workbench_research_import_workbench_tables__table_id__import_search_research_preview_post: {
1446
+ input: {
1447
+ path: {
1448
+ /** Workbench table id (UUID). */
1449
+ table_id: string;
1450
+ };
1451
+ headers?: {
1452
+ "X-Target-Org-Id"?: string | null;
1453
+ };
1454
+ body: SearchResearchPreviewRequest;
1455
+ };
1456
+ output: ApiResponse_EnrichmentPayload_;
1457
+ };
1458
+ /**
1459
+ * POST /workbench/tables/{table_id}/import/search/preview
1460
+ * Preview Workbench Search Import
1461
+ * tier: read · scope: lists:read
1462
+ */
1463
+ preview_workbench_search_import_workbench_tables__table_id__import_search_preview_post: {
1464
+ input: {
1465
+ path: {
1466
+ /** Workbench table id (UUID). */
1467
+ table_id: string;
1468
+ };
1469
+ headers?: {
1470
+ "X-Target-Org-Id"?: string | null;
1471
+ };
1472
+ body: SearchImportPreviewRequest;
1473
+ };
1474
+ output: ApiResponse_EnrichmentPayload_;
1475
+ };
1476
+ /**
1477
+ * POST /workbench/tables/{table_id}/rows/query
1478
+ * Query Workbench Rows
1479
+ * tier: read · scope: lists:read
1480
+ */
1481
+ query_workbench_rows_workbench_tables__table_id__rows_query_post: {
1482
+ input: {
1483
+ path: {
1484
+ /** Workbench table id (UUID). */
1485
+ table_id: string;
1486
+ };
1487
+ headers?: {
1488
+ "X-Target-Org-Id"?: string | null;
1489
+ };
1490
+ body?: StagingRowsQueryRequest;
1491
+ };
1492
+ output: ApiResponse_EnrichmentListPayload_;
1493
+ };
1494
+ /**
1495
+ * POST /workbench/tables/{table_id}/ai/validate-credits
1496
+ * Quote Workbench Ai Run
1497
+ * tier: read · scope: lists:read
1498
+ */
1499
+ quote_workbench_ai_run_workbench_tables__table_id__ai_validate_credits_post: {
1500
+ input: {
1501
+ path: {
1502
+ /** Workbench table id (UUID). */
1503
+ table_id: string;
1504
+ };
1505
+ headers?: {
1506
+ "X-Target-Org-Id"?: string | null;
1507
+ };
1508
+ body?: WorkbenchCreditValidationRequest | null;
1509
+ };
1510
+ output: ApiResponse_EnrichmentPayload_;
1511
+ };
1512
+ /**
1513
+ * GET /workbench/tables/{table_id}/formula-columns/generate-quote
1514
+ * Quote Workbench Formula Generation
1515
+ * tier: read · scope: lists:read
1516
+ */
1517
+ quote_workbench_formula_generation_workbench_tables__table_id__formula_columns_generate_quote_get: {
1518
+ input: {
1519
+ path: {
1520
+ /** Workbench table id (UUID). */
1521
+ table_id: string;
1522
+ };
1523
+ headers?: {
1524
+ "X-Target-Org-Id"?: string | null;
1525
+ };
1526
+ };
1527
+ output: ApiResponse_EnrichmentPayload_;
1528
+ };
1529
+ /**
1530
+ * POST /workbench/tables/{table_id}/unlock-quote
1531
+ * Quote Workbench Unlock
1532
+ * tier: read · scope: lists:read
1533
+ */
1534
+ quote_workbench_unlock_workbench_tables__table_id__unlock_quote_post: {
1535
+ input: {
1536
+ path: {
1537
+ /** Workbench table id (UUID). */
1538
+ table_id: string;
1539
+ };
1540
+ headers?: {
1541
+ "X-Target-Org-Id"?: string | null;
1542
+ };
1543
+ body?: UnlockStagingRowsRequest;
1544
+ };
1545
+ output: ApiResponse_EnrichmentPayload_;
1546
+ };
1547
+ /**
1548
+ * POST /workbench/tables/{table_id}/waterfall/configs/{column_id}/validate-credits
1549
+ * Quote Workbench Waterfall Run
1550
+ * tier: read · scope: lists:read
1551
+ */
1552
+ quote_workbench_waterfall_run_workbench_tables__table_id__waterfall_configs__column_id__validate_credits_post: {
1553
+ input: {
1554
+ path: {
1555
+ /** Workbench table id (UUID). */
1556
+ table_id: string;
1557
+ /** The waterfall column id. */
1558
+ column_id: number;
1559
+ };
1560
+ headers?: {
1561
+ "X-Target-Org-Id"?: string | null;
1562
+ };
1563
+ body?: WorkbenchCreditValidationRequest | null;
1564
+ };
1565
+ output: ApiResponse_EnrichmentPayload_;
1566
+ };
1567
+ /**
1568
+ * POST /workbench/tables/{table_id}/regenerate-key
1569
+ * Regenerate Workbench Key
1570
+ * tier: write · scope: lists:write
1571
+ */
1572
+ regenerate_workbench_key_workbench_tables__table_id__regenerate_key_post: {
1573
+ input: {
1574
+ path: {
1575
+ /** Workbench table id (UUID). */
1576
+ table_id: string;
1577
+ };
1578
+ headers?: {
1579
+ "X-Target-Org-Id"?: string | null;
1580
+ };
1581
+ body?: RegenerateKeyRequest;
1582
+ };
1583
+ output: ApiResponse_EnrichmentPayload_;
1584
+ };
1585
+ /**
1586
+ * GET /workbench/tables/{table_id}/ai/groups/{group_id}/find-people/review
1587
+ * Review Workbench Find People Candidates
1588
+ * tier: read · scope: lists:read
1589
+ */
1590
+ review_workbench_find_people_candidates_workbench_tables__table_id__ai_groups__group_id__find_people_review_get: {
1591
+ input: {
1592
+ path: {
1593
+ /** Workbench table id (UUID). */
1594
+ table_id: string;
1595
+ /** AI group id (starts with `ai_enrich`). */
1596
+ group_id: string;
1597
+ };
1598
+ headers?: {
1599
+ "X-Target-Org-Id"?: string | null;
1600
+ };
1601
+ };
1602
+ output: ApiResponse_EnrichmentListPayload_;
1603
+ };
1604
+ /**
1605
+ * DELETE /workbench/tables/{table_id}/columns/{col_id}/sources/{source_type}
1606
+ * Revoke Workbench Column Source
1607
+ * tier: destructive · scope: lists:delete
1608
+ */
1609
+ revoke_workbench_column_source_workbench_tables__table_id__columns__col_id__sources__source_type__delete: {
1610
+ input: {
1611
+ path: {
1612
+ /** Workbench table id (UUID). */
1613
+ table_id: string;
1614
+ /** Column id. */
1615
+ col_id: number;
1616
+ /** Which source binding to revoke. */
1617
+ source_type: string;
1618
+ };
1619
+ headers?: {
1620
+ "X-Target-Org-Id"?: string | null;
1621
+ };
1622
+ };
1623
+ output: ApiResponse_EnrichmentPayload_;
1624
+ };
1625
+ /**
1626
+ * POST /workbench/tables/{table_id}/ai/run-all
1627
+ * Run Workbench Ai
1628
+ * tier: billable · scope: lists:run
1629
+ */
1630
+ run_workbench_ai_workbench_tables__table_id__ai_run_all_post: {
1631
+ input: {
1632
+ path: {
1633
+ /** Workbench table id (UUID). */
1634
+ table_id: string;
1635
+ };
1636
+ headers?: {
1637
+ "X-Target-Org-Id"?: string | null;
1638
+ };
1639
+ body?: RunStagingAIRequest;
1640
+ };
1641
+ output: ApiResponse_EnrichmentPayload_;
1642
+ };
1643
+ /**
1644
+ * POST /workbench/tables/{table_id}/ai/groups/{group_id}/run
1645
+ * Run Workbench Ai Group
1646
+ * tier: billable · scope: lists:run
1647
+ */
1648
+ run_workbench_ai_group_workbench_tables__table_id__ai_groups__group_id__run_post: {
1649
+ input: {
1650
+ path: {
1651
+ /** Workbench table id (UUID). */
1652
+ table_id: string;
1653
+ /** The AI group id. */
1654
+ group_id: string;
1655
+ };
1656
+ headers?: {
1657
+ "X-Target-Org-Id"?: string | null;
1658
+ };
1659
+ body?: RunStagingAIRequest | null;
1660
+ };
1661
+ output: ApiResponse_EnrichmentPayload_;
1662
+ };
1663
+ /**
1664
+ * POST /workbench/tables/{table_id}/columns/{col_id}/ai/run
1665
+ * Run Workbench Column Ai
1666
+ * tier: billable · scope: lists:run
1667
+ */
1668
+ run_workbench_column_ai_workbench_tables__table_id__columns__col_id__ai_run_post: {
1669
+ input: {
1670
+ path: {
1671
+ /** Workbench table id (UUID). */
1672
+ table_id: string;
1673
+ /** Column id. */
1674
+ col_id: number;
1675
+ };
1676
+ headers?: {
1677
+ "X-Target-Org-Id"?: string | null;
1678
+ };
1679
+ body?: RunStagingAIRequest | null;
1680
+ };
1681
+ output: ApiResponse_EnrichmentPayload_;
1682
+ };
1683
+ /**
1684
+ * POST /workbench/tables/{table_id}/ai/run
1685
+ * Run Workbench Default Ai
1686
+ * tier: billable · scope: lists:run
1687
+ */
1688
+ run_workbench_default_ai_workbench_tables__table_id__ai_run_post: {
1689
+ input: {
1690
+ path: {
1691
+ /** Workbench table id (UUID). */
1692
+ table_id: string;
1693
+ };
1694
+ headers?: {
1695
+ "X-Target-Org-Id"?: string | null;
1696
+ };
1697
+ body?: RunStagingAIRequest | null;
1698
+ };
1699
+ output: ApiResponse_EnrichmentPayload_;
1700
+ };
1701
+ /**
1702
+ * POST /workbench/tables/{table_id}/find-people/{config_id}/run
1703
+ * Run Workbench Find People
1704
+ * tier: billable · scope: lists:run
1705
+ */
1706
+ run_workbench_find_people_workbench_tables__table_id__find_people__config_id__run_post: {
1707
+ input: {
1708
+ path: {
1709
+ /** Workbench table id (UUID). */
1710
+ table_id: string;
1711
+ /** Find-people configuration id (UUID). */
1712
+ config_id: string;
1713
+ };
1714
+ headers?: {
1715
+ "X-Target-Org-Id"?: string | null;
1716
+ };
1717
+ body: RunWorkbenchFindPeopleRequest;
1718
+ };
1719
+ output: ApiResponse_EnrichmentPayload_;
1720
+ };
1721
+ /**
1722
+ * POST /workbench/tables/{table_id}/scraper/providers/{provider}/runs
1723
+ * Run Workbench Provider Scraper
1724
+ * tier: billable · scope: lists:run
1725
+ */
1726
+ run_workbench_provider_scraper_workbench_tables__table_id__scraper_providers__provider__runs_post: {
1727
+ input: {
1728
+ path: {
1729
+ /** Workbench table id (UUID). */
1730
+ table_id: string;
1731
+ /** Which scraper provider. */
1732
+ provider: "apify";
1733
+ };
1734
+ headers?: {
1735
+ "X-Target-Org-Id"?: string | null;
1736
+ };
1737
+ body: RunProviderScraperRequest;
1738
+ };
1739
+ output: ApiResponse_EnrichmentPayload_;
1740
+ };
1741
+ /**
1742
+ * POST /workbench/tables/{table_id}/scraper/runs
1743
+ * Run Workbench Scraper
1744
+ * tier: billable · scope: lists:run
1745
+ */
1746
+ run_workbench_scraper_workbench_tables__table_id__scraper_runs_post: {
1747
+ input: {
1748
+ path: {
1749
+ /** Workbench table id (UUID). */
1750
+ table_id: string;
1751
+ };
1752
+ headers?: {
1753
+ "X-Target-Org-Id"?: string | null;
1754
+ };
1755
+ body: RunBuiltinScraperRequest;
1756
+ };
1757
+ output: ApiResponse_EnrichmentPayload_;
1758
+ };
1759
+ /**
1760
+ * POST /workbench/tables/{table_id}/waterfall/configs/{column_id}/run
1761
+ * Run Workbench Waterfall
1762
+ * tier: billable · scope: lists:run
1763
+ */
1764
+ run_workbench_waterfall_workbench_tables__table_id__waterfall_configs__column_id__run_post: {
1765
+ input: {
1766
+ path: {
1767
+ /** Workbench table id (UUID). */
1768
+ table_id: string;
1769
+ /** The waterfall column id. */
1770
+ column_id: number;
1771
+ };
1772
+ headers?: {
1773
+ "X-Target-Org-Id"?: string | null;
1774
+ };
1775
+ body?: RunStagingAIRequest | null;
1776
+ };
1777
+ output: ApiResponse_EnrichmentPayload_;
1778
+ };
1779
+ /**
1780
+ * PUT /workbench/scraper/providers/{provider}/connection
1781
+ * Save Scraper Provider Connection
1782
+ * tier: write · scope: lists:write
1783
+ */
1784
+ save_scraper_provider_connection_workbench_scraper_providers__provider__connection_put: {
1785
+ input: {
1786
+ path: {
1787
+ /** Which scraper provider. */
1788
+ provider: "apify";
1789
+ };
1790
+ headers?: {
1791
+ "X-Target-Org-Id"?: string | null;
1792
+ };
1793
+ body: ScraperConnectionRequest;
1794
+ };
1795
+ output: ApiResponse_EnrichmentPayload_;
1796
+ };
1797
+ /**
1798
+ * PUT /workbench/tables/{table_id}/columns/{col_id}/ai-config
1799
+ * Save Workbench Column Ai Config
1800
+ * tier: write · scope: lists:write
1801
+ */
1802
+ save_workbench_column_ai_config_workbench_tables__table_id__columns__col_id__ai_config_put: {
1803
+ input: {
1804
+ path: {
1805
+ /** Workbench table id (UUID). */
1806
+ table_id: string;
1807
+ /** Column id. */
1808
+ col_id: number;
1809
+ };
1810
+ headers?: {
1811
+ "X-Target-Org-Id"?: string | null;
1812
+ };
1813
+ body: SaveColumnAIConfigRequest;
1814
+ };
1815
+ output: ApiResponse_EnrichmentPayload_;
1816
+ };
1817
+ /**
1818
+ * POST /workbench/tables/{table_id}/waterfall/configs
1819
+ * Save Workbench Waterfall
1820
+ * tier: write · scope: lists:write
1821
+ */
1822
+ save_workbench_waterfall_workbench_tables__table_id__waterfall_configs_post: {
1823
+ input: {
1824
+ path: {
1825
+ /** Workbench table id (UUID). */
1826
+ table_id: string;
1827
+ };
1828
+ headers?: {
1829
+ "X-Target-Org-Id"?: string | null;
1830
+ };
1831
+ body: SaveWaterfallRequest;
1832
+ };
1833
+ output: ApiResponse_EnrichmentPayload_;
1834
+ };
1835
+ /**
1836
+ * POST /workbench/tables/{table_id}/send-to-sequence
1837
+ * Send Workbench Rows To Sequence
1838
+ * tier: external · scope: lists:run
1839
+ */
1840
+ send_workbench_rows_to_sequence_workbench_tables__table_id__send_to_sequence_post: {
1841
+ input: {
1842
+ path: {
1843
+ /** Workbench table id (UUID). */
1844
+ table_id: string;
1845
+ };
1846
+ headers?: {
1847
+ "X-Target-Org-Id"?: string | null;
1848
+ };
1849
+ body: SendToSequenceRequest;
1850
+ };
1851
+ output: ApiResponse_EnrichmentPayload_;
1852
+ };
1853
+ /**
1854
+ * PUT /workbench/tables/{table_id}/auto-enrich
1855
+ * Set Workbench Auto Enrich
1856
+ * tier: billable · scope: lists:run
1857
+ */
1858
+ set_workbench_auto_enrich_workbench_tables__table_id__auto_enrich_put: {
1859
+ input: {
1860
+ path: {
1861
+ /** Workbench table id (UUID). */
1862
+ table_id: string;
1863
+ };
1864
+ headers?: {
1865
+ "X-Target-Org-Id"?: string | null;
1866
+ };
1867
+ body: ToggleAutoEnrichRequest;
1868
+ };
1869
+ output: ApiResponse_EnrichmentPayload_;
1870
+ };
1871
+ /**
1872
+ * PUT /workbench/tables/{table_id}/schedule
1873
+ * Set Workbench Schedule
1874
+ * tier: billable · scope: lists:run
1875
+ */
1876
+ set_workbench_schedule_workbench_tables__table_id__schedule_put: {
1877
+ input: {
1878
+ path: {
1879
+ /** Workbench table id (UUID). */
1880
+ table_id: string;
1881
+ };
1882
+ headers?: {
1883
+ "X-Target-Org-Id"?: string | null;
1884
+ };
1885
+ body: ScheduleConfigRequest;
1886
+ };
1887
+ output: ApiResponse_EnrichmentPayload_;
1888
+ };
1889
+ /**
1890
+ * POST /workbench/tables/{table_id}/ai/groups/{group_id}/find-people/skip
1891
+ * Skip Workbench Find People Candidates
1892
+ * tier: write · scope: lists:write
1893
+ */
1894
+ skip_workbench_find_people_candidates_workbench_tables__table_id__ai_groups__group_id__find_people_skip_post: {
1895
+ input: {
1896
+ path: {
1897
+ /** Workbench table id (UUID). */
1898
+ table_id: string;
1899
+ /** AI group id (starts with `ai_enrich`). */
1900
+ group_id: string;
1901
+ };
1902
+ headers?: {
1903
+ "X-Target-Org-Id"?: string | null;
1904
+ };
1905
+ body: UpdateStagingAIFindPeopleCandidatesRequest;
1906
+ };
1907
+ output: ApiResponse_EnrichmentPayload_;
1908
+ };
1909
+ /**
1910
+ * POST /workbench/tables/{table_id}/suggest-mappings
1911
+ * Suggest Workbench Mappings
1912
+ * tier: billable · scope: lists:run
1913
+ */
1914
+ suggest_workbench_mappings_workbench_tables__table_id__suggest_mappings_post: {
1915
+ input: {
1916
+ path: {
1917
+ /** Workbench table id (UUID). */
1918
+ table_id: string;
1919
+ };
1920
+ headers?: {
1921
+ "X-Target-Org-Id"?: string | null;
1922
+ };
1923
+ body: SuggestMappingsRequest;
1924
+ };
1925
+ output: ApiResponse_EnrichmentPayload_;
1926
+ };
1927
+ /**
1928
+ * POST /workbench/tables/{table_id}/connections/{connection_id}/sync
1929
+ * Sync Workbench Connection
1930
+ * tier: write · scope: lists:write
1931
+ */
1932
+ sync_workbench_connection_workbench_tables__table_id__connections__connection_id__sync_post: {
1933
+ input: {
1934
+ path: {
1935
+ /** Workbench table id (UUID). */
1936
+ table_id: string;
1937
+ /** Connection id. */
1938
+ connection_id: number;
1939
+ };
1940
+ headers?: {
1941
+ "X-Target-Org-Id"?: string | null;
1942
+ };
1943
+ };
1944
+ output: ApiResponse_EnrichmentPayload_;
1945
+ };
1946
+ /**
1947
+ * POST /workbench/scraper/providers/{provider}/connection/test
1948
+ * Test Scraper Provider Connection
1949
+ * tier: external · scope: lists:run
1950
+ */
1951
+ test_scraper_provider_connection_workbench_scraper_providers__provider__connection_test_post: {
1952
+ input: {
1953
+ path: {
1954
+ /** Which scraper provider. */
1955
+ provider: "apify";
1956
+ };
1957
+ headers?: {
1958
+ "X-Target-Org-Id"?: string | null;
1959
+ };
1960
+ body: ScraperConnectionTestRequest;
1961
+ };
1962
+ output: ApiResponse_EnrichmentPayload_;
1963
+ };
1964
+ /**
1965
+ * POST /workbench/tables/{table_id}/unlock-rows
1966
+ * Unlock Workbench Rows
1967
+ * tier: billable · scope: lists:run
1968
+ */
1969
+ unlock_workbench_rows_workbench_tables__table_id__unlock_rows_post: {
1970
+ input: {
1971
+ path: {
1972
+ /** Workbench table id (UUID). */
1973
+ table_id: string;
1974
+ };
1975
+ headers?: {
1976
+ "X-Target-Org-Id"?: string | null;
1977
+ };
1978
+ body: UnlockStagingRowsRequest;
1979
+ };
1980
+ output: ApiResponse_EnrichmentPayload_;
1981
+ };
1982
+ /**
1983
+ * PUT /workbench/tables/{table_id}/ai/groups/{group_id}
1984
+ * Update Workbench Ai Group
1985
+ * tier: write · scope: lists:write
1986
+ */
1987
+ update_workbench_ai_group_workbench_tables__table_id__ai_groups__group_id__put: {
1988
+ input: {
1989
+ path: {
1990
+ /** Workbench table id (UUID). */
1991
+ table_id: string;
1992
+ /** AI group id (starts with `ai_enrich`). */
1993
+ group_id: string;
1994
+ };
1995
+ headers?: {
1996
+ "X-Target-Org-Id"?: string | null;
1997
+ };
1998
+ body: UpdateAIConfigRequest;
1999
+ };
2000
+ output: ApiResponse_EnrichmentPayload_;
2001
+ };
2002
+ /**
2003
+ * PUT /workbench/tables/{table_id}/pipelines/{pipeline_id}
2004
+ * Update Workbench Pipeline
2005
+ * tier: billable · scope: lists:run
2006
+ */
2007
+ update_workbench_pipeline_workbench_tables__table_id__pipelines__pipeline_id__put: {
2008
+ input: {
2009
+ path: {
2010
+ /** Workbench table id (UUID). */
2011
+ table_id: string;
2012
+ /** Pipeline id (UUID). */
2013
+ pipeline_id: string;
2014
+ };
2015
+ headers?: {
2016
+ "X-Target-Org-Id"?: string | null;
2017
+ };
2018
+ body: UpdateWorkbenchPipelineRequest;
2019
+ };
2020
+ output: ApiResponse_EnrichmentPayload_;
2021
+ };
2022
+ /**
2023
+ * PATCH /workbench/tables/{table_id}/rows/{row_id}
2024
+ * Update Workbench Row
2025
+ * tier: write · scope: lists:write
2026
+ */
2027
+ update_workbench_row_workbench_tables__table_id__rows__row_id__patch: {
2028
+ input: {
2029
+ path: {
2030
+ /** Table id (UUID). */
2031
+ table_id: string;
2032
+ /** Row id. */
2033
+ row_id: number;
2034
+ };
2035
+ headers?: {
2036
+ "X-Target-Org-Id"?: string | null;
2037
+ };
2038
+ body: WorkbenchRowUpdateRequest;
2039
+ };
2040
+ output: ApiResponse_dict_;
2041
+ };
2042
+ /**
2043
+ * PUT /workbench/tables/{table_id}
2044
+ * Update Workbench Table
2045
+ * tier: write · scope: lists:write
2046
+ */
2047
+ update_workbench_table_workbench_tables__table_id__put: {
2048
+ input: {
2049
+ path: {
2050
+ /** Table id (UUID). */
2051
+ table_id: string;
2052
+ };
2053
+ headers?: {
2054
+ "X-Target-Org-Id"?: string | null;
2055
+ };
2056
+ body: WorkbenchTableUpdateRequest;
2057
+ };
2058
+ output: ApiResponse_dict_;
2059
+ };
2060
+ /**
2061
+ * PUT /workbench/tables/{table_id}/triggers/{trigger_id}
2062
+ * Update Workbench Trigger
2063
+ * tier: billable · scope: lists:run
2064
+ */
2065
+ update_workbench_trigger_workbench_tables__table_id__triggers__trigger_id__put: {
2066
+ input: {
2067
+ path: {
2068
+ /** Workbench table id (UUID). */
2069
+ table_id: string;
2070
+ /** Trigger id. */
2071
+ trigger_id: number;
2072
+ };
2073
+ headers?: {
2074
+ "X-Target-Org-Id"?: string | null;
2075
+ };
2076
+ body: UpdateTriggerRequest;
2077
+ };
2078
+ output: ApiResponse_EnrichmentPayload_;
2079
+ };
2080
+ /**
2081
+ * PUT /workbench/tables/{table_id}/waterfall/configs/{column_id}
2082
+ * Update Workbench Waterfall
2083
+ * tier: write · scope: lists:write
2084
+ */
2085
+ update_workbench_waterfall_workbench_tables__table_id__waterfall_configs__column_id__put: {
2086
+ input: {
2087
+ path: {
2088
+ /** Workbench table id (UUID). */
2089
+ table_id: string;
2090
+ /** The waterfall column id. */
2091
+ column_id: number;
2092
+ };
2093
+ headers?: {
2094
+ "X-Target-Org-Id"?: string | null;
2095
+ };
2096
+ body: UpdateWaterfallConfigRequest;
2097
+ };
2098
+ output: ApiResponse_EnrichmentPayload_;
2099
+ };
2100
+ }
2101
+
2102
+ // 79 schemas referenced above (the same as G8Contract.<Name>).
2103
+
2104
+ /** Where one output field lands. */
2105
+ export interface AIColumnMappingDto {
2106
+ column_id: string;
2107
+ column_name: string;
2108
+ output_field: string;
2109
+ }
2110
+
2111
+ /** Execution settings for an AI enrichment group. */
2112
+ export interface AIConfigDto {
2113
+ /** Re-run when new data arrives. ONGOING SPEND when true. */
2114
+ auto_update?: boolean;
2115
+ find_people?: AIFindPeopleSettingsDto | null;
2116
+ list_routing?: ListRoutingDto | null;
2117
+ mode?: "standard" | "find_people";
2118
+ run_condition?: string | null;
2119
+ scope?: ("company" | "contact" | "combined") | null;
2120
+ /** Skip rows that already have a value - the main cost control. */
2121
+ skip_existing_values?: boolean;
2122
+ /** Skip rows enriched in the last 30 days. */
2123
+ skip_recently_enriched?: boolean;
2124
+ use_advanced_search?: boolean;
2125
+ use_json?: boolean;
2126
+ }
2127
+
2128
+ /** A full AI enrichment group definition. */
2129
+ export interface AIEnrichmentConfigDto {
2130
+ column_mappings?: Array<AIColumnMappingDto>;
2131
+ config: AIConfigDto;
2132
+ created_at?: string | null;
2133
+ created_by?: string | null;
2134
+ description?: string | null;
2135
+ group_id?: string | null;
2136
+ id?: string | null;
2137
+ input_mapping: Array<string>;
2138
+ is_global?: boolean;
2139
+ json_schema?: (Record<string, "string" | "number" | "boolean">) | null;
2140
+ list_id?: number | null;
2141
+ model: string;
2142
+ name?: string | null;
2143
+ org_id?: string | null;
2144
+ output_format?: string;
2145
+ outputs: Array<AIOutputFieldDto>;
2146
+ prompt: string;
2147
+ updated_at?: string | null;
2148
+ usecase: string;
2149
+ }
2150
+
2151
+ /** Find-people mode settings for an AI group. */
2152
+ export interface AIFindPeopleSettingsDto {
2153
+ destination_table_id?: string | null;
2154
+ destination_table_name?: string | null;
2155
+ /** `auto` exports found contacts without a human step; `review` holds them. */
2156
+ export_mode?: "auto" | "review";
2157
+ max_people?: number;
2158
+ review_store?: "source_metadata";
2159
+ }
2160
+
2161
+ /** One field the AI pass is asked to return. */
2162
+ export interface AIOutputFieldDto {
2163
+ name: string;
2164
+ type: string;
2165
+ }
2166
+
2167
+ export interface ApiResponse_EnrichmentListPayload_ {
2168
+ data: EnrichmentListPayload;
2169
+ pagination?: PaginationMeta | null;
2170
+ }
2171
+
2172
+ export interface ApiResponse_EnrichmentPayload_ {
2173
+ data: EnrichmentPayload;
2174
+ pagination?: PaginationMeta | null;
2175
+ }
2176
+
2177
+ export interface ApiResponse_WorkbenchPage_ {
2178
+ data: WorkbenchPage;
2179
+ pagination?: PaginationMeta | null;
2180
+ }
2181
+
2182
+ export interface ApiResponse_WorkbenchTableList_ {
2183
+ data: WorkbenchTableList;
2184
+ pagination?: PaginationMeta | null;
2185
+ }
2186
+
2187
+ export interface ApiResponse_WorkbenchTable_ {
2188
+ data: WorkbenchTable;
2189
+ pagination?: PaginationMeta | null;
2190
+ }
2191
+
2192
+ export interface ApiResponse_dict_ {
2193
+ data: Record<string, unknown>;
2194
+ pagination?: PaginationMeta | null;
2195
+ }
2196
+
2197
+ /** Up to 50 extractions in one call. */
2198
+ export interface BulkExtractRequest {
2199
+ extractions: Array<ExtractColumnRequest>;
2200
+ }
2201
+
2202
+ /** Pull records out of a connected CRM into a workbench table. */
2203
+ export interface CRMImportRequest {
2204
+ /** Which CRM connection to read. */
2205
+ connection_id?: string | null;
2206
+ /** Legacy alias of `provider_type`. */
2207
+ crm_provider?: string | null;
2208
+ entity_type?: ("contact" | "company") | null;
2209
+ filters?: Record<string, unknown> | null;
2210
+ limit?: number;
2211
+ /** Legacy alias of `entity_type` (plural form). */
2212
+ object_type?: string | null;
2213
+ /** CRM provider key, e.g. 'hubspot'. */
2214
+ provider_type?: string | null;
2215
+ raw_source_column_id?: number | null;
2216
+ }
2217
+
2218
+ /** Bind an ingest source to a column. */
2219
+ export interface ConfigureRawSourceRequest {
2220
+ /** Source-specific settings. */
2221
+ config?: Record<string, unknown> | null;
2222
+ /** Credential lifetime, applied when one is first generated. */
2223
+ expires_in_days?: number;
2224
+ label?: string | null;
2225
+ /** Explicitly acknowledge that an existing credential is invalidated IMMEDIATELY. Anything already posting with the old key stops. */
2226
+ rotate_existing?: boolean;
2227
+ /** Which kind of source feeds this column. */
2228
+ source_type?: "webhook" | "legacy_webhook" | "scraper_bot";
2229
+ }
2230
+
2231
+ /** Search for contacts at each company row in a workbench table. */
2232
+ export interface ConfigureStagingFindPeopleRequest {
2233
+ auto_create_columns?: boolean;
2234
+ /** Confirm an EMPTY filter set is intentional. An unfiltered search returns the widest - and most expensive - possible result. */
2235
+ broad_search_acknowledged?: boolean;
2236
+ company_name_column?: string | null;
2237
+ create_destination_table?: boolean;
2238
+ destination_table_id?: string | null;
2239
+ destination_table_name?: string | null;
2240
+ /** Column holding company domains or LinkedIn URLs. */
2241
+ domain_column: string;
2242
+ lookup_field?: "COMPANY_DOMAIN" | "COMPANY_LINKEDIN_URL";
2243
+ max_people_per_company?: number;
2244
+ /** Hard ceiling across every company row. */
2245
+ max_total_people?: number;
2246
+ name?: string;
2247
+ search_filters?: Array<FindPeopleSearchFilter>;
2248
+ skip_existing?: boolean;
2249
+ }
2250
+
2251
+ /** Create a formula column with one child column per output. */
2252
+ export interface CreateFormulaColumnsRequest {
2253
+ description?: string | null;
2254
+ /** The G8X formula expression. */
2255
+ formula: string;
2256
+ output_columns: Array<FormulaOutputColumnDef>;
2257
+ }
2258
+
2259
+ /**
2260
+ * React to rows as they arrive or change.
2261
+ *
2262
+ * `action_type: run_ai` enriches, and charges for, every matching row.
2263
+ * `webhook_notify` posts to a URL you give in `action_config`.
2264
+ */
2265
+ export interface CreateTriggerRequest {
2266
+ action_config?: Record<string, unknown>;
2267
+ action_type: "run_ai" | "run_formula" | "export" | "webhook_notify";
2268
+ conditions?: Record<string, unknown> | null;
2269
+ enabled?: boolean;
2270
+ event_type: "ingest" | "ai_complete" | "status_change";
2271
+ name: string;
2272
+ }
2273
+
2274
+ /** Bind a workflow's outputs to columns on one list. */
2275
+ export interface CreateWorkbenchBindingsRequest {
2276
+ /** At least one. The app refuses an empty set; so does this. */
2277
+ bindings: Array<WorkbenchBindingItem>;
2278
+ /** The list whose grid gains the columns. */
2279
+ list_id: number;
2280
+ /** The workflow producing the values. */
2281
+ workflow_id: string;
2282
+ }
2283
+
2284
+ /** Create a workbench pipeline. `enabled: true` ARMS it on every new row. */
2285
+ export interface CreateWorkbenchPipelineRequest {
2286
+ enabled?: boolean;
2287
+ name: string;
2288
+ start: PipelineStartConfig;
2289
+ steps?: Array<WorkbenchPipelineStep>;
2290
+ }
2291
+
2292
+ /**
2293
+ * Import rows from a datafile that has ALREADY been uploaded.
2294
+ *
2295
+ * `datafile_id` refers to an upload made elsewhere; this operation does not
2296
+ * accept file content, which is why it fits the JSON envelope at all.
2297
+ */
2298
+ export interface DatafileImportRequest {
2299
+ /** Source header -> column name. */
2300
+ column_mapping?: Record<string, string> | null;
2301
+ /** Id of a previously uploaded datafile. */
2302
+ datafile_id: string;
2303
+ limit?: number | null;
2304
+ raw_source_column_id?: number | null;
2305
+ skip_duplicates?: boolean;
2306
+ }
2307
+
2308
+ /** Sample a raw JSON column and report the field paths inside it. */
2309
+ export interface DiscoverFieldsRequest {
2310
+ /** Rows to sample. */
2311
+ sample_size?: number;
2312
+ /** The raw JSON column to scan. */
2313
+ source_column_id: number;
2314
+ }
2315
+
2316
+ /**
2317
+ * Verify found emails after the waterfall. PAID per address when
2318
+ * `use_system_credentials` is true.
2319
+ */
2320
+ export interface EmailVerificationConfig {
2321
+ accept_catchall?: boolean;
2322
+ enabled?: boolean;
2323
+ provider?: "zerobounce" | "hunter" | "icypeas" | "leadmagic" | "emaillistverify";
2324
+ /** Use graph8's provider keys (charges credits) rather than your own. */
2325
+ use_system_credentials?: boolean;
2326
+ valid_statuses?: Array<string>;
2327
+ }
2328
+
2329
+ /**
2330
+ * A collection result.
2331
+ *
2332
+ * `items` is ALWAYS present, so a caller can iterate without knowing whether
2333
+ * the handler returned a bare list or a named key. When the handler used a
2334
+ * named key that key is preserved beside `items` rather than renamed, because
2335
+ * renaming it would make the API and the app disagree about the same data.
2336
+ */
2337
+ export interface EnrichmentListPayload {
2338
+ /** The collection, always present. */
2339
+ items?: Array<unknown>;
2340
+ [key: string]: unknown;
2341
+ }
2342
+
2343
+ /**
2344
+ * One enrichment object, open-shaped.
2345
+ *
2346
+ * Open on purpose: a workbench column set is defined by the CUSTOMER at
2347
+ * runtime, and the enrichment result shapes grow with every provider added.
2348
+ * Pinning them would drop whatever a provider returned that this contract had
2349
+ * not caught up on, which on an enrichment surface is the data the customer
2350
+ * paid for.
2351
+ */
2352
+ export type EnrichmentPayload = Record<string, unknown>;
2353
+
2354
+ /** Fan an array field out into one row per element. */
2355
+ export interface ExpandArrayRequest {
2356
+ array_field_path: string;
2357
+ /** Copy the parent row's other fields onto each new row. */
2358
+ keep_parent_fields?: boolean;
2359
+ source_column_id?: number | null;
2360
+ }
2361
+
2362
+ /** Create one column from a JSON path inside a raw column. */
2363
+ export interface ExtractColumnRequest {
2364
+ column_name: string;
2365
+ data_type?: "text" | "number" | "boolean" | "json";
2366
+ display_name: string;
2367
+ /** Dot path inside the raw JSON. */
2368
+ field_path: string;
2369
+ source_column_id: number;
2370
+ }
2371
+
2372
+ /** One condition narrowing the people search. */
2373
+ export interface FindPeopleSearchFilter {
2374
+ field: string;
2375
+ operator: "any_of" | "any_of_with_simular" | "any_off" | "any_off_with_simular" | "all_of" | "none_of" | "empty" | "not_empty" | "exists" | "between" | "include_lists" | "exclude_lists" | "include_topics" | "include_keywords";
2376
+ value?: Array<string>;
2377
+ }
2378
+
2379
+ /** One output of a multi-output formula. */
2380
+ export interface FormulaOutputColumnDef {
2381
+ display_name: string;
2382
+ name: string;
2383
+ }
2384
+
2385
+ /** Route records to different lists based on an AI output field. */
2386
+ export interface ListRoutingDto {
2387
+ enabled?: boolean;
2388
+ field_name?: string;
2389
+ list_mappings?: Record<string, number>;
2390
+ }
2391
+
2392
+ /** One column an AI pass writes into. */
2393
+ export interface OutputColumnDef {
2394
+ display_name?: string | null;
2395
+ mapping_target?: string | null;
2396
+ name: string;
2397
+ type?: string;
2398
+ }
2399
+
2400
+ export interface PaginationMeta {
2401
+ /** Whether there are more pages */
2402
+ has_next: boolean;
2403
+ /** Items per page */
2404
+ limit: number;
2405
+ /** 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. */
2406
+ next_cursor?: string | null;
2407
+ /** Current page number (1-indexed) */
2408
+ page: number;
2409
+ /** Total number of items */
2410
+ total: number;
2411
+ }
2412
+
2413
+ /** Import a rectangle of values - the paste path, no file involved. */
2414
+ export interface PasteImportRequest {
2415
+ headers: Array<string>;
2416
+ raw_source_column_id?: number | null;
2417
+ rows: Array<Array<unknown>>;
2418
+ }
2419
+
2420
+ export interface PipelineExpectedField {
2421
+ data_type?: "text" | "number" | "boolean" | "json";
2422
+ display_name?: string;
2423
+ locked?: boolean;
2424
+ name: string;
2425
+ }
2426
+
2427
+ /** What starts the pipeline. */
2428
+ export interface PipelineStartConfig {
2429
+ expected_fields?: Array<PipelineExpectedField>;
2430
+ source_types?: Array<string>;
2431
+ type: "email_pdf" | "webhook" | "scraper_bot" | "ingest";
2432
+ }
2433
+
2434
+ /** Mint a fresh ingest credential for a table. */
2435
+ export interface RegenerateKeyRequest {
2436
+ /** Acknowledge that the existing credential stops working IMMEDIATELY. Leave false to mint only when there is none. */
2437
+ rotate_existing?: boolean;
2438
+ }
2439
+
2440
+ /**
2441
+ * Describe what to collect; the scraper fills the table. CHARGES.
2442
+ *
2443
+ * The price is quoted by `GET /workbench/scraper/credit-estimate`. A quote is
2444
+ * approved by passing `approved_max_credits` and `quote_expires_at` back.
2445
+ */
2446
+ export interface RunBuiltinScraperRequest {
2447
+ approved_max_credits?: number | null;
2448
+ /** Also enrich each scraped row. Charged on top. */
2449
+ auto_enrich?: boolean;
2450
+ max_results?: number;
2451
+ model?: string | null;
2452
+ prompt: string;
2453
+ quote_expires_at?: string | null;
2454
+ }
2455
+
2456
+ /**
2457
+ * Run a scraper on your connected provider account. CHARGES per result.
2458
+ *
2459
+ * One of `preset_id` (from `GET /workbench/scraper/presets`) or
2460
+ * `custom_actor_id`. `auto_enrich` DEFAULTS TO TRUE here: every result is
2461
+ * also enriched, and charged, unless you turn it off.
2462
+ */
2463
+ export interface RunProviderScraperRequest {
2464
+ approved_max_credits?: number | null;
2465
+ auto_enrich?: boolean;
2466
+ custom_actor_id?: string | null;
2467
+ input_config?: Record<string, unknown>;
2468
+ max_results?: number;
2469
+ preset_id?: string | null;
2470
+ quote_expires_at?: string | null;
2471
+ }
2472
+
2473
+ /**
2474
+ * Which rows a run covers, and the spend the caller approved.
2475
+ *
2476
+ * OMITTING `row_ids` RUNS EVERY ROW. `exclude_row_ids` narrows that back down.
2477
+ */
2478
+ export interface RunStagingAIRequest {
2479
+ /** Ceiling the caller approves. The run refuses to exceed it. */
2480
+ approved_max_credits?: number | null;
2481
+ conditions?: Array<Record<string, string>> | null;
2482
+ exclude_row_ids?: Array<number> | null;
2483
+ max_rows_per_source?: number | null;
2484
+ /** Override the configured model. */
2485
+ model?: string | null;
2486
+ multi_row_output?: boolean | null;
2487
+ /** Override the configured prompt. */
2488
+ prompt?: string | null;
2489
+ qualification_mode?: boolean;
2490
+ quote_expires_at?: string | null;
2491
+ quote_id?: string | null;
2492
+ /** Rows to run. OMIT to run EVERY row in the table. */
2493
+ row_ids?: Array<number> | null;
2494
+ status_filter?: string | null;
2495
+ }
2496
+
2497
+ /**
2498
+ * Which rows find-people runs over.
2499
+ *
2500
+ * `selected` requires `row_ids` or `exclude_row_ids`; the other modes forbid
2501
+ * them.
2502
+ */
2503
+ export interface RunWorkbenchFindPeopleRequest {
2504
+ enrichment_mode?: "first_10" | "all_rows" | "selected";
2505
+ exclude_row_ids?: Array<number> | null;
2506
+ row_ids?: Array<number> | null;
2507
+ }
2508
+
2509
+ /** Save an AI enrichment group. Saving costs nothing; running it does. */
2510
+ export interface SaveAIConfigRequest {
2511
+ config: AIEnrichmentConfigDto;
2512
+ /** Always false. Saving never runs - the app refuses immediate execution so a save can never become an unpriced spend. */
2513
+ run_immediately?: false;
2514
+ target_records?: Array<string> | null;
2515
+ }
2516
+
2517
+ /** Configure ONE column's AI pass. Saving costs nothing; running does. */
2518
+ export interface SaveColumnAIConfigRequest {
2519
+ /** Only run the pass on rows matching these conditions. */
2520
+ conditions?: Record<string, unknown> | null;
2521
+ model?: string;
2522
+ prompt: string;
2523
+ usecase?: "content_generation" | "web-research";
2524
+ }
2525
+
2526
+ /** Configure the table-level AI pass. Saving costs nothing; running does. */
2527
+ export interface SaveStagingAIConfigRequest {
2528
+ entity_type?: ("contact" | "company") | null;
2529
+ max_rows_per_source?: number;
2530
+ model?: string;
2531
+ multi_row_output?: boolean;
2532
+ output_columns?: Array<OutputColumnDef>;
2533
+ prompt: string;
2534
+ usecase?: string;
2535
+ }
2536
+
2537
+ /**
2538
+ * Create or overwrite a workbench waterfall column.
2539
+ *
2540
+ * `run_immediately` and `target_records` are carried for parity with the app
2541
+ * model and IGNORED by the workbench save: saving never runs anything. Run it
2542
+ * with `POST /workbench/tables/{table_id}/waterfall/configs/{column_id}/run`.
2543
+ */
2544
+ export interface SaveWaterfallRequest {
2545
+ config: WaterfallConfig;
2546
+ /** Ignored on a workbench table. */
2547
+ run_immediately?: boolean;
2548
+ /** Ignored on a workbench table. */
2549
+ target_records?: Array<string> | null;
2550
+ }
2551
+
2552
+ /**
2553
+ * Run something on this table on a schedule.
2554
+ *
2555
+ * A schedule whose `action_type` is `run_ai` SPENDS CREDITS on every firing,
2556
+ * without a further call. `enabled` defaults to false so creating one is not
2557
+ * the same act as starting it.
2558
+ */
2559
+ export interface ScheduleConfigRequest {
2560
+ action_config?: Record<string, unknown> | null;
2561
+ action_type: "run_ai" | "run_formula" | "crm_import";
2562
+ cron_expression?: string | null;
2563
+ enabled?: boolean;
2564
+ frequency?: ("hourly" | "daily" | "weekly") | null;
2565
+ }
2566
+
2567
+ /** Connect your own scraper provider account. The token is write-only. */
2568
+ export interface ScraperConnectionRequest {
2569
+ /** Your provider API token. Never returned. */
2570
+ api_key: string;
2571
+ configuration?: Record<string, unknown>;
2572
+ }
2573
+
2574
+ /** Check a token against the provider without saving it. */
2575
+ export interface ScraperConnectionTestRequest {
2576
+ api_key: string;
2577
+ }
2578
+
2579
+ /** Sample what a people search would import. Contact details stay masked. */
2580
+ export interface SearchImportPreviewRequest {
2581
+ filters: Array<Record<string, unknown>>;
2582
+ max_employees_per_company?: number | null;
2583
+ max_result?: number | null;
2584
+ sample_size?: number;
2585
+ }
2586
+
2587
+ /** Describe your leads in words; a model writes the search filters. */
2588
+ export interface SearchResearchPreviewRequest {
2589
+ lead_prompt: string;
2590
+ max_employees_per_company?: number | null;
2591
+ max_result?: number | null;
2592
+ sample_size?: number;
2593
+ }
2594
+
2595
+ /** Put workbench rows into a sequence. */
2596
+ export interface SendToSequenceRequest {
2597
+ create_new_list?: boolean;
2598
+ list_id?: number | null;
2599
+ new_list_name?: string | null;
2600
+ /** Rows to send. OMIT to send EVERY row in the table. */
2601
+ row_ids?: Array<number> | null;
2602
+ sequence_id: number;
2603
+ }
2604
+
2605
+ /** Ask the model to write a prompt from the table's columns and sample rows. */
2606
+ export interface StagingPromptGeneratorRequest {
2607
+ /** What the AI pass should do, in plain words. */
2608
+ task_description: string;
2609
+ }
2610
+
2611
+ /** Read a window of rows. Reads only - nothing is enriched or charged. */
2612
+ export interface StagingRowsQueryRequest {
2613
+ end_row?: number;
2614
+ filter_model?: Record<string, unknown> | null;
2615
+ sort_model?: Array<Record<string, unknown>> | null;
2616
+ start_row?: number;
2617
+ }
2618
+
2619
+ /** Ask the model to map source columns onto target fields. */
2620
+ export interface SuggestMappingsRequest {
2621
+ source_columns: Array<string>;
2622
+ target_fields: Array<string>;
2623
+ }
2624
+
2625
+ /** Copy rows from this table into another table in the same organisation. */
2626
+ export interface TableConnectionRequest {
2627
+ destination_table_id: string;
2628
+ /** Source column -> destination. */
2629
+ field_mapping?: Record<string, string> | null;
2630
+ filter_conditions?: Record<string, unknown> | null;
2631
+ sync_mode?: "append";
2632
+ }
2633
+
2634
+ /**
2635
+ * Turn the table's automatic AI enrichment on or off.
2636
+ *
2637
+ * `enabled` is explicit rather than a toggle, so a retried request is
2638
+ * idempotent instead of flipping the state back - which on this switch would
2639
+ * silently resume spending.
2640
+ */
2641
+ export interface ToggleAutoEnrichRequest {
2642
+ /** Rows per automatic batch. */
2643
+ batch_size?: number;
2644
+ enabled: boolean;
2645
+ }
2646
+
2647
+ /**
2648
+ * Which locked rows to price, or to unlock.
2649
+ *
2650
+ * The SAME body serves the quote and the unlock. Send identical fields to
2651
+ * both: the quote prices exactly the scope the unlock will then charge for.
2652
+ *
2653
+ * OMITTING `row_ids` MEANS EVERY LOCKED ROW IN THE TABLE. That is the app's
2654
+ * "Unlock All", and at one credit per row it is the most expensive thing this
2655
+ * body can express. `exclude_row_ids` narrows it back down.
2656
+ */
2657
+ export interface UnlockStagingRowsRequest {
2658
+ /** Ceiling the caller approves. The run refuses to exceed it. */
2659
+ approved_max_credits?: number | null;
2660
+ /** Rows to leave locked. */
2661
+ exclude_row_ids?: Array<number> | null;
2662
+ /** The quote's operation id. REQUIRED by the unlock - it is what ties the charge to a price the caller was shown, and it makes a retried unlock idempotent instead of charging twice. */
2663
+ operation_id?: string | null;
2664
+ /** Expiry of the quote being approved. */
2665
+ quote_expires_at?: string | null;
2666
+ /** Rows to act on. OMIT to mean EVERY locked row in the table. */
2667
+ row_ids?: Array<number> | null;
2668
+ }
2669
+
2670
+ /** Replace an AI enrichment group's definition. */
2671
+ export interface UpdateAIConfigRequest {
2672
+ config: AIEnrichmentConfigDto;
2673
+ }
2674
+
2675
+ /** Mark candidates as skipped. Changes review state only. */
2676
+ export interface UpdateStagingAIFindPeopleCandidatesRequest {
2677
+ candidate_ids?: Array<string>;
2678
+ }
2679
+
2680
+ /** Edit an automation trigger. Every field is optional; omitted means unchanged. */
2681
+ export interface UpdateTriggerRequest {
2682
+ action_config?: Record<string, unknown> | null;
2683
+ conditions?: Record<string, unknown> | null;
2684
+ enabled?: boolean | null;
2685
+ name?: string | null;
2686
+ }
2687
+
2688
+ /** Replace a waterfall's definition. */
2689
+ export interface UpdateWaterfallConfigRequest {
2690
+ config: WaterfallConfig;
2691
+ }
2692
+
2693
+ /** Edit a workbench pipeline. Omitted fields are left alone. */
2694
+ export interface UpdateWorkbenchPipelineRequest {
2695
+ enabled?: boolean | null;
2696
+ name?: string | null;
2697
+ start?: PipelineStartConfig | null;
2698
+ steps?: Array<WorkbenchPipelineStep> | null;
2699
+ }
2700
+
2701
+ /**
2702
+ * A complete waterfall definition.
2703
+ *
2704
+ * `org_id` and `created_by` are accepted for shape parity with the app and
2705
+ * IGNORED: the organisation always comes from the API key.
2706
+ */
2707
+ export interface WaterfallConfig {
2708
+ auto_update?: boolean;
2709
+ column_id: string;
2710
+ /** Ignored. */
2711
+ created_by?: string | null;
2712
+ data_type?: string;
2713
+ email_verification?: EmailVerificationConfig | null;
2714
+ field_to_enrich: string;
2715
+ hide_provider_columns?: boolean;
2716
+ id?: string | null;
2717
+ is_existing_column?: boolean;
2718
+ is_global?: boolean;
2719
+ list_id?: number | null;
2720
+ list_routing?: WaterfallListRouting | null;
2721
+ name: string;
2722
+ /** Run condition formula. */
2723
+ only_run_if?: string | null;
2724
+ /** Ignored: the key's organisation is used. */
2725
+ org_id?: string | null;
2726
+ output_successful_provider?: boolean;
2727
+ skip_existing_values?: boolean;
2728
+ skip_recently_enriched?: boolean;
2729
+ steps: Array<WaterfallStep>;
2730
+ target_column_name?: string | null;
2731
+ /** Deprecated: use `email_verification`. */
2732
+ validate_emails?: boolean;
2733
+ }
2734
+
2735
+ /** Route records into lists by their verification result. */
2736
+ export interface WaterfallListRouting {
2737
+ copy_columns?: boolean;
2738
+ enabled?: boolean;
2739
+ field_name?: string;
2740
+ /** Verification status -> list id. */
2741
+ list_mappings?: Record<string, number>;
2742
+ routing_columns?: Record<string, unknown> | null;
2743
+ }
2744
+
2745
+ /** One provider attempt in a waterfall. */
2746
+ export interface WaterfallStep {
2747
+ action: string;
2748
+ action_display_name: string;
2749
+ confidence_threshold?: number;
2750
+ config?: Record<string, unknown>;
2751
+ enabled?: boolean;
2752
+ id: string;
2753
+ input_mapping?: Record<string, string>;
2754
+ /** Use graph8's provider credentials. Those calls are charged. */
2755
+ is_system_provider?: boolean;
2756
+ max_retries?: number;
2757
+ order: number;
2758
+ output_field?: string | null;
2759
+ /** Deprecated. */
2760
+ output_mapping?: Record<string, string> | null;
2761
+ /** Provider name, from `GET /enrichment/providers`. */
2762
+ provider: string;
2763
+ stop_on_success?: boolean;
2764
+ }
2765
+
2766
+ /** One workflow output rendered as one grid column. */
2767
+ export interface WorkbenchBindingItem {
2768
+ /** Display name of the column. */
2769
+ column_name: string;
2770
+ /** How the grid treats the column. */
2771
+ column_type: "computed" | "ai" | "enrichment" | "state" | "action" | "review";
2772
+ /** Column-type settings. */
2773
+ config?: Record<string, unknown> | null;
2774
+ /** How the cell renders. */
2775
+ display_mode?: string;
2776
+ /** The workflow node whose output feeds the column. */
2777
+ node_id: string;
2778
+ /** Dot path into that node's output. */
2779
+ output_path: string;
2780
+ /** Position among the bound columns. */
2781
+ sort_order?: number;
2782
+ }
2783
+
2784
+ export interface WorkbenchColumnCreateRequest {
2785
+ column_type?: "data" | "formula" | "raw_json";
2786
+ data_type?: "text" | "number" | "boolean" | "json";
2787
+ display_name: string;
2788
+ /** Path into a raw_json source column. */
2789
+ field_path?: string | null;
2790
+ /** Required for a formula column. */
2791
+ formula?: string | null;
2792
+ /** Machine name: lowercase, starting with a letter. This is the key row data is addressed by, which is why it is constrained while `display_name` is not. */
2793
+ name: string;
2794
+ source?: string;
2795
+ source_column_id?: number | null;
2796
+ }
2797
+
2798
+ /**
2799
+ * Point a column at a CRM field so export knows where its values go.
2800
+ *
2801
+ * `null` clears the mapping, which is why the field is optional rather than
2802
+ * required - an unmapped column is a real state, not a missing argument.
2803
+ */
2804
+ export interface WorkbenchColumnMappingRequest {
2805
+ mapping_target?: string | null;
2806
+ }
2807
+
2808
+ /**
2809
+ * Price a run before starting it. FREE.
2810
+ *
2811
+ * At most one of `column_id`, `group_id` and `all_columns`. None prices the
2812
+ * table's default AI pass.
2813
+ */
2814
+ export interface WorkbenchCreditValidationRequest {
2815
+ all_columns?: boolean;
2816
+ column_id?: number | null;
2817
+ exclude_row_ids?: Array<number> | null;
2818
+ group_id?: string | null;
2819
+ /** OMIT to price EVERY row. */
2820
+ row_ids?: Array<number> | null;
2821
+ status_filter?: string | null;
2822
+ }
2823
+
2824
+ /** Export rows to an audience list. */
2825
+ export interface WorkbenchExportRequest {
2826
+ create_new_list?: boolean;
2827
+ entity_type?: "contact" | "company";
2828
+ exclude_row_ids?: Array<number> | null;
2829
+ export_filter?: Record<string, unknown> | null;
2830
+ /** Only rows whose email passed verification. */
2831
+ export_verified_only?: boolean;
2832
+ /** Existing list to export into. */
2833
+ list_id?: number | null;
2834
+ new_list_name?: string | null;
2835
+ row_ids?: Array<number> | null;
2836
+ }
2837
+
2838
+ /**
2839
+ * A page of rows, or a list of columns, exactly as the app returns it.
2840
+ *
2841
+ * Rows and columns stay open dicts: a Workbench table's columns are defined
2842
+ * by the CUSTOMER at runtime. There is no schema to pin, and inventing one
2843
+ * would make the product unusable through this API.
2844
+ */
2845
+ export interface WorkbenchPage {
2846
+ items?: Array<Record<string, unknown>>;
2847
+ total?: number;
2848
+ [key: string]: unknown;
2849
+ }
2850
+
2851
+ /**
2852
+ * A step inside a branch.
2853
+ *
2854
+ * Its own `if_steps` / `else_steps` are open objects in this schema: the app
2855
+ * nests steps without limit, and a self-referencing schema is not publishable.
2856
+ * They are still validated as steps by the app.
2857
+ */
2858
+ export interface WorkbenchPipelineBranchStep {
2859
+ column_id?: number | null;
2860
+ conditions?: Array<Record<string, unknown>> | null;
2861
+ else_steps?: Array<Record<string, unknown>>;
2862
+ enabled?: boolean;
2863
+ group_id?: string | null;
2864
+ id: string;
2865
+ if_steps?: Array<Record<string, unknown>>;
2866
+ inline_config?: Record<string, unknown> | null;
2867
+ name: string;
2868
+ template?: string | null;
2869
+ type: "ai_group" | "waterfall" | "formula" | "branch" | "export_to_list";
2870
+ }
2871
+
2872
+ /** One step. A `branch` step runs `if_steps` or `else_steps`. */
2873
+ export interface WorkbenchPipelineStep {
2874
+ column_id?: number | null;
2875
+ conditions?: Array<Record<string, unknown>> | null;
2876
+ else_steps?: Array<WorkbenchPipelineBranchStep>;
2877
+ enabled?: boolean;
2878
+ group_id?: string | null;
2879
+ id: string;
2880
+ if_steps?: Array<WorkbenchPipelineBranchStep>;
2881
+ inline_config?: Record<string, unknown> | null;
2882
+ name: string;
2883
+ template?: string | null;
2884
+ type: "ai_group" | "waterfall" | "formula" | "branch" | "export_to_list";
2885
+ }
2886
+
2887
+ export interface WorkbenchRowCreateRequest {
2888
+ /** Column machine name -> value. */
2889
+ data?: Record<string, unknown>;
2890
+ raw_source_column_id?: number | null;
2891
+ }
2892
+
2893
+ /** Set ONE field on one row - the grid's cell edit. */
2894
+ export interface WorkbenchRowUpdateRequest {
2895
+ field: string;
2896
+ value: unknown;
2897
+ }
2898
+
2899
+ /**
2900
+ * Delete rows by id, or every row EXCEPT a set.
2901
+ *
2902
+ * `select_all` is EXPLICIT rather than inferred from an empty `row_ids`,
2903
+ * mirroring the app - so a client bug can never turn "nothing selected" into
2904
+ * "delete the whole table". This surface keeps that guarantee rather than
2905
+ * accepting a bare empty list as a delete-everything.
2906
+ */
2907
+ export interface WorkbenchRowsDeleteRequest {
2908
+ exclude_row_ids?: Array<number> | null;
2909
+ row_ids?: Array<number> | null;
2910
+ select_all?: boolean;
2911
+ }
2912
+
2913
+ /**
2914
+ * Import people from a search into the table as LOCKED rows.
2915
+ *
2916
+ * Each row costs a credit to unlock (`POST .../unlock-rows`).
2917
+ */
2918
+ export interface WorkbenchSearchImportRequest {
2919
+ filters: Array<Record<string, unknown>>;
2920
+ limit?: number;
2921
+ max_employees_per_company?: number | null;
2922
+ max_result?: number | null;
2923
+ raw_source_column_id?: number | null;
2924
+ return_inserted_ids?: boolean;
2925
+ skip_duplicates?: boolean;
2926
+ }
2927
+
2928
+ /** One staging table. */
2929
+ export interface WorkbenchTable {
2930
+ created_at?: string | null;
2931
+ description?: string | null;
2932
+ /** contact or company. */
2933
+ entity_type?: string | null;
2934
+ id?: string | null;
2935
+ name?: string | null;
2936
+ row_count?: number | null;
2937
+ updated_at?: string | null;
2938
+ [key: string]: unknown;
2939
+ }
2940
+
2941
+ export interface WorkbenchTableCreateRequest {
2942
+ description?: string | null;
2943
+ /** What the rows will become on export. Settable once, at creation. */
2944
+ entity_type?: ("contact" | "company") | null;
2945
+ /** Table name. */
2946
+ name: string;
2947
+ }
2948
+
2949
+ export interface WorkbenchTableList {
2950
+ tables?: Array<WorkbenchTable>;
2951
+ total?: number;
2952
+ [key: string]: unknown;
2953
+ }
2954
+
2955
+ /**
2956
+ * Rename or re-describe. `entity_type` is deliberately absent - it decides
2957
+ * how rows export and is fixed at creation.
2958
+ */
2959
+ export interface WorkbenchTableUpdateRequest {
2960
+ description?: string | null;
2961
+ name?: string | null;
2962
+ }