@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,129 @@
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.providerUsage` (Provider Usage): 5 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<"clear_provider_usage_cache_provider_usage_cache_delete">;
9
+ *
10
+ * Reference with examples: providerUsage.md
11
+ */
12
+ /* eslint-disable */
13
+
14
+ /** `g8.api.providerUsage.<member>` -> the operationId it calls. */
15
+ export interface ProviderUsageMembers {
16
+ clearProviderUsageCache: "clear_provider_usage_cache_provider_usage_cache_delete";
17
+ getProviderUsage: "get_provider_usage_provider_usage_get";
18
+ getSingleProviderUsage: "get_single_provider_usage_provider_usage__provider__get";
19
+ refreshProviderUsage: "refresh_provider_usage_provider_usage_refresh_post";
20
+ syncProviderUsageNow: "sync_provider_usage_now_provider_usage_sync_post";
21
+ }
22
+
23
+ /** Input and output of every `g8.api.providerUsage` operation, keyed by operationId. */
24
+ export interface ProviderUsageOperations {
25
+ /**
26
+ * DELETE /provider-usage/cache
27
+ * Clear Provider Usage Cache
28
+ * tier: destructive · scope: integrations:delete
29
+ */
30
+ clear_provider_usage_cache_provider_usage_cache_delete: {
31
+ input: {
32
+ headers?: {
33
+ "X-Target-Org-Id"?: string | null;
34
+ };
35
+ };
36
+ output: ApiResponse_ProviderUsagePayload_;
37
+ };
38
+ /**
39
+ * GET /provider-usage
40
+ * Get Provider Usage
41
+ * tier: read · scope: integrations:read
42
+ */
43
+ get_provider_usage_provider_usage_get: {
44
+ input: {
45
+ query?: {
46
+ /** Only these providers. */
47
+ providers?: Array<string> | null;
48
+ };
49
+ headers?: {
50
+ "X-Target-Org-Id"?: string | null;
51
+ };
52
+ };
53
+ output: ApiResponse_ProviderUsagePayload_;
54
+ };
55
+ /**
56
+ * GET /provider-usage/{provider}
57
+ * Get Single Provider Usage
58
+ * tier: read · scope: integrations:read
59
+ */
60
+ get_single_provider_usage_provider_usage__provider__get: {
61
+ input: {
62
+ path: {
63
+ /** Provider name. */
64
+ provider: string;
65
+ };
66
+ headers?: {
67
+ "X-Target-Org-Id"?: string | null;
68
+ };
69
+ };
70
+ output: ApiResponse_ProviderUsagePayload_;
71
+ };
72
+ /**
73
+ * POST /provider-usage/refresh
74
+ * Refresh Provider Usage
75
+ * tier: external · scope: integrations:run
76
+ */
77
+ refresh_provider_usage_provider_usage_refresh_post: {
78
+ input: {
79
+ headers?: {
80
+ "X-Target-Org-Id"?: string | null;
81
+ };
82
+ body: ProviderUsageRefreshRequest;
83
+ };
84
+ output: ApiResponse_ProviderUsagePayload_;
85
+ };
86
+ /**
87
+ * POST /provider-usage/sync
88
+ * Sync Provider Usage Now
89
+ * tier: external · scope: integrations:run
90
+ */
91
+ sync_provider_usage_now_provider_usage_sync_post: {
92
+ input: {
93
+ headers?: {
94
+ "X-Target-Org-Id"?: string | null;
95
+ };
96
+ };
97
+ output: ApiResponse_ProviderUsagePayload_;
98
+ };
99
+ }
100
+
101
+ // 4 schemas referenced above (the same as G8Contract.<Name>).
102
+
103
+ export interface ApiResponse_ProviderUsagePayload_ {
104
+ data: ProviderUsagePayload;
105
+ pagination?: PaginationMeta | null;
106
+ }
107
+
108
+ export interface PaginationMeta {
109
+ /** Whether there are more pages */
110
+ has_next: boolean;
111
+ /** Items per page */
112
+ limit: number;
113
+ /** Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers. */
114
+ next_cursor?: string | null;
115
+ /** Current page number (1-indexed) */
116
+ page: number;
117
+ /** Total number of items */
118
+ total: number;
119
+ }
120
+
121
+ /** Usage figures per provider, or the result of a refresh/sync. */
122
+ export type ProviderUsagePayload = Record<string, unknown>;
123
+
124
+ export interface ProviderUsageRefreshRequest {
125
+ /** Refresh even if the figures are recent. */
126
+ force_refresh?: boolean;
127
+ /** Only these providers. Omit for all. */
128
+ provider_names?: Array<string> | null;
129
+ }
@@ -0,0 +1,186 @@
1
+ <!-- Generated by sdk/js/scripts/generate-agent-docs.ts from developer-contract/openapi.json. Regenerated on every build. -->
2
+
3
+ # `g8.api.providerUsage`: Provider Usage
4
+
5
+ 5 operations (2 read, 1 destructive, 2 external).
6
+
7
+ No hand-written client covers this area. Call it through `g8.api.providerUsage.*` 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: [providerUsage.d.ts](providerUsage.d.ts).
20
+
21
+ ## Operations
22
+
23
+ | Call | HTTP | Tier | Scope | Summary |
24
+ |---|---|---|---|---|
25
+ | [`clearProviderUsageCache`](#op-clearproviderusagecache) | `DELETE /api/v1/provider-usage/cache` | destructive | `integrations:delete` | Clear Provider Usage Cache |
26
+ | [`getProviderUsage`](#op-getproviderusage) | `GET /api/v1/provider-usage` | read | `integrations:read` | Get Provider Usage |
27
+ | [`getSingleProviderUsage`](#op-getsingleproviderusage) | `GET /api/v1/provider-usage/{provider}` | read | `integrations:read` | Get Single Provider Usage |
28
+ | [`refreshProviderUsage`](#op-refreshproviderusage) | `POST /api/v1/provider-usage/refresh` | external | `integrations:run` | Refresh Provider Usage |
29
+ | [`syncProviderUsageNow`](#op-syncproviderusagenow) | `POST /api/v1/provider-usage/sync` | external | `integrations:run` | Sync Provider Usage Now |
30
+
31
+ ---
32
+
33
+ <a id="op-clearproviderusagecache"></a>
34
+
35
+ ### `g8.api.providerUsage.clearProviderUsageCache(input?)`
36
+
37
+ **Clear Provider Usage Cache**
38
+
39
+ - HTTP: `DELETE /api/v1/provider-usage/cache`
40
+ - operationId: `clear_provider_usage_cache_provider_usage_cache_delete` (also callable as `g8.api.call("clear_provider_usage_cache_provider_usage_cache_delete", input)`)
41
+ - Tier: `destructive`: deletes or archives data; confirm with a human before calling
42
+ - API-key scope: `integrations:delete`
43
+
44
+ Drop the cached figures so the next read goes to the providers.
45
+
46
+ **Input**: none.
47
+
48
+ **Returns** `ApiResponse_ProviderUsagePayload_`: the envelope `{ data: ProviderUsagePayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
49
+
50
+ Other envelope fields: `pagination` (PaginationMeta).
51
+
52
+ **Example**
53
+
54
+ ```ts
55
+ // destructive: deletes or archives data; confirm with a human before calling.
56
+ const result = await g8.api.providerUsage.clearProviderUsageCache();
57
+ ```
58
+
59
+ ---
60
+
61
+ <a id="op-getproviderusage"></a>
62
+
63
+ ### `g8.api.providerUsage.getProviderUsage(input?)`
64
+
65
+ **Get Provider Usage**
66
+
67
+ - HTTP: `GET /api/v1/provider-usage`
68
+ - operationId: `get_provider_usage_provider_usage_get` (also callable as `g8.api.call("get_provider_usage_provider_usage_get", input)`)
69
+ - Tier: `read`: reads data; safe to call and to retry
70
+ - API-key scope: `integrations:read`
71
+
72
+ Usage statistics for every configured provider.
73
+
74
+ **Input**
75
+
76
+ | Field | Type | Required | Description |
77
+ |---|---|---|---|
78
+ | `query.providers` | `Array<string> \| null` | no | Only these providers. |
79
+
80
+ **Returns** `ApiResponse_ProviderUsagePayload_`: the envelope `{ data: ProviderUsagePayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
81
+
82
+ Other envelope fields: `pagination` (PaginationMeta).
83
+
84
+ **Example**
85
+
86
+ ```ts
87
+ const result = await g8.api.providerUsage.getProviderUsage();
88
+ ```
89
+
90
+ ---
91
+
92
+ <a id="op-getsingleproviderusage"></a>
93
+
94
+ ### `g8.api.providerUsage.getSingleProviderUsage(input)`
95
+
96
+ **Get Single Provider Usage**
97
+
98
+ - HTTP: `GET /api/v1/provider-usage/{provider}`
99
+ - operationId: `get_single_provider_usage_provider_usage__provider__get` (also callable as `g8.api.call("get_single_provider_usage_provider_usage__provider__get", input)`)
100
+ - Tier: `read`: reads data; safe to call and to retry
101
+ - API-key scope: `integrations:read`
102
+
103
+ Usage statistics for one provider.
104
+
105
+ **Input**
106
+
107
+ | Field | Type | Required | Description |
108
+ |---|---|---|---|
109
+ | `path.provider` | `string` | yes | Provider name. |
110
+
111
+ **Returns** `ApiResponse_ProviderUsagePayload_`: the envelope `{ data: ProviderUsagePayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
112
+
113
+ Other envelope fields: `pagination` (PaginationMeta).
114
+
115
+ **Example**
116
+
117
+ ```ts
118
+ const result = await g8.api.providerUsage.getSingleProviderUsage({ path: { provider: "example" } });
119
+ ```
120
+
121
+ ---
122
+
123
+ <a id="op-refreshproviderusage"></a>
124
+
125
+ ### `g8.api.providerUsage.refreshProviderUsage(input)`
126
+
127
+ **Refresh Provider Usage**
128
+
129
+ - HTTP: `POST /api/v1/provider-usage/refresh`
130
+ - operationId: `refresh_provider_usage_provider_usage_refresh_post` (also callable as `g8.api.call("refresh_provider_usage_provider_usage_refresh_post", input)`)
131
+ - Tier: `external`: reaches real people (sends email/SMS, places a call, launches a send); the SDK never blindly retries it; confirm with a human first
132
+ - API-key scope: `integrations:run`
133
+
134
+ Re-read usage from the providers now (calls each provider's API with the org's key).
135
+
136
+ **Input**
137
+
138
+ | Field | Type | Required | Description |
139
+ |---|---|---|---|
140
+ | `body` | `ProviderUsageRefreshRequest` | yes | Request body; fields below. |
141
+
142
+ Body fields (`ProviderUsageRefreshRequest`):
143
+
144
+ | Field | Type | Required | Description |
145
+ |---|---|---|---|
146
+ | `body.force_refresh` | `boolean` | no | Refresh even if the figures are recent. default `false` |
147
+ | `body.provider_names` | `Array<string> \| null` | no | Only these providers. Omit for all. |
148
+
149
+ **Returns** `ApiResponse_ProviderUsagePayload_`: the envelope `{ data: ProviderUsagePayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
150
+
151
+ Other envelope fields: `pagination` (PaginationMeta).
152
+
153
+ **Example**
154
+
155
+ ```ts
156
+ // external: reaches real people (sends email/SMS, places a call, launches a send); the SDK never blindly retries it; confirm with a human first.
157
+ const result = await g8.api.providerUsage.refreshProviderUsage({ body: {} });
158
+ ```
159
+
160
+ ---
161
+
162
+ <a id="op-syncproviderusagenow"></a>
163
+
164
+ ### `g8.api.providerUsage.syncProviderUsageNow(input?)`
165
+
166
+ **Sync Provider Usage Now**
167
+
168
+ - HTTP: `POST /api/v1/provider-usage/sync`
169
+ - operationId: `sync_provider_usage_now_provider_usage_sync_post` (also callable as `g8.api.call("sync_provider_usage_now_provider_usage_sync_post", input)`)
170
+ - Tier: `external`: reaches real people (sends email/SMS, places a call, launches a send); the SDK never blindly retries it; confirm with a human first
171
+ - API-key scope: `integrations:run`
172
+
173
+ Sync this org's usage from every provider immediately.
174
+
175
+ **Input**: none.
176
+
177
+ **Returns** `ApiResponse_ProviderUsagePayload_`: the envelope `{ data: ProviderUsagePayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
178
+
179
+ Other envelope fields: `pagination` (PaginationMeta).
180
+
181
+ **Example**
182
+
183
+ ```ts
184
+ // external: reaches real people (sends email/SMS, places a call, launches a send); the SDK never blindly retries it; confirm with a human first.
185
+ const result = await g8.api.providerUsage.syncProviderUsageNow();
186
+ ```
@@ -0,0 +1,69 @@
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.public` (Public): 1 operation.
5
+ *
6
+ * For reading. In code, import from the package instead:
7
+ * import type { ApiInput, ApiOutput, G8Contract } from "@graph8/sdk";
8
+ * type In = ApiInput<"public_enrich_lookup_public_enrich_lookup_post">;
9
+ *
10
+ * Reference with examples: public.md
11
+ */
12
+ /* eslint-disable */
13
+
14
+ /** `g8.api.public.<member>` -> the operationId it calls. */
15
+ export interface PublicMembers {
16
+ publicEnrichLookup: "public_enrich_lookup_public_enrich_lookup_post";
17
+ }
18
+
19
+ /** Input and output of every `g8.api.public` operation, keyed by operationId. */
20
+ export interface PublicOperations {
21
+ /**
22
+ * POST /public/enrich/lookup
23
+ * Public Enrich Lookup
24
+ * tier: billable · scope: n/a
25
+ */
26
+ public_enrich_lookup_public_enrich_lookup_post: {
27
+ input: {
28
+ headers?: {
29
+ "X-Write-Key"?: string | null;
30
+ };
31
+ body: PublicEnrichRequest;
32
+ };
33
+ output: ApiResponse_PublicEnrichResponse_;
34
+ };
35
+ }
36
+
37
+ // 4 schemas referenced above (the same as G8Contract.<Name>).
38
+
39
+ export interface ApiResponse_PublicEnrichResponse_ {
40
+ data: PublicEnrichResponse;
41
+ pagination?: PaginationMeta | null;
42
+ }
43
+
44
+ export interface PaginationMeta {
45
+ /** Whether there are more pages */
46
+ has_next: boolean;
47
+ /** Items per page */
48
+ limit: number;
49
+ /** Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers. */
50
+ next_cursor?: string | null;
51
+ /** Current page number (1-indexed) */
52
+ page: number;
53
+ /** Total number of items */
54
+ total: number;
55
+ }
56
+
57
+ export interface PublicEnrichRequest {
58
+ /** Email address to look up */
59
+ email: string;
60
+ }
61
+
62
+ export interface PublicEnrichResponse {
63
+ /** Whether the email was found in graph8 */
64
+ found: boolean;
65
+ /** Fields graph8 already knows */
66
+ known_fields?: Record<string, unknown>;
67
+ /** Fields the form should ask for */
68
+ missing_fields?: Array<string>;
69
+ }
@@ -0,0 +1,78 @@
1
+ <!-- Generated by sdk/js/scripts/generate-agent-docs.ts from developer-contract/openapi.json. Regenerated on every build. -->
2
+
3
+ # `g8.api.public`: Public
4
+
5
+ 1 operation (1 billable).
6
+
7
+ 1 of these also have a hand-written method (`g8.forms`), marked **★** below. Prefer the hand-written method when one exists: it unwraps the `data` envelope and takes friendlier arguments. See [../sdk-clients.md](../sdk-clients.md).
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: [public.d.ts](public.d.ts).
20
+
21
+ ## Operations
22
+
23
+ | Call | HTTP | Tier | Scope | Summary |
24
+ |---|---|---|---|---|
25
+ | [`publicEnrichLookup`](#op-publicenrichlookup) ★ | `POST /api/v1/public/enrich/lookup` | billable | | Public Enrich Lookup |
26
+
27
+ ---
28
+
29
+ <a id="op-publicenrichlookup"></a>
30
+
31
+ ### `g8.api.public.publicEnrichLookup(input)`
32
+
33
+ **Public Enrich Lookup**
34
+
35
+ - HTTP: `POST /api/v1/public/enrich/lookup`
36
+ - operationId: `public_enrich_lookup_public_enrich_lookup_post` (also callable as `g8.api.call("public_enrich_lookup_public_enrich_lookup_post", input)`)
37
+ - Tier: `billable`: spends credits; the SDK never blindly retries it; confirm cost before bulk use
38
+ - API-key scope: none published
39
+ - ★ Hand-written: [`g8.forms.lookup()`](../sdk-clients.md#g8-forms-lookup)
40
+
41
+ Look up a contact by email using write key authentication.
42
+
43
+ Used by the <G8Form /> progressive form component to determine which
44
+ fields graph8 already knows (and can hide) vs which fields to ask the user.
45
+
46
+ Searches the mashup (OpenSearch) index for enrichment data.
47
+
48
+ **Input**
49
+
50
+ | Field | Type | Required | Description |
51
+ |---|---|---|---|
52
+ | `body` | `PublicEnrichRequest` | yes | Request body; fields below. |
53
+ | `headers.X-Write-Key` | `string \| null` | no | |
54
+
55
+ Body fields (`PublicEnrichRequest`):
56
+
57
+ | Field | Type | Required | Description |
58
+ |---|---|---|---|
59
+ | `body.email` | `string` | yes | Email address to look up |
60
+
61
+ **Returns** `ApiResponse_PublicEnrichResponse_`: the envelope `{ data: PublicEnrichResponse, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
62
+
63
+ Other envelope fields: `pagination` (PaginationMeta).
64
+
65
+ `PublicEnrichResponse` fields:
66
+
67
+ | Field | Type | Required | Description |
68
+ |---|---|---|---|
69
+ | `found` | `boolean` | yes | Whether the email was found in graph8 |
70
+ | `known_fields` | `Record<string, unknown>` | no | Fields graph8 already knows default `{}` |
71
+ | `missing_fields` | `Array<string>` | no | Fields the form should ask for default `[]` |
72
+
73
+ **Example**
74
+
75
+ ```ts
76
+ // billable: spends credits; the SDK never blindly retries it; confirm cost before bulk use.
77
+ const result = await g8.api.public.publicEnrichLookup({ body: { email: "jane@acme.com" } });
78
+ ```
@@ -0,0 +1,67 @@
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.publicCopilot` (Public - Copilot): 1 operation.
5
+ *
6
+ * For reading. In code, import from the package instead:
7
+ * import type { ApiInput, ApiOutput, G8Contract } from "@graph8/sdk";
8
+ * type In = ApiInput<"public_copilot_chat_public_copilot_chat_post">;
9
+ *
10
+ * Reference with examples: publicCopilot.md
11
+ */
12
+ /* eslint-disable */
13
+
14
+ /** `g8.api.publicCopilot.<member>` -> the operationId it calls. */
15
+ export interface PublicCopilotMembers {
16
+ publicCopilotChat: "public_copilot_chat_public_copilot_chat_post";
17
+ }
18
+
19
+ /** Input and output of every `g8.api.publicCopilot` operation, keyed by operationId. */
20
+ export interface PublicCopilotOperations {
21
+ /**
22
+ * POST /public/copilot/chat
23
+ * Public Copilot Chat
24
+ * tier: write · scope: n/a
25
+ */
26
+ public_copilot_chat_public_copilot_chat_post: {
27
+ input: {
28
+ headers?: {
29
+ "X-Write-Key"?: string | null;
30
+ };
31
+ body: PublicCopilotRequest;
32
+ };
33
+ output: ApiResponse_PublicCopilotResponse_;
34
+ };
35
+ }
36
+
37
+ // 4 schemas referenced above (the same as G8Contract.<Name>).
38
+
39
+ export interface ApiResponse_PublicCopilotResponse_ {
40
+ data: PublicCopilotResponse;
41
+ pagination?: PaginationMeta | null;
42
+ }
43
+
44
+ export interface PaginationMeta {
45
+ /** Whether there are more pages */
46
+ has_next: boolean;
47
+ /** Items per page */
48
+ limit: number;
49
+ /** Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers. */
50
+ next_cursor?: string | null;
51
+ /** Current page number (1-indexed) */
52
+ page: number;
53
+ /** Total number of items */
54
+ total: number;
55
+ }
56
+
57
+ export interface PublicCopilotRequest {
58
+ context?: Record<string, unknown> | null;
59
+ message: string;
60
+ session_id?: string | null;
61
+ }
62
+
63
+ export interface PublicCopilotResponse {
64
+ response: string;
65
+ session_id?: string | null;
66
+ sources?: Array<Record<string, unknown>>;
67
+ }
@@ -0,0 +1,80 @@
1
+ <!-- Generated by sdk/js/scripts/generate-agent-docs.ts from developer-contract/openapi.json. Regenerated on every build. -->
2
+
3
+ # `g8.api.publicCopilot`: Public - Copilot
4
+
5
+ 1 operation (1 write).
6
+
7
+ 1 of these also have a hand-written method (`g8.copilot`), marked **★** below. Prefer the hand-written method when one exists: it unwraps the `data` envelope and takes friendlier arguments. See [../sdk-clients.md](../sdk-clients.md).
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: [publicCopilot.d.ts](publicCopilot.d.ts).
20
+
21
+ ## Operations
22
+
23
+ | Call | HTTP | Tier | Scope | Summary |
24
+ |---|---|---|---|---|
25
+ | [`publicCopilotChat`](#op-publiccopilotchat) ★ | `POST /api/v1/public/copilot/chat` | write | | Public Copilot Chat |
26
+
27
+ ---
28
+
29
+ <a id="op-publiccopilotchat"></a>
30
+
31
+ ### `g8.api.publicCopilot.publicCopilotChat(input)`
32
+
33
+ **Public Copilot Chat**
34
+
35
+ - HTTP: `POST /api/v1/public/copilot/chat`
36
+ - operationId: `public_copilot_chat_public_copilot_chat_post` (also callable as `g8.api.call("public_copilot_chat_public_copilot_chat_post", input)`)
37
+ - Tier: `write`: creates or changes records; the SDK sends an Idempotency-Key and retries transient failures
38
+ - API-key scope: none published
39
+ - ★ Hand-written: [`g8.copilot.ask()`](../sdk-clients.md#g8-copilot-ask)
40
+
41
+ Send a message to the graph8 copilot using write key auth.
42
+
43
+ This is a simplified, non-streaming version for the SDK widget.
44
+ Responses come from the org's knowledge base (global context docs,
45
+ brand brief, FAQs, etc.) — no admin tools are available.
46
+
47
+ Used by g8.copilot.ask().
48
+
49
+ **Input**
50
+
51
+ | Field | Type | Required | Description |
52
+ |---|---|---|---|
53
+ | `body` | `PublicCopilotRequest` | yes | Request body; fields below. |
54
+ | `headers.X-Write-Key` | `string \| null` | no | |
55
+
56
+ Body fields (`PublicCopilotRequest`):
57
+
58
+ | Field | Type | Required | Description |
59
+ |---|---|---|---|
60
+ | `body.message` | `string` | yes | |
61
+ | `body.context` | `Record<string, unknown> \| null` | no | |
62
+ | `body.session_id` | `string \| null` | no | |
63
+
64
+ **Returns** `ApiResponse_PublicCopilotResponse_`: the envelope `{ data: PublicCopilotResponse, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
65
+
66
+ Other envelope fields: `pagination` (PaginationMeta).
67
+
68
+ `PublicCopilotResponse` fields:
69
+
70
+ | Field | Type | Required | Description |
71
+ |---|---|---|---|
72
+ | `response` | `string` | yes | |
73
+ | `session_id` | `string \| null` | no | |
74
+ | `sources` | `Array<Record<string, unknown>>` | no | default `[]` |
75
+
76
+ **Example**
77
+
78
+ ```ts
79
+ const result = await g8.api.publicCopilot.publicCopilotChat({ body: { message: "example" } });
80
+ ```
@@ -0,0 +1,66 @@
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.publicSignals` (Public - Signals): 1 operation.
5
+ *
6
+ * For reading. In code, import from the package instead:
7
+ * import type { ApiInput, ApiOutput, G8Contract } from "@graph8/sdk";
8
+ * type In = ApiInput<"public_signals_company_public_signals_company_get">;
9
+ *
10
+ * Reference with examples: publicSignals.md
11
+ */
12
+ /* eslint-disable */
13
+
14
+ /** `g8.api.publicSignals.<member>` -> the operationId it calls. */
15
+ export interface PublicSignalsMembers {
16
+ publicSignalsCompany: "public_signals_company_public_signals_company_get";
17
+ }
18
+
19
+ /** Input and output of every `g8.api.publicSignals` operation, keyed by operationId. */
20
+ export interface PublicSignalsOperations {
21
+ /**
22
+ * GET /public/signals/company
23
+ * Public Signals Company
24
+ * tier: read · scope: intent:read
25
+ */
26
+ public_signals_company_public_signals_company_get: {
27
+ input: {
28
+ query: {
29
+ domain: string;
30
+ };
31
+ headers?: {
32
+ "X-Write-Key"?: string | null;
33
+ "X-Target-Org-Id"?: string | null;
34
+ };
35
+ };
36
+ output: ApiResponse_IntentSignalsResponse_;
37
+ };
38
+ }
39
+
40
+ // 3 schemas referenced above (the same as G8Contract.<Name>).
41
+
42
+ export interface ApiResponse_IntentSignalsResponse_ {
43
+ data: IntentSignalsResponse;
44
+ pagination?: PaginationMeta | null;
45
+ }
46
+
47
+ export interface IntentSignalsResponse {
48
+ domain: string;
49
+ intent?: string;
50
+ last_seen?: string | null;
51
+ score?: number;
52
+ signals?: Array<string>;
53
+ }
54
+
55
+ export interface PaginationMeta {
56
+ /** Whether there are more pages */
57
+ has_next: boolean;
58
+ /** Items per page */
59
+ limit: number;
60
+ /** Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers. */
61
+ next_cursor?: string | null;
62
+ /** Current page number (1-indexed) */
63
+ page: number;
64
+ /** Total number of items */
65
+ total: number;
66
+ }