@graph8/sdk 0.251.0 → 0.260.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 +104 -7
- package/dist/index.d.ts +104 -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 +102 -7
- package/dist/react.d.ts +102 -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 +1696 -0
- package/docs/api/deals.md +2432 -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,968 @@
|
|
|
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.content` (Content): 41 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<"add_content_grid_row_content_grids__grid_id__rows_post">;
|
|
9
|
+
*
|
|
10
|
+
* Reference with examples: content.md
|
|
11
|
+
*/
|
|
12
|
+
/* eslint-disable */
|
|
13
|
+
|
|
14
|
+
/** `g8.api.content.<member>` -> the operationId it calls. */
|
|
15
|
+
export interface ContentMembers {
|
|
16
|
+
addContentGridRow: "add_content_grid_row_content_grids__grid_id__rows_post";
|
|
17
|
+
backfillContentPages: "backfill_content_pages_content_pages_backfill_post";
|
|
18
|
+
createContentApprovalShare: "create_content_approval_share_content_calendar_approvals_post";
|
|
19
|
+
createContentFromIdea: "create_content_from_idea_content_calendar_ideas__idea_id__create_content_post";
|
|
20
|
+
createContentGrid: "create_content_grid_content_grids_post";
|
|
21
|
+
createContentPage: "create_content_page_content_pages_post";
|
|
22
|
+
deleteContentGrid: "delete_content_grid_content_grids__grid_id__delete";
|
|
23
|
+
deleteContentGridRow: "delete_content_grid_row_content_grids__grid_id__rows__row_id__delete";
|
|
24
|
+
deleteContentPage: "delete_content_page_content_pages__page_id__delete";
|
|
25
|
+
deleteContentWorkspacePage: "delete_content_workspace_page_content_workspace_pages__page_id__delete";
|
|
26
|
+
enrichContentPage: "enrich_content_page_content_pages__page_id__enrich_seo_post";
|
|
27
|
+
enrichContentPagesBulk: "enrich_content_pages_bulk_content_pages_enrich_seo_bulk_post";
|
|
28
|
+
getContentBackfillStatus: "get_content_backfill_status_content_pages_backfill_status__task_id__get";
|
|
29
|
+
getContentCalendar: "get_content_calendar_content_calendar_get";
|
|
30
|
+
getContentGrid: "get_content_grid_content_grids__grid_id__get";
|
|
31
|
+
getContentIdeaEvidence: "get_content_idea_evidence_content_calendar_ideas__idea_id__evidence_get";
|
|
32
|
+
getContentImportStatus: "get_content_import_status_content_workspace_import_status__job_id__get";
|
|
33
|
+
getContentPage: "get_content_page_content_pages__page_id__get";
|
|
34
|
+
getContentSeoSummary: "get_content_seo_summary_content_workspace_seo_summary_get";
|
|
35
|
+
getContentSignalMiningStatus: "get_content_signal_mining_status_content_calendar_mine_signals_status_get";
|
|
36
|
+
getContentWorkspacePage: "get_content_workspace_page_content_workspace_pages__page_id__get";
|
|
37
|
+
getIdeaCorpusStats: "get_idea_corpus_stats_content_calendar_ideas_corpus_stats_get";
|
|
38
|
+
importContentPagesFromSitemap: "import_content_pages_from_sitemap_content_pages_import_sitemap_post";
|
|
39
|
+
listContentApprovalShares: "list_content_approval_shares_content_calendar_approvals_get";
|
|
40
|
+
listContentGrids: "list_content_grids_content_grids_get";
|
|
41
|
+
listContentIdeas: "list_content_ideas_content_calendar_ideas_get";
|
|
42
|
+
listContentImportJobs: "list_content_import_jobs_content_workspace_import_jobs_get";
|
|
43
|
+
listContentPages: "list_content_pages_content_pages_get";
|
|
44
|
+
listContentTypes: "list_content_types_content_types_get";
|
|
45
|
+
listContentWorkspacePages: "list_content_workspace_pages_content_workspace_pages_get";
|
|
46
|
+
listWebsiteTemplates: "list_website_templates_content_website_templates_get";
|
|
47
|
+
mineContentSignals: "mine_content_signals_content_calendar_mine_signals_post";
|
|
48
|
+
patchContentIdea: "patch_content_idea_content_calendar_ideas__idea_id__patch";
|
|
49
|
+
repurposeContentToAd: "repurpose_content_to_ad_content_calendar_repurpose_ad_post";
|
|
50
|
+
repurposeContentToLinkedinPost: "repurpose_content_to_linkedin_post_content_calendar_repurpose_linkedin_post_post";
|
|
51
|
+
retryContentPublish: "retry_content_publish_content_calendar__content_type___content_id__retry_publish_post";
|
|
52
|
+
scheduleContentPiece: "schedule_content_piece_content_calendar__content_type___content_id__schedule_patch";
|
|
53
|
+
startContentCrawlImport: "start_content_crawl_import_content_workspace_import_crawl_post";
|
|
54
|
+
startContentSitemapImport: "start_content_sitemap_import_content_workspace_import_sitemap_post";
|
|
55
|
+
updateContentPage: "update_content_page_content_pages__page_id__patch";
|
|
56
|
+
updateContentWorkspacePage: "update_content_workspace_page_content_workspace_pages__page_id__patch";
|
|
57
|
+
}
|
|
58
|
+
|
|
59
|
+
/** Input and output of every `g8.api.content` operation, keyed by operationId. */
|
|
60
|
+
export interface ContentOperations {
|
|
61
|
+
/**
|
|
62
|
+
* POST /content/grids/{grid_id}/rows
|
|
63
|
+
* Add Content Grid Row
|
|
64
|
+
* tier: write · scope: campaigns:write
|
|
65
|
+
*/
|
|
66
|
+
add_content_grid_row_content_grids__grid_id__rows_post: {
|
|
67
|
+
input: {
|
|
68
|
+
path: {
|
|
69
|
+
/** Content grid id. */
|
|
70
|
+
grid_id: string;
|
|
71
|
+
};
|
|
72
|
+
headers?: {
|
|
73
|
+
"X-Target-Org-Id"?: string | null;
|
|
74
|
+
};
|
|
75
|
+
body: AddRowRequest;
|
|
76
|
+
};
|
|
77
|
+
output: ApiResponse_StudioContentPayload_;
|
|
78
|
+
};
|
|
79
|
+
/**
|
|
80
|
+
* POST /content/pages/backfill
|
|
81
|
+
* Backfill Content Pages
|
|
82
|
+
* tier: write · scope: campaigns:write
|
|
83
|
+
*/
|
|
84
|
+
backfill_content_pages_content_pages_backfill_post: {
|
|
85
|
+
input: {
|
|
86
|
+
headers?: {
|
|
87
|
+
"X-Target-Org-Id"?: string | null;
|
|
88
|
+
};
|
|
89
|
+
};
|
|
90
|
+
output: ApiResponse_StudioContentPayload_;
|
|
91
|
+
};
|
|
92
|
+
/**
|
|
93
|
+
* POST /content/calendar/approvals
|
|
94
|
+
* Create Content Approval Share
|
|
95
|
+
* tier: write · scope: campaigns:write
|
|
96
|
+
*/
|
|
97
|
+
create_content_approval_share_content_calendar_approvals_post: {
|
|
98
|
+
input: {
|
|
99
|
+
headers?: {
|
|
100
|
+
"X-Target-Org-Id"?: string | null;
|
|
101
|
+
};
|
|
102
|
+
body: CreateApprovalShareRequest;
|
|
103
|
+
};
|
|
104
|
+
output: ApiResponse_StudioContentPayload_;
|
|
105
|
+
};
|
|
106
|
+
/**
|
|
107
|
+
* POST /content/calendar/ideas/{idea_id}/create-content
|
|
108
|
+
* Create Content From Idea
|
|
109
|
+
* tier: billable · scope: campaigns:run
|
|
110
|
+
*/
|
|
111
|
+
create_content_from_idea_content_calendar_ideas__idea_id__create_content_post: {
|
|
112
|
+
input: {
|
|
113
|
+
path: {
|
|
114
|
+
/** Mined idea id. */
|
|
115
|
+
idea_id: string;
|
|
116
|
+
};
|
|
117
|
+
headers?: {
|
|
118
|
+
"X-Target-Org-Id"?: string | null;
|
|
119
|
+
};
|
|
120
|
+
body: CreateFromIdeaRequest;
|
|
121
|
+
};
|
|
122
|
+
output: ApiResponse_StudioContentPayload_;
|
|
123
|
+
};
|
|
124
|
+
/**
|
|
125
|
+
* POST /content/grids
|
|
126
|
+
* Create Content Grid
|
|
127
|
+
* tier: write · scope: campaigns:write
|
|
128
|
+
*/
|
|
129
|
+
create_content_grid_content_grids_post: {
|
|
130
|
+
input: {
|
|
131
|
+
headers?: {
|
|
132
|
+
"X-Target-Org-Id"?: string | null;
|
|
133
|
+
};
|
|
134
|
+
body: CreateGridRequest;
|
|
135
|
+
};
|
|
136
|
+
output: ApiResponse_StudioContentPayload_;
|
|
137
|
+
};
|
|
138
|
+
/**
|
|
139
|
+
* POST /content/pages
|
|
140
|
+
* Create Content Page
|
|
141
|
+
* tier: write · scope: campaigns:write
|
|
142
|
+
*/
|
|
143
|
+
create_content_page_content_pages_post: {
|
|
144
|
+
input: {
|
|
145
|
+
headers?: {
|
|
146
|
+
"X-Target-Org-Id"?: string | null;
|
|
147
|
+
};
|
|
148
|
+
body: CreatePageRequest;
|
|
149
|
+
};
|
|
150
|
+
output: ApiResponse_StudioContentPayload_;
|
|
151
|
+
};
|
|
152
|
+
/**
|
|
153
|
+
* DELETE /content/grids/{grid_id}
|
|
154
|
+
* Delete Content Grid
|
|
155
|
+
* tier: destructive · scope: campaigns:delete
|
|
156
|
+
*/
|
|
157
|
+
delete_content_grid_content_grids__grid_id__delete: {
|
|
158
|
+
input: {
|
|
159
|
+
path: {
|
|
160
|
+
/** Content grid id. */
|
|
161
|
+
grid_id: string;
|
|
162
|
+
};
|
|
163
|
+
headers?: {
|
|
164
|
+
"X-Target-Org-Id"?: string | null;
|
|
165
|
+
};
|
|
166
|
+
};
|
|
167
|
+
output: ApiResponse_StudioContentPayload_;
|
|
168
|
+
};
|
|
169
|
+
/**
|
|
170
|
+
* DELETE /content/grids/{grid_id}/rows/{row_id}
|
|
171
|
+
* Delete Content Grid Row
|
|
172
|
+
* tier: destructive · scope: campaigns:delete
|
|
173
|
+
*/
|
|
174
|
+
delete_content_grid_row_content_grids__grid_id__rows__row_id__delete: {
|
|
175
|
+
input: {
|
|
176
|
+
path: {
|
|
177
|
+
/** Content grid id. */
|
|
178
|
+
grid_id: string;
|
|
179
|
+
/** Row id within the grid. */
|
|
180
|
+
row_id: string;
|
|
181
|
+
};
|
|
182
|
+
headers?: {
|
|
183
|
+
"X-Target-Org-Id"?: string | null;
|
|
184
|
+
};
|
|
185
|
+
};
|
|
186
|
+
output: ApiResponse_StudioContentPayload_;
|
|
187
|
+
};
|
|
188
|
+
/**
|
|
189
|
+
* DELETE /content/pages/{page_id}
|
|
190
|
+
* Delete Content Page
|
|
191
|
+
* tier: destructive · scope: campaigns:delete
|
|
192
|
+
*/
|
|
193
|
+
delete_content_page_content_pages__page_id__delete: {
|
|
194
|
+
input: {
|
|
195
|
+
path: {
|
|
196
|
+
/** Content page id. */
|
|
197
|
+
page_id: string;
|
|
198
|
+
};
|
|
199
|
+
query?: {
|
|
200
|
+
/** Delete even when the page is referenced by grid rows or calendar entries. Without it, a referenced page is refused rather than silently orphaning them. */
|
|
201
|
+
force?: boolean;
|
|
202
|
+
};
|
|
203
|
+
headers?: {
|
|
204
|
+
"X-Target-Org-Id"?: string | null;
|
|
205
|
+
};
|
|
206
|
+
};
|
|
207
|
+
output: ApiResponse_StudioContentPayload_;
|
|
208
|
+
};
|
|
209
|
+
/**
|
|
210
|
+
* DELETE /content-workspace/pages/{page_id}
|
|
211
|
+
* Delete Content Workspace Page
|
|
212
|
+
* tier: destructive · scope: campaigns:delete
|
|
213
|
+
*/
|
|
214
|
+
delete_content_workspace_page_content_workspace_pages__page_id__delete: {
|
|
215
|
+
input: {
|
|
216
|
+
path: {
|
|
217
|
+
/** Content page id (UUID). */
|
|
218
|
+
page_id: string;
|
|
219
|
+
};
|
|
220
|
+
headers?: {
|
|
221
|
+
"X-Target-Org-Id"?: string | null;
|
|
222
|
+
};
|
|
223
|
+
};
|
|
224
|
+
output: ApiResponse_StudioContentPayload_;
|
|
225
|
+
};
|
|
226
|
+
/**
|
|
227
|
+
* POST /content/pages/{page_id}/enrich-seo
|
|
228
|
+
* Enrich Content Page
|
|
229
|
+
* tier: billable · scope: campaigns:run
|
|
230
|
+
*/
|
|
231
|
+
enrich_content_page_content_pages__page_id__enrich_seo_post: {
|
|
232
|
+
input: {
|
|
233
|
+
path: {
|
|
234
|
+
/** Content page id. */
|
|
235
|
+
page_id: string;
|
|
236
|
+
};
|
|
237
|
+
headers?: {
|
|
238
|
+
"X-Target-Org-Id"?: string | null;
|
|
239
|
+
};
|
|
240
|
+
};
|
|
241
|
+
output: ApiResponse_StudioContentPayload_;
|
|
242
|
+
};
|
|
243
|
+
/**
|
|
244
|
+
* POST /content/pages/enrich-seo-bulk
|
|
245
|
+
* Enrich Content Pages Bulk
|
|
246
|
+
* tier: billable · scope: campaigns:run
|
|
247
|
+
*/
|
|
248
|
+
enrich_content_pages_bulk_content_pages_enrich_seo_bulk_post: {
|
|
249
|
+
input: {
|
|
250
|
+
headers?: {
|
|
251
|
+
"X-Target-Org-Id"?: string | null;
|
|
252
|
+
};
|
|
253
|
+
body: EnrichSeoBulkRequest;
|
|
254
|
+
};
|
|
255
|
+
output: ApiResponse_StudioContentPayload_;
|
|
256
|
+
};
|
|
257
|
+
/**
|
|
258
|
+
* GET /content/pages/backfill/status/{task_id}
|
|
259
|
+
* Get Content Backfill Status
|
|
260
|
+
* tier: read · scope: campaigns:read
|
|
261
|
+
*/
|
|
262
|
+
get_content_backfill_status_content_pages_backfill_status__task_id__get: {
|
|
263
|
+
input: {
|
|
264
|
+
path: {
|
|
265
|
+
/** Task id returned by `POST /content/pages/backfill`. */
|
|
266
|
+
task_id: string;
|
|
267
|
+
};
|
|
268
|
+
headers?: {
|
|
269
|
+
"X-Target-Org-Id"?: string | null;
|
|
270
|
+
};
|
|
271
|
+
};
|
|
272
|
+
output: ApiResponse_StudioContentPayload_;
|
|
273
|
+
};
|
|
274
|
+
/**
|
|
275
|
+
* GET /content/calendar
|
|
276
|
+
* Get Content Calendar
|
|
277
|
+
* tier: read · scope: campaigns:read
|
|
278
|
+
*/
|
|
279
|
+
get_content_calendar_content_calendar_get: {
|
|
280
|
+
input: {
|
|
281
|
+
query: {
|
|
282
|
+
/** Window start, inclusive. */
|
|
283
|
+
date_from: string;
|
|
284
|
+
/** Window end, inclusive. */
|
|
285
|
+
date_to: string;
|
|
286
|
+
/** Comma-separated lanes to include. Omit for all five. Same vocabulary as the `content_type` path parameter. */
|
|
287
|
+
types?: string | null;
|
|
288
|
+
/** Include pieces with no planned date, capped per lane. */
|
|
289
|
+
include_unscheduled?: boolean;
|
|
290
|
+
};
|
|
291
|
+
headers?: {
|
|
292
|
+
"X-Target-Org-Id"?: string | null;
|
|
293
|
+
};
|
|
294
|
+
};
|
|
295
|
+
output: ApiResponse_StudioContentPayload_;
|
|
296
|
+
};
|
|
297
|
+
/**
|
|
298
|
+
* GET /content/grids/{grid_id}
|
|
299
|
+
* Get Content Grid
|
|
300
|
+
* tier: read · scope: campaigns:read
|
|
301
|
+
*/
|
|
302
|
+
get_content_grid_content_grids__grid_id__get: {
|
|
303
|
+
input: {
|
|
304
|
+
path: {
|
|
305
|
+
/** Content grid id. */
|
|
306
|
+
grid_id: string;
|
|
307
|
+
};
|
|
308
|
+
headers?: {
|
|
309
|
+
"X-Target-Org-Id"?: string | null;
|
|
310
|
+
};
|
|
311
|
+
};
|
|
312
|
+
output: ApiResponse_StudioContentPayload_;
|
|
313
|
+
};
|
|
314
|
+
/**
|
|
315
|
+
* GET /content/calendar/ideas/{idea_id}/evidence
|
|
316
|
+
* Get Content Idea Evidence
|
|
317
|
+
* tier: read · scope: campaigns:read
|
|
318
|
+
*/
|
|
319
|
+
get_content_idea_evidence_content_calendar_ideas__idea_id__evidence_get: {
|
|
320
|
+
input: {
|
|
321
|
+
path: {
|
|
322
|
+
/** Mined idea id. */
|
|
323
|
+
idea_id: string;
|
|
324
|
+
};
|
|
325
|
+
headers?: {
|
|
326
|
+
"X-Target-Org-Id"?: string | null;
|
|
327
|
+
};
|
|
328
|
+
};
|
|
329
|
+
output: ApiResponse_StudioContentListPayload_;
|
|
330
|
+
};
|
|
331
|
+
/**
|
|
332
|
+
* GET /content-workspace/import/status/{job_id}
|
|
333
|
+
* Get Content Import Status
|
|
334
|
+
* tier: read · scope: campaigns:read
|
|
335
|
+
*/
|
|
336
|
+
get_content_import_status_content_workspace_import_status__job_id__get: {
|
|
337
|
+
input: {
|
|
338
|
+
path: {
|
|
339
|
+
/** Import job id (UUID). */
|
|
340
|
+
job_id: string;
|
|
341
|
+
};
|
|
342
|
+
headers?: {
|
|
343
|
+
"X-Target-Org-Id"?: string | null;
|
|
344
|
+
};
|
|
345
|
+
};
|
|
346
|
+
output: ApiResponse_StudioContentPayload_;
|
|
347
|
+
};
|
|
348
|
+
/**
|
|
349
|
+
* GET /content/pages/{page_id}
|
|
350
|
+
* Get Content Page
|
|
351
|
+
* tier: read · scope: campaigns:read
|
|
352
|
+
*/
|
|
353
|
+
get_content_page_content_pages__page_id__get: {
|
|
354
|
+
input: {
|
|
355
|
+
path: {
|
|
356
|
+
/** Content page id. */
|
|
357
|
+
page_id: string;
|
|
358
|
+
};
|
|
359
|
+
headers?: {
|
|
360
|
+
"X-Target-Org-Id"?: string | null;
|
|
361
|
+
};
|
|
362
|
+
};
|
|
363
|
+
output: ApiResponse_StudioContentPayload_;
|
|
364
|
+
};
|
|
365
|
+
/**
|
|
366
|
+
* GET /content-workspace/seo-summary
|
|
367
|
+
* Get Content Seo Summary
|
|
368
|
+
* tier: read · scope: campaigns:read
|
|
369
|
+
*/
|
|
370
|
+
get_content_seo_summary_content_workspace_seo_summary_get: {
|
|
371
|
+
input: {
|
|
372
|
+
query?: {
|
|
373
|
+
/** One owned domain. Omit for all owned pages. */
|
|
374
|
+
domain?: string | null;
|
|
375
|
+
};
|
|
376
|
+
headers?: {
|
|
377
|
+
"X-Target-Org-Id"?: string | null;
|
|
378
|
+
};
|
|
379
|
+
};
|
|
380
|
+
output: ApiResponse_StudioContentPayload_;
|
|
381
|
+
};
|
|
382
|
+
/**
|
|
383
|
+
* GET /content/calendar/mine-signals/status
|
|
384
|
+
* Get Content Signal Mining Status
|
|
385
|
+
* tier: read · scope: campaigns:read
|
|
386
|
+
*/
|
|
387
|
+
get_content_signal_mining_status_content_calendar_mine_signals_status_get: {
|
|
388
|
+
input: {
|
|
389
|
+
headers?: {
|
|
390
|
+
"X-Target-Org-Id"?: string | null;
|
|
391
|
+
};
|
|
392
|
+
};
|
|
393
|
+
output: ApiResponse_StudioContentPayload_;
|
|
394
|
+
};
|
|
395
|
+
/**
|
|
396
|
+
* GET /content-workspace/pages/{page_id}
|
|
397
|
+
* Get Content Workspace Page
|
|
398
|
+
* tier: read · scope: campaigns:read
|
|
399
|
+
*/
|
|
400
|
+
get_content_workspace_page_content_workspace_pages__page_id__get: {
|
|
401
|
+
input: {
|
|
402
|
+
path: {
|
|
403
|
+
/** Content page id (UUID). */
|
|
404
|
+
page_id: string;
|
|
405
|
+
};
|
|
406
|
+
headers?: {
|
|
407
|
+
"X-Target-Org-Id"?: string | null;
|
|
408
|
+
};
|
|
409
|
+
};
|
|
410
|
+
output: ApiResponse_StudioContentPayload_;
|
|
411
|
+
};
|
|
412
|
+
/**
|
|
413
|
+
* GET /content/calendar/ideas/corpus-stats
|
|
414
|
+
* Get Idea Corpus Stats
|
|
415
|
+
* tier: read · scope: campaigns:read
|
|
416
|
+
*/
|
|
417
|
+
get_idea_corpus_stats_content_calendar_ideas_corpus_stats_get: {
|
|
418
|
+
input: {
|
|
419
|
+
headers?: {
|
|
420
|
+
"X-Target-Org-Id"?: string | null;
|
|
421
|
+
};
|
|
422
|
+
};
|
|
423
|
+
output: ApiResponse_StudioContentPayload_;
|
|
424
|
+
};
|
|
425
|
+
/**
|
|
426
|
+
* POST /content/pages/import-sitemap
|
|
427
|
+
* Import Content Pages From Sitemap
|
|
428
|
+
* tier: write · scope: campaigns:write
|
|
429
|
+
*/
|
|
430
|
+
import_content_pages_from_sitemap_content_pages_import_sitemap_post: {
|
|
431
|
+
input: {
|
|
432
|
+
headers?: {
|
|
433
|
+
"X-Target-Org-Id"?: string | null;
|
|
434
|
+
};
|
|
435
|
+
body: ImportSitemapRequest;
|
|
436
|
+
};
|
|
437
|
+
output: ApiResponse_StudioContentPayload_;
|
|
438
|
+
};
|
|
439
|
+
/**
|
|
440
|
+
* GET /content/calendar/approvals
|
|
441
|
+
* List Content Approval Shares
|
|
442
|
+
* tier: read · scope: campaigns:read
|
|
443
|
+
*/
|
|
444
|
+
list_content_approval_shares_content_calendar_approvals_get: {
|
|
445
|
+
input: {
|
|
446
|
+
headers?: {
|
|
447
|
+
"X-Target-Org-Id"?: string | null;
|
|
448
|
+
};
|
|
449
|
+
};
|
|
450
|
+
output: ApiResponse_StudioContentListPayload_;
|
|
451
|
+
};
|
|
452
|
+
/**
|
|
453
|
+
* GET /content/grids
|
|
454
|
+
* List Content Grids
|
|
455
|
+
* tier: read · scope: campaigns:read
|
|
456
|
+
*/
|
|
457
|
+
list_content_grids_content_grids_get: {
|
|
458
|
+
input: {
|
|
459
|
+
query?: {
|
|
460
|
+
/** Filter to one grid type. */
|
|
461
|
+
grid_type?: string | null;
|
|
462
|
+
};
|
|
463
|
+
headers?: {
|
|
464
|
+
"X-Target-Org-Id"?: string | null;
|
|
465
|
+
};
|
|
466
|
+
};
|
|
467
|
+
output: ApiResponse_StudioContentListPayload_;
|
|
468
|
+
};
|
|
469
|
+
/**
|
|
470
|
+
* GET /content/calendar/ideas
|
|
471
|
+
* List Content Ideas
|
|
472
|
+
* tier: read · scope: campaigns:read
|
|
473
|
+
*/
|
|
474
|
+
list_content_ideas_content_calendar_ideas_get: {
|
|
475
|
+
input: {
|
|
476
|
+
query?: {
|
|
477
|
+
/** List archived ideas instead of the active pool. */
|
|
478
|
+
archived?: boolean;
|
|
479
|
+
};
|
|
480
|
+
headers?: {
|
|
481
|
+
"X-Target-Org-Id"?: string | null;
|
|
482
|
+
};
|
|
483
|
+
};
|
|
484
|
+
output: ApiResponse_StudioContentListPayload_;
|
|
485
|
+
};
|
|
486
|
+
/**
|
|
487
|
+
* GET /content-workspace/import/jobs
|
|
488
|
+
* List Content Import Jobs
|
|
489
|
+
* tier: read · scope: campaigns:read
|
|
490
|
+
*/
|
|
491
|
+
list_content_import_jobs_content_workspace_import_jobs_get: {
|
|
492
|
+
input: {
|
|
493
|
+
query?: {
|
|
494
|
+
/** Only jobs in this status. */
|
|
495
|
+
status?: string | null;
|
|
496
|
+
limit?: number;
|
|
497
|
+
};
|
|
498
|
+
headers?: {
|
|
499
|
+
"X-Target-Org-Id"?: string | null;
|
|
500
|
+
};
|
|
501
|
+
};
|
|
502
|
+
output: ApiResponse_StudioContentListPayload_;
|
|
503
|
+
};
|
|
504
|
+
/**
|
|
505
|
+
* GET /content/pages
|
|
506
|
+
* List Content Pages
|
|
507
|
+
* tier: read · scope: campaigns:read
|
|
508
|
+
*/
|
|
509
|
+
list_content_pages_content_pages_get: {
|
|
510
|
+
input: {
|
|
511
|
+
query?: {
|
|
512
|
+
/** Only pages on this domain. */
|
|
513
|
+
domain?: string | null;
|
|
514
|
+
/** True for the org's own pages, false for tracked competitors'. */
|
|
515
|
+
is_owned?: boolean | null;
|
|
516
|
+
crawl_status?: string | null;
|
|
517
|
+
source?: string | null;
|
|
518
|
+
/** From `GET /content/types`. */
|
|
519
|
+
content_type?: string | null;
|
|
520
|
+
content_status?: string | null;
|
|
521
|
+
limit?: number;
|
|
522
|
+
offset?: number;
|
|
523
|
+
};
|
|
524
|
+
headers?: {
|
|
525
|
+
"X-Target-Org-Id"?: string | null;
|
|
526
|
+
};
|
|
527
|
+
};
|
|
528
|
+
output: ApiResponse_StudioContentListPayload_;
|
|
529
|
+
};
|
|
530
|
+
/**
|
|
531
|
+
* GET /content/types
|
|
532
|
+
* List Content Types
|
|
533
|
+
* tier: read · scope: campaigns:read
|
|
534
|
+
*/
|
|
535
|
+
list_content_types_content_types_get: {
|
|
536
|
+
input: {
|
|
537
|
+
headers?: {
|
|
538
|
+
"X-Target-Org-Id"?: string | null;
|
|
539
|
+
};
|
|
540
|
+
};
|
|
541
|
+
output: ApiResponse_StudioContentPayload_;
|
|
542
|
+
};
|
|
543
|
+
/**
|
|
544
|
+
* GET /content-workspace/pages
|
|
545
|
+
* List Content Workspace Pages
|
|
546
|
+
* tier: read · scope: campaigns:read
|
|
547
|
+
*/
|
|
548
|
+
list_content_workspace_pages_content_workspace_pages_get: {
|
|
549
|
+
input: {
|
|
550
|
+
query?: {
|
|
551
|
+
domain?: string | null;
|
|
552
|
+
refresh_status?: string | null;
|
|
553
|
+
intent?: string | null;
|
|
554
|
+
page_type?: string | null;
|
|
555
|
+
/** Only pages AI answer engines cite (or do not). */
|
|
556
|
+
llm_cited?: boolean | null;
|
|
557
|
+
ai_overview_present?: boolean | null;
|
|
558
|
+
/** Only pages one import brought in. */
|
|
559
|
+
import_job_id?: string | null;
|
|
560
|
+
search?: string | null;
|
|
561
|
+
page?: number;
|
|
562
|
+
page_size?: number;
|
|
563
|
+
/** Field to sort by. */
|
|
564
|
+
sort_by?: string;
|
|
565
|
+
sort_order?: string;
|
|
566
|
+
};
|
|
567
|
+
headers?: {
|
|
568
|
+
"X-Target-Org-Id"?: string | null;
|
|
569
|
+
};
|
|
570
|
+
};
|
|
571
|
+
output: ApiResponse_StudioContentListPayload_;
|
|
572
|
+
};
|
|
573
|
+
/**
|
|
574
|
+
* GET /content/website-templates
|
|
575
|
+
* List Website Templates
|
|
576
|
+
* tier: read · scope: campaigns:read
|
|
577
|
+
*/
|
|
578
|
+
list_website_templates_content_website_templates_get: {
|
|
579
|
+
input: {
|
|
580
|
+
query?: {
|
|
581
|
+
limit?: number;
|
|
582
|
+
};
|
|
583
|
+
headers?: {
|
|
584
|
+
"X-Target-Org-Id"?: string | null;
|
|
585
|
+
};
|
|
586
|
+
};
|
|
587
|
+
output: ApiResponse_StudioContentListPayload_;
|
|
588
|
+
};
|
|
589
|
+
/**
|
|
590
|
+
* POST /content/calendar/mine-signals
|
|
591
|
+
* Mine Content Signals
|
|
592
|
+
* tier: billable · scope: campaigns:run
|
|
593
|
+
*/
|
|
594
|
+
mine_content_signals_content_calendar_mine_signals_post: {
|
|
595
|
+
input: {
|
|
596
|
+
headers?: {
|
|
597
|
+
"X-Target-Org-Id"?: string | null;
|
|
598
|
+
};
|
|
599
|
+
body: MineSignalsRequest;
|
|
600
|
+
};
|
|
601
|
+
output: ApiResponse_StudioContentPayload_;
|
|
602
|
+
};
|
|
603
|
+
/**
|
|
604
|
+
* PATCH /content/calendar/ideas/{idea_id}
|
|
605
|
+
* Patch Content Idea
|
|
606
|
+
* tier: write · scope: campaigns:write
|
|
607
|
+
*/
|
|
608
|
+
patch_content_idea_content_calendar_ideas__idea_id__patch: {
|
|
609
|
+
input: {
|
|
610
|
+
path: {
|
|
611
|
+
/** Mined idea id. */
|
|
612
|
+
idea_id: string;
|
|
613
|
+
};
|
|
614
|
+
headers?: {
|
|
615
|
+
"X-Target-Org-Id"?: string | null;
|
|
616
|
+
};
|
|
617
|
+
body: PatchIdeaRequest;
|
|
618
|
+
};
|
|
619
|
+
output: ApiResponse_StudioContentPayload_;
|
|
620
|
+
};
|
|
621
|
+
/**
|
|
622
|
+
* POST /content/calendar/repurpose/ad
|
|
623
|
+
* Repurpose Content To Ad
|
|
624
|
+
* tier: billable · scope: campaigns:run
|
|
625
|
+
*/
|
|
626
|
+
repurpose_content_to_ad_content_calendar_repurpose_ad_post: {
|
|
627
|
+
input: {
|
|
628
|
+
headers?: {
|
|
629
|
+
"X-Target-Org-Id"?: string | null;
|
|
630
|
+
};
|
|
631
|
+
body: RepurposeAdRequest;
|
|
632
|
+
};
|
|
633
|
+
output: ApiResponse_StudioContentPayload_;
|
|
634
|
+
};
|
|
635
|
+
/**
|
|
636
|
+
* POST /content/calendar/repurpose/linkedin-post
|
|
637
|
+
* Repurpose Content To Linkedin Post
|
|
638
|
+
* tier: billable · scope: campaigns:run
|
|
639
|
+
*/
|
|
640
|
+
repurpose_content_to_linkedin_post_content_calendar_repurpose_linkedin_post_post: {
|
|
641
|
+
input: {
|
|
642
|
+
headers?: {
|
|
643
|
+
"X-Target-Org-Id"?: string | null;
|
|
644
|
+
};
|
|
645
|
+
body: RepurposeSourceRequest;
|
|
646
|
+
};
|
|
647
|
+
output: ApiResponse_StudioContentPayload_;
|
|
648
|
+
};
|
|
649
|
+
/**
|
|
650
|
+
* POST /content/calendar/{content_type}/{content_id}/retry-publish
|
|
651
|
+
* Retry Content Publish
|
|
652
|
+
* tier: external · scope: campaigns:run
|
|
653
|
+
*/
|
|
654
|
+
retry_content_publish_content_calendar__content_type___content_id__retry_publish_post: {
|
|
655
|
+
input: {
|
|
656
|
+
path: {
|
|
657
|
+
/** Which content lane the piece lives in. */
|
|
658
|
+
content_type: "newsletter_issue" | "landing_page" | "seo_page" | "linkedin_post" | "ad_creative";
|
|
659
|
+
/** Id of the piece within that lane. */
|
|
660
|
+
content_id: string;
|
|
661
|
+
};
|
|
662
|
+
headers?: {
|
|
663
|
+
"X-Target-Org-Id"?: string | null;
|
|
664
|
+
};
|
|
665
|
+
};
|
|
666
|
+
output: ApiResponse_StudioContentPayload_;
|
|
667
|
+
};
|
|
668
|
+
/**
|
|
669
|
+
* PATCH /content/calendar/{content_type}/{content_id}/schedule
|
|
670
|
+
* Schedule Content Piece
|
|
671
|
+
* tier: external · scope: campaigns:run
|
|
672
|
+
*/
|
|
673
|
+
schedule_content_piece_content_calendar__content_type___content_id__schedule_patch: {
|
|
674
|
+
input: {
|
|
675
|
+
path: {
|
|
676
|
+
/** Which content lane the piece lives in. */
|
|
677
|
+
content_type: "newsletter_issue" | "landing_page" | "seo_page" | "linkedin_post" | "ad_creative";
|
|
678
|
+
/** Id of the piece within that lane. */
|
|
679
|
+
content_id: string;
|
|
680
|
+
};
|
|
681
|
+
headers?: {
|
|
682
|
+
"X-Target-Org-Id"?: string | null;
|
|
683
|
+
};
|
|
684
|
+
body: ScheduleRequest;
|
|
685
|
+
};
|
|
686
|
+
output: ApiResponse_StudioContentPayload_;
|
|
687
|
+
};
|
|
688
|
+
/**
|
|
689
|
+
* POST /content-workspace/import/crawl
|
|
690
|
+
* Start Content Crawl Import
|
|
691
|
+
* tier: billable · scope: campaigns:run
|
|
692
|
+
*/
|
|
693
|
+
start_content_crawl_import_content_workspace_import_crawl_post: {
|
|
694
|
+
input: {
|
|
695
|
+
headers?: {
|
|
696
|
+
"X-Target-Org-Id"?: string | null;
|
|
697
|
+
};
|
|
698
|
+
body: ContentWorkspaceCrawlRequest;
|
|
699
|
+
};
|
|
700
|
+
output: ApiResponse_StudioContentPayload_;
|
|
701
|
+
};
|
|
702
|
+
/**
|
|
703
|
+
* POST /content-workspace/import/sitemap
|
|
704
|
+
* Start Content Sitemap Import
|
|
705
|
+
* tier: write · scope: campaigns:write
|
|
706
|
+
*/
|
|
707
|
+
start_content_sitemap_import_content_workspace_import_sitemap_post: {
|
|
708
|
+
input: {
|
|
709
|
+
headers?: {
|
|
710
|
+
"X-Target-Org-Id"?: string | null;
|
|
711
|
+
};
|
|
712
|
+
body: ContentWorkspaceSitemapImportRequest;
|
|
713
|
+
};
|
|
714
|
+
output: ApiResponse_StudioContentPayload_;
|
|
715
|
+
};
|
|
716
|
+
/**
|
|
717
|
+
* PATCH /content/pages/{page_id}
|
|
718
|
+
* Update Content Page
|
|
719
|
+
* tier: write · scope: campaigns:write
|
|
720
|
+
*/
|
|
721
|
+
update_content_page_content_pages__page_id__patch: {
|
|
722
|
+
input: {
|
|
723
|
+
path: {
|
|
724
|
+
/** Content page id. */
|
|
725
|
+
page_id: string;
|
|
726
|
+
};
|
|
727
|
+
headers?: {
|
|
728
|
+
"X-Target-Org-Id"?: string | null;
|
|
729
|
+
};
|
|
730
|
+
body: UpdatePageRequest;
|
|
731
|
+
};
|
|
732
|
+
output: ApiResponse_StudioContentPayload_;
|
|
733
|
+
};
|
|
734
|
+
/**
|
|
735
|
+
* PATCH /content-workspace/pages/{page_id}
|
|
736
|
+
* Update Content Workspace Page
|
|
737
|
+
* tier: write · scope: campaigns:write
|
|
738
|
+
*/
|
|
739
|
+
update_content_workspace_page_content_workspace_pages__page_id__patch: {
|
|
740
|
+
input: {
|
|
741
|
+
path: {
|
|
742
|
+
/** Content page id (UUID). */
|
|
743
|
+
page_id: string;
|
|
744
|
+
};
|
|
745
|
+
headers?: {
|
|
746
|
+
"X-Target-Org-Id"?: string | null;
|
|
747
|
+
};
|
|
748
|
+
body: ContentWorkspacePageUpdateRequest;
|
|
749
|
+
};
|
|
750
|
+
output: ApiResponse_StudioContentPayload_;
|
|
751
|
+
};
|
|
752
|
+
}
|
|
753
|
+
|
|
754
|
+
// 21 schemas referenced above (the same as G8Contract.<Name>).
|
|
755
|
+
|
|
756
|
+
/** Add one job to a grid. Spends nothing until the job is run. */
|
|
757
|
+
export interface AddRowRequest {
|
|
758
|
+
author_team_member_id?: string | null;
|
|
759
|
+
job_type: string;
|
|
760
|
+
original_body?: string | null;
|
|
761
|
+
original_meta?: string | null;
|
|
762
|
+
original_title?: string | null;
|
|
763
|
+
source_url?: string | null;
|
|
764
|
+
target_keyword?: string | null;
|
|
765
|
+
}
|
|
766
|
+
|
|
767
|
+
export interface ApiResponse_StudioContentListPayload_ {
|
|
768
|
+
data: StudioContentListPayload;
|
|
769
|
+
pagination?: PaginationMeta | null;
|
|
770
|
+
}
|
|
771
|
+
|
|
772
|
+
export interface ApiResponse_StudioContentPayload_ {
|
|
773
|
+
data: StudioContentPayload;
|
|
774
|
+
pagination?: PaginationMeta | null;
|
|
775
|
+
}
|
|
776
|
+
|
|
777
|
+
/** Deep-crawl the org's OWN website. SPENDS PROVIDER CREDIT, per page crawled. */
|
|
778
|
+
export interface ContentWorkspaceCrawlRequest {
|
|
779
|
+
/** e.g. ['/author', '/tag']. */
|
|
780
|
+
exclude_paths?: Array<string> | null;
|
|
781
|
+
/** e.g. ['/blog', '/resources']. */
|
|
782
|
+
include_paths?: Array<string> | null;
|
|
783
|
+
/** The ceiling on pages crawled - and on the spend. */
|
|
784
|
+
max_pages?: number;
|
|
785
|
+
/** Must be on the org's registered website. */
|
|
786
|
+
start_url: string;
|
|
787
|
+
}
|
|
788
|
+
|
|
789
|
+
/** Partial update of a page's SEO-refresh planning fields. */
|
|
790
|
+
export interface ContentWorkspacePageUpdateRequest {
|
|
791
|
+
intent?: string | null;
|
|
792
|
+
key_issues?: string | null;
|
|
793
|
+
owner_id?: string | null;
|
|
794
|
+
page_type?: string | null;
|
|
795
|
+
planned_changes?: string | null;
|
|
796
|
+
primary_keyword?: string | null;
|
|
797
|
+
primary_topic?: string | null;
|
|
798
|
+
refresh_scope?: string | null;
|
|
799
|
+
refresh_status?: string | null;
|
|
800
|
+
}
|
|
801
|
+
|
|
802
|
+
/** Import the pages listed in an XML sitemap. */
|
|
803
|
+
export interface ContentWorkspaceSitemapImportRequest {
|
|
804
|
+
/** Glob patterns to exclude. */
|
|
805
|
+
exclude_patterns?: Array<string> | null;
|
|
806
|
+
/** Glob patterns to include. */
|
|
807
|
+
include_patterns?: Array<string> | null;
|
|
808
|
+
max_pages?: number;
|
|
809
|
+
sitemap_url: string;
|
|
810
|
+
}
|
|
811
|
+
|
|
812
|
+
/**
|
|
813
|
+
* Mint a tokenised approval link for a piece. Spends nothing.
|
|
814
|
+
*
|
|
815
|
+
* The link is a BEARER URL: anyone holding it can approve or reject the
|
|
816
|
+
* piece without a graph8 login. That is the point - it goes to a client -
|
|
817
|
+
* but it means the expiry is the only thing bounding it.
|
|
818
|
+
*/
|
|
819
|
+
export interface CreateApprovalShareRequest {
|
|
820
|
+
content_id: string;
|
|
821
|
+
content_type: string;
|
|
822
|
+
expires_in_days?: number;
|
|
823
|
+
}
|
|
824
|
+
|
|
825
|
+
/** Turn a mined idea into a draft. SPENDS CREDIT, immediately. */
|
|
826
|
+
export interface CreateFromIdeaRequest {
|
|
827
|
+
format: "landing_page" | "linkedin_post" | "ad_creative" | "newsletter_section";
|
|
828
|
+
}
|
|
829
|
+
|
|
830
|
+
/** Create a content grid - a batch of content jobs. Spends nothing itself. */
|
|
831
|
+
export interface CreateGridRequest {
|
|
832
|
+
grid_type: string;
|
|
833
|
+
name: string;
|
|
834
|
+
workflow_config?: Record<string, unknown> | null;
|
|
835
|
+
}
|
|
836
|
+
|
|
837
|
+
/** Add one page to the content inventory. Spends nothing. */
|
|
838
|
+
export interface CreatePageRequest {
|
|
839
|
+
content_status?: string | null;
|
|
840
|
+
content_type?: string | null;
|
|
841
|
+
is_owned?: boolean;
|
|
842
|
+
title?: string | null;
|
|
843
|
+
url: string;
|
|
844
|
+
}
|
|
845
|
+
|
|
846
|
+
/**
|
|
847
|
+
* Bulk SEO enrichment. SPENDS PROVIDER CREDIT, once per page.
|
|
848
|
+
*
|
|
849
|
+
* Omit `page_ids` to take the next `limit` un-enriched pages. `limit` is the
|
|
850
|
+
* ceiling on the spend, so send it deliberately rather than by default.
|
|
851
|
+
*/
|
|
852
|
+
export interface EnrichSeoBulkRequest {
|
|
853
|
+
/** Maximum pages enriched, and therefore the maximum spend. */
|
|
854
|
+
limit?: number;
|
|
855
|
+
page_ids?: Array<string> | null;
|
|
856
|
+
}
|
|
857
|
+
|
|
858
|
+
/**
|
|
859
|
+
* Import pages from a sitemap. Fetches the sitemap; spends no credit.
|
|
860
|
+
*
|
|
861
|
+
* The two filters are substring matches applied to each discovered URL.
|
|
862
|
+
*/
|
|
863
|
+
export interface ImportSitemapRequest {
|
|
864
|
+
sitemap_url: string;
|
|
865
|
+
url_must_contain?: Array<string> | null;
|
|
866
|
+
url_must_not_contain?: Array<string> | null;
|
|
867
|
+
}
|
|
868
|
+
|
|
869
|
+
/**
|
|
870
|
+
* Mine conversations for content ideas. SPENDS CREDIT, per conversation.
|
|
871
|
+
*
|
|
872
|
+
* The cost scales with `lookback_days` and the size of the corpus it
|
|
873
|
+
* selects - check `GET /content/calendar/ideas/corpus-stats` first, which is
|
|
874
|
+
* free and tells you how many conversations each lookback tier covers.
|
|
875
|
+
*
|
|
876
|
+
* `include_archived` TRUE (the app's default) lets a previously dismissed
|
|
877
|
+
* theme resurface; false is "fresh only".
|
|
878
|
+
*/
|
|
879
|
+
export interface MineSignalsRequest {
|
|
880
|
+
focus?: string | null;
|
|
881
|
+
include_archived?: boolean;
|
|
882
|
+
lookback_days?: number;
|
|
883
|
+
max_ideas?: number;
|
|
884
|
+
/** Which corpora to mine. Closed to the two the app accepts - it rejects anything else, and an unknown value would otherwise mine an empty corpus at full price. */
|
|
885
|
+
sources?: Array<"meetings" | "emails">;
|
|
886
|
+
target_format?: ("landing_page" | "linkedin_post" | "newsletter_section" | "ad_creative") | null;
|
|
887
|
+
}
|
|
888
|
+
|
|
889
|
+
export interface PaginationMeta {
|
|
890
|
+
/** Whether there are more pages */
|
|
891
|
+
has_next: boolean;
|
|
892
|
+
/** Items per page */
|
|
893
|
+
limit: number;
|
|
894
|
+
/** 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. */
|
|
895
|
+
next_cursor?: string | null;
|
|
896
|
+
/** Current page number (1-indexed) */
|
|
897
|
+
page: number;
|
|
898
|
+
/** Total number of items */
|
|
899
|
+
total: number;
|
|
900
|
+
}
|
|
901
|
+
|
|
902
|
+
/**
|
|
903
|
+
* Card actions on a mined idea. Spends nothing.
|
|
904
|
+
*
|
|
905
|
+
* PARTIAL: an absent field is untouched, a field sent as NULL is CLEARED.
|
|
906
|
+
* Those are different instructions and only the second one erases.
|
|
907
|
+
*/
|
|
908
|
+
export interface PatchIdeaRequest {
|
|
909
|
+
rating?: number | null;
|
|
910
|
+
scheduled_for?: string | null;
|
|
911
|
+
status?: ("new" | "saved") | null;
|
|
912
|
+
}
|
|
913
|
+
|
|
914
|
+
/** Derive an ad creative from an existing piece. SPENDS CREDIT. */
|
|
915
|
+
export interface RepurposeAdRequest {
|
|
916
|
+
ad_format?: string;
|
|
917
|
+
platform?: string;
|
|
918
|
+
source_id: string;
|
|
919
|
+
source_type: string;
|
|
920
|
+
}
|
|
921
|
+
|
|
922
|
+
/** Derive a LinkedIn post from an existing piece. SPENDS CREDIT. */
|
|
923
|
+
export interface RepurposeSourceRequest {
|
|
924
|
+
source_id: string;
|
|
925
|
+
source_type: string;
|
|
926
|
+
}
|
|
927
|
+
|
|
928
|
+
/**
|
|
929
|
+
* Place a piece on the calendar, or ARM it to publish itself.
|
|
930
|
+
*
|
|
931
|
+
* `arm` is the consequential field: false plans the date for a human, true
|
|
932
|
+
* hands it to the publish sweep, which will put the piece in front of real
|
|
933
|
+
* people at `planned_publish_at` with no further confirmation.
|
|
934
|
+
*/
|
|
935
|
+
export interface ScheduleRequest {
|
|
936
|
+
/** TRUE MEANS IT WILL PUBLISH ITSELF at planned_publish_at, with no further human step. False only records the date. */
|
|
937
|
+
arm?: boolean;
|
|
938
|
+
clear_planned?: boolean;
|
|
939
|
+
owner_id?: string | null;
|
|
940
|
+
planned_publish_at?: string | null;
|
|
941
|
+
publish_settings?: Record<string, unknown> | null;
|
|
942
|
+
}
|
|
943
|
+
|
|
944
|
+
/**
|
|
945
|
+
* A LIST result, open-shaped, with `items` always present.
|
|
946
|
+
*
|
|
947
|
+
* The app returns a bare list from some routes and a named key from others
|
|
948
|
+
* (`pages`, `grids`, `images`, `creatives`, `reports`, `items`). Both are
|
|
949
|
+
* published: the original key is preserved AND mirrored onto `items`, so a
|
|
950
|
+
* client can page any Studio collection the same way without a per-route
|
|
951
|
+
* lookup table.
|
|
952
|
+
*/
|
|
953
|
+
export interface StudioContentListPayload {
|
|
954
|
+
items?: Array<unknown>;
|
|
955
|
+
[key: string]: unknown;
|
|
956
|
+
}
|
|
957
|
+
|
|
958
|
+
/** One Studio object, open-shaped. See the module docstring. */
|
|
959
|
+
export type StudioContentPayload = Record<string, unknown>;
|
|
960
|
+
|
|
961
|
+
/** Edit an inventory page. Spends nothing. */
|
|
962
|
+
export interface UpdatePageRequest {
|
|
963
|
+
body_content?: string | null;
|
|
964
|
+
content_status?: string | null;
|
|
965
|
+
content_type?: string | null;
|
|
966
|
+
primary_keyword?: string | null;
|
|
967
|
+
title?: string | null;
|
|
968
|
+
}
|