@nemphi/sdk 0.2.5277 → 0.3.5333
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/dist/generated/marketing/client.d.ts +534 -1
- package/dist/generated/marketing/client.d.ts.map +1 -1
- package/dist/generated/marketing/client.js +176 -3
- package/dist/generated/marketing/client.js.map +1 -1
- package/dist/generated/marketing/index.d.ts +2 -2
- package/dist/generated/marketing/index.d.ts.map +1 -1
- package/dist/generated/marketing/models.d.ts +151 -0
- package/dist/generated/marketing/models.d.ts.map +1 -1
- package/dist/generated/marketing/models.js +88 -0
- package/dist/generated/marketing/models.js.map +1 -1
- package/dist/index.d.ts +246 -15
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +192 -138
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { type BaseClientOptions, type RequestOptions, Transport } from "../_/index.js";
|
|
2
2
|
import type { Pending } from "../models.js";
|
|
3
|
-
import { type MarketingAccountsComparison, type MarketingActionAnswer, type MarketingAdAccountDeleted, type MarketingAdAccountQueued, type MarketingAdAccountsAnswer, type MarketingAdReport, type MarketingAdTrendAnswer, type MarketingAskAnswer, type MarketingAttachedAnswer, type MarketingCallAnswer, type MarketingCallMediaView, type MarketingCallsAnswer, type MarketingCampaignAnswer, type MarketingCampaignDetail, type MarketingCampaignList, type MarketingCampaignReport, type MarketingCampaignsAnswer, type MarketingChannelDeleted, type MarketingChannelQueued, type MarketingChannelTrendAnswer, type MarketingChannelsAnswer, type MarketingConsentAnswer, type MarketingConversationAnswer, type MarketingConversationDetail, type MarketingConversationsAnswer, type MarketingCreatedCampaign, type MarketingCreatedPosts, type MarketingCreatorInfoOutput, type MarketingDealAnswer, type MarketingDeletedAnswer, type MarketingDeletedTopic, type MarketingDetachedAnswer, type MarketingEmailStatusAnswer, type MarketingEnabledEmail, type MarketingEscalateAnswer, type MarketingGenerationAnswer, type MarketingGenerationsAnswer, type MarketingGoogleAdsConsent, type MarketingHistoryAnswer, type MarketingHitsAnswer, type MarketingLinkAnswer, type MarketingMediaPage, type MarketingMediaRequest, type MarketingOpenedRevision, type MarketingPermissionAnswer, type MarketingPostAnswer, type MarketingPostWithVisits, type MarketingPostsPage, type MarketingQueuedAnswer, type MarketingQueuedTest, type MarketingReputationAnswer, type MarketingResponderAnswer, type MarketingResponderDetail, type MarketingRespondersAnswer, type MarketingRestoredRevision, type MarketingResumeAnswer, type MarketingRevisionPage, type MarketingRevisionsPage, type MarketingRowList, type MarketingSavedRow, type MarketingSavedTemplate, type MarketingSendTemplateAnswer, type MarketingSentCampaign, type MarketingSnapshotsAnswer, type MarketingSpamCheck, type MarketingSuggestedFixes, type MarketingTemplateList, type MarketingTopPostsAnswer, type MarketingTopicAnswer, type MarketingTopicsAnswer, type MarketingUnsubscribeList, type MarketingUnsubscribed, type MarketingUpdatedSettings, type MarketingWhatsappConnectAnswer, type MarketinginboxDeletedAnswer, type MarketinginboxTemplateList } from "./models.js";
|
|
3
|
+
import { type MarketingAccountsComparison, type MarketingActionAnswer, type MarketingAdAccountDeleted, type MarketingAdAccountQueued, type MarketingAdAccountsAnswer, type MarketingAdReport, type MarketingAdTrendAnswer, type MarketingAskAnswer, type MarketingAttachedAnswer, type MarketingBestTimes, type MarketingCallAnswer, type MarketingCallMediaView, type MarketingCallsAnswer, type MarketingCampaignAnswer, type MarketingCampaignDetail, type MarketingCampaignList, type MarketingCampaignReport, type MarketingCampaignsAnswer, type MarketingCaptionDraftAnswer, type MarketingChannelDeleted, type MarketingChannelQueued, type MarketingChannelTrendAnswer, type MarketingChannelsAnswer, type MarketingCommentAnswer, type MarketingComments, type MarketingConsentAnswer, type MarketingConversationAnswer, type MarketingConversationDetail, type MarketingConversationNoteAnswer, type MarketingConversationNotes, type MarketingConversationsAnswer, type MarketingCreatedCampaign, type MarketingCreatedPosts, type MarketingCreatorInfoOutput, type MarketingDealAnswer, type MarketingDeletedAnswer, type MarketingDeletedTopic, type MarketingDetachedAnswer, type MarketingEmailStatusAnswer, type MarketingEnabledEmail, type MarketingEscalateAnswer, type MarketingGenerationAnswer, type MarketingGenerationsAnswer, type MarketingGoogleAdsConsent, type MarketingHistoryAnswer, type MarketingHitsAnswer, type MarketingIdeaAnswer, type MarketingIdeas, type MarketingLinkAnswer, type MarketingMediaPage, type MarketingMediaRequest, type MarketingOpenedRevision, type MarketingPermissionAnswer, type MarketingPostAnswer, type MarketingPostNoteAnswer, type MarketingPostNotes, type MarketingPostScheduleAnswer, type MarketingPostSchedules, type MarketingPostWithVisits, type MarketingPostsPage, type MarketingQueuedAnswer, type MarketingQueuedTest, type MarketingReputationAnswer, type MarketingResponderAnswer, type MarketingResponderDetail, type MarketingRespondersAnswer, type MarketingRestoredRevision, type MarketingResumeAnswer, type MarketingRevisionPage, type MarketingRevisionsPage, type MarketingRowList, type MarketingSavedRow, type MarketingSavedTemplate, type MarketingSendTemplateAnswer, type MarketingSentCampaign, type MarketingSnapshotsAnswer, type MarketingSnippetAnswer, type MarketingSnippets, type MarketingSpamCheck, type MarketingSuggestedFixes, type MarketingTemplateList, type MarketingTopPostsAnswer, type MarketingTopicAnswer, type MarketingTopicsAnswer, type MarketingUnsubscribeList, type MarketingUnsubscribed, type MarketingUpdatedSettings, type MarketingWhatsappConnectAnswer, type MarketinginboxDeletedAnswer, type MarketinginboxTemplateList } from "./models.js";
|
|
4
4
|
export interface ClientOptions extends BaseClientOptions {
|
|
5
5
|
/**
|
|
6
6
|
* The URL the paths of the API are relative to.
|
|
@@ -23,6 +23,26 @@ export interface Client {
|
|
|
23
23
|
* Risk: `read`.
|
|
24
24
|
*/
|
|
25
25
|
adTrend(request?: AdTrendRequest, options?: RequestOptions): Promise<AdTrendResponse>;
|
|
26
|
+
/**
|
|
27
|
+
* Leave a private note on an inbox conversation for the team (context, a
|
|
28
|
+
* promise made, what to do next)
|
|
29
|
+
*
|
|
30
|
+
* Leave a private note on an inbox conversation for the team (context, a
|
|
31
|
+
* promise made, what to do next). The customer never sees it.
|
|
32
|
+
*
|
|
33
|
+
* Risk: `write`.
|
|
34
|
+
*/
|
|
35
|
+
addConversationNote(request: AddConversationNoteRequest, options?: RequestOptions): Promise<AddConversationNoteResponse>;
|
|
36
|
+
/**
|
|
37
|
+
* Leave an internal comment on a post for the team (feedback on the copy, a
|
|
38
|
+
* question about the image, a reminder)
|
|
39
|
+
*
|
|
40
|
+
* Leave an internal comment on a post for the team (feedback on the copy, a
|
|
41
|
+
* question about the image, a reminder). It is never published.
|
|
42
|
+
*
|
|
43
|
+
* Risk: `write`.
|
|
44
|
+
*/
|
|
45
|
+
addPostNote(request: AddPostNoteRequest, options?: RequestOptions): Promise<AddPostNoteResponse>;
|
|
26
46
|
/**
|
|
27
47
|
* Answer an inbound WhatsApp voice call with a WebRTC SDP answer
|
|
28
48
|
*
|
|
@@ -48,6 +68,16 @@ export interface Client {
|
|
|
48
68
|
* Risk: `external_effect`.
|
|
49
69
|
*/
|
|
50
70
|
askConsumer(request: AskConsumerRequest, options?: RequestOptions): Promise<AskConsumerResponse>;
|
|
71
|
+
/**
|
|
72
|
+
* Assign an inbox conversation to a workspace member so the team knows who
|
|
73
|
+
* answers it, or clear the assignment (empty…
|
|
74
|
+
*
|
|
75
|
+
* Assign an inbox conversation to a workspace member so the team knows who
|
|
76
|
+
* answers it, or clear the assignment (empty assignee_user_id).
|
|
77
|
+
*
|
|
78
|
+
* Risk: `write`.
|
|
79
|
+
*/
|
|
80
|
+
assignConversation(request: AssignConversationRequest, options?: RequestOptions): Promise<AssignConversationResponse>;
|
|
51
81
|
/**
|
|
52
82
|
* Attach a workspace document to a marketing response agent's knowledge base
|
|
53
83
|
*
|
|
@@ -57,6 +87,18 @@ export interface Client {
|
|
|
57
87
|
* Risk: `write`.
|
|
58
88
|
*/
|
|
59
89
|
attachResponderDocument(request: AttachResponderDocumentRequest, options?: RequestOptions): Promise<AttachResponderDocumentResponse>;
|
|
90
|
+
/**
|
|
91
|
+
* The weekdays and hours one account's published posts drew the most
|
|
92
|
+
* interactions at, from the counters collected for…
|
|
93
|
+
*
|
|
94
|
+
* The weekdays and hours one account's published posts drew the most
|
|
95
|
+
* interactions at, from the counters collected for its last 200 published
|
|
96
|
+
* posts, best first. sample is how many posts had counters; with fewer than 5
|
|
97
|
+
* the times are a weak signal.
|
|
98
|
+
*
|
|
99
|
+
* Risk: `read`.
|
|
100
|
+
*/
|
|
101
|
+
bestPostTimes(request: BestPostTimesRequest, options?: RequestOptions): Promise<BestPostTimesResponse>;
|
|
60
102
|
/**
|
|
61
103
|
* Cancel a scheduled campaign before it goes out, or stop one that is sending
|
|
62
104
|
* (recipients already sent stay sent)
|
|
@@ -291,6 +333,15 @@ export interface Client {
|
|
|
291
333
|
* Risk: `write`.
|
|
292
334
|
*/
|
|
293
335
|
deleteEmailTemplate(request: DeleteEmailTemplateRequest, options?: RequestOptions): Promise<DeleteEmailTemplateResponse>;
|
|
336
|
+
/**
|
|
337
|
+
* Remove an idea from the backlog, once it became a post or was dropped
|
|
338
|
+
*
|
|
339
|
+
* Remove an idea from the backlog, once it became a post or was dropped.
|
|
340
|
+
* Posts made from it are not touched.
|
|
341
|
+
*
|
|
342
|
+
* Risk: `write`.
|
|
343
|
+
*/
|
|
344
|
+
deleteIdea(request: DeleteIdeaRequest, options?: RequestOptions): Promise<DeleteIdeaResponse>;
|
|
294
345
|
/**
|
|
295
346
|
* Delete one of the workspace's inbox topics
|
|
296
347
|
*
|
|
@@ -309,6 +360,15 @@ export interface Client {
|
|
|
309
360
|
* Risk: `write`.
|
|
310
361
|
*/
|
|
311
362
|
deleteResponder(request: DeleteResponderRequest, options?: RequestOptions): Promise<DeleteResponderResponse>;
|
|
363
|
+
/**
|
|
364
|
+
* Delete a saved caption or hashtag group
|
|
365
|
+
*
|
|
366
|
+
* Delete a saved caption or hashtag group. Posts that already used it keep
|
|
367
|
+
* their text.
|
|
368
|
+
*
|
|
369
|
+
* Risk: `write`.
|
|
370
|
+
*/
|
|
371
|
+
deleteSnippet(request: DeleteSnippetRequest, options?: RequestOptions): Promise<DeleteSnippetResponse>;
|
|
312
372
|
/**
|
|
313
373
|
* Remove a document from a marketing response agent's knowledge base
|
|
314
374
|
*
|
|
@@ -457,6 +517,16 @@ export interface Client {
|
|
|
457
517
|
* Risk: `read`.
|
|
458
518
|
*/
|
|
459
519
|
getCampaign(request: GetCampaignRequest, options?: RequestOptions): Promise<GetCampaignResponse>;
|
|
520
|
+
/**
|
|
521
|
+
* Read a caption request from marketing.write_captions: status queued, done
|
|
522
|
+
* (suggestions holds one caption per network)…
|
|
523
|
+
*
|
|
524
|
+
* Read a caption request from marketing.write_captions: status queued, done
|
|
525
|
+
* (suggestions holds one caption per network) or failed (error says why).
|
|
526
|
+
*
|
|
527
|
+
* Risk: `read`.
|
|
528
|
+
*/
|
|
529
|
+
getCaptionDraft(request: GetCaptionDraftRequest, options?: RequestOptions): Promise<GetCaptionDraftResponse>;
|
|
460
530
|
/**
|
|
461
531
|
* Open one inbox conversation: header (channel, peer, linked party) plus
|
|
462
532
|
* messages oldest-first
|
|
@@ -519,6 +589,17 @@ export interface Client {
|
|
|
519
589
|
* Risk: `read`.
|
|
520
590
|
*/
|
|
521
591
|
getResponder(request: GetResponderRequest, options?: RequestOptions): Promise<GetResponderResponse>;
|
|
592
|
+
/**
|
|
593
|
+
* Hide a comment under an Instagram or Facebook post from everyone but its
|
|
594
|
+
* author and their friends, or show it again…
|
|
595
|
+
*
|
|
596
|
+
* Hide a comment under an Instagram or Facebook post from everyone but its
|
|
597
|
+
* author and their friends, or show it again (hidden=false). Meta applies it
|
|
598
|
+
* through the outbox.
|
|
599
|
+
*
|
|
600
|
+
* Risk: `external_effect`.
|
|
601
|
+
*/
|
|
602
|
+
hideComment(request: HideCommentRequest, options?: RequestOptions): Promise<HideCommentResponse>;
|
|
522
603
|
/**
|
|
523
604
|
* Attach a WhatsApp inbox conversation to an existing CRM party
|
|
524
605
|
* (customer/contact)
|
|
@@ -587,6 +668,26 @@ export interface Client {
|
|
|
587
668
|
* Risk: `read`.
|
|
588
669
|
*/
|
|
589
670
|
listChannels(request: ListChannelsRequest, options?: RequestOptions): Promise<ListChannelsResponse>;
|
|
671
|
+
/**
|
|
672
|
+
* Public comments under the workspace's Instagram and Facebook posts, newest
|
|
673
|
+
* first, each with the post it is under, and…
|
|
674
|
+
*
|
|
675
|
+
* Public comments under the workspace's Instagram and Facebook posts, newest
|
|
676
|
+
* first, each with the post it is under, and the replies sent from here
|
|
677
|
+
* (direction out). Optionally only one account's or one post's.
|
|
678
|
+
*
|
|
679
|
+
* Risk: `read`.
|
|
680
|
+
*/
|
|
681
|
+
listComments(request?: ListCommentsRequest, options?: RequestOptions): Promise<ListCommentsResponse>;
|
|
682
|
+
/**
|
|
683
|
+
* The private notes teammates left on an inbox conversation, oldest first
|
|
684
|
+
*
|
|
685
|
+
* The private notes teammates left on an inbox conversation, oldest first.
|
|
686
|
+
* The customer never sees them.
|
|
687
|
+
*
|
|
688
|
+
* Risk: `read`.
|
|
689
|
+
*/
|
|
690
|
+
listConversationNotes(request: ListConversationNotesRequest, options?: RequestOptions): Promise<ListConversationNotesResponse>;
|
|
590
691
|
/**
|
|
591
692
|
* List inbox conversations for the workspace (customer threads on connected
|
|
592
693
|
* marketing channels; WhatsApp Business…
|
|
@@ -681,6 +782,15 @@ export interface Client {
|
|
|
681
782
|
* Risk: `read`.
|
|
682
783
|
*/
|
|
683
784
|
listHistory(request: ListHistoryRequest, options?: RequestOptions): Promise<ListHistoryResponse>;
|
|
785
|
+
/**
|
|
786
|
+
* The workspace's backlog of post ideas, the most recently touched first
|
|
787
|
+
*
|
|
788
|
+
* The workspace's backlog of post ideas, the most recently touched first. An
|
|
789
|
+
* idea is not tied to an account until it becomes a post.
|
|
790
|
+
*
|
|
791
|
+
* Risk: `read`.
|
|
792
|
+
*/
|
|
793
|
+
listIdeas(request: ListIdeasRequest, options?: RequestOptions): Promise<ListIdeasResponse>;
|
|
684
794
|
/**
|
|
685
795
|
* The workspace's own inbox topics: names the business chose for what its
|
|
686
796
|
* customer conversations are about (e.g
|
|
@@ -714,6 +824,15 @@ export interface Client {
|
|
|
714
824
|
* Risk: `read`.
|
|
715
825
|
*/
|
|
716
826
|
listMetrics(request?: ListMetricsRequest, options?: RequestOptions): Promise<ListMetricsResponse>;
|
|
827
|
+
/**
|
|
828
|
+
* The comments teammates left on a post while preparing it, oldest first
|
|
829
|
+
*
|
|
830
|
+
* The comments teammates left on a post while preparing it, oldest first.
|
|
831
|
+
* They are internal and never published.
|
|
832
|
+
*
|
|
833
|
+
* Risk: `read`.
|
|
834
|
+
*/
|
|
835
|
+
listPostNotes(request: ListPostNotesRequest, options?: RequestOptions): Promise<ListPostNotesResponse>;
|
|
717
836
|
/**
|
|
718
837
|
* Read saved draft versions, newest first
|
|
719
838
|
*
|
|
@@ -725,6 +844,17 @@ export interface Client {
|
|
|
725
844
|
* Risk: `read`.
|
|
726
845
|
*/
|
|
727
846
|
listPostRevisions(request: ListPostRevisionsRequest, options?: RequestOptions): Promise<ListPostRevisionsResponse>;
|
|
847
|
+
/**
|
|
848
|
+
* The weekly posting times of each connected Instagram / Facebook / LinkedIn
|
|
849
|
+
* / TikTok account and the next of those…
|
|
850
|
+
*
|
|
851
|
+
* The weekly posting times of each connected Instagram / Facebook / LinkedIn
|
|
852
|
+
* / TikTok account and the next of those times no post has taken yet (what
|
|
853
|
+
* marketing.create_post with queue=true schedules for).
|
|
854
|
+
*
|
|
855
|
+
* Risk: `read`.
|
|
856
|
+
*/
|
|
857
|
+
listPostSchedules(request: ListPostSchedulesRequest, options?: RequestOptions): Promise<ListPostSchedulesResponse>;
|
|
728
858
|
/**
|
|
729
859
|
* List scheduled and published Instagram / Facebook / LinkedIn / TikTok posts
|
|
730
860
|
* for the workspace, newest schedule first
|
|
@@ -746,6 +876,16 @@ export interface Client {
|
|
|
746
876
|
* Risk: `read`.
|
|
747
877
|
*/
|
|
748
878
|
listResponders(request?: ListRespondersRequest, options?: RequestOptions): Promise<ListRespondersResponse>;
|
|
879
|
+
/**
|
|
880
|
+
* The workspace's saved captions and hashtag groups, by name, for the
|
|
881
|
+
* composer to insert
|
|
882
|
+
*
|
|
883
|
+
* The workspace's saved captions and hashtag groups, by name, for the
|
|
884
|
+
* composer to insert. kind narrows to one of them.
|
|
885
|
+
*
|
|
886
|
+
* Risk: `read`.
|
|
887
|
+
*/
|
|
888
|
+
listSnippets(request?: ListSnippetsRequest, options?: RequestOptions): Promise<ListSnippetsResponse>;
|
|
749
889
|
/**
|
|
750
890
|
* List the APPROVED WhatsApp message templates on a marketing channel's
|
|
751
891
|
* business account, read live from Meta: name…
|
|
@@ -805,6 +945,17 @@ export interface Client {
|
|
|
805
945
|
* Risk: `external_effect`.
|
|
806
946
|
*/
|
|
807
947
|
rejectCall(request: RejectCallRequest, options?: RequestOptions): Promise<RejectCallResponse>;
|
|
948
|
+
/**
|
|
949
|
+
* Reply publicly under a comment on an Instagram or Facebook post
|
|
950
|
+
*
|
|
951
|
+
* Reply publicly under a comment on an Instagram or Facebook post. The reply
|
|
952
|
+
* is recorded as pending and sent through the outbox; it shows as sent, or
|
|
953
|
+
* failed with Meta's reason. For a private answer use the direct-message
|
|
954
|
+
* inbox.
|
|
955
|
+
*
|
|
956
|
+
* Risk: `external_effect`.
|
|
957
|
+
*/
|
|
958
|
+
replyToComment(request: ReplyToCommentRequest, options?: RequestOptions): Promise<ReplyToCommentResponse>;
|
|
808
959
|
/**
|
|
809
960
|
* Send a WhatsApp call-permission request to a customer so the business may
|
|
810
961
|
* later place a voice call…
|
|
@@ -871,6 +1022,16 @@ export interface Client {
|
|
|
871
1022
|
* Risk: `write`.
|
|
872
1023
|
*/
|
|
873
1024
|
saveEmailTemplate(request: SaveEmailTemplateRequest, options?: RequestOptions): Promise<SaveEmailTemplateResponse>;
|
|
1025
|
+
/**
|
|
1026
|
+
* Add a post idea to the workspace's backlog, or with id change one
|
|
1027
|
+
*
|
|
1028
|
+
* Add a post idea to the workspace's backlog, or with id change one. The
|
|
1029
|
+
* title is the idea in a line; notes hold the angle, references or a draft
|
|
1030
|
+
* caption.
|
|
1031
|
+
*
|
|
1032
|
+
* Risk: `write`.
|
|
1033
|
+
*/
|
|
1034
|
+
saveIdea(request: SaveIdeaRequest, options?: RequestOptions): Promise<SaveIdeaResponse>;
|
|
874
1035
|
/**
|
|
875
1036
|
* Create or edit one of the workspace's inbox topics
|
|
876
1037
|
*
|
|
@@ -891,6 +1052,16 @@ export interface Client {
|
|
|
891
1052
|
* Risk: `write`.
|
|
892
1053
|
*/
|
|
893
1054
|
savePostDraft(request: SavePostDraftRequest, options?: RequestOptions): Promise<SavePostDraftResponse>;
|
|
1055
|
+
/**
|
|
1056
|
+
* Save a caption or a hashtag group under a name so the team can insert it in
|
|
1057
|
+
* any post
|
|
1058
|
+
*
|
|
1059
|
+
* Save a caption or a hashtag group under a name so the team can insert it in
|
|
1060
|
+
* any post. With id, replaces that saved text; without, adds a new one.
|
|
1061
|
+
*
|
|
1062
|
+
* Risk: `write`.
|
|
1063
|
+
*/
|
|
1064
|
+
saveSnippet(request: SaveSnippetRequest, options?: RequestOptions): Promise<SaveSnippetResponse>;
|
|
894
1065
|
/**
|
|
895
1066
|
* Schedule an approved post, change the time of a scheduled post, or restore
|
|
896
1067
|
* a cancelled post
|
|
@@ -981,6 +1152,28 @@ export interface Client {
|
|
|
981
1152
|
* Risk: `external_effect`.
|
|
982
1153
|
*/
|
|
983
1154
|
sendWhatsapp(request: SendWhatsappRequest, options?: RequestOptions): Promise<SendWhatsappResponse>;
|
|
1155
|
+
/**
|
|
1156
|
+
* Replace one account's weekly posting times
|
|
1157
|
+
*
|
|
1158
|
+
* Replace one account's weekly posting times. Each slot is a weekday (0
|
|
1159
|
+
* Sunday … 6 Saturday) and a local HH:MM read in time_zone. An empty list
|
|
1160
|
+
* clears the schedule. marketing.create_post with queue=true then schedules
|
|
1161
|
+
* each post for the account's next free time.
|
|
1162
|
+
*
|
|
1163
|
+
* Risk: `write`.
|
|
1164
|
+
*/
|
|
1165
|
+
setPostSchedule(request: SetPostScheduleRequest, options?: RequestOptions): Promise<SetPostScheduleResponse>;
|
|
1166
|
+
/**
|
|
1167
|
+
* Replace a post's tags: the workspace's own labels (a campaign, theme or
|
|
1168
|
+
* product) to filter the board and calendar by
|
|
1169
|
+
*
|
|
1170
|
+
* Replace a post's tags: the workspace's own labels (a campaign, theme or
|
|
1171
|
+
* product) to filter the board and calendar by. They are never published. At
|
|
1172
|
+
* most 10, each up to 32 characters; an empty list clears them.
|
|
1173
|
+
*
|
|
1174
|
+
* Risk: `write`.
|
|
1175
|
+
*/
|
|
1176
|
+
setPostTags(request: SetPostTagsRequest, options?: RequestOptions): Promise<SetPostTagsResponse>;
|
|
984
1177
|
/**
|
|
985
1178
|
* Submit a draft for review
|
|
986
1179
|
*
|
|
@@ -1097,6 +1290,20 @@ export interface Client {
|
|
|
1097
1290
|
* Risk: `write`.
|
|
1098
1291
|
*/
|
|
1099
1292
|
updateResponder(request: UpdateResponderRequest, options?: RequestOptions): Promise<UpdateResponderResponse>;
|
|
1293
|
+
/**
|
|
1294
|
+
* Write a social caption for each network a post goes to, from a short brief
|
|
1295
|
+
* (what the post is about, the offer, the…
|
|
1296
|
+
*
|
|
1297
|
+
* Write a social caption for each network a post goes to, from a short brief
|
|
1298
|
+
* (what the post is about, the offer, the call to action), or rework an
|
|
1299
|
+
* existing caption. It is written in the background within seconds; read it
|
|
1300
|
+
* with marketing.get_caption_draft. Each caption fits its network's length
|
|
1301
|
+
* and habits (hashtags on Instagram and TikTok, a professional voice on
|
|
1302
|
+
* LinkedIn). Spends the workspace's daily AI allowance.
|
|
1303
|
+
*
|
|
1304
|
+
* Risk: `write`.
|
|
1305
|
+
*/
|
|
1306
|
+
writeCaptions(request: WriteCaptionsRequest, options?: RequestOptions): Promise<WriteCaptionsResponse>;
|
|
1100
1307
|
}
|
|
1101
1308
|
export declare function createClient(options: ClientOptions): Client;
|
|
1102
1309
|
export declare function bind(transport: Transport): Client;
|
|
@@ -1114,6 +1321,34 @@ export type AdTrendResponse = {
|
|
|
1114
1321
|
output: MarketingAdTrendAnswer;
|
|
1115
1322
|
tool: "marketing.ad_trend";
|
|
1116
1323
|
} | Pending;
|
|
1324
|
+
export interface AddConversationNoteRequest {
|
|
1325
|
+
/**
|
|
1326
|
+
* The note
|
|
1327
|
+
*/
|
|
1328
|
+
body: string;
|
|
1329
|
+
/**
|
|
1330
|
+
* Conversation to note
|
|
1331
|
+
*/
|
|
1332
|
+
conversationId: string;
|
|
1333
|
+
}
|
|
1334
|
+
export type AddConversationNoteResponse = {
|
|
1335
|
+
output: MarketingConversationNoteAnswer;
|
|
1336
|
+
tool: "marketing.add_conversation_note";
|
|
1337
|
+
} | Pending;
|
|
1338
|
+
export interface AddPostNoteRequest {
|
|
1339
|
+
/**
|
|
1340
|
+
* The comment
|
|
1341
|
+
*/
|
|
1342
|
+
body: string;
|
|
1343
|
+
/**
|
|
1344
|
+
* marketing_posts id
|
|
1345
|
+
*/
|
|
1346
|
+
postId: string;
|
|
1347
|
+
}
|
|
1348
|
+
export type AddPostNoteResponse = {
|
|
1349
|
+
output: MarketingPostNoteAnswer;
|
|
1350
|
+
tool: "marketing.add_post_note";
|
|
1351
|
+
} | Pending;
|
|
1117
1352
|
export interface AnswerCallRequest {
|
|
1118
1353
|
/**
|
|
1119
1354
|
* Inbound ringing call to answer
|
|
@@ -1149,6 +1384,20 @@ export type AskConsumerResponse = {
|
|
|
1149
1384
|
output: MarketingAskAnswer;
|
|
1150
1385
|
tool: "marketing.ask_consumer";
|
|
1151
1386
|
} | Pending;
|
|
1387
|
+
export interface AssignConversationRequest {
|
|
1388
|
+
/**
|
|
1389
|
+
* The member who owns the thread; empty clears it
|
|
1390
|
+
*/
|
|
1391
|
+
assigneeUserId?: string;
|
|
1392
|
+
/**
|
|
1393
|
+
* Conversation to assign
|
|
1394
|
+
*/
|
|
1395
|
+
conversationId: string;
|
|
1396
|
+
}
|
|
1397
|
+
export type AssignConversationResponse = {
|
|
1398
|
+
output: MarketingConversationAnswer;
|
|
1399
|
+
tool: "marketing.assign_conversation";
|
|
1400
|
+
} | Pending;
|
|
1152
1401
|
export interface AttachResponderDocumentRequest {
|
|
1153
1402
|
/**
|
|
1154
1403
|
* Document id from documents.upload / the Documents page
|
|
@@ -1160,6 +1409,21 @@ export type AttachResponderDocumentResponse = {
|
|
|
1160
1409
|
output: MarketingAttachedAnswer;
|
|
1161
1410
|
tool: "marketing.attach_responder_document";
|
|
1162
1411
|
} | Pending;
|
|
1412
|
+
export interface BestPostTimesRequest {
|
|
1413
|
+
/**
|
|
1414
|
+
* Instagram / Facebook / LinkedIn / TikTok channel id from
|
|
1415
|
+
* marketing.list_channels
|
|
1416
|
+
*/
|
|
1417
|
+
channelId: string;
|
|
1418
|
+
/**
|
|
1419
|
+
* IANA zone the hours are given in (default UTC)
|
|
1420
|
+
*/
|
|
1421
|
+
timeZone?: string;
|
|
1422
|
+
}
|
|
1423
|
+
export type BestPostTimesResponse = {
|
|
1424
|
+
output: MarketingBestTimes;
|
|
1425
|
+
tool: "marketing.best_post_times";
|
|
1426
|
+
} | Pending;
|
|
1163
1427
|
export interface CancelEmailCampaignRequest {
|
|
1164
1428
|
campaignId: string;
|
|
1165
1429
|
}
|
|
@@ -1334,15 +1598,37 @@ export type CreateEmailCampaignResponse = {
|
|
|
1334
1598
|
tool: "marketing.create_email_campaign";
|
|
1335
1599
|
} | Pending;
|
|
1336
1600
|
export interface CreatePostRequest {
|
|
1601
|
+
/**
|
|
1602
|
+
* Instagram image posts only: alt text that describes the picture for people
|
|
1603
|
+
* who use screen readers
|
|
1604
|
+
*/
|
|
1605
|
+
altText?: string;
|
|
1337
1606
|
/**
|
|
1338
1607
|
* Post caption / Facebook or LinkedIn message text (stories take no caption)
|
|
1339
1608
|
*/
|
|
1340
1609
|
caption?: string;
|
|
1610
|
+
/**
|
|
1611
|
+
* Optional per-account captions keyed by channel_id; an account named here
|
|
1612
|
+
* gets its own text instead of caption
|
|
1613
|
+
*/
|
|
1614
|
+
captions?: {
|
|
1615
|
+
[key: string]: string;
|
|
1616
|
+
};
|
|
1341
1617
|
/**
|
|
1342
1618
|
* One or more Instagram / Facebook / LinkedIn / TikTok channel ids from
|
|
1343
1619
|
* marketing.list_channels
|
|
1344
1620
|
*/
|
|
1345
1621
|
channelIds: string[];
|
|
1622
|
+
/**
|
|
1623
|
+
* Instagram only: up to 3 usernames invited to co-author the post (they
|
|
1624
|
+
* accept in the app). Not for stories
|
|
1625
|
+
*/
|
|
1626
|
+
collaborators?: string[];
|
|
1627
|
+
/**
|
|
1628
|
+
* Instagram and Facebook only: a comment published under the post right after
|
|
1629
|
+
* it goes out (often hashtags or a link). Not for stories
|
|
1630
|
+
*/
|
|
1631
|
+
firstComment?: string;
|
|
1346
1632
|
/**
|
|
1347
1633
|
* image (default), video, carousel (2–10 URLs), reels (video), story (24-hour
|
|
1348
1634
|
* Instagram/Facebook story), or text (Facebook/LinkedIn feed only)
|
|
@@ -1353,6 +1639,11 @@ export interface CreatePostRequest {
|
|
|
1353
1639
|
* Required for image/video/carousel/reels/story
|
|
1354
1640
|
*/
|
|
1355
1641
|
mediaUrls?: string[];
|
|
1642
|
+
/**
|
|
1643
|
+
* Add to each account's queue: schedule the post for that account's next free
|
|
1644
|
+
* posting time (marketing.set_post_schedule). Takes the place of scheduled_at
|
|
1645
|
+
*/
|
|
1646
|
+
queue?: boolean;
|
|
1356
1647
|
/**
|
|
1357
1648
|
* When to publish as RFC3339 UTC (omit or past = publish as soon as approved
|
|
1358
1649
|
* / queued)
|
|
@@ -1451,6 +1742,16 @@ export type DeleteEmailTemplateResponse = {
|
|
|
1451
1742
|
output: MarketingDeletedAnswer;
|
|
1452
1743
|
tool: "marketing.delete_email_template";
|
|
1453
1744
|
} | Pending;
|
|
1745
|
+
export interface DeleteIdeaRequest {
|
|
1746
|
+
/**
|
|
1747
|
+
* The idea's id
|
|
1748
|
+
*/
|
|
1749
|
+
id: string;
|
|
1750
|
+
}
|
|
1751
|
+
export type DeleteIdeaResponse = {
|
|
1752
|
+
output: MarketingIdeaAnswer;
|
|
1753
|
+
tool: "marketing.delete_idea";
|
|
1754
|
+
} | Pending;
|
|
1454
1755
|
export interface DeleteInboxTopicRequest {
|
|
1455
1756
|
/**
|
|
1456
1757
|
* Topic from marketing.list_inbox_topics
|
|
@@ -1468,6 +1769,16 @@ export type DeleteResponderResponse = {
|
|
|
1468
1769
|
output: MarketinginboxDeletedAnswer;
|
|
1469
1770
|
tool: "marketing.delete_responder";
|
|
1470
1771
|
} | Pending;
|
|
1772
|
+
export interface DeleteSnippetRequest {
|
|
1773
|
+
/**
|
|
1774
|
+
* The saved text's id
|
|
1775
|
+
*/
|
|
1776
|
+
id: string;
|
|
1777
|
+
}
|
|
1778
|
+
export type DeleteSnippetResponse = {
|
|
1779
|
+
output: MarketingSnippetAnswer;
|
|
1780
|
+
tool: "marketing.delete_snippet";
|
|
1781
|
+
} | Pending;
|
|
1471
1782
|
export interface DetachResponderDocumentRequest {
|
|
1472
1783
|
documentId: string;
|
|
1473
1784
|
responderId: string;
|
|
@@ -1639,6 +1950,16 @@ export type GetCampaignResponse = {
|
|
|
1639
1950
|
output: MarketingCampaignDetail;
|
|
1640
1951
|
tool: "marketing.get_campaign";
|
|
1641
1952
|
} | Pending;
|
|
1953
|
+
export interface GetCaptionDraftRequest {
|
|
1954
|
+
/**
|
|
1955
|
+
* The id marketing.write_captions answered
|
|
1956
|
+
*/
|
|
1957
|
+
draftId: string;
|
|
1958
|
+
}
|
|
1959
|
+
export type GetCaptionDraftResponse = {
|
|
1960
|
+
output: MarketingCaptionDraftAnswer;
|
|
1961
|
+
tool: "marketing.get_caption_draft";
|
|
1962
|
+
} | Pending;
|
|
1642
1963
|
export interface GetConversationRequest {
|
|
1643
1964
|
/**
|
|
1644
1965
|
* Conversation id from marketing.list_conversations
|
|
@@ -1696,6 +2017,20 @@ export type GetResponderResponse = {
|
|
|
1696
2017
|
output: MarketingResponderDetail;
|
|
1697
2018
|
tool: "marketing.get_responder";
|
|
1698
2019
|
} | Pending;
|
|
2020
|
+
export interface HideCommentRequest {
|
|
2021
|
+
/**
|
|
2022
|
+
* The comment (marketing.list_comments id)
|
|
2023
|
+
*/
|
|
2024
|
+
commentId: string;
|
|
2025
|
+
/**
|
|
2026
|
+
* true hides it (default), false shows it again
|
|
2027
|
+
*/
|
|
2028
|
+
hidden?: boolean;
|
|
2029
|
+
}
|
|
2030
|
+
export type HideCommentResponse = {
|
|
2031
|
+
output: MarketingCommentAnswer;
|
|
2032
|
+
tool: "marketing.hide_comment";
|
|
2033
|
+
} | Pending;
|
|
1699
2034
|
export interface LinkConversationPartyRequest {
|
|
1700
2035
|
conversationId: string;
|
|
1701
2036
|
/**
|
|
@@ -1775,6 +2110,34 @@ export type ListChannelsResponse = {
|
|
|
1775
2110
|
output: MarketingChannelsAnswer;
|
|
1776
2111
|
tool: "marketing.list_channels";
|
|
1777
2112
|
} | Pending;
|
|
2113
|
+
export interface ListCommentsRequest {
|
|
2114
|
+
/**
|
|
2115
|
+
* Only this Instagram or Facebook account's comments
|
|
2116
|
+
*/
|
|
2117
|
+
channelId?: string;
|
|
2118
|
+
/**
|
|
2119
|
+
* At most this many (default 100, at most 300)
|
|
2120
|
+
*/
|
|
2121
|
+
limit?: number;
|
|
2122
|
+
/**
|
|
2123
|
+
* Only the comments under this post (marketing.list_posts id)
|
|
2124
|
+
*/
|
|
2125
|
+
postId?: string;
|
|
2126
|
+
}
|
|
2127
|
+
export type ListCommentsResponse = {
|
|
2128
|
+
output: MarketingComments;
|
|
2129
|
+
tool: "marketing.list_comments";
|
|
2130
|
+
} | Pending;
|
|
2131
|
+
export interface ListConversationNotesRequest {
|
|
2132
|
+
/**
|
|
2133
|
+
* Conversation whose notes to read
|
|
2134
|
+
*/
|
|
2135
|
+
conversationId: string;
|
|
2136
|
+
}
|
|
2137
|
+
export type ListConversationNotesResponse = {
|
|
2138
|
+
output: MarketingConversationNotes;
|
|
2139
|
+
tool: "marketing.list_conversation_notes";
|
|
2140
|
+
} | Pending;
|
|
1778
2141
|
export interface ListConversationsRequest {
|
|
1779
2142
|
/**
|
|
1780
2143
|
* Only conversations in this built-in category
|
|
@@ -1901,6 +2264,15 @@ export type ListHistoryResponse = {
|
|
|
1901
2264
|
output: MarketingHistoryAnswer;
|
|
1902
2265
|
tool: "marketing.list_history";
|
|
1903
2266
|
} | Pending;
|
|
2267
|
+
export interface ListIdeasRequest {
|
|
2268
|
+
body: {
|
|
2269
|
+
[key: string]: unknown;
|
|
2270
|
+
};
|
|
2271
|
+
}
|
|
2272
|
+
export type ListIdeasResponse = {
|
|
2273
|
+
output: MarketingIdeas;
|
|
2274
|
+
tool: "marketing.list_ideas";
|
|
2275
|
+
} | Pending;
|
|
1904
2276
|
export interface ListInboxTopicsRequest {
|
|
1905
2277
|
body: {
|
|
1906
2278
|
[key: string]: unknown;
|
|
@@ -1978,6 +2350,16 @@ export type ListMetricsResponse = {
|
|
|
1978
2350
|
output: MarketingSnapshotsAnswer;
|
|
1979
2351
|
tool: "marketing.list_metrics";
|
|
1980
2352
|
} | Pending;
|
|
2353
|
+
export interface ListPostNotesRequest {
|
|
2354
|
+
/**
|
|
2355
|
+
* marketing_posts id
|
|
2356
|
+
*/
|
|
2357
|
+
postId: string;
|
|
2358
|
+
}
|
|
2359
|
+
export type ListPostNotesResponse = {
|
|
2360
|
+
output: MarketingPostNotes;
|
|
2361
|
+
tool: "marketing.list_post_notes";
|
|
2362
|
+
} | Pending;
|
|
1981
2363
|
export interface ListPostRevisionsRequest {
|
|
1982
2364
|
/**
|
|
1983
2365
|
* Only versions older than this one, for paging
|
|
@@ -1992,6 +2374,15 @@ export type ListPostRevisionsResponse = {
|
|
|
1992
2374
|
output: MarketingRevisionsPage;
|
|
1993
2375
|
tool: "marketing.list_post_revisions";
|
|
1994
2376
|
} | Pending;
|
|
2377
|
+
export interface ListPostSchedulesRequest {
|
|
2378
|
+
body: {
|
|
2379
|
+
[key: string]: unknown;
|
|
2380
|
+
};
|
|
2381
|
+
}
|
|
2382
|
+
export type ListPostSchedulesResponse = {
|
|
2383
|
+
output: MarketingPostSchedules;
|
|
2384
|
+
tool: "marketing.list_post_schedules";
|
|
2385
|
+
} | Pending;
|
|
1995
2386
|
export interface ListPostsRequest {
|
|
1996
2387
|
/**
|
|
1997
2388
|
* Narrow to one channel
|
|
@@ -2028,6 +2419,16 @@ export type ListRespondersResponse = {
|
|
|
2028
2419
|
output: MarketingRespondersAnswer;
|
|
2029
2420
|
tool: "marketing.list_responders";
|
|
2030
2421
|
} | Pending;
|
|
2422
|
+
export interface ListSnippetsRequest {
|
|
2423
|
+
/**
|
|
2424
|
+
* caption or hashtags; empty for both
|
|
2425
|
+
*/
|
|
2426
|
+
kind?: "caption" | "hashtags";
|
|
2427
|
+
}
|
|
2428
|
+
export type ListSnippetsResponse = {
|
|
2429
|
+
output: MarketingSnippets;
|
|
2430
|
+
tool: "marketing.list_snippets";
|
|
2431
|
+
} | Pending;
|
|
2031
2432
|
export interface ListTemplatesRequest {
|
|
2032
2433
|
/**
|
|
2033
2434
|
* WhatsApp marketing channel id (see marketing.list_channels)
|
|
@@ -2095,6 +2496,20 @@ export type RejectCallResponse = {
|
|
|
2095
2496
|
output: MarketingActionAnswer;
|
|
2096
2497
|
tool: "marketing.reject_call";
|
|
2097
2498
|
} | Pending;
|
|
2499
|
+
export interface ReplyToCommentRequest {
|
|
2500
|
+
/**
|
|
2501
|
+
* The public reply text
|
|
2502
|
+
*/
|
|
2503
|
+
body: string;
|
|
2504
|
+
/**
|
|
2505
|
+
* The comment to answer (marketing.list_comments id)
|
|
2506
|
+
*/
|
|
2507
|
+
commentId: string;
|
|
2508
|
+
}
|
|
2509
|
+
export type ReplyToCommentResponse = {
|
|
2510
|
+
output: MarketingCommentAnswer;
|
|
2511
|
+
tool: "marketing.reply_to_comment";
|
|
2512
|
+
} | Pending;
|
|
2098
2513
|
export interface RequestCallPermissionRequest {
|
|
2099
2514
|
/**
|
|
2100
2515
|
* WhatsApp Business channel to send from
|
|
@@ -2187,6 +2602,24 @@ export type SaveEmailTemplateResponse = {
|
|
|
2187
2602
|
output: MarketingSavedTemplate;
|
|
2188
2603
|
tool: "marketing.save_email_template";
|
|
2189
2604
|
} | Pending;
|
|
2605
|
+
export interface SaveIdeaRequest {
|
|
2606
|
+
/**
|
|
2607
|
+
* An idea's id to change; empty to add one
|
|
2608
|
+
*/
|
|
2609
|
+
id?: string;
|
|
2610
|
+
/**
|
|
2611
|
+
* The angle, references or a draft caption
|
|
2612
|
+
*/
|
|
2613
|
+
notes?: string;
|
|
2614
|
+
/**
|
|
2615
|
+
* The idea in a line
|
|
2616
|
+
*/
|
|
2617
|
+
title: string;
|
|
2618
|
+
}
|
|
2619
|
+
export type SaveIdeaResponse = {
|
|
2620
|
+
output: MarketingIdeaAnswer;
|
|
2621
|
+
tool: "marketing.save_idea";
|
|
2622
|
+
} | Pending;
|
|
2190
2623
|
export interface SaveInboxTopicRequest {
|
|
2191
2624
|
/**
|
|
2192
2625
|
* When a conversation belongs here, written for the automatic reader (e.g.
|
|
@@ -2207,6 +2640,11 @@ export type SaveInboxTopicResponse = {
|
|
|
2207
2640
|
tool: "marketing.save_inbox_topic";
|
|
2208
2641
|
} | Pending;
|
|
2209
2642
|
export interface SavePostDraftRequest {
|
|
2643
|
+
/**
|
|
2644
|
+
* Instagram image posts only: alt text that describes the picture for people
|
|
2645
|
+
* who use screen readers
|
|
2646
|
+
*/
|
|
2647
|
+
altText?: string;
|
|
2210
2648
|
/**
|
|
2211
2649
|
* Post caption / message text
|
|
2212
2650
|
*/
|
|
@@ -2215,6 +2653,16 @@ export interface SavePostDraftRequest {
|
|
|
2215
2653
|
* The channel the post will go out on (see marketing.list_channels)
|
|
2216
2654
|
*/
|
|
2217
2655
|
channelId: string;
|
|
2656
|
+
/**
|
|
2657
|
+
* Instagram only: up to 3 usernames invited to co-author the post (they
|
|
2658
|
+
* accept in the app). Not for stories
|
|
2659
|
+
*/
|
|
2660
|
+
collaborators?: string[];
|
|
2661
|
+
/**
|
|
2662
|
+
* Instagram and Facebook only: a comment published under the post right after
|
|
2663
|
+
* it goes out (often hashtags or a link). Not for stories
|
|
2664
|
+
*/
|
|
2665
|
+
firstComment?: string;
|
|
2218
2666
|
/**
|
|
2219
2667
|
* image (default), video, carousel (2–10 URLs), reels (video), story (24-hour
|
|
2220
2668
|
* Instagram/Facebook story), or text (Facebook/LinkedIn feed only)
|
|
@@ -2260,6 +2708,28 @@ export type SavePostDraftResponse = {
|
|
|
2260
2708
|
output: MarketingPostAnswer;
|
|
2261
2709
|
tool: "marketing.save_post_draft";
|
|
2262
2710
|
} | Pending;
|
|
2711
|
+
export interface SaveSnippetRequest {
|
|
2712
|
+
/**
|
|
2713
|
+
* The text inserted
|
|
2714
|
+
*/
|
|
2715
|
+
body: string;
|
|
2716
|
+
/**
|
|
2717
|
+
* A saved text's id to replace; empty to add one
|
|
2718
|
+
*/
|
|
2719
|
+
id?: string;
|
|
2720
|
+
/**
|
|
2721
|
+
* caption or hashtags
|
|
2722
|
+
*/
|
|
2723
|
+
kind: "caption" | "hashtags";
|
|
2724
|
+
/**
|
|
2725
|
+
* A short name the team finds it by
|
|
2726
|
+
*/
|
|
2727
|
+
name: string;
|
|
2728
|
+
}
|
|
2729
|
+
export type SaveSnippetResponse = {
|
|
2730
|
+
output: MarketingSnippetAnswer;
|
|
2731
|
+
tool: "marketing.save_snippet";
|
|
2732
|
+
} | Pending;
|
|
2263
2733
|
export interface SchedulePostRequest {
|
|
2264
2734
|
/**
|
|
2265
2735
|
* marketing_posts id
|
|
@@ -2379,6 +2849,42 @@ export type SendWhatsappResponse = {
|
|
|
2379
2849
|
output: MarketingQueuedAnswer;
|
|
2380
2850
|
tool: "marketing.send_whatsapp";
|
|
2381
2851
|
} | Pending;
|
|
2852
|
+
export interface SetPostScheduleRequest {
|
|
2853
|
+
/**
|
|
2854
|
+
* Instagram / Facebook / LinkedIn / TikTok channel id from
|
|
2855
|
+
* marketing.list_channels
|
|
2856
|
+
*/
|
|
2857
|
+
channelId: string;
|
|
2858
|
+
/**
|
|
2859
|
+
* The weekly times (at most 50)
|
|
2860
|
+
*/
|
|
2861
|
+
slots: {
|
|
2862
|
+
time: string;
|
|
2863
|
+
weekday: number;
|
|
2864
|
+
}[];
|
|
2865
|
+
/**
|
|
2866
|
+
* IANA zone the times are written in, like America/Bogota
|
|
2867
|
+
*/
|
|
2868
|
+
timeZone: string;
|
|
2869
|
+
}
|
|
2870
|
+
export type SetPostScheduleResponse = {
|
|
2871
|
+
output: MarketingPostScheduleAnswer;
|
|
2872
|
+
tool: "marketing.set_post_schedule";
|
|
2873
|
+
} | Pending;
|
|
2874
|
+
export interface SetPostTagsRequest {
|
|
2875
|
+
/**
|
|
2876
|
+
* marketing_posts id
|
|
2877
|
+
*/
|
|
2878
|
+
postId: string;
|
|
2879
|
+
/**
|
|
2880
|
+
* The tags, like otoño or lanzamiento
|
|
2881
|
+
*/
|
|
2882
|
+
tags: string[];
|
|
2883
|
+
}
|
|
2884
|
+
export type SetPostTagsResponse = {
|
|
2885
|
+
output: MarketingPostAnswer;
|
|
2886
|
+
tool: "marketing.set_post_tags";
|
|
2887
|
+
} | Pending;
|
|
2382
2888
|
export interface SubmitPostRequest {
|
|
2383
2889
|
/**
|
|
2384
2890
|
* marketing_posts id
|
|
@@ -2506,4 +3012,31 @@ export type UpdateResponderResponse = {
|
|
|
2506
3012
|
output: MarketingResponderAnswer;
|
|
2507
3013
|
tool: "marketing.update_responder";
|
|
2508
3014
|
} | Pending;
|
|
3015
|
+
export interface WriteCaptionsRequest {
|
|
3016
|
+
/**
|
|
3017
|
+
* What the post is about: the product, offer or news, who it is for, the call
|
|
3018
|
+
* to action
|
|
3019
|
+
*/
|
|
3020
|
+
brief: string;
|
|
3021
|
+
/**
|
|
3022
|
+
* A caption to rework rather than starting from the brief alone
|
|
3023
|
+
*/
|
|
3024
|
+
currentCaption?: string;
|
|
3025
|
+
/**
|
|
3026
|
+
* The language to write in, like es or en; the brief's own when omitted
|
|
3027
|
+
*/
|
|
3028
|
+
language?: string;
|
|
3029
|
+
/**
|
|
3030
|
+
* The networks to write a caption for
|
|
3031
|
+
*/
|
|
3032
|
+
providers: ("instagram" | "facebook" | "linkedin" | "tiktok")[];
|
|
3033
|
+
/**
|
|
3034
|
+
* The voice: friendly (default), professional, playful or bold
|
|
3035
|
+
*/
|
|
3036
|
+
tone?: "friendly" | "professional" | "playful" | "bold";
|
|
3037
|
+
}
|
|
3038
|
+
export type WriteCaptionsResponse = {
|
|
3039
|
+
output: MarketingCaptionDraftAnswer;
|
|
3040
|
+
tool: "marketing.write_captions";
|
|
3041
|
+
} | Pending;
|
|
2509
3042
|
//# sourceMappingURL=client.d.ts.map
|