@graph8/sdk 0.245.0 → 0.260.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 +19 -5
  2. package/dist/cli.js +216 -0
  3. package/dist/index.d.mts +283 -12
  4. package/dist/index.d.ts +283 -12
  5. package/dist/index.js +88 -2
  6. package/dist/index.js.map +1 -1
  7. package/dist/index.mjs +88 -2
  8. package/dist/index.mjs.map +1 -1
  9. package/dist/react.d.mts +274 -12
  10. package/dist/react.d.ts +274 -12
  11. package/dist/react.js +106 -10
  12. package/dist/react.js.map +1 -1
  13. package/dist/react.mjs +97 -11
  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 +1696 -0
  140. package/docs/api/deals.md +2432 -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,1218 @@
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.workflows` (Workflows): 59 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<"approve_execution_workflows_executions_approve_post">;
9
+ *
10
+ * Reference with examples: workflows.md
11
+ */
12
+ /* eslint-disable */
13
+
14
+ /** `g8.api.workflows.<member>` -> the operationId it calls. */
15
+ export interface WorkflowsMembers {
16
+ approveExecution: "approve_execution_workflows_executions_approve_post";
17
+ attachSkillCollections: "attach_skill_collections_skills__action_id__collections_post";
18
+ bulkRestartExecutions: "bulk_restart_executions_workflows_executions_bulk_restart_post";
19
+ createSkillTestCase: "create_skill_test_case_skills__action_id__test_cases_post";
20
+ createWorkbench: "create_workbench_workflows_workbenches_post";
21
+ createWorkflow: "create_workflow_workflows_post";
22
+ deleteSkillTestCase: "delete_skill_test_case_skills__action_id__test_cases__test_case_id__delete";
23
+ deleteWorkflow: "delete_workflow_workflows__action_id__delete";
24
+ deleteWorkflowIntegration: "delete_workflow_integration_workflows_integrations__provider_name__delete";
25
+ describeFormFields: "describe_form_fields_workflows_forms__form_id__fields_get";
26
+ detachSkillCollection: "detach_skill_collection_skills__action_id__collections__collection_id__delete";
27
+ diffSkillVersions: "diff_skill_versions_skills__action_id__versions__version_id__diff_get";
28
+ executeWorkflow: "execute_workflow_workflows__action_id__execute_post";
29
+ getExecution: "get_execution_workflows_executions__execution_id__get";
30
+ getExecutionStats: "get_execution_stats_workflows_stats_executions_get";
31
+ getNodeTypesSchema: "get_node_types_schema_workflows_node_types_schema_get";
32
+ getTriggerActivity: "get_trigger_activity_workflows_stats_trigger_activity_get";
33
+ getTriggerStatus: "get_trigger_status_workflows__action_id__trigger_status_get";
34
+ getWorkflow: "get_workflow_workflows__action_id__get";
35
+ getWorkflowIntegration: "get_workflow_integration_workflows_integrations__provider_name__get";
36
+ getWorkflowNodeStats: "get_workflow_node_stats_workflows_node_stats_get";
37
+ getWorkflowRunSummary: "get_workflow_run_summary_workflows_run_summary_get";
38
+ inferSkillVariable: "infer_skill_variable_skills_infer_variable_post";
39
+ listDispositions: "list_dispositions_workflows_dispositions_get";
40
+ listInboxTags: "list_inbox_tags_workflows_inbox_tags_get";
41
+ listLinkedinSenders: "list_linkedin_senders_workflows_integrations_linkedin_senders_get";
42
+ listMcpServers: "list_mcp_servers_workflows_mcp_servers_get";
43
+ listRecentWorkflowRuns: "list_recent_workflow_runs_workflows__action_id__runs_recent_get";
44
+ listRoamGroups: "list_roam_groups_workflows_integrations_roam_groups_get";
45
+ listRoamUsers: "list_roam_users_workflows_integrations_roam_users_get";
46
+ listSkillCollections: "list_skill_collections_skills__action_id__collections_get";
47
+ listSkillTestCases: "list_skill_test_cases_skills__action_id__test_cases_get";
48
+ listSkillTestRuns: "list_skill_test_runs_skills__action_id__test_runs_get";
49
+ listSkillVersions: "list_skill_versions_skills__action_id__versions_get";
50
+ listSlackChannels: "list_slack_channels_workflows_integrations_slack_channels_get";
51
+ listSlackUsers: "list_slack_users_workflows_integrations_slack_users_get";
52
+ listWorkbenches: "list_workbenches_workflows_workbenches_get";
53
+ listWorkflowExecutions: "list_workflow_executions_workflows_executions_get";
54
+ listWorkflowIntegrations: "list_workflow_integrations_workflows_integrations_get";
55
+ listWorkflows: "list_workflows_workflows_get";
56
+ parseScriptParameters: "parse_script_parameters_skills_parse_script_parameters_post";
57
+ pauseExecution: "pause_execution_workflows_executions__execution_id__pause_post";
58
+ planInlineWorkflow: "plan_inline_workflow_workflows_plan_post";
59
+ planWorkflow: "plan_workflow_workflows__action_id__plan_post";
60
+ rejectExecution: "reject_execution_workflows_executions_reject_post";
61
+ requestExecutionChanges: "request_execution_changes_workflows_executions_request_changes_post";
62
+ resetTriggerCursor: "reset_trigger_cursor_workflows__action_id__trigger_reset_post";
63
+ resolveSkillTemplates: "resolve_skill_templates_skills_resolve_templates_post";
64
+ restartExecution: "restart_execution_workflows_executions__execution_id__restart_post";
65
+ restoreSkillVersion: "restore_skill_version_skills__action_id__versions__version_id__restore_post";
66
+ resumeExecution: "resume_execution_workflows_executions__execution_id__resume_post";
67
+ runSkillTestSuite: "run_skill_test_suite_skills__action_id__test_runs_post";
68
+ saveWorkflowIntegration: "save_workflow_integration_workflows_integrations__provider_name__post";
69
+ stopExecution: "stop_execution_workflows_executions__execution_id__stop_post";
70
+ testIntegrationCredential: "test_integration_credential_workflows_integrations__provider_name__test_post";
71
+ testSkillOnce: "test_skill_once_skills__action_id__test_post";
72
+ updateSkillTestCase: "update_skill_test_case_skills__action_id__test_cases__test_case_id__put";
73
+ updateWorkflow: "update_workflow_workflows__action_id__put";
74
+ validateWorkflow: "validate_workflow_workflows_validate_post";
75
+ }
76
+
77
+ /** Input and output of every `g8.api.workflows` operation, keyed by operationId. */
78
+ export interface WorkflowsOperations {
79
+ /**
80
+ * POST /workflows/executions/approve
81
+ * Approve a run waiting on a human
82
+ * tier: external · scope: workflows:run
83
+ */
84
+ approve_execution_workflows_executions_approve_post: {
85
+ input: {
86
+ headers?: {
87
+ "X-Target-Org-Id"?: string | null;
88
+ };
89
+ body: ExecutionApproval;
90
+ };
91
+ output: ApiResponse_VoicePayload_;
92
+ };
93
+ /**
94
+ * POST /skills/{action_id}/collections
95
+ * Give a skill collections to retrieve from
96
+ * tier: write · scope: workflows:write
97
+ */
98
+ attach_skill_collections_skills__action_id__collections_post: {
99
+ input: {
100
+ path: {
101
+ /** Skill or workflow `action_id`. */
102
+ action_id: string;
103
+ };
104
+ headers?: {
105
+ "X-Target-Org-Id"?: string | null;
106
+ };
107
+ body: Body_attach_skill_collections_skills__action_id__collections_post;
108
+ };
109
+ output: ApiResponse_VoicePayload_;
110
+ };
111
+ /**
112
+ * POST /workflows/executions/bulk-restart
113
+ * Restart many workflow executions
114
+ * tier: external · scope: workflows:run
115
+ */
116
+ bulk_restart_executions_workflows_executions_bulk_restart_post: {
117
+ input: {
118
+ headers?: {
119
+ "X-Target-Org-Id"?: string | null;
120
+ };
121
+ body?: Record<string, unknown>;
122
+ };
123
+ output: ApiResponse_VoicePayload_;
124
+ };
125
+ /**
126
+ * POST /skills/{action_id}/test-cases
127
+ * Save a test case for a skill
128
+ * tier: write · scope: workflows:write
129
+ */
130
+ create_skill_test_case_skills__action_id__test_cases_post: {
131
+ input: {
132
+ path: {
133
+ /** Skill or workflow `action_id`. */
134
+ action_id: string;
135
+ };
136
+ headers?: {
137
+ "X-Target-Org-Id"?: string | null;
138
+ };
139
+ body: Body_create_skill_test_case_skills__action_id__test_cases_post;
140
+ };
141
+ output: ApiResponse_VoicePayload_;
142
+ };
143
+ /**
144
+ * POST /workflows/workbenches
145
+ * Create a workbench (so a workflow has somewhere to write)
146
+ * tier: external · scope: workflows:run
147
+ */
148
+ create_workbench_workflows_workbenches_post: {
149
+ input: {
150
+ headers?: {
151
+ "X-Target-Org-Id"?: string | null;
152
+ };
153
+ body: Record<string, unknown>;
154
+ };
155
+ output: Record<string, unknown>;
156
+ };
157
+ /**
158
+ * POST /workflows
159
+ * Create a workflow
160
+ * tier: external · scope: workflows:run
161
+ */
162
+ create_workflow_workflows_post: {
163
+ input: {
164
+ headers?: {
165
+ "X-Target-Org-Id"?: string | null;
166
+ };
167
+ body: Record<string, unknown>;
168
+ };
169
+ output: Record<string, unknown>;
170
+ };
171
+ /**
172
+ * DELETE /skills/{action_id}/test-cases/{test_case_id}
173
+ * Delete a test case
174
+ * tier: destructive · scope: workflows:delete
175
+ */
176
+ delete_skill_test_case_skills__action_id__test_cases__test_case_id__delete: {
177
+ input: {
178
+ path: {
179
+ /** Skill or workflow `action_id`. */
180
+ action_id: string;
181
+ /** Test case id. */
182
+ test_case_id: string;
183
+ };
184
+ headers?: {
185
+ "X-Target-Org-Id"?: string | null;
186
+ };
187
+ };
188
+ output: ApiResponse_VoicePayload_;
189
+ };
190
+ /**
191
+ * DELETE /workflows/{action_id}
192
+ * Delete a workflow
193
+ * tier: destructive · scope: workflows:delete
194
+ */
195
+ delete_workflow_workflows__action_id__delete: {
196
+ input: {
197
+ path: {
198
+ /** Workflow action_id. */
199
+ action_id: string;
200
+ };
201
+ headers?: {
202
+ "X-Target-Org-Id"?: string | null;
203
+ };
204
+ };
205
+ output: Record<string, unknown>;
206
+ };
207
+ /**
208
+ * DELETE /workflows/integrations/{provider_name}
209
+ * Disconnect a workflow integration
210
+ * tier: destructive · scope: workflows:delete
211
+ */
212
+ delete_workflow_integration_workflows_integrations__provider_name__delete: {
213
+ input: {
214
+ path: {
215
+ /** Provider name. */
216
+ provider_name: string;
217
+ };
218
+ headers?: {
219
+ "X-Target-Org-Id"?: string | null;
220
+ };
221
+ };
222
+ output: ApiResponse_VoicePayload_;
223
+ };
224
+ /**
225
+ * GET /workflows/forms/{form_id}/fields
226
+ * Discover form field names from recent submissions (resolver helper)
227
+ * tier: read · scope: workflows:read
228
+ */
229
+ describe_form_fields_workflows_forms__form_id__fields_get: {
230
+ input: {
231
+ path: {
232
+ /** HTML form id (form_tag_id) */
233
+ form_id: string;
234
+ };
235
+ headers?: {
236
+ "X-Target-Org-Id"?: string | null;
237
+ };
238
+ };
239
+ output: Record<string, unknown>;
240
+ };
241
+ /**
242
+ * DELETE /skills/{action_id}/collections/{collection_id}
243
+ * Stop a skill retrieving from a collection
244
+ * tier: destructive · scope: workflows:delete
245
+ */
246
+ detach_skill_collection_skills__action_id__collections__collection_id__delete: {
247
+ input: {
248
+ path: {
249
+ /** Skill or workflow `action_id`. */
250
+ action_id: string;
251
+ /** Collection to unlink. */
252
+ collection_id: number;
253
+ };
254
+ headers?: {
255
+ "X-Target-Org-Id"?: string | null;
256
+ };
257
+ };
258
+ output: ApiResponse_VoicePayload_;
259
+ };
260
+ /**
261
+ * GET /skills/{action_id}/versions/{version_id}/diff
262
+ * Diff two versions of a skill
263
+ * tier: read · scope: workflows:read
264
+ */
265
+ diff_skill_versions_skills__action_id__versions__version_id__diff_get: {
266
+ input: {
267
+ path: {
268
+ /** Skill or workflow `action_id`. */
269
+ action_id: string;
270
+ /** The version to diff. */
271
+ version_id: string;
272
+ };
273
+ query?: {
274
+ /** The version to compare with. Defaults to the one immediately before. */
275
+ against?: string | null;
276
+ };
277
+ headers?: {
278
+ "X-Target-Org-Id"?: string | null;
279
+ };
280
+ };
281
+ output: ApiResponse_VoicePayload_;
282
+ };
283
+ /**
284
+ * POST /workflows/{action_id}/execute
285
+ * Execute a workflow
286
+ * tier: external · scope: workflows:run
287
+ */
288
+ execute_workflow_workflows__action_id__execute_post: {
289
+ input: {
290
+ path: {
291
+ /** Workflow action_id. */
292
+ action_id: string;
293
+ };
294
+ headers?: {
295
+ "X-Target-Org-Id"?: string | null;
296
+ };
297
+ body?: Record<string, unknown>;
298
+ };
299
+ output: Record<string, unknown>;
300
+ };
301
+ /**
302
+ * GET /workflows/executions/{execution_id}
303
+ * Get execution status / result
304
+ * tier: read · scope: workflows:read
305
+ */
306
+ get_execution_workflows_executions__execution_id__get: {
307
+ input: {
308
+ path: {
309
+ /** Execution UUID. */
310
+ execution_id: string;
311
+ };
312
+ headers?: {
313
+ "X-Target-Org-Id"?: string | null;
314
+ };
315
+ };
316
+ output: Record<string, unknown>;
317
+ };
318
+ /**
319
+ * GET /workflows/stats/executions
320
+ * Run health for the organisation or one skill
321
+ * tier: read · scope: workflows:read
322
+ */
323
+ get_execution_stats_workflows_stats_executions_get: {
324
+ input: {
325
+ query?: {
326
+ /** One skill's health; omit for the organisation. */
327
+ action_id?: string | null;
328
+ /** Window; omit for lifetime. */
329
+ days?: number | null;
330
+ };
331
+ headers?: {
332
+ "X-Target-Org-Id"?: string | null;
333
+ };
334
+ };
335
+ output: ApiResponse_VoicePayload_;
336
+ };
337
+ /**
338
+ * GET /workflows/node-types/schema
339
+ * Catalog of all workflow node types and their config schemas
340
+ * tier: read · scope: workflows:read
341
+ */
342
+ get_node_types_schema_workflows_node_types_schema_get: {
343
+ input: {
344
+ query?: {
345
+ /** "slim" returns name+type per field; "full" includes Pydantic JSON schema. */
346
+ detail?: string;
347
+ /** If provided, return just one entry instead of the full catalog. */
348
+ node_type?: string | null;
349
+ };
350
+ headers?: {
351
+ "X-Target-Org-Id"?: string | null;
352
+ };
353
+ };
354
+ output: Record<string, unknown>;
355
+ };
356
+ /**
357
+ * GET /workflows/stats/trigger-activity
358
+ * Whether workflow triggers are being evaluated
359
+ * tier: read · scope: workflows:read
360
+ */
361
+ get_trigger_activity_workflows_stats_trigger_activity_get: {
362
+ input: {
363
+ query: {
364
+ /** Comma-separated workflow ids (first 200 used). */
365
+ action_ids: string;
366
+ };
367
+ headers?: {
368
+ "X-Target-Org-Id"?: string | null;
369
+ };
370
+ };
371
+ output: ApiResponse_VoicePayload_;
372
+ };
373
+ /**
374
+ * GET /workflows/{action_id}/trigger-status
375
+ * Trigger status (cursor + config) for a workflow
376
+ * tier: read · scope: workflows:read
377
+ */
378
+ get_trigger_status_workflows__action_id__trigger_status_get: {
379
+ input: {
380
+ path: {
381
+ /** Workflow action_id. */
382
+ action_id: string;
383
+ };
384
+ headers?: {
385
+ "X-Target-Org-Id"?: string | null;
386
+ };
387
+ };
388
+ output: Record<string, unknown>;
389
+ };
390
+ /**
391
+ * GET /workflows/{action_id}
392
+ * Get a workflow's full graph
393
+ * tier: read · scope: workflows:read
394
+ */
395
+ get_workflow_workflows__action_id__get: {
396
+ input: {
397
+ path: {
398
+ /** Workflow action_id. */
399
+ action_id: string;
400
+ };
401
+ headers?: {
402
+ "X-Target-Org-Id"?: string | null;
403
+ };
404
+ };
405
+ output: Record<string, unknown>;
406
+ };
407
+ /**
408
+ * GET /workflows/integrations/{provider_name}
409
+ * Get one workflow integration
410
+ * tier: read · scope: workflows:read
411
+ */
412
+ get_workflow_integration_workflows_integrations__provider_name__get: {
413
+ input: {
414
+ path: {
415
+ /** Provider name. */
416
+ provider_name: string;
417
+ };
418
+ headers?: {
419
+ "X-Target-Org-Id"?: string | null;
420
+ };
421
+ };
422
+ output: ApiResponse_VoicePayload_;
423
+ };
424
+ /**
425
+ * GET /workflows/node-stats
426
+ * Per-node success and failure rates for a workflow
427
+ * tier: read · scope: workflows:read
428
+ */
429
+ get_workflow_node_stats_workflows_node_stats_get: {
430
+ input: {
431
+ query: {
432
+ /** The workflow to analyse. */
433
+ action_id: string;
434
+ /** Window, in days. */
435
+ days?: number;
436
+ };
437
+ headers?: {
438
+ "X-Target-Org-Id"?: string | null;
439
+ };
440
+ };
441
+ output: ApiResponse_VoicePayload_;
442
+ };
443
+ /**
444
+ * GET /workflows/run-summary
445
+ * Has this workflow ever run?
446
+ * tier: read · scope: workflows:read
447
+ */
448
+ get_workflow_run_summary_workflows_run_summary_get: {
449
+ input: {
450
+ query?: {
451
+ /** Comma-separated workflow ids. Omit for every workflow in the org. */
452
+ action_ids?: string | null;
453
+ };
454
+ headers?: {
455
+ "X-Target-Org-Id"?: string | null;
456
+ };
457
+ };
458
+ output: ApiResponse_VoicePayload_;
459
+ };
460
+ /**
461
+ * POST /skills/infer-variable
462
+ * Infer one skill variable from a record
463
+ * tier: write · scope: workflows:write
464
+ */
465
+ infer_skill_variable_skills_infer_variable_post: {
466
+ input: {
467
+ headers?: {
468
+ "X-Target-Org-Id"?: string | null;
469
+ };
470
+ body: Body_infer_skill_variable_skills_infer_variable_post;
471
+ };
472
+ output: ApiResponse_VoicePayload_;
473
+ };
474
+ /**
475
+ * GET /workflows/dispositions
476
+ * List valid call disposition values (system + this org's custom)
477
+ * tier: read · scope: workflows:read
478
+ */
479
+ list_dispositions_workflows_dispositions_get: {
480
+ input: {
481
+ headers?: {
482
+ "X-Target-Org-Id"?: string | null;
483
+ };
484
+ };
485
+ output: Record<string, unknown>;
486
+ };
487
+ /**
488
+ * GET /workflows/inbox-tags
489
+ * List AI Inbox tags for the org (resolver helper)
490
+ * tier: read · scope: workflows:read
491
+ */
492
+ list_inbox_tags_workflows_inbox_tags_get: {
493
+ input: {
494
+ query?: {
495
+ /** Return only tags an AI agent is allowed to apply automatically. */
496
+ ai_applicable_only?: boolean;
497
+ };
498
+ headers?: {
499
+ "X-Target-Org-Id"?: string | null;
500
+ };
501
+ };
502
+ output: Record<string, unknown>;
503
+ };
504
+ /**
505
+ * GET /workflows/integrations/linkedin/senders
506
+ * List LinkedIn sender accounts for the org (resolver helper)
507
+ * tier: read · scope: workflows:read
508
+ */
509
+ list_linkedin_senders_workflows_integrations_linkedin_senders_get: {
510
+ input: {
511
+ headers?: {
512
+ "X-Target-Org-Id"?: string | null;
513
+ };
514
+ };
515
+ output: Record<string, unknown>;
516
+ };
517
+ /**
518
+ * GET /workflows/mcp-servers
519
+ * List MCP servers connected to the org (resolver helper)
520
+ * tier: read · scope: workflows:read
521
+ */
522
+ list_mcp_servers_workflows_mcp_servers_get: {
523
+ input: {
524
+ headers?: {
525
+ "X-Target-Org-Id"?: string | null;
526
+ };
527
+ };
528
+ output: Record<string, unknown>;
529
+ };
530
+ /**
531
+ * GET /workflows/{action_id}/runs/recent
532
+ * Recent runs of one workflow
533
+ * tier: read · scope: workflows:read
534
+ */
535
+ list_recent_workflow_runs_workflows__action_id__runs_recent_get: {
536
+ input: {
537
+ path: {
538
+ /** Skill or workflow `action_id`. */
539
+ action_id: string;
540
+ };
541
+ query?: {
542
+ /** Rows to return, newest first. */
543
+ limit?: number;
544
+ };
545
+ headers?: {
546
+ "X-Target-Org-Id"?: string | null;
547
+ };
548
+ };
549
+ output: ApiResponse_VoiceListPayload_;
550
+ };
551
+ /**
552
+ * GET /workflows/integrations/roam/groups
553
+ * List Roam groups connected to the org (resolver helper)
554
+ * tier: read · scope: workflows:read
555
+ */
556
+ list_roam_groups_workflows_integrations_roam_groups_get: {
557
+ input: {
558
+ headers?: {
559
+ "X-Target-Org-Id"?: string | null;
560
+ };
561
+ };
562
+ output: Record<string, unknown>;
563
+ };
564
+ /**
565
+ * GET /workflows/integrations/roam/users
566
+ * List Roam users connected to the org (resolver helper)
567
+ * tier: read · scope: workflows:read
568
+ */
569
+ list_roam_users_workflows_integrations_roam_users_get: {
570
+ input: {
571
+ headers?: {
572
+ "X-Target-Org-Id"?: string | null;
573
+ };
574
+ };
575
+ output: Record<string, unknown>;
576
+ };
577
+ /**
578
+ * GET /skills/{action_id}/collections
579
+ * Collections a skill retrieves from
580
+ * tier: read · scope: workflows:read
581
+ */
582
+ list_skill_collections_skills__action_id__collections_get: {
583
+ input: {
584
+ path: {
585
+ /** Skill or workflow `action_id`. */
586
+ action_id: string;
587
+ };
588
+ headers?: {
589
+ "X-Target-Org-Id"?: string | null;
590
+ };
591
+ };
592
+ output: ApiResponse_VoiceListPayload_;
593
+ };
594
+ /**
595
+ * GET /skills/{action_id}/test-cases
596
+ * List a skill's saved test cases
597
+ * tier: read · scope: workflows:read
598
+ */
599
+ list_skill_test_cases_skills__action_id__test_cases_get: {
600
+ input: {
601
+ path: {
602
+ /** Skill or workflow `action_id`. */
603
+ action_id: string;
604
+ };
605
+ headers?: {
606
+ "X-Target-Org-Id"?: string | null;
607
+ };
608
+ };
609
+ output: ApiResponse_VoiceListPayload_;
610
+ };
611
+ /**
612
+ * GET /skills/{action_id}/test-runs
613
+ * A skill's test-run history
614
+ * tier: read · scope: workflows:read
615
+ */
616
+ list_skill_test_runs_skills__action_id__test_runs_get: {
617
+ input: {
618
+ path: {
619
+ /** Skill or workflow `action_id`. */
620
+ action_id: string;
621
+ };
622
+ query?: {
623
+ /** Only runs of this case. */
624
+ test_case_id?: string | null;
625
+ /** Rows to return, newest first. */
626
+ limit?: number;
627
+ /** True adds the stored output previews. They can be large. */
628
+ include_output?: boolean;
629
+ };
630
+ headers?: {
631
+ "X-Target-Org-Id"?: string | null;
632
+ };
633
+ };
634
+ output: ApiResponse_VoiceListPayload_;
635
+ };
636
+ /**
637
+ * GET /skills/{action_id}/versions
638
+ * A skill's versions
639
+ * tier: read · scope: workflows:read
640
+ */
641
+ list_skill_versions_skills__action_id__versions_get: {
642
+ input: {
643
+ path: {
644
+ /** Skill (action) id. */
645
+ action_id: string;
646
+ };
647
+ query?: {
648
+ /** Newest first. */
649
+ limit?: number;
650
+ };
651
+ headers?: {
652
+ "X-Target-Org-Id"?: string | null;
653
+ };
654
+ };
655
+ output: ApiResponse_VoicePayload_;
656
+ };
657
+ /**
658
+ * GET /workflows/integrations/slack/channels
659
+ * List Slack channels for the org (resolver helper)
660
+ * tier: read · scope: workflows:read
661
+ */
662
+ list_slack_channels_workflows_integrations_slack_channels_get: {
663
+ input: {
664
+ headers?: {
665
+ "X-Target-Org-Id"?: string | null;
666
+ };
667
+ };
668
+ output: Record<string, unknown>;
669
+ };
670
+ /**
671
+ * GET /workflows/integrations/slack/users
672
+ * List Slack users for the org (resolver helper)
673
+ * tier: read · scope: workflows:read
674
+ */
675
+ list_slack_users_workflows_integrations_slack_users_get: {
676
+ input: {
677
+ headers?: {
678
+ "X-Target-Org-Id"?: string | null;
679
+ };
680
+ };
681
+ output: Record<string, unknown>;
682
+ };
683
+ /**
684
+ * GET /workflows/workbenches
685
+ * List workbenches for the org (resolver helper)
686
+ * tier: read · scope: workflows:read
687
+ */
688
+ list_workbenches_workflows_workbenches_get: {
689
+ input: {
690
+ query?: {
691
+ /** Page size. */
692
+ limit?: number;
693
+ /** 1-based page number. */
694
+ page?: number;
695
+ /** Case-insensitive name filter. */
696
+ filter_name?: string | null;
697
+ };
698
+ headers?: {
699
+ "X-Target-Org-Id"?: string | null;
700
+ };
701
+ };
702
+ output: Record<string, unknown>;
703
+ };
704
+ /**
705
+ * GET /workflows/executions
706
+ * List workflow executions for the caller's org (recover a lost execution_id)
707
+ * tier: read · scope: workflows:read
708
+ */
709
+ list_workflow_executions_workflows_executions_get: {
710
+ input: {
711
+ query?: {
712
+ /** Filter to a single workflow's executions. */
713
+ action_id?: string | null;
714
+ /** Filter by execution status (equality match — one status per call). The backend writes seven values: pending|running|completed|failed|paused|pending_approval|stopped. The four terminal-or-early states are pending, running, completed, failed; paused and pending_approval are resumable, stopped is terminal. */
715
+ status_filter?: string | null;
716
+ /** Filter by the identity that started the run (user email, agent id, 'api', ...). */
717
+ triggered_by?: string | null;
718
+ /** Page size (1..200). */
719
+ limit?: number;
720
+ /** Rows to skip for pagination. */
721
+ offset?: number;
722
+ };
723
+ headers?: {
724
+ "X-Target-Org-Id"?: string | null;
725
+ };
726
+ };
727
+ output: Record<string, unknown>;
728
+ };
729
+ /**
730
+ * GET /workflows/integrations
731
+ * List connected workflow integrations
732
+ * tier: read · scope: workflows:read
733
+ */
734
+ list_workflow_integrations_workflows_integrations_get: {
735
+ input: {
736
+ headers?: {
737
+ "X-Target-Org-Id"?: string | null;
738
+ };
739
+ };
740
+ output: ApiResponse_VoiceListPayload_;
741
+ };
742
+ /**
743
+ * GET /workflows
744
+ * List workflows for the caller's org
745
+ * tier: read · scope: workflows:read
746
+ */
747
+ list_workflows_workflows_get: {
748
+ input: {
749
+ query?: {
750
+ /** Filter by enabled flag. */
751
+ enabled?: boolean | null;
752
+ /** Filter by category. */
753
+ category?: string | null;
754
+ /** Templates only when true. */
755
+ is_template?: boolean | null;
756
+ };
757
+ headers?: {
758
+ "X-Target-Org-Id"?: string | null;
759
+ };
760
+ };
761
+ output: Record<string, unknown>;
762
+ };
763
+ /**
764
+ * POST /skills/parse-script-parameters
765
+ * Detect a script's parameters from its code
766
+ * tier: write · scope: workflows:write
767
+ */
768
+ parse_script_parameters_skills_parse_script_parameters_post: {
769
+ input: {
770
+ headers?: {
771
+ "X-Target-Org-Id"?: string | null;
772
+ };
773
+ body: Body_parse_script_parameters_skills_parse_script_parameters_post;
774
+ };
775
+ output: ApiResponse_VoicePayload_;
776
+ };
777
+ /**
778
+ * POST /workflows/executions/{execution_id}/pause
779
+ * Pause a running execution (tenant-checked)
780
+ * tier: external · scope: workflows:run
781
+ */
782
+ pause_execution_workflows_executions__execution_id__pause_post: {
783
+ input: {
784
+ path: {
785
+ /** Execution UUID. */
786
+ execution_id: string;
787
+ };
788
+ headers?: {
789
+ "X-Target-Org-Id"?: string | null;
790
+ };
791
+ body?: Record<string, unknown>;
792
+ };
793
+ output: Record<string, unknown>;
794
+ };
795
+ /**
796
+ * POST /workflows/plan
797
+ * Preview a normalized execution plan for an inline workflow graph
798
+ * tier: read · scope: workflows:read
799
+ */
800
+ plan_inline_workflow_workflows_plan_post: {
801
+ input: {
802
+ headers?: {
803
+ "X-Target-Org-Id"?: string | null;
804
+ };
805
+ body: Record<string, unknown>;
806
+ };
807
+ output: Record<string, unknown>;
808
+ };
809
+ /**
810
+ * POST /workflows/{action_id}/plan
811
+ * Preview a normalized execution plan for a saved workflow
812
+ * tier: read · scope: workflows:read
813
+ */
814
+ plan_workflow_workflows__action_id__plan_post: {
815
+ input: {
816
+ path: {
817
+ /** Workflow action_id. */
818
+ action_id: string;
819
+ };
820
+ headers?: {
821
+ "X-Target-Org-Id"?: string | null;
822
+ };
823
+ body?: Record<string, unknown>;
824
+ };
825
+ output: Record<string, unknown>;
826
+ };
827
+ /**
828
+ * POST /workflows/executions/reject
829
+ * Reject a run waiting on a human
830
+ * tier: write · scope: workflows:write
831
+ */
832
+ reject_execution_workflows_executions_reject_post: {
833
+ input: {
834
+ headers?: {
835
+ "X-Target-Org-Id"?: string | null;
836
+ };
837
+ body: ExecutionRejection;
838
+ };
839
+ output: ApiResponse_VoicePayload_;
840
+ };
841
+ /**
842
+ * POST /workflows/executions/request-changes
843
+ * Answer a human-approval step with changes requested
844
+ * tier: external · scope: workflows:run
845
+ */
846
+ request_execution_changes_workflows_executions_request_changes_post: {
847
+ input: {
848
+ headers?: {
849
+ "X-Target-Org-Id"?: string | null;
850
+ };
851
+ body: Body_request_execution_changes_workflows_executions_request_changes_post;
852
+ };
853
+ output: ApiResponse_VoicePayload_;
854
+ };
855
+ /**
856
+ * POST /workflows/{action_id}/trigger-reset
857
+ * Reset the trigger cursor to now
858
+ * tier: external · scope: workflows:run
859
+ */
860
+ reset_trigger_cursor_workflows__action_id__trigger_reset_post: {
861
+ input: {
862
+ path: {
863
+ /** Workflow action_id. */
864
+ action_id: string;
865
+ };
866
+ headers?: {
867
+ "X-Target-Org-Id"?: string | null;
868
+ };
869
+ };
870
+ output: Record<string, unknown>;
871
+ };
872
+ /**
873
+ * POST /skills/resolve-templates
874
+ * Resolve skill template names to ids
875
+ * tier: write · scope: workflows:write
876
+ */
877
+ resolve_skill_templates_skills_resolve_templates_post: {
878
+ input: {
879
+ headers?: {
880
+ "X-Target-Org-Id"?: string | null;
881
+ };
882
+ body: Record<string, unknown>;
883
+ };
884
+ output: ApiResponse_VoicePayload_;
885
+ };
886
+ /**
887
+ * POST /workflows/executions/{execution_id}/restart
888
+ * Restart one workflow execution
889
+ * tier: external · scope: workflows:run
890
+ */
891
+ restart_execution_workflows_executions__execution_id__restart_post: {
892
+ input: {
893
+ path: {
894
+ /** Execution id. */
895
+ execution_id: string;
896
+ };
897
+ headers?: {
898
+ "X-Target-Org-Id"?: string | null;
899
+ };
900
+ body?: Record<string, unknown>;
901
+ };
902
+ output: ApiResponse_VoicePayload_;
903
+ };
904
+ /**
905
+ * POST /skills/{action_id}/versions/{version_id}/restore
906
+ * Restore an earlier version of a skill
907
+ * tier: write · scope: workflows:write
908
+ */
909
+ restore_skill_version_skills__action_id__versions__version_id__restore_post: {
910
+ input: {
911
+ path: {
912
+ /** Skill (action) id. */
913
+ action_id: string;
914
+ /** The version to bring back. */
915
+ version_id: string;
916
+ };
917
+ headers?: {
918
+ "X-Target-Org-Id"?: string | null;
919
+ };
920
+ };
921
+ output: ApiResponse_VoicePayload_;
922
+ };
923
+ /**
924
+ * POST /workflows/executions/{execution_id}/resume
925
+ * Resume a paused execution (tenant-checked)
926
+ * tier: external · scope: workflows:run
927
+ */
928
+ resume_execution_workflows_executions__execution_id__resume_post: {
929
+ input: {
930
+ path: {
931
+ /** Execution UUID. */
932
+ execution_id: string;
933
+ };
934
+ headers?: {
935
+ "X-Target-Org-Id"?: string | null;
936
+ };
937
+ body?: Record<string, unknown>;
938
+ };
939
+ output: Record<string, unknown>;
940
+ };
941
+ /**
942
+ * POST /skills/{action_id}/test-runs
943
+ * Run every saved test case against a skill
944
+ * tier: external · scope: workflows:run
945
+ */
946
+ run_skill_test_suite_skills__action_id__test_runs_post: {
947
+ input: {
948
+ path: {
949
+ /** Skill or workflow `action_id`. */
950
+ action_id: string;
951
+ };
952
+ headers?: {
953
+ "X-Target-Org-Id"?: string | null;
954
+ };
955
+ };
956
+ output: ApiResponse_VoicePayload_;
957
+ };
958
+ /**
959
+ * POST /workflows/integrations/{provider_name}
960
+ * Connect or update a workflow integration
961
+ * tier: write · scope: workflows:write
962
+ */
963
+ save_workflow_integration_workflows_integrations__provider_name__post: {
964
+ input: {
965
+ path: {
966
+ /** Provider name. */
967
+ provider_name: string;
968
+ };
969
+ headers?: {
970
+ "X-Target-Org-Id"?: string | null;
971
+ };
972
+ body?: Body_save_workflow_integration_workflows_integrations__provider_name__post;
973
+ };
974
+ output: ApiResponse_VoicePayload_;
975
+ };
976
+ /**
977
+ * POST /workflows/executions/{execution_id}/stop
978
+ * Permanently stop an execution (tenant-checked)
979
+ * tier: external · scope: workflows:run
980
+ */
981
+ stop_execution_workflows_executions__execution_id__stop_post: {
982
+ input: {
983
+ path: {
984
+ /** Execution UUID. */
985
+ execution_id: string;
986
+ };
987
+ headers?: {
988
+ "X-Target-Org-Id"?: string | null;
989
+ };
990
+ body?: Record<string, unknown>;
991
+ };
992
+ output: Record<string, unknown>;
993
+ };
994
+ /**
995
+ * POST /workflows/integrations/{provider_name}/test
996
+ * Try a Roam or Slack token
997
+ * tier: external · scope: workflows:run
998
+ */
999
+ test_integration_credential_workflows_integrations__provider_name__test_post: {
1000
+ input: {
1001
+ path: {
1002
+ /** roam or slack. */
1003
+ provider_name: "roam" | "slack";
1004
+ };
1005
+ headers?: {
1006
+ "X-Target-Org-Id"?: string | null;
1007
+ };
1008
+ body: IntegrationCredentialTest;
1009
+ };
1010
+ output: ApiResponse_VoicePayload_;
1011
+ };
1012
+ /**
1013
+ * POST /skills/{action_id}/test
1014
+ * Dry-run a skill once
1015
+ * tier: write · scope: workflows:write
1016
+ */
1017
+ test_skill_once_skills__action_id__test_post: {
1018
+ input: {
1019
+ path: {
1020
+ /** Skill (action) id. */
1021
+ action_id: string;
1022
+ };
1023
+ headers?: {
1024
+ "X-Target-Org-Id"?: string | null;
1025
+ };
1026
+ body: SkillTestRun;
1027
+ };
1028
+ output: ApiResponse_VoicePayload_;
1029
+ };
1030
+ /**
1031
+ * PUT /skills/{action_id}/test-cases/{test_case_id}
1032
+ * Update a test case
1033
+ * tier: write · scope: workflows:write
1034
+ */
1035
+ update_skill_test_case_skills__action_id__test_cases__test_case_id__put: {
1036
+ input: {
1037
+ path: {
1038
+ /** Skill or workflow `action_id`. */
1039
+ action_id: string;
1040
+ /** Test case id. */
1041
+ test_case_id: string;
1042
+ };
1043
+ headers?: {
1044
+ "X-Target-Org-Id"?: string | null;
1045
+ };
1046
+ body: Record<string, unknown>;
1047
+ };
1048
+ output: ApiResponse_VoicePayload_;
1049
+ };
1050
+ /**
1051
+ * PUT /workflows/{action_id}
1052
+ * Update a workflow's graph
1053
+ * tier: external · scope: workflows:run
1054
+ */
1055
+ update_workflow_workflows__action_id__put: {
1056
+ input: {
1057
+ path: {
1058
+ /** Workflow action_id. */
1059
+ action_id: string;
1060
+ };
1061
+ headers?: {
1062
+ "X-Target-Org-Id"?: string | null;
1063
+ };
1064
+ body: Record<string, unknown>;
1065
+ };
1066
+ output: Record<string, unknown>;
1067
+ };
1068
+ /**
1069
+ * POST /workflows/validate
1070
+ * Validate a workflow graph (structural + reference resolution)
1071
+ * tier: external · scope: workflows:run
1072
+ */
1073
+ validate_workflow_workflows_validate_post: {
1074
+ input: {
1075
+ headers?: {
1076
+ "X-Target-Org-Id"?: string | null;
1077
+ };
1078
+ body: Record<string, unknown>;
1079
+ };
1080
+ output: Record<string, unknown>;
1081
+ };
1082
+ }
1083
+
1084
+ // 15 schemas referenced above (the same as G8Contract.<Name>).
1085
+
1086
+ export interface ApiResponse_VoiceListPayload_ {
1087
+ data: VoiceListPayload;
1088
+ pagination?: PaginationMeta | null;
1089
+ }
1090
+
1091
+ export interface ApiResponse_VoicePayload_ {
1092
+ data: VoicePayload;
1093
+ pagination?: PaginationMeta | null;
1094
+ }
1095
+
1096
+ export interface Body_attach_skill_collections_skills__action_id__collections_post {
1097
+ /** Collections to attach. Additive - existing links survive. */
1098
+ collection_ids: Array<number>;
1099
+ }
1100
+
1101
+ export interface Body_create_skill_test_case_skills__action_id__test_cases_post {
1102
+ /** Extra configuration for the assertion. */
1103
+ assertion_config?: Record<string, unknown> | null;
1104
+ /** "exact", "contains" or "llm_judge". `llm_judge` is skipped by dry runs. */
1105
+ assertion_type?: string;
1106
+ /** What the assertion compares against. */
1107
+ expected_output?: unknown | null;
1108
+ /** The fixture, same shape as an execution's input. */
1109
+ input_data: Record<string, unknown>;
1110
+ /** Human label. */
1111
+ name: string;
1112
+ }
1113
+
1114
+ export interface Body_infer_skill_variable_skills_infer_variable_post {
1115
+ /** The contact or company record, same shape as an execution input. */
1116
+ entity_data: Record<string, unknown>;
1117
+ /** "contact" or "company". */
1118
+ entity_data_type: string;
1119
+ /** Record id. Used for cache keying only. */
1120
+ entity_id?: string | null;
1121
+ }
1122
+
1123
+ export interface Body_parse_script_parameters_skills_parse_script_parameters_post {
1124
+ /** The script source. */
1125
+ code: string;
1126
+ /** "python", "javascript" or "typescript". */
1127
+ language?: string;
1128
+ }
1129
+
1130
+ export interface Body_request_execution_changes_workflows_executions_request_changes_post {
1131
+ /** REQUIRED and non-blank. It is the value the revise branch reads as `${<human_node>.feedback}` - an empty one sends the workflow down the revise path with nothing to revise against. */
1132
+ feedback: string;
1133
+ /** Who is asking for changes. */
1134
+ requested_by: string;
1135
+ /** The workflow the run belongs to. */
1136
+ workflow_id: string;
1137
+ }
1138
+
1139
+ export interface Body_save_workflow_integration_workflows_integrations__provider_name__post {
1140
+ /** The provider credential. WRITE-ONLY: no route on this API returns it. Omitting it on an update leaves the stored key in place. */
1141
+ api_key?: string | null;
1142
+ /** Provider-specific settings. */
1143
+ configuration?: Record<string, unknown> | null;
1144
+ }
1145
+
1146
+ /** voice `ApprovalRequest`, without `org_id`. */
1147
+ export interface ExecutionApproval {
1148
+ /** Who approved; voice checks they may. */
1149
+ approved_by: string;
1150
+ notes?: string | null;
1151
+ /** The paused run's workflow id. */
1152
+ workflow_id: string;
1153
+ }
1154
+
1155
+ /** voice `RejectionRequest`, without `org_id`. */
1156
+ export interface ExecutionRejection {
1157
+ reason?: string | null;
1158
+ /** Who rejected; voice checks they may. */
1159
+ rejected_by: string;
1160
+ /** The paused run's workflow id. */
1161
+ workflow_id: string;
1162
+ }
1163
+
1164
+ /** voice `WorkflowIntegrationTestRequest`. */
1165
+ export interface IntegrationCredentialTest {
1166
+ /** The token to try. Not stored. */
1167
+ api_key: string;
1168
+ }
1169
+
1170
+ export interface PaginationMeta {
1171
+ /** Whether there are more pages */
1172
+ has_next: boolean;
1173
+ /** Items per page */
1174
+ limit: number;
1175
+ /** 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. */
1176
+ next_cursor?: string | null;
1177
+ /** Current page number (1-indexed) */
1178
+ page: number;
1179
+ /** Total number of items */
1180
+ total: number;
1181
+ }
1182
+
1183
+ /** voice `SkillTestRunRequest`: one dry run, from a saved case OR ad-hoc inputs. */
1184
+ export interface SkillTestRun {
1185
+ /** Ad-hoc only. */
1186
+ assertion_config?: Record<string, unknown> | null;
1187
+ /** Ad-hoc only. */
1188
+ assertion_type?: ("exact" | "contains" | "llm_judge") | null;
1189
+ /** Ad-hoc only: value to assert against. */
1190
+ expected_output?: unknown | null;
1191
+ /** Ad-hoc inputs (no saved case). */
1192
+ input_data?: Record<string, unknown> | null;
1193
+ /** Run this saved case. */
1194
+ test_case_id?: string | null;
1195
+ /** Attribution for the run history. */
1196
+ triggered_by?: string | null;
1197
+ }
1198
+
1199
+ /**
1200
+ * A LIST result from voice, normalised so `items` is always present.
1201
+ *
1202
+ * Voice is inconsistent about whether a list comes back bare or under a named
1203
+ * key (`collections`, `files`, `routes`, `chats`, ...). Both are preserved:
1204
+ * the original key is kept for anyone reading voice's docs, and `items`
1205
+ * always holds the same rows so a client can page one way.
1206
+ */
1207
+ export interface VoiceListPayload {
1208
+ items?: Array<unknown>;
1209
+ [key: string]: unknown;
1210
+ }
1211
+
1212
+ /**
1213
+ * One voice object - a collection, an agent, a route, a chat.
1214
+ *
1215
+ * Open-shaped: voice adds fields to these bodies on its own release cadence
1216
+ * and a dropped-or-added key must not be a 500 in this service.
1217
+ */
1218
+ export type VoicePayload = Record<string, unknown>;