@getlatedev/node 0.2.289 → 0.2.291
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 +57 -57
- package/dist/index.d.mts +4 -0
- package/dist/index.d.ts +4 -0
- package/dist/index.js +1 -1
- package/dist/index.mjs +1 -1
- package/package.json +1 -1
- package/src/generated/sdk.gen.ts +57 -57
- package/src/generated/types.gen.ts +4 -0
package/README.md
CHANGED
|
@@ -194,7 +194,7 @@ try {
|
|
|
194
194
|
| `accounts.deleteAccount()` | Disconnect account |
|
|
195
195
|
| `accounts.deleteGoogleBusinessReviewReply()` | Delete a review reply |
|
|
196
196
|
| `accounts.batchGetGoogleBusinessReviews()` | Batch get reviews |
|
|
197
|
-
| `accounts.moveAccountToProfile()` | Move account to
|
|
197
|
+
| `accounts.moveAccountToProfile()` | Move account to another profile |
|
|
198
198
|
| `accounts.replyToGoogleBusinessReview()` | Reply to a review |
|
|
199
199
|
|
|
200
200
|
### Profiles
|
|
@@ -220,13 +220,13 @@ try {
|
|
|
220
220
|
| `analytics.getInstagramDemographics()` | Get Instagram demographics |
|
|
221
221
|
| `analytics.getInstagramFollowerHistory()` | Get Instagram follower history |
|
|
222
222
|
| `analytics.getLinkedInAggregateAnalytics()` | Get LinkedIn aggregate stats |
|
|
223
|
-
| `analytics.getLinkedInOrgAggregateAnalytics()` | Get LinkedIn
|
|
223
|
+
| `analytics.getLinkedInOrgAggregateAnalytics()` | Get LinkedIn org analytics |
|
|
224
224
|
| `analytics.getLinkedInPostAnalytics()` | Get LinkedIn post stats |
|
|
225
225
|
| `analytics.getLinkedInPostReactions()` | Get LinkedIn post reactions |
|
|
226
226
|
| `analytics.getPostingFrequency()` | Get frequency vs engagement |
|
|
227
227
|
| `analytics.getPostTimeline()` | Get post analytics timeline |
|
|
228
228
|
| `analytics.getTikTokAccountInsights()` | Get TikTok account-level insights |
|
|
229
|
-
| `analytics.getYouTubeChannelInsights()` | Get YouTube channel
|
|
229
|
+
| `analytics.getYouTubeChannelInsights()` | Get YouTube channel insights |
|
|
230
230
|
| `analytics.getYouTubeDailyViews()` | Get YouTube daily views |
|
|
231
231
|
| `analytics.getYouTubeDemographics()` | Get YouTube demographics |
|
|
232
232
|
| `analytics.getYouTubeVideoRetention()` | Get YouTube video retention curve |
|
|
@@ -296,7 +296,7 @@ try {
|
|
|
296
296
|
| `connect.listLinkedInOrganizations()` | List LinkedIn orgs |
|
|
297
297
|
| `connect.listPinterestBoardsForSelection()` | List Pinterest boards |
|
|
298
298
|
| `connect.listSnapchatProfiles()` | List Snapchat profiles |
|
|
299
|
-
| `connect.listWhatsAppPhoneNumbers()` | List
|
|
299
|
+
| `connect.listWhatsAppPhoneNumbers()` | List numbers for selection |
|
|
300
300
|
| `connect.getConnectUrl()` | Get OAuth connect URL |
|
|
301
301
|
| `connect.getFacebookPages()` | List Facebook pages |
|
|
302
302
|
| `connect.getGmbLocations()` | List GBP locations |
|
|
@@ -314,8 +314,8 @@ try {
|
|
|
314
314
|
| `connect.updateRedditSubreddits()` | Set default subreddit |
|
|
315
315
|
| `connect.updateYoutubeDefaultPlaylist()` | Set default YouTube playlist |
|
|
316
316
|
| `connect.completeTelegramConnect()` | Check Telegram status |
|
|
317
|
-
| `connect.completeWhatsAppPhoneSelection()` | Complete
|
|
318
|
-
| `connect.configureTikTokAdsBrandIdentity()` |
|
|
317
|
+
| `connect.completeWhatsAppPhoneSelection()` | Complete number selection |
|
|
318
|
+
| `connect.configureTikTokAdsBrandIdentity()` | Set TikTok brand identity |
|
|
319
319
|
| `connect.connectAds()` | Connect ads for a platform |
|
|
320
320
|
| `connect.connectBlueskyCredentials()` | Connect Bluesky account |
|
|
321
321
|
| `connect.connectWhatsAppCredentials()` | Connect WhatsApp via credentials |
|
|
@@ -360,11 +360,11 @@ try {
|
|
|
360
360
|
|--------|-------------|
|
|
361
361
|
| `adCampaigns.listAdCampaigns()` | List campaigns |
|
|
362
362
|
| `adCampaigns.bulkUpdateAdCampaignStatus()` | Pause or resume many campaigns |
|
|
363
|
-
| `adCampaigns.getAdsTimeline()` | Get daily
|
|
363
|
+
| `adCampaigns.getAdsTimeline()` | Get daily account metrics |
|
|
364
364
|
| `adCampaigns.getAdTree()` | Get campaign tree |
|
|
365
|
-
| `adCampaigns.updateAdCampaign()` | Update a campaign
|
|
365
|
+
| `adCampaigns.updateAdCampaign()` | Update a campaign |
|
|
366
366
|
| `adCampaigns.updateAdCampaignStatus()` | Pause or resume a campaign |
|
|
367
|
-
| `adCampaigns.updateAdSet()` | Update an ad set
|
|
367
|
+
| `adCampaigns.updateAdSet()` | Update an ad set |
|
|
368
368
|
| `adCampaigns.updateAdSetStatus()` | Pause or resume a single ad set |
|
|
369
369
|
| `adCampaigns.deleteAdCampaign()` | Delete a campaign |
|
|
370
370
|
| `adCampaigns.duplicateAdCampaign()` | Duplicate a campaign |
|
|
@@ -377,38 +377,38 @@ try {
|
|
|
377
377
|
| `ads.listAdCatalogs()` | List Meta product catalogs |
|
|
378
378
|
| `ads.listAds()` | List ads |
|
|
379
379
|
| `ads.listAdsBusinessCenters()` | List TikTok Business Centers |
|
|
380
|
-
| `ads.listConversionAssociations()` | List
|
|
381
|
-
| `ads.listConversionDestinations()` | List destinations
|
|
380
|
+
| `ads.listConversionAssociations()` | List associated campaigns |
|
|
381
|
+
| `ads.listConversionDestinations()` | List conversion destinations |
|
|
382
382
|
| `ads.listFormLeads()` | List leads for a single form |
|
|
383
|
-
| `ads.listLeadForms()` | List
|
|
384
|
-
| `ads.listLeads()` | List submitted leads
|
|
385
|
-
| `ads.createConversionDestination()` | Create a conversion destination
|
|
386
|
-
| `ads.createCtwaAd()` | Create Click-to-WhatsApp ad
|
|
387
|
-
| `ads.createLeadForm()` | Create a
|
|
383
|
+
| `ads.listLeadForms()` | List lead forms |
|
|
384
|
+
| `ads.listLeads()` | List submitted leads |
|
|
385
|
+
| `ads.createConversionDestination()` | Create a conversion destination |
|
|
386
|
+
| `ads.createCtwaAd()` | Create Click-to-WhatsApp ad |
|
|
387
|
+
| `ads.createLeadForm()` | Create a lead form |
|
|
388
388
|
| `ads.createStandaloneAd()` | Create standalone ad |
|
|
389
|
-
| `ads.createTestLead()` | Create a
|
|
389
|
+
| `ads.createTestLead()` | Create a test lead |
|
|
390
390
|
| `ads.getAd()` | Get ad details |
|
|
391
391
|
| `ads.getAdAnalytics()` | Get ad analytics |
|
|
392
392
|
| `ads.getAdComments()` | List comments on an ad |
|
|
393
|
-
| `ads.getAdTrackingTags()` |
|
|
394
|
-
| `ads.getConversionDestination()` |
|
|
395
|
-
| `ads.getConversionMetrics()` |
|
|
396
|
-
| `ads.getConversionsQuality()` |
|
|
397
|
-
| `ads.getLeadForm()` | Get a
|
|
393
|
+
| `ads.getAdTrackingTags()` | Get ad tracking tags |
|
|
394
|
+
| `ads.getConversionDestination()` | Get a conversion destination |
|
|
395
|
+
| `ads.getConversionMetrics()` | Get attribution metrics |
|
|
396
|
+
| `ads.getConversionsQuality()` | Get Event Match Quality |
|
|
397
|
+
| `ads.getLeadForm()` | Get a lead form |
|
|
398
398
|
| `ads.updateAd()` | Update ad |
|
|
399
|
-
| `ads.updateAdTrackingTags()` | Set
|
|
399
|
+
| `ads.updateAdTrackingTags()` | Set ad tracking tags |
|
|
400
400
|
| `ads.updateConversionDestination()` | Update a conversion destination |
|
|
401
401
|
| `ads.deleteAd()` | Cancel an ad |
|
|
402
|
-
| `ads.deleteConversionDestination()` |
|
|
403
|
-
| `ads.addConversionAssociations()` | Associate campaigns
|
|
404
|
-
| `ads.adjustConversions()` | Adjust
|
|
405
|
-
| `ads.archiveLeadForm()` | Archive a
|
|
402
|
+
| `ads.deleteConversionDestination()` | Delete a conversion destination |
|
|
403
|
+
| `ads.addConversionAssociations()` | Associate campaigns |
|
|
404
|
+
| `ads.adjustConversions()` | Adjust uploaded conversions |
|
|
405
|
+
| `ads.archiveLeadForm()` | Archive a lead form |
|
|
406
406
|
| `ads.boostPost()` | Boost post as ad |
|
|
407
407
|
| `ads.estimateAdReach()` | Estimate audience reach |
|
|
408
|
-
| `ads.removeConversionAssociations()` | Remove
|
|
409
|
-
| `ads.searchAdInterests()` | Search targeting interests
|
|
408
|
+
| `ads.removeConversionAssociations()` | Remove associated campaigns |
|
|
409
|
+
| `ads.searchAdInterests()` | Search targeting interests |
|
|
410
410
|
| `ads.searchAdTargeting()` | Search targeting options |
|
|
411
|
-
| `ads.sendConversions()` | Send conversion events
|
|
411
|
+
| `ads.sendConversions()` | Send conversion events |
|
|
412
412
|
|
|
413
413
|
### Broadcasts
|
|
414
414
|
| Method | Description |
|
|
@@ -473,7 +473,7 @@ try {
|
|
|
473
473
|
|--------|-------------|
|
|
474
474
|
| `discord.listDiscordGuildMembers()` | List Discord guild members |
|
|
475
475
|
| `discord.listDiscordGuildRoles()` | List Discord guild roles |
|
|
476
|
-
| `discord.listDiscordPinnedMessages()` | List pinned messages
|
|
476
|
+
| `discord.listDiscordPinnedMessages()` | List pinned messages |
|
|
477
477
|
| `discord.listDiscordScheduledEvents()` | List Discord scheduled events |
|
|
478
478
|
| `discord.createDiscordScheduledEvent()` | Create a Discord scheduled event |
|
|
479
479
|
| `discord.getDiscordChannels()` | List Discord guild channels |
|
|
@@ -539,9 +539,9 @@ try {
|
|
|
539
539
|
### Inbox Analytics
|
|
540
540
|
| Method | Description |
|
|
541
541
|
|--------|-------------|
|
|
542
|
-
| `inboxAnalytics.listInboxConversationAnalytics()` | List
|
|
543
|
-
| `inboxAnalytics.getInboxConversationAnalytics()` | Get analytics
|
|
544
|
-
| `inboxAnalytics.getInboxHeatmap()` | Get
|
|
542
|
+
| `inboxAnalytics.listInboxConversationAnalytics()` | List conversation analytics |
|
|
543
|
+
| `inboxAnalytics.getInboxConversationAnalytics()` | Get conversation analytics |
|
|
544
|
+
| `inboxAnalytics.getInboxHeatmap()` | Get day × hour heatmap |
|
|
545
545
|
| `inboxAnalytics.getInboxResponseTime()` | Get inbox response-time stats |
|
|
546
546
|
| `inboxAnalytics.getInboxSourceBreakdown()` | Get inbox source breakdown |
|
|
547
547
|
| `inboxAnalytics.getInboxTopAccounts()` | Get top accounts by inbox volume |
|
|
@@ -557,7 +557,7 @@ try {
|
|
|
557
557
|
| Method | Description |
|
|
558
558
|
|--------|-------------|
|
|
559
559
|
| `messages.listInboxConversations()` | List conversations |
|
|
560
|
-
| `messages.createInboxConversation()` | Create conversation
|
|
560
|
+
| `messages.createInboxConversation()` | Create conversation |
|
|
561
561
|
| `messages.getInboxConversation()` | Get conversation |
|
|
562
562
|
| `messages.getInboxConversationMessages()` | List messages |
|
|
563
563
|
| `messages.updateInboxConversation()` | Update conversation status |
|
|
@@ -594,14 +594,14 @@ try {
|
|
|
594
594
|
### Tracking Tags
|
|
595
595
|
| Method | Description |
|
|
596
596
|
|--------|-------------|
|
|
597
|
-
| `trackingTags.listTrackingTags()` | List tracking tags
|
|
598
|
-
| `trackingTags.listTrackingTagSharedAccounts()` | List
|
|
599
|
-
| `trackingTags.createTrackingTag()` | Create a tracking tag
|
|
600
|
-
| `trackingTags.getTrackingTag()` |
|
|
601
|
-
| `trackingTags.getTrackingTagStats()` |
|
|
602
|
-
| `trackingTags.updateTrackingTag()` | Update a tracking tag
|
|
603
|
-
| `trackingTags.addTrackingTagSharedAccount()` | Share
|
|
604
|
-
| `trackingTags.removeTrackingTagSharedAccount()` | Stop sharing
|
|
597
|
+
| `trackingTags.listTrackingTags()` | List tracking tags |
|
|
598
|
+
| `trackingTags.listTrackingTagSharedAccounts()` | List accounts it is shared with |
|
|
599
|
+
| `trackingTags.createTrackingTag()` | Create a tracking tag |
|
|
600
|
+
| `trackingTags.getTrackingTag()` | Get a tracking tag |
|
|
601
|
+
| `trackingTags.getTrackingTagStats()` | Get aggregated event stats |
|
|
602
|
+
| `trackingTags.updateTrackingTag()` | Update a tracking tag |
|
|
603
|
+
| `trackingTags.addTrackingTagSharedAccount()` | Share with an ad account |
|
|
604
|
+
| `trackingTags.removeTrackingTagSharedAccount()` | Stop sharing with an account |
|
|
605
605
|
|
|
606
606
|
### Twitter Engagement
|
|
607
607
|
| Method | Description |
|
|
@@ -624,10 +624,10 @@ try {
|
|
|
624
624
|
### WhatsApp
|
|
625
625
|
| Method | Description |
|
|
626
626
|
|--------|-------------|
|
|
627
|
-
| `whatsapp.listWhatsAppConversions()` | List
|
|
627
|
+
| `whatsapp.listWhatsAppConversions()` | List conversion events |
|
|
628
628
|
| `whatsapp.listWhatsAppGroupChats()` | List active groups |
|
|
629
629
|
| `whatsapp.listWhatsAppGroupJoinRequests()` | List join requests |
|
|
630
|
-
| `whatsapp.createWhatsAppDataset()` | Provision CTWA
|
|
630
|
+
| `whatsapp.createWhatsAppDataset()` | Provision CTWA dataset |
|
|
631
631
|
| `whatsapp.createWhatsAppGroupChat()` | Create group |
|
|
632
632
|
| `whatsapp.createWhatsAppGroupInviteLink()` | Create invite link |
|
|
633
633
|
| `whatsapp.createWhatsAppTemplate()` | Create template |
|
|
@@ -659,9 +659,9 @@ try {
|
|
|
659
659
|
|--------|-------------|
|
|
660
660
|
| `whatsappCalling.listWhatsAppCalls()` | List call history for an account |
|
|
661
661
|
| `whatsappCalling.getWhatsAppCall()` | Get a single call |
|
|
662
|
-
| `whatsappCalling.getWhatsAppCallEstimate()` | Estimate per-minute cost
|
|
662
|
+
| `whatsappCalling.getWhatsAppCallEstimate()` | Estimate per-minute cost |
|
|
663
663
|
| `whatsappCalling.getWhatsAppCallingConfig()` | Get calling config for an account |
|
|
664
|
-
| `whatsappCalling.getWhatsAppCallPermissions()` | Check call permission
|
|
664
|
+
| `whatsappCalling.getWhatsAppCallPermissions()` | Check call permission |
|
|
665
665
|
| `whatsappCalling.updateWhatsAppCalling()` | Update calling config |
|
|
666
666
|
| `whatsappCalling.disableWhatsAppCalling()` | Disable calling on a number |
|
|
667
667
|
| `whatsappCalling.enableWhatsAppCalling()` | Enable calling on a number |
|
|
@@ -690,24 +690,24 @@ try {
|
|
|
690
690
|
| `whatsappPhoneNumbers.listWhatsAppNumberCountries()` | List offerable number countries |
|
|
691
691
|
| `whatsappPhoneNumbers.createWhatsAppNumberKycLink()` | Create a hosted KYC link |
|
|
692
692
|
| `whatsappPhoneNumbers.getWhatsAppNumberInfo()` | Get number status |
|
|
693
|
-
| `whatsappPhoneNumbers.getWhatsAppNumberKycForm()` | Get
|
|
694
|
-
| `whatsappPhoneNumbers.getWhatsAppNumberRemediation()` | Get
|
|
693
|
+
| `whatsappPhoneNumbers.getWhatsAppNumberKycForm()` | Get KYC form spec |
|
|
694
|
+
| `whatsappPhoneNumbers.getWhatsAppNumberRemediation()` | Get declined requirements |
|
|
695
695
|
| `whatsappPhoneNumbers.getWhatsAppPhoneNumber()` | Get phone number |
|
|
696
696
|
| `whatsappPhoneNumbers.getWhatsAppPhoneNumbers()` | List phone numbers |
|
|
697
|
-
| `whatsappPhoneNumbers.checkWhatsAppNumberAvailability()` | Check
|
|
697
|
+
| `whatsappPhoneNumbers.checkWhatsAppNumberAvailability()` | Check country availability |
|
|
698
698
|
| `whatsappPhoneNumbers.purchaseWhatsAppPhoneNumber()` | Purchase phone number |
|
|
699
699
|
| `whatsappPhoneNumbers.releaseWhatsAppPhoneNumber()` | Release phone number |
|
|
700
|
-
| `whatsappPhoneNumbers.remediateWhatsAppNumber()` |
|
|
701
|
-
| `whatsappPhoneNumbers.searchAvailableWhatsAppNumbers()` | Search available numbers
|
|
702
|
-
| `whatsappPhoneNumbers.submitWhatsAppNumberKyc()` | Submit
|
|
703
|
-
| `whatsappPhoneNumbers.uploadWhatsAppNumberKycDocument()` | Upload a
|
|
704
|
-
| `whatsappPhoneNumbers.validateWhatsAppNumberKycAddress()` | Pre-validate
|
|
700
|
+
| `whatsappPhoneNumbers.remediateWhatsAppNumber()` | Resubmit a declined number |
|
|
701
|
+
| `whatsappPhoneNumbers.searchAvailableWhatsAppNumbers()` | Search available numbers |
|
|
702
|
+
| `whatsappPhoneNumbers.submitWhatsAppNumberKyc()` | Submit KYC |
|
|
703
|
+
| `whatsappPhoneNumbers.uploadWhatsAppNumberKycDocument()` | Upload a KYC document |
|
|
704
|
+
| `whatsappPhoneNumbers.validateWhatsAppNumberKycAddress()` | Pre-validate KYC address |
|
|
705
705
|
|
|
706
706
|
### WhatsApp Sandbox
|
|
707
707
|
| Method | Description |
|
|
708
708
|
|--------|-------------|
|
|
709
709
|
| `whatsappSandbox.listWhatsAppSandboxSessions()` | List your sandbox sessions |
|
|
710
|
-
| `whatsappSandbox.createWhatsAppSandboxSession()` | Start a sandbox activation
|
|
710
|
+
| `whatsappSandbox.createWhatsAppSandboxSession()` | Start a sandbox activation |
|
|
711
711
|
| `whatsappSandbox.deleteWhatsAppSandboxSession()` | Revoke a sandbox session |
|
|
712
712
|
|
|
713
713
|
### WhatsApp Templates
|
|
@@ -730,7 +730,7 @@ try {
|
|
|
730
730
|
| `workflows.activateWorkflow()` | Activate workflow |
|
|
731
731
|
| `workflows.duplicateWorkflow()` | Duplicate a workflow |
|
|
732
732
|
| `workflows.pauseWorkflow()` | Pause workflow |
|
|
733
|
-
| `workflows.restoreWorkflowVersion()` | Restore a
|
|
733
|
+
| `workflows.restoreWorkflowVersion()` | Restore a workflow version |
|
|
734
734
|
| `workflows.triggerWorkflow()` | Manually start a workflow run |
|
|
735
735
|
|
|
736
736
|
### Invites
|
package/dist/index.d.mts
CHANGED
|
@@ -7830,6 +7830,10 @@ type ListPostsData = {
|
|
|
7830
7830
|
* Sort order for results.
|
|
7831
7831
|
*/
|
|
7832
7832
|
sortBy?: 'scheduled-desc' | 'scheduled-asc' | 'created-desc' | 'created-asc' | 'status' | 'platform';
|
|
7833
|
+
/**
|
|
7834
|
+
* Which collection to read. `zernio` (default) returns posts authored through Zernio. `external` returns posts synced from the platform (existing/historical posts that were published outside Zernio). Combine with `accountId` and paginate via `page`/`limit` to walk the full synced history (we keep up to the last ~12 months per account).
|
|
7835
|
+
*/
|
|
7836
|
+
source?: 'zernio' | 'external';
|
|
7833
7837
|
status?: 'draft' | 'scheduled' | 'published' | 'failed';
|
|
7834
7838
|
};
|
|
7835
7839
|
};
|
package/dist/index.d.ts
CHANGED
|
@@ -7830,6 +7830,10 @@ type ListPostsData = {
|
|
|
7830
7830
|
* Sort order for results.
|
|
7831
7831
|
*/
|
|
7832
7832
|
sortBy?: 'scheduled-desc' | 'scheduled-asc' | 'created-desc' | 'created-asc' | 'status' | 'platform';
|
|
7833
|
+
/**
|
|
7834
|
+
* Which collection to read. `zernio` (default) returns posts authored through Zernio. `external` returns posts synced from the platform (existing/historical posts that were published outside Zernio). Combine with `accountId` and paginate via `page`/`limit` to walk the full synced history (we keep up to the last ~12 months per account).
|
|
7835
|
+
*/
|
|
7836
|
+
source?: 'zernio' | 'external';
|
|
7833
7837
|
status?: 'draft' | 'scheduled' | 'published' | 'failed';
|
|
7834
7838
|
};
|
|
7835
7839
|
};
|
package/dist/index.js
CHANGED
|
@@ -36,7 +36,7 @@ module.exports = __toCommonJS(index_exports);
|
|
|
36
36
|
// package.json
|
|
37
37
|
var package_default = {
|
|
38
38
|
name: "@getlatedev/node",
|
|
39
|
-
version: "0.2.
|
|
39
|
+
version: "0.2.291",
|
|
40
40
|
description: "The official Node.js library for the Zernio API",
|
|
41
41
|
main: "dist/index.js",
|
|
42
42
|
module: "dist/index.mjs",
|
package/dist/index.mjs
CHANGED
|
@@ -5,7 +5,7 @@ var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "sy
|
|
|
5
5
|
// package.json
|
|
6
6
|
var package_default = {
|
|
7
7
|
name: "@getlatedev/node",
|
|
8
|
-
version: "0.2.
|
|
8
|
+
version: "0.2.291",
|
|
9
9
|
description: "The official Node.js library for the Zernio API",
|
|
10
10
|
main: "dist/index.js",
|
|
11
11
|
module: "dist/index.mjs",
|
package/package.json
CHANGED
package/src/generated/sdk.gen.ts
CHANGED
|
@@ -84,7 +84,7 @@ export const getAnalytics = <ThrowOnError extends boolean = false>(options?: Opt
|
|
|
84
84
|
};
|
|
85
85
|
|
|
86
86
|
/**
|
|
87
|
-
* Get YouTube channel
|
|
87
|
+
* Get YouTube channel insights
|
|
88
88
|
* Returns channel-scoped aggregate metrics from YouTube Analytics API v2. Saves you
|
|
89
89
|
* from looping /v1/analytics/youtube/daily-views over every video when you only need
|
|
90
90
|
* channel totals.
|
|
@@ -108,7 +108,7 @@ export const getYouTubeChannelInsights = <ThrowOnError extends boolean = false>(
|
|
|
108
108
|
};
|
|
109
109
|
|
|
110
110
|
/**
|
|
111
|
-
* Get LinkedIn
|
|
111
|
+
* Get LinkedIn org analytics
|
|
112
112
|
* Returns aggregate analytics for a LinkedIn organization page. Parallel to
|
|
113
113
|
* /v1/accounts/{id}/linkedin-aggregate-analytics (which handles personal accounts only).
|
|
114
114
|
* Backed by LinkedIn's organizationalEntityShareStatistics,
|
|
@@ -408,7 +408,7 @@ export const getInboxVolume = <ThrowOnError extends boolean = false>(options: Op
|
|
|
408
408
|
};
|
|
409
409
|
|
|
410
410
|
/**
|
|
411
|
-
* Get
|
|
411
|
+
* Get day × hour heatmap
|
|
412
412
|
* Day-of-week × hour-of-day breakdown of inbox messages. Buckets are
|
|
413
413
|
* sparse — only cells with at least one event are returned; clients
|
|
414
414
|
* zero-fill the rest to render the full 7×24 grid. The `dow` field
|
|
@@ -478,7 +478,7 @@ export const getInboxTopAccounts = <ThrowOnError extends boolean = false>(option
|
|
|
478
478
|
};
|
|
479
479
|
|
|
480
480
|
/**
|
|
481
|
-
* List
|
|
481
|
+
* List conversation analytics
|
|
482
482
|
* Per-conversation listing with per-row totals + first/last message
|
|
483
483
|
* timestamps. The inbox analog of GET /v1/analytics (posts listing) —
|
|
484
484
|
* same filter shape, same pagination, same sort/order semantics.
|
|
@@ -499,7 +499,7 @@ export const listInboxConversationAnalytics = <ThrowOnError extends boolean = fa
|
|
|
499
499
|
};
|
|
500
500
|
|
|
501
501
|
/**
|
|
502
|
-
* Get analytics
|
|
502
|
+
* Get conversation analytics
|
|
503
503
|
* Per-conversation inbox analytics. The inbox analog of
|
|
504
504
|
* /v1/analytics/post-timeline — one conversation, daily totals,
|
|
505
505
|
* source mix.
|
|
@@ -927,7 +927,7 @@ export const updateAccount = <ThrowOnError extends boolean = false>(options: Opt
|
|
|
927
927
|
};
|
|
928
928
|
|
|
929
929
|
/**
|
|
930
|
-
* Move account to
|
|
930
|
+
* Move account to another profile
|
|
931
931
|
* Moves a connected social account to a different profile owned by the same
|
|
932
932
|
* user. The target profile must belong to the same user as the account.
|
|
933
933
|
*
|
|
@@ -1080,7 +1080,7 @@ export const connectAds = <ThrowOnError extends boolean = false>(options: Option
|
|
|
1080
1080
|
};
|
|
1081
1081
|
|
|
1082
1082
|
/**
|
|
1083
|
-
*
|
|
1083
|
+
* Set TikTok brand identity
|
|
1084
1084
|
* Set or update the Brand Identity (display name + avatar) for a
|
|
1085
1085
|
* `tiktokads` SocialAccount. TikTok requires every ad to carry an
|
|
1086
1086
|
* `identity_id + identity_type` pair. The Brand Identity is the
|
|
@@ -1586,7 +1586,7 @@ export const connectWhatsAppCredentials = <ThrowOnError extends boolean = false>
|
|
|
1586
1586
|
};
|
|
1587
1587
|
|
|
1588
1588
|
/**
|
|
1589
|
-
* List
|
|
1589
|
+
* List numbers for selection
|
|
1590
1590
|
* Fetch the WhatsApp phone numbers available across the user's WhatsApp Business Accounts (WABAs) after a headless OAuth flow.
|
|
1591
1591
|
*
|
|
1592
1592
|
* WhatsApp OAuth grants access at the WABA level. When a connected WABA has 2 or more phone numbers, you must call this endpoint to list them and then `POST /v1/connect/whatsapp/select-phone-number` to bind one to the Zernio profile. Single-phone WABAs auto-complete during the OAuth callback and never reach this endpoint.
|
|
@@ -1604,7 +1604,7 @@ export const listWhatsAppPhoneNumbers = <ThrowOnError extends boolean = false>(o
|
|
|
1604
1604
|
};
|
|
1605
1605
|
|
|
1606
1606
|
/**
|
|
1607
|
-
* Complete
|
|
1607
|
+
* Complete number selection
|
|
1608
1608
|
* Bind a specific WhatsApp phone number to the Zernio profile after the user picks one from `listWhatsAppPhoneNumbers`. Exchanges the short-lived OAuth token for a long-lived token, subscribes the WABA to webhooks, and creates the SocialAccount.
|
|
1609
1609
|
*
|
|
1610
1610
|
*/
|
|
@@ -2049,7 +2049,7 @@ export const removeDiscordMemberRole = <ThrowOnError extends boolean = false>(op
|
|
|
2049
2049
|
};
|
|
2050
2050
|
|
|
2051
2051
|
/**
|
|
2052
|
-
* List pinned messages
|
|
2052
|
+
* List pinned messages
|
|
2053
2053
|
* Returns the channel's pinned messages, sorted most-recently-pinned
|
|
2054
2054
|
* first. Discord caps a channel at 50 pinned messages and returns the
|
|
2055
2055
|
* full list unpaginated.
|
|
@@ -2358,7 +2358,7 @@ export const listInboxConversations = <ThrowOnError extends boolean = false>(opt
|
|
|
2358
2358
|
};
|
|
2359
2359
|
|
|
2360
2360
|
/**
|
|
2361
|
-
* Create conversation
|
|
2361
|
+
* Create conversation
|
|
2362
2362
|
* Initiate a new direct message conversation with a specified user. If a conversation already exists with the recipient, the message is added to the existing thread.
|
|
2363
2363
|
*
|
|
2364
2364
|
* Supported platforms: X/Twitter, Bluesky, Reddit, and WhatsApp. Other platforms return PLATFORM_NOT_SUPPORTED.
|
|
@@ -3058,7 +3058,7 @@ export const disableWhatsAppCalling = <ThrowOnError extends boolean = false>(opt
|
|
|
3058
3058
|
};
|
|
3059
3059
|
|
|
3060
3060
|
/**
|
|
3061
|
-
* Check call permission
|
|
3061
|
+
* Check call permission
|
|
3062
3062
|
* Returns the permission state and the list of available actions for
|
|
3063
3063
|
* a given consumer wa_id (e.g. `start_call`, `send_call_permission_request`).
|
|
3064
3064
|
* Use this before placing a call to decide whether to prompt for
|
|
@@ -3119,7 +3119,7 @@ export const getWhatsAppCall = <ThrowOnError extends boolean = false>(options: O
|
|
|
3119
3119
|
};
|
|
3120
3120
|
|
|
3121
3121
|
/**
|
|
3122
|
-
* Estimate per-minute cost
|
|
3122
|
+
* Estimate per-minute cost
|
|
3123
3123
|
* Returns a zero-markup estimated cost for an outbound call to the
|
|
3124
3124
|
* given destination, broken down by Meta + Telnyx + recording line
|
|
3125
3125
|
* items. Costs are pass-through, no margin applied.
|
|
@@ -3318,7 +3318,7 @@ export const getWhatsAppDataset = <ThrowOnError extends boolean = false>(options
|
|
|
3318
3318
|
};
|
|
3319
3319
|
|
|
3320
3320
|
/**
|
|
3321
|
-
* Provision CTWA
|
|
3321
|
+
* Provision CTWA dataset
|
|
3322
3322
|
* Creates (or fetches, if one already exists) the Meta dataset that
|
|
3323
3323
|
* Click-to-WhatsApp ad events are reported against via the Conversions
|
|
3324
3324
|
* API, and persists its ID on the account as `metadata.metaCapiDatasetId`.
|
|
@@ -3387,7 +3387,7 @@ export const listWhatsAppNumberCountries = <ThrowOnError extends boolean = false
|
|
|
3387
3387
|
};
|
|
3388
3388
|
|
|
3389
3389
|
/**
|
|
3390
|
-
* Search available numbers
|
|
3390
|
+
* Search available numbers
|
|
3391
3391
|
* Search the provider's inventory for numbers available to purchase in a
|
|
3392
3392
|
* country (default US). Optional filters narrow the results. The country
|
|
3393
3393
|
* must be offerable (see GET /v1/whatsapp/phone-numbers/countries).
|
|
@@ -3401,7 +3401,7 @@ export const searchAvailableWhatsAppNumbers = <ThrowOnError extends boolean = fa
|
|
|
3401
3401
|
};
|
|
3402
3402
|
|
|
3403
3403
|
/**
|
|
3404
|
-
* Check
|
|
3404
|
+
* Check country availability
|
|
3405
3405
|
* Pre-purchase check, so you can warn BEFORE a customer invests in KYC
|
|
3406
3406
|
* (regulated review is async, 1-3 days). Tells you whether we have
|
|
3407
3407
|
* deliverable inventory, and what address the customer needs:
|
|
@@ -3421,7 +3421,7 @@ export const checkWhatsAppNumberAvailability = <ThrowOnError extends boolean = f
|
|
|
3421
3421
|
};
|
|
3422
3422
|
|
|
3423
3423
|
/**
|
|
3424
|
-
* Get
|
|
3424
|
+
* Get KYC form spec
|
|
3425
3425
|
* For a Tier 3/4 country, the fields the end customer must provide (Telnyx
|
|
3426
3426
|
* regulatory requirements) before a number can be ordered: text, date,
|
|
3427
3427
|
* address, or file (document) per requirement.
|
|
@@ -3435,7 +3435,7 @@ export const getWhatsAppNumberKycForm = <ThrowOnError extends boolean = false>(o
|
|
|
3435
3435
|
};
|
|
3436
3436
|
|
|
3437
3437
|
/**
|
|
3438
|
-
* Submit
|
|
3438
|
+
* Submit KYC
|
|
3439
3439
|
* Submit the end customer's KYC (textual values, uploaded documents,
|
|
3440
3440
|
* address) for a Tier 3/4 country. Documents are streamed straight to the
|
|
3441
3441
|
* number provider and are not stored by Zernio. Builds + submits a
|
|
@@ -3463,7 +3463,7 @@ export const submitWhatsAppNumberKyc = <ThrowOnError extends boolean = false>(op
|
|
|
3463
3463
|
};
|
|
3464
3464
|
|
|
3465
3465
|
/**
|
|
3466
|
-
* Upload a
|
|
3466
|
+
* Upload a KYC document
|
|
3467
3467
|
* Upload ONE document and get back its provider document id, to reference
|
|
3468
3468
|
* from POST /v1/whatsapp/phone-numbers/kyc via `documents[].documentId`.
|
|
3469
3469
|
* Send the RAW file bytes as the request body (not base64); put the filename
|
|
@@ -3480,7 +3480,7 @@ export const uploadWhatsAppNumberKycDocument = <ThrowOnError extends boolean = f
|
|
|
3480
3480
|
};
|
|
3481
3481
|
|
|
3482
3482
|
/**
|
|
3483
|
-
* Pre-validate
|
|
3483
|
+
* Pre-validate KYC address
|
|
3484
3484
|
* Optional early check for the address step of a Tier 4 (end-user identity)
|
|
3485
3485
|
* registration: validates a postal address for deliverability BEFORE the full
|
|
3486
3486
|
* KYC submit, so it can be corrected before any documents are uploaded. The
|
|
@@ -3523,7 +3523,7 @@ export const createWhatsAppNumberKycLink = <ThrowOnError extends boolean = false
|
|
|
3523
3523
|
};
|
|
3524
3524
|
|
|
3525
3525
|
/**
|
|
3526
|
-
* Get
|
|
3526
|
+
* Get declined requirements
|
|
3527
3527
|
* For a number in `regulatory_declined`, returns ONLY the requirements the
|
|
3528
3528
|
* reviewer flagged declined, as a form spec (same shape as the KYC form GET).
|
|
3529
3529
|
* The customer fixes just those — Telnyx supports correcting a declined
|
|
@@ -3539,7 +3539,7 @@ export const getWhatsAppNumberRemediation = <ThrowOnError extends boolean = fals
|
|
|
3539
3539
|
};
|
|
3540
3540
|
|
|
3541
3541
|
/**
|
|
3542
|
-
*
|
|
3542
|
+
* Resubmit a declined number
|
|
3543
3543
|
* Submit corrected values/documents for the declined requirement(s). We
|
|
3544
3544
|
* PATCH them onto the SAME requirement group and re-submit it for approval;
|
|
3545
3545
|
* the number goes `regulatory_declined` → `pending_regulatory`. No new
|
|
@@ -3604,7 +3604,7 @@ export const listWhatsAppSandboxSessions = <ThrowOnError extends boolean = false
|
|
|
3604
3604
|
};
|
|
3605
3605
|
|
|
3606
3606
|
/**
|
|
3607
|
-
* Start a sandbox activation
|
|
3607
|
+
* Start a sandbox activation
|
|
3608
3608
|
* Creates (or refreshes) a pending sandbox session for the given phone and
|
|
3609
3609
|
* immediately fires the verified sandbox template from the shared sandbox
|
|
3610
3610
|
* number to that phone. The session activates when the phone owner replies
|
|
@@ -4379,7 +4379,7 @@ export const getWorkflowVersion = <ThrowOnError extends boolean = false>(options
|
|
|
4379
4379
|
};
|
|
4380
4380
|
|
|
4381
4381
|
/**
|
|
4382
|
-
* Restore a
|
|
4382
|
+
* Restore a workflow version
|
|
4383
4383
|
* Replace the current graph with the named version's snapshot. Before the swap, the current graph is itself snapshotted as a new version, so a restore is reversible. The workflow must be in `draft` or `paused` status (same gate as a normal graph edit). The returned workflow carries `restoredFromVersion` so the UI can surface which version was rolled back to.
|
|
4384
4384
|
*
|
|
4385
4385
|
*/
|
|
@@ -4638,7 +4638,7 @@ export const updateAdCampaignStatus = <ThrowOnError extends boolean = false>(opt
|
|
|
4638
4638
|
};
|
|
4639
4639
|
|
|
4640
4640
|
/**
|
|
4641
|
-
* Update a campaign
|
|
4641
|
+
* Update a campaign
|
|
4642
4642
|
* Campaign-level edits. At least one of `budget` or `bidStrategy` is required.
|
|
4643
4643
|
*
|
|
4644
4644
|
* - `budget` updates the CBO (Campaign Budget Optimization) budget. For ABO campaigns
|
|
@@ -4718,7 +4718,7 @@ export const duplicateAdCampaign = <ThrowOnError extends boolean = false>(option
|
|
|
4718
4718
|
};
|
|
4719
4719
|
|
|
4720
4720
|
/**
|
|
4721
|
-
* Update an ad set
|
|
4721
|
+
* Update an ad set
|
|
4722
4722
|
* Ad-set-level writes. Use this for ABO budget updates, ad-set-scoped
|
|
4723
4723
|
* pause/resume, and bid-strategy edits. At least one of `budget`,
|
|
4724
4724
|
* `status`, or `bidStrategy` is required.
|
|
@@ -4773,7 +4773,7 @@ export const getAdTree = <ThrowOnError extends boolean = false>(options?: Option
|
|
|
4773
4773
|
};
|
|
4774
4774
|
|
|
4775
4775
|
/**
|
|
4776
|
-
* Get daily
|
|
4776
|
+
* Get daily account metrics
|
|
4777
4777
|
* Returns daily aggregate metrics across all ads in a SocialAccount as a single
|
|
4778
4778
|
* time series — one row per calendar day in the requested range. Use this for
|
|
4779
4779
|
* dashboards that draw a daily-spend or daily-conversions chart, instead of
|
|
@@ -4861,7 +4861,7 @@ export const getAdAnalytics = <ThrowOnError extends boolean = false>(options: Op
|
|
|
4861
4861
|
};
|
|
4862
4862
|
|
|
4863
4863
|
/**
|
|
4864
|
-
*
|
|
4864
|
+
* Get ad tracking tags
|
|
4865
4865
|
* Unified read of the platform's native click-URL tracking params.
|
|
4866
4866
|
* - Meta (facebook/instagram): the creative's `url_tags` (and template_url_spec).
|
|
4867
4867
|
* - Google (googleads): the campaign's `trackingUrlTemplate` + `finalUrlSuffix`.
|
|
@@ -4878,7 +4878,7 @@ export const getAdTrackingTags = <ThrowOnError extends boolean = false>(options:
|
|
|
4878
4878
|
};
|
|
4879
4879
|
|
|
4880
4880
|
/**
|
|
4881
|
-
* Set
|
|
4881
|
+
* Set ad tracking tags
|
|
4882
4882
|
* Unified update. Send only the fields for the ad's platform:
|
|
4883
4883
|
* - Meta: `urlTags` (array of {key,value}). Meta creatives are immutable, so this rebuilds the
|
|
4884
4884
|
* creative and repoints the ad. By DEFAULT we PRESERVE the existing creative verbatim
|
|
@@ -4996,7 +4996,7 @@ export const createStandaloneAd = <ThrowOnError extends boolean = false>(options
|
|
|
4996
4996
|
};
|
|
4997
4997
|
|
|
4998
4998
|
/**
|
|
4999
|
-
* List submitted leads
|
|
4999
|
+
* List submitted leads
|
|
5000
5000
|
* Returns persisted Meta Lead Gen leads for your team, newest-first, with keyset pagination on `cursor`. Leads are ingested in real time from the `leadgen` webhook. Requires the Ads add-on.
|
|
5001
5001
|
*
|
|
5002
5002
|
*/
|
|
@@ -5008,7 +5008,7 @@ export const listLeads = <ThrowOnError extends boolean = false>(options?: Option
|
|
|
5008
5008
|
};
|
|
5009
5009
|
|
|
5010
5010
|
/**
|
|
5011
|
-
* List
|
|
5011
|
+
* List lead forms
|
|
5012
5012
|
* Lists the Lead Gen forms owned by the connected Facebook Page. Requires the Ads add-on.
|
|
5013
5013
|
*/
|
|
5014
5014
|
export const listLeadForms = <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<ListLeadFormsData, ThrowOnError>) => {
|
|
@@ -5019,7 +5019,7 @@ export const listLeadForms = <ThrowOnError extends boolean = false>(options: Opt
|
|
|
5019
5019
|
};
|
|
5020
5020
|
|
|
5021
5021
|
/**
|
|
5022
|
-
* Create a
|
|
5022
|
+
* Create a lead form
|
|
5023
5023
|
* Creates a Lead Gen form on the connected Facebook Page (POST /{page-id}/leadgen_forms). NOT idempotent — a retry creates a second form. Prefilled question types (EMAIL, PHONE, FULL_NAME, …) must omit label/key; CUSTOM questions require both. Requires the Ads add-on.
|
|
5024
5024
|
*
|
|
5025
5025
|
*/
|
|
@@ -5031,7 +5031,7 @@ export const createLeadForm = <ThrowOnError extends boolean = false>(options: Op
|
|
|
5031
5031
|
};
|
|
5032
5032
|
|
|
5033
5033
|
/**
|
|
5034
|
-
* Get a
|
|
5034
|
+
* Get a lead form
|
|
5035
5035
|
*/
|
|
5036
5036
|
export const getLeadForm = <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<GetLeadFormData, ThrowOnError>) => {
|
|
5037
5037
|
return (options?.client ?? client).get<GetLeadFormResponse, GetLeadFormError, ThrowOnError>({
|
|
@@ -5041,7 +5041,7 @@ export const getLeadForm = <ThrowOnError extends boolean = false>(options: Optio
|
|
|
5041
5041
|
};
|
|
5042
5042
|
|
|
5043
5043
|
/**
|
|
5044
|
-
* Archive a
|
|
5044
|
+
* Archive a lead form
|
|
5045
5045
|
* Meta has no hard delete for forms; this archives the form (status=ARCHIVED).
|
|
5046
5046
|
*/
|
|
5047
5047
|
export const archiveLeadForm = <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<ArchiveLeadFormData, ThrowOnError>) => {
|
|
@@ -5064,7 +5064,7 @@ export const listFormLeads = <ThrowOnError extends boolean = false>(options: Opt
|
|
|
5064
5064
|
};
|
|
5065
5065
|
|
|
5066
5066
|
/**
|
|
5067
|
-
* Create a
|
|
5067
|
+
* Create a test lead
|
|
5068
5068
|
* Submits a test lead against the form (POST /{form-id}/test_leads) to exercise retrieval without waiting for real ad impressions. Meta allows one test lead per form at a time.
|
|
5069
5069
|
*
|
|
5070
5070
|
*/
|
|
@@ -5077,7 +5077,7 @@ export const createTestLead = <ThrowOnError extends boolean = false>(options: Op
|
|
|
5077
5077
|
|
|
5078
5078
|
/**
|
|
5079
5079
|
* @deprecated
|
|
5080
|
-
* Search targeting interests
|
|
5080
|
+
* Search targeting interests
|
|
5081
5081
|
* Deprecated alias for `GET /v1/ads/targeting/search?dimension=interest`. Kept for
|
|
5082
5082
|
* backward compatibility, it returns the legacy `{ interests: [...] }` shape rather
|
|
5083
5083
|
* than the normalized `{ results: [...] }`. New integrations should use
|
|
@@ -5221,7 +5221,7 @@ export const addUsersToAdAudience = <ThrowOnError extends boolean = false>(optio
|
|
|
5221
5221
|
};
|
|
5222
5222
|
|
|
5223
5223
|
/**
|
|
5224
|
-
*
|
|
5224
|
+
* Get Event Match Quality
|
|
5225
5225
|
* Reads Meta Event Match Quality (EMQ) and pixel↔CAPI event coverage for a
|
|
5226
5226
|
* pixel/dataset, live from Meta's Dataset Quality API. Web events only (a
|
|
5227
5227
|
* Meta limitation). Meta-only; other platforms return 405. Requires the Ads add-on.
|
|
@@ -5235,7 +5235,7 @@ export const getConversionsQuality = <ThrowOnError extends boolean = false>(opti
|
|
|
5235
5235
|
};
|
|
5236
5236
|
|
|
5237
5237
|
/**
|
|
5238
|
-
* Send conversion events
|
|
5238
|
+
* Send conversion events
|
|
5239
5239
|
* Relay one or more conversion events to the target ad platform's native Conversions API.
|
|
5240
5240
|
* Platform is inferred from the provided `accountId`. Requires the Ads add-on.
|
|
5241
5241
|
*
|
|
@@ -5289,7 +5289,7 @@ export const sendConversions = <ThrowOnError extends boolean = false>(options: O
|
|
|
5289
5289
|
};
|
|
5290
5290
|
|
|
5291
5291
|
/**
|
|
5292
|
-
* Adjust
|
|
5292
|
+
* Adjust uploaded conversions
|
|
5293
5293
|
* Adjust conversions that were previously uploaded via `POST /v1/ads/conversions` —
|
|
5294
5294
|
* retract them, restate their value, or enhance them with first-party data. Requires
|
|
5295
5295
|
* the Ads add-on.
|
|
@@ -5328,7 +5328,7 @@ export const adjustConversions = <ThrowOnError extends boolean = false>(options:
|
|
|
5328
5328
|
};
|
|
5329
5329
|
|
|
5330
5330
|
/**
|
|
5331
|
-
* List destinations
|
|
5331
|
+
* List conversion destinations
|
|
5332
5332
|
* Returns the list of pixels (Meta), conversion actions (Google), or
|
|
5333
5333
|
* conversion rules (LinkedIn) accessible to the connected ads account.
|
|
5334
5334
|
* Use the returned `id` as `destinationId` when posting to
|
|
@@ -5353,7 +5353,7 @@ export const listConversionDestinations = <ThrowOnError extends boolean = false>
|
|
|
5353
5353
|
};
|
|
5354
5354
|
|
|
5355
5355
|
/**
|
|
5356
|
-
* Create a conversion destination
|
|
5356
|
+
* Create a conversion destination
|
|
5357
5357
|
* Create a new conversion destination on the platform. Supported for
|
|
5358
5358
|
* LinkedIn (conversion rule) and Google Ads (conversion action). Meta
|
|
5359
5359
|
* manages destinations in its own UI and returns 405.
|
|
@@ -5397,7 +5397,7 @@ export const createConversionDestination = <ThrowOnError extends boolean = false
|
|
|
5397
5397
|
};
|
|
5398
5398
|
|
|
5399
5399
|
/**
|
|
5400
|
-
*
|
|
5400
|
+
* Get a conversion destination
|
|
5401
5401
|
* LinkedIn-only today. Returns the full destination record for one
|
|
5402
5402
|
* conversion rule. The `adAccountId` query parameter is required because
|
|
5403
5403
|
* LinkedIn rules are scoped to a sponsored ad account.
|
|
@@ -5427,7 +5427,7 @@ export const updateConversionDestination = <ThrowOnError extends boolean = false
|
|
|
5427
5427
|
};
|
|
5428
5428
|
|
|
5429
5429
|
/**
|
|
5430
|
-
*
|
|
5430
|
+
* Delete a conversion destination
|
|
5431
5431
|
* LinkedIn-only today. LinkedIn does not expose hard-delete on conversion
|
|
5432
5432
|
* rules — what their UI calls "delete" is the same `enabled: false` flip
|
|
5433
5433
|
* we apply here. The rule remains fetchable via GET with
|
|
@@ -5446,7 +5446,7 @@ export const deleteConversionDestination = <ThrowOnError extends boolean = false
|
|
|
5446
5446
|
};
|
|
5447
5447
|
|
|
5448
5448
|
/**
|
|
5449
|
-
* List
|
|
5449
|
+
* List associated campaigns
|
|
5450
5450
|
* LinkedIn-only today. Returns the campaigns currently associated with
|
|
5451
5451
|
* this conversion rule. Note that auto-association on rule creation
|
|
5452
5452
|
* runs once at create time; campaigns created after the rule still need
|
|
@@ -5461,7 +5461,7 @@ export const listConversionAssociations = <ThrowOnError extends boolean = false>
|
|
|
5461
5461
|
};
|
|
5462
5462
|
|
|
5463
5463
|
/**
|
|
5464
|
-
* Associate campaigns
|
|
5464
|
+
* Associate campaigns
|
|
5465
5465
|
* Associate one or more campaigns with this conversion rule. Returns a
|
|
5466
5466
|
* per-campaign success/failure result so callers can retry only the
|
|
5467
5467
|
* rows that failed (e.g. wrong campaign type for the rule's objective).
|
|
@@ -5475,7 +5475,7 @@ export const addConversionAssociations = <ThrowOnError extends boolean = false>(
|
|
|
5475
5475
|
};
|
|
5476
5476
|
|
|
5477
5477
|
/**
|
|
5478
|
-
* Remove
|
|
5478
|
+
* Remove associated campaigns
|
|
5479
5479
|
* Remove one or more campaign associations from this conversion rule.
|
|
5480
5480
|
* Pass `adAccountId` and `campaignIds` as query parameters
|
|
5481
5481
|
* (`campaignIds` is comma-separated). The route also accepts a JSON
|
|
@@ -5493,7 +5493,7 @@ export const removeConversionAssociations = <ThrowOnError extends boolean = fals
|
|
|
5493
5493
|
};
|
|
5494
5494
|
|
|
5495
5495
|
/**
|
|
5496
|
-
*
|
|
5496
|
+
* Get attribution metrics
|
|
5497
5497
|
* LinkedIn-only today. Returns conversion-attribution metrics
|
|
5498
5498
|
* (`externalWebsiteConversions`, `externalWebsitePostClickConversions`,
|
|
5499
5499
|
* `externalWebsitePostViewConversions`, `conversionValueInLocalCurrency`,
|
|
@@ -5517,7 +5517,7 @@ export const getConversionMetrics = <ThrowOnError extends boolean = false>(optio
|
|
|
5517
5517
|
};
|
|
5518
5518
|
|
|
5519
5519
|
/**
|
|
5520
|
-
* List
|
|
5520
|
+
* List conversion events
|
|
5521
5521
|
* Returns the most recent conversion events sent through
|
|
5522
5522
|
* `POST /v1/whatsapp/conversions` for the given WhatsApp account.
|
|
5523
5523
|
* Sourced from delivery logs (Axiom `late` dataset), so the visible
|
|
@@ -5579,7 +5579,7 @@ export const sendWhatsAppConversion = <ThrowOnError extends boolean = false>(opt
|
|
|
5579
5579
|
};
|
|
5580
5580
|
|
|
5581
5581
|
/**
|
|
5582
|
-
* Create Click-to-WhatsApp ad
|
|
5582
|
+
* Create Click-to-WhatsApp ad
|
|
5583
5583
|
* Creates one or more Click-to-WhatsApp (CTWA) ads on Meta under a single campaign and ad set. When tapped, each ad opens a WhatsApp conversation with the business attached to the supplied Facebook Page. The full hierarchy (campaign, ad set, creative(s), ad(s)) is created and activated in one call. The CTA is locked to WHATSAPP_MESSAGE and the destination is hard-coded to api.whatsapp.com/send; Meta resolves the actual WhatsApp number from the Page-to-WA pairing configured in Page settings or Business Manager.
|
|
5584
5584
|
*
|
|
5585
5585
|
* Supports two mutually-exclusive shapes:
|
|
@@ -5598,7 +5598,7 @@ export const createCtwaAd = <ThrowOnError extends boolean = false>(options: Opti
|
|
|
5598
5598
|
};
|
|
5599
5599
|
|
|
5600
5600
|
/**
|
|
5601
|
-
* List tracking tags
|
|
5601
|
+
* List tracking tags
|
|
5602
5602
|
* Returns the tracking tags (Meta Pixels) the connected ads account can
|
|
5603
5603
|
* see. Pass `?adAccountId=act_...` to scope the list to a single ad
|
|
5604
5604
|
* account; omit it to list every pixel reachable by the token (the name
|
|
@@ -5620,7 +5620,7 @@ export const listTrackingTags = <ThrowOnError extends boolean = false>(options:
|
|
|
5620
5620
|
};
|
|
5621
5621
|
|
|
5622
5622
|
/**
|
|
5623
|
-
* Create a tracking tag
|
|
5623
|
+
* Create a tracking tag
|
|
5624
5624
|
* Creates a Meta Pixel on the given ad account (`POST /act_{id}/adspixels`
|
|
5625
5625
|
* — `name` is the only input). Returns the created tag including its
|
|
5626
5626
|
* install `code`. The pixel is owned by the Business Manager that owns the
|
|
@@ -5644,7 +5644,7 @@ export const createTrackingTag = <ThrowOnError extends boolean = false>(options:
|
|
|
5644
5644
|
};
|
|
5645
5645
|
|
|
5646
5646
|
/**
|
|
5647
|
-
*
|
|
5647
|
+
* Get a tracking tag
|
|
5648
5648
|
* Returns the full tag record including the base-code `code` snippet,
|
|
5649
5649
|
* `lastFiredTime`, `ownerBusinessId`, `isUnavailable`, etc. Meta only
|
|
5650
5650
|
* (platform `metaads`); other platforms return 405.
|
|
@@ -5658,7 +5658,7 @@ export const getTrackingTag = <ThrowOnError extends boolean = false>(options: Op
|
|
|
5658
5658
|
};
|
|
5659
5659
|
|
|
5660
5660
|
/**
|
|
5661
|
-
* Update a tracking tag
|
|
5661
|
+
* Update a tracking tag
|
|
5662
5662
|
* Partial-update a pixel. Whitelisted fields: `name` (rename),
|
|
5663
5663
|
* `enableAutomaticMatching`, `automaticMatchingFields`,
|
|
5664
5664
|
* `firstPartyCookieStatus`, `dataUseSetting`. At least one is required.
|
|
@@ -5679,7 +5679,7 @@ export const updateTrackingTag = <ThrowOnError extends boolean = false>(options:
|
|
|
5679
5679
|
};
|
|
5680
5680
|
|
|
5681
5681
|
/**
|
|
5682
|
-
* List
|
|
5682
|
+
* List accounts it is shared with
|
|
5683
5683
|
* Meta only (platform `metaads`); other platforms return 405.
|
|
5684
5684
|
*/
|
|
5685
5685
|
export const listTrackingTagSharedAccounts = <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<ListTrackingTagSharedAccountsData, ThrowOnError>) => {
|
|
@@ -5690,7 +5690,7 @@ export const listTrackingTagSharedAccounts = <ThrowOnError extends boolean = fal
|
|
|
5690
5690
|
};
|
|
5691
5691
|
|
|
5692
5692
|
/**
|
|
5693
|
-
* Share
|
|
5693
|
+
* Share with an ad account
|
|
5694
5694
|
* Shares the pixel with another ad account so campaigns/audiences in that
|
|
5695
5695
|
* account can use it. Requires that you administer both the pixel's owning
|
|
5696
5696
|
* Business Manager and the target ad account; a pixel on a personal
|
|
@@ -5706,7 +5706,7 @@ export const addTrackingTagSharedAccount = <ThrowOnError extends boolean = false
|
|
|
5706
5706
|
};
|
|
5707
5707
|
|
|
5708
5708
|
/**
|
|
5709
|
-
* Stop sharing
|
|
5709
|
+
* Stop sharing with an account
|
|
5710
5710
|
* `adAccountId` may be passed as a query parameter (recommended) or as a
|
|
5711
5711
|
* JSON body field for clients that can send DELETE bodies. Meta only
|
|
5712
5712
|
* (platform `metaads`); other platforms return 405.
|
|
@@ -5720,7 +5720,7 @@ export const removeTrackingTagSharedAccount = <ThrowOnError extends boolean = fa
|
|
|
5720
5720
|
};
|
|
5721
5721
|
|
|
5722
5722
|
/**
|
|
5723
|
-
*
|
|
5723
|
+
* Get aggregated event stats
|
|
5724
5724
|
* Returns aggregated event counts for the pixel (`GET /{pixel_id}/stats`).
|
|
5725
5725
|
* Rows are passed through from Meta as-is — their shape depends on the
|
|
5726
5726
|
* `aggregation` requested. Meta only (platform `metaads`); other platforms
|
|
@@ -7425,6 +7425,10 @@ export type ListPostsData = {
|
|
|
7425
7425
|
* Sort order for results.
|
|
7426
7426
|
*/
|
|
7427
7427
|
sortBy?: 'scheduled-desc' | 'scheduled-asc' | 'created-desc' | 'created-asc' | 'status' | 'platform';
|
|
7428
|
+
/**
|
|
7429
|
+
* Which collection to read. `zernio` (default) returns posts authored through Zernio. `external` returns posts synced from the platform (existing/historical posts that were published outside Zernio). Combine with `accountId` and paginate via `page`/`limit` to walk the full synced history (we keep up to the last ~12 months per account).
|
|
7430
|
+
*/
|
|
7431
|
+
source?: 'zernio' | 'external';
|
|
7428
7432
|
status?: 'draft' | 'scheduled' | 'published' | 'failed';
|
|
7429
7433
|
};
|
|
7430
7434
|
};
|