@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.
- package/README.md +9 -2
- package/dist/cli.js +216 -0
- package/dist/index.d.mts +105 -7
- package/dist/index.d.ts +105 -7
- package/dist/index.js +44 -3
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +44 -3
- package/dist/index.mjs.map +1 -1
- package/dist/react.d.mts +103 -7
- package/dist/react.d.ts +103 -7
- package/dist/react.js +62 -11
- package/dist/react.js.map +1 -1
- package/dist/react.mjs +53 -12
- package/dist/react.mjs.map +1 -1
- package/dist/types/README.md +7 -0
- package/dist/types/agency.d.ts +20 -0
- package/dist/types/agentSetup.d.ts +57 -0
- package/dist/types/api.d.ts +127 -0
- package/dist/types/appClient.d.ts +99 -0
- package/dist/types/appPlatform.d.ts +269 -0
- package/dist/types/appTokens.d.ts +125 -0
- package/dist/types/apps.d.ts +130 -0
- package/dist/types/audiences.d.ts +88 -0
- package/dist/types/calendar.d.ts +55 -0
- package/dist/types/campaigns.d.ts +61 -0
- package/dist/types/chat.d.ts +35 -0
- package/dist/types/cli.d.ts +14 -0
- package/dist/types/companies.d.ts +123 -0
- package/dist/types/contacts.d.ts +200 -0
- package/dist/types/copilot.d.ts +31 -0
- package/dist/types/core.d.ts +1052 -0
- package/dist/types/deals.d.ts +215 -0
- package/dist/types/enrich.d.ts +51 -0
- package/dist/types/fields.d.ts +84 -0
- package/dist/types/forms.d.ts +16 -0
- package/dist/types/http.d.ts +141 -0
- package/dist/types/inbox.d.ts +123 -0
- package/dist/types/index.d.ts +63 -0
- package/dist/types/intent.d.ts +196 -0
- package/dist/types/lists.d.ts +44 -0
- package/dist/types/mailboxes.d.ts +240 -0
- package/dist/types/marketplace.d.ts +62 -0
- package/dist/types/meetings.d.ts +70 -0
- package/dist/types/newsletter.d.ts +212 -0
- package/dist/types/notes.d.ts +57 -0
- package/dist/types/objects.d.ts +281 -0
- package/dist/types/pipelines.d.ts +135 -0
- package/dist/types/quotes.d.ts +143 -0
- package/dist/types/react.d.ts +978 -0
- package/dist/types/search.d.ts +99 -0
- package/dist/types/sequences.d.ts +255 -0
- package/dist/types/signals.d.ts +28 -0
- package/dist/types/skills.d.ts +176 -0
- package/dist/types/snippet.d.ts +24 -0
- package/dist/types/studio.d.ts +161 -0
- package/dist/types/tasks.d.ts +101 -0
- package/dist/types/types.d.ts +45 -0
- package/dist/types/utils.d.ts +21 -0
- package/dist/types/version.d.ts +10 -0
- package/dist/types/visitors.d.ts +29 -0
- package/dist/types/voice.d.ts +304 -0
- package/dist/types/webhooks.d.ts +71 -0
- package/dist/types/workflows.d.ts +229 -0
- package/docs/agents.md +748 -0
- package/docs/api/README.md +165 -0
- package/docs/api/accounts.d.ts +396 -0
- package/docs/api/accounts.md +644 -0
- package/docs/api/adCampaigns.d.ts +707 -0
- package/docs/api/adCampaigns.md +1091 -0
- package/docs/api/adCreatives.d.ts +996 -0
- package/docs/api/adCreatives.md +1708 -0
- package/docs/api/agency.d.ts +556 -0
- package/docs/api/agency.md +845 -0
- package/docs/api/agent.d.ts +330 -0
- package/docs/api/agent.md +514 -0
- package/docs/api/agents.d.ts +1622 -0
- package/docs/api/agents.md +2860 -0
- package/docs/api/aiInbox.d.ts +1984 -0
- package/docs/api/aiInbox.md +3490 -0
- package/docs/api/analytics.d.ts +1273 -0
- package/docs/api/analytics.md +2095 -0
- package/docs/api/apiKeys.d.ts +252 -0
- package/docs/api/apiKeys.md +318 -0
- package/docs/api/appDeployments.d.ts +236 -0
- package/docs/api/appDeployments.md +471 -0
- package/docs/api/appDomains.d.ts +171 -0
- package/docs/api/appDomains.md +281 -0
- package/docs/api/appLogs.d.ts +120 -0
- package/docs/api/appLogs.md +159 -0
- package/docs/api/appObjects.d.ts +415 -0
- package/docs/api/appObjects.md +568 -0
- package/docs/api/appPages.d.ts +557 -0
- package/docs/api/appPages.md +796 -0
- package/docs/api/appPlatformTokens.d.ts +123 -0
- package/docs/api/appPlatformTokens.md +172 -0
- package/docs/api/appointments.d.ts +2361 -0
- package/docs/api/appointments.md +3917 -0
- package/docs/api/apps.d.ts +822 -0
- package/docs/api/apps.md +1342 -0
- package/docs/api/assertUpsert.d.ts +286 -0
- package/docs/api/assertUpsert.md +370 -0
- package/docs/api/audienceSyncs.d.ts +259 -0
- package/docs/api/audienceSyncs.md +395 -0
- package/docs/api/brandKit.d.ts +686 -0
- package/docs/api/brandKit.md +1133 -0
- package/docs/api/bugReports.d.ts +181 -0
- package/docs/api/bugReports.md +268 -0
- package/docs/api/by-path.md +3260 -0
- package/docs/api/calendarInvites.d.ts +117 -0
- package/docs/api/calendarInvites.md +148 -0
- package/docs/api/campaignWorkflows.d.ts +152 -0
- package/docs/api/campaignWorkflows.md +200 -0
- package/docs/api/campaigns.d.ts +721 -0
- package/docs/api/campaigns.md +1236 -0
- package/docs/api/channels.d.ts +171 -0
- package/docs/api/channels.md +235 -0
- package/docs/api/cliCampaigns.d.ts +205 -0
- package/docs/api/cliCampaigns.md +256 -0
- package/docs/api/cliPipelines.d.ts +324 -0
- package/docs/api/cliPipelines.md +562 -0
- package/docs/api/clickHouse.d.ts +115 -0
- package/docs/api/clickHouse.md +138 -0
- package/docs/api/companies.d.ts +1636 -0
- package/docs/api/companies.md +2211 -0
- package/docs/api/companyIntelligence.d.ts +299 -0
- package/docs/api/companyIntelligence.md +488 -0
- package/docs/api/contacts.d.ts +2173 -0
- package/docs/api/contacts.md +3143 -0
- package/docs/api/content.d.ts +968 -0
- package/docs/api/content.md +1667 -0
- package/docs/api/contentGridSkills.d.ts +177 -0
- package/docs/api/contentGridSkills.md +271 -0
- package/docs/api/copilot.d.ts +1017 -0
- package/docs/api/copilot.md +1765 -0
- package/docs/api/crmSyncs.d.ts +215 -0
- package/docs/api/crmSyncs.md +301 -0
- package/docs/api/customerSuccess.d.ts +491 -0
- package/docs/api/customerSuccess.md +776 -0
- package/docs/api/deals.d.ts +1697 -0
- package/docs/api/deals.md +2436 -0
- package/docs/api/deliverability.d.ts +418 -0
- package/docs/api/deliverability.md +677 -0
- package/docs/api/desk.d.ts +1765 -0
- package/docs/api/desk.md +3007 -0
- package/docs/api/dialer.d.ts +1185 -0
- package/docs/api/dialer.md +2166 -0
- package/docs/api/dialerAnalytics.d.ts +187 -0
- package/docs/api/dialerAnalytics.md +257 -0
- package/docs/api/documents.d.ts +895 -0
- package/docs/api/documents.md +1440 -0
- package/docs/api/duplicates.d.ts +195 -0
- package/docs/api/duplicates.md +315 -0
- package/docs/api/eSign.d.ts +38 -0
- package/docs/api/eSign.md +54 -0
- package/docs/api/eSignature.d.ts +242 -0
- package/docs/api/eSignature.md +341 -0
- package/docs/api/enrichment.d.ts +3207 -0
- package/docs/api/enrichment.md +5225 -0
- package/docs/api/events.d.ts +115 -0
- package/docs/api/events.md +105 -0
- package/docs/api/fields.d.ts +482 -0
- package/docs/api/fields.md +566 -0
- package/docs/api/forms.d.ts +1012 -0
- package/docs/api/forms.md +1542 -0
- package/docs/api/gtmCampaigns.d.ts +662 -0
- package/docs/api/gtmCampaigns.md +1044 -0
- package/docs/api/gtmContext.d.ts +1187 -0
- package/docs/api/gtmContext.md +2112 -0
- package/docs/api/gtmDeliverability.d.ts +60 -0
- package/docs/api/gtmDeliverability.md +63 -0
- package/docs/api/gtmKnowledgeBase.d.ts +76 -0
- package/docs/api/gtmKnowledgeBase.md +91 -0
- package/docs/api/gtmLaunchHelpers.d.ts +123 -0
- package/docs/api/gtmLaunchHelpers.md +148 -0
- package/docs/api/gtmLibrary.d.ts +448 -0
- package/docs/api/gtmLibrary.md +780 -0
- package/docs/api/health.d.ts +39 -0
- package/docs/api/health.md +58 -0
- package/docs/api/imageLibrary.d.ts +341 -0
- package/docs/api/imageLibrary.md +569 -0
- package/docs/api/imports.d.ts +157 -0
- package/docs/api/imports.md +174 -0
- package/docs/api/inbox.d.ts +709 -0
- package/docs/api/inbox.md +1067 -0
- package/docs/api/install.d.ts +213 -0
- package/docs/api/install.md +317 -0
- package/docs/api/installedApps.d.ts +131 -0
- package/docs/api/installedApps.md +241 -0
- package/docs/api/integrationStatus.d.ts +142 -0
- package/docs/api/integrationStatus.md +205 -0
- package/docs/api/integrations.d.ts +2327 -0
- package/docs/api/integrations.md +3791 -0
- package/docs/api/intent.d.ts +482 -0
- package/docs/api/intent.md +858 -0
- package/docs/api/knowledge.d.ts +501 -0
- package/docs/api/knowledge.md +843 -0
- package/docs/api/knowledgeBase.d.ts +84 -0
- package/docs/api/knowledgeBase.md +96 -0
- package/docs/api/landingPages.d.ts +1411 -0
- package/docs/api/landingPages.md +2488 -0
- package/docs/api/leads.d.ts +133 -0
- package/docs/api/leads.md +180 -0
- package/docs/api/library.d.ts +217 -0
- package/docs/api/library.md +338 -0
- package/docs/api/linkedIn.d.ts +227 -0
- package/docs/api/linkedIn.md +289 -0
- package/docs/api/linkedInOutreach.d.ts +727 -0
- package/docs/api/linkedInOutreach.md +990 -0
- package/docs/api/lists.d.ts +1106 -0
- package/docs/api/lists.md +1609 -0
- package/docs/api/logs.d.ts +71 -0
- package/docs/api/logs.md +70 -0
- package/docs/api/mailboxes.d.ts +1050 -0
- package/docs/api/mailboxes.md +1690 -0
- package/docs/api/marketingIntelligence.d.ts +256 -0
- package/docs/api/marketingIntelligence.md +454 -0
- package/docs/api/marketplace.d.ts +3173 -0
- package/docs/api/marketplace.md +5953 -0
- package/docs/api/mcp.d.ts +69 -0
- package/docs/api/mcp.md +69 -0
- package/docs/api/me.d.ts +54 -0
- package/docs/api/me.md +56 -0
- package/docs/api/meetings.d.ts +539 -0
- package/docs/api/meetings.md +747 -0
- package/docs/api/newsletter.d.ts +1613 -0
- package/docs/api/newsletter.md +2746 -0
- package/docs/api/notes.d.ts +517 -0
- package/docs/api/notes.md +888 -0
- package/docs/api/notifications.d.ts +94 -0
- package/docs/api/notifications.md +105 -0
- package/docs/api/objects.d.ts +621 -0
- package/docs/api/objects.md +1098 -0
- package/docs/api/openSearch.d.ts +234 -0
- package/docs/api/openSearch.md +297 -0
- package/docs/api/ops.d.ts +299 -0
- package/docs/api/ops.md +339 -0
- package/docs/api/orgGovernance.d.ts +393 -0
- package/docs/api/orgGovernance.md +623 -0
- package/docs/api/orgVideos.d.ts +184 -0
- package/docs/api/orgVideos.md +252 -0
- package/docs/api/organizationSettings.d.ts +626 -0
- package/docs/api/organizationSettings.md +911 -0
- package/docs/api/phoneNumbers.d.ts +484 -0
- package/docs/api/phoneNumbers.md +777 -0
- package/docs/api/profile.d.ts +329 -0
- package/docs/api/profile.md +540 -0
- package/docs/api/programmaticPages.d.ts +400 -0
- package/docs/api/programmaticPages.md +626 -0
- package/docs/api/providerDomains.d.ts +866 -0
- package/docs/api/providerDomains.md +1446 -0
- package/docs/api/providerUsage.d.ts +129 -0
- package/docs/api/providerUsage.md +186 -0
- package/docs/api/public.d.ts +69 -0
- package/docs/api/public.md +78 -0
- package/docs/api/publicCopilot.d.ts +67 -0
- package/docs/api/publicCopilot.md +80 -0
- package/docs/api/publicSignals.d.ts +66 -0
- package/docs/api/publicSignals.md +71 -0
- package/docs/api/publicVisitors.d.ts +97 -0
- package/docs/api/publicVisitors.md +118 -0
- package/docs/api/quotes.d.ts +1564 -0
- package/docs/api/quotes.md +2553 -0
- package/docs/api/radar.d.ts +808 -0
- package/docs/api/radar.md +1431 -0
- package/docs/api/radarReports.d.ts +208 -0
- package/docs/api/radarReports.md +306 -0
- package/docs/api/recordRoles.d.ts +143 -0
- package/docs/api/recordRoles.md +175 -0
- package/docs/api/repos.d.ts +146 -0
- package/docs/api/repos.md +211 -0
- package/docs/api/research.d.ts +295 -0
- package/docs/api/research.md +534 -0
- package/docs/api/revenue.d.ts +402 -0
- package/docs/api/revenue.md +608 -0
- package/docs/api/revenueAnalytics.d.ts +147 -0
- package/docs/api/revenueAnalytics.md +212 -0
- package/docs/api/revenueLifecycle.d.ts +207 -0
- package/docs/api/revenueLifecycle.md +274 -0
- package/docs/api/revenueRecords.d.ts +372 -0
- package/docs/api/revenueRecords.md +563 -0
- package/docs/api/roles.d.ts +431 -0
- package/docs/api/roles.md +812 -0
- package/docs/api/salesCoach.d.ts +877 -0
- package/docs/api/salesCoach.md +1540 -0
- package/docs/api/sandbox.d.ts +210 -0
- package/docs/api/sandbox.md +380 -0
- package/docs/api/scans.d.ts +104 -0
- package/docs/api/scans.md +136 -0
- package/docs/api/scheduleBuy.d.ts +293 -0
- package/docs/api/scheduleBuy.md +431 -0
- package/docs/api/scraping.d.ts +266 -0
- package/docs/api/scraping.md +383 -0
- package/docs/api/sdrAnalytics.d.ts +138 -0
- package/docs/api/sdrAnalytics.md +246 -0
- package/docs/api/search.d.ts +598 -0
- package/docs/api/search.md +866 -0
- package/docs/api/seo.d.ts +447 -0
- package/docs/api/seo.md +660 -0
- package/docs/api/sequenceLifecycle.d.ts +439 -0
- package/docs/api/sequenceLifecycle.md +513 -0
- package/docs/api/sequences.d.ts +1936 -0
- package/docs/api/sequences.md +3232 -0
- package/docs/api/settings.d.ts +448 -0
- package/docs/api/settings.md +731 -0
- package/docs/api/signals.d.ts +1441 -0
- package/docs/api/signals.md +2526 -0
- package/docs/api/signatures.d.ts +719 -0
- package/docs/api/signatures.md +1247 -0
- package/docs/api/skills.d.ts +230 -0
- package/docs/api/skills.md +466 -0
- package/docs/api/snippet.d.ts +85 -0
- package/docs/api/snippet.md +106 -0
- package/docs/api/socialPublishing.d.ts +824 -0
- package/docs/api/socialPublishing.md +1245 -0
- package/docs/api/studioDocuments.d.ts +244 -0
- package/docs/api/studioDocuments.md +348 -0
- package/docs/api/support.d.ts +90 -0
- package/docs/api/support.md +76 -0
- package/docs/api/suppressions.d.ts +241 -0
- package/docs/api/suppressions.md +343 -0
- package/docs/api/surveys.d.ts +847 -0
- package/docs/api/surveys.md +1223 -0
- package/docs/api/tasks.d.ts +813 -0
- package/docs/api/tasks.md +1344 -0
- package/docs/api/teamMembers.d.ts +668 -0
- package/docs/api/teamMembers.md +1040 -0
- package/docs/api/teams.d.ts +784 -0
- package/docs/api/teams.md +1395 -0
- package/docs/api/usage.d.ts +277 -0
- package/docs/api/usage.md +389 -0
- package/docs/api/visitors.d.ts +690 -0
- package/docs/api/visitors.md +1075 -0
- package/docs/api/voice.d.ts +4661 -0
- package/docs/api/voice.md +7905 -0
- package/docs/api/webAnalytics.d.ts +964 -0
- package/docs/api/webAnalytics.md +1452 -0
- package/docs/api/webChat.d.ts +1704 -0
- package/docs/api/webChat.md +2048 -0
- package/docs/api/webhooks.d.ts +251 -0
- package/docs/api/webhooks.md +386 -0
- package/docs/api/websiteEditor.d.ts +324 -0
- package/docs/api/websiteEditor.md +517 -0
- package/docs/api/work.d.ts +2298 -0
- package/docs/api/work.md +3096 -0
- package/docs/api/workbench.d.ts +2962 -0
- package/docs/api/workbench.md +4884 -0
- package/docs/api/workflows.d.ts +1218 -0
- package/docs/api/workflows.md +2302 -0
- package/docs/sdk-clients.md +4339 -0
- package/package.json +10 -3
|
@@ -0,0 +1,165 @@
|
|
|
1
|
+
<!-- Generated by sdk/js/scripts/generate-agent-docs.ts from developer-contract/openapi.json. Regenerated on every build. -->
|
|
2
|
+
|
|
3
|
+
# `g8.api`: every Developer API operation
|
|
4
|
+
|
|
5
|
+
`g8.api` is generated from the published OpenAPI contract, so it covers all 3252 operations across 141 namespaces (1508 read, 811 write, 300 destructive, 383 billable, 250 external).
|
|
6
|
+
|
|
7
|
+
- Found a REST path in a curl example or the web docs? Look it up in [by-path.md](by-path.md).
|
|
8
|
+
- Prefer a hand-written method where one exists: [../sdk-clients.md](../sdk-clients.md).
|
|
9
|
+
- At runtime, `g8.api.operations()` returns this same catalogue with each operation's method, path, tier and scope.
|
|
10
|
+
|
|
11
|
+
## Tiers
|
|
12
|
+
|
|
13
|
+
| Tier | Meaning |
|
|
14
|
+
|---|---|
|
|
15
|
+
| `read` | reads data; safe to call and to retry |
|
|
16
|
+
| `write` | creates or changes records; the SDK sends an Idempotency-Key and retries transient failures |
|
|
17
|
+
| `destructive` | deletes or archives data; confirm with a human before calling |
|
|
18
|
+
| `billable` | spends credits; the SDK never blindly retries it; confirm cost before bulk use |
|
|
19
|
+
| `external` | reaches real people (sends email/SMS, places a call, launches a send); the SDK never blindly retries it; confirm with a human first |
|
|
20
|
+
|
|
21
|
+
## Namespaces
|
|
22
|
+
|
|
23
|
+
| Namespace | Area | Operations | Hand-written coverage | Page | Types |
|
|
24
|
+
|---|---|---|---|---|---|
|
|
25
|
+
| `g8.api.accounts` | Accounts | 16 | none | [accounts.md](accounts.md) | [accounts.d.ts](accounts.d.ts) |
|
|
26
|
+
| `g8.api.adCampaigns` | Ad Campaigns | 19 | none | [adCampaigns.md](adCampaigns.md) | [adCampaigns.d.ts](adCampaigns.d.ts) |
|
|
27
|
+
| `g8.api.adCreatives` | Ad Creatives | 40 | none | [adCreatives.md](adCreatives.md) | [adCreatives.d.ts](adCreatives.d.ts) |
|
|
28
|
+
| `g8.api.agency` | Agency | 24 | 2 | [agency.md](agency.md) | [agency.d.ts](agency.d.ts) |
|
|
29
|
+
| `g8.api.agent` | Agent | 8 | none | [agent.md](agent.md) | [agent.d.ts](agent.d.ts) |
|
|
30
|
+
| `g8.api.agents` | Agents | 65 | none | [agents.md](agents.md) | [agents.d.ts](agents.d.ts) |
|
|
31
|
+
| `g8.api.aiInbox` | AI Inbox | 79 | none | [aiInbox.md](aiInbox.md) | [aiInbox.d.ts](aiInbox.d.ts) |
|
|
32
|
+
| `g8.api.analytics` | Analytics | 51 | none | [analytics.md](analytics.md) | [analytics.d.ts](analytics.d.ts) |
|
|
33
|
+
| `g8.api.apiKeys` | API Keys | 6 | none | [apiKeys.md](apiKeys.md) | [apiKeys.d.ts](apiKeys.d.ts) |
|
|
34
|
+
| `g8.api.appDeployments` | App Deployments | 7 | 6 | [appDeployments.md](appDeployments.md) | [appDeployments.d.ts](appDeployments.d.ts) |
|
|
35
|
+
| `g8.api.appDomains` | App Domains | 5 | 4 | [appDomains.md](appDomains.md) | [appDomains.d.ts](appDomains.d.ts) |
|
|
36
|
+
| `g8.api.appLogs` | App Logs | 2 | 2 | [appLogs.md](appLogs.md) | [appLogs.d.ts](appLogs.d.ts) |
|
|
37
|
+
| `g8.api.appObjects` | App Objects | 10 | none | [appObjects.md](appObjects.md) | [appObjects.d.ts](appObjects.d.ts) |
|
|
38
|
+
| `g8.api.appPages` | App Pages | 16 | none | [appPages.md](appPages.md) | [appPages.d.ts](appPages.d.ts) |
|
|
39
|
+
| `g8.api.appPlatformTokens` | App Platform - Tokens | 3 | none | [appPlatformTokens.md](appPlatformTokens.md) | [appPlatformTokens.d.ts](appPlatformTokens.d.ts) |
|
|
40
|
+
| `g8.api.appointments` | Appointments | 92 | none | [appointments.md](appointments.md) | [appointments.d.ts](appointments.d.ts) |
|
|
41
|
+
| `g8.api.apps` | Apps | 22 | 14 | [apps.md](apps.md) | [apps.d.ts](apps.d.ts) |
|
|
42
|
+
| `g8.api.assertUpsert` | Assert / Upsert | 6 | 1 | [assertUpsert.md](assertUpsert.md) | [assertUpsert.d.ts](assertUpsert.d.ts) |
|
|
43
|
+
| `g8.api.audienceSyncs` | Audience Syncs | 8 | 8 | [audienceSyncs.md](audienceSyncs.md) | [audienceSyncs.d.ts](audienceSyncs.d.ts) |
|
|
44
|
+
| `g8.api.brandKit` | Brand Kit | 30 | none | [brandKit.md](brandKit.md) | [brandKit.d.ts](brandKit.d.ts) |
|
|
45
|
+
| `g8.api.bugReports` | Bug Reports | 7 | none | [bugReports.md](bugReports.md) | [bugReports.d.ts](bugReports.d.ts) |
|
|
46
|
+
| `g8.api.calendarInvites` | Calendar Invites | 3 | none | [calendarInvites.md](calendarInvites.md) | [calendarInvites.d.ts](calendarInvites.d.ts) |
|
|
47
|
+
| `g8.api.campaignWorkflows` | Campaign Workflows | 5 | none | [campaignWorkflows.md](campaignWorkflows.md) | [campaignWorkflows.d.ts](campaignWorkflows.d.ts) |
|
|
48
|
+
| `g8.api.campaigns` | Campaigns | 29 | none | [campaigns.md](campaigns.md) | [campaigns.d.ts](campaigns.d.ts) |
|
|
49
|
+
| `g8.api.channels` | Channels | 5 | none | [channels.md](channels.md) | [channels.d.ts](channels.d.ts) |
|
|
50
|
+
| `g8.api.cliCampaigns` | CLI Campaigns | 6 | none | [cliCampaigns.md](cliCampaigns.md) | [cliCampaigns.d.ts](cliCampaigns.d.ts) |
|
|
51
|
+
| `g8.api.cliPipelines` | CLI Pipelines | 12 | 12 | [cliPipelines.md](cliPipelines.md) | [cliPipelines.d.ts](cliPipelines.d.ts) |
|
|
52
|
+
| `g8.api.clickHouse` | ClickHouse | 2 | none | [clickHouse.md](clickHouse.md) | [clickHouse.d.ts](clickHouse.d.ts) |
|
|
53
|
+
| `g8.api.companies` | Companies | 50 | 8 | [companies.md](companies.md) | [companies.d.ts](companies.d.ts) |
|
|
54
|
+
| `g8.api.companyIntelligence` | Company Intelligence | 14 | none | [companyIntelligence.md](companyIntelligence.md) | [companyIntelligence.d.ts](companyIntelligence.d.ts) |
|
|
55
|
+
| `g8.api.contacts` | Contacts | 70 | 7 | [contacts.md](contacts.md) | [contacts.d.ts](contacts.d.ts) |
|
|
56
|
+
| `g8.api.content` | Content | 41 | none | [content.md](content.md) | [content.d.ts](content.d.ts) |
|
|
57
|
+
| `g8.api.contentGridSkills` | Content Grid Skills | 6 | none | [contentGridSkills.md](contentGridSkills.md) | [contentGridSkills.d.ts](contentGridSkills.d.ts) |
|
|
58
|
+
| `g8.api.copilot` | Copilot | 39 | none | [copilot.md](copilot.md) | [copilot.d.ts](copilot.d.ts) |
|
|
59
|
+
| `g8.api.crmSyncs` | CRM Syncs | 6 | none | [crmSyncs.md](crmSyncs.md) | [crmSyncs.d.ts](crmSyncs.d.ts) |
|
|
60
|
+
| `g8.api.customerSuccess` | Customer success | 19 | none | [customerSuccess.md](customerSuccess.md) | [customerSuccess.d.ts](customerSuccess.d.ts) |
|
|
61
|
+
| `g8.api.deals` | Deals | 48 | 8 | [deals.md](deals.md) | [deals.d.ts](deals.d.ts) |
|
|
62
|
+
| `g8.api.deliverability` | Deliverability | 17 | none | [deliverability.md](deliverability.md) | [deliverability.d.ts](deliverability.d.ts) |
|
|
63
|
+
| `g8.api.desk` | Desk | 71 | none | [desk.md](desk.md) | [desk.d.ts](desk.d.ts) |
|
|
64
|
+
| `g8.api.dialer` | Dialer | 46 | none | [dialer.md](dialer.md) | [dialer.d.ts](dialer.d.ts) |
|
|
65
|
+
| `g8.api.dialerAnalytics` | Dialer Analytics | 6 | none | [dialerAnalytics.md](dialerAnalytics.md) | [dialerAnalytics.d.ts](dialerAnalytics.d.ts) |
|
|
66
|
+
| `g8.api.documents` | Documents | 35 | none | [documents.md](documents.md) | [documents.d.ts](documents.d.ts) |
|
|
67
|
+
| `g8.api.duplicates` | Duplicates | 7 | none | [duplicates.md](duplicates.md) | [duplicates.d.ts](duplicates.d.ts) |
|
|
68
|
+
| `g8.api.eSign` | E-Sign | 1 | none | [eSign.md](eSign.md) | [eSign.d.ts](eSign.d.ts) |
|
|
69
|
+
| `g8.api.eSignature` | E-Signature | 7 | none | [eSignature.md](eSignature.md) | [eSignature.d.ts](eSignature.d.ts) |
|
|
70
|
+
| `g8.api.enrichment` | Enrichment | 114 | 3 | [enrichment.md](enrichment.md) | [enrichment.d.ts](enrichment.d.ts) |
|
|
71
|
+
| `g8.api.events` | Events | 1 | none | [events.md](events.md) | [events.d.ts](events.d.ts) |
|
|
72
|
+
| `g8.api.fields` | Fields | 8 | 5 | [fields.md](fields.md) | [fields.d.ts](fields.d.ts) |
|
|
73
|
+
| `g8.api.forms` | Forms | 35 | none | [forms.md](forms.md) | [forms.d.ts](forms.d.ts) |
|
|
74
|
+
| `g8.api.gtmCampaigns` | GTM Campaigns | 22 | 4 | [gtmCampaigns.md](gtmCampaigns.md) | [gtmCampaigns.d.ts](gtmCampaigns.d.ts) |
|
|
75
|
+
| `g8.api.gtmContext` | GTM Context | 51 | 13 | [gtmContext.md](gtmContext.md) | [gtmContext.d.ts](gtmContext.d.ts) |
|
|
76
|
+
| `g8.api.gtmDeliverability` | GTM Deliverability | 1 | none | [gtmDeliverability.md](gtmDeliverability.md) | [gtmDeliverability.d.ts](gtmDeliverability.d.ts) |
|
|
77
|
+
| `g8.api.gtmKnowledgeBase` | GTM Knowledge Base | 2 | none | [gtmKnowledgeBase.md](gtmKnowledgeBase.md) | [gtmKnowledgeBase.d.ts](gtmKnowledgeBase.d.ts) |
|
|
78
|
+
| `g8.api.gtmLaunchHelpers` | GTM Launch Helpers | 2 | none | [gtmLaunchHelpers.md](gtmLaunchHelpers.md) | [gtmLaunchHelpers.d.ts](gtmLaunchHelpers.d.ts) |
|
|
79
|
+
| `g8.api.gtmLibrary` | GTM Library | 20 | none | [gtmLibrary.md](gtmLibrary.md) | [gtmLibrary.d.ts](gtmLibrary.d.ts) |
|
|
80
|
+
| `g8.api.health` | health | 1 | none | [health.md](health.md) | [health.d.ts](health.d.ts) |
|
|
81
|
+
| `g8.api.imageLibrary` | Image Library | 14 | none | [imageLibrary.md](imageLibrary.md) | [imageLibrary.d.ts](imageLibrary.d.ts) |
|
|
82
|
+
| `g8.api.imports` | Imports | 3 | none | [imports.md](imports.md) | [imports.d.ts](imports.d.ts) |
|
|
83
|
+
| `g8.api.inbox` | Inbox | 22 | 6 | [inbox.md](inbox.md) | [inbox.d.ts](inbox.d.ts) |
|
|
84
|
+
| `g8.api.install` | Install | 6 | none | [install.md](install.md) | [install.d.ts](install.d.ts) |
|
|
85
|
+
| `g8.api.installedApps` | Installed Apps | 4 | none | [installedApps.md](installedApps.md) | [installedApps.d.ts](installedApps.d.ts) |
|
|
86
|
+
| `g8.api.integrationStatus` | Integration Status | 6 | none | [integrationStatus.md](integrationStatus.md) | [integrationStatus.d.ts](integrationStatus.d.ts) |
|
|
87
|
+
| `g8.api.integrations` | Integrations | 83 | none | [integrations.md](integrations.md) | [integrations.d.ts](integrations.d.ts) |
|
|
88
|
+
| `g8.api.intent` | Intent | 16 | 13 | [intent.md](intent.md) | [intent.d.ts](intent.d.ts) |
|
|
89
|
+
| `g8.api.knowledge` | Knowledge | 21 | none | [knowledge.md](knowledge.md) | [knowledge.d.ts](knowledge.d.ts) |
|
|
90
|
+
| `g8.api.knowledgeBase` | Knowledge Base | 2 | none | [knowledgeBase.md](knowledgeBase.md) | [knowledgeBase.d.ts](knowledgeBase.d.ts) |
|
|
91
|
+
| `g8.api.landingPages` | Landing Pages | 59 | none | [landingPages.md](landingPages.md) | [landingPages.d.ts](landingPages.d.ts) |
|
|
92
|
+
| `g8.api.leads` | Leads | 4 | none | [leads.md](leads.md) | [leads.d.ts](leads.d.ts) |
|
|
93
|
+
| `g8.api.library` | Library | 9 | none | [library.md](library.md) | [library.d.ts](library.d.ts) |
|
|
94
|
+
| `g8.api.linkedIn` | LinkedIn | 5 | none | [linkedIn.md](linkedIn.md) | [linkedIn.d.ts](linkedIn.d.ts) |
|
|
95
|
+
| `g8.api.linkedInOutreach` | LinkedIn Outreach | 20 | none | [linkedInOutreach.md](linkedInOutreach.md) | [linkedInOutreach.d.ts](linkedInOutreach.d.ts) |
|
|
96
|
+
| `g8.api.lists` | Lists | 36 | 6 | [lists.md](lists.md) | [lists.d.ts](lists.d.ts) |
|
|
97
|
+
| `g8.api.logs` | Logs | 1 | none | [logs.md](logs.md) | [logs.d.ts](logs.d.ts) |
|
|
98
|
+
| `g8.api.mailboxes` | Mailboxes | 38 | 5 | [mailboxes.md](mailboxes.md) | [mailboxes.d.ts](mailboxes.d.ts) |
|
|
99
|
+
| `g8.api.marketingIntelligence` | Marketing Intelligence | 10 | none | [marketingIntelligence.md](marketingIntelligence.md) | [marketingIntelligence.d.ts](marketingIntelligence.d.ts) |
|
|
100
|
+
| `g8.api.marketplace` | Marketplace | 142 | 5 | [marketplace.md](marketplace.md) | [marketplace.d.ts](marketplace.d.ts) |
|
|
101
|
+
| `g8.api.mcp` | MCP | 1 | none | [mcp.md](mcp.md) | [mcp.d.ts](mcp.d.ts) |
|
|
102
|
+
| `g8.api.me` | Me | 1 | none | [me.md](me.md) | [me.d.ts](me.d.ts) |
|
|
103
|
+
| `g8.api.meetings` | Meetings | 17 | 2 | [meetings.md](meetings.md) | [meetings.d.ts](meetings.d.ts) |
|
|
104
|
+
| `g8.api.newsletter` | Newsletter | 61 | 15 | [newsletter.md](newsletter.md) | [newsletter.d.ts](newsletter.d.ts) |
|
|
105
|
+
| `g8.api.notes` | Notes | 19 | 8 | [notes.md](notes.md) | [notes.d.ts](notes.d.ts) |
|
|
106
|
+
| `g8.api.notifications` | Notifications | 2 | none | [notifications.md](notifications.md) | [notifications.d.ts](notifications.d.ts) |
|
|
107
|
+
| `g8.api.objects` | Objects | 18 | 18 | [objects.md](objects.md) | [objects.d.ts](objects.d.ts) |
|
|
108
|
+
| `g8.api.openSearch` | OpenSearch | 4 | none | [openSearch.md](openSearch.md) | [openSearch.d.ts](openSearch.d.ts) |
|
|
109
|
+
| `g8.api.ops` | Ops (internal, cross-tenant, read-only) | 5 | none | [ops.md](ops.md) | [ops.d.ts](ops.d.ts) |
|
|
110
|
+
| `g8.api.orgGovernance` | Org Governance | 17 | none | [orgGovernance.md](orgGovernance.md) | [orgGovernance.d.ts](orgGovernance.d.ts) |
|
|
111
|
+
| `g8.api.orgVideos` | Org Videos | 6 | none | [orgVideos.md](orgVideos.md) | [orgVideos.d.ts](orgVideos.d.ts) |
|
|
112
|
+
| `g8.api.organizationSettings` | Organization Settings | 22 | none | [organizationSettings.md](organizationSettings.md) | [organizationSettings.d.ts](organizationSettings.d.ts) |
|
|
113
|
+
| `g8.api.phoneNumbers` | Phone Numbers | 16 | none | [phoneNumbers.md](phoneNumbers.md) | [phoneNumbers.d.ts](phoneNumbers.d.ts) |
|
|
114
|
+
| `g8.api.profile` | Profile | 14 | none | [profile.md](profile.md) | [profile.d.ts](profile.d.ts) |
|
|
115
|
+
| `g8.api.programmaticPages` | Programmatic Pages | 15 | none | [programmaticPages.md](programmaticPages.md) | [programmaticPages.d.ts](programmaticPages.d.ts) |
|
|
116
|
+
| `g8.api.providerDomains` | Provider Domains | 34 | none | [providerDomains.md](providerDomains.md) | [providerDomains.d.ts](providerDomains.d.ts) |
|
|
117
|
+
| `g8.api.providerUsage` | Provider Usage | 5 | none | [providerUsage.md](providerUsage.md) | [providerUsage.d.ts](providerUsage.d.ts) |
|
|
118
|
+
| `g8.api.public` | Public | 1 | 1 | [public.md](public.md) | [public.d.ts](public.d.ts) |
|
|
119
|
+
| `g8.api.publicCopilot` | Public - Copilot | 1 | 1 | [publicCopilot.md](publicCopilot.md) | [publicCopilot.d.ts](publicCopilot.d.ts) |
|
|
120
|
+
| `g8.api.publicSignals` | Public - Signals | 1 | 1 | [publicSignals.md](publicSignals.md) | [publicSignals.d.ts](publicSignals.d.ts) |
|
|
121
|
+
| `g8.api.publicVisitors` | Public - Visitors | 2 | 2 | [publicVisitors.md](publicVisitors.md) | [publicVisitors.d.ts](publicVisitors.d.ts) |
|
|
122
|
+
| `g8.api.quotes` | Quotes | 56 | 12 | [quotes.md](quotes.md) | [quotes.d.ts](quotes.d.ts) |
|
|
123
|
+
| `g8.api.radar` | Radar | 42 | none | [radar.md](radar.md) | [radar.d.ts](radar.d.ts) |
|
|
124
|
+
| `g8.api.radarReports` | Radar Reports | 8 | none | [radarReports.md](radarReports.md) | [radarReports.d.ts](radarReports.d.ts) |
|
|
125
|
+
| `g8.api.recordRoles` | Record Roles | 4 | none | [recordRoles.md](recordRoles.md) | [recordRoles.d.ts](recordRoles.d.ts) |
|
|
126
|
+
| `g8.api.repos` | Repos | 4 | none | [repos.md](repos.md) | [repos.d.ts](repos.d.ts) |
|
|
127
|
+
| `g8.api.research` | Research | 13 | none | [research.md](research.md) | [research.d.ts](research.d.ts) |
|
|
128
|
+
| `g8.api.revenue` | Revenue | 14 | none | [revenue.md](revenue.md) | [revenue.d.ts](revenue.d.ts) |
|
|
129
|
+
| `g8.api.revenueAnalytics` | Revenue Analytics | 6 | none | [revenueAnalytics.md](revenueAnalytics.md) | [revenueAnalytics.d.ts](revenueAnalytics.d.ts) |
|
|
130
|
+
| `g8.api.revenueLifecycle` | Revenue Lifecycle | 5 | none | [revenueLifecycle.md](revenueLifecycle.md) | [revenueLifecycle.d.ts](revenueLifecycle.d.ts) |
|
|
131
|
+
| `g8.api.revenueRecords` | Revenue Records | 15 | none | [revenueRecords.md](revenueRecords.md) | [revenueRecords.d.ts](revenueRecords.d.ts) |
|
|
132
|
+
| `g8.api.roles` | Roles | 20 | none | [roles.md](roles.md) | [roles.d.ts](roles.d.ts) |
|
|
133
|
+
| `g8.api.salesCoach` | Sales Coach | 37 | none | [salesCoach.md](salesCoach.md) | [salesCoach.d.ts](salesCoach.d.ts) |
|
|
134
|
+
| `g8.api.sandbox` | sandbox | 9 | none | [sandbox.md](sandbox.md) | [sandbox.d.ts](sandbox.d.ts) |
|
|
135
|
+
| `g8.api.scans` | Scans | 2 | none | [scans.md](scans.md) | [scans.d.ts](scans.d.ts) |
|
|
136
|
+
| `g8.api.scheduleBuy` | Schedule Buy | 9 | none | [scheduleBuy.md](scheduleBuy.md) | [scheduleBuy.d.ts](scheduleBuy.d.ts) |
|
|
137
|
+
| `g8.api.scraping` | Scraping | 10 | none | [scraping.md](scraping.md) | [scraping.d.ts](scraping.d.ts) |
|
|
138
|
+
| `g8.api.sdrAnalytics` | SDR Analytics | 5 | none | [sdrAnalytics.md](sdrAnalytics.md) | [sdrAnalytics.d.ts](sdrAnalytics.d.ts) |
|
|
139
|
+
| `g8.api.search` | Search | 19 | 4 | [search.md](search.md) | [search.d.ts](search.d.ts) |
|
|
140
|
+
| `g8.api.seo` | SEO | 11 | none | [seo.md](seo.md) | [seo.d.ts](seo.d.ts) |
|
|
141
|
+
| `g8.api.sequenceLifecycle` | Sequence Lifecycle | 8 | 6 | [sequenceLifecycle.md](sequenceLifecycle.md) | [sequenceLifecycle.d.ts](sequenceLifecycle.d.ts) |
|
|
142
|
+
| `g8.api.sequences` | Sequences | 71 | 6 | [sequences.md](sequences.md) | [sequences.d.ts](sequences.d.ts) |
|
|
143
|
+
| `g8.api.settings` | Settings | 18 | none | [settings.md](settings.md) | [settings.d.ts](settings.d.ts) |
|
|
144
|
+
| `g8.api.signals` | Signals | 56 | none | [signals.md](signals.md) | [signals.d.ts](signals.d.ts) |
|
|
145
|
+
| `g8.api.signatures` | Signatures | 24 | none | [signatures.md](signatures.md) | [signatures.d.ts](signatures.d.ts) |
|
|
146
|
+
| `g8.api.skills` | Skills | 12 | 12 | [skills.md](skills.md) | [skills.d.ts](skills.d.ts) |
|
|
147
|
+
| `g8.api.snippet` | Snippet | 2 | 1 | [snippet.md](snippet.md) | [snippet.d.ts](snippet.d.ts) |
|
|
148
|
+
| `g8.api.socialPublishing` | Social Publishing | 22 | none | [socialPublishing.md](socialPublishing.md) | [socialPublishing.d.ts](socialPublishing.d.ts) |
|
|
149
|
+
| `g8.api.studioDocuments` | Studio Documents | 9 | none | [studioDocuments.md](studioDocuments.md) | [studioDocuments.d.ts](studioDocuments.d.ts) |
|
|
150
|
+
| `g8.api.support` | Support | 1 | none | [support.md](support.md) | [support.d.ts](support.d.ts) |
|
|
151
|
+
| `g8.api.suppressions` | Suppressions | 6 | none | [suppressions.md](suppressions.md) | [suppressions.d.ts](suppressions.d.ts) |
|
|
152
|
+
| `g8.api.surveys` | Surveys | 21 | none | [surveys.md](surveys.md) | [surveys.d.ts](surveys.d.ts) |
|
|
153
|
+
| `g8.api.tasks` | Tasks | 25 | 5 | [tasks.md](tasks.md) | [tasks.d.ts](tasks.d.ts) |
|
|
154
|
+
| `g8.api.teamMembers` | Team members | 21 | none | [teamMembers.md](teamMembers.md) | [teamMembers.d.ts](teamMembers.d.ts) |
|
|
155
|
+
| `g8.api.teams` | Teams | 35 | none | [teams.md](teams.md) | [teams.d.ts](teams.d.ts) |
|
|
156
|
+
| `g8.api.usage` | Usage | 9 | none | [usage.md](usage.md) | [usage.d.ts](usage.d.ts) |
|
|
157
|
+
| `g8.api.visitors` | Visitors | 26 | none | [visitors.md](visitors.md) | [visitors.d.ts](visitors.d.ts) |
|
|
158
|
+
| `g8.api.voice` | Voice | 187 | 11 | [voice.md](voice.md) | [voice.d.ts](voice.d.ts) |
|
|
159
|
+
| `g8.api.webAnalytics` | Web Analytics | 38 | none | [webAnalytics.md](webAnalytics.md) | [webAnalytics.d.ts](webAnalytics.d.ts) |
|
|
160
|
+
| `g8.api.webChat` | Web Chat | 46 | none | [webChat.md](webChat.md) | [webChat.d.ts](webChat.d.ts) |
|
|
161
|
+
| `g8.api.webhooks` | Webhooks | 8 | none | [webhooks.md](webhooks.md) | [webhooks.d.ts](webhooks.d.ts) |
|
|
162
|
+
| `g8.api.websiteEditor` | Website Editor | 12 | none | [websiteEditor.md](websiteEditor.md) | [websiteEditor.d.ts](websiteEditor.d.ts) |
|
|
163
|
+
| `g8.api.work` | Work | 59 | none | [work.md](work.md) | [work.d.ts](work.d.ts) |
|
|
164
|
+
| `g8.api.workbench` | Workbench | 107 | none | [workbench.md](workbench.md) | [workbench.d.ts](workbench.d.ts) |
|
|
165
|
+
| `g8.api.workflows` | Workflows | 59 | 21 | [workflows.md](workflows.md) | [workflows.d.ts](workflows.d.ts) |
|
|
@@ -0,0 +1,396 @@
|
|
|
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.accounts` (Accounts): 16 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<"generate_outreach_plan_accounts__account_id__generate_outreach_plan_post">;
|
|
9
|
+
*
|
|
10
|
+
* Reference with examples: accounts.md
|
|
11
|
+
*/
|
|
12
|
+
/* eslint-disable */
|
|
13
|
+
|
|
14
|
+
/** `g8.api.accounts.<member>` -> the operationId it calls. */
|
|
15
|
+
export interface AccountsMembers {
|
|
16
|
+
generateOutreachPlan: "generate_outreach_plan_accounts__account_id__generate_outreach_plan_post";
|
|
17
|
+
generateStakeholderOutreach: "generate_stakeholder_outreach_accounts__account_id__stakeholders__stakeholder_id__generate_outreach_post";
|
|
18
|
+
getAccountAdoptionMatrix: "get_account_adoption_matrix_accounts__account_id__adoption_matrix_get";
|
|
19
|
+
getAccountBilling: "get_account_billing_accounts__account_id__billing_get";
|
|
20
|
+
getAccountCompanyContacts: "get_account_company_contacts_accounts__mashup_company_id__contacts_get";
|
|
21
|
+
getAccountIntentSignals: "get_account_intent_signals_accounts__account_id__intent_signals_get";
|
|
22
|
+
getAccountTrialJourney: "get_account_trial_journey_accounts__account_id__trial_journey_get";
|
|
23
|
+
getIntentSignal: "get_intent_signal_accounts_intent_signal_get";
|
|
24
|
+
getRevenueSummary: "get_revenue_summary_accounts_revenue_summary_get";
|
|
25
|
+
getTrialDropoffFunnel: "get_trial_dropoff_funnel_accounts_trial_dropoff_funnel_get";
|
|
26
|
+
getTrialDropoffStep: "get_trial_dropoff_step_accounts_trial_dropoff_funnel_step_get";
|
|
27
|
+
getTrialInsight: "get_trial_insight_accounts__account_id__trial_insight_post";
|
|
28
|
+
getTrialOverview: "get_trial_overview_accounts_trial_overview_get";
|
|
29
|
+
getTrialOverviewList: "get_trial_overview_list_accounts_trial_overview_list_get";
|
|
30
|
+
listAccountDocumentsBatch: "list_account_documents_batch_accounts_documents_get";
|
|
31
|
+
listAccountsEnriched: "list_accounts_enriched_accounts_enriched_get";
|
|
32
|
+
}
|
|
33
|
+
|
|
34
|
+
/** Input and output of every `g8.api.accounts` operation, keyed by operationId. */
|
|
35
|
+
export interface AccountsOperations {
|
|
36
|
+
/**
|
|
37
|
+
* POST /accounts/{account_id}/generate-outreach-plan
|
|
38
|
+
* Generate Outreach Plan
|
|
39
|
+
* tier: billable · scope: sequences:run
|
|
40
|
+
*/
|
|
41
|
+
generate_outreach_plan_accounts__account_id__generate_outreach_plan_post: {
|
|
42
|
+
input: {
|
|
43
|
+
path: {
|
|
44
|
+
/** Account id: the account UUID or the company id. */
|
|
45
|
+
account_id: string;
|
|
46
|
+
};
|
|
47
|
+
headers?: {
|
|
48
|
+
"X-Target-Org-Id"?: string | null;
|
|
49
|
+
};
|
|
50
|
+
};
|
|
51
|
+
output: ApiResponse_OrgPayload_;
|
|
52
|
+
};
|
|
53
|
+
/**
|
|
54
|
+
* POST /accounts/{account_id}/stakeholders/{stakeholder_id}/generate-outreach
|
|
55
|
+
* Generate Stakeholder Outreach
|
|
56
|
+
* tier: billable · scope: sequences:run
|
|
57
|
+
*/
|
|
58
|
+
generate_stakeholder_outreach_accounts__account_id__stakeholders__stakeholder_id__generate_outreach_post: {
|
|
59
|
+
input: {
|
|
60
|
+
path: {
|
|
61
|
+
/** Account id: the account UUID or the company id. */
|
|
62
|
+
account_id: string;
|
|
63
|
+
/** The stakeholder (contact) to write for. */
|
|
64
|
+
stakeholder_id: string;
|
|
65
|
+
};
|
|
66
|
+
headers?: {
|
|
67
|
+
"X-Target-Org-Id"?: string | null;
|
|
68
|
+
};
|
|
69
|
+
body: AccountStakeholderOutreachRequest;
|
|
70
|
+
};
|
|
71
|
+
output: ApiResponse_OrgPayload_;
|
|
72
|
+
};
|
|
73
|
+
/**
|
|
74
|
+
* GET /accounts/{account_id}/adoption-matrix
|
|
75
|
+
* Get Account Adoption Matrix
|
|
76
|
+
* tier: read · scope: companies:read
|
|
77
|
+
*/
|
|
78
|
+
get_account_adoption_matrix_accounts__account_id__adoption_matrix_get: {
|
|
79
|
+
input: {
|
|
80
|
+
path: {
|
|
81
|
+
/** Account id: the account UUID or the company id. */
|
|
82
|
+
account_id: string;
|
|
83
|
+
};
|
|
84
|
+
headers?: {
|
|
85
|
+
"X-Target-Org-Id"?: string | null;
|
|
86
|
+
};
|
|
87
|
+
};
|
|
88
|
+
output: ApiResponse_OrgPayload_;
|
|
89
|
+
};
|
|
90
|
+
/**
|
|
91
|
+
* GET /accounts/{account_id}/billing
|
|
92
|
+
* Get Account Billing
|
|
93
|
+
* tier: read · scope: companies:read
|
|
94
|
+
*/
|
|
95
|
+
get_account_billing_accounts__account_id__billing_get: {
|
|
96
|
+
input: {
|
|
97
|
+
path: {
|
|
98
|
+
/** Account id: the account UUID or the company id. */
|
|
99
|
+
account_id: string;
|
|
100
|
+
};
|
|
101
|
+
headers?: {
|
|
102
|
+
"X-Target-Org-Id"?: string | null;
|
|
103
|
+
};
|
|
104
|
+
};
|
|
105
|
+
output: ApiResponse_OrgPayload_;
|
|
106
|
+
};
|
|
107
|
+
/**
|
|
108
|
+
* GET /accounts/{mashup_company_id}/contacts
|
|
109
|
+
* Get Account Company Contacts
|
|
110
|
+
* tier: read · scope: companies:read
|
|
111
|
+
*/
|
|
112
|
+
get_account_company_contacts_accounts__mashup_company_id__contacts_get: {
|
|
113
|
+
input: {
|
|
114
|
+
path: {
|
|
115
|
+
/** The company's integer id. */
|
|
116
|
+
mashup_company_id: number;
|
|
117
|
+
};
|
|
118
|
+
query?: {
|
|
119
|
+
limit?: number;
|
|
120
|
+
};
|
|
121
|
+
headers?: {
|
|
122
|
+
"X-Target-Org-Id"?: string | null;
|
|
123
|
+
};
|
|
124
|
+
};
|
|
125
|
+
output: ApiResponse_OrgPayload_;
|
|
126
|
+
};
|
|
127
|
+
/**
|
|
128
|
+
* GET /accounts/{account_id}/intent-signals
|
|
129
|
+
* Get Account Intent Signals
|
|
130
|
+
* tier: read · scope: companies:read
|
|
131
|
+
*/
|
|
132
|
+
get_account_intent_signals_accounts__account_id__intent_signals_get: {
|
|
133
|
+
input: {
|
|
134
|
+
path: {
|
|
135
|
+
/** Account id: the account UUID or the company id. */
|
|
136
|
+
account_id: string;
|
|
137
|
+
};
|
|
138
|
+
query?: {
|
|
139
|
+
limit?: number;
|
|
140
|
+
};
|
|
141
|
+
headers?: {
|
|
142
|
+
"X-Target-Org-Id"?: string | null;
|
|
143
|
+
};
|
|
144
|
+
};
|
|
145
|
+
output: ApiResponse_OrgPayload_;
|
|
146
|
+
};
|
|
147
|
+
/**
|
|
148
|
+
* GET /accounts/{account_id}/trial-journey
|
|
149
|
+
* Get Account Trial Journey
|
|
150
|
+
* tier: read · scope: companies:read
|
|
151
|
+
*/
|
|
152
|
+
get_account_trial_journey_accounts__account_id__trial_journey_get: {
|
|
153
|
+
input: {
|
|
154
|
+
path: {
|
|
155
|
+
/** Account id: the account UUID or the company id. */
|
|
156
|
+
account_id: string;
|
|
157
|
+
};
|
|
158
|
+
headers?: {
|
|
159
|
+
"X-Target-Org-Id"?: string | null;
|
|
160
|
+
};
|
|
161
|
+
};
|
|
162
|
+
output: ApiResponse_OrgPayload_;
|
|
163
|
+
};
|
|
164
|
+
/**
|
|
165
|
+
* GET /accounts/intent-signal
|
|
166
|
+
* Get Intent Signal
|
|
167
|
+
* tier: read · scope: companies:read
|
|
168
|
+
*/
|
|
169
|
+
get_intent_signal_accounts_intent_signal_get: {
|
|
170
|
+
input: {
|
|
171
|
+
headers?: {
|
|
172
|
+
"X-Target-Org-Id"?: string | null;
|
|
173
|
+
};
|
|
174
|
+
};
|
|
175
|
+
output: ApiResponse_OrgPayload_;
|
|
176
|
+
};
|
|
177
|
+
/**
|
|
178
|
+
* GET /accounts/revenue-summary
|
|
179
|
+
* Get Revenue Summary
|
|
180
|
+
* tier: read · scope: companies:read
|
|
181
|
+
*/
|
|
182
|
+
get_revenue_summary_accounts_revenue_summary_get: {
|
|
183
|
+
input: {
|
|
184
|
+
headers?: {
|
|
185
|
+
"X-Target-Org-Id"?: string | null;
|
|
186
|
+
};
|
|
187
|
+
};
|
|
188
|
+
output: ApiResponse_OrgPayload_;
|
|
189
|
+
};
|
|
190
|
+
/**
|
|
191
|
+
* GET /accounts/trial-dropoff-funnel
|
|
192
|
+
* Get Trial Dropoff Funnel
|
|
193
|
+
* tier: read · scope: companies:read
|
|
194
|
+
*/
|
|
195
|
+
get_trial_dropoff_funnel_accounts_trial_dropoff_funnel_get: {
|
|
196
|
+
input: {
|
|
197
|
+
query?: {
|
|
198
|
+
/** Window, in days. */
|
|
199
|
+
days?: number;
|
|
200
|
+
limit?: number;
|
|
201
|
+
};
|
|
202
|
+
headers?: {
|
|
203
|
+
"X-Target-Org-Id"?: string | null;
|
|
204
|
+
};
|
|
205
|
+
};
|
|
206
|
+
output: ApiResponse_OrgPayload_;
|
|
207
|
+
};
|
|
208
|
+
/**
|
|
209
|
+
* GET /accounts/trial-dropoff-funnel/step
|
|
210
|
+
* Get Trial Dropoff Step
|
|
211
|
+
* tier: read · scope: companies:read
|
|
212
|
+
*/
|
|
213
|
+
get_trial_dropoff_step_accounts_trial_dropoff_funnel_step_get: {
|
|
214
|
+
input: {
|
|
215
|
+
query: {
|
|
216
|
+
/** The funnel step to drill into. */
|
|
217
|
+
step_key: string;
|
|
218
|
+
/** Window, in days. */
|
|
219
|
+
days?: number;
|
|
220
|
+
limit?: number;
|
|
221
|
+
};
|
|
222
|
+
headers?: {
|
|
223
|
+
"X-Target-Org-Id"?: string | null;
|
|
224
|
+
};
|
|
225
|
+
};
|
|
226
|
+
output: ApiResponse_OrgPayload_;
|
|
227
|
+
};
|
|
228
|
+
/**
|
|
229
|
+
* POST /accounts/{account_id}/trial-insight
|
|
230
|
+
* Get Trial Insight
|
|
231
|
+
* tier: write · scope: companies:write
|
|
232
|
+
*/
|
|
233
|
+
get_trial_insight_accounts__account_id__trial_insight_post: {
|
|
234
|
+
input: {
|
|
235
|
+
path: {
|
|
236
|
+
/** Account id: the account UUID or the company id. */
|
|
237
|
+
account_id: string;
|
|
238
|
+
};
|
|
239
|
+
headers?: {
|
|
240
|
+
"X-Target-Org-Id"?: string | null;
|
|
241
|
+
};
|
|
242
|
+
};
|
|
243
|
+
output: ApiResponse_OrgPayload_;
|
|
244
|
+
};
|
|
245
|
+
/**
|
|
246
|
+
* GET /accounts/trial-overview
|
|
247
|
+
* Get Trial Overview
|
|
248
|
+
* tier: read · scope: companies:read
|
|
249
|
+
*/
|
|
250
|
+
get_trial_overview_accounts_trial_overview_get: {
|
|
251
|
+
input: {
|
|
252
|
+
query?: {
|
|
253
|
+
/** Count trials by company or by contact. */
|
|
254
|
+
view?: string;
|
|
255
|
+
};
|
|
256
|
+
headers?: {
|
|
257
|
+
"X-Target-Org-Id"?: string | null;
|
|
258
|
+
};
|
|
259
|
+
};
|
|
260
|
+
output: ApiResponse_OrgPayload_;
|
|
261
|
+
};
|
|
262
|
+
/**
|
|
263
|
+
* GET /accounts/trial-overview/list
|
|
264
|
+
* Get Trial Overview List
|
|
265
|
+
* tier: read · scope: companies:read
|
|
266
|
+
*/
|
|
267
|
+
get_trial_overview_list_accounts_trial_overview_list_get: {
|
|
268
|
+
input: {
|
|
269
|
+
query?: {
|
|
270
|
+
/** Which headline number to drill into. */
|
|
271
|
+
metric?: string;
|
|
272
|
+
/** Companies or contacts. */
|
|
273
|
+
view?: string;
|
|
274
|
+
/** Active or expired trials. */
|
|
275
|
+
status?: string;
|
|
276
|
+
/** Enrichment segment, when `view=contacts`. */
|
|
277
|
+
segment?: string;
|
|
278
|
+
limit?: number;
|
|
279
|
+
};
|
|
280
|
+
headers?: {
|
|
281
|
+
"X-Target-Org-Id"?: string | null;
|
|
282
|
+
};
|
|
283
|
+
};
|
|
284
|
+
output: ApiResponse_OrgListPayload_;
|
|
285
|
+
};
|
|
286
|
+
/**
|
|
287
|
+
* GET /accounts/documents
|
|
288
|
+
* List Account Documents Batch
|
|
289
|
+
* tier: read · scope: companies:read
|
|
290
|
+
*/
|
|
291
|
+
list_account_documents_batch_accounts_documents_get: {
|
|
292
|
+
input: {
|
|
293
|
+
query: {
|
|
294
|
+
/** Comma-separated account ids. The batch ceiling is the app's own. */
|
|
295
|
+
account_ids: string;
|
|
296
|
+
/** Only documents in this folder. */
|
|
297
|
+
folder?: string | null;
|
|
298
|
+
/** Include the full document bodies. Off by default because the payload grows by orders of magnitude when it is on. */
|
|
299
|
+
include_content?: boolean;
|
|
300
|
+
};
|
|
301
|
+
headers?: {
|
|
302
|
+
"X-Target-Org-Id"?: string | null;
|
|
303
|
+
};
|
|
304
|
+
};
|
|
305
|
+
output: ApiResponse_OrgListPayload_;
|
|
306
|
+
};
|
|
307
|
+
/**
|
|
308
|
+
* GET /accounts/enriched
|
|
309
|
+
* List Accounts Enriched
|
|
310
|
+
* tier: read · scope: companies:read
|
|
311
|
+
*/
|
|
312
|
+
list_accounts_enriched_accounts_enriched_get: {
|
|
313
|
+
input: {
|
|
314
|
+
query?: {
|
|
315
|
+
skip?: number;
|
|
316
|
+
limit?: number;
|
|
317
|
+
/** Match on company name or domain. */
|
|
318
|
+
search?: string | null;
|
|
319
|
+
/** Lifecycle status, e.g. `trial` or `customer`. */
|
|
320
|
+
status?: string | null;
|
|
321
|
+
/** Filter to one lifecycle stage. */
|
|
322
|
+
lifecycle_id?: string | null;
|
|
323
|
+
/** Filter on website-check state. */
|
|
324
|
+
website_status?: string | null;
|
|
325
|
+
/** Only accounts with an open deal. */
|
|
326
|
+
in_pipeline?: boolean;
|
|
327
|
+
/** Include first-touch attribution. */
|
|
328
|
+
include_attribution?: boolean;
|
|
329
|
+
/** Use the same trial cohort `/accounts/trial-overview` uses, so the rows here and the counts there agree. Off by default, matching the app. */
|
|
330
|
+
canonical_trial_cohort?: boolean;
|
|
331
|
+
/** Attach recent product-session links. */
|
|
332
|
+
include_sessions?: boolean;
|
|
333
|
+
};
|
|
334
|
+
headers?: {
|
|
335
|
+
"X-Target-Org-Id"?: string | null;
|
|
336
|
+
};
|
|
337
|
+
};
|
|
338
|
+
output: ApiResponse_OrgListPayload_;
|
|
339
|
+
};
|
|
340
|
+
}
|
|
341
|
+
|
|
342
|
+
// 6 schemas referenced above (the same as G8Contract.<Name>).
|
|
343
|
+
|
|
344
|
+
/** Mirrors `accounts.GenerateOutreachRequest`. */
|
|
345
|
+
export interface AccountStakeholderOutreachRequest {
|
|
346
|
+
/** What to draft for this stakeholder. */
|
|
347
|
+
type: "email" | "linkedin" | "call_script";
|
|
348
|
+
}
|
|
349
|
+
|
|
350
|
+
export interface ApiResponse_OrgListPayload_ {
|
|
351
|
+
data: OrgListPayload;
|
|
352
|
+
pagination?: PaginationMeta | null;
|
|
353
|
+
}
|
|
354
|
+
|
|
355
|
+
export interface ApiResponse_OrgPayload_ {
|
|
356
|
+
data: OrgPayload;
|
|
357
|
+
pagination?: PaginationMeta | null;
|
|
358
|
+
}
|
|
359
|
+
|
|
360
|
+
/**
|
|
361
|
+
* An open envelope for a LIST result, so a bare list keeps its shape.
|
|
362
|
+
*
|
|
363
|
+
* Most of these handlers return a bare `list[...]`; a few return a named
|
|
364
|
+
* envelope (`{"team_members": [...], "total": n}`). Both are reachable as
|
|
365
|
+
* `items`, and a named envelope KEEPS its own key as well so a caller
|
|
366
|
+
* already reading the app's shape is not broken by the wrapper.
|
|
367
|
+
*/
|
|
368
|
+
export interface OrgListPayload {
|
|
369
|
+
items?: Array<unknown>;
|
|
370
|
+
[key: string]: unknown;
|
|
371
|
+
}
|
|
372
|
+
|
|
373
|
+
/**
|
|
374
|
+
* An open envelope for a single role, team, member or account record.
|
|
375
|
+
*
|
|
376
|
+
* Open on purpose. The app's own response models on this surface grow with
|
|
377
|
+
* the product - `RoleResponse` gained `rep_limits` and `manages_role_slugs`,
|
|
378
|
+
* `TeamResponse` gained channel counts and a campaign count - and a pinned
|
|
379
|
+
* mirror would SILENTLY DROP whatever it had not caught up on. A dropped
|
|
380
|
+
* permission in a role read is the worst possible kind of stale: it reads as
|
|
381
|
+
* "they do not have it".
|
|
382
|
+
*/
|
|
383
|
+
export type OrgPayload = Record<string, unknown>;
|
|
384
|
+
|
|
385
|
+
export interface PaginationMeta {
|
|
386
|
+
/** Whether there are more pages */
|
|
387
|
+
has_next: boolean;
|
|
388
|
+
/** Items per page */
|
|
389
|
+
limit: number;
|
|
390
|
+
/** 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. */
|
|
391
|
+
next_cursor?: string | null;
|
|
392
|
+
/** Current page number (1-indexed) */
|
|
393
|
+
page: number;
|
|
394
|
+
/** Total number of items */
|
|
395
|
+
total: number;
|
|
396
|
+
}
|