@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,1187 @@
|
|
|
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.gtmContext` (GTM Context): 51 operations.
|
|
5
|
+
*
|
|
6
|
+
* For reading. In code, import from the package instead:
|
|
7
|
+
* import type { ApiInput, ApiOutput, G8Contract } from "@graph8/sdk";
|
|
8
|
+
* type In = ApiInput<"approve_company_profile_company_profile_approve_post">;
|
|
9
|
+
*
|
|
10
|
+
* Reference with examples: gtmContext.md
|
|
11
|
+
*/
|
|
12
|
+
/* eslint-disable */
|
|
13
|
+
|
|
14
|
+
/** `g8.api.gtmContext.<member>` -> the operationId it calls. */
|
|
15
|
+
export interface GtmContextMembers {
|
|
16
|
+
approveCompanyProfile: "approve_company_profile_company_profile_approve_post";
|
|
17
|
+
approveCompanyProfileKeywords: "approve_company_profile_keywords_company_profile_keywords_approve_post";
|
|
18
|
+
archiveIcp: "archive_icp_icps__icp_id__archive_post";
|
|
19
|
+
archivePersona: "archive_persona_personas__persona_id__archive_post";
|
|
20
|
+
createIcp: "create_icp_icps_post";
|
|
21
|
+
createPersona: "create_persona_personas_post";
|
|
22
|
+
deleteAllDocuments: "delete_all_documents_global_context_documents_delete";
|
|
23
|
+
deleteDocument: "delete_document_global_context_documents__doc_type__delete";
|
|
24
|
+
extractCompanyData: "extract_company_data_global_context_extract_company_data_post";
|
|
25
|
+
generateAllDocuments: "generate_all_documents_global_context_generate_all_post";
|
|
26
|
+
generateCompanyProfile: "generate_company_profile_company_profile_generate_post";
|
|
27
|
+
getBuyingJourneyCrmStatus: "get_buying_journey_crm_status_global_context_documents_buying_journey_crm_status_get";
|
|
28
|
+
getCompanyProfile: "get_company_profile_company_profile_get";
|
|
29
|
+
getCompanyProfileWorkflowStatus: "get_company_profile_workflow_status_company_profile_workflow_status_get";
|
|
30
|
+
getDocHighlights: "get_doc_highlights_global_context_doc__doc_type__highlights_get";
|
|
31
|
+
getDocumentsAnalytics: "get_documents_analytics_global_context_documents_analytics_get";
|
|
32
|
+
getGlobalContextDocument: "get_global_context_document_global_context_documents__doc_id__get";
|
|
33
|
+
getLatestPipeline: "get_latest_pipeline_global_context_pipeline_latest_get";
|
|
34
|
+
getMailboxWarmupAnalytics: "get_mailbox_warmup_analytics_mailboxes__mailbox_id__warmup_get";
|
|
35
|
+
getPipelineStatus: "get_pipeline_status_global_context_pipeline__pipeline_id__get";
|
|
36
|
+
listActivities: "list_activities_activities_get";
|
|
37
|
+
listGlobalContextDocuments: "list_global_context_documents_global_context_documents_get";
|
|
38
|
+
listIcps: "list_icps_icps_get";
|
|
39
|
+
listIntelligenceData: "list_intelligence_data_intelligence_data_get";
|
|
40
|
+
listMailboxes: "list_mailboxes_mailboxes_get";
|
|
41
|
+
listPersonas: "list_personas_personas_get";
|
|
42
|
+
listPipelines: "list_pipelines_global_context_pipelines_get";
|
|
43
|
+
listResearchReports: "list_research_reports_research_reports_get";
|
|
44
|
+
regenerateGlobalContext: "regenerate_global_context_global_context_regenerate_post";
|
|
45
|
+
regenerateOneDocument: "regenerate_one_document_global_context__doc_id__regenerate_post";
|
|
46
|
+
reindexAllDocuments: "reindex_all_documents_global_context_reindex_all_post";
|
|
47
|
+
reindexCompanyProfile: "reindex_company_profile_company_profile_reindex_post";
|
|
48
|
+
resetCompanyProfileKeywords: "reset_company_profile_keywords_company_profile_keywords_delete";
|
|
49
|
+
resetStuckDocuments: "reset_stuck_documents_global_context_reset_stuck_documents_post";
|
|
50
|
+
resumePipeline: "resume_pipeline_global_context_resume_pipeline_post";
|
|
51
|
+
retryCompanyProfile: "retry_company_profile_company_profile_retry_post";
|
|
52
|
+
saveBuyingJourneyInterview: "save_buying_journey_interview_global_context_documents_buying_journey_interview_post";
|
|
53
|
+
scaffoldAllDocuments: "scaffold_all_documents_global_context_scaffold_post";
|
|
54
|
+
scaffoldCompanyKeywords: "scaffold_company_keywords_global_context_scaffold_company_keywords_post";
|
|
55
|
+
scaffoldCompanyProfile: "scaffold_company_profile_global_context_scaffold_company_profile_post";
|
|
56
|
+
stopAllGeneration: "stop_all_generation_global_context_stop_all_generation_post";
|
|
57
|
+
submitDocumentFeedback: "submit_document_feedback_global_context_documents__doc_id__feedback_post";
|
|
58
|
+
trackDocumentUsage: "track_document_usage_global_context_documents__doc_id__track_usage_post";
|
|
59
|
+
unapproveCompanyProfile: "unapprove_company_profile_company_profile_unapprove_post";
|
|
60
|
+
updateCompanyProfile: "update_company_profile_company_profile_put";
|
|
61
|
+
updateGlobalContextDocument: "update_global_context_document_global_context_documents__doc_id__patch";
|
|
62
|
+
updateIcp: "update_icp_icps__icp_id__patch";
|
|
63
|
+
updatePersona: "update_persona_personas__persona_id__patch";
|
|
64
|
+
updateResearchReport: "update_research_report_research_reports__report_id__patch";
|
|
65
|
+
uploadCompanyProfileLogo: "upload_company_profile_logo_company_profile_logo_post";
|
|
66
|
+
uploadEnablementAsset: "upload_enablement_asset_enablement_assets_post";
|
|
67
|
+
}
|
|
68
|
+
|
|
69
|
+
/** Input and output of every `g8.api.gtmContext` operation, keyed by operationId. */
|
|
70
|
+
export interface GtmContextOperations {
|
|
71
|
+
/**
|
|
72
|
+
* POST /company-profile/approve
|
|
73
|
+
* Approve Company Profile
|
|
74
|
+
* tier: write · scope: campaigns:write
|
|
75
|
+
*/
|
|
76
|
+
approve_company_profile_company_profile_approve_post: {
|
|
77
|
+
input: {
|
|
78
|
+
headers?: {
|
|
79
|
+
"X-Target-Org-Id"?: string | null;
|
|
80
|
+
};
|
|
81
|
+
body: ProfileWebsiteRequest;
|
|
82
|
+
};
|
|
83
|
+
output: ApiResponse_CrmRecordPayload_;
|
|
84
|
+
};
|
|
85
|
+
/**
|
|
86
|
+
* POST /company-profile/keywords/approve
|
|
87
|
+
* Approve Company Profile Keywords
|
|
88
|
+
* tier: write · scope: campaigns:write
|
|
89
|
+
*/
|
|
90
|
+
approve_company_profile_keywords_company_profile_keywords_approve_post: {
|
|
91
|
+
input: {
|
|
92
|
+
headers?: {
|
|
93
|
+
"X-Target-Org-Id"?: string | null;
|
|
94
|
+
};
|
|
95
|
+
body: ProfileWebsiteRequest;
|
|
96
|
+
};
|
|
97
|
+
output: ApiResponse_CrmRecordPayload_;
|
|
98
|
+
};
|
|
99
|
+
/**
|
|
100
|
+
* POST /icps/{icp_id}/archive
|
|
101
|
+
* Archive Icp
|
|
102
|
+
* tier: destructive · scope: campaigns:delete
|
|
103
|
+
*/
|
|
104
|
+
archive_icp_icps__icp_id__archive_post: {
|
|
105
|
+
input: {
|
|
106
|
+
path: {
|
|
107
|
+
/** ICP ID (UUID) */
|
|
108
|
+
icp_id: string;
|
|
109
|
+
};
|
|
110
|
+
headers?: {
|
|
111
|
+
"X-Target-Org-Id"?: string | null;
|
|
112
|
+
};
|
|
113
|
+
};
|
|
114
|
+
output: ApiResponse_dict_;
|
|
115
|
+
};
|
|
116
|
+
/**
|
|
117
|
+
* POST /personas/{persona_id}/archive
|
|
118
|
+
* Archive Persona
|
|
119
|
+
* tier: destructive · scope: campaigns:delete
|
|
120
|
+
*/
|
|
121
|
+
archive_persona_personas__persona_id__archive_post: {
|
|
122
|
+
input: {
|
|
123
|
+
path: {
|
|
124
|
+
/** Persona ID (UUID) */
|
|
125
|
+
persona_id: string;
|
|
126
|
+
};
|
|
127
|
+
headers?: {
|
|
128
|
+
"X-Target-Org-Id"?: string | null;
|
|
129
|
+
};
|
|
130
|
+
};
|
|
131
|
+
output: ApiResponse_dict_;
|
|
132
|
+
};
|
|
133
|
+
/**
|
|
134
|
+
* POST /icps
|
|
135
|
+
* Create Icp
|
|
136
|
+
* tier: write · scope: campaigns:write
|
|
137
|
+
*/
|
|
138
|
+
create_icp_icps_post: {
|
|
139
|
+
input: {
|
|
140
|
+
headers?: {
|
|
141
|
+
"X-Target-Org-Id"?: string | null;
|
|
142
|
+
};
|
|
143
|
+
body: CreateIcpRequest;
|
|
144
|
+
};
|
|
145
|
+
output: ApiResponse_dict_;
|
|
146
|
+
};
|
|
147
|
+
/**
|
|
148
|
+
* POST /personas
|
|
149
|
+
* Create Persona
|
|
150
|
+
* tier: write · scope: campaigns:write
|
|
151
|
+
*/
|
|
152
|
+
create_persona_personas_post: {
|
|
153
|
+
input: {
|
|
154
|
+
headers?: {
|
|
155
|
+
"X-Target-Org-Id"?: string | null;
|
|
156
|
+
};
|
|
157
|
+
body: CreatePersonaRequest;
|
|
158
|
+
};
|
|
159
|
+
output: ApiResponse_dict_;
|
|
160
|
+
};
|
|
161
|
+
/**
|
|
162
|
+
* DELETE /global-context/documents
|
|
163
|
+
* Delete All Documents
|
|
164
|
+
* tier: destructive · scope: campaigns:delete
|
|
165
|
+
*/
|
|
166
|
+
delete_all_documents_global_context_documents_delete: {
|
|
167
|
+
input: {
|
|
168
|
+
headers?: {
|
|
169
|
+
"X-Target-Org-Id"?: string | null;
|
|
170
|
+
};
|
|
171
|
+
};
|
|
172
|
+
output: ApiResponse_StudioPayload_;
|
|
173
|
+
};
|
|
174
|
+
/**
|
|
175
|
+
* DELETE /global-context/documents/{doc_type}
|
|
176
|
+
* Delete Document
|
|
177
|
+
* tier: destructive · scope: campaigns:delete
|
|
178
|
+
*/
|
|
179
|
+
delete_document_global_context_documents__doc_type__delete: {
|
|
180
|
+
input: {
|
|
181
|
+
path: {
|
|
182
|
+
/** Document type key, e.g. `company_profile`, `icp_research`, `buying_journey`. Free-form on purpose: the set grows with the product and a closed list here would 422 a document the org already has. */
|
|
183
|
+
doc_type: string;
|
|
184
|
+
};
|
|
185
|
+
headers?: {
|
|
186
|
+
"X-Target-Org-Id"?: string | null;
|
|
187
|
+
};
|
|
188
|
+
};
|
|
189
|
+
output: ApiResponse_StudioPayload_;
|
|
190
|
+
};
|
|
191
|
+
/**
|
|
192
|
+
* POST /global-context/extract-company-data
|
|
193
|
+
* Extract Company Data
|
|
194
|
+
* tier: write · scope: campaigns:write
|
|
195
|
+
*/
|
|
196
|
+
extract_company_data_global_context_extract_company_data_post: {
|
|
197
|
+
input: {
|
|
198
|
+
headers?: {
|
|
199
|
+
"X-Target-Org-Id"?: string | null;
|
|
200
|
+
};
|
|
201
|
+
body: ExtractCompanyDataRequest;
|
|
202
|
+
};
|
|
203
|
+
output: ApiResponse_StudioPayload_;
|
|
204
|
+
};
|
|
205
|
+
/**
|
|
206
|
+
* POST /global-context/generate-all
|
|
207
|
+
* Generate All Documents
|
|
208
|
+
* tier: billable · scope: campaigns:run
|
|
209
|
+
*/
|
|
210
|
+
generate_all_documents_global_context_generate_all_post: {
|
|
211
|
+
input: {
|
|
212
|
+
headers?: {
|
|
213
|
+
"X-Target-Org-Id"?: string | null;
|
|
214
|
+
};
|
|
215
|
+
body: GenerateAllDocumentsRequest;
|
|
216
|
+
};
|
|
217
|
+
output: ApiResponse_StudioPayload_;
|
|
218
|
+
};
|
|
219
|
+
/**
|
|
220
|
+
* POST /company-profile/generate
|
|
221
|
+
* Generate Company Profile
|
|
222
|
+
* tier: billable · scope: campaigns:run
|
|
223
|
+
*/
|
|
224
|
+
generate_company_profile_company_profile_generate_post: {
|
|
225
|
+
input: {
|
|
226
|
+
headers?: {
|
|
227
|
+
"X-Target-Org-Id"?: string | null;
|
|
228
|
+
};
|
|
229
|
+
body: ProfileFieldsRequest;
|
|
230
|
+
};
|
|
231
|
+
output: ApiResponse_CrmRecordPayload_;
|
|
232
|
+
};
|
|
233
|
+
/**
|
|
234
|
+
* GET /global-context/documents/buying-journey/crm-status
|
|
235
|
+
* Get Buying Journey Crm Status
|
|
236
|
+
* tier: read · scope: campaigns:read
|
|
237
|
+
*/
|
|
238
|
+
get_buying_journey_crm_status_global_context_documents_buying_journey_crm_status_get: {
|
|
239
|
+
input: {
|
|
240
|
+
headers?: {
|
|
241
|
+
"X-Target-Org-Id"?: string | null;
|
|
242
|
+
};
|
|
243
|
+
};
|
|
244
|
+
output: ApiResponse_StudioPayload_;
|
|
245
|
+
};
|
|
246
|
+
/**
|
|
247
|
+
* GET /company-profile
|
|
248
|
+
* Get Company Profile
|
|
249
|
+
* tier: read · scope: campaigns:read
|
|
250
|
+
*/
|
|
251
|
+
get_company_profile_company_profile_get: {
|
|
252
|
+
input: {
|
|
253
|
+
headers?: {
|
|
254
|
+
"X-Target-Org-Id"?: string | null;
|
|
255
|
+
};
|
|
256
|
+
};
|
|
257
|
+
output: ApiResponse_dict_;
|
|
258
|
+
};
|
|
259
|
+
/**
|
|
260
|
+
* GET /company-profile/workflow-status
|
|
261
|
+
* Get Company Profile Workflow Status
|
|
262
|
+
* tier: read · scope: campaigns:read
|
|
263
|
+
*/
|
|
264
|
+
get_company_profile_workflow_status_company_profile_workflow_status_get: {
|
|
265
|
+
input: {
|
|
266
|
+
query: {
|
|
267
|
+
/** The website the profile was built from. */
|
|
268
|
+
website_url: string;
|
|
269
|
+
};
|
|
270
|
+
headers?: {
|
|
271
|
+
"X-Target-Org-Id"?: string | null;
|
|
272
|
+
};
|
|
273
|
+
};
|
|
274
|
+
output: ApiResponse_CrmRecordPayload_;
|
|
275
|
+
};
|
|
276
|
+
/**
|
|
277
|
+
* GET /global-context/doc/{doc_type}/highlights
|
|
278
|
+
* Get Doc Highlights
|
|
279
|
+
* tier: read · scope: campaigns:read
|
|
280
|
+
*/
|
|
281
|
+
get_doc_highlights_global_context_doc__doc_type__highlights_get: {
|
|
282
|
+
input: {
|
|
283
|
+
path: {
|
|
284
|
+
/** Document type key, e.g. `company_profile`, `icp_research`, `buying_journey`. Free-form on purpose: the set grows with the product and a closed list here would 422 a document the org already has. */
|
|
285
|
+
doc_type: string;
|
|
286
|
+
};
|
|
287
|
+
headers?: {
|
|
288
|
+
"X-Target-Org-Id"?: string | null;
|
|
289
|
+
};
|
|
290
|
+
};
|
|
291
|
+
output: ApiResponse_StudioPayload_;
|
|
292
|
+
};
|
|
293
|
+
/**
|
|
294
|
+
* GET /global-context/documents/analytics
|
|
295
|
+
* Get Documents Analytics
|
|
296
|
+
* tier: read · scope: campaigns:read
|
|
297
|
+
*/
|
|
298
|
+
get_documents_analytics_global_context_documents_analytics_get: {
|
|
299
|
+
input: {
|
|
300
|
+
headers?: {
|
|
301
|
+
"X-Target-Org-Id"?: string | null;
|
|
302
|
+
};
|
|
303
|
+
};
|
|
304
|
+
output: ApiResponse_StudioListPayload_;
|
|
305
|
+
};
|
|
306
|
+
/**
|
|
307
|
+
* GET /global-context/documents/{doc_id}
|
|
308
|
+
* Get Global Context Document
|
|
309
|
+
* tier: read · scope: campaigns:read
|
|
310
|
+
*/
|
|
311
|
+
get_global_context_document_global_context_documents__doc_id__get: {
|
|
312
|
+
input: {
|
|
313
|
+
path: {
|
|
314
|
+
/** Document id, OR a document TYPE key. The app resolves either, which is what makes `company_profile` a usable id. */
|
|
315
|
+
doc_id: string;
|
|
316
|
+
};
|
|
317
|
+
headers?: {
|
|
318
|
+
"X-Target-Org-Id"?: string | null;
|
|
319
|
+
};
|
|
320
|
+
};
|
|
321
|
+
output: ApiResponse_StudioPayload_;
|
|
322
|
+
};
|
|
323
|
+
/**
|
|
324
|
+
* GET /global-context/pipeline/latest
|
|
325
|
+
* Get Latest Pipeline
|
|
326
|
+
* tier: read · scope: campaigns:read
|
|
327
|
+
*/
|
|
328
|
+
get_latest_pipeline_global_context_pipeline_latest_get: {
|
|
329
|
+
input: {
|
|
330
|
+
headers?: {
|
|
331
|
+
"X-Target-Org-Id"?: string | null;
|
|
332
|
+
};
|
|
333
|
+
};
|
|
334
|
+
output: ApiResponse_StudioPayload_;
|
|
335
|
+
};
|
|
336
|
+
/**
|
|
337
|
+
* GET /mailboxes/{mailbox_id}/warmup
|
|
338
|
+
* Get Mailbox Warmup Analytics
|
|
339
|
+
* tier: read · scope: campaigns:read
|
|
340
|
+
*/
|
|
341
|
+
get_mailbox_warmup_analytics_mailboxes__mailbox_id__warmup_get: {
|
|
342
|
+
input: {
|
|
343
|
+
path: {
|
|
344
|
+
mailbox_id: number;
|
|
345
|
+
};
|
|
346
|
+
headers?: {
|
|
347
|
+
"X-Target-Org-Id"?: string | null;
|
|
348
|
+
};
|
|
349
|
+
};
|
|
350
|
+
output: ApiResponse_dict_;
|
|
351
|
+
};
|
|
352
|
+
/**
|
|
353
|
+
* GET /global-context/pipeline/{pipeline_id}
|
|
354
|
+
* Get Pipeline Status
|
|
355
|
+
* tier: read · scope: campaigns:read
|
|
356
|
+
*/
|
|
357
|
+
get_pipeline_status_global_context_pipeline__pipeline_id__get: {
|
|
358
|
+
input: {
|
|
359
|
+
path: {
|
|
360
|
+
/** Pipeline id. */
|
|
361
|
+
pipeline_id: string;
|
|
362
|
+
};
|
|
363
|
+
headers?: {
|
|
364
|
+
"X-Target-Org-Id"?: string | null;
|
|
365
|
+
};
|
|
366
|
+
};
|
|
367
|
+
output: ApiResponse_StudioPayload_;
|
|
368
|
+
};
|
|
369
|
+
/**
|
|
370
|
+
* GET /activities
|
|
371
|
+
* List Activities
|
|
372
|
+
* tier: read · scope: campaigns:read
|
|
373
|
+
*/
|
|
374
|
+
list_activities_activities_get: {
|
|
375
|
+
input: {
|
|
376
|
+
query?: {
|
|
377
|
+
page?: number;
|
|
378
|
+
limit?: number;
|
|
379
|
+
activity_type?: string | null;
|
|
380
|
+
contact_id?: string | null;
|
|
381
|
+
company_id?: string | null;
|
|
382
|
+
mashup_contact_id?: number | null;
|
|
383
|
+
mashup_company_id?: number | null;
|
|
384
|
+
deal_id?: string | null;
|
|
385
|
+
occurred_after?: string | null;
|
|
386
|
+
occurred_before?: string | null;
|
|
387
|
+
};
|
|
388
|
+
headers?: {
|
|
389
|
+
"X-Target-Org-Id"?: string | null;
|
|
390
|
+
};
|
|
391
|
+
};
|
|
392
|
+
output: ApiResponse_list_dict__;
|
|
393
|
+
};
|
|
394
|
+
/**
|
|
395
|
+
* GET /global-context/documents
|
|
396
|
+
* List Global Context Documents
|
|
397
|
+
* tier: read · scope: campaigns:read
|
|
398
|
+
*/
|
|
399
|
+
list_global_context_documents_global_context_documents_get: {
|
|
400
|
+
input: {
|
|
401
|
+
query?: {
|
|
402
|
+
/** Filter by context category */
|
|
403
|
+
category?: string | null;
|
|
404
|
+
/** Include each document's body text at `content` (read from meta_data.content). Default True preserves historical behavior (this endpoint has always returned content); pass false for a lighter metadata-only listing. */
|
|
405
|
+
include_content?: boolean;
|
|
406
|
+
limit?: number;
|
|
407
|
+
};
|
|
408
|
+
headers?: {
|
|
409
|
+
"X-Target-Org-Id"?: string | null;
|
|
410
|
+
};
|
|
411
|
+
};
|
|
412
|
+
output: ApiResponse_list_dict__;
|
|
413
|
+
};
|
|
414
|
+
/**
|
|
415
|
+
* GET /icps
|
|
416
|
+
* List Icps
|
|
417
|
+
* tier: read · scope: campaigns:read
|
|
418
|
+
*/
|
|
419
|
+
list_icps_icps_get: {
|
|
420
|
+
input: {
|
|
421
|
+
query?: {
|
|
422
|
+
/** Filter by ICP status */
|
|
423
|
+
status?: string | null;
|
|
424
|
+
limit?: number;
|
|
425
|
+
};
|
|
426
|
+
headers?: {
|
|
427
|
+
"X-Target-Org-Id"?: string | null;
|
|
428
|
+
};
|
|
429
|
+
};
|
|
430
|
+
output: ApiResponse_list_dict__;
|
|
431
|
+
};
|
|
432
|
+
/**
|
|
433
|
+
* GET /intelligence-data
|
|
434
|
+
* List Intelligence Data
|
|
435
|
+
* tier: read · scope: campaigns:read
|
|
436
|
+
*/
|
|
437
|
+
list_intelligence_data_intelligence_data_get: {
|
|
438
|
+
input: {
|
|
439
|
+
query?: {
|
|
440
|
+
/** Filter by data_type (website_scrape, company_enrichment, competitor_discovery, company_keywords, product_inventory, organic_keywords, paid_keywords, ...) */
|
|
441
|
+
data_type?: string | null;
|
|
442
|
+
/** Include the raw `data` JSONB blob (large; default omits) */
|
|
443
|
+
include_content?: boolean;
|
|
444
|
+
limit?: number;
|
|
445
|
+
};
|
|
446
|
+
headers?: {
|
|
447
|
+
"X-Target-Org-Id"?: string | null;
|
|
448
|
+
};
|
|
449
|
+
};
|
|
450
|
+
output: ApiResponse_list_dict__;
|
|
451
|
+
};
|
|
452
|
+
/**
|
|
453
|
+
* GET /mailboxes
|
|
454
|
+
* List Mailboxes
|
|
455
|
+
* tier: read · scope: campaigns:read
|
|
456
|
+
*/
|
|
457
|
+
list_mailboxes_mailboxes_get: {
|
|
458
|
+
input: {
|
|
459
|
+
query?: {
|
|
460
|
+
limit?: number;
|
|
461
|
+
/** Include archived mailboxes */
|
|
462
|
+
include_archived?: boolean;
|
|
463
|
+
/** Filter by connection_status (active|paused|disconnected|expired|...) */
|
|
464
|
+
connection_status?: string | null;
|
|
465
|
+
};
|
|
466
|
+
headers?: {
|
|
467
|
+
"X-Target-Org-Id"?: string | null;
|
|
468
|
+
};
|
|
469
|
+
};
|
|
470
|
+
output: ApiResponse_list_dict__;
|
|
471
|
+
};
|
|
472
|
+
/**
|
|
473
|
+
* GET /personas
|
|
474
|
+
* List Personas
|
|
475
|
+
* tier: read · scope: campaigns:read
|
|
476
|
+
*/
|
|
477
|
+
list_personas_personas_get: {
|
|
478
|
+
input: {
|
|
479
|
+
query?: {
|
|
480
|
+
/** Filter by persona status */
|
|
481
|
+
status?: string | null;
|
|
482
|
+
limit?: number;
|
|
483
|
+
};
|
|
484
|
+
headers?: {
|
|
485
|
+
"X-Target-Org-Id"?: string | null;
|
|
486
|
+
};
|
|
487
|
+
};
|
|
488
|
+
output: ApiResponse_list_dict__;
|
|
489
|
+
};
|
|
490
|
+
/**
|
|
491
|
+
* GET /global-context/pipelines
|
|
492
|
+
* List Pipelines
|
|
493
|
+
* tier: read · scope: campaigns:read
|
|
494
|
+
*/
|
|
495
|
+
list_pipelines_global_context_pipelines_get: {
|
|
496
|
+
input: {
|
|
497
|
+
query?: {
|
|
498
|
+
/** How many recent runs to return. The app's default is 10. */
|
|
499
|
+
limit?: number;
|
|
500
|
+
};
|
|
501
|
+
headers?: {
|
|
502
|
+
"X-Target-Org-Id"?: string | null;
|
|
503
|
+
};
|
|
504
|
+
};
|
|
505
|
+
output: ApiResponse_StudioListPayload_;
|
|
506
|
+
};
|
|
507
|
+
/**
|
|
508
|
+
* GET /research-reports
|
|
509
|
+
* List Research Reports
|
|
510
|
+
* tier: read · scope: campaigns:read
|
|
511
|
+
*/
|
|
512
|
+
list_research_reports_research_reports_get: {
|
|
513
|
+
input: {
|
|
514
|
+
query?: {
|
|
515
|
+
/** Filter by report_type (buyer_psychology, competitive_teardown, gtm_channel, industry_analyst, review_sentiment, voice_of_customer) */
|
|
516
|
+
report_type?: string | null;
|
|
517
|
+
/** Include the structured `content` JSONB blob + markdown (large) */
|
|
518
|
+
include_content?: boolean;
|
|
519
|
+
limit?: number;
|
|
520
|
+
};
|
|
521
|
+
headers?: {
|
|
522
|
+
"X-Target-Org-Id"?: string | null;
|
|
523
|
+
};
|
|
524
|
+
};
|
|
525
|
+
output: ApiResponse_list_dict__;
|
|
526
|
+
};
|
|
527
|
+
/**
|
|
528
|
+
* POST /global-context/regenerate
|
|
529
|
+
* Regenerate Global Context
|
|
530
|
+
* tier: write · scope: campaigns:write
|
|
531
|
+
*/
|
|
532
|
+
regenerate_global_context_global_context_regenerate_post: {
|
|
533
|
+
input: {
|
|
534
|
+
headers?: {
|
|
535
|
+
"X-Target-Org-Id"?: string | null;
|
|
536
|
+
};
|
|
537
|
+
body: RegenerateContextRequest;
|
|
538
|
+
};
|
|
539
|
+
output: ApiResponse_dict_;
|
|
540
|
+
};
|
|
541
|
+
/**
|
|
542
|
+
* POST /global-context/{doc_id}/regenerate
|
|
543
|
+
* Regenerate One Document
|
|
544
|
+
* tier: write · scope: campaigns:write
|
|
545
|
+
*/
|
|
546
|
+
regenerate_one_document_global_context__doc_id__regenerate_post: {
|
|
547
|
+
input: {
|
|
548
|
+
path: {
|
|
549
|
+
/** Document id. */
|
|
550
|
+
doc_id: string;
|
|
551
|
+
};
|
|
552
|
+
headers?: {
|
|
553
|
+
"X-Target-Org-Id"?: string | null;
|
|
554
|
+
};
|
|
555
|
+
};
|
|
556
|
+
output: ApiResponse_StudioPayload_;
|
|
557
|
+
};
|
|
558
|
+
/**
|
|
559
|
+
* POST /global-context/reindex-all
|
|
560
|
+
* Reindex All Documents
|
|
561
|
+
* tier: write · scope: campaigns:write
|
|
562
|
+
*/
|
|
563
|
+
reindex_all_documents_global_context_reindex_all_post: {
|
|
564
|
+
input: {
|
|
565
|
+
headers?: {
|
|
566
|
+
"X-Target-Org-Id"?: string | null;
|
|
567
|
+
};
|
|
568
|
+
};
|
|
569
|
+
output: ApiResponse_StudioPayload_;
|
|
570
|
+
};
|
|
571
|
+
/**
|
|
572
|
+
* POST /company-profile/reindex
|
|
573
|
+
* Reindex Company Profile
|
|
574
|
+
* tier: billable · scope: campaigns:run
|
|
575
|
+
*/
|
|
576
|
+
reindex_company_profile_company_profile_reindex_post: {
|
|
577
|
+
input: {
|
|
578
|
+
headers?: {
|
|
579
|
+
"X-Target-Org-Id"?: string | null;
|
|
580
|
+
};
|
|
581
|
+
body: ProfileWebsiteRequest;
|
|
582
|
+
};
|
|
583
|
+
output: ApiResponse_CrmRecordPayload_;
|
|
584
|
+
};
|
|
585
|
+
/**
|
|
586
|
+
* DELETE /company-profile/keywords
|
|
587
|
+
* Reset Company Profile Keywords
|
|
588
|
+
* tier: destructive · scope: campaigns:delete
|
|
589
|
+
*/
|
|
590
|
+
reset_company_profile_keywords_company_profile_keywords_delete: {
|
|
591
|
+
input: {
|
|
592
|
+
query: {
|
|
593
|
+
/** The website the profile was built from. */
|
|
594
|
+
website_url: string;
|
|
595
|
+
};
|
|
596
|
+
headers?: {
|
|
597
|
+
"X-Target-Org-Id"?: string | null;
|
|
598
|
+
};
|
|
599
|
+
};
|
|
600
|
+
output: ApiResponse_CrmRecordPayload_;
|
|
601
|
+
};
|
|
602
|
+
/**
|
|
603
|
+
* POST /global-context/reset-stuck-documents
|
|
604
|
+
* Reset Stuck Documents
|
|
605
|
+
* tier: destructive · scope: campaigns:delete
|
|
606
|
+
*/
|
|
607
|
+
reset_stuck_documents_global_context_reset_stuck_documents_post: {
|
|
608
|
+
input: {
|
|
609
|
+
headers?: {
|
|
610
|
+
"X-Target-Org-Id"?: string | null;
|
|
611
|
+
};
|
|
612
|
+
};
|
|
613
|
+
output: ApiResponse_StudioPayload_;
|
|
614
|
+
};
|
|
615
|
+
/**
|
|
616
|
+
* POST /global-context/resume-pipeline
|
|
617
|
+
* Resume Pipeline
|
|
618
|
+
* tier: write · scope: campaigns:write
|
|
619
|
+
*/
|
|
620
|
+
resume_pipeline_global_context_resume_pipeline_post: {
|
|
621
|
+
input: {
|
|
622
|
+
headers?: {
|
|
623
|
+
"X-Target-Org-Id"?: string | null;
|
|
624
|
+
};
|
|
625
|
+
};
|
|
626
|
+
output: ApiResponse_StudioPayload_;
|
|
627
|
+
};
|
|
628
|
+
/**
|
|
629
|
+
* POST /company-profile/retry
|
|
630
|
+
* Retry Company Profile
|
|
631
|
+
* tier: billable · scope: campaigns:run
|
|
632
|
+
*/
|
|
633
|
+
retry_company_profile_company_profile_retry_post: {
|
|
634
|
+
input: {
|
|
635
|
+
headers?: {
|
|
636
|
+
"X-Target-Org-Id"?: string | null;
|
|
637
|
+
};
|
|
638
|
+
body: ProfileWebsiteRequest;
|
|
639
|
+
};
|
|
640
|
+
output: ApiResponse_CrmRecordPayload_;
|
|
641
|
+
};
|
|
642
|
+
/**
|
|
643
|
+
* POST /global-context/documents/buying-journey/interview
|
|
644
|
+
* Save Buying Journey Interview
|
|
645
|
+
* tier: write · scope: campaigns:write
|
|
646
|
+
*/
|
|
647
|
+
save_buying_journey_interview_global_context_documents_buying_journey_interview_post: {
|
|
648
|
+
input: {
|
|
649
|
+
headers?: {
|
|
650
|
+
"X-Target-Org-Id"?: string | null;
|
|
651
|
+
};
|
|
652
|
+
body: BuyingJourneyInterviewRequest;
|
|
653
|
+
};
|
|
654
|
+
output: ApiResponse_StudioPayload_;
|
|
655
|
+
};
|
|
656
|
+
/**
|
|
657
|
+
* POST /global-context/scaffold
|
|
658
|
+
* Scaffold All Documents
|
|
659
|
+
* tier: write · scope: campaigns:write
|
|
660
|
+
*/
|
|
661
|
+
scaffold_all_documents_global_context_scaffold_post: {
|
|
662
|
+
input: {
|
|
663
|
+
headers?: {
|
|
664
|
+
"X-Target-Org-Id"?: string | null;
|
|
665
|
+
};
|
|
666
|
+
};
|
|
667
|
+
output: ApiResponse_StudioPayload_;
|
|
668
|
+
};
|
|
669
|
+
/**
|
|
670
|
+
* POST /global-context/scaffold-company-keywords
|
|
671
|
+
* Scaffold Company Keywords
|
|
672
|
+
* tier: write · scope: campaigns:write
|
|
673
|
+
*/
|
|
674
|
+
scaffold_company_keywords_global_context_scaffold_company_keywords_post: {
|
|
675
|
+
input: {
|
|
676
|
+
headers?: {
|
|
677
|
+
"X-Target-Org-Id"?: string | null;
|
|
678
|
+
};
|
|
679
|
+
};
|
|
680
|
+
output: ApiResponse_StudioPayload_;
|
|
681
|
+
};
|
|
682
|
+
/**
|
|
683
|
+
* POST /global-context/scaffold-company-profile
|
|
684
|
+
* Scaffold Company Profile
|
|
685
|
+
* tier: write · scope: campaigns:write
|
|
686
|
+
*/
|
|
687
|
+
scaffold_company_profile_global_context_scaffold_company_profile_post: {
|
|
688
|
+
input: {
|
|
689
|
+
headers?: {
|
|
690
|
+
"X-Target-Org-Id"?: string | null;
|
|
691
|
+
};
|
|
692
|
+
};
|
|
693
|
+
output: ApiResponse_StudioPayload_;
|
|
694
|
+
};
|
|
695
|
+
/**
|
|
696
|
+
* POST /global-context/stop-all-generation
|
|
697
|
+
* Stop All Generation
|
|
698
|
+
* tier: write · scope: campaigns:write
|
|
699
|
+
*/
|
|
700
|
+
stop_all_generation_global_context_stop_all_generation_post: {
|
|
701
|
+
input: {
|
|
702
|
+
headers?: {
|
|
703
|
+
"X-Target-Org-Id"?: string | null;
|
|
704
|
+
};
|
|
705
|
+
};
|
|
706
|
+
output: ApiResponse_StudioPayload_;
|
|
707
|
+
};
|
|
708
|
+
/**
|
|
709
|
+
* POST /global-context/documents/{doc_id}/feedback
|
|
710
|
+
* Submit Document Feedback
|
|
711
|
+
* tier: write · scope: campaigns:write
|
|
712
|
+
*/
|
|
713
|
+
submit_document_feedback_global_context_documents__doc_id__feedback_post: {
|
|
714
|
+
input: {
|
|
715
|
+
path: {
|
|
716
|
+
/** Document id. */
|
|
717
|
+
doc_id: string;
|
|
718
|
+
};
|
|
719
|
+
headers?: {
|
|
720
|
+
"X-Target-Org-Id"?: string | null;
|
|
721
|
+
};
|
|
722
|
+
body: DocumentFeedbackRequest;
|
|
723
|
+
};
|
|
724
|
+
output: ApiResponse_StudioPayload_;
|
|
725
|
+
};
|
|
726
|
+
/**
|
|
727
|
+
* POST /global-context/documents/{doc_id}/track-usage
|
|
728
|
+
* Track Document Usage
|
|
729
|
+
* tier: write · scope: campaigns:write
|
|
730
|
+
*/
|
|
731
|
+
track_document_usage_global_context_documents__doc_id__track_usage_post: {
|
|
732
|
+
input: {
|
|
733
|
+
path: {
|
|
734
|
+
/** Global Context document ID. */
|
|
735
|
+
doc_id: string;
|
|
736
|
+
};
|
|
737
|
+
headers?: {
|
|
738
|
+
"X-Target-Org-Id"?: string | null;
|
|
739
|
+
};
|
|
740
|
+
body: TrackDocumentUsageRequest;
|
|
741
|
+
};
|
|
742
|
+
output: ApiResponse_StudioPayload_;
|
|
743
|
+
};
|
|
744
|
+
/**
|
|
745
|
+
* POST /company-profile/unapprove
|
|
746
|
+
* Unapprove Company Profile
|
|
747
|
+
* tier: write · scope: campaigns:write
|
|
748
|
+
*/
|
|
749
|
+
unapprove_company_profile_company_profile_unapprove_post: {
|
|
750
|
+
input: {
|
|
751
|
+
headers?: {
|
|
752
|
+
"X-Target-Org-Id"?: string | null;
|
|
753
|
+
};
|
|
754
|
+
body: ProfileWebsiteRequest;
|
|
755
|
+
};
|
|
756
|
+
output: ApiResponse_CrmRecordPayload_;
|
|
757
|
+
};
|
|
758
|
+
/**
|
|
759
|
+
* PUT /company-profile
|
|
760
|
+
* Update Company Profile
|
|
761
|
+
* tier: write · scope: campaigns:write
|
|
762
|
+
*/
|
|
763
|
+
update_company_profile_company_profile_put: {
|
|
764
|
+
input: {
|
|
765
|
+
headers?: {
|
|
766
|
+
"X-Target-Org-Id"?: string | null;
|
|
767
|
+
};
|
|
768
|
+
body: CompanyProfileUpdateRequest;
|
|
769
|
+
};
|
|
770
|
+
output: ApiResponse_dict_;
|
|
771
|
+
};
|
|
772
|
+
/**
|
|
773
|
+
* PATCH /global-context/documents/{doc_id}
|
|
774
|
+
* Update Global Context Document
|
|
775
|
+
* tier: write · scope: campaigns:write
|
|
776
|
+
*/
|
|
777
|
+
update_global_context_document_global_context_documents__doc_id__patch: {
|
|
778
|
+
input: {
|
|
779
|
+
path: {
|
|
780
|
+
/** Global context document ID (UUID) */
|
|
781
|
+
doc_id: string;
|
|
782
|
+
};
|
|
783
|
+
headers?: {
|
|
784
|
+
"X-Target-Org-Id"?: string | null;
|
|
785
|
+
};
|
|
786
|
+
body: UpdateGlobalContextRequest;
|
|
787
|
+
};
|
|
788
|
+
output: ApiResponse_dict_;
|
|
789
|
+
};
|
|
790
|
+
/**
|
|
791
|
+
* PATCH /icps/{icp_id}
|
|
792
|
+
* Update Icp
|
|
793
|
+
* tier: write · scope: campaigns:write
|
|
794
|
+
*/
|
|
795
|
+
update_icp_icps__icp_id__patch: {
|
|
796
|
+
input: {
|
|
797
|
+
path: {
|
|
798
|
+
/** ICP ID (UUID) */
|
|
799
|
+
icp_id: string;
|
|
800
|
+
};
|
|
801
|
+
headers?: {
|
|
802
|
+
"X-Target-Org-Id"?: string | null;
|
|
803
|
+
};
|
|
804
|
+
body: UpdateIcpRequest;
|
|
805
|
+
};
|
|
806
|
+
output: ApiResponse_dict_;
|
|
807
|
+
};
|
|
808
|
+
/**
|
|
809
|
+
* PATCH /personas/{persona_id}
|
|
810
|
+
* Update Persona
|
|
811
|
+
* tier: write · scope: campaigns:write
|
|
812
|
+
*/
|
|
813
|
+
update_persona_personas__persona_id__patch: {
|
|
814
|
+
input: {
|
|
815
|
+
path: {
|
|
816
|
+
/** Persona ID (UUID) */
|
|
817
|
+
persona_id: string;
|
|
818
|
+
};
|
|
819
|
+
headers?: {
|
|
820
|
+
"X-Target-Org-Id"?: string | null;
|
|
821
|
+
};
|
|
822
|
+
body: UpdatePersonaRequest;
|
|
823
|
+
};
|
|
824
|
+
output: ApiResponse_dict_;
|
|
825
|
+
};
|
|
826
|
+
/**
|
|
827
|
+
* PATCH /research-reports/{report_id}
|
|
828
|
+
* Update Research Report
|
|
829
|
+
* tier: billable · scope: campaigns:run
|
|
830
|
+
*/
|
|
831
|
+
update_research_report_research_reports__report_id__patch: {
|
|
832
|
+
input: {
|
|
833
|
+
path: {
|
|
834
|
+
/** Research report ID (UUID) */
|
|
835
|
+
report_id: string;
|
|
836
|
+
};
|
|
837
|
+
headers?: {
|
|
838
|
+
"X-Target-Org-Id"?: string | null;
|
|
839
|
+
};
|
|
840
|
+
body: UpdateResearchReportRequest;
|
|
841
|
+
};
|
|
842
|
+
output: ApiResponse_dict_;
|
|
843
|
+
};
|
|
844
|
+
/**
|
|
845
|
+
* POST /company-profile/logo
|
|
846
|
+
* Upload Company Profile Logo
|
|
847
|
+
* tier: write · scope: campaigns:write
|
|
848
|
+
*/
|
|
849
|
+
upload_company_profile_logo_company_profile_logo_post: {
|
|
850
|
+
input: {
|
|
851
|
+
headers?: {
|
|
852
|
+
"X-Target-Org-Id"?: string | null;
|
|
853
|
+
};
|
|
854
|
+
};
|
|
855
|
+
output: ApiResponse_CrmRecordPayload_;
|
|
856
|
+
};
|
|
857
|
+
/**
|
|
858
|
+
* POST /enablement/assets
|
|
859
|
+
* Upload Enablement Asset
|
|
860
|
+
* tier: write · scope: campaigns:write
|
|
861
|
+
*/
|
|
862
|
+
upload_enablement_asset_enablement_assets_post: {
|
|
863
|
+
input: {
|
|
864
|
+
headers?: {
|
|
865
|
+
"X-Target-Org-Id"?: string | null;
|
|
866
|
+
};
|
|
867
|
+
body: EnablementAssetUploadRequest;
|
|
868
|
+
};
|
|
869
|
+
output: ApiResponse_dict_;
|
|
870
|
+
};
|
|
871
|
+
}
|
|
872
|
+
|
|
873
|
+
// 25 schemas referenced above (the same as G8Contract.<Name>).
|
|
874
|
+
|
|
875
|
+
export interface ApiResponse_CrmRecordPayload_ {
|
|
876
|
+
data: CrmRecordPayload;
|
|
877
|
+
pagination?: PaginationMeta | null;
|
|
878
|
+
}
|
|
879
|
+
|
|
880
|
+
export interface ApiResponse_StudioListPayload_ {
|
|
881
|
+
data: StudioListPayload;
|
|
882
|
+
pagination?: PaginationMeta | null;
|
|
883
|
+
}
|
|
884
|
+
|
|
885
|
+
export interface ApiResponse_StudioPayload_ {
|
|
886
|
+
data: StudioPayload;
|
|
887
|
+
pagination?: PaginationMeta | null;
|
|
888
|
+
}
|
|
889
|
+
|
|
890
|
+
export interface ApiResponse_dict_ {
|
|
891
|
+
data: Record<string, unknown>;
|
|
892
|
+
pagination?: PaginationMeta | null;
|
|
893
|
+
}
|
|
894
|
+
|
|
895
|
+
export interface ApiResponse_list_dict__ {
|
|
896
|
+
data: Array<Record<string, unknown>>;
|
|
897
|
+
pagination?: PaginationMeta | null;
|
|
898
|
+
}
|
|
899
|
+
|
|
900
|
+
/**
|
|
901
|
+
* The typed form of the untyped `dict` body the interview route takes.
|
|
902
|
+
*
|
|
903
|
+
* The app reads `answers` and 400s when it is empty. Typed so that is a 422,
|
|
904
|
+
* and so the shape is discoverable.
|
|
905
|
+
*/
|
|
906
|
+
export interface BuyingJourneyInterviewRequest {
|
|
907
|
+
/** Structured interview answers about how this organisation sells. Injected as highest-priority grounding the next time the buying journey document is generated. */
|
|
908
|
+
answers: Record<string, unknown>;
|
|
909
|
+
}
|
|
910
|
+
|
|
911
|
+
export interface CompanyProfileUpdateRequest {
|
|
912
|
+
/** Profile fields to save, e.g. {'company_name': 'Acme', 'industry': 'Manufacturing'}. Replaces the stored field set. */
|
|
913
|
+
fields: Record<string, string>;
|
|
914
|
+
/** Approved profiles are immutable by design. Set true to explicitly unlock and overwrite a human-approved profile. Left false, an approved profile returns 409 instead of being silently unapproved. */
|
|
915
|
+
unapprove_if_approved?: boolean;
|
|
916
|
+
/** The client's real website. This is the source of truth Studio generation reads; setting it wrong is what makes every downstream ICP, persona and campaign describe the wrong company. */
|
|
917
|
+
website_url: string;
|
|
918
|
+
}
|
|
919
|
+
|
|
920
|
+
/**
|
|
921
|
+
* Body for POST /icps - create a Studio ICP manually (no AI generation).
|
|
922
|
+
*
|
|
923
|
+
* Mirrors the internal Studio "Add ICP" action. Manual ICPs are created with
|
|
924
|
+
* status 'active'; the fit/opportunity/readiness/total scores stay null (they are
|
|
925
|
+
* only produced by the AI generate flow, which this endpoint does not run).
|
|
926
|
+
*/
|
|
927
|
+
export interface CreateIcpRequest {
|
|
928
|
+
/** List of buying-intent signals. */
|
|
929
|
+
buying_signals?: Array<unknown> | null;
|
|
930
|
+
/** Freeform ICP description. */
|
|
931
|
+
description?: string | null;
|
|
932
|
+
/** Estimated addressable-market count. */
|
|
933
|
+
estimated_market_size?: number | null;
|
|
934
|
+
/** Firmographic criteria (industry, size, geo, ...). */
|
|
935
|
+
firmographics?: Record<string, unknown> | null;
|
|
936
|
+
/** ICP name/title. */
|
|
937
|
+
name: string;
|
|
938
|
+
/** Technology signals. */
|
|
939
|
+
tech_stack?: Record<string, unknown> | null;
|
|
940
|
+
/** The org website this ICP belongs to. */
|
|
941
|
+
website_url: string;
|
|
942
|
+
}
|
|
943
|
+
|
|
944
|
+
/**
|
|
945
|
+
* Body for POST /personas - create a Studio buyer persona manually.
|
|
946
|
+
*
|
|
947
|
+
* Mirrors the internal Studio "Add Persona" action. Manual personas are created
|
|
948
|
+
* with status 'active'; AI/score fields stay null (they are only populated by the
|
|
949
|
+
* AI generate flow, which this endpoint intentionally does not run).
|
|
950
|
+
*/
|
|
951
|
+
export interface CreatePersonaRequest {
|
|
952
|
+
/** Recommended campaign approach. */
|
|
953
|
+
campaign_approach?: string | null;
|
|
954
|
+
/** Confidence label (e.g. 'high'/'medium'/'low'). Defaults to 'medium'. */
|
|
955
|
+
confidence?: string | null;
|
|
956
|
+
/** Expected receptivity note. */
|
|
957
|
+
expected_receptivity?: string | null;
|
|
958
|
+
/** List of buying/intent signals. */
|
|
959
|
+
key_signals?: Array<unknown> | null;
|
|
960
|
+
/** Display priority (lower sorts first). Defaults to 1. */
|
|
961
|
+
priority?: number | null;
|
|
962
|
+
/** Recommended campaign goal. */
|
|
963
|
+
recommended_goal?: string | null;
|
|
964
|
+
/** Origin label for the persona. Defaults to 'manual'. */
|
|
965
|
+
source?: string | null;
|
|
966
|
+
/** Persona title (e.g. 'Director of Marketing Operations'). */
|
|
967
|
+
title: string;
|
|
968
|
+
/** The org website this persona belongs to. */
|
|
969
|
+
website_url: string;
|
|
970
|
+
/** Why this persona is worth targeting. */
|
|
971
|
+
why_target?: string | null;
|
|
972
|
+
}
|
|
973
|
+
|
|
974
|
+
/**
|
|
975
|
+
* An open envelope for one record, one dashboard or one job receipt.
|
|
976
|
+
*
|
|
977
|
+
* Open because most of these reads are COMPUTED shapes - an engagement
|
|
978
|
+
* summary, a next-best-step, an intelligence status - that grow with the
|
|
979
|
+
* product, and dropping a field from an advisory read makes it say "nothing
|
|
980
|
+
* to report" rather than "we did not tell you".
|
|
981
|
+
*/
|
|
982
|
+
export type CrmRecordPayload = Record<string, unknown>;
|
|
983
|
+
|
|
984
|
+
/**
|
|
985
|
+
* Mirrors `campaign_builder.routers.global_context.FeedbackRequest`.
|
|
986
|
+
*
|
|
987
|
+
* `feedback_type` is a Literal where the app takes `str` and rejects anything
|
|
988
|
+
* but `up`/`down` from inside the handler.
|
|
989
|
+
*/
|
|
990
|
+
export interface DocumentFeedbackRequest {
|
|
991
|
+
/** Thumbs up or thumbs down on the document. */
|
|
992
|
+
feedback_type: "up" | "down";
|
|
993
|
+
/** The usage record this feedback is about, when the feedback follows a specific use of the document rather than the document itself. */
|
|
994
|
+
usage_id?: string | null;
|
|
995
|
+
}
|
|
996
|
+
|
|
997
|
+
/** Base64 file upload for the org's Studio Enablement library. */
|
|
998
|
+
export interface EnablementAssetUploadRequest {
|
|
999
|
+
content_base64: string;
|
|
1000
|
+
file_name: string;
|
|
1001
|
+
folder?: string | null;
|
|
1002
|
+
mime_type?: string | null;
|
|
1003
|
+
tags?: Array<string>;
|
|
1004
|
+
}
|
|
1005
|
+
|
|
1006
|
+
/**
|
|
1007
|
+
* The typed form of the untyped `dict` body `extract-company-data` takes.
|
|
1008
|
+
*
|
|
1009
|
+
* The app reads exactly two keys off that dict and 400s when `website_url` is
|
|
1010
|
+
* missing. Typed here so the same mistake is a parse-layer 422 naming the
|
|
1011
|
+
* field, and so the caller can see that `enrich` exists at all - it is
|
|
1012
|
+
* invisible in an untyped body.
|
|
1013
|
+
*
|
|
1014
|
+
* NOT a mirrored model: there is no app model to mirror. The proxy sends a
|
|
1015
|
+
* plain dict, exactly as the browser does.
|
|
1016
|
+
*/
|
|
1017
|
+
export interface ExtractCompanyDataRequest {
|
|
1018
|
+
/** Enrich the extracted fields through Apollo. SPENDS CREDITS - the call is credit-gated and answers 402 when the balance is short. */
|
|
1019
|
+
enrich?: boolean;
|
|
1020
|
+
/** Company website to extract from. Intelligence data for it must already exist. */
|
|
1021
|
+
website_url: string;
|
|
1022
|
+
}
|
|
1023
|
+
|
|
1024
|
+
/**
|
|
1025
|
+
* Mirrors `campaign_builder.routers.global_context.GenerateAllDocumentsRequest`.
|
|
1026
|
+
*
|
|
1027
|
+
* ONE-SHOT. The app refuses this with a 409 once a pipeline has completed for
|
|
1028
|
+
* the org, which is why `POST /global-context/regenerate` exists - use that
|
|
1029
|
+
* to rebuild documents that already exist.
|
|
1030
|
+
*/
|
|
1031
|
+
export interface GenerateAllDocumentsRequest {
|
|
1032
|
+
/** The company website every document is generated against. Intelligence data must already exist for it. */
|
|
1033
|
+
website_url: string;
|
|
1034
|
+
}
|
|
1035
|
+
|
|
1036
|
+
export interface PaginationMeta {
|
|
1037
|
+
/** Whether there are more pages */
|
|
1038
|
+
has_next: boolean;
|
|
1039
|
+
/** Items per page */
|
|
1040
|
+
limit: number;
|
|
1041
|
+
/** 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. */
|
|
1042
|
+
next_cursor?: string | null;
|
|
1043
|
+
/** Current page number (1-indexed) */
|
|
1044
|
+
page: number;
|
|
1045
|
+
/** Total number of items */
|
|
1046
|
+
total: number;
|
|
1047
|
+
}
|
|
1048
|
+
|
|
1049
|
+
/** Mirrors `company_profile.SaveProfileRequest`. */
|
|
1050
|
+
export interface ProfileFieldsRequest {
|
|
1051
|
+
/** Which profile fields to generate, and their seeds. */
|
|
1052
|
+
fields: Record<string, unknown>;
|
|
1053
|
+
/** The org's website - the profile's key. */
|
|
1054
|
+
website_url: string;
|
|
1055
|
+
}
|
|
1056
|
+
|
|
1057
|
+
/**
|
|
1058
|
+
* Names the company profile to act on, by the website it was built from.
|
|
1059
|
+
*
|
|
1060
|
+
* Mirrors `campaign_builder.routers.company_profile.ApproveProfileRequest`,
|
|
1061
|
+
* which is the same single field. The reindex route reads the same value as
|
|
1062
|
+
* a QUERY parameter on a POST in the app; it is a body here because a POST
|
|
1063
|
+
* that carries its only input in the URL is the kind of asymmetry a client
|
|
1064
|
+
* library gets wrong once and then works around forever.
|
|
1065
|
+
*/
|
|
1066
|
+
export interface ProfileWebsiteRequest {
|
|
1067
|
+
/** Website the profile was built from. Matched on its canonical domain. */
|
|
1068
|
+
website_url: string;
|
|
1069
|
+
}
|
|
1070
|
+
|
|
1071
|
+
export interface RegenerateContextRequest {
|
|
1072
|
+
/** Specific Studio doc types to regenerate (e.g. ['icp_research','persona_research']). Omit to regenerate every document that already exists in the org. */
|
|
1073
|
+
doc_types?: Array<string> | null;
|
|
1074
|
+
/** Website to generate from. After a company-profile change this must be the NEW domain — intelligence is keyed by URL, so passing the old one silently regenerates the same stale content. */
|
|
1075
|
+
website_url: string;
|
|
1076
|
+
}
|
|
1077
|
+
|
|
1078
|
+
/**
|
|
1079
|
+
* An open envelope for a LIST result, so a bare list keeps its shape.
|
|
1080
|
+
*
|
|
1081
|
+
* A handler that returns `[...]` and one that returns `{"documents": [...]}`
|
|
1082
|
+
* both land on `items`, and the named key is preserved beside it so a caller
|
|
1083
|
+
* reading the app's own spelling is not broken by the normalisation.
|
|
1084
|
+
*/
|
|
1085
|
+
export interface StudioListPayload {
|
|
1086
|
+
items?: Array<unknown>;
|
|
1087
|
+
[key: string]: unknown;
|
|
1088
|
+
}
|
|
1089
|
+
|
|
1090
|
+
/**
|
|
1091
|
+
* An open envelope for one settings block, document or brand artefact.
|
|
1092
|
+
*
|
|
1093
|
+
* OPEN on purpose. These surfaces are configuration and generated content,
|
|
1094
|
+
* and both grow: a new toggle on a settings block or a new field on a
|
|
1095
|
+
* generated document must reach a caller on the day it ships, not on the day
|
|
1096
|
+
* somebody remembers to widen a mirror. A closed response model here would
|
|
1097
|
+
* silently DROP the new key, which reads to the caller as "the product does
|
|
1098
|
+
* not have that setting".
|
|
1099
|
+
*
|
|
1100
|
+
* The request side is the opposite and is mirrored exactly - see the module
|
|
1101
|
+
* docstring for why the asymmetry is deliberate.
|
|
1102
|
+
*/
|
|
1103
|
+
export type StudioPayload = Record<string, unknown>;
|
|
1104
|
+
|
|
1105
|
+
/** Mirrors the app handler's query parameters field for field. */
|
|
1106
|
+
export interface TrackDocumentUsageRequest {
|
|
1107
|
+
/** ID of the entity that used the document, if any. */
|
|
1108
|
+
source_id?: string | null;
|
|
1109
|
+
/** Where the use happened, e.g. `campaign`, `account`, `copilot`, `research`. Free-form. */
|
|
1110
|
+
source_type?: string | null;
|
|
1111
|
+
/** `creation`: the document was used to generate new content. `citation`: the document was quoted or referenced. */
|
|
1112
|
+
usage_type: "creation" | "citation";
|
|
1113
|
+
}
|
|
1114
|
+
|
|
1115
|
+
/**
|
|
1116
|
+
* Body for PATCH /global-context/documents/{doc_id}.
|
|
1117
|
+
*
|
|
1118
|
+
* Partial update: send only the fields you want to change. At least one of
|
|
1119
|
+
* ``content`` / ``status`` must be present.
|
|
1120
|
+
*/
|
|
1121
|
+
export interface UpdateGlobalContextRequest {
|
|
1122
|
+
/** New document body. Stored at meta_data.content. Omit to leave unchanged. */
|
|
1123
|
+
content?: string | null;
|
|
1124
|
+
/** New document status (e.g. 'completed', 'draft'). Omit to leave unchanged. */
|
|
1125
|
+
status?: string | null;
|
|
1126
|
+
}
|
|
1127
|
+
|
|
1128
|
+
/**
|
|
1129
|
+
* Body for PATCH /icps/{icp_id}. Partial - send only the fields to change.
|
|
1130
|
+
*
|
|
1131
|
+
* At least one field must be present. Archiving is a separate lifecycle action
|
|
1132
|
+
* (POST /icps/{icp_id}/archive), matching the internal Studio split.
|
|
1133
|
+
*/
|
|
1134
|
+
export interface UpdateIcpRequest {
|
|
1135
|
+
/** New list of buying-intent signals. */
|
|
1136
|
+
buying_signals?: Array<unknown> | null;
|
|
1137
|
+
/** New description. */
|
|
1138
|
+
description?: string | null;
|
|
1139
|
+
/** New estimated market-size count. */
|
|
1140
|
+
estimated_market_size?: number | null;
|
|
1141
|
+
/** New firmographic criteria. */
|
|
1142
|
+
firmographics?: Record<string, unknown> | null;
|
|
1143
|
+
/** New ICP name. */
|
|
1144
|
+
name?: string | null;
|
|
1145
|
+
/** New technology signals. */
|
|
1146
|
+
tech_stack?: Record<string, unknown> | null;
|
|
1147
|
+
}
|
|
1148
|
+
|
|
1149
|
+
/**
|
|
1150
|
+
* Body for PATCH /personas/{persona_id}. Partial - send only fields to change.
|
|
1151
|
+
*
|
|
1152
|
+
* At least one field must be present. Passing status='archived' is equivalent to
|
|
1153
|
+
* calling POST /personas/{persona_id}/archive.
|
|
1154
|
+
*/
|
|
1155
|
+
export interface UpdatePersonaRequest {
|
|
1156
|
+
/** New campaign approach. */
|
|
1157
|
+
campaign_approach?: string | null;
|
|
1158
|
+
/** New confidence label. */
|
|
1159
|
+
confidence?: string | null;
|
|
1160
|
+
/** New expected-receptivity note. */
|
|
1161
|
+
expected_receptivity?: string | null;
|
|
1162
|
+
/** New list of buying/intent signals. */
|
|
1163
|
+
key_signals?: Array<unknown> | null;
|
|
1164
|
+
/** New display priority. */
|
|
1165
|
+
priority?: number | null;
|
|
1166
|
+
/** New recommended goal. */
|
|
1167
|
+
recommended_goal?: string | null;
|
|
1168
|
+
/** New status (e.g. 'active', 'archived'). */
|
|
1169
|
+
status?: string | null;
|
|
1170
|
+
/** New persona title. */
|
|
1171
|
+
title?: string | null;
|
|
1172
|
+
/** New 'why target' text. */
|
|
1173
|
+
why_target?: string | null;
|
|
1174
|
+
}
|
|
1175
|
+
|
|
1176
|
+
/**
|
|
1177
|
+
* Body for PATCH /research-reports/{report_id}.
|
|
1178
|
+
*
|
|
1179
|
+
* Partial update: send only what you want to change. At least one of
|
|
1180
|
+
* ``markdown_content`` / ``status`` must be present.
|
|
1181
|
+
*/
|
|
1182
|
+
export interface UpdateResearchReportRequest {
|
|
1183
|
+
/** New rendered markdown body. Omit to leave unchanged. Triggers RAG re-index. */
|
|
1184
|
+
markdown_content?: string | null;
|
|
1185
|
+
/** New report status. A report already 'completed'/'approved' can only move between those two states (done reports stay done). */
|
|
1186
|
+
status?: string | null;
|
|
1187
|
+
}
|