@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,780 @@
1
+ <!-- Generated by sdk/js/scripts/generate-agent-docs.ts from developer-contract/openapi.json. Regenerated on every build. -->
2
+
3
+ # `g8.api.gtmLibrary`: GTM Library
4
+
5
+ 20 operations (4 read, 9 write, 3 destructive, 4 billable).
6
+
7
+ No hand-written client covers this area. Call it through `g8.api.gtmLibrary.*` as shown below, or by operationId with `g8.api.call(operationId, input)`.
8
+
9
+ Every example below assumes this setup (server-side, API key):
10
+
11
+ ```ts
12
+ import { g8 } from "@graph8/sdk";
13
+
14
+ g8.init({ apiKey: process.env.G8_API_KEY! });
15
+ ```
16
+
17
+ Example values are placeholders that match each field's type. Only required fields are shown. Every example is type-checked against the SDK in CI.
18
+
19
+ Exact TypeScript types for every operation on this page, and every schema they use: [gtmLibrary.d.ts](gtmLibrary.d.ts).
20
+
21
+ ## Operations
22
+
23
+ | Call | HTTP | Tier | Scope | Summary |
24
+ |---|---|---|---|---|
25
+ | [`createCommittee`](#op-createcommittee) | `POST /api/v1/committees` | write | `campaigns:write` | Create Committee |
26
+ | [`deleteCommittee`](#op-deletecommittee) | `DELETE /api/v1/committees/{committee_id}` | destructive | `campaigns:delete` | Delete Committee |
27
+ | [`deletePersona`](#op-deletepersona) | `DELETE /api/v1/personas/{persona_id}` | destructive | `campaigns:delete` | Delete Persona |
28
+ | [`deleteTam`](#op-deletetam) | `DELETE /api/v1/tam` | destructive | `campaigns:delete` | Delete Tam |
29
+ | [`fillPersonasFromGlobalDoc`](#op-fillpersonasfromglobaldoc) | `POST /api/v1/personas/from-global-doc` | write | `campaigns:write` | Fill Personas From Global Doc |
30
+ | [`generateIcps`](#op-generateicps) | `POST /api/v1/icps/generate` | billable | `campaigns:run` | Generate Icps |
31
+ | [`generatePersonas`](#op-generatepersonas) | `POST /api/v1/personas/generate` | billable | `campaigns:run` | Generate Personas |
32
+ | [`generateTam`](#op-generatetam) | `POST /api/v1/tam/generate` | billable | `campaigns:run` | Generate Tam |
33
+ | [`getCommittee`](#op-getcommittee) | `GET /api/v1/committees/{committee_id}` | read | `campaigns:read` | Get Committee |
34
+ | [`getPersona`](#op-getpersona) | `GET /api/v1/personas/{persona_id}` | read | `campaigns:read` | Get Persona |
35
+ | [`getTam`](#op-gettam) | `GET /api/v1/tam` | read | `campaigns:read` | Get Tam |
36
+ | [`listCommittees`](#op-listcommittees) | `GET /api/v1/committees` | read | `campaigns:read` | List Committees |
37
+ | [`pinIcp`](#op-pinicp) | `POST /api/v1/icps/{icp_id}/pin` | write | `campaigns:write` | Pin Icp |
38
+ | [`pinPersona`](#op-pinpersona) | `POST /api/v1/personas/{persona_id}/pin` | write | `campaigns:write` | Pin Persona |
39
+ | [`regenerateTam`](#op-regeneratetam) | `POST /api/v1/tam/regenerate` | billable | `campaigns:run` | Regenerate Tam |
40
+ | [`replaceCommitteeMembers`](#op-replacecommitteemembers) | `PUT /api/v1/committees/{committee_id}/members` | write | `campaigns:write` | Replace Committee Members |
41
+ | [`unpinIcp`](#op-unpinicp) | `POST /api/v1/icps/{icp_id}/unpin` | write | `campaigns:write` | Unpin Icp |
42
+ | [`unpinPersona`](#op-unpinpersona) | `POST /api/v1/personas/{persona_id}/unpin` | write | `campaigns:write` | Unpin Persona |
43
+ | [`updateCommittee`](#op-updatecommittee) | `PATCH /api/v1/committees/{committee_id}` | write | `campaigns:write` | Update Committee |
44
+ | [`updateTam`](#op-updatetam) | `PATCH /api/v1/tam` | write | `campaigns:write` | Update Tam |
45
+
46
+ ---
47
+
48
+ <a id="op-createcommittee"></a>
49
+
50
+ ### `g8.api.gtmLibrary.createCommittee(input)`
51
+
52
+ **Create Committee**
53
+
54
+ - HTTP: `POST /api/v1/committees`
55
+ - operationId: `create_committee_committees_post` (also callable as `g8.api.call("create_committee_committees_post", input)`)
56
+ - Tier: `write`: creates or changes records; the SDK sends an Idempotency-Key and retries transient failures
57
+ - API-key scope: `campaigns:write`
58
+
59
+ Create a buying committee.
60
+
61
+ **Input**
62
+
63
+ | Field | Type | Required | Description |
64
+ |---|---|---|---|
65
+ | `body` | `CommitteeCreateRequest` | yes | Request body; fields below. |
66
+
67
+ Body fields (`CommitteeCreateRequest`):
68
+
69
+ | Field | Type | Required | Description |
70
+ |---|---|---|---|
71
+ | `body.name` | `string` | yes | |
72
+ | `body.description` | `string \| null` | no | |
73
+ | `body.is_default` | `boolean \| null` | no | Make this the org's default committee (unsets the previous one). default `false` |
74
+
75
+ **Returns** `ApiResponse_GtmLibraryPayload_`: the envelope `{ data: GtmLibraryPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
76
+
77
+ Other envelope fields: `pagination` (PaginationMeta).
78
+
79
+ **Example**
80
+
81
+ ```ts
82
+ const result = await g8.api.gtmLibrary.createCommittee({ body: { name: "Example" } });
83
+ ```
84
+
85
+ ---
86
+
87
+ <a id="op-deletecommittee"></a>
88
+
89
+ ### `g8.api.gtmLibrary.deleteCommittee(input)`
90
+
91
+ **Delete Committee**
92
+
93
+ - HTTP: `DELETE /api/v1/committees/{committee_id}`
94
+ - operationId: `delete_committee_committees__committee_id__delete` (also callable as `g8.api.call("delete_committee_committees__committee_id__delete", input)`)
95
+ - Tier: `destructive`: deletes or archives data; confirm with a human before calling
96
+ - API-key scope: `campaigns:delete`
97
+
98
+ Delete a committee. Its member rows go with it.
99
+
100
+ **Input**
101
+
102
+ | Field | Type | Required | Description |
103
+ |---|---|---|---|
104
+ | `path.committee_id` | `string (uuid)` | yes | Committee id. |
105
+
106
+ **Returns** `ApiResponse_GtmLibraryPayload_`: the envelope `{ data: GtmLibraryPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
107
+
108
+ Other envelope fields: `pagination` (PaginationMeta).
109
+
110
+ **Example**
111
+
112
+ ```ts
113
+ // destructive: deletes or archives data; confirm with a human before calling.
114
+ const result = await g8.api.gtmLibrary.deleteCommittee({ path: { committee_id: "00000000-0000-0000-0000-000000000000" } });
115
+ ```
116
+
117
+ ---
118
+
119
+ <a id="op-deletepersona"></a>
120
+
121
+ ### `g8.api.gtmLibrary.deletePersona(input)`
122
+
123
+ **Delete Persona**
124
+
125
+ - HTTP: `DELETE /api/v1/personas/{persona_id}`
126
+ - operationId: `delete_persona_personas__persona_id__delete` (also callable as `g8.api.call("delete_persona_personas__persona_id__delete", input)`)
127
+ - Tier: `destructive`: deletes or archives data; confirm with a human before calling
128
+ - API-key scope: `campaigns:delete`
129
+
130
+ Permanently delete a persona. `POST /personas/{id}/archive` is the reversible option.
131
+
132
+ **Input**
133
+
134
+ | Field | Type | Required | Description |
135
+ |---|---|---|---|
136
+ | `path.persona_id` | `string` | yes | Persona id. |
137
+
138
+ **Returns** `ApiResponse_GtmLibraryPayload_`: the envelope `{ data: GtmLibraryPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
139
+
140
+ Other envelope fields: `pagination` (PaginationMeta).
141
+
142
+ **Example**
143
+
144
+ ```ts
145
+ // destructive: deletes or archives data; confirm with a human before calling.
146
+ const result = await g8.api.gtmLibrary.deletePersona({ path: { persona_id: "id" } });
147
+ ```
148
+
149
+ ---
150
+
151
+ <a id="op-deletetam"></a>
152
+
153
+ ### `g8.api.gtmLibrary.deleteTam(input?)`
154
+
155
+ **Delete Tam**
156
+
157
+ - HTTP: `DELETE /api/v1/tam`
158
+ - operationId: `delete_tam_tam_delete` (also callable as `g8.api.call("delete_tam_tam_delete", input)`)
159
+ - Tier: `destructive`: deletes or archives data; confirm with a human before calling
160
+ - API-key scope: `campaigns:delete`
161
+
162
+ Delete a TAM definition.
163
+
164
+ **Input**
165
+
166
+ | Field | Type | Required | Description |
167
+ |---|---|---|---|
168
+ | `query.website_url` | `string \| null` | no | Which website's TAM to delete. |
169
+
170
+ **Returns** `ApiResponse_GtmLibraryPayload_`: the envelope `{ data: GtmLibraryPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
171
+
172
+ Other envelope fields: `pagination` (PaginationMeta).
173
+
174
+ **Example**
175
+
176
+ ```ts
177
+ // destructive: deletes or archives data; confirm with a human before calling.
178
+ const result = await g8.api.gtmLibrary.deleteTam();
179
+ ```
180
+
181
+ ---
182
+
183
+ <a id="op-fillpersonasfromglobaldoc"></a>
184
+
185
+ ### `g8.api.gtmLibrary.fillPersonasFromGlobalDoc(input?)`
186
+
187
+ **Fill Personas From Global Doc**
188
+
189
+ - HTTP: `POST /api/v1/personas/from-global-doc`
190
+ - operationId: `fill_personas_from_global_doc_personas_from_global_doc_post` (also callable as `g8.api.call("fill_personas_from_global_doc_personas_from_global_doc_post", input)`)
191
+ - Tier: `write`: creates or changes records; the SDK sends an Idempotency-Key and retries transient failures
192
+ - API-key scope: `campaigns:write`
193
+
194
+ Create or complete personas from the finished persona-research document.
195
+
196
+ Idempotent. A persona with a committee role already set is left alone.
197
+
198
+ **Input**
199
+
200
+ | Field | Type | Required | Description |
201
+ |---|---|---|---|
202
+ | `body` | `PersonaFillFromDocRequest \| null` | no | Request body; fields below. |
203
+
204
+ Body fields:
205
+
206
+ | Field | Type | Required | Description |
207
+ |---|---|---|---|
208
+ | `body.website_url` | `string \| null` | no | Stored on any persona row this creates. Optional: the committees view is org-wide and does not filter on it. |
209
+
210
+ **Returns** `ApiResponse_GtmLibraryListPayload_`: the envelope `{ data: GtmLibraryListPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
211
+
212
+ Other envelope fields: `pagination` (PaginationMeta).
213
+
214
+ `GtmLibraryListPayload` fields:
215
+
216
+ | Field | Type | Required | Description |
217
+ |---|---|---|---|
218
+ | `items` | `Array<unknown>` | no | |
219
+
220
+ **Example**
221
+
222
+ ```ts
223
+ const result = await g8.api.gtmLibrary.fillPersonasFromGlobalDoc();
224
+ ```
225
+
226
+ ---
227
+
228
+ <a id="op-generateicps"></a>
229
+
230
+ ### `g8.api.gtmLibrary.generateIcps(input)`
231
+
232
+ **Generate Icps**
233
+
234
+ - HTTP: `POST /api/v1/icps/generate`
235
+ - operationId: `generate_icps_icps_generate_post` (also callable as `g8.api.call("generate_icps_icps_generate_post", input)`)
236
+ - Tier: `billable`: spends credits; the SDK never blindly retries it; confirm cost before bulk use
237
+ - API-key scope: `campaigns:run`
238
+
239
+ Research ideal customer profiles for a website with AI (runs a model; billable).
240
+
241
+ **Input**
242
+
243
+ | Field | Type | Required | Description |
244
+ |---|---|---|---|
245
+ | `body` | `IcpGenerateRequest` | yes | Request body; fields below. |
246
+
247
+ Body fields (`IcpGenerateRequest`):
248
+
249
+ | Field | Type | Required | Description |
250
+ |---|---|---|---|
251
+ | `body.website_url` | `string` | yes | The website the ICPs are researched from. |
252
+ | `body.save_to_database` | `boolean \| null` | no | Persist the generated ICPs. default `true` |
253
+
254
+ **Returns** `ApiResponse_GtmLibraryListPayload_`: the envelope `{ data: GtmLibraryListPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
255
+
256
+ Other envelope fields: `pagination` (PaginationMeta).
257
+
258
+ `GtmLibraryListPayload` fields:
259
+
260
+ | Field | Type | Required | Description |
261
+ |---|---|---|---|
262
+ | `items` | `Array<unknown>` | no | |
263
+
264
+ **Example**
265
+
266
+ ```ts
267
+ // billable: spends credits; the SDK never blindly retries it; confirm cost before bulk use.
268
+ const result = await g8.api.gtmLibrary.generateIcps({ body: { website_url: "https://example.com" } });
269
+ ```
270
+
271
+ ---
272
+
273
+ <a id="op-generatepersonas"></a>
274
+
275
+ ### `g8.api.gtmLibrary.generatePersonas(input)`
276
+
277
+ **Generate Personas**
278
+
279
+ - HTTP: `POST /api/v1/personas/generate`
280
+ - operationId: `generate_personas_personas_generate_post` (also callable as `g8.api.call("generate_personas_personas_generate_post", input)`)
281
+ - Tier: `billable`: spends credits; the SDK never blindly retries it; confirm cost before bulk use
282
+ - API-key scope: `campaigns:run`
283
+
284
+ Research buyer personas for a website with AI (runs a model; billable).
285
+
286
+ Pinned personas survive; unpinned ones are replaced when saved.
287
+
288
+ **Input**
289
+
290
+ | Field | Type | Required | Description |
291
+ |---|---|---|---|
292
+ | `body` | `PersonaGenerateRequest` | yes | Request body; fields below. |
293
+
294
+ Body fields (`PersonaGenerateRequest`):
295
+
296
+ | Field | Type | Required | Description |
297
+ |---|---|---|---|
298
+ | `body.website_url` | `string` | yes | The website the personas are researched from. |
299
+ | `body.save_to_database` | `boolean \| null` | no | Persist the generated personas. False returns a preview only. default `true` |
300
+
301
+ **Returns** `ApiResponse_GtmLibraryListPayload_`: the envelope `{ data: GtmLibraryListPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
302
+
303
+ Other envelope fields: `pagination` (PaginationMeta).
304
+
305
+ `GtmLibraryListPayload` fields:
306
+
307
+ | Field | Type | Required | Description |
308
+ |---|---|---|---|
309
+ | `items` | `Array<unknown>` | no | |
310
+
311
+ **Example**
312
+
313
+ ```ts
314
+ // billable: spends credits; the SDK never blindly retries it; confirm cost before bulk use.
315
+ const result = await g8.api.gtmLibrary.generatePersonas({ body: { website_url: "https://example.com" } });
316
+ ```
317
+
318
+ ---
319
+
320
+ <a id="op-generatetam"></a>
321
+
322
+ ### `g8.api.gtmLibrary.generateTam(input)`
323
+
324
+ **Generate Tam**
325
+
326
+ - HTTP: `POST /api/v1/tam/generate`
327
+ - operationId: `generate_tam_tam_generate_post` (also callable as `g8.api.call("generate_tam_tam_generate_post", input)`)
328
+ - Tier: `billable`: spends credits; the SDK never blindly retries it; confirm cost before bulk use
329
+ - API-key scope: `campaigns:run`
330
+
331
+ Define the TAM for a website with AI (runs a model; billable).
332
+
333
+ **Input**
334
+
335
+ | Field | Type | Required | Description |
336
+ |---|---|---|---|
337
+ | `body` | `TamGenerateRequest` | yes | Request body; fields below. |
338
+
339
+ Body fields (`TamGenerateRequest`):
340
+
341
+ | Field | Type | Required | Description |
342
+ |---|---|---|---|
343
+ | `body.website_url` | `string` | yes | The website the TAM is defined for. |
344
+
345
+ **Returns** `ApiResponse_GtmLibraryPayload_`: the envelope `{ data: GtmLibraryPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
346
+
347
+ Other envelope fields: `pagination` (PaginationMeta).
348
+
349
+ **Example**
350
+
351
+ ```ts
352
+ // billable: spends credits; the SDK never blindly retries it; confirm cost before bulk use.
353
+ const result = await g8.api.gtmLibrary.generateTam({ body: { website_url: "https://example.com" } });
354
+ ```
355
+
356
+ ---
357
+
358
+ <a id="op-getcommittee"></a>
359
+
360
+ ### `g8.api.gtmLibrary.getCommittee(input)`
361
+
362
+ **Get Committee**
363
+
364
+ - HTTP: `GET /api/v1/committees/{committee_id}`
365
+ - operationId: `get_committee_committees__committee_id__get` (also callable as `g8.api.call("get_committee_committees__committee_id__get", input)`)
366
+ - Tier: `read`: reads data; safe to call and to retry
367
+ - API-key scope: `campaigns:read`
368
+
369
+ A committee with its full member roster.
370
+
371
+ **Input**
372
+
373
+ | Field | Type | Required | Description |
374
+ |---|---|---|---|
375
+ | `path.committee_id` | `string (uuid)` | yes | Committee id. |
376
+
377
+ **Returns** `ApiResponse_GtmLibraryPayload_`: the envelope `{ data: GtmLibraryPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
378
+
379
+ Other envelope fields: `pagination` (PaginationMeta).
380
+
381
+ **Example**
382
+
383
+ ```ts
384
+ const result = await g8.api.gtmLibrary.getCommittee({ path: { committee_id: "00000000-0000-0000-0000-000000000000" } });
385
+ ```
386
+
387
+ ---
388
+
389
+ <a id="op-getpersona"></a>
390
+
391
+ ### `g8.api.gtmLibrary.getPersona(input)`
392
+
393
+ **Get Persona**
394
+
395
+ - HTTP: `GET /api/v1/personas/{persona_id}`
396
+ - operationId: `get_persona_personas__persona_id__get` (also callable as `g8.api.call("get_persona_personas__persona_id__get", input)`)
397
+ - Tier: `read`: reads data; safe to call and to retry
398
+ - API-key scope: `campaigns:read`
399
+
400
+ One persona.
401
+
402
+ **Input**
403
+
404
+ | Field | Type | Required | Description |
405
+ |---|---|---|---|
406
+ | `path.persona_id` | `string` | yes | Persona id. |
407
+
408
+ **Returns** `ApiResponse_GtmLibraryPayload_`: the envelope `{ data: GtmLibraryPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
409
+
410
+ Other envelope fields: `pagination` (PaginationMeta).
411
+
412
+ **Example**
413
+
414
+ ```ts
415
+ const result = await g8.api.gtmLibrary.getPersona({ path: { persona_id: "id" } });
416
+ ```
417
+
418
+ ---
419
+
420
+ <a id="op-gettam"></a>
421
+
422
+ ### `g8.api.gtmLibrary.getTam(input?)`
423
+
424
+ **Get Tam**
425
+
426
+ - HTTP: `GET /api/v1/tam`
427
+ - operationId: `get_tam_tam_get` (also callable as `g8.api.call("get_tam_tam_get", input)`)
428
+ - Tier: `read`: reads data; safe to call and to retry
429
+ - API-key scope: `campaigns:read`
430
+
431
+ The org's total-addressable-market definition.
432
+
433
+ **Input**
434
+
435
+ | Field | Type | Required | Description |
436
+ |---|---|---|---|
437
+ | `query.website_url` | `string \| null` | no | Which website's TAM. Omit for the org's latest. |
438
+
439
+ **Returns** `ApiResponse_GtmLibraryPayload_`: the envelope `{ data: GtmLibraryPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
440
+
441
+ Other envelope fields: `pagination` (PaginationMeta).
442
+
443
+ **Example**
444
+
445
+ ```ts
446
+ const result = await g8.api.gtmLibrary.getTam();
447
+ ```
448
+
449
+ ---
450
+
451
+ <a id="op-listcommittees"></a>
452
+
453
+ ### `g8.api.gtmLibrary.listCommittees(input?)`
454
+
455
+ **List Committees**
456
+
457
+ - HTTP: `GET /api/v1/committees`
458
+ - operationId: `list_committees_committees_get` (also callable as `g8.api.call("list_committees_committees_get", input)`)
459
+ - Tier: `read`: reads data; safe to call and to retry
460
+ - API-key scope: `campaigns:read`
461
+
462
+ Every buying committee in the org, with member counts.
463
+
464
+ **Input**: none.
465
+
466
+ **Returns** `ApiResponse_GtmLibraryListPayload_`: the envelope `{ data: GtmLibraryListPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
467
+
468
+ Other envelope fields: `pagination` (PaginationMeta).
469
+
470
+ `GtmLibraryListPayload` fields:
471
+
472
+ | Field | Type | Required | Description |
473
+ |---|---|---|---|
474
+ | `items` | `Array<unknown>` | no | |
475
+
476
+ **Example**
477
+
478
+ ```ts
479
+ const result = await g8.api.gtmLibrary.listCommittees();
480
+ ```
481
+
482
+ ---
483
+
484
+ <a id="op-pinicp"></a>
485
+
486
+ ### `g8.api.gtmLibrary.pinIcp(input)`
487
+
488
+ **Pin Icp**
489
+
490
+ - HTTP: `POST /api/v1/icps/{icp_id}/pin`
491
+ - operationId: `pin_icp_icps__icp_id__pin_post` (also callable as `g8.api.call("pin_icp_icps__icp_id__pin_post", input)`)
492
+ - Tier: `write`: creates or changes records; the SDK sends an Idempotency-Key and retries transient failures
493
+ - API-key scope: `campaigns:write`
494
+
495
+ Pin an ICP so `POST /icps/generate` keeps it.
496
+
497
+ **Input**
498
+
499
+ | Field | Type | Required | Description |
500
+ |---|---|---|---|
501
+ | `path.icp_id` | `string` | yes | ICP id. |
502
+
503
+ **Returns** `ApiResponse_GtmLibraryPayload_`: the envelope `{ data: GtmLibraryPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
504
+
505
+ Other envelope fields: `pagination` (PaginationMeta).
506
+
507
+ **Example**
508
+
509
+ ```ts
510
+ const result = await g8.api.gtmLibrary.pinIcp({ path: { icp_id: "id" } });
511
+ ```
512
+
513
+ ---
514
+
515
+ <a id="op-pinpersona"></a>
516
+
517
+ ### `g8.api.gtmLibrary.pinPersona(input)`
518
+
519
+ **Pin Persona**
520
+
521
+ - HTTP: `POST /api/v1/personas/{persona_id}/pin`
522
+ - operationId: `pin_persona_personas__persona_id__pin_post` (also callable as `g8.api.call("pin_persona_personas__persona_id__pin_post", input)`)
523
+ - Tier: `write`: creates or changes records; the SDK sends an Idempotency-Key and retries transient failures
524
+ - API-key scope: `campaigns:write`
525
+
526
+ Pin a persona so `POST /personas/generate` keeps it.
527
+
528
+ **Input**
529
+
530
+ | Field | Type | Required | Description |
531
+ |---|---|---|---|
532
+ | `path.persona_id` | `string` | yes | Persona id. |
533
+
534
+ **Returns** `ApiResponse_GtmLibraryPayload_`: the envelope `{ data: GtmLibraryPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
535
+
536
+ Other envelope fields: `pagination` (PaginationMeta).
537
+
538
+ **Example**
539
+
540
+ ```ts
541
+ const result = await g8.api.gtmLibrary.pinPersona({ path: { persona_id: "id" } });
542
+ ```
543
+
544
+ ---
545
+
546
+ <a id="op-regeneratetam"></a>
547
+
548
+ ### `g8.api.gtmLibrary.regenerateTam(input)`
549
+
550
+ **Regenerate Tam**
551
+
552
+ - HTTP: `POST /api/v1/tam/regenerate`
553
+ - operationId: `regenerate_tam_tam_regenerate_post` (also callable as `g8.api.call("regenerate_tam_tam_regenerate_post", input)`)
554
+ - Tier: `billable`: spends credits; the SDK never blindly retries it; confirm cost before bulk use
555
+ - API-key scope: `campaigns:run`
556
+
557
+ Re-run the TAM definition with AI (runs a model; billable).
558
+
559
+ **Input**
560
+
561
+ | Field | Type | Required | Description |
562
+ |---|---|---|---|
563
+ | `body` | `TamGenerateRequest` | yes | Request body; fields below. |
564
+
565
+ Body fields (`TamGenerateRequest`):
566
+
567
+ | Field | Type | Required | Description |
568
+ |---|---|---|---|
569
+ | `body.website_url` | `string` | yes | The website the TAM is defined for. |
570
+
571
+ **Returns** `ApiResponse_GtmLibraryPayload_`: the envelope `{ data: GtmLibraryPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
572
+
573
+ Other envelope fields: `pagination` (PaginationMeta).
574
+
575
+ **Example**
576
+
577
+ ```ts
578
+ // billable: spends credits; the SDK never blindly retries it; confirm cost before bulk use.
579
+ const result = await g8.api.gtmLibrary.regenerateTam({ body: { website_url: "https://example.com" } });
580
+ ```
581
+
582
+ ---
583
+
584
+ <a id="op-replacecommitteemembers"></a>
585
+
586
+ ### `g8.api.gtmLibrary.replaceCommitteeMembers(input)`
587
+
588
+ **Replace Committee Members**
589
+
590
+ - HTTP: `PUT /api/v1/committees/{committee_id}/members`
591
+ - operationId: `replace_committee_members_committees__committee_id__members_put` (also callable as `g8.api.call("replace_committee_members_committees__committee_id__members_put", input)`)
592
+ - Tier: `write`: creates or changes records; the SDK sends an Idempotency-Key and retries transient failures
593
+ - API-key scope: `campaigns:write`
594
+
595
+ Replace the committee's whole roster in one write.
596
+
597
+ **Input**
598
+
599
+ | Field | Type | Required | Description |
600
+ |---|---|---|---|
601
+ | `path.committee_id` | `string (uuid)` | yes | Committee id. |
602
+ | `body` | `CommitteeMembersRequest` | yes | Request body; fields below. |
603
+
604
+ Body fields (`CommitteeMembersRequest`):
605
+
606
+ | Field | Type | Required | Description |
607
+ |---|---|---|---|
608
+ | `body.members` | `Array<CommitteeMemberAssignment>` | yes | The FULL roster. Personas left out are removed from the committee. |
609
+
610
+ **Returns** `ApiResponse_GtmLibraryPayload_`: the envelope `{ data: GtmLibraryPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
611
+
612
+ Other envelope fields: `pagination` (PaginationMeta).
613
+
614
+ **Example**
615
+
616
+ ```ts
617
+ const result = await g8.api.gtmLibrary.replaceCommitteeMembers({
618
+ path: { committee_id: "00000000-0000-0000-0000-000000000000" },
619
+ body: { members: [{ persona_id: "id" }] },
620
+ });
621
+ ```
622
+
623
+ ---
624
+
625
+ <a id="op-unpinicp"></a>
626
+
627
+ ### `g8.api.gtmLibrary.unpinIcp(input)`
628
+
629
+ **Unpin Icp**
630
+
631
+ - HTTP: `POST /api/v1/icps/{icp_id}/unpin`
632
+ - operationId: `unpin_icp_icps__icp_id__unpin_post` (also callable as `g8.api.call("unpin_icp_icps__icp_id__unpin_post", input)`)
633
+ - Tier: `write`: creates or changes records; the SDK sends an Idempotency-Key and retries transient failures
634
+ - API-key scope: `campaigns:write`
635
+
636
+ Unpin an ICP; the next generation may replace it.
637
+
638
+ **Input**
639
+
640
+ | Field | Type | Required | Description |
641
+ |---|---|---|---|
642
+ | `path.icp_id` | `string` | yes | ICP id. |
643
+
644
+ **Returns** `ApiResponse_GtmLibraryPayload_`: the envelope `{ data: GtmLibraryPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
645
+
646
+ Other envelope fields: `pagination` (PaginationMeta).
647
+
648
+ **Example**
649
+
650
+ ```ts
651
+ const result = await g8.api.gtmLibrary.unpinIcp({ path: { icp_id: "id" } });
652
+ ```
653
+
654
+ ---
655
+
656
+ <a id="op-unpinpersona"></a>
657
+
658
+ ### `g8.api.gtmLibrary.unpinPersona(input)`
659
+
660
+ **Unpin Persona**
661
+
662
+ - HTTP: `POST /api/v1/personas/{persona_id}/unpin`
663
+ - operationId: `unpin_persona_personas__persona_id__unpin_post` (also callable as `g8.api.call("unpin_persona_personas__persona_id__unpin_post", input)`)
664
+ - Tier: `write`: creates or changes records; the SDK sends an Idempotency-Key and retries transient failures
665
+ - API-key scope: `campaigns:write`
666
+
667
+ Unpin a persona; the next generation may replace it.
668
+
669
+ **Input**
670
+
671
+ | Field | Type | Required | Description |
672
+ |---|---|---|---|
673
+ | `path.persona_id` | `string` | yes | Persona id. |
674
+
675
+ **Returns** `ApiResponse_GtmLibraryPayload_`: the envelope `{ data: GtmLibraryPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
676
+
677
+ Other envelope fields: `pagination` (PaginationMeta).
678
+
679
+ **Example**
680
+
681
+ ```ts
682
+ const result = await g8.api.gtmLibrary.unpinPersona({ path: { persona_id: "id" } });
683
+ ```
684
+
685
+ ---
686
+
687
+ <a id="op-updatecommittee"></a>
688
+
689
+ ### `g8.api.gtmLibrary.updateCommittee(input)`
690
+
691
+ **Update Committee**
692
+
693
+ - HTTP: `PATCH /api/v1/committees/{committee_id}`
694
+ - operationId: `update_committee_committees__committee_id__patch` (also callable as `g8.api.call("update_committee_committees__committee_id__patch", input)`)
695
+ - Tier: `write`: creates or changes records; the SDK sends an Idempotency-Key and retries transient failures
696
+ - API-key scope: `campaigns:write`
697
+
698
+ Rename a committee, edit its description, or make it the default.
699
+
700
+ **Input**
701
+
702
+ | Field | Type | Required | Description |
703
+ |---|---|---|---|
704
+ | `path.committee_id` | `string (uuid)` | yes | Committee id. |
705
+ | `body` | `CommitteeUpdateRequest` | yes | Request body; fields below. |
706
+
707
+ Body fields (`CommitteeUpdateRequest`):
708
+
709
+ | Field | Type | Required | Description |
710
+ |---|---|---|---|
711
+ | `body.description` | `string \| null` | no | |
712
+ | `body.is_default` | `boolean \| null` | no | |
713
+ | `body.name` | `string \| null` | no | |
714
+
715
+ **Returns** `ApiResponse_GtmLibraryPayload_`: the envelope `{ data: GtmLibraryPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
716
+
717
+ Other envelope fields: `pagination` (PaginationMeta).
718
+
719
+ **Example**
720
+
721
+ ```ts
722
+ const result = await g8.api.gtmLibrary.updateCommittee({
723
+ path: { committee_id: "00000000-0000-0000-0000-000000000000" },
724
+ body: {},
725
+ });
726
+ ```
727
+
728
+ ---
729
+
730
+ <a id="op-updatetam"></a>
731
+
732
+ ### `g8.api.gtmLibrary.updateTam(input)`
733
+
734
+ **Update Tam**
735
+
736
+ - HTTP: `PATCH /api/v1/tam`
737
+ - operationId: `update_tam_tam_patch` (also callable as `g8.api.call("update_tam_tam_patch", input)`)
738
+ - Tier: `write`: creates or changes records; the SDK sends an Idempotency-Key and retries transient failures
739
+ - API-key scope: `campaigns:write`
740
+
741
+ Replace the TAM definition. Records a new version authored by the key.
742
+
743
+ **Input**
744
+
745
+ | Field | Type | Required | Description |
746
+ |---|---|---|---|
747
+ | `body` | `TamUpdateRequest` | yes | Request body; fields below. |
748
+
749
+ Body fields (`TamUpdateRequest`):
750
+
751
+ | Field | Type | Required | Description |
752
+ |---|---|---|---|
753
+ | `body.definition` | `Record<string, unknown>` | yes | The full TAM definition to store. |
754
+ | `body.website_url` | `string` | yes | The website whose TAM definition is edited. |
755
+ | `body.change_summary` | `string \| null` | no | A note recorded with the new version. |
756
+
757
+ **Returns** `ApiResponse_GtmLibraryPayload_`: the envelope `{ data: GtmLibraryPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
758
+
759
+ Other envelope fields: `pagination` (PaginationMeta).
760
+
761
+ **Example**
762
+
763
+ ```ts
764
+ const result = await g8.api.gtmLibrary.updateTam({ body: { definition: {}, website_url: "https://example.com" } });
765
+ ```
766
+
767
+ ---
768
+
769
+ ## Referenced types
770
+
771
+ Named types that appear in the tables above. Full TypeScript definitions: `G8Contract.<Name>` (`import type { G8Contract } from "@graph8/sdk"`).
772
+
773
+ <a id="type-committeememberassignment"></a>
774
+
775
+ ### `CommitteeMemberAssignment`
776
+
777
+ | Field | Type | Required | Description |
778
+ |---|---|---|---|
779
+ | `persona_id` | `string` | yes | |
780
+ | `abm_category` | `"economic_buyer" \| "champion" \| "end_user" \| "technical" \| null` | no | The role slot. Null keeps the persona on the committee with no role. |