@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,747 @@
|
|
|
1
|
+
<!-- Generated by sdk/js/scripts/generate-agent-docs.ts from developer-contract/openapi.json. Regenerated on every build. -->
|
|
2
|
+
|
|
3
|
+
# `g8.api.meetings`: Meetings
|
|
4
|
+
|
|
5
|
+
17 operations (10 read, 3 write, 1 destructive, 3 billable).
|
|
6
|
+
|
|
7
|
+
2 of these also have a hand-written method (`g8.meetings`), 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: [meetings.d.ts](meetings.d.ts).
|
|
20
|
+
|
|
21
|
+
## Operations
|
|
22
|
+
|
|
23
|
+
| Call | HTTP | Tier | Scope | Summary |
|
|
24
|
+
|---|---|---|---|---|
|
|
25
|
+
| [`acknowledgeMeetingReview`](#op-acknowledgemeetingreview) | `POST /api/v1/meeting-transcripts/{transcript_id}/review/acknowledge` | write | `meetings:write` | Acknowledge Meeting Review |
|
|
26
|
+
| [`advanceDealStage`](#op-advancedealstage) | `POST /api/v1/deals/{deal_id}/advance-stage` | write | `meetings:write` | Advance Deal Stage |
|
|
27
|
+
| [`deleteMeetingTranscript`](#op-deletemeetingtranscript) | `DELETE /api/v1/meeting-transcripts/{transcript_id}` | destructive | `meetings:delete` | Delete Meeting Transcript |
|
|
28
|
+
| [`draftMeetingFollowUp`](#op-draftmeetingfollowup) | `POST /api/v1/meeting-transcripts/{transcript_id}/follow-up-draft` | billable | `meetings:run` | Draft Meeting Follow Up |
|
|
29
|
+
| [`getDealMemory`](#op-getdealmemory) | `GET /api/v1/deals/{deal_id}/memory` | read | `meetings:read` | Get Deal Memory |
|
|
30
|
+
| [`getDealStageReadiness`](#op-getdealstagereadiness) | `GET /api/v1/deals/{deal_id}/stage-readiness` | read | `meetings:read` | Get Deal Stage Readiness |
|
|
31
|
+
| [`getMeeting`](#op-getmeeting) ★ | `GET /api/v1/inbox/meetings/{meeting_id}` | read | `meetings:read` | Get Meeting |
|
|
32
|
+
| [`getMeetingCoachingQueue`](#op-getmeetingcoachingqueue) | `GET /api/v1/meeting-transcripts/coaching-queue` | read | `meetings:read` | Get Meeting Coaching Queue |
|
|
33
|
+
| [`getMeetingReview`](#op-getmeetingreview) | `GET /api/v1/meeting-transcripts/{transcript_id}/review` | read | `meetings:read` | Get Meeting Review |
|
|
34
|
+
| [`getMeetingTranscript`](#op-getmeetingtranscript) | `GET /api/v1/meeting-transcripts/{transcript_id}` | read | `meetings:read` | Get Meeting Transcript |
|
|
35
|
+
| [`getMeetingTranscriptStats`](#op-getmeetingtranscriptstats) | `GET /api/v1/meeting-transcripts/stats` | read | `meetings:read` | Get Meeting Transcript Stats |
|
|
36
|
+
| [`linkMeetingTranscriptAccount`](#op-linkmeetingtranscriptaccount) | `PATCH /api/v1/meeting-transcripts/{transcript_id}/account` | write | `meetings:write` | Link Meeting Transcript Account |
|
|
37
|
+
| [`listMeetingTranscripts`](#op-listmeetingtranscripts) | `GET /api/v1/meeting-transcripts` | read | `meetings:read` | List Meeting Transcripts |
|
|
38
|
+
| [`listMeetings`](#op-listmeetings) ★ | `GET /api/v1/inbox/meetings` | read | `meetings:read` | List Meetings |
|
|
39
|
+
| [`meetingsBooked`](#op-meetingsbooked) | `GET /api/v1/inbox/meetings/booked` | read | `meetings:read` | Meetings Booked |
|
|
40
|
+
| [`regenerateMeetingReview`](#op-regeneratemeetingreview) | `POST /api/v1/meeting-transcripts/{transcript_id}/review/regenerate` | billable | `meetings:run` | Regenerate Meeting Review |
|
|
41
|
+
| [`suggestDealNextBestStep`](#op-suggestdealnextbeststep) | `POST /api/v1/deals/{deal_id}/next-best-step` | billable | `meetings:run` | Suggest Deal Next Best Step |
|
|
42
|
+
|
|
43
|
+
---
|
|
44
|
+
|
|
45
|
+
<a id="op-acknowledgemeetingreview"></a>
|
|
46
|
+
|
|
47
|
+
### `g8.api.meetings.acknowledgeMeetingReview(input)`
|
|
48
|
+
|
|
49
|
+
**Acknowledge Meeting Review**
|
|
50
|
+
|
|
51
|
+
- HTTP: `POST /api/v1/meeting-transcripts/{transcript_id}/review/acknowledge`
|
|
52
|
+
- operationId: `acknowledge_meeting_review_meeting_transcripts__transcript_id__review_acknowledge_post` (also callable as `g8.api.call("acknowledge_meeting_review_meeting_transcripts__transcript_id__review_acknowledge_post", input)`)
|
|
53
|
+
- Tier: `write`: creates or changes records; the SDK sends an Idempotency-Key and retries transient failures
|
|
54
|
+
- API-key scope: `meetings:write`
|
|
55
|
+
|
|
56
|
+
Mark a review acknowledged in the coaching queue. MANAGER ONLY.
|
|
57
|
+
|
|
58
|
+
**Input**
|
|
59
|
+
|
|
60
|
+
| Field | Type | Required | Description |
|
|
61
|
+
|---|---|---|---|
|
|
62
|
+
| `path.transcript_id` | `string` | yes | Transcript id. |
|
|
63
|
+
|
|
64
|
+
**Returns** `ApiResponse_CrmRecordPayload_`: the envelope `{ data: CrmRecordPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
|
|
65
|
+
|
|
66
|
+
Other envelope fields: `pagination` (PaginationMeta).
|
|
67
|
+
|
|
68
|
+
**Example**
|
|
69
|
+
|
|
70
|
+
```ts
|
|
71
|
+
const result = await g8.api.meetings.acknowledgeMeetingReview({ path: { transcript_id: "id" } });
|
|
72
|
+
```
|
|
73
|
+
|
|
74
|
+
---
|
|
75
|
+
|
|
76
|
+
<a id="op-advancedealstage"></a>
|
|
77
|
+
|
|
78
|
+
### `g8.api.meetings.advanceDealStage(input)`
|
|
79
|
+
|
|
80
|
+
**Advance Deal Stage**
|
|
81
|
+
|
|
82
|
+
- HTTP: `POST /api/v1/deals/{deal_id}/advance-stage`
|
|
83
|
+
- operationId: `advance_deal_stage_deals__deal_id__advance_stage_post` (also callable as `g8.api.call("advance_deal_stage_deals__deal_id__advance_stage_post", input)`)
|
|
84
|
+
- Tier: `write`: creates or changes records; the SDK sends an Idempotency-Key and retries transient failures
|
|
85
|
+
- API-key scope: `meetings:write`
|
|
86
|
+
|
|
87
|
+
Move the deal to its next stage when the meeting evidence says it is ready.
|
|
88
|
+
|
|
89
|
+
A real stage change: audited, and it emits the same stage-change event a
|
|
90
|
+
person moving the deal would. Refused when the readiness check fails.
|
|
91
|
+
|
|
92
|
+
**Input**
|
|
93
|
+
|
|
94
|
+
| Field | Type | Required | Description |
|
|
95
|
+
|---|---|---|---|
|
|
96
|
+
| `path.deal_id` | `string` | yes | Deal id (UUID). |
|
|
97
|
+
|
|
98
|
+
**Returns** `ApiResponse_CrmRecordPayload_`: the envelope `{ data: CrmRecordPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
|
|
99
|
+
|
|
100
|
+
Other envelope fields: `pagination` (PaginationMeta).
|
|
101
|
+
|
|
102
|
+
**Example**
|
|
103
|
+
|
|
104
|
+
```ts
|
|
105
|
+
const result = await g8.api.meetings.advanceDealStage({ path: { deal_id: "id" } });
|
|
106
|
+
```
|
|
107
|
+
|
|
108
|
+
---
|
|
109
|
+
|
|
110
|
+
<a id="op-deletemeetingtranscript"></a>
|
|
111
|
+
|
|
112
|
+
### `g8.api.meetings.deleteMeetingTranscript(input)`
|
|
113
|
+
|
|
114
|
+
**Delete Meeting Transcript**
|
|
115
|
+
|
|
116
|
+
- HTTP: `DELETE /api/v1/meeting-transcripts/{transcript_id}`
|
|
117
|
+
- operationId: `delete_meeting_transcript_meeting_transcripts__transcript_id__delete` (also callable as `g8.api.call("delete_meeting_transcript_meeting_transcripts__transcript_id__delete", input)`)
|
|
118
|
+
- Tier: `destructive`: deletes or archives data; confirm with a human before calling
|
|
119
|
+
- API-key scope: `meetings:delete`
|
|
120
|
+
|
|
121
|
+
Delete a transcript PERMANENTLY. ORG ADMIN ONLY (checked by the app handler).
|
|
122
|
+
|
|
123
|
+
**Input**
|
|
124
|
+
|
|
125
|
+
| Field | Type | Required | Description |
|
|
126
|
+
|---|---|---|---|
|
|
127
|
+
| `path.transcript_id` | `string` | yes | Transcript id. |
|
|
128
|
+
|
|
129
|
+
**Returns** `ApiResponse_CrmRecordPayload_`: the envelope `{ data: CrmRecordPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
|
|
130
|
+
|
|
131
|
+
Other envelope fields: `pagination` (PaginationMeta).
|
|
132
|
+
|
|
133
|
+
**Example**
|
|
134
|
+
|
|
135
|
+
```ts
|
|
136
|
+
// destructive: deletes or archives data; confirm with a human before calling.
|
|
137
|
+
const result = await g8.api.meetings.deleteMeetingTranscript({ path: { transcript_id: "id" } });
|
|
138
|
+
```
|
|
139
|
+
|
|
140
|
+
---
|
|
141
|
+
|
|
142
|
+
<a id="op-draftmeetingfollowup"></a>
|
|
143
|
+
|
|
144
|
+
### `g8.api.meetings.draftMeetingFollowUp(input)`
|
|
145
|
+
|
|
146
|
+
**Draft Meeting Follow Up**
|
|
147
|
+
|
|
148
|
+
- HTTP: `POST /api/v1/meeting-transcripts/{transcript_id}/follow-up-draft`
|
|
149
|
+
- operationId: `draft_meeting_follow_up_meeting_transcripts__transcript_id__follow_up_draft_post` (also callable as `g8.api.call("draft_meeting_follow_up_meeting_transcripts__transcript_id__follow_up_draft_post", input)`)
|
|
150
|
+
- Tier: `billable`: spends credits; the SDK never blindly retries it; confirm cost before bulk use
|
|
151
|
+
- API-key scope: `meetings:run`
|
|
152
|
+
|
|
153
|
+
A follow-up email draft grounded in this meeting. NOTHING IS SENT.
|
|
154
|
+
|
|
155
|
+
Returns the draft written at import time when there is one; generates on
|
|
156
|
+
demand (a model call, which spends credits) when there is none or when
|
|
157
|
+
`regenerate=true`.
|
|
158
|
+
|
|
159
|
+
**Input**
|
|
160
|
+
|
|
161
|
+
| Field | Type | Required | Description |
|
|
162
|
+
|---|---|---|---|
|
|
163
|
+
| `path.transcript_id` | `string` | yes | Transcript id. |
|
|
164
|
+
| `query.regenerate` | `boolean` | no | Write a fresh draft even when one is stored. SPENDS CREDITS. default `false` |
|
|
165
|
+
|
|
166
|
+
**Returns** `ApiResponse_CrmRecordPayload_`: the envelope `{ data: CrmRecordPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
|
|
167
|
+
|
|
168
|
+
Other envelope fields: `pagination` (PaginationMeta).
|
|
169
|
+
|
|
170
|
+
**Example**
|
|
171
|
+
|
|
172
|
+
```ts
|
|
173
|
+
// billable: spends credits; the SDK never blindly retries it; confirm cost before bulk use.
|
|
174
|
+
const result = await g8.api.meetings.draftMeetingFollowUp({ path: { transcript_id: "id" } });
|
|
175
|
+
```
|
|
176
|
+
|
|
177
|
+
---
|
|
178
|
+
|
|
179
|
+
<a id="op-getdealmemory"></a>
|
|
180
|
+
|
|
181
|
+
### `g8.api.meetings.getDealMemory(input)`
|
|
182
|
+
|
|
183
|
+
**Get Deal Memory**
|
|
184
|
+
|
|
185
|
+
- HTTP: `GET /api/v1/deals/{deal_id}/memory`
|
|
186
|
+
- operationId: `get_deal_memory_deals__deal_id__memory_get` (also callable as `g8.api.call("get_deal_memory_deals__deal_id__memory_get", input)`)
|
|
187
|
+
- Tier: `read`: reads data; safe to call and to retry
|
|
188
|
+
- API-key scope: `meetings:read`
|
|
189
|
+
|
|
190
|
+
Everything the meetings on this deal established: people, pains, commitments, risks.
|
|
191
|
+
|
|
192
|
+
**Input**
|
|
193
|
+
|
|
194
|
+
| Field | Type | Required | Description |
|
|
195
|
+
|---|---|---|---|
|
|
196
|
+
| `path.deal_id` | `string` | yes | Deal id (UUID). |
|
|
197
|
+
|
|
198
|
+
**Returns** `ApiResponse_CrmRecordPayload_`: the envelope `{ data: CrmRecordPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
|
|
199
|
+
|
|
200
|
+
Other envelope fields: `pagination` (PaginationMeta).
|
|
201
|
+
|
|
202
|
+
**Example**
|
|
203
|
+
|
|
204
|
+
```ts
|
|
205
|
+
const result = await g8.api.meetings.getDealMemory({ path: { deal_id: "id" } });
|
|
206
|
+
```
|
|
207
|
+
|
|
208
|
+
---
|
|
209
|
+
|
|
210
|
+
<a id="op-getdealstagereadiness"></a>
|
|
211
|
+
|
|
212
|
+
### `g8.api.meetings.getDealStageReadiness(input)`
|
|
213
|
+
|
|
214
|
+
**Get Deal Stage Readiness**
|
|
215
|
+
|
|
216
|
+
- HTTP: `GET /api/v1/deals/{deal_id}/stage-readiness`
|
|
217
|
+
- operationId: `get_deal_stage_readiness_deals__deal_id__stage_readiness_get` (also callable as `g8.api.call("get_deal_stage_readiness_deals__deal_id__stage_readiness_get", input)`)
|
|
218
|
+
- Tier: `read`: reads data; safe to call and to retry
|
|
219
|
+
- API-key scope: `meetings:read`
|
|
220
|
+
|
|
221
|
+
How ready this deal is for its next stage, from the evidence in its meeting reviews.
|
|
222
|
+
|
|
223
|
+
**Input**
|
|
224
|
+
|
|
225
|
+
| Field | Type | Required | Description |
|
|
226
|
+
|---|---|---|---|
|
|
227
|
+
| `path.deal_id` | `string` | yes | Deal id (UUID). |
|
|
228
|
+
|
|
229
|
+
**Returns** `ApiResponse_CrmRecordPayload_`: the envelope `{ data: CrmRecordPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
|
|
230
|
+
|
|
231
|
+
Other envelope fields: `pagination` (PaginationMeta).
|
|
232
|
+
|
|
233
|
+
**Example**
|
|
234
|
+
|
|
235
|
+
```ts
|
|
236
|
+
const result = await g8.api.meetings.getDealStageReadiness({ path: { deal_id: "id" } });
|
|
237
|
+
```
|
|
238
|
+
|
|
239
|
+
---
|
|
240
|
+
|
|
241
|
+
<a id="op-getmeeting"></a>
|
|
242
|
+
|
|
243
|
+
### `g8.api.meetings.getMeeting(input)`
|
|
244
|
+
|
|
245
|
+
**Get Meeting**
|
|
246
|
+
|
|
247
|
+
- HTTP: `GET /api/v1/inbox/meetings/{meeting_id}`
|
|
248
|
+
- operationId: `get_meeting_inbox_meetings__meeting_id__get` (also callable as `g8.api.call("get_meeting_inbox_meetings__meeting_id__get", input)`)
|
|
249
|
+
- Tier: `read`: reads data; safe to call and to retry
|
|
250
|
+
- API-key scope: `meetings:read`
|
|
251
|
+
- ★ Hand-written: [`g8.meetings.get()`](../sdk-clients.md#g8-meetings-get)
|
|
252
|
+
|
|
253
|
+
Get a single meeting by ID with full transcript bundled inline.
|
|
254
|
+
|
|
255
|
+
Transcript content is included when the caller is a participant or
|
|
256
|
+
has the `meetings:see_transcripts` permission. Otherwise the response
|
|
257
|
+
sets `transcript_redacted=true` and omits the transcript body
|
|
258
|
+
(status / IDs remain visible).
|
|
259
|
+
|
|
260
|
+
**Input**
|
|
261
|
+
|
|
262
|
+
| Field | Type | Required | Description |
|
|
263
|
+
|---|---|---|---|
|
|
264
|
+
| `path.meeting_id` | `string` | yes | Meeting ID (CalendarEvent.id) |
|
|
265
|
+
|
|
266
|
+
**Returns** `ApiResponse_MeetingDetail_`: the envelope `{ data: MeetingDetail, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
|
|
267
|
+
|
|
268
|
+
Other envelope fields: `pagination` (PaginationMeta).
|
|
269
|
+
|
|
270
|
+
`MeetingDetail` fields:
|
|
271
|
+
|
|
272
|
+
| Field | Type | Required | Description |
|
|
273
|
+
|---|---|---|---|
|
|
274
|
+
| `id` | `string` | yes | |
|
|
275
|
+
| `action_items` | `Array<Record<string, unknown>> \| null` | no | |
|
|
276
|
+
| `assignees` | `Array<Record<string, unknown>>` | no | |
|
|
277
|
+
| `attendees` | `Array<MeetingAttendee>` | no | |
|
|
278
|
+
| `audience_type` | `string \| null` | no | |
|
|
279
|
+
| `campaign_mentions` | `Array<string> \| null` | no | |
|
|
280
|
+
| `channel` | `string` | no | default `"meetings"` |
|
|
281
|
+
| `created_at` | `string \| null` | no | |
|
|
282
|
+
| `custom_fields` | `Array<Record<string, unknown>> \| null` | no | |
|
|
283
|
+
| `end_time` | `string \| null` | no | |
|
|
284
|
+
| `is_internal_only` | `boolean \| null` | no | |
|
|
285
|
+
| `key_topics` | `Array<string> \| null` | no | |
|
|
286
|
+
| `matched_account` | `Record<string, unknown> \| null` | no | |
|
|
287
|
+
| `meeting_sensitivity` | `string \| null` | no | |
|
|
288
|
+
| `meeting_tasks` | `Array<Record<string, unknown>> \| null` | no | CRM tasks created from transcript action items |
|
|
289
|
+
| `meeting_url` | `string \| null` | no | |
|
|
290
|
+
| `organizer_email` | `string \| null` | no | |
|
|
291
|
+
| `organizer_team_member` | `Record<string, unknown> \| null` | no | |
|
|
292
|
+
| `owner_team_member` | `Record<string, unknown> \| null` | no | |
|
|
293
|
+
| `participant_links` | `Array<Record<string, unknown>> \| null` | no | |
|
|
294
|
+
| `start_time` | `string \| null` | no | |
|
|
295
|
+
| `subject` | `string \| null` | no | |
|
|
296
|
+
| `tags` | `Array<Record<string, unknown>>` | no | |
|
|
297
|
+
| `transcript_id` | `string \| null` | no | |
|
|
298
|
+
| `transcript_link_source` | `string \| null` | no | |
|
|
299
|
+
| `transcript_redacted` | `boolean` | no | default `false` |
|
|
300
|
+
| `transcript_source` | `string \| null` | no | |
|
|
301
|
+
| `transcript_status` | `string \| null` | no | |
|
|
302
|
+
| `transcript_summary` | `string \| null` | no | |
|
|
303
|
+
| `transcript_text` | `string \| null` | no | Full transcript body text (omitted when redacted) |
|
|
304
|
+
| `updated_at` | `string \| null` | no | |
|
|
305
|
+
| `user_email` | `string \| null` | no | |
|
|
306
|
+
|
|
307
|
+
**Example**
|
|
308
|
+
|
|
309
|
+
```ts
|
|
310
|
+
const result = await g8.api.meetings.getMeeting({ path: { meeting_id: "id" } });
|
|
311
|
+
```
|
|
312
|
+
|
|
313
|
+
---
|
|
314
|
+
|
|
315
|
+
<a id="op-getmeetingcoachingqueue"></a>
|
|
316
|
+
|
|
317
|
+
### `g8.api.meetings.getMeetingCoachingQueue(input?)`
|
|
318
|
+
|
|
319
|
+
**Get Meeting Coaching Queue**
|
|
320
|
+
|
|
321
|
+
- HTTP: `GET /api/v1/meeting-transcripts/coaching-queue`
|
|
322
|
+
- operationId: `get_meeting_coaching_queue_meeting_transcripts_coaching_queue_get` (also callable as `g8.api.call("get_meeting_coaching_queue_meeting_transcripts_coaching_queue_get", input)`)
|
|
323
|
+
- Tier: `read`: reads data; safe to call and to retry
|
|
324
|
+
- API-key scope: `meetings:read`
|
|
325
|
+
|
|
326
|
+
Reviewed meetings flagged for a manager's attention. MANAGER ONLY.
|
|
327
|
+
|
|
328
|
+
Requires `meetings:see_all` or a privileged org role on the key's minter;
|
|
329
|
+
otherwise 403, because it surfaces every rep's scores.
|
|
330
|
+
|
|
331
|
+
**Input**
|
|
332
|
+
|
|
333
|
+
| Field | Type | Required | Description |
|
|
334
|
+
|---|---|---|---|
|
|
335
|
+
| `query.target` | `string \| null` | no | Only reviews for this pipeline target. |
|
|
336
|
+
| `query.only_unreviewed` | `boolean` | no | Only reviews no manager has acknowledged. default `false` |
|
|
337
|
+
| `query.min_score` | `integer` | no | Lowest review score to include. default `0` |
|
|
338
|
+
| `query.max_score` | `integer` | no | Highest review score to include. default `40` |
|
|
339
|
+
| `query.limit` | `integer` | no | How many reviews. default `50` |
|
|
340
|
+
|
|
341
|
+
**Returns** `ApiResponse_CrmRecordPayload_`: the envelope `{ data: CrmRecordPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
|
|
342
|
+
|
|
343
|
+
Other envelope fields: `pagination` (PaginationMeta).
|
|
344
|
+
|
|
345
|
+
**Example**
|
|
346
|
+
|
|
347
|
+
```ts
|
|
348
|
+
const result = await g8.api.meetings.getMeetingCoachingQueue();
|
|
349
|
+
```
|
|
350
|
+
|
|
351
|
+
---
|
|
352
|
+
|
|
353
|
+
<a id="op-getmeetingreview"></a>
|
|
354
|
+
|
|
355
|
+
### `g8.api.meetings.getMeetingReview(input)`
|
|
356
|
+
|
|
357
|
+
**Get Meeting Review**
|
|
358
|
+
|
|
359
|
+
- HTTP: `GET /api/v1/meeting-transcripts/{transcript_id}/review`
|
|
360
|
+
- operationId: `get_meeting_review_meeting_transcripts__transcript_id__review_get` (also callable as `g8.api.call("get_meeting_review_meeting_transcripts__transcript_id__review_get", input)`)
|
|
361
|
+
- Tier: `read`: reads data; safe to call and to retry
|
|
362
|
+
- API-key scope: `meetings:read`
|
|
363
|
+
|
|
364
|
+
The AI review of this meeting: score, stage elements hit and missed, coaching notes.
|
|
365
|
+
|
|
366
|
+
404 until the review has run. A review that ran but was skipped (orphan
|
|
367
|
+
meeting, transcript too short) returns `skipped: true` with the reason.
|
|
368
|
+
|
|
369
|
+
**Input**
|
|
370
|
+
|
|
371
|
+
| Field | Type | Required | Description |
|
|
372
|
+
|---|---|---|---|
|
|
373
|
+
| `path.transcript_id` | `string` | yes | Transcript id. |
|
|
374
|
+
|
|
375
|
+
**Returns** `ApiResponse_CrmRecordPayload_`: the envelope `{ data: CrmRecordPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
|
|
376
|
+
|
|
377
|
+
Other envelope fields: `pagination` (PaginationMeta).
|
|
378
|
+
|
|
379
|
+
**Example**
|
|
380
|
+
|
|
381
|
+
```ts
|
|
382
|
+
const result = await g8.api.meetings.getMeetingReview({ path: { transcript_id: "id" } });
|
|
383
|
+
```
|
|
384
|
+
|
|
385
|
+
---
|
|
386
|
+
|
|
387
|
+
<a id="op-getmeetingtranscript"></a>
|
|
388
|
+
|
|
389
|
+
### `g8.api.meetings.getMeetingTranscript(input)`
|
|
390
|
+
|
|
391
|
+
**Get Meeting Transcript**
|
|
392
|
+
|
|
393
|
+
- HTTP: `GET /api/v1/meeting-transcripts/{transcript_id}`
|
|
394
|
+
- operationId: `get_meeting_transcript_meeting_transcripts__transcript_id__get` (also callable as `g8.api.call("get_meeting_transcript_meeting_transcripts__transcript_id__get", input)`)
|
|
395
|
+
- Tier: `read`: reads data; safe to call and to retry
|
|
396
|
+
- API-key scope: `meetings:read`
|
|
397
|
+
|
|
398
|
+
The full transcript. 403 unless the key's minter took part or can see all meetings.
|
|
399
|
+
|
|
400
|
+
**Input**
|
|
401
|
+
|
|
402
|
+
| Field | Type | Required | Description |
|
|
403
|
+
|---|---|---|---|
|
|
404
|
+
| `path.transcript_id` | `string` | yes | Transcript id. |
|
|
405
|
+
|
|
406
|
+
**Returns** `ApiResponse_CrmRecordPayload_`: the envelope `{ data: CrmRecordPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
|
|
407
|
+
|
|
408
|
+
Other envelope fields: `pagination` (PaginationMeta).
|
|
409
|
+
|
|
410
|
+
**Example**
|
|
411
|
+
|
|
412
|
+
```ts
|
|
413
|
+
const result = await g8.api.meetings.getMeetingTranscript({ path: { transcript_id: "id" } });
|
|
414
|
+
```
|
|
415
|
+
|
|
416
|
+
---
|
|
417
|
+
|
|
418
|
+
<a id="op-getmeetingtranscriptstats"></a>
|
|
419
|
+
|
|
420
|
+
### `g8.api.meetings.getMeetingTranscriptStats(input?)`
|
|
421
|
+
|
|
422
|
+
**Get Meeting Transcript Stats**
|
|
423
|
+
|
|
424
|
+
- HTTP: `GET /api/v1/meeting-transcripts/stats`
|
|
425
|
+
- operationId: `get_meeting_transcript_stats_meeting_transcripts_stats_get` (also callable as `g8.api.call("get_meeting_transcript_stats_meeting_transcripts_stats_get", input)`)
|
|
426
|
+
- Tier: `read`: reads data; safe to call and to retry
|
|
427
|
+
- API-key scope: `meetings:read`
|
|
428
|
+
|
|
429
|
+
Org-wide counts: transcripts by type, how many are filed, recent volume.
|
|
430
|
+
|
|
431
|
+
**Input**: none.
|
|
432
|
+
|
|
433
|
+
**Returns** `ApiResponse_CrmRecordPayload_`: the envelope `{ data: CrmRecordPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
|
|
434
|
+
|
|
435
|
+
Other envelope fields: `pagination` (PaginationMeta).
|
|
436
|
+
|
|
437
|
+
**Example**
|
|
438
|
+
|
|
439
|
+
```ts
|
|
440
|
+
const result = await g8.api.meetings.getMeetingTranscriptStats();
|
|
441
|
+
```
|
|
442
|
+
|
|
443
|
+
---
|
|
444
|
+
|
|
445
|
+
<a id="op-linkmeetingtranscriptaccount"></a>
|
|
446
|
+
|
|
447
|
+
### `g8.api.meetings.linkMeetingTranscriptAccount(input)`
|
|
448
|
+
|
|
449
|
+
**Link Meeting Transcript Account**
|
|
450
|
+
|
|
451
|
+
- HTTP: `PATCH /api/v1/meeting-transcripts/{transcript_id}/account`
|
|
452
|
+
- operationId: `link_meeting_transcript_account_meeting_transcripts__transcript_id__account_patch` (also callable as `g8.api.call("link_meeting_transcript_account_meeting_transcripts__transcript_id__account_patch", input)`)
|
|
453
|
+
- Tier: `write`: creates or changes records; the SDK sends an Idempotency-Key and retries transient failures
|
|
454
|
+
- API-key scope: `meetings:write`
|
|
455
|
+
|
|
456
|
+
File this transcript under an account, overriding the automatic categoriser.
|
|
457
|
+
|
|
458
|
+
**Input**
|
|
459
|
+
|
|
460
|
+
| Field | Type | Required | Description |
|
|
461
|
+
|---|---|---|---|
|
|
462
|
+
| `path.transcript_id` | `string` | yes | Transcript id. |
|
|
463
|
+
| `body` | `LinkTranscriptAccountRequest` | yes | Request body; fields below. |
|
|
464
|
+
|
|
465
|
+
Body fields (`LinkTranscriptAccountRequest`):
|
|
466
|
+
|
|
467
|
+
| Field | Type | Required | Description |
|
|
468
|
+
|---|---|---|---|
|
|
469
|
+
| `body.account_id` | `string` | yes | Account (company) to file the transcript under. |
|
|
470
|
+
|
|
471
|
+
**Returns** `ApiResponse_CrmRecordPayload_`: the envelope `{ data: CrmRecordPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
|
|
472
|
+
|
|
473
|
+
Other envelope fields: `pagination` (PaginationMeta).
|
|
474
|
+
|
|
475
|
+
**Example**
|
|
476
|
+
|
|
477
|
+
```ts
|
|
478
|
+
const result = await g8.api.meetings.linkMeetingTranscriptAccount({ path: { transcript_id: "id" }, body: { account_id: "id" } });
|
|
479
|
+
```
|
|
480
|
+
|
|
481
|
+
---
|
|
482
|
+
|
|
483
|
+
<a id="op-listmeetingtranscripts"></a>
|
|
484
|
+
|
|
485
|
+
### `g8.api.meetings.listMeetingTranscripts(input?)`
|
|
486
|
+
|
|
487
|
+
**List Meeting Transcripts**
|
|
488
|
+
|
|
489
|
+
- HTTP: `GET /api/v1/meeting-transcripts`
|
|
490
|
+
- operationId: `list_meeting_transcripts_meeting_transcripts_get` (also callable as `g8.api.call("list_meeting_transcripts_meeting_transcripts_get", input)`)
|
|
491
|
+
- Tier: `read`: reads data; safe to call and to retry
|
|
492
|
+
- API-key scope: `meetings:read`
|
|
493
|
+
|
|
494
|
+
Transcripts the key can see, newest first, with a total for paging.
|
|
495
|
+
|
|
496
|
+
**Input**
|
|
497
|
+
|
|
498
|
+
| Field | Type | Required | Description |
|
|
499
|
+
|---|---|---|---|
|
|
500
|
+
| `query.transcript_type` | `string \| null` | no | `account`, `client` or `internal`. |
|
|
501
|
+
| `query.account_id` | `string \| null` | no | Only transcripts filed under this account. |
|
|
502
|
+
| `query.date_from` | `string (date) \| null` | no | Earliest meeting date. |
|
|
503
|
+
| `query.date_to` | `string (date) \| null` | no | Latest meeting date. |
|
|
504
|
+
| `query.search` | `string \| null` | no | Match in the title or the transcript text. |
|
|
505
|
+
| `query.limit` | `integer` | no | Page size. default `50` |
|
|
506
|
+
| `query.offset` | `integer` | no | Rows to skip. default `0` |
|
|
507
|
+
|
|
508
|
+
**Returns** `ApiResponse_CrmRecordPayload_`: the envelope `{ data: CrmRecordPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
|
|
509
|
+
|
|
510
|
+
Other envelope fields: `pagination` (PaginationMeta).
|
|
511
|
+
|
|
512
|
+
**Example**
|
|
513
|
+
|
|
514
|
+
```ts
|
|
515
|
+
const result = await g8.api.meetings.listMeetingTranscripts();
|
|
516
|
+
```
|
|
517
|
+
|
|
518
|
+
---
|
|
519
|
+
|
|
520
|
+
<a id="op-listmeetings"></a>
|
|
521
|
+
|
|
522
|
+
### `g8.api.meetings.listMeetings(input?)`
|
|
523
|
+
|
|
524
|
+
**List Meetings**
|
|
525
|
+
|
|
526
|
+
- HTTP: `GET /api/v1/inbox/meetings`
|
|
527
|
+
- operationId: `list_meetings_inbox_meetings_get` (also callable as `g8.api.call("list_meetings_inbox_meetings_get", input)`)
|
|
528
|
+
- Tier: `read`: reads data; safe to call and to retry
|
|
529
|
+
- API-key scope: `meetings:read`
|
|
530
|
+
- ★ Hand-written: [`g8.meetings.list()`](../sdk-clients.md#g8-meetings-list)
|
|
531
|
+
|
|
532
|
+
List meetings as compact summary cards.
|
|
533
|
+
|
|
534
|
+
The default visibility scope follows the caller's RBAC. Pass
|
|
535
|
+
`participant_email` to scope down to a specific contact's meetings
|
|
536
|
+
(matched across organizer + owner + attendees). Transcript content
|
|
537
|
+
is returned only as a short summary preview; call the detail
|
|
538
|
+
endpoint for full transcript text.
|
|
539
|
+
|
|
540
|
+
**Input**
|
|
541
|
+
|
|
542
|
+
| Field | Type | Required | Description |
|
|
543
|
+
|---|---|---|---|
|
|
544
|
+
| `query.participant_email` | `Array<string> \| null` | no | Filter to meetings where ANY of the provided emails appears as organizer, owner, or attendee (case-insensitive, OR-matched). Repeat the param for multiple emails. |
|
|
545
|
+
| `query.scope` | `string \| null` | no | Visibility scope: 'my' (your meetings) or 'all' (org-wide, requires meetings:see_all) |
|
|
546
|
+
| `query.timeframe` | `string \| null` | no | 'all', 'upcoming', or 'past' (default: past) |
|
|
547
|
+
| `query.has_transcript` | `boolean \| null` | no | True = transcript linked; False = no transcript |
|
|
548
|
+
| `query.internal_mode` | `string \| null` | no | Internal meeting visibility. 'include_internal' returns ALL meetings (team syncs, internal-only attendees). 'exclude_internal' drops any meeting with no external attendees. Omitting respects the org policy default (most orgs default to exclude_internal). Pass include_internal to see team/standup meetings the default would hide. |
|
|
549
|
+
| `query.search` | `string \| null` | no | Match title or transcript text |
|
|
550
|
+
| `query.page` | `integer` | no | Page number default `1` |
|
|
551
|
+
| `query.page_size` | `integer` | no | Items per page default `50` |
|
|
552
|
+
|
|
553
|
+
**Returns** `ApiResponse_list_MeetingSummary__`: the envelope `{ data: Array<MeetingSummary>, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
|
|
554
|
+
|
|
555
|
+
Other envelope fields: `pagination` (PaginationMeta).
|
|
556
|
+
|
|
557
|
+
`MeetingSummary` fields:
|
|
558
|
+
|
|
559
|
+
| Field | Type | Required | Description |
|
|
560
|
+
|---|---|---|---|
|
|
561
|
+
| `id` | `string` | yes | |
|
|
562
|
+
| `assignees` | `Array<Record<string, unknown>>` | no | |
|
|
563
|
+
| `attendees` | `Array<MeetingAttendee>` | no | |
|
|
564
|
+
| `audience_type` | `string \| null` | no | customer, prospect, internal, or unknown |
|
|
565
|
+
| `channel` | `string` | no | default `"meetings"` |
|
|
566
|
+
| `created_at` | `string \| null` | no | |
|
|
567
|
+
| `end_time` | `string \| null` | no | |
|
|
568
|
+
| `is_internal_only` | `boolean \| null` | no | |
|
|
569
|
+
| `matched_account` | `Record<string, unknown> \| null` | no | |
|
|
570
|
+
| `meeting_sensitivity` | `string \| null` | no | |
|
|
571
|
+
| `meeting_url` | `string \| null` | no | |
|
|
572
|
+
| `organizer_email` | `string \| null` | no | |
|
|
573
|
+
| `preview` | `string \| null` | no | Short conversational summary for inbox-card rendering |
|
|
574
|
+
| `start_time` | `string \| null` | no | |
|
|
575
|
+
| `subject` | `string \| null` | no | Meeting title |
|
|
576
|
+
| `tags` | `Array<Record<string, unknown>>` | no | |
|
|
577
|
+
| `transcript_id` | `string \| null` | no | |
|
|
578
|
+
| `transcript_redacted` | `boolean` | no | True when transcript content is hidden due to lack of permissions default `false` |
|
|
579
|
+
| `transcript_source` | `string \| null` | no | |
|
|
580
|
+
| `transcript_status` | `string \| null` | no | linked, missing, or no_transcript_expected |
|
|
581
|
+
| `transcript_summary` | `string \| null` | no | Short transcript summary (preview only) |
|
|
582
|
+
| `updated_at` | `string \| null` | no | |
|
|
583
|
+
| `user_email` | `string \| null` | no | Calendar owner email (the user this meeting belongs to) |
|
|
584
|
+
|
|
585
|
+
**Example**
|
|
586
|
+
|
|
587
|
+
```ts
|
|
588
|
+
const result = await g8.api.meetings.listMeetings();
|
|
589
|
+
```
|
|
590
|
+
|
|
591
|
+
---
|
|
592
|
+
|
|
593
|
+
<a id="op-meetingsbooked"></a>
|
|
594
|
+
|
|
595
|
+
### `g8.api.meetings.meetingsBooked(input?)`
|
|
596
|
+
|
|
597
|
+
**Meetings Booked**
|
|
598
|
+
|
|
599
|
+
- HTTP: `GET /api/v1/inbox/meetings/booked`
|
|
600
|
+
- operationId: `meetings_booked_inbox_meetings_booked_get` (also callable as `g8.api.call("meetings_booked_inbox_meetings_booked_get", input)`)
|
|
601
|
+
- Tier: `read`: reads data; safe to call and to retry
|
|
602
|
+
- API-key scope: `meetings:read`
|
|
603
|
+
|
|
604
|
+
Count + recent list of booked meetings (not cancelled, not deleted,
|
|
605
|
+
not private-sensitivity).
|
|
606
|
+
|
|
607
|
+
Org-scoped to the authenticated key's organization. Returns metadata
|
|
608
|
+
only (title / time / status / attendee count) — never transcript
|
|
609
|
+
content. Finer per-user / `meetings:see_all` scoping is tracked as a
|
|
610
|
+
follow-up. Registered before `/{meeting_id}` so 'booked' isn't captured
|
|
611
|
+
as an id.
|
|
612
|
+
|
|
613
|
+
**Input**
|
|
614
|
+
|
|
615
|
+
| Field | Type | Required | Description |
|
|
616
|
+
|---|---|---|---|
|
|
617
|
+
| `query.days` | `integer` | no | Lookback window in days default `30` |
|
|
618
|
+
| `query.limit` | `integer` | no | Max meetings per page default `20` |
|
|
619
|
+
| `query.page` | `integer` | no | 1-based page over the booked list default `1` |
|
|
620
|
+
| `query.upcoming_only` | `boolean` | no | Only meetings from now forward default `false` |
|
|
621
|
+
|
|
622
|
+
**Returns** `ApiResponse_MeetingsBookedResult_`: the envelope `{ data: MeetingsBookedResult, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
|
|
623
|
+
|
|
624
|
+
Other envelope fields: `pagination` (PaginationMeta).
|
|
625
|
+
|
|
626
|
+
`MeetingsBookedResult` fields:
|
|
627
|
+
|
|
628
|
+
| Field | Type | Required | Description |
|
|
629
|
+
|---|---|---|---|
|
|
630
|
+
| `days` | `integer` | yes | |
|
|
631
|
+
| `count` | `integer` | no | Total booked meetings in the window default `0` |
|
|
632
|
+
| `has_next` | `boolean` | no | Whether another page exists default `false` |
|
|
633
|
+
| `meetings` | `Array<BookedMeeting>` | no | |
|
|
634
|
+
| `page` | `integer` | no | 1-based page of the booked list default `1` |
|
|
635
|
+
| `upcoming_only` | `boolean` | no | default `false` |
|
|
636
|
+
|
|
637
|
+
**Example**
|
|
638
|
+
|
|
639
|
+
```ts
|
|
640
|
+
const result = await g8.api.meetings.meetingsBooked();
|
|
641
|
+
```
|
|
642
|
+
|
|
643
|
+
---
|
|
644
|
+
|
|
645
|
+
<a id="op-regeneratemeetingreview"></a>
|
|
646
|
+
|
|
647
|
+
### `g8.api.meetings.regenerateMeetingReview(input)`
|
|
648
|
+
|
|
649
|
+
**Regenerate Meeting Review**
|
|
650
|
+
|
|
651
|
+
- HTTP: `POST /api/v1/meeting-transcripts/{transcript_id}/review/regenerate`
|
|
652
|
+
- operationId: `regenerate_meeting_review_meeting_transcripts__transcript_id__review_regenerate_post` (also callable as `g8.api.call("regenerate_meeting_review_meeting_transcripts__transcript_id__review_regenerate_post", input)`)
|
|
653
|
+
- Tier: `billable`: spends credits; the SDK never blindly retries it; confirm cost before bulk use
|
|
654
|
+
- API-key scope: `meetings:run`
|
|
655
|
+
|
|
656
|
+
Run the meeting review again. SPENDS CREDITS on every call.
|
|
657
|
+
|
|
658
|
+
For a review that failed, or after the transcript was re-linked to the
|
|
659
|
+
right deal.
|
|
660
|
+
|
|
661
|
+
**Input**
|
|
662
|
+
|
|
663
|
+
| Field | Type | Required | Description |
|
|
664
|
+
|---|---|---|---|
|
|
665
|
+
| `path.transcript_id` | `string` | yes | Transcript id. |
|
|
666
|
+
|
|
667
|
+
**Returns** `ApiResponse_CrmRecordPayload_`: the envelope `{ data: CrmRecordPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
|
|
668
|
+
|
|
669
|
+
Other envelope fields: `pagination` (PaginationMeta).
|
|
670
|
+
|
|
671
|
+
**Example**
|
|
672
|
+
|
|
673
|
+
```ts
|
|
674
|
+
// billable: spends credits; the SDK never blindly retries it; confirm cost before bulk use.
|
|
675
|
+
const result = await g8.api.meetings.regenerateMeetingReview({ path: { transcript_id: "id" } });
|
|
676
|
+
```
|
|
677
|
+
|
|
678
|
+
---
|
|
679
|
+
|
|
680
|
+
<a id="op-suggestdealnextbeststep"></a>
|
|
681
|
+
|
|
682
|
+
### `g8.api.meetings.suggestDealNextBestStep(input)`
|
|
683
|
+
|
|
684
|
+
**Suggest Deal Next Best Step**
|
|
685
|
+
|
|
686
|
+
- HTTP: `POST /api/v1/deals/{deal_id}/next-best-step`
|
|
687
|
+
- operationId: `suggest_deal_next_best_step_deals__deal_id__next_best_step_post` (also callable as `g8.api.call("suggest_deal_next_best_step_deals__deal_id__next_best_step_post", input)`)
|
|
688
|
+
- Tier: `billable`: spends credits; the SDK never blindly retries it; confirm cost before bulk use
|
|
689
|
+
- API-key scope: `meetings:run`
|
|
690
|
+
|
|
691
|
+
One recommended next action for this deal. SPENDS CREDITS. Writes nothing.
|
|
692
|
+
|
|
693
|
+
POST because every call is a fresh model call. Gated on READ access to
|
|
694
|
+
the deal, as in the app: recommending is not editing. 502 when the model
|
|
695
|
+
call fails.
|
|
696
|
+
|
|
697
|
+
**Input**
|
|
698
|
+
|
|
699
|
+
| Field | Type | Required | Description |
|
|
700
|
+
|---|---|---|---|
|
|
701
|
+
| `path.deal_id` | `string` | yes | Deal id (UUID). |
|
|
702
|
+
|
|
703
|
+
**Returns** `ApiResponse_CrmRecordPayload_`: the envelope `{ data: CrmRecordPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
|
|
704
|
+
|
|
705
|
+
Other envelope fields: `pagination` (PaginationMeta).
|
|
706
|
+
|
|
707
|
+
**Example**
|
|
708
|
+
|
|
709
|
+
```ts
|
|
710
|
+
// billable: spends credits; the SDK never blindly retries it; confirm cost before bulk use.
|
|
711
|
+
const result = await g8.api.meetings.suggestDealNextBestStep({ path: { deal_id: "id" } });
|
|
712
|
+
```
|
|
713
|
+
|
|
714
|
+
---
|
|
715
|
+
|
|
716
|
+
## Referenced types
|
|
717
|
+
|
|
718
|
+
Named types that appear in the tables above. Full TypeScript definitions: `G8Contract.<Name>` (`import type { G8Contract } from "@graph8/sdk"`).
|
|
719
|
+
|
|
720
|
+
<a id="type-bookedmeeting"></a>
|
|
721
|
+
|
|
722
|
+
### `BookedMeeting`
|
|
723
|
+
|
|
724
|
+
One booked calendar meeting (non-cancelled, non-private).
|
|
725
|
+
|
|
726
|
+
| Field | Type | Required | Description |
|
|
727
|
+
|---|---|---|---|
|
|
728
|
+
| `id` | `integer` | yes | |
|
|
729
|
+
| `attendees` | `integer` | no | Attendee count default `0` |
|
|
730
|
+
| `end_time` | `string \| null` | no | |
|
|
731
|
+
| `organizer` | `string \| null` | no | |
|
|
732
|
+
| `start_time` | `string \| null` | no | |
|
|
733
|
+
| `status` | `string \| null` | no | |
|
|
734
|
+
| `title` | `string \| null` | no | |
|
|
735
|
+
|
|
736
|
+
<a id="type-meetingattendee"></a>
|
|
737
|
+
|
|
738
|
+
### `MeetingAttendee`
|
|
739
|
+
|
|
740
|
+
Lightweight attendee record on a meeting.
|
|
741
|
+
|
|
742
|
+
| Field | Type | Required | Description |
|
|
743
|
+
|---|---|---|---|
|
|
744
|
+
| `email` | `string \| null` | no | |
|
|
745
|
+
| `name` | `string \| null` | no | |
|
|
746
|
+
| `organizer` | `boolean \| null` | no | True when this attendee is the meeting organizer |
|
|
747
|
+
| `response_status` | `string \| null` | no | Provider-reported RSVP: accepted, declined, tentative, needsAction |
|