@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,824 @@
|
|
|
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.socialPublishing` (Social Publishing): 22 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_social_engagers_to_audience_social_posts__post_id__engagers_add_to_audience_post">;
|
|
9
|
+
*
|
|
10
|
+
* Reference with examples: socialPublishing.md
|
|
11
|
+
*/
|
|
12
|
+
/* eslint-disable */
|
|
13
|
+
|
|
14
|
+
/** `g8.api.socialPublishing.<member>` -> the operationId it calls. */
|
|
15
|
+
export interface SocialPublishingMembers {
|
|
16
|
+
addSocialEngagersToAudience: "add_social_engagers_to_audience_social_posts__post_id__engagers_add_to_audience_post";
|
|
17
|
+
cancelSocialPost: "cancel_social_post_social_posts__post_id__cancel_post";
|
|
18
|
+
createSocialPost: "create_social_post_social_posts_post";
|
|
19
|
+
deleteSocialPost: "delete_social_post_social_posts__post_id__delete";
|
|
20
|
+
disconnectSocialAccount: "disconnect_social_account_social_accounts__account_id__delete";
|
|
21
|
+
enrollSocialEngagers: "enroll_social_engagers_social_posts__post_id__engagers_enroll_post";
|
|
22
|
+
generateSocialPost: "generate_social_post_social_posts_generate_post";
|
|
23
|
+
getSocialAnalytics: "get_social_analytics_social_analytics_get";
|
|
24
|
+
getSocialAutopilot: "get_social_autopilot_social_autopilot__account_id__get";
|
|
25
|
+
getSocialGenerationContext: "get_social_generation_context_social_generate_context_get";
|
|
26
|
+
getSocialPost: "get_social_post_social_posts__post_id__get";
|
|
27
|
+
getSocialPostMetrics: "get_social_post_metrics_social_posts__post_id__metrics_get";
|
|
28
|
+
listSocialAccounts: "list_social_accounts_social_accounts_get";
|
|
29
|
+
listSocialIdeas: "list_social_ideas_social_ideas_get";
|
|
30
|
+
listSocialPostEngagers: "list_social_post_engagers_social_posts__post_id__engagers_get";
|
|
31
|
+
listSocialPosts: "list_social_posts_social_posts_get";
|
|
32
|
+
listSocialProviders: "list_social_providers_social_providers_get";
|
|
33
|
+
pauseSocialAutopilot: "pause_social_autopilot_social_autopilot__account_id__pause_post";
|
|
34
|
+
publishSocialPost: "publish_social_post_social_posts__post_id__publish_post";
|
|
35
|
+
saveSocialAutopilot: "save_social_autopilot_social_autopilot__account_id__put";
|
|
36
|
+
scheduleSocialPost: "schedule_social_post_social_posts__post_id__schedule_post";
|
|
37
|
+
updateSocialPost: "update_social_post_social_posts__post_id__patch";
|
|
38
|
+
}
|
|
39
|
+
|
|
40
|
+
/** Input and output of every `g8.api.socialPublishing` operation, keyed by operationId. */
|
|
41
|
+
export interface SocialPublishingOperations {
|
|
42
|
+
/**
|
|
43
|
+
* POST /social/posts/{post_id}/engagers/add-to-audience
|
|
44
|
+
* Add Social Engagers To Audience
|
|
45
|
+
* tier: external · scope: campaigns:run
|
|
46
|
+
*/
|
|
47
|
+
add_social_engagers_to_audience_social_posts__post_id__engagers_add_to_audience_post: {
|
|
48
|
+
input: {
|
|
49
|
+
path: {
|
|
50
|
+
/** The post's id. */
|
|
51
|
+
post_id: string;
|
|
52
|
+
};
|
|
53
|
+
headers?: {
|
|
54
|
+
"X-Target-Org-Id"?: string | null;
|
|
55
|
+
};
|
|
56
|
+
body: SocialAudienceFromEngagersRequest;
|
|
57
|
+
};
|
|
58
|
+
output: ApiResponse_SocialAudienceFromEngagers_;
|
|
59
|
+
};
|
|
60
|
+
/**
|
|
61
|
+
* POST /social/posts/{post_id}/cancel
|
|
62
|
+
* Cancel Social Post
|
|
63
|
+
* tier: destructive · scope: campaigns:delete
|
|
64
|
+
*/
|
|
65
|
+
cancel_social_post_social_posts__post_id__cancel_post: {
|
|
66
|
+
input: {
|
|
67
|
+
path: {
|
|
68
|
+
/** The post's id. */
|
|
69
|
+
post_id: string;
|
|
70
|
+
};
|
|
71
|
+
headers?: {
|
|
72
|
+
"X-Target-Org-Id"?: string | null;
|
|
73
|
+
};
|
|
74
|
+
};
|
|
75
|
+
output: ApiResponse_SocialPost_;
|
|
76
|
+
};
|
|
77
|
+
/**
|
|
78
|
+
* POST /social/posts
|
|
79
|
+
* Create Social Post
|
|
80
|
+
* tier: write · scope: campaigns:write
|
|
81
|
+
*/
|
|
82
|
+
create_social_post_social_posts_post: {
|
|
83
|
+
input: {
|
|
84
|
+
headers?: {
|
|
85
|
+
"X-Target-Org-Id"?: string | null;
|
|
86
|
+
};
|
|
87
|
+
body: SocialPostCreateRequest;
|
|
88
|
+
};
|
|
89
|
+
output: ApiResponse_SocialPost_;
|
|
90
|
+
};
|
|
91
|
+
/**
|
|
92
|
+
* DELETE /social/posts/{post_id}
|
|
93
|
+
* Delete Social Post
|
|
94
|
+
* tier: destructive · scope: campaigns:delete
|
|
95
|
+
*/
|
|
96
|
+
delete_social_post_social_posts__post_id__delete: {
|
|
97
|
+
input: {
|
|
98
|
+
path: {
|
|
99
|
+
/** The post's id. */
|
|
100
|
+
post_id: string;
|
|
101
|
+
};
|
|
102
|
+
headers?: {
|
|
103
|
+
"X-Target-Org-Id"?: string | null;
|
|
104
|
+
};
|
|
105
|
+
};
|
|
106
|
+
output: ApiResponse_SocialDeleted_;
|
|
107
|
+
};
|
|
108
|
+
/**
|
|
109
|
+
* DELETE /social/accounts/{account_id}
|
|
110
|
+
* Disconnect Social Account
|
|
111
|
+
* tier: destructive · scope: campaigns:delete
|
|
112
|
+
*/
|
|
113
|
+
disconnect_social_account_social_accounts__account_id__delete: {
|
|
114
|
+
input: {
|
|
115
|
+
path: {
|
|
116
|
+
/** An `id` from `GET /social/accounts`. */
|
|
117
|
+
account_id: string;
|
|
118
|
+
};
|
|
119
|
+
headers?: {
|
|
120
|
+
"X-Target-Org-Id"?: string | null;
|
|
121
|
+
};
|
|
122
|
+
};
|
|
123
|
+
output: ApiResponse_SocialDeleted_;
|
|
124
|
+
};
|
|
125
|
+
/**
|
|
126
|
+
* POST /social/posts/{post_id}/engagers/enroll
|
|
127
|
+
* Enroll Social Engagers
|
|
128
|
+
* tier: external · scope: campaigns:run
|
|
129
|
+
*/
|
|
130
|
+
enroll_social_engagers_social_posts__post_id__engagers_enroll_post: {
|
|
131
|
+
input: {
|
|
132
|
+
path: {
|
|
133
|
+
/** The post's id. */
|
|
134
|
+
post_id: string;
|
|
135
|
+
};
|
|
136
|
+
headers?: {
|
|
137
|
+
"X-Target-Org-Id"?: string | null;
|
|
138
|
+
};
|
|
139
|
+
body: SocialEnrollEngagersRequest;
|
|
140
|
+
};
|
|
141
|
+
output: ApiResponse_SocialEnrollResult_;
|
|
142
|
+
};
|
|
143
|
+
/**
|
|
144
|
+
* POST /social/posts/generate
|
|
145
|
+
* Generate Social Post
|
|
146
|
+
* tier: billable · scope: campaigns:run
|
|
147
|
+
*/
|
|
148
|
+
generate_social_post_social_posts_generate_post: {
|
|
149
|
+
input: {
|
|
150
|
+
headers?: {
|
|
151
|
+
"X-Target-Org-Id"?: string | null;
|
|
152
|
+
};
|
|
153
|
+
body: SocialPostGenerateRequest;
|
|
154
|
+
};
|
|
155
|
+
output: ApiResponse_SocialGenerated_;
|
|
156
|
+
};
|
|
157
|
+
/**
|
|
158
|
+
* GET /social/analytics
|
|
159
|
+
* Get Social Analytics
|
|
160
|
+
* tier: read · scope: campaigns:read
|
|
161
|
+
*/
|
|
162
|
+
get_social_analytics_social_analytics_get: {
|
|
163
|
+
input: {
|
|
164
|
+
query?: {
|
|
165
|
+
/** Window, in days back from today. */
|
|
166
|
+
days?: number;
|
|
167
|
+
};
|
|
168
|
+
headers?: {
|
|
169
|
+
"X-Target-Org-Id"?: string | null;
|
|
170
|
+
};
|
|
171
|
+
};
|
|
172
|
+
output: ApiResponse_SocialAnalytics_;
|
|
173
|
+
};
|
|
174
|
+
/**
|
|
175
|
+
* GET /social/autopilot/{account_id}
|
|
176
|
+
* Get Social Autopilot
|
|
177
|
+
* tier: read · scope: campaigns:read
|
|
178
|
+
*/
|
|
179
|
+
get_social_autopilot_social_autopilot__account_id__get: {
|
|
180
|
+
input: {
|
|
181
|
+
path: {
|
|
182
|
+
/** An `id` from `GET /social/accounts`. */
|
|
183
|
+
account_id: string;
|
|
184
|
+
};
|
|
185
|
+
headers?: {
|
|
186
|
+
"X-Target-Org-Id"?: string | null;
|
|
187
|
+
};
|
|
188
|
+
};
|
|
189
|
+
output: ApiResponse_SocialAutopilot_;
|
|
190
|
+
};
|
|
191
|
+
/**
|
|
192
|
+
* GET /social/generate/context
|
|
193
|
+
* Get Social Generation Context
|
|
194
|
+
* tier: read · scope: campaigns:read
|
|
195
|
+
*/
|
|
196
|
+
get_social_generation_context_social_generate_context_get: {
|
|
197
|
+
input: {
|
|
198
|
+
headers?: {
|
|
199
|
+
"X-Target-Org-Id"?: string | null;
|
|
200
|
+
};
|
|
201
|
+
};
|
|
202
|
+
output: ApiResponse_SocialGenerationContext_;
|
|
203
|
+
};
|
|
204
|
+
/**
|
|
205
|
+
* GET /social/posts/{post_id}
|
|
206
|
+
* Get Social Post
|
|
207
|
+
* tier: read · scope: campaigns:read
|
|
208
|
+
*/
|
|
209
|
+
get_social_post_social_posts__post_id__get: {
|
|
210
|
+
input: {
|
|
211
|
+
path: {
|
|
212
|
+
/** The post's id. */
|
|
213
|
+
post_id: string;
|
|
214
|
+
};
|
|
215
|
+
headers?: {
|
|
216
|
+
"X-Target-Org-Id"?: string | null;
|
|
217
|
+
};
|
|
218
|
+
};
|
|
219
|
+
output: ApiResponse_SocialPost_;
|
|
220
|
+
};
|
|
221
|
+
/**
|
|
222
|
+
* GET /social/posts/{post_id}/metrics
|
|
223
|
+
* Get Social Post Metrics
|
|
224
|
+
* tier: read · scope: campaigns:read
|
|
225
|
+
*/
|
|
226
|
+
get_social_post_metrics_social_posts__post_id__metrics_get: {
|
|
227
|
+
input: {
|
|
228
|
+
path: {
|
|
229
|
+
/** The post's id. */
|
|
230
|
+
post_id: string;
|
|
231
|
+
};
|
|
232
|
+
headers?: {
|
|
233
|
+
"X-Target-Org-Id"?: string | null;
|
|
234
|
+
};
|
|
235
|
+
};
|
|
236
|
+
output: ApiResponse_SocialPostMetrics_;
|
|
237
|
+
};
|
|
238
|
+
/**
|
|
239
|
+
* GET /social/accounts
|
|
240
|
+
* List Social Accounts
|
|
241
|
+
* tier: read · scope: campaigns:read
|
|
242
|
+
*/
|
|
243
|
+
list_social_accounts_social_accounts_get: {
|
|
244
|
+
input: {
|
|
245
|
+
headers?: {
|
|
246
|
+
"X-Target-Org-Id"?: string | null;
|
|
247
|
+
};
|
|
248
|
+
};
|
|
249
|
+
output: ApiResponse_SocialAccountList_;
|
|
250
|
+
};
|
|
251
|
+
/**
|
|
252
|
+
* GET /social/ideas
|
|
253
|
+
* List Social Ideas
|
|
254
|
+
* tier: read · scope: campaigns:read
|
|
255
|
+
*/
|
|
256
|
+
list_social_ideas_social_ideas_get: {
|
|
257
|
+
input: {
|
|
258
|
+
query?: {
|
|
259
|
+
/** Only ideas from this source. */
|
|
260
|
+
source?: ("signal_mining" | "linkedin_trending" | "proof_freshness" | "repurpose" | "ai") | null;
|
|
261
|
+
/** Mine fresh ideas before answering. */
|
|
262
|
+
refresh?: boolean;
|
|
263
|
+
};
|
|
264
|
+
headers?: {
|
|
265
|
+
"X-Target-Org-Id"?: string | null;
|
|
266
|
+
};
|
|
267
|
+
};
|
|
268
|
+
output: ApiResponse_SocialIdeas_;
|
|
269
|
+
};
|
|
270
|
+
/**
|
|
271
|
+
* GET /social/posts/{post_id}/engagers
|
|
272
|
+
* List Social Post Engagers
|
|
273
|
+
* tier: read · scope: campaigns:read
|
|
274
|
+
*/
|
|
275
|
+
list_social_post_engagers_social_posts__post_id__engagers_get: {
|
|
276
|
+
input: {
|
|
277
|
+
path: {
|
|
278
|
+
/** The post's id. */
|
|
279
|
+
post_id: string;
|
|
280
|
+
};
|
|
281
|
+
query?: {
|
|
282
|
+
/** Fetch fresh from the network instead of the stored copy. */
|
|
283
|
+
refresh?: boolean;
|
|
284
|
+
};
|
|
285
|
+
headers?: {
|
|
286
|
+
"X-Target-Org-Id"?: string | null;
|
|
287
|
+
};
|
|
288
|
+
};
|
|
289
|
+
output: ApiResponse_SocialEngagers_;
|
|
290
|
+
};
|
|
291
|
+
/**
|
|
292
|
+
* GET /social/posts
|
|
293
|
+
* List Social Posts
|
|
294
|
+
* tier: read · scope: campaigns:read
|
|
295
|
+
*/
|
|
296
|
+
list_social_posts_social_posts_get: {
|
|
297
|
+
input: {
|
|
298
|
+
query?: {
|
|
299
|
+
/** Only posts in this state. */
|
|
300
|
+
status?: ("draft" | "ready" | "scheduled" | "publishing" | "live" | "failed" | "cancelled") | null;
|
|
301
|
+
page?: number;
|
|
302
|
+
page_size?: number;
|
|
303
|
+
};
|
|
304
|
+
headers?: {
|
|
305
|
+
"X-Target-Org-Id"?: string | null;
|
|
306
|
+
};
|
|
307
|
+
};
|
|
308
|
+
output: ApiResponse_SocialPostPage_;
|
|
309
|
+
};
|
|
310
|
+
/**
|
|
311
|
+
* GET /social/providers
|
|
312
|
+
* List Social Providers
|
|
313
|
+
* tier: read · scope: campaigns:read
|
|
314
|
+
*/
|
|
315
|
+
list_social_providers_social_providers_get: {
|
|
316
|
+
input: {
|
|
317
|
+
headers?: {
|
|
318
|
+
"X-Target-Org-Id"?: string | null;
|
|
319
|
+
};
|
|
320
|
+
};
|
|
321
|
+
output: ApiResponse_SocialProviderList_;
|
|
322
|
+
};
|
|
323
|
+
/**
|
|
324
|
+
* POST /social/autopilot/{account_id}/pause
|
|
325
|
+
* Pause Social Autopilot
|
|
326
|
+
* tier: write · scope: campaigns:write
|
|
327
|
+
*/
|
|
328
|
+
pause_social_autopilot_social_autopilot__account_id__pause_post: {
|
|
329
|
+
input: {
|
|
330
|
+
path: {
|
|
331
|
+
/** An `id` from `GET /social/accounts`. */
|
|
332
|
+
account_id: string;
|
|
333
|
+
};
|
|
334
|
+
headers?: {
|
|
335
|
+
"X-Target-Org-Id"?: string | null;
|
|
336
|
+
};
|
|
337
|
+
};
|
|
338
|
+
output: ApiResponse_SocialAutopilot_;
|
|
339
|
+
};
|
|
340
|
+
/**
|
|
341
|
+
* POST /social/posts/{post_id}/publish
|
|
342
|
+
* Publish Social Post
|
|
343
|
+
* tier: external · scope: campaigns:run
|
|
344
|
+
*/
|
|
345
|
+
publish_social_post_social_posts__post_id__publish_post: {
|
|
346
|
+
input: {
|
|
347
|
+
path: {
|
|
348
|
+
/** The post's id. */
|
|
349
|
+
post_id: string;
|
|
350
|
+
};
|
|
351
|
+
headers?: {
|
|
352
|
+
"X-Target-Org-Id"?: string | null;
|
|
353
|
+
};
|
|
354
|
+
};
|
|
355
|
+
output: ApiResponse_SocialPublishAccepted_;
|
|
356
|
+
};
|
|
357
|
+
/**
|
|
358
|
+
* PUT /social/autopilot/{account_id}
|
|
359
|
+
* Save Social Autopilot
|
|
360
|
+
* tier: external · scope: campaigns:run
|
|
361
|
+
*/
|
|
362
|
+
save_social_autopilot_social_autopilot__account_id__put: {
|
|
363
|
+
input: {
|
|
364
|
+
path: {
|
|
365
|
+
/** An `id` from `GET /social/accounts`. */
|
|
366
|
+
account_id: string;
|
|
367
|
+
};
|
|
368
|
+
headers?: {
|
|
369
|
+
"X-Target-Org-Id"?: string | null;
|
|
370
|
+
};
|
|
371
|
+
body: SocialAutopilotSaveRequest;
|
|
372
|
+
};
|
|
373
|
+
output: ApiResponse_SocialAutopilot_;
|
|
374
|
+
};
|
|
375
|
+
/**
|
|
376
|
+
* POST /social/posts/{post_id}/schedule
|
|
377
|
+
* Schedule Social Post
|
|
378
|
+
* tier: external · scope: campaigns:run
|
|
379
|
+
*/
|
|
380
|
+
schedule_social_post_social_posts__post_id__schedule_post: {
|
|
381
|
+
input: {
|
|
382
|
+
path: {
|
|
383
|
+
/** The post's id. */
|
|
384
|
+
post_id: string;
|
|
385
|
+
};
|
|
386
|
+
headers?: {
|
|
387
|
+
"X-Target-Org-Id"?: string | null;
|
|
388
|
+
};
|
|
389
|
+
body: SocialPostScheduleRequest;
|
|
390
|
+
};
|
|
391
|
+
output: ApiResponse_SocialPost_;
|
|
392
|
+
};
|
|
393
|
+
/**
|
|
394
|
+
* PATCH /social/posts/{post_id}
|
|
395
|
+
* Update Social Post
|
|
396
|
+
* tier: write · scope: campaigns:write
|
|
397
|
+
*/
|
|
398
|
+
update_social_post_social_posts__post_id__patch: {
|
|
399
|
+
input: {
|
|
400
|
+
path: {
|
|
401
|
+
/** The post's id. */
|
|
402
|
+
post_id: string;
|
|
403
|
+
};
|
|
404
|
+
headers?: {
|
|
405
|
+
"X-Target-Org-Id"?: string | null;
|
|
406
|
+
};
|
|
407
|
+
body: SocialPostUpdateRequest;
|
|
408
|
+
};
|
|
409
|
+
output: ApiResponse_SocialPost_;
|
|
410
|
+
};
|
|
411
|
+
}
|
|
412
|
+
|
|
413
|
+
// 50 schemas referenced above (the same as G8Contract.<Name>).
|
|
414
|
+
|
|
415
|
+
export interface ApiResponse_SocialAccountList_ {
|
|
416
|
+
data: SocialAccountList;
|
|
417
|
+
pagination?: PaginationMeta | null;
|
|
418
|
+
}
|
|
419
|
+
|
|
420
|
+
export interface ApiResponse_SocialAnalytics_ {
|
|
421
|
+
data: SocialAnalytics;
|
|
422
|
+
pagination?: PaginationMeta | null;
|
|
423
|
+
}
|
|
424
|
+
|
|
425
|
+
export interface ApiResponse_SocialAudienceFromEngagers_ {
|
|
426
|
+
data: SocialAudienceFromEngagers;
|
|
427
|
+
pagination?: PaginationMeta | null;
|
|
428
|
+
}
|
|
429
|
+
|
|
430
|
+
export interface ApiResponse_SocialAutopilot_ {
|
|
431
|
+
data: SocialAutopilot;
|
|
432
|
+
pagination?: PaginationMeta | null;
|
|
433
|
+
}
|
|
434
|
+
|
|
435
|
+
export interface ApiResponse_SocialDeleted_ {
|
|
436
|
+
data: SocialDeleted;
|
|
437
|
+
pagination?: PaginationMeta | null;
|
|
438
|
+
}
|
|
439
|
+
|
|
440
|
+
export interface ApiResponse_SocialEngagers_ {
|
|
441
|
+
data: SocialEngagers;
|
|
442
|
+
pagination?: PaginationMeta | null;
|
|
443
|
+
}
|
|
444
|
+
|
|
445
|
+
export interface ApiResponse_SocialEnrollResult_ {
|
|
446
|
+
data: SocialEnrollResult;
|
|
447
|
+
pagination?: PaginationMeta | null;
|
|
448
|
+
}
|
|
449
|
+
|
|
450
|
+
export interface ApiResponse_SocialGenerated_ {
|
|
451
|
+
data: SocialGenerated;
|
|
452
|
+
pagination?: PaginationMeta | null;
|
|
453
|
+
}
|
|
454
|
+
|
|
455
|
+
export interface ApiResponse_SocialGenerationContext_ {
|
|
456
|
+
data: SocialGenerationContext;
|
|
457
|
+
pagination?: PaginationMeta | null;
|
|
458
|
+
}
|
|
459
|
+
|
|
460
|
+
export interface ApiResponse_SocialIdeas_ {
|
|
461
|
+
data: SocialIdeas;
|
|
462
|
+
pagination?: PaginationMeta | null;
|
|
463
|
+
}
|
|
464
|
+
|
|
465
|
+
export interface ApiResponse_SocialPostMetrics_ {
|
|
466
|
+
data: SocialPostMetrics;
|
|
467
|
+
pagination?: PaginationMeta | null;
|
|
468
|
+
}
|
|
469
|
+
|
|
470
|
+
export interface ApiResponse_SocialPostPage_ {
|
|
471
|
+
data: SocialPostPage;
|
|
472
|
+
pagination?: PaginationMeta | null;
|
|
473
|
+
}
|
|
474
|
+
|
|
475
|
+
export interface ApiResponse_SocialPost_ {
|
|
476
|
+
data: SocialPost;
|
|
477
|
+
pagination?: PaginationMeta | null;
|
|
478
|
+
}
|
|
479
|
+
|
|
480
|
+
export interface ApiResponse_SocialProviderList_ {
|
|
481
|
+
data: SocialProviderList;
|
|
482
|
+
pagination?: PaginationMeta | null;
|
|
483
|
+
}
|
|
484
|
+
|
|
485
|
+
export interface ApiResponse_SocialPublishAccepted_ {
|
|
486
|
+
data: SocialPublishAccepted;
|
|
487
|
+
pagination?: PaginationMeta | null;
|
|
488
|
+
}
|
|
489
|
+
|
|
490
|
+
export interface PaginationMeta {
|
|
491
|
+
/** Whether there are more pages */
|
|
492
|
+
has_next: boolean;
|
|
493
|
+
/** Items per page */
|
|
494
|
+
limit: number;
|
|
495
|
+
/** 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. */
|
|
496
|
+
next_cursor?: string | null;
|
|
497
|
+
/** Current page number (1-indexed) */
|
|
498
|
+
page: number;
|
|
499
|
+
/** Total number of items */
|
|
500
|
+
total: number;
|
|
501
|
+
}
|
|
502
|
+
|
|
503
|
+
/** A connected social account. `id` is what `account_ref` takes everywhere else. */
|
|
504
|
+
export interface SocialAccount {
|
|
505
|
+
capabilities: SocialCapabilities;
|
|
506
|
+
capacity: SocialAccountCapacity;
|
|
507
|
+
display_name?: string | null;
|
|
508
|
+
id: string;
|
|
509
|
+
profile_url?: string | null;
|
|
510
|
+
provider: string;
|
|
511
|
+
status?: string | null;
|
|
512
|
+
}
|
|
513
|
+
|
|
514
|
+
export interface SocialAccountCapacity {
|
|
515
|
+
publish_limit: number;
|
|
516
|
+
publish_used: number;
|
|
517
|
+
}
|
|
518
|
+
|
|
519
|
+
export interface SocialAccountList {
|
|
520
|
+
items: Array<SocialAccount>;
|
|
521
|
+
}
|
|
522
|
+
|
|
523
|
+
/** Totals and a per-day series over the requested window. */
|
|
524
|
+
export interface SocialAnalytics {
|
|
525
|
+
per_day: Array<Record<string, unknown>>;
|
|
526
|
+
totals: Record<string, number>;
|
|
527
|
+
}
|
|
528
|
+
|
|
529
|
+
/** The audience built from a post's engagers. */
|
|
530
|
+
export interface SocialAudienceFromEngagers {
|
|
531
|
+
added: number;
|
|
532
|
+
audience_id: number;
|
|
533
|
+
audience_name: string;
|
|
534
|
+
created: number;
|
|
535
|
+
matched: number;
|
|
536
|
+
skipped_no_identity: number;
|
|
537
|
+
truncated?: boolean;
|
|
538
|
+
}
|
|
539
|
+
|
|
540
|
+
/** Build an audience from the people who engaged with a post. */
|
|
541
|
+
export interface SocialAudienceFromEngagersRequest {
|
|
542
|
+
audience_name?: string | null;
|
|
543
|
+
}
|
|
544
|
+
|
|
545
|
+
/** Autopilot configuration and state for one account. */
|
|
546
|
+
export interface SocialAutopilot {
|
|
547
|
+
account_ref: string;
|
|
548
|
+
auto_publish_confirmed?: boolean;
|
|
549
|
+
available: boolean;
|
|
550
|
+
configured?: boolean;
|
|
551
|
+
direction?: string;
|
|
552
|
+
enabled?: boolean;
|
|
553
|
+
estimated_generation_credits?: number;
|
|
554
|
+
id?: string | null;
|
|
555
|
+
last_blocking_error?: string | null;
|
|
556
|
+
last_planned_at?: string | null;
|
|
557
|
+
next_slots?: Array<string>;
|
|
558
|
+
prompt_version?: number;
|
|
559
|
+
scheduled_count?: number;
|
|
560
|
+
timezone?: string;
|
|
561
|
+
unscheduled_posts?: number;
|
|
562
|
+
weekly_queue_slots?: Array<SocialQueueSlot>;
|
|
563
|
+
}
|
|
564
|
+
|
|
565
|
+
/** Configure autopilot for one account. */
|
|
566
|
+
export interface SocialAutopilotSaveRequest {
|
|
567
|
+
/** True lets autopilot PUBLISH what it writes without a human approving each post. */
|
|
568
|
+
auto_publish_confirmed?: boolean;
|
|
569
|
+
/** What autopilot should post about. */
|
|
570
|
+
direction: string;
|
|
571
|
+
enabled?: boolean;
|
|
572
|
+
/** IANA timezone. */
|
|
573
|
+
timezone: string;
|
|
574
|
+
weekly_queue_slots: Array<SocialQueueSlot>;
|
|
575
|
+
}
|
|
576
|
+
|
|
577
|
+
/** What an account's connection can do. */
|
|
578
|
+
export interface SocialCapabilities {
|
|
579
|
+
analytics: boolean;
|
|
580
|
+
leads: boolean;
|
|
581
|
+
media: boolean;
|
|
582
|
+
publish_company: boolean;
|
|
583
|
+
publish_personal: boolean;
|
|
584
|
+
}
|
|
585
|
+
|
|
586
|
+
/** The resource is gone. */
|
|
587
|
+
export interface SocialDeleted {
|
|
588
|
+
deleted?: boolean;
|
|
589
|
+
}
|
|
590
|
+
|
|
591
|
+
/** One person who engaged with a post. */
|
|
592
|
+
export interface SocialEngager {
|
|
593
|
+
action: string;
|
|
594
|
+
contact_id?: number | null;
|
|
595
|
+
headline?: string;
|
|
596
|
+
linkedin_url?: string | null;
|
|
597
|
+
name: string;
|
|
598
|
+
resolution: string;
|
|
599
|
+
}
|
|
600
|
+
|
|
601
|
+
/** Engagers of a post. `truncated: true` means this is a PARTIAL list. */
|
|
602
|
+
export interface SocialEngagers {
|
|
603
|
+
items: Array<SocialEngager>;
|
|
604
|
+
supported?: boolean;
|
|
605
|
+
total: number;
|
|
606
|
+
truncated?: boolean;
|
|
607
|
+
}
|
|
608
|
+
|
|
609
|
+
/** Enroll chosen engagers of a post into a sequence. */
|
|
610
|
+
export interface SocialEnrollEngagersRequest {
|
|
611
|
+
/** `contact_id`s from the post's engagers. */
|
|
612
|
+
contact_ids: Array<number>;
|
|
613
|
+
sequence_id: string;
|
|
614
|
+
}
|
|
615
|
+
|
|
616
|
+
/** Engagers enrolled into a sequence. */
|
|
617
|
+
export interface SocialEnrollResult {
|
|
618
|
+
audience_id: number;
|
|
619
|
+
enrolled: number;
|
|
620
|
+
sequence_status?: string | null;
|
|
621
|
+
}
|
|
622
|
+
|
|
623
|
+
/** Generated drafts. Nothing has been saved. */
|
|
624
|
+
export interface SocialGenerated {
|
|
625
|
+
credits_used: number;
|
|
626
|
+
provenance: Array<string>;
|
|
627
|
+
variants: Array<SocialVariant>;
|
|
628
|
+
}
|
|
629
|
+
|
|
630
|
+
/** Which grounding sources have data to draw on. */
|
|
631
|
+
export interface SocialGenerationContext {
|
|
632
|
+
brand_voice: boolean;
|
|
633
|
+
campaign_brief: boolean;
|
|
634
|
+
inbox_insights: number;
|
|
635
|
+
proof_points: number;
|
|
636
|
+
recent_content: number;
|
|
637
|
+
top_posts: number;
|
|
638
|
+
}
|
|
639
|
+
|
|
640
|
+
/** One post idea. */
|
|
641
|
+
export interface SocialIdea {
|
|
642
|
+
concept?: string;
|
|
643
|
+
created_at?: string | null;
|
|
644
|
+
drafted_count?: number;
|
|
645
|
+
favorited?: boolean;
|
|
646
|
+
fit: SocialIdeaFit;
|
|
647
|
+
id: string;
|
|
648
|
+
primary_hook?: string | null;
|
|
649
|
+
proof_points?: string | null;
|
|
650
|
+
receipts?: Array<SocialIdeaReceipt>;
|
|
651
|
+
secondary_hooks?: Array<string>;
|
|
652
|
+
source: string;
|
|
653
|
+
title: string;
|
|
654
|
+
why?: string;
|
|
655
|
+
}
|
|
656
|
+
|
|
657
|
+
export interface SocialIdeaFit {
|
|
658
|
+
grade?: string | null;
|
|
659
|
+
reason?: string | null;
|
|
660
|
+
}
|
|
661
|
+
|
|
662
|
+
export interface SocialIdeaReceipt {
|
|
663
|
+
count: number;
|
|
664
|
+
kind: string;
|
|
665
|
+
}
|
|
666
|
+
|
|
667
|
+
/** Post ideas, plus how many came from each source. */
|
|
668
|
+
export interface SocialIdeas {
|
|
669
|
+
items: Array<SocialIdea>;
|
|
670
|
+
sources: Record<string, number>;
|
|
671
|
+
}
|
|
672
|
+
|
|
673
|
+
/** One image (or other asset) attached to a post. */
|
|
674
|
+
export interface SocialMediaItem {
|
|
675
|
+
/** Alt text. `alt_text` is accepted as a synonym. */
|
|
676
|
+
alt?: string;
|
|
677
|
+
/** Asset-library id, when the asset came from there. */
|
|
678
|
+
id?: string | null;
|
|
679
|
+
/** Asset kind. `image` for a picture. */
|
|
680
|
+
kind?: string;
|
|
681
|
+
/** Publicly fetchable URL of the asset. */
|
|
682
|
+
url: string;
|
|
683
|
+
}
|
|
684
|
+
|
|
685
|
+
/** One post. */
|
|
686
|
+
export interface SocialPost {
|
|
687
|
+
account_ref?: string | null;
|
|
688
|
+
autopilot_config_id?: string | null;
|
|
689
|
+
autopilot_version?: number | null;
|
|
690
|
+
body: string;
|
|
691
|
+
campaign_id?: string | null;
|
|
692
|
+
created_at?: string | null;
|
|
693
|
+
created_by: string;
|
|
694
|
+
external_post_id?: string | null;
|
|
695
|
+
external_post_url?: string | null;
|
|
696
|
+
failure_reason?: string | null;
|
|
697
|
+
generation_metadata?: Record<string, unknown> | null;
|
|
698
|
+
generation_sources?: Array<string> | null;
|
|
699
|
+
id: string;
|
|
700
|
+
idea_id?: string | null;
|
|
701
|
+
media?: Array<Record<string, unknown>> | null;
|
|
702
|
+
post_type: string;
|
|
703
|
+
provider?: string | null;
|
|
704
|
+
published_at?: string | null;
|
|
705
|
+
scheduled_at?: string | null;
|
|
706
|
+
status: string;
|
|
707
|
+
updated_at?: string | null;
|
|
708
|
+
}
|
|
709
|
+
|
|
710
|
+
/** A new post. Created as a DRAFT - nothing is published until you schedule or publish it. */
|
|
711
|
+
export interface SocialPostCreateRequest {
|
|
712
|
+
/** The account it will publish from - an `id` from `GET /social/accounts`. Optional: a draft can be written before any account is connected, but one is required to schedule or publish. */
|
|
713
|
+
account_ref?: string | null;
|
|
714
|
+
/** The post text. */
|
|
715
|
+
body: string;
|
|
716
|
+
/** Campaign to attribute the post to. */
|
|
717
|
+
campaign_id?: string | null;
|
|
718
|
+
generation_sources?: Array<string> | null;
|
|
719
|
+
/** The idea from `GET /social/ideas` this came from. */
|
|
720
|
+
idea_id?: string | null;
|
|
721
|
+
/** Repeat a create with the same key to get the original post back instead of a duplicate. */
|
|
722
|
+
idempotency_key?: string | null;
|
|
723
|
+
media?: Array<SocialMediaItem> | null;
|
|
724
|
+
post_type?: "text" | "image" | "video" | "document";
|
|
725
|
+
}
|
|
726
|
+
|
|
727
|
+
/**
|
|
728
|
+
* Ask the AI studio for draft variants. SPENDS CREDITS; saves nothing.
|
|
729
|
+
*
|
|
730
|
+
* The variants come back in the response - create a post from the one you
|
|
731
|
+
* want with `POST /social/posts`.
|
|
732
|
+
*/
|
|
733
|
+
export interface SocialPostGenerateRequest {
|
|
734
|
+
campaign_id?: string | null;
|
|
735
|
+
/** Older synonym of `instructions`. */
|
|
736
|
+
context?: string | null;
|
|
737
|
+
frame?: string | null;
|
|
738
|
+
hashtags_max?: number;
|
|
739
|
+
idea_id?: string | null;
|
|
740
|
+
instructions?: string | null;
|
|
741
|
+
/** Someone else's post, used as a structural template only. */
|
|
742
|
+
reference_post?: string | null;
|
|
743
|
+
refine?: SocialRefineSpec | null;
|
|
744
|
+
/** Grounding sources. Omit for the default set (brand_voice, campaign_brief, proof_catalog, inbox_insights). `GET /social/generate/context` says which have data. */
|
|
745
|
+
sources?: Array<string> | null;
|
|
746
|
+
tone?: string | null;
|
|
747
|
+
variants?: number;
|
|
748
|
+
}
|
|
749
|
+
|
|
750
|
+
/** Engagement on a published post. `supported: false` means the zeros are placeholders, not measurements. */
|
|
751
|
+
export interface SocialPostMetrics {
|
|
752
|
+
comments?: number;
|
|
753
|
+
fetched_at?: string | null;
|
|
754
|
+
impressions?: number;
|
|
755
|
+
reactions?: number;
|
|
756
|
+
shares?: number;
|
|
757
|
+
supported?: boolean;
|
|
758
|
+
}
|
|
759
|
+
|
|
760
|
+
/** A page of posts plus the org-wide count per status. */
|
|
761
|
+
export interface SocialPostPage {
|
|
762
|
+
counts: Record<string, number>;
|
|
763
|
+
items: Array<SocialPost>;
|
|
764
|
+
total: number;
|
|
765
|
+
}
|
|
766
|
+
|
|
767
|
+
/** When to publish. */
|
|
768
|
+
export interface SocialPostScheduleRequest {
|
|
769
|
+
/** ISO 8601. Include a timezone offset. */
|
|
770
|
+
scheduled_at: string;
|
|
771
|
+
}
|
|
772
|
+
|
|
773
|
+
/**
|
|
774
|
+
* Edit a post. Only the fields you send change.
|
|
775
|
+
*
|
|
776
|
+
* `account_ref: null` sent EXPLICITLY detaches the draft from its account;
|
|
777
|
+
* omitting the field leaves the account alone.
|
|
778
|
+
*/
|
|
779
|
+
export interface SocialPostUpdateRequest {
|
|
780
|
+
account_ref?: string | null;
|
|
781
|
+
body?: string | null;
|
|
782
|
+
media?: Array<SocialMediaItem> | null;
|
|
783
|
+
post_type?: ("text" | "image" | "video" | "document") | null;
|
|
784
|
+
}
|
|
785
|
+
|
|
786
|
+
/** A way of connecting an account. */
|
|
787
|
+
export interface SocialProvider {
|
|
788
|
+
available: boolean;
|
|
789
|
+
capabilities: SocialCapabilities;
|
|
790
|
+
connect_method: string;
|
|
791
|
+
description: string;
|
|
792
|
+
key: string;
|
|
793
|
+
label: string;
|
|
794
|
+
}
|
|
795
|
+
|
|
796
|
+
export interface SocialProviderList {
|
|
797
|
+
items: Array<SocialProvider>;
|
|
798
|
+
}
|
|
799
|
+
|
|
800
|
+
/** Publishing was queued. `status` is the post's state right now - `scheduled` until the publisher claims it. */
|
|
801
|
+
export interface SocialPublishAccepted {
|
|
802
|
+
post: SocialPost;
|
|
803
|
+
status: string;
|
|
804
|
+
}
|
|
805
|
+
|
|
806
|
+
/** A weekly publishing slot. */
|
|
807
|
+
export interface SocialQueueSlot {
|
|
808
|
+
/** 0 = Monday ... 6 = Sunday. */
|
|
809
|
+
day: number;
|
|
810
|
+
/** HH:MM in the autopilot's timezone. */
|
|
811
|
+
time: string;
|
|
812
|
+
}
|
|
813
|
+
|
|
814
|
+
/** Rewrite an existing draft instead of generating from scratch. */
|
|
815
|
+
export interface SocialRefineSpec {
|
|
816
|
+
body: string;
|
|
817
|
+
instruction: string;
|
|
818
|
+
}
|
|
819
|
+
|
|
820
|
+
/** One generated draft. */
|
|
821
|
+
export interface SocialVariant {
|
|
822
|
+
body: string;
|
|
823
|
+
frame: string;
|
|
824
|
+
}
|