@zernio/node 0.2.1050 → 0.2.1051
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 +5 -0
- package/dist/index.d.mts +150 -53
- package/dist/index.d.ts +150 -53
- package/dist/index.js +13 -1
- package/dist/index.mjs +13 -1
- package/package.json +1 -1
- package/src/client.ts +8 -0
- package/src/generated/sdk.gen.ts +13 -1
- package/src/generated/types.gen.ts +152 -53
|
@@ -1861,6 +1861,60 @@ export type syncStatus = 'synced' | 'pending' | 'partial' | 'unavailable';
|
|
|
1861
1861
|
|
|
1862
1862
|
export type mediaType = 'image' | 'video' | 'carousel' | 'text';
|
|
1863
1863
|
|
|
1864
|
+
/**
|
|
1865
|
+
* One API changelog entry, as shown on https://docs.zernio.com/changelog.
|
|
1866
|
+
*/
|
|
1867
|
+
export type ApiChangelogEntry = {
|
|
1868
|
+
/**
|
|
1869
|
+
* Stable entry id; the same entry is never published twice.
|
|
1870
|
+
*/
|
|
1871
|
+
id: string;
|
|
1872
|
+
type: 'new_feature' | 'breaking_change' | 'improvement' | 'deprecation' | 'minor';
|
|
1873
|
+
/**
|
|
1874
|
+
* Platform and area slugs the entry is about: a platform (`instagram`, `facebook`, `threads`, `tiktok`, `x`, `linkedin`, `youtube`, `pinterest`, `reddit`, `bluesky`, `telegram`, `snapchat`, `whatsapp`, `discord`, `slack`, `google-business`, `imessage`), an ads platform (`meta-ads`, `google-ads`, `tiktok-ads`, `linkedin-ads`, `pinterest-ads`, `x-ads`) or an area (`ads`, `publishing`, `inbox`, `telephony`, `commerce`, `analytics`, `webhooks`, `general`). Filter with the `platform` query parameter.
|
|
1875
|
+
*/
|
|
1876
|
+
platforms: Array<(string)>;
|
|
1877
|
+
/**
|
|
1878
|
+
* The announcement, in Markdown.
|
|
1879
|
+
*/
|
|
1880
|
+
message: string;
|
|
1881
|
+
publishedAt: string;
|
|
1882
|
+
/**
|
|
1883
|
+
* The `info.version` of the OpenAPI spec the entry describes, when known.
|
|
1884
|
+
*/
|
|
1885
|
+
specVersion: (string) | null;
|
|
1886
|
+
/**
|
|
1887
|
+
* The entry on the docs changelog.
|
|
1888
|
+
*/
|
|
1889
|
+
url: string;
|
|
1890
|
+
/**
|
|
1891
|
+
* Deterministic diff of the OpenAPI spec behind the entry. Empty lists when nothing of that kind changed.
|
|
1892
|
+
*/
|
|
1893
|
+
changes: {
|
|
1894
|
+
endpoints: {
|
|
1895
|
+
added: Array<ApiChangelogOperationRef>;
|
|
1896
|
+
removed: Array<ApiChangelogOperationRef>;
|
|
1897
|
+
modified: Array<ApiChangelogOperationRef>;
|
|
1898
|
+
};
|
|
1899
|
+
schemas: {
|
|
1900
|
+
/**
|
|
1901
|
+
* Component schema names.
|
|
1902
|
+
*/
|
|
1903
|
+
added: Array<(string)>;
|
|
1904
|
+
removed: Array<(string)>;
|
|
1905
|
+
modified: Array<(string)>;
|
|
1906
|
+
};
|
|
1907
|
+
};
|
|
1908
|
+
};
|
|
1909
|
+
|
|
1910
|
+
export type type2 = 'new_feature' | 'breaking_change' | 'improvement' | 'deprecation' | 'minor';
|
|
1911
|
+
|
|
1912
|
+
export type ApiChangelogOperationRef = {
|
|
1913
|
+
method: string;
|
|
1914
|
+
path: string;
|
|
1915
|
+
operationId?: string;
|
|
1916
|
+
};
|
|
1917
|
+
|
|
1864
1918
|
export type ApiKey = {
|
|
1865
1919
|
id?: string;
|
|
1866
1920
|
name?: string;
|
|
@@ -3099,7 +3153,7 @@ export type CommentAutomationTemplate = {
|
|
|
3099
3153
|
elements: Array<CommentAutomationTemplateElement>;
|
|
3100
3154
|
};
|
|
3101
3155
|
|
|
3102
|
-
export type
|
|
3156
|
+
export type type3 = 'generic';
|
|
3103
3157
|
|
|
3104
3158
|
/**
|
|
3105
3159
|
* Facebook only. How Messenger renders each element imageUrl: horizontal (1.91:1, the default) or square (1:1). Instagram has no such setting, so an Instagram automation carrying it is a 400.
|
|
@@ -3271,7 +3325,7 @@ export type platform5 = 'shopify';
|
|
|
3271
3325
|
|
|
3272
3326
|
export type method = 'code' | 'automatic';
|
|
3273
3327
|
|
|
3274
|
-
export type
|
|
3328
|
+
export type type4 = 'percentage' | 'fixed_amount' | 'free_shipping' | 'buy_x_get_y' | 'app';
|
|
3275
3329
|
|
|
3276
3330
|
export type status10 = 'active' | 'scheduled' | 'expired';
|
|
3277
3331
|
|
|
@@ -3349,7 +3403,7 @@ export type CommerceMenuItem = {
|
|
|
3349
3403
|
items?: Array<CommerceMenuItem>;
|
|
3350
3404
|
};
|
|
3351
3405
|
|
|
3352
|
-
export type
|
|
3406
|
+
export type type5 = 'frontpage' | 'collection' | 'collections' | 'product' | 'catalog' | 'page' | 'blog' | 'article' | 'search' | 'shop_policy' | 'http' | 'metaobject' | 'customer_account_page';
|
|
3353
3407
|
|
|
3354
3408
|
export type CommerceMenuItemInput = {
|
|
3355
3409
|
title: string;
|
|
@@ -4972,7 +5026,7 @@ export type DmButton = {
|
|
|
4972
5026
|
phone?: string;
|
|
4973
5027
|
};
|
|
4974
5028
|
|
|
4975
|
-
export type
|
|
5029
|
+
export type type6 = 'url' | 'postback' | 'phone';
|
|
4976
5030
|
|
|
4977
5031
|
/**
|
|
4978
5032
|
* Canonical error envelope. `error` is the human-readable message; `type`,
|
|
@@ -5093,7 +5147,7 @@ export type ErrorResponse = {
|
|
|
5093
5147
|
/**
|
|
5094
5148
|
* Error class for programmatic handling.
|
|
5095
5149
|
*/
|
|
5096
|
-
export type
|
|
5150
|
+
export type type7 = 'invalid_request_error' | 'authentication_error' | 'permission_error' | 'not_found' | 'rate_limit_error' | 'platform_error' | 'api_error';
|
|
5097
5151
|
|
|
5098
5152
|
/**
|
|
5099
5153
|
* Meta ad create failures only. The step that failed: `media` (image/video download or upload), `campaign`, `adset`, `creative`, `ad` (the ad POST itself, where Meta's code 31 / 3858385 hold and 100 / 1359188 payment rejections land), `activation` (switching the created objects on), or `other` (a read or check before any write).
|
|
@@ -5134,7 +5188,7 @@ export type ExternalPostMediaItem = {
|
|
|
5134
5188
|
unavailableReason?: 'platform_withheld';
|
|
5135
5189
|
};
|
|
5136
5190
|
|
|
5137
|
-
export type
|
|
5191
|
+
export type type8 = 'image' | 'video';
|
|
5138
5192
|
|
|
5139
5193
|
/**
|
|
5140
5194
|
* unavailable means the media file could not be retrieved (url is null or, for LinkedIn videos, a cover image standing in for the file). available or absent means the file is available at url (older synced items omit the field).
|
|
@@ -5861,7 +5915,7 @@ export type topicType = 'STANDARD' | 'EVENT' | 'OFFER';
|
|
|
5861
5915
|
/**
|
|
5862
5916
|
* Button action type: LEARN_MORE, BOOK, ORDER, SHOP, SIGN_UP, CALL
|
|
5863
5917
|
*/
|
|
5864
|
-
export type
|
|
5918
|
+
export type type9 = 'LEARN_MORE' | 'BOOK' | 'ORDER' | 'SHOP' | 'SIGN_UP' | 'CALL';
|
|
5865
5919
|
|
|
5866
5920
|
/**
|
|
5867
5921
|
* A Google Business Profile review, as returned by every gmb-reviews read endpoint.
|
|
@@ -6179,7 +6233,7 @@ export type GoogleListingGroupFilterNode = {
|
|
|
6179
6233
|
} | null;
|
|
6180
6234
|
};
|
|
6181
6235
|
|
|
6182
|
-
export type
|
|
6236
|
+
export type type10 = 'SUBDIVISION' | 'UNIT_INCLUDED' | 'UNIT_EXCLUDED';
|
|
6183
6237
|
|
|
6184
6238
|
export type GoogleListingGroupNode = {
|
|
6185
6239
|
dimension: GoogleListingGroupDimension;
|
|
@@ -7708,7 +7762,7 @@ export type MediaItem = {
|
|
|
7708
7762
|
tiktokProcessed?: boolean;
|
|
7709
7763
|
};
|
|
7710
7764
|
|
|
7711
|
-
export type
|
|
7765
|
+
export type type11 = 'image' | 'video' | 'gif' | 'document';
|
|
7712
7766
|
|
|
7713
7767
|
export type MediaUploadResponse = {
|
|
7714
7768
|
files?: Array<UploadedFile>;
|
|
@@ -8656,7 +8710,7 @@ export type PortfolioBidStrategy = {
|
|
|
8656
8710
|
targetRoas?: (number) | null;
|
|
8657
8711
|
};
|
|
8658
8712
|
|
|
8659
|
-
export type
|
|
8713
|
+
export type type12 = 'TARGET_CPA' | 'TARGET_ROAS' | 'MAXIMIZE_CONVERSIONS' | 'MAXIMIZE_CONVERSION_VALUE';
|
|
8660
8714
|
|
|
8661
8715
|
export type Post = {
|
|
8662
8716
|
_id?: string;
|
|
@@ -9303,7 +9357,7 @@ export type RcsContent = {
|
|
|
9303
9357
|
suggestions?: Array<RcsSuggestion>;
|
|
9304
9358
|
};
|
|
9305
9359
|
|
|
9306
|
-
export type
|
|
9360
|
+
export type type13 = 'text';
|
|
9307
9361
|
|
|
9308
9362
|
export type orientation = 'VERTICAL' | 'HORIZONTAL';
|
|
9309
9363
|
|
|
@@ -9416,7 +9470,7 @@ export type RcsSuggestion = {
|
|
|
9416
9470
|
postbackData?: string;
|
|
9417
9471
|
};
|
|
9418
9472
|
|
|
9419
|
-
export type
|
|
9473
|
+
export type type14 = 'reply';
|
|
9420
9474
|
|
|
9421
9475
|
export type application = 'BROWSER' | 'WEBVIEW';
|
|
9422
9476
|
|
|
@@ -10753,7 +10807,7 @@ export type UploadedFile = {
|
|
|
10753
10807
|
mimeType?: string;
|
|
10754
10808
|
};
|
|
10755
10809
|
|
|
10756
|
-
export type
|
|
10810
|
+
export type type15 = 'image' | 'video' | 'document';
|
|
10757
10811
|
|
|
10758
10812
|
export type UploadTokenResponse = {
|
|
10759
10813
|
token?: string;
|
|
@@ -11301,7 +11355,7 @@ export type Webhook = {
|
|
|
11301
11355
|
/**
|
|
11302
11356
|
* Events subscribed to
|
|
11303
11357
|
*/
|
|
11304
|
-
events?: Array<('post.scheduled' | 'post.published' | 'post.failed' | 'post.partial' | 'post.cancelled' | 'post.recycled' | 'post.platform.published' | 'post.platform.failed' | 'post.platform.deleted' | 'post.tiktok.url_resolved' | 'post.external.created' | 'post.external.updated' | 'post.external.deleted' | 'account.connected' | 'account.disconnected' | 'account.ads.initial_sync_completed' | 'account.ads.sync_failed' | 'account.ads.sync_recovered' | 'analytics.synced' | 'message.received' | 'conversation.started' | 'conversation.control_changed' | 'call.received' | 'call.ended' | 'call.failed' | 'call.permission_request' | 'message.sent' | 'message.edited' | 'message.deleted' | 'message.delivered' | 'message.read' | 'message.played' | 'message.failed' | 'reaction.received' | 'referral.received' | 'comment.received' | 'review.new' | 'review.updated' | 'lead.received' | 'ad.status_changed' | 'whatsapp.template.status_updated' | 'whatsapp.template.category_updated' | 'whatsapp.account.name_status_updated' | 'whatsapp.account.quality_updated' | 'whatsapp.account.status_updated' | 'whatsapp.account.alert_received' | 'whatsapp.contact.identity_changed' | 'whatsapp.automatic_event' | 'whatsapp.number.activated' | 'whatsapp.number.declined' | 'whatsapp.number.action_required' | 'whatsapp.number.verification_required' | 'whatsapp.number.suspended' | 'whatsapp.number.reactivated' | 'whatsapp.number.released' | 'whatsapp.number.kyc_submitted' | 'phone_number.stock_available' | 'verification.approved' | 'verification.failed' | 'sms.registration.action_required' | 'sms.registration.status_updated' | 'branded_calling.identity.status_updated' | 'branded_calling.identity.action_required' | 'branded_calling.number.status_updated' | 'rcs.agent.status_updated' | 'commerce.product.created' | 'commerce.product.updated' | 'commerce.product.deleted')>;
|
|
11358
|
+
events?: Array<('post.scheduled' | 'post.published' | 'post.failed' | 'post.partial' | 'post.cancelled' | 'post.recycled' | 'post.platform.published' | 'post.platform.failed' | 'post.platform.deleted' | 'post.tiktok.url_resolved' | 'post.external.created' | 'post.external.updated' | 'post.external.deleted' | 'account.connected' | 'account.disconnected' | 'account.ads.initial_sync_completed' | 'account.ads.sync_failed' | 'account.ads.sync_recovered' | 'analytics.synced' | 'message.received' | 'conversation.started' | 'conversation.control_changed' | 'call.received' | 'call.ended' | 'call.failed' | 'call.permission_request' | 'message.sent' | 'message.edited' | 'message.deleted' | 'message.delivered' | 'message.read' | 'message.played' | 'message.failed' | 'reaction.received' | 'referral.received' | 'comment.received' | 'review.new' | 'review.updated' | 'lead.received' | 'ad.status_changed' | 'whatsapp.template.status_updated' | 'whatsapp.template.category_updated' | 'whatsapp.account.name_status_updated' | 'whatsapp.account.quality_updated' | 'whatsapp.account.status_updated' | 'whatsapp.account.alert_received' | 'whatsapp.contact.identity_changed' | 'whatsapp.automatic_event' | 'whatsapp.number.activated' | 'whatsapp.number.declined' | 'whatsapp.number.action_required' | 'whatsapp.number.verification_required' | 'whatsapp.number.suspended' | 'whatsapp.number.reactivated' | 'whatsapp.number.released' | 'whatsapp.number.kyc_submitted' | 'phone_number.stock_available' | 'verification.approved' | 'verification.failed' | 'api.changelog.published' | 'sms.registration.action_required' | 'sms.registration.status_updated' | 'branded_calling.identity.status_updated' | 'branded_calling.identity.action_required' | 'branded_calling.number.status_updated' | 'rcs.agent.status_updated' | 'commerce.product.created' | 'commerce.product.updated' | 'commerce.product.deleted')>;
|
|
11305
11359
|
/**
|
|
11306
11360
|
* Whether webhook delivery is enabled
|
|
11307
11361
|
*/
|
|
@@ -11905,6 +11959,21 @@ export type WebhookPayloadAnalyticsSynced = {
|
|
|
11905
11959
|
|
|
11906
11960
|
export type event7 = 'analytics.synced';
|
|
11907
11961
|
|
|
11962
|
+
export type WebhookPayloadApiChangelogPublished = {
|
|
11963
|
+
/**
|
|
11964
|
+
* Stable webhook event ID: the dedupe key, also sent as the X-Zernio-Event-Id header and identical on every retry and redelivery. It identifies the event only, never an account or other resource.
|
|
11965
|
+
*/
|
|
11966
|
+
id: string;
|
|
11967
|
+
event: 'api.changelog.published';
|
|
11968
|
+
entry: ApiChangelogEntry;
|
|
11969
|
+
/**
|
|
11970
|
+
* UTC time at which Zernio generated this event (set once when the event payload is built, before delivery is queued). Retries and redeliveries keep the original value, so it reflects the event, not the delivery attempt.
|
|
11971
|
+
*/
|
|
11972
|
+
timestamp: string;
|
|
11973
|
+
};
|
|
11974
|
+
|
|
11975
|
+
export type event8 = 'api.changelog.published';
|
|
11976
|
+
|
|
11908
11977
|
/**
|
|
11909
11978
|
* Webhook payload for the `call.ended` event. Fires on call hangup
|
|
11910
11979
|
* with the duration and a zero-markup billing breakdown.
|
|
@@ -11973,7 +12042,7 @@ export type WebhookPayloadCallEnded = {
|
|
|
11973
12042
|
timestamp: string;
|
|
11974
12043
|
};
|
|
11975
12044
|
|
|
11976
|
-
export type
|
|
12045
|
+
export type event9 = 'call.ended';
|
|
11977
12046
|
|
|
11978
12047
|
/**
|
|
11979
12048
|
* Webhook payload for the `call.failed` event. Fired when a call
|
|
@@ -12007,7 +12076,7 @@ export type WebhookPayloadCallFailed = {
|
|
|
12007
12076
|
timestamp: string;
|
|
12008
12077
|
};
|
|
12009
12078
|
|
|
12010
|
-
export type
|
|
12079
|
+
export type event10 = 'call.failed';
|
|
12011
12080
|
|
|
12012
12081
|
/**
|
|
12013
12082
|
* Webhook payload for the `call.permission_request` event. Fires
|
|
@@ -12044,7 +12113,7 @@ export type WebhookPayloadCallPermissionRequest = {
|
|
|
12044
12113
|
timestamp: string;
|
|
12045
12114
|
};
|
|
12046
12115
|
|
|
12047
|
-
export type
|
|
12116
|
+
export type event11 = 'call.permission_request';
|
|
12048
12117
|
|
|
12049
12118
|
export type response = 'accept' | 'reject';
|
|
12050
12119
|
|
|
@@ -12098,7 +12167,7 @@ export type WebhookPayloadCallReceived = {
|
|
|
12098
12167
|
timestamp: string;
|
|
12099
12168
|
};
|
|
12100
12169
|
|
|
12101
|
-
export type
|
|
12170
|
+
export type event12 = 'call.received';
|
|
12102
12171
|
|
|
12103
12172
|
/**
|
|
12104
12173
|
* Webhook payload for comment received events (Instagram, Facebook, Threads, YouTube, LinkedIn, Bluesky, Reddit, TikTok). X/Twitter does NOT fire this event. TikTok events carry only the author id: the comment.update webhook has no username, picture or owner flag.
|
|
@@ -12254,7 +12323,7 @@ export type WebhookPayloadComment = {
|
|
|
12254
12323
|
timestamp: string;
|
|
12255
12324
|
};
|
|
12256
12325
|
|
|
12257
|
-
export type
|
|
12326
|
+
export type event13 = 'comment.received';
|
|
12258
12327
|
|
|
12259
12328
|
export type platform13 = 'instagram' | 'facebook' | 'threads' | 'youtube' | 'linkedin' | 'bluesky' | 'reddit' | 'tiktok';
|
|
12260
12329
|
|
|
@@ -12293,9 +12362,9 @@ export type WebhookPayloadCommerceProduct = {
|
|
|
12293
12362
|
};
|
|
12294
12363
|
};
|
|
12295
12364
|
|
|
12296
|
-
export type
|
|
12365
|
+
export type event14 = 'commerce.product.created' | 'commerce.product.updated' | 'commerce.product.deleted';
|
|
12297
12366
|
|
|
12298
|
-
export type
|
|
12367
|
+
export type type16 = 'product';
|
|
12299
12368
|
|
|
12300
12369
|
/**
|
|
12301
12370
|
* WhatsApp only. Who answers a conversation changed: Meta Business Agent took it over,
|
|
@@ -12331,7 +12400,7 @@ export type WebhookPayloadConversationControlChanged = {
|
|
|
12331
12400
|
timestamp: string;
|
|
12332
12401
|
};
|
|
12333
12402
|
|
|
12334
|
-
export type
|
|
12403
|
+
export type event15 = 'conversation.control_changed';
|
|
12335
12404
|
|
|
12336
12405
|
/**
|
|
12337
12406
|
* Who answers now. ai_agent: Meta Business Agent; app: you; other: another partner app on the number.
|
|
@@ -12368,7 +12437,7 @@ export type WebhookPayloadConversationStarted = {
|
|
|
12368
12437
|
timestamp: string;
|
|
12369
12438
|
};
|
|
12370
12439
|
|
|
12371
|
-
export type
|
|
12440
|
+
export type event16 = 'conversation.started';
|
|
12372
12441
|
|
|
12373
12442
|
/**
|
|
12374
12443
|
* Webhook payload for post.external.created / post.external.updated /
|
|
@@ -12400,7 +12469,7 @@ export type WebhookPayloadExternalPost = {
|
|
|
12400
12469
|
timestamp: string;
|
|
12401
12470
|
};
|
|
12402
12471
|
|
|
12403
|
-
export type
|
|
12472
|
+
export type event17 = 'post.external.created' | 'post.external.updated' | 'post.external.deleted';
|
|
12404
12473
|
|
|
12405
12474
|
/**
|
|
12406
12475
|
* Webhook payload for lead.received events (Meta Lead Gen / Instant Forms).
|
|
@@ -12471,7 +12540,7 @@ export type WebhookPayloadLead = {
|
|
|
12471
12540
|
timestamp: string;
|
|
12472
12541
|
};
|
|
12473
12542
|
|
|
12474
|
-
export type
|
|
12543
|
+
export type event18 = 'lead.received';
|
|
12475
12544
|
|
|
12476
12545
|
export type platform14 = 'facebook';
|
|
12477
12546
|
|
|
@@ -13030,7 +13099,7 @@ export type WebhookPayloadMessage = {
|
|
|
13030
13099
|
timestamp: string;
|
|
13031
13100
|
};
|
|
13032
13101
|
|
|
13033
|
-
export type
|
|
13102
|
+
export type event19 = 'message.received';
|
|
13034
13103
|
|
|
13035
13104
|
/**
|
|
13036
13105
|
* Which Zernio surface produced the message. Always present and
|
|
@@ -13091,7 +13160,7 @@ export type WebhookPayloadMessageDeleted = {
|
|
|
13091
13160
|
timestamp: string;
|
|
13092
13161
|
};
|
|
13093
13162
|
|
|
13094
|
-
export type
|
|
13163
|
+
export type event20 = 'message.deleted';
|
|
13095
13164
|
|
|
13096
13165
|
/**
|
|
13097
13166
|
* Shared payload for message.delivered, message.read, message.played and
|
|
@@ -13154,7 +13223,7 @@ export type WebhookPayloadMessageDeliveryStatus = {
|
|
|
13154
13223
|
timestamp: string;
|
|
13155
13224
|
};
|
|
13156
13225
|
|
|
13157
|
-
export type
|
|
13226
|
+
export type event21 = 'message.delivered' | 'message.read' | 'message.played' | 'message.failed';
|
|
13158
13227
|
|
|
13159
13228
|
/**
|
|
13160
13229
|
* Webhook payload for message.edited events. Fires when the sender
|
|
@@ -13192,7 +13261,7 @@ export type WebhookPayloadMessageEdited = {
|
|
|
13192
13261
|
timestamp: string;
|
|
13193
13262
|
};
|
|
13194
13263
|
|
|
13195
|
-
export type
|
|
13264
|
+
export type event22 = 'message.edited';
|
|
13196
13265
|
|
|
13197
13266
|
/**
|
|
13198
13267
|
* Webhook payload for message sent events (fired when a message is sent via the API, or from the WhatsApp Business app on Coexistence numbers)
|
|
@@ -13410,7 +13479,7 @@ export type WebhookPayloadMessageSent = {
|
|
|
13410
13479
|
timestamp: string;
|
|
13411
13480
|
};
|
|
13412
13481
|
|
|
13413
|
-
export type
|
|
13482
|
+
export type event23 = 'message.sent';
|
|
13414
13483
|
|
|
13415
13484
|
/**
|
|
13416
13485
|
* Every platform whose outgoing messages Zernio observes. sms is absent on purpose: its carrier receipts update delivery status and never raise message.sent.
|
|
@@ -13464,7 +13533,7 @@ export type WebhookPayloadPhoneNumberStockAvailable = {
|
|
|
13464
13533
|
timestamp: string;
|
|
13465
13534
|
};
|
|
13466
13535
|
|
|
13467
|
-
export type
|
|
13536
|
+
export type event24 = 'phone_number.stock_available';
|
|
13468
13537
|
|
|
13469
13538
|
/**
|
|
13470
13539
|
* Webhook payload for post events
|
|
@@ -13514,7 +13583,7 @@ export type WebhookPayloadPost = {
|
|
|
13514
13583
|
timestamp: string;
|
|
13515
13584
|
};
|
|
13516
13585
|
|
|
13517
|
-
export type
|
|
13586
|
+
export type event25 = 'post.scheduled' | 'post.published' | 'post.failed' | 'post.partial' | 'post.cancelled' | 'post.recycled';
|
|
13518
13587
|
|
|
13519
13588
|
/**
|
|
13520
13589
|
* Webhook payload for the per-platform terminal events
|
|
@@ -13633,7 +13702,7 @@ export type WebhookPayloadPostPlatform = {
|
|
|
13633
13702
|
timestamp: string;
|
|
13634
13703
|
};
|
|
13635
13704
|
|
|
13636
|
-
export type
|
|
13705
|
+
export type event26 = 'post.platform.published' | 'post.platform.failed' | 'post.platform.deleted' | 'post.tiktok.url_resolved';
|
|
13637
13706
|
|
|
13638
13707
|
/**
|
|
13639
13708
|
* Terminal status this event fires on. Matches the event suffix.
|
|
@@ -13693,7 +13762,7 @@ export type WebhookPayloadReaction = {
|
|
|
13693
13762
|
timestamp: string;
|
|
13694
13763
|
};
|
|
13695
13764
|
|
|
13696
|
-
export type
|
|
13765
|
+
export type event27 = 'reaction.received';
|
|
13697
13766
|
|
|
13698
13767
|
export type action = 'added' | 'removed';
|
|
13699
13768
|
|
|
@@ -13767,7 +13836,7 @@ export type WebhookPayloadReferral = {
|
|
|
13767
13836
|
timestamp: string;
|
|
13768
13837
|
};
|
|
13769
13838
|
|
|
13770
|
-
export type
|
|
13839
|
+
export type event28 = 'referral.received';
|
|
13771
13840
|
|
|
13772
13841
|
/**
|
|
13773
13842
|
* Webhook payload for the review.new event (new review posted on a connected account).
|
|
@@ -13794,7 +13863,7 @@ export type WebhookPayloadReviewNew = {
|
|
|
13794
13863
|
timestamp: string;
|
|
13795
13864
|
};
|
|
13796
13865
|
|
|
13797
|
-
export type
|
|
13866
|
+
export type event29 = 'review.new';
|
|
13798
13867
|
|
|
13799
13868
|
/**
|
|
13800
13869
|
* Webhook payload for the review.updated event. Fired when the reviewer edits their
|
|
@@ -13827,7 +13896,7 @@ export type WebhookPayloadReviewUpdated = {
|
|
|
13827
13896
|
timestamp: string;
|
|
13828
13897
|
};
|
|
13829
13898
|
|
|
13830
|
-
export type
|
|
13899
|
+
export type event30 = 'review.updated';
|
|
13831
13900
|
|
|
13832
13901
|
/**
|
|
13833
13902
|
* Webhook payload for test deliveries
|
|
@@ -13848,7 +13917,7 @@ export type WebhookPayloadTest = {
|
|
|
13848
13917
|
timestamp: string;
|
|
13849
13918
|
};
|
|
13850
13919
|
|
|
13851
|
-
export type
|
|
13920
|
+
export type event31 = 'webhook.test';
|
|
13852
13921
|
|
|
13853
13922
|
/**
|
|
13854
13923
|
* Webhook payload for `whatsapp.account.alert_received`, forwarded from Meta's
|
|
@@ -13895,7 +13964,7 @@ export type WebhookPayloadWhatsAppAccountAlertReceived = {
|
|
|
13895
13964
|
timestamp: string;
|
|
13896
13965
|
};
|
|
13897
13966
|
|
|
13898
|
-
export type
|
|
13967
|
+
export type event32 = 'whatsapp.account.alert_received';
|
|
13899
13968
|
|
|
13900
13969
|
export type platform16 = 'whatsapp';
|
|
13901
13970
|
|
|
@@ -13946,7 +14015,7 @@ export type WebhookPayloadWhatsAppAccountNameStatusUpdated = {
|
|
|
13946
14015
|
timestamp: string;
|
|
13947
14016
|
};
|
|
13948
14017
|
|
|
13949
|
-
export type
|
|
14018
|
+
export type event33 = 'whatsapp.account.name_status_updated';
|
|
13950
14019
|
|
|
13951
14020
|
/**
|
|
13952
14021
|
* Normalized from Meta's `decision` (REJECTED -> DECLINED, DEFERRED -> PENDING_REVIEW; the review is still open on DEFERRED, not a rejection).
|
|
@@ -13999,7 +14068,7 @@ export type WebhookPayloadWhatsAppAccountQualityUpdated = {
|
|
|
13999
14068
|
timestamp: string;
|
|
14000
14069
|
};
|
|
14001
14070
|
|
|
14002
|
-
export type
|
|
14071
|
+
export type event34 = 'whatsapp.account.quality_updated';
|
|
14003
14072
|
|
|
14004
14073
|
/**
|
|
14005
14074
|
* The Meta webhook field that reported the change.
|
|
@@ -14070,7 +14139,7 @@ export type WebhookPayloadWhatsAppAccountStatusUpdated = {
|
|
|
14070
14139
|
timestamp: string;
|
|
14071
14140
|
};
|
|
14072
14141
|
|
|
14073
|
-
export type
|
|
14142
|
+
export type event35 = 'whatsapp.account.status_updated';
|
|
14074
14143
|
|
|
14075
14144
|
/**
|
|
14076
14145
|
* `active` only on a reinstatement (DISABLED_UPDATE with ban state REINSTATE).
|
|
@@ -14122,7 +14191,7 @@ export type WebhookPayloadWhatsAppContactIdentityChanged = {
|
|
|
14122
14191
|
timestamp: string;
|
|
14123
14192
|
};
|
|
14124
14193
|
|
|
14125
|
-
export type
|
|
14194
|
+
export type event36 = 'whatsapp.contact.identity_changed';
|
|
14126
14195
|
|
|
14127
14196
|
/**
|
|
14128
14197
|
* Which Meta signal reported the change. `user_changed_number`: new phone number. `user_changed_user_id` and `user_id_update`: new BSUID.
|
|
@@ -14191,7 +14260,7 @@ export type WebhookPayloadWhatsAppTemplateCategoryUpdated = {
|
|
|
14191
14260
|
timestamp: string;
|
|
14192
14261
|
};
|
|
14193
14262
|
|
|
14194
|
-
export type
|
|
14263
|
+
export type event37 = 'whatsapp.template.category_updated';
|
|
14195
14264
|
|
|
14196
14265
|
/**
|
|
14197
14266
|
* `scheduled` is Meta's 24h advance notice of an upcoming
|
|
@@ -14268,7 +14337,7 @@ export type WebhookPayloadWhatsAppTemplateStatusUpdated = {
|
|
|
14268
14337
|
timestamp: string;
|
|
14269
14338
|
};
|
|
14270
14339
|
|
|
14271
|
-
export type
|
|
14340
|
+
export type event38 = 'whatsapp.template.status_updated';
|
|
14272
14341
|
|
|
14273
14342
|
/**
|
|
14274
14343
|
* New status. Forwarded verbatim from Meta's `event` field.
|
|
@@ -14523,7 +14592,7 @@ export type WhatsAppTemplateButton = {
|
|
|
14523
14592
|
navigate_screen?: string;
|
|
14524
14593
|
};
|
|
14525
14594
|
|
|
14526
|
-
export type
|
|
14595
|
+
export type type17 = 'quick_reply' | 'url' | 'phone_number' | 'otp' | 'copy_code' | 'flow' | 'mpm' | 'catalog';
|
|
14527
14596
|
|
|
14528
14597
|
/**
|
|
14529
14598
|
* Required when type is otp
|
|
@@ -14565,7 +14634,7 @@ export type WhatsAppTemplateLookupError = {
|
|
|
14565
14634
|
};
|
|
14566
14635
|
};
|
|
14567
14636
|
|
|
14568
|
-
export type
|
|
14637
|
+
export type type18 = 'platform_error';
|
|
14569
14638
|
|
|
14570
14639
|
export type code = 'platform_api_error';
|
|
14571
14640
|
|
|
@@ -14724,7 +14793,7 @@ export type WorkflowNode = {
|
|
|
14724
14793
|
* integrations (webhook, ai, handoff, start_call).
|
|
14725
14794
|
*
|
|
14726
14795
|
*/
|
|
14727
|
-
export type
|
|
14796
|
+
export type type19 = 'trigger' | 'send_message' | 'wait_for_reply' | 'condition' | 'set_variable' | 'delay' | 'webhook' | 'ai' | 'handoff' | 'start_call' | 'a_b_split' | 'set_field' | 'enroll_sequence' | 'add_tag' | 'remove_tag' | 'end';
|
|
14728
14797
|
|
|
14729
14798
|
/**
|
|
14730
14799
|
* A single X API operation with its per-call price and the Zernio platform methods that trigger it.
|
|
@@ -14860,7 +14929,7 @@ export type XArticleBlock = {
|
|
|
14860
14929
|
entity_ranges?: Array<XArticleEntityRange>;
|
|
14861
14930
|
};
|
|
14862
14931
|
|
|
14863
|
-
export type
|
|
14932
|
+
export type type20 = 'unstyled' | 'header-one' | 'header-two' | 'header-three' | 'unordered-list-item' | 'ordered-list-item' | 'blockquote' | 'atomic';
|
|
14864
14933
|
|
|
14865
14934
|
/**
|
|
14866
14935
|
* X's snake_case content-state shape. Standard DraftJS camelCase fields such as entityMap, inlineStyleRanges, and entityRanges are rejected.
|
|
@@ -14939,7 +15008,7 @@ export type XArticleEntity = {
|
|
|
14939
15008
|
|
|
14940
15009
|
export type mutability = 'immutable' | 'mutable' | 'segmented';
|
|
14941
15010
|
|
|
14942
|
-
export type
|
|
15011
|
+
export type type21 = 'divider' | 'latex';
|
|
14943
15012
|
|
|
14944
15013
|
/**
|
|
14945
15014
|
* The referenced entity must exist, and offset plus length must not exceed the containing block's text length.
|
|
@@ -25195,7 +25264,7 @@ export type CreateWebhookSettingsData = {
|
|
|
25195
25264
|
/**
|
|
25196
25265
|
* Events to subscribe to (at least one required)
|
|
25197
25266
|
*/
|
|
25198
|
-
events: Array<('post.scheduled' | 'post.published' | 'post.failed' | 'post.partial' | 'post.cancelled' | 'post.recycled' | 'post.platform.published' | 'post.platform.failed' | 'post.platform.deleted' | 'post.tiktok.url_resolved' | 'post.external.created' | 'post.external.updated' | 'post.external.deleted' | 'account.connected' | 'account.disconnected' | 'account.ads.initial_sync_completed' | 'account.ads.sync_failed' | 'account.ads.sync_recovered' | 'analytics.synced' | 'message.received' | 'conversation.started' | 'conversation.control_changed' | 'call.received' | 'call.ended' | 'call.failed' | 'call.permission_request' | 'message.sent' | 'message.edited' | 'message.deleted' | 'message.delivered' | 'message.read' | 'message.played' | 'message.failed' | 'reaction.received' | 'referral.received' | 'comment.received' | 'review.new' | 'review.updated' | 'lead.received' | 'ad.status_changed' | 'whatsapp.template.status_updated' | 'whatsapp.template.category_updated' | 'whatsapp.account.name_status_updated' | 'whatsapp.account.quality_updated' | 'whatsapp.account.status_updated' | 'whatsapp.account.alert_received' | 'whatsapp.contact.identity_changed' | 'whatsapp.automatic_event' | 'whatsapp.number.activated' | 'whatsapp.number.declined' | 'whatsapp.number.action_required' | 'whatsapp.number.verification_required' | 'whatsapp.number.suspended' | 'whatsapp.number.reactivated' | 'whatsapp.number.released' | 'whatsapp.number.kyc_submitted' | 'phone_number.stock_available' | 'verification.approved' | 'verification.failed' | 'sms.registration.action_required' | 'sms.registration.status_updated' | 'branded_calling.identity.status_updated' | 'branded_calling.identity.action_required' | 'branded_calling.number.status_updated' | 'rcs.agent.status_updated' | 'commerce.product.created' | 'commerce.product.updated' | 'commerce.product.deleted')>;
|
|
25267
|
+
events: Array<('post.scheduled' | 'post.published' | 'post.failed' | 'post.partial' | 'post.cancelled' | 'post.recycled' | 'post.platform.published' | 'post.platform.failed' | 'post.platform.deleted' | 'post.tiktok.url_resolved' | 'post.external.created' | 'post.external.updated' | 'post.external.deleted' | 'account.connected' | 'account.disconnected' | 'account.ads.initial_sync_completed' | 'account.ads.sync_failed' | 'account.ads.sync_recovered' | 'analytics.synced' | 'message.received' | 'conversation.started' | 'conversation.control_changed' | 'call.received' | 'call.ended' | 'call.failed' | 'call.permission_request' | 'message.sent' | 'message.edited' | 'message.deleted' | 'message.delivered' | 'message.read' | 'message.played' | 'message.failed' | 'reaction.received' | 'referral.received' | 'comment.received' | 'review.new' | 'review.updated' | 'lead.received' | 'ad.status_changed' | 'whatsapp.template.status_updated' | 'whatsapp.template.category_updated' | 'whatsapp.account.name_status_updated' | 'whatsapp.account.quality_updated' | 'whatsapp.account.status_updated' | 'whatsapp.account.alert_received' | 'whatsapp.contact.identity_changed' | 'whatsapp.automatic_event' | 'whatsapp.number.activated' | 'whatsapp.number.declined' | 'whatsapp.number.action_required' | 'whatsapp.number.verification_required' | 'whatsapp.number.suspended' | 'whatsapp.number.reactivated' | 'whatsapp.number.released' | 'whatsapp.number.kyc_submitted' | 'phone_number.stock_available' | 'verification.approved' | 'verification.failed' | 'api.changelog.published' | 'sms.registration.action_required' | 'sms.registration.status_updated' | 'branded_calling.identity.status_updated' | 'branded_calling.identity.action_required' | 'branded_calling.number.status_updated' | 'rcs.agent.status_updated' | 'commerce.product.created' | 'commerce.product.updated' | 'commerce.product.deleted')>;
|
|
25199
25268
|
/**
|
|
25200
25269
|
* Enable or disable webhook delivery. Defaults to `true` when omitted.
|
|
25201
25270
|
*/
|
|
@@ -25263,7 +25332,7 @@ export type UpdateWebhookSettingsData = {
|
|
|
25263
25332
|
/**
|
|
25264
25333
|
* Events to subscribe to. Must contain at least one event if provided.
|
|
25265
25334
|
*/
|
|
25266
|
-
events?: Array<('post.scheduled' | 'post.published' | 'post.failed' | 'post.partial' | 'post.cancelled' | 'post.recycled' | 'post.platform.published' | 'post.platform.failed' | 'post.platform.deleted' | 'post.tiktok.url_resolved' | 'post.external.created' | 'post.external.updated' | 'post.external.deleted' | 'account.connected' | 'account.disconnected' | 'account.ads.initial_sync_completed' | 'account.ads.sync_failed' | 'account.ads.sync_recovered' | 'analytics.synced' | 'message.received' | 'conversation.started' | 'conversation.control_changed' | 'call.received' | 'call.ended' | 'call.failed' | 'call.permission_request' | 'message.sent' | 'message.edited' | 'message.deleted' | 'message.delivered' | 'message.read' | 'message.played' | 'message.failed' | 'reaction.received' | 'referral.received' | 'comment.received' | 'review.new' | 'review.updated' | 'lead.received' | 'ad.status_changed' | 'whatsapp.template.status_updated' | 'whatsapp.template.category_updated' | 'whatsapp.account.name_status_updated' | 'whatsapp.account.quality_updated' | 'whatsapp.account.status_updated' | 'whatsapp.account.alert_received' | 'whatsapp.contact.identity_changed' | 'whatsapp.automatic_event' | 'whatsapp.number.activated' | 'whatsapp.number.declined' | 'whatsapp.number.action_required' | 'whatsapp.number.verification_required' | 'whatsapp.number.suspended' | 'whatsapp.number.reactivated' | 'whatsapp.number.released' | 'whatsapp.number.kyc_submitted' | 'phone_number.stock_available' | 'verification.approved' | 'verification.failed' | 'sms.registration.action_required' | 'sms.registration.status_updated' | 'branded_calling.identity.status_updated' | 'branded_calling.identity.action_required' | 'branded_calling.number.status_updated' | 'rcs.agent.status_updated' | 'commerce.product.created' | 'commerce.product.updated' | 'commerce.product.deleted')>;
|
|
25335
|
+
events?: Array<('post.scheduled' | 'post.published' | 'post.failed' | 'post.partial' | 'post.cancelled' | 'post.recycled' | 'post.platform.published' | 'post.platform.failed' | 'post.platform.deleted' | 'post.tiktok.url_resolved' | 'post.external.created' | 'post.external.updated' | 'post.external.deleted' | 'account.connected' | 'account.disconnected' | 'account.ads.initial_sync_completed' | 'account.ads.sync_failed' | 'account.ads.sync_recovered' | 'analytics.synced' | 'message.received' | 'conversation.started' | 'conversation.control_changed' | 'call.received' | 'call.ended' | 'call.failed' | 'call.permission_request' | 'message.sent' | 'message.edited' | 'message.deleted' | 'message.delivered' | 'message.read' | 'message.played' | 'message.failed' | 'reaction.received' | 'referral.received' | 'comment.received' | 'review.new' | 'review.updated' | 'lead.received' | 'ad.status_changed' | 'whatsapp.template.status_updated' | 'whatsapp.template.category_updated' | 'whatsapp.account.name_status_updated' | 'whatsapp.account.quality_updated' | 'whatsapp.account.status_updated' | 'whatsapp.account.alert_received' | 'whatsapp.contact.identity_changed' | 'whatsapp.automatic_event' | 'whatsapp.number.activated' | 'whatsapp.number.declined' | 'whatsapp.number.action_required' | 'whatsapp.number.verification_required' | 'whatsapp.number.suspended' | 'whatsapp.number.reactivated' | 'whatsapp.number.released' | 'whatsapp.number.kyc_submitted' | 'phone_number.stock_available' | 'verification.approved' | 'verification.failed' | 'api.changelog.published' | 'sms.registration.action_required' | 'sms.registration.status_updated' | 'branded_calling.identity.status_updated' | 'branded_calling.identity.action_required' | 'branded_calling.number.status_updated' | 'rcs.agent.status_updated' | 'commerce.product.created' | 'commerce.product.updated' | 'commerce.product.deleted')>;
|
|
25267
25336
|
/**
|
|
25268
25337
|
* Enable or disable webhook delivery
|
|
25269
25338
|
*/
|
|
@@ -54446,4 +54515,34 @@ export type DownloadTikTokVideoResponse = ({
|
|
|
54446
54515
|
|
|
54447
54516
|
export type DownloadTikTokVideoError = (unknown | {
|
|
54448
54517
|
error?: string;
|
|
54449
|
-
} | ErrorResponse);
|
|
54518
|
+
} | ErrorResponse);
|
|
54519
|
+
|
|
54520
|
+
export type ListChangelogData = {
|
|
54521
|
+
query?: {
|
|
54522
|
+
/**
|
|
54523
|
+
* Only entries published strictly before this instant. Pass the previous page's `nextCursor`.
|
|
54524
|
+
*/
|
|
54525
|
+
before?: string;
|
|
54526
|
+
limit?: number;
|
|
54527
|
+
/**
|
|
54528
|
+
* Only entries tagged with this platform or area slug (see `platforms` on the entry). One slug per request.
|
|
54529
|
+
*/
|
|
54530
|
+
platform?: string;
|
|
54531
|
+
/**
|
|
54532
|
+
* Only entries of this type.
|
|
54533
|
+
*/
|
|
54534
|
+
type?: 'new_feature' | 'breaking_change' | 'improvement' | 'deprecation' | 'minor';
|
|
54535
|
+
};
|
|
54536
|
+
};
|
|
54537
|
+
|
|
54538
|
+
export type ListChangelogResponse = ({
|
|
54539
|
+
entries: Array<ApiChangelogEntry>;
|
|
54540
|
+
/**
|
|
54541
|
+
* `before` value for the next page, or null when this page was not full.
|
|
54542
|
+
*/
|
|
54543
|
+
nextCursor: (string) | null;
|
|
54544
|
+
});
|
|
54545
|
+
|
|
54546
|
+
export type ListChangelogError = (ErrorResponse | {
|
|
54547
|
+
error?: string;
|
|
54548
|
+
});
|