@getlatedev/node 0.2.1223 → 0.2.1225
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 +2 -0
- package/dist/index.d.mts +298 -45
- package/dist/index.d.ts +298 -45
- package/dist/index.js +15 -1
- package/dist/index.mjs +15 -1
- package/package.json +1 -1
- package/src/client.ts +4 -0
- package/src/generated/sdk.gen.ts +27 -5
- package/src/generated/types.gen.ts +309 -44
|
@@ -3689,10 +3689,26 @@ export type CommentAutomationTemplateElement = {
|
|
|
3689
3689
|
}>;
|
|
3690
3690
|
};
|
|
3691
3691
|
|
|
3692
|
+
export type CommerceAddress = {
|
|
3693
|
+
firstName?: (string) | null;
|
|
3694
|
+
lastName?: (string) | null;
|
|
3695
|
+
company?: (string) | null;
|
|
3696
|
+
phone?: (string) | null;
|
|
3697
|
+
line1?: (string) | null;
|
|
3698
|
+
line2?: (string) | null;
|
|
3699
|
+
city?: (string) | null;
|
|
3700
|
+
region?: (string) | null;
|
|
3701
|
+
postalCode?: (string) | null;
|
|
3702
|
+
/**
|
|
3703
|
+
* ISO 3166-1 alpha-2.
|
|
3704
|
+
*/
|
|
3705
|
+
countryCode?: (string) | null;
|
|
3706
|
+
};
|
|
3707
|
+
|
|
3692
3708
|
/**
|
|
3693
3709
|
* An operation a store supports. Calling an operation outside this list answers 400 platform_not_supported.
|
|
3694
3710
|
*/
|
|
3695
|
-
export type CommerceCapability = 'products.read' | 'products.create' | 'products.update' | 'products.status' | 'products.price' | 'products.variants' | 'products.images' | 'products.images_remove' | 'collections.read' | 'collections.write' | 'collections.metafields' | 'metafields.read' | 'metafields.write' | 'pages.read' | 'pages.write' | 'inventory.read' | 'inventory.write' | 'channels.read' | 'channels.write' | 'discounts.read' | 'discounts.write' | 'discounts.codes' | 'navigation.read' | 'navigation.write' | 'metaobjects.read' | 'metaobjects.write' | 'markets.read' | 'markets.write' | 'marketing.write';
|
|
3711
|
+
export type CommerceCapability = 'products.read' | 'products.create' | 'products.update' | 'products.status' | 'products.price' | 'products.variants' | 'products.images' | 'products.images_remove' | 'collections.read' | 'collections.write' | 'collections.metafields' | 'metafields.read' | 'metafields.write' | 'pages.read' | 'pages.write' | 'inventory.read' | 'inventory.write' | 'channels.read' | 'channels.write' | 'discounts.read' | 'discounts.write' | 'discounts.codes' | 'navigation.read' | 'navigation.write' | 'metaobjects.read' | 'metaobjects.write' | 'markets.read' | 'markets.write' | 'marketing.write' | 'orders.read';
|
|
3696
3712
|
|
|
3697
3713
|
/**
|
|
3698
3714
|
* A store kept in sync with an ad-platform product catalog.
|
|
@@ -3966,6 +3982,151 @@ export type CommerceMoney = {
|
|
|
3966
3982
|
currency: string;
|
|
3967
3983
|
};
|
|
3968
3984
|
|
|
3985
|
+
/**
|
|
3986
|
+
* An order with what an invoice needs. Every amount is in `currency`, the store currency.
|
|
3987
|
+
*/
|
|
3988
|
+
export type CommerceOrder = {
|
|
3989
|
+
id?: string;
|
|
3990
|
+
accountId?: string;
|
|
3991
|
+
platform?: 'shopify' | 'woocommerce';
|
|
3992
|
+
/**
|
|
3993
|
+
* The number the merchant and buyer see.
|
|
3994
|
+
*/
|
|
3995
|
+
number?: string;
|
|
3996
|
+
status?: CommerceOrderStatus;
|
|
3997
|
+
/**
|
|
3998
|
+
* Shopify fulfilment status (e.g. UNFULFILLED) or WooCommerce order status (e.g. processing).
|
|
3999
|
+
*/
|
|
4000
|
+
platformStatus?: string;
|
|
4001
|
+
paymentStatus?: ('pending' | 'authorized' | 'partially_paid' | 'paid' | 'partially_refunded' | 'refunded' | 'voided' | 'failed' | null);
|
|
4002
|
+
/**
|
|
4003
|
+
* Shopify financial status. Null on WooCommerce, where payment is read from the order status.
|
|
4004
|
+
*/
|
|
4005
|
+
platformPaymentStatus?: (string) | null;
|
|
4006
|
+
currency?: string;
|
|
4007
|
+
/**
|
|
4008
|
+
* Whether line item and shipping amounts include tax. Always false on WooCommerce, whose API returns amounts before tax whatever the store displays (platformData.pricesIncludeTax).
|
|
4009
|
+
*/
|
|
4010
|
+
taxesIncluded?: boolean;
|
|
4011
|
+
createdAt?: string;
|
|
4012
|
+
updatedAt?: string;
|
|
4013
|
+
/**
|
|
4014
|
+
* WooCommerce only; null on Shopify.
|
|
4015
|
+
*/
|
|
4016
|
+
paidAt?: (string) | null;
|
|
4017
|
+
/**
|
|
4018
|
+
* Shopify only; null on WooCommerce.
|
|
4019
|
+
*/
|
|
4020
|
+
cancelledAt?: (string) | null;
|
|
4021
|
+
cancelReason?: (string) | null;
|
|
4022
|
+
/**
|
|
4023
|
+
* Line items before order discounts and shipping.
|
|
4024
|
+
*/
|
|
4025
|
+
subtotal?: CommerceMoney;
|
|
4026
|
+
discountTotal?: CommerceMoney;
|
|
4027
|
+
shippingTotal?: CommerceMoney;
|
|
4028
|
+
taxTotal?: CommerceMoney;
|
|
4029
|
+
total?: CommerceMoney;
|
|
4030
|
+
refundedTotal?: CommerceMoney;
|
|
4031
|
+
discountCodes?: Array<(string)>;
|
|
4032
|
+
paymentMethods?: Array<(string)>;
|
|
4033
|
+
customer?: {
|
|
4034
|
+
/**
|
|
4035
|
+
* Null for guest checkouts.
|
|
4036
|
+
*/
|
|
4037
|
+
id?: (string) | null;
|
|
4038
|
+
email?: (string) | null;
|
|
4039
|
+
phone?: (string) | null;
|
|
4040
|
+
firstName?: (string) | null;
|
|
4041
|
+
lastName?: (string) | null;
|
|
4042
|
+
} | null;
|
|
4043
|
+
billingAddress?: (CommerceAddress | null);
|
|
4044
|
+
shippingAddress?: (CommerceAddress | null);
|
|
4045
|
+
buyerNote?: (string) | null;
|
|
4046
|
+
lineItems?: Array<{
|
|
4047
|
+
id?: string;
|
|
4048
|
+
/**
|
|
4049
|
+
* Null when the product was deleted.
|
|
4050
|
+
*/
|
|
4051
|
+
productId?: (string) | null;
|
|
4052
|
+
variantId?: (string) | null;
|
|
4053
|
+
sku?: (string) | null;
|
|
4054
|
+
title?: string;
|
|
4055
|
+
variantTitle?: (string) | null;
|
|
4056
|
+
/**
|
|
4057
|
+
* As ordered; refunded units are listed under refunds.
|
|
4058
|
+
*/
|
|
4059
|
+
quantity?: number;
|
|
4060
|
+
/**
|
|
4061
|
+
* Before discounts.
|
|
4062
|
+
*/
|
|
4063
|
+
unitPrice?: CommerceMoney;
|
|
4064
|
+
/**
|
|
4065
|
+
* unitPrice x quantity.
|
|
4066
|
+
*/
|
|
4067
|
+
subtotal?: CommerceMoney;
|
|
4068
|
+
discountTotal?: CommerceMoney;
|
|
4069
|
+
/**
|
|
4070
|
+
* subtotal minus discountTotal.
|
|
4071
|
+
*/
|
|
4072
|
+
total?: CommerceMoney;
|
|
4073
|
+
taxLines?: Array<CommerceTaxLine>;
|
|
4074
|
+
}>;
|
|
4075
|
+
shippingLines?: Array<CommerceOrderChargeLine>;
|
|
4076
|
+
/**
|
|
4077
|
+
* WooCommerce fees. Always empty on Shopify.
|
|
4078
|
+
*/
|
|
4079
|
+
feeLines?: Array<CommerceOrderChargeLine>;
|
|
4080
|
+
/**
|
|
4081
|
+
* Order tax by rate, line items and shipping together.
|
|
4082
|
+
*/
|
|
4083
|
+
taxLines?: Array<CommerceTaxLine>;
|
|
4084
|
+
refunds?: Array<{
|
|
4085
|
+
id?: string;
|
|
4086
|
+
createdAt?: (string) | null;
|
|
4087
|
+
note?: (string) | null;
|
|
4088
|
+
amount?: CommerceMoney;
|
|
4089
|
+
lineItems?: Array<{
|
|
4090
|
+
lineItemId?: string;
|
|
4091
|
+
quantity?: number;
|
|
4092
|
+
/**
|
|
4093
|
+
* Before tax.
|
|
4094
|
+
*/
|
|
4095
|
+
amount?: CommerceMoney;
|
|
4096
|
+
}>;
|
|
4097
|
+
}>;
|
|
4098
|
+
fulfillments?: Array<{
|
|
4099
|
+
carrierName?: (string) | null;
|
|
4100
|
+
trackingNumber?: (string) | null;
|
|
4101
|
+
trackingUrl?: (string) | null;
|
|
4102
|
+
}>;
|
|
4103
|
+
/**
|
|
4104
|
+
* Platform-only fields. Null when the platform has none.
|
|
4105
|
+
*/
|
|
4106
|
+
platformData?: {
|
|
4107
|
+
[key: string]: unknown;
|
|
4108
|
+
} | null;
|
|
4109
|
+
};
|
|
4110
|
+
|
|
4111
|
+
/**
|
|
4112
|
+
* A shipping or fee line.
|
|
4113
|
+
*/
|
|
4114
|
+
export type CommerceOrderChargeLine = {
|
|
4115
|
+
id?: string;
|
|
4116
|
+
title?: string;
|
|
4117
|
+
/**
|
|
4118
|
+
* Before discounts.
|
|
4119
|
+
*/
|
|
4120
|
+
amount?: CommerceMoney;
|
|
4121
|
+
discountTotal?: CommerceMoney;
|
|
4122
|
+
taxLines?: Array<CommerceTaxLine>;
|
|
4123
|
+
};
|
|
4124
|
+
|
|
4125
|
+
/**
|
|
4126
|
+
* Where the order stands. The raw platform value is returned next to it as platformStatus.
|
|
4127
|
+
*/
|
|
4128
|
+
export type CommerceOrderStatus = 'pending_payment' | 'on_hold' | 'awaiting_fulfillment' | 'partially_fulfilled' | 'in_transit' | 'delivered' | 'completed' | 'cancelled';
|
|
4129
|
+
|
|
3969
4130
|
export type CommercePage = {
|
|
3970
4131
|
id?: string;
|
|
3971
4132
|
accountId?: string;
|
|
@@ -4090,6 +4251,15 @@ export type CommerceStore = {
|
|
|
4090
4251
|
grantPermissionsUrl: (string) | null;
|
|
4091
4252
|
};
|
|
4092
4253
|
|
|
4254
|
+
export type CommerceTaxLine = {
|
|
4255
|
+
title?: string;
|
|
4256
|
+
/**
|
|
4257
|
+
* Percent, e.g. 20 for 20%. Null when the platform does not say.
|
|
4258
|
+
*/
|
|
4259
|
+
ratePercent?: (number) | null;
|
|
4260
|
+
amount?: CommerceMoney;
|
|
4261
|
+
};
|
|
4262
|
+
|
|
4093
4263
|
/**
|
|
4094
4264
|
* A purchasable variant of a product (one per option combination).
|
|
4095
4265
|
*/
|
|
@@ -11267,6 +11437,10 @@ export type TargetingSpec = {
|
|
|
11267
11437
|
* LinkedIn B2B only. Function URN id fragments, or the full urn:li:function:* URN from /v1/ads/targeting/search?dimension=jobFunction.
|
|
11268
11438
|
*/
|
|
11269
11439
|
jobFunctions?: Array<(string)>;
|
|
11440
|
+
/**
|
|
11441
|
+
* LinkedIn B2B only. Member skills (e.g. Python, Recruiting): skill URN id fragments, or the full urn:li:skill:* URN from /v1/ads/targeting/search?dimension=skill. Values are ORed; the facet is ANDed with the other facets. On an ad set update an empty list removes the skills.
|
|
11442
|
+
*/
|
|
11443
|
+
skills?: Array<(string)>;
|
|
11270
11444
|
/**
|
|
11271
11445
|
* Platform audience IDs to include, as returned by GET /v1/ads/audiences (Meta custom audience ids, TikTok audience ids, Pinterest customer list ids, LinkedIn segment ids (the platformAudienceId from GET /v1/ads/audiences; Zernio resolves it to the targetable LinkedIn ad segment, an unknown id returns 400), Google user list ids, X custom audience ids). On Reddit, the ids of custom audiences built in Reddit Ads Manager (GET /v1/ads/audiences does not list Reddit audiences). Not supported on OpenAI (400).
|
|
11272
11446
|
*/
|
|
@@ -12392,7 +12566,7 @@ export type Webhook = {
|
|
|
12392
12566
|
/**
|
|
12393
12567
|
* Events subscribed to
|
|
12394
12568
|
*/
|
|
12395
|
-
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' | 'ad.video.processed' | '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' | 'contact.tag_added' | 'contact.tag_removed' | 'contact.field_changed' | 'sequence.enrolled' | 'sequence.exited' | 'workflow.run.started' | 'workflow.run.completed' | 'workflow.run.failed' | 'support.run.completed' | 'support.run.failed')>;
|
|
12569
|
+
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' | 'ad.video.processed' | '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' | 'commerce.order.created' | 'commerce.order.updated' | 'commerce.order.refunded' | 'contact.tag_added' | 'contact.tag_removed' | 'contact.field_changed' | 'sequence.enrolled' | 'sequence.exited' | 'workflow.run.started' | 'workflow.run.completed' | 'workflow.run.failed' | 'support.run.completed' | 'support.run.failed')>;
|
|
12396
12570
|
/**
|
|
12397
12571
|
* Whether webhook delivery is enabled
|
|
12398
12572
|
*/
|
|
@@ -13519,6 +13693,52 @@ export type event14 = 'comment.received';
|
|
|
13519
13693
|
|
|
13520
13694
|
export type platform13 = 'instagram' | 'facebook' | 'threads' | 'youtube' | 'linkedin' | 'bluesky' | 'reddit' | 'tiktok';
|
|
13521
13695
|
|
|
13696
|
+
export type WebhookPayloadCommerceOrder = {
|
|
13697
|
+
/**
|
|
13698
|
+
* Always true when present: only a sample sent by POST /v1/webhooks/test with an event carries it. Real deliveries never do.
|
|
13699
|
+
*/
|
|
13700
|
+
test?: boolean;
|
|
13701
|
+
id?: string;
|
|
13702
|
+
event?: 'commerce.order.created' | 'commerce.order.updated' | 'commerce.order.refunded';
|
|
13703
|
+
/**
|
|
13704
|
+
* 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.
|
|
13705
|
+
*/
|
|
13706
|
+
timestamp?: string;
|
|
13707
|
+
store?: {
|
|
13708
|
+
/**
|
|
13709
|
+
* Zernio SocialAccount id of the store.
|
|
13710
|
+
*/
|
|
13711
|
+
accountId?: string;
|
|
13712
|
+
platform?: 'shopify' | 'woocommerce';
|
|
13713
|
+
/**
|
|
13714
|
+
* The platform id of the shop.
|
|
13715
|
+
*/
|
|
13716
|
+
shopId?: (string) | null;
|
|
13717
|
+
};
|
|
13718
|
+
/**
|
|
13719
|
+
* Identifiers only, never buyer data: read the order with GET /v1/commerce/orders/{orderId}.
|
|
13720
|
+
*/
|
|
13721
|
+
resource?: {
|
|
13722
|
+
type?: 'order';
|
|
13723
|
+
/**
|
|
13724
|
+
* Platform-native order id.
|
|
13725
|
+
*/
|
|
13726
|
+
id?: string;
|
|
13727
|
+
/**
|
|
13728
|
+
* Zernio order status at the time of the change. Null on commerce.order.refunded from Shopify, and on WooCommerce refunds.
|
|
13729
|
+
*/
|
|
13730
|
+
status?: (CommerceOrderStatus | null);
|
|
13731
|
+
/**
|
|
13732
|
+
* Raw platform status, e.g. UNFULFILLED on Shopify or processing on WooCommerce.
|
|
13733
|
+
*/
|
|
13734
|
+
platformStatus?: (string) | null;
|
|
13735
|
+
};
|
|
13736
|
+
};
|
|
13737
|
+
|
|
13738
|
+
export type event15 = 'commerce.order.created' | 'commerce.order.updated' | 'commerce.order.refunded';
|
|
13739
|
+
|
|
13740
|
+
export type type17 = 'order';
|
|
13741
|
+
|
|
13522
13742
|
export type WebhookPayloadCommerceProduct = {
|
|
13523
13743
|
/**
|
|
13524
13744
|
* Always true when present: only a sample sent by POST /v1/webhooks/test with an event carries it. Real deliveries never do.
|
|
@@ -13558,9 +13778,9 @@ export type WebhookPayloadCommerceProduct = {
|
|
|
13558
13778
|
};
|
|
13559
13779
|
};
|
|
13560
13780
|
|
|
13561
|
-
export type
|
|
13781
|
+
export type event16 = 'commerce.product.created' | 'commerce.product.updated' | 'commerce.product.deleted';
|
|
13562
13782
|
|
|
13563
|
-
export type
|
|
13783
|
+
export type type18 = 'product';
|
|
13564
13784
|
|
|
13565
13785
|
export type WebhookPayloadContactFieldChanged = {
|
|
13566
13786
|
/**
|
|
@@ -13598,7 +13818,7 @@ export type WebhookPayloadContactFieldChanged = {
|
|
|
13598
13818
|
source: 'api' | 'workflow' | 'automation';
|
|
13599
13819
|
};
|
|
13600
13820
|
|
|
13601
|
-
export type
|
|
13821
|
+
export type event17 = 'contact.field_changed';
|
|
13602
13822
|
|
|
13603
13823
|
/**
|
|
13604
13824
|
* Who wrote the field: the API or dashboard, a workflow set_field node, or an automation.
|
|
@@ -13630,7 +13850,7 @@ export type WebhookPayloadContactTag = {
|
|
|
13630
13850
|
source: 'api' | 'workflow' | 'automation';
|
|
13631
13851
|
};
|
|
13632
13852
|
|
|
13633
|
-
export type
|
|
13853
|
+
export type event18 = 'contact.tag_added' | 'contact.tag_removed';
|
|
13634
13854
|
|
|
13635
13855
|
/**
|
|
13636
13856
|
* Who answers a conversation changed under Meta's handover protocol. WhatsApp: Meta
|
|
@@ -13676,7 +13896,7 @@ export type WebhookPayloadConversationControlChanged = {
|
|
|
13676
13896
|
timestamp: string;
|
|
13677
13897
|
};
|
|
13678
13898
|
|
|
13679
|
-
export type
|
|
13899
|
+
export type event19 = 'conversation.control_changed';
|
|
13680
13900
|
|
|
13681
13901
|
/**
|
|
13682
13902
|
* Who answers now. ai_agent: Meta Business Agent (WhatsApp); app: you; other: another app (a WhatsApp partner, or a Messenger / Instagram receiver such as Page Inbox).
|
|
@@ -13718,7 +13938,7 @@ export type WebhookPayloadConversationStarted = {
|
|
|
13718
13938
|
timestamp: string;
|
|
13719
13939
|
};
|
|
13720
13940
|
|
|
13721
|
-
export type
|
|
13941
|
+
export type event20 = 'conversation.started';
|
|
13722
13942
|
|
|
13723
13943
|
/**
|
|
13724
13944
|
* Webhook payload for post.external.created / post.external.updated /
|
|
@@ -13755,7 +13975,7 @@ export type WebhookPayloadExternalPost = {
|
|
|
13755
13975
|
timestamp: string;
|
|
13756
13976
|
};
|
|
13757
13977
|
|
|
13758
|
-
export type
|
|
13978
|
+
export type event21 = 'post.external.created' | 'post.external.updated' | 'post.external.deleted';
|
|
13759
13979
|
|
|
13760
13980
|
/**
|
|
13761
13981
|
* Webhook payload for lead.received events (Meta Lead Gen / Instant Forms).
|
|
@@ -13831,7 +14051,7 @@ export type WebhookPayloadLead = {
|
|
|
13831
14051
|
timestamp: string;
|
|
13832
14052
|
};
|
|
13833
14053
|
|
|
13834
|
-
export type
|
|
14054
|
+
export type event22 = 'lead.received';
|
|
13835
14055
|
|
|
13836
14056
|
export type platform14 = 'facebook';
|
|
13837
14057
|
|
|
@@ -14422,7 +14642,7 @@ export type WebhookPayloadMessage = {
|
|
|
14422
14642
|
timestamp: string;
|
|
14423
14643
|
};
|
|
14424
14644
|
|
|
14425
|
-
export type
|
|
14645
|
+
export type event23 = 'message.received';
|
|
14426
14646
|
|
|
14427
14647
|
/**
|
|
14428
14648
|
* Which Zernio surface produced the message. Always present and
|
|
@@ -14488,7 +14708,7 @@ export type WebhookPayloadMessageDeleted = {
|
|
|
14488
14708
|
timestamp: string;
|
|
14489
14709
|
};
|
|
14490
14710
|
|
|
14491
|
-
export type
|
|
14711
|
+
export type event24 = 'message.deleted';
|
|
14492
14712
|
|
|
14493
14713
|
/**
|
|
14494
14714
|
* Shared payload for message.delivered, message.read, message.played and
|
|
@@ -14556,7 +14776,7 @@ export type WebhookPayloadMessageDeliveryStatus = {
|
|
|
14556
14776
|
timestamp: string;
|
|
14557
14777
|
};
|
|
14558
14778
|
|
|
14559
|
-
export type
|
|
14779
|
+
export type event25 = 'message.delivered' | 'message.read' | 'message.played' | 'message.failed';
|
|
14560
14780
|
|
|
14561
14781
|
/**
|
|
14562
14782
|
* Webhook payload for message.edited events. Fires when the sender
|
|
@@ -14599,7 +14819,7 @@ export type WebhookPayloadMessageEdited = {
|
|
|
14599
14819
|
timestamp: string;
|
|
14600
14820
|
};
|
|
14601
14821
|
|
|
14602
|
-
export type
|
|
14822
|
+
export type event26 = 'message.edited';
|
|
14603
14823
|
|
|
14604
14824
|
/**
|
|
14605
14825
|
* Webhook payload for message sent events (fired when a message is sent via the API, or from the WhatsApp Business app on Coexistence numbers)
|
|
@@ -14845,7 +15065,7 @@ export type WebhookPayloadMessageSent = {
|
|
|
14845
15065
|
timestamp: string;
|
|
14846
15066
|
};
|
|
14847
15067
|
|
|
14848
|
-
export type
|
|
15068
|
+
export type event27 = 'message.sent';
|
|
14849
15069
|
|
|
14850
15070
|
/**
|
|
14851
15071
|
* Every platform whose outgoing messages Zernio observes. sms is absent on purpose: its carrier receipts update delivery status and never raise message.sent.
|
|
@@ -14903,7 +15123,7 @@ export type WebhookPayloadPhoneNumberStockAvailable = {
|
|
|
14903
15123
|
timestamp: string;
|
|
14904
15124
|
};
|
|
14905
15125
|
|
|
14906
|
-
export type
|
|
15126
|
+
export type event28 = 'phone_number.stock_available';
|
|
14907
15127
|
|
|
14908
15128
|
/**
|
|
14909
15129
|
* Webhook payload for post events
|
|
@@ -14958,7 +15178,7 @@ export type WebhookPayloadPost = {
|
|
|
14958
15178
|
timestamp: string;
|
|
14959
15179
|
};
|
|
14960
15180
|
|
|
14961
|
-
export type
|
|
15181
|
+
export type event29 = 'post.scheduled' | 'post.published' | 'post.failed' | 'post.partial' | 'post.cancelled' | 'post.recycled';
|
|
14962
15182
|
|
|
14963
15183
|
/**
|
|
14964
15184
|
* Webhook payload for the per-platform terminal events
|
|
@@ -15082,7 +15302,7 @@ export type WebhookPayloadPostPlatform = {
|
|
|
15082
15302
|
timestamp: string;
|
|
15083
15303
|
};
|
|
15084
15304
|
|
|
15085
|
-
export type
|
|
15305
|
+
export type event30 = 'post.platform.published' | 'post.platform.failed' | 'post.platform.deleted' | 'post.tiktok.url_resolved';
|
|
15086
15306
|
|
|
15087
15307
|
/**
|
|
15088
15308
|
* Terminal status this event fires on. Matches the event suffix.
|
|
@@ -15147,7 +15367,7 @@ export type WebhookPayloadReaction = {
|
|
|
15147
15367
|
timestamp: string;
|
|
15148
15368
|
};
|
|
15149
15369
|
|
|
15150
|
-
export type
|
|
15370
|
+
export type event31 = 'reaction.received';
|
|
15151
15371
|
|
|
15152
15372
|
export type action = 'added' | 'removed';
|
|
15153
15373
|
|
|
@@ -15226,7 +15446,7 @@ export type WebhookPayloadReferral = {
|
|
|
15226
15446
|
timestamp: string;
|
|
15227
15447
|
};
|
|
15228
15448
|
|
|
15229
|
-
export type
|
|
15449
|
+
export type event32 = 'referral.received';
|
|
15230
15450
|
|
|
15231
15451
|
/**
|
|
15232
15452
|
* Webhook payload for the review.new event (new review posted on a connected account).
|
|
@@ -15258,7 +15478,7 @@ export type WebhookPayloadReviewNew = {
|
|
|
15258
15478
|
timestamp: string;
|
|
15259
15479
|
};
|
|
15260
15480
|
|
|
15261
|
-
export type
|
|
15481
|
+
export type event33 = 'review.new';
|
|
15262
15482
|
|
|
15263
15483
|
/**
|
|
15264
15484
|
* Webhook payload for the review.updated event. Fired when the reviewer edits their
|
|
@@ -15296,7 +15516,7 @@ export type WebhookPayloadReviewUpdated = {
|
|
|
15296
15516
|
timestamp: string;
|
|
15297
15517
|
};
|
|
15298
15518
|
|
|
15299
|
-
export type
|
|
15519
|
+
export type event34 = 'review.updated';
|
|
15300
15520
|
|
|
15301
15521
|
export type WebhookPayloadSequenceEnrollment = {
|
|
15302
15522
|
/**
|
|
@@ -15329,7 +15549,7 @@ export type WebhookPayloadSequenceEnrollment = {
|
|
|
15329
15549
|
exitReason?: 'completed' | 'replied' | 'manual' | 'failed' | 'unsubscribed';
|
|
15330
15550
|
};
|
|
15331
15551
|
|
|
15332
|
-
export type
|
|
15552
|
+
export type event35 = 'sequence.enrolled' | 'sequence.exited';
|
|
15333
15553
|
|
|
15334
15554
|
/**
|
|
15335
15555
|
* sequence.exited only. completed: the last step was sent; replied: the contact replied and the sequence exits on reply; manual: unenrolled through the API; failed: the step kept failing to send; unsubscribed: the contact opted out.
|
|
@@ -15350,7 +15570,7 @@ export type WebhookPayloadSupportRun = {
|
|
|
15350
15570
|
run: SupportRun;
|
|
15351
15571
|
};
|
|
15352
15572
|
|
|
15353
|
-
export type
|
|
15573
|
+
export type event36 = 'support.run.completed' | 'support.run.failed';
|
|
15354
15574
|
|
|
15355
15575
|
/**
|
|
15356
15576
|
* Webhook payload for test deliveries
|
|
@@ -15371,7 +15591,7 @@ export type WebhookPayloadTest = {
|
|
|
15371
15591
|
timestamp: string;
|
|
15372
15592
|
};
|
|
15373
15593
|
|
|
15374
|
-
export type
|
|
15594
|
+
export type event37 = 'webhook.test';
|
|
15375
15595
|
|
|
15376
15596
|
/**
|
|
15377
15597
|
* Webhook payload for `whatsapp.account.alert_received`, forwarded from Meta's
|
|
@@ -15423,7 +15643,7 @@ export type WebhookPayloadWhatsAppAccountAlertReceived = {
|
|
|
15423
15643
|
timestamp: string;
|
|
15424
15644
|
};
|
|
15425
15645
|
|
|
15426
|
-
export type
|
|
15646
|
+
export type event38 = 'whatsapp.account.alert_received';
|
|
15427
15647
|
|
|
15428
15648
|
export type platform16 = 'whatsapp';
|
|
15429
15649
|
|
|
@@ -15479,7 +15699,7 @@ export type WebhookPayloadWhatsAppAccountNameStatusUpdated = {
|
|
|
15479
15699
|
timestamp: string;
|
|
15480
15700
|
};
|
|
15481
15701
|
|
|
15482
|
-
export type
|
|
15702
|
+
export type event39 = 'whatsapp.account.name_status_updated';
|
|
15483
15703
|
|
|
15484
15704
|
/**
|
|
15485
15705
|
* Normalized from Meta's `decision` (REJECTED -> DECLINED, DEFERRED -> PENDING_REVIEW; the review is still open on DEFERRED, not a rejection).
|
|
@@ -15537,7 +15757,7 @@ export type WebhookPayloadWhatsAppAccountQualityUpdated = {
|
|
|
15537
15757
|
timestamp: string;
|
|
15538
15758
|
};
|
|
15539
15759
|
|
|
15540
|
-
export type
|
|
15760
|
+
export type event40 = 'whatsapp.account.quality_updated';
|
|
15541
15761
|
|
|
15542
15762
|
/**
|
|
15543
15763
|
* The Meta webhook field that reported the change.
|
|
@@ -15613,7 +15833,7 @@ export type WebhookPayloadWhatsAppAccountStatusUpdated = {
|
|
|
15613
15833
|
timestamp: string;
|
|
15614
15834
|
};
|
|
15615
15835
|
|
|
15616
|
-
export type
|
|
15836
|
+
export type event41 = 'whatsapp.account.status_updated';
|
|
15617
15837
|
|
|
15618
15838
|
/**
|
|
15619
15839
|
* `active` only on a reinstatement (DISABLED_UPDATE with ban state REINSTATE).
|
|
@@ -15670,7 +15890,7 @@ export type WebhookPayloadWhatsAppContactIdentityChanged = {
|
|
|
15670
15890
|
timestamp: string;
|
|
15671
15891
|
};
|
|
15672
15892
|
|
|
15673
|
-
export type
|
|
15893
|
+
export type event42 = 'whatsapp.contact.identity_changed';
|
|
15674
15894
|
|
|
15675
15895
|
/**
|
|
15676
15896
|
* Which Meta signal reported the change. `user_changed_number`: new phone number. `user_changed_user_id` and `user_id_update`: new BSUID.
|
|
@@ -15744,7 +15964,7 @@ export type WebhookPayloadWhatsAppTemplateCategoryUpdated = {
|
|
|
15744
15964
|
timestamp: string;
|
|
15745
15965
|
};
|
|
15746
15966
|
|
|
15747
|
-
export type
|
|
15967
|
+
export type event43 = 'whatsapp.template.category_updated';
|
|
15748
15968
|
|
|
15749
15969
|
/**
|
|
15750
15970
|
* `scheduled` is Meta's 24h advance notice of an upcoming
|
|
@@ -15826,7 +16046,7 @@ export type WebhookPayloadWhatsAppTemplateStatusUpdated = {
|
|
|
15826
16046
|
timestamp: string;
|
|
15827
16047
|
};
|
|
15828
16048
|
|
|
15829
|
-
export type
|
|
16049
|
+
export type event44 = 'whatsapp.template.status_updated';
|
|
15830
16050
|
|
|
15831
16051
|
/**
|
|
15832
16052
|
* New status. Forwarded verbatim from Meta's `event` field.
|
|
@@ -15893,7 +16113,7 @@ export type WebhookPayloadWorkflowRun = {
|
|
|
15893
16113
|
error?: string;
|
|
15894
16114
|
};
|
|
15895
16115
|
|
|
15896
|
-
export type
|
|
16116
|
+
export type event45 = 'workflow.run.started' | 'workflow.run.completed' | 'workflow.run.failed';
|
|
15897
16117
|
|
|
15898
16118
|
/**
|
|
15899
16119
|
* running on workflow.run.started; completed or exited (ended on purpose before the last node, e.g. a handoff) on workflow.run.completed; failed on workflow.run.failed.
|
|
@@ -16171,7 +16391,7 @@ export type WhatsAppTemplateButton = {
|
|
|
16171
16391
|
navigate_screen?: string;
|
|
16172
16392
|
};
|
|
16173
16393
|
|
|
16174
|
-
export type
|
|
16394
|
+
export type type19 = 'quick_reply' | 'url' | 'phone_number' | 'otp' | 'copy_code' | 'flow' | 'mpm' | 'catalog';
|
|
16175
16395
|
|
|
16176
16396
|
/**
|
|
16177
16397
|
* Required when type is otp
|
|
@@ -16213,7 +16433,7 @@ export type WhatsAppTemplateLookupError = {
|
|
|
16213
16433
|
};
|
|
16214
16434
|
};
|
|
16215
16435
|
|
|
16216
|
-
export type
|
|
16436
|
+
export type type20 = 'platform_error';
|
|
16217
16437
|
|
|
16218
16438
|
export type code = 'platform_api_error';
|
|
16219
16439
|
|
|
@@ -16375,7 +16595,7 @@ export type WorkflowNode = {
|
|
|
16375
16595
|
* integrations (webhook, ai, handoff, start_call).
|
|
16376
16596
|
*
|
|
16377
16597
|
*/
|
|
16378
|
-
export type
|
|
16598
|
+
export type type21 = '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';
|
|
16379
16599
|
|
|
16380
16600
|
/**
|
|
16381
16601
|
* A single X API operation with its per-call price and the Zernio platform methods that trigger it.
|
|
@@ -16511,7 +16731,7 @@ export type XArticleBlock = {
|
|
|
16511
16731
|
entity_ranges?: Array<XArticleEntityRange>;
|
|
16512
16732
|
};
|
|
16513
16733
|
|
|
16514
|
-
export type
|
|
16734
|
+
export type type22 = 'unstyled' | 'header-one' | 'header-two' | 'header-three' | 'unordered-list-item' | 'ordered-list-item' | 'blockquote' | 'atomic';
|
|
16515
16735
|
|
|
16516
16736
|
/**
|
|
16517
16737
|
* X's snake_case content-state shape. Standard DraftJS camelCase fields such as entityMap, inlineStyleRanges, and entityRanges are rejected.
|
|
@@ -16590,7 +16810,7 @@ export type XArticleEntity = {
|
|
|
16590
16810
|
|
|
16591
16811
|
export type mutability = 'immutable' | 'mutable' | 'segmented';
|
|
16592
16812
|
|
|
16593
|
-
export type
|
|
16813
|
+
export type type23 = 'divider' | 'latex';
|
|
16594
16814
|
|
|
16595
16815
|
/**
|
|
16596
16816
|
* The referenced entity must exist, and offset plus length must not exceed the containing block's text length.
|
|
@@ -27092,7 +27312,7 @@ export type CreateWebhookSettingsData = {
|
|
|
27092
27312
|
/**
|
|
27093
27313
|
* Events to subscribe to (at least one required)
|
|
27094
27314
|
*/
|
|
27095
|
-
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' | 'ad.video.processed' | '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' | 'contact.tag_added' | 'contact.tag_removed' | 'contact.field_changed' | 'sequence.enrolled' | 'sequence.exited' | 'workflow.run.started' | 'workflow.run.completed' | 'workflow.run.failed' | 'support.run.completed' | 'support.run.failed')>;
|
|
27315
|
+
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' | 'ad.video.processed' | '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' | 'commerce.order.created' | 'commerce.order.updated' | 'commerce.order.refunded' | 'contact.tag_added' | 'contact.tag_removed' | 'contact.field_changed' | 'sequence.enrolled' | 'sequence.exited' | 'workflow.run.started' | 'workflow.run.completed' | 'workflow.run.failed' | 'support.run.completed' | 'support.run.failed')>;
|
|
27096
27316
|
/**
|
|
27097
27317
|
* Enable or disable webhook delivery. Defaults to `true` when omitted.
|
|
27098
27318
|
*/
|
|
@@ -27158,7 +27378,7 @@ export type UpdateWebhookSettingsData = {
|
|
|
27158
27378
|
/**
|
|
27159
27379
|
* Events to subscribe to. Must contain at least one event if provided.
|
|
27160
27380
|
*/
|
|
27161
|
-
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' | 'ad.video.processed' | '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' | 'contact.tag_added' | 'contact.tag_removed' | 'contact.field_changed' | 'sequence.enrolled' | 'sequence.exited' | 'workflow.run.started' | 'workflow.run.completed' | 'workflow.run.failed' | 'support.run.completed' | 'support.run.failed')>;
|
|
27381
|
+
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' | 'ad.video.processed' | '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' | 'commerce.order.created' | 'commerce.order.updated' | 'commerce.order.refunded' | 'contact.tag_added' | 'contact.tag_removed' | 'contact.field_changed' | 'sequence.enrolled' | 'sequence.exited' | 'workflow.run.started' | 'workflow.run.completed' | 'workflow.run.failed' | 'support.run.completed' | 'support.run.failed')>;
|
|
27162
27382
|
/**
|
|
27163
27383
|
* Enable or disable webhook delivery
|
|
27164
27384
|
*/
|
|
@@ -27328,7 +27548,7 @@ export type TestWebhookData = {
|
|
|
27328
27548
|
/**
|
|
27329
27549
|
* Send a sample payload of this event instead of `webhook.test`. The sample is marked with `test: true`.
|
|
27330
27550
|
*/
|
|
27331
|
-
event?: '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' | 'message.sent' | 'message.edited' | 'message.deleted' | 'message.delivered' | 'message.read' | 'message.played' | 'message.failed' | 'reaction.received' | 'referral.received' | 'conversation.started' | 'conversation.control_changed' | 'contact.tag_added' | 'contact.tag_removed' | 'contact.field_changed' | 'sequence.enrolled' | 'sequence.exited' | 'workflow.run.started' | 'workflow.run.completed' | 'workflow.run.failed' | 'support.run.completed' | 'support.run.failed' | 'call.received' | 'call.ended' | 'call.failed' | 'call.permission_request' | 'comment.received' | 'review.new' | 'review.updated' | 'ad.status_changed' | 'ad.video.processed' | 'lead.received' | '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.number.activated' | 'whatsapp.number.declined' | 'whatsapp.number.action_required' | 'whatsapp.automatic_event' | 'whatsapp.number.verification_required' | 'whatsapp.number.suspended' | 'whatsapp.number.reactivated' | 'whatsapp.number.released' | 'whatsapp.number.kyc_submitted' | 'phone_number.stock_available' | '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' | 'verification.approved' | 'verification.failed' | 'commerce.product.created' | 'commerce.product.updated' | 'commerce.product.deleted' | 'api.changelog.published';
|
|
27551
|
+
event?: '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' | 'message.sent' | 'message.edited' | 'message.deleted' | 'message.delivered' | 'message.read' | 'message.played' | 'message.failed' | 'reaction.received' | 'referral.received' | 'conversation.started' | 'conversation.control_changed' | 'contact.tag_added' | 'contact.tag_removed' | 'contact.field_changed' | 'sequence.enrolled' | 'sequence.exited' | 'workflow.run.started' | 'workflow.run.completed' | 'workflow.run.failed' | 'support.run.completed' | 'support.run.failed' | 'call.received' | 'call.ended' | 'call.failed' | 'call.permission_request' | 'comment.received' | 'review.new' | 'review.updated' | 'ad.status_changed' | 'ad.video.processed' | 'lead.received' | '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.number.activated' | 'whatsapp.number.declined' | 'whatsapp.number.action_required' | 'whatsapp.automatic_event' | 'whatsapp.number.verification_required' | 'whatsapp.number.suspended' | 'whatsapp.number.reactivated' | 'whatsapp.number.released' | 'whatsapp.number.kyc_submitted' | 'phone_number.stock_available' | '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' | 'verification.approved' | 'verification.failed' | 'commerce.product.created' | 'commerce.product.updated' | 'commerce.product.deleted' | 'commerce.order.created' | 'commerce.order.updated' | 'commerce.order.refunded' | 'api.changelog.published';
|
|
27332
27552
|
};
|
|
27333
27553
|
};
|
|
27334
27554
|
|
|
@@ -50360,9 +50580,9 @@ export type SearchAdTargetingData = {
|
|
|
50360
50580
|
*/
|
|
50361
50581
|
countryCode?: string;
|
|
50362
50582
|
/**
|
|
50363
|
-
* What to search. `geo` resolves locations (scope further with `geoType`), `interest`/`behavior` resolve audience entities (`behavior` on Meta, TikTok and LinkedIn), `interestSuggestion` suggests interests related to the names in `q` (Meta only), `interestKeyword`/`hashtag` resolve TikTok additional interests and hashtags (TikTok only), `income` resolves the normalized income tiers, `language` resolves Google's targetable language_constant table (Google only), `workPosition`/`workEmployer`/`workIndustry` resolve Meta work demographics, `industry`/`jobFunction`/`seniority`/`companySize` resolve LinkedIn B2B facets (LinkedIn only). Defaults to `interest` for backward compatibility with the deprecated /v1/ads/interests alias.
|
|
50583
|
+
* What to search. `geo` resolves locations (scope further with `geoType`), `interest`/`behavior` resolve audience entities (`behavior` on Meta, TikTok and LinkedIn), `interestSuggestion` suggests interests related to the names in `q` (Meta only), `interestKeyword`/`hashtag` resolve TikTok additional interests and hashtags (TikTok only), `income` resolves the normalized income tiers, `language` resolves Google's targetable language_constant table (Google only), `workPosition`/`workEmployer`/`workIndustry` resolve Meta work demographics, `industry`/`jobFunction`/`seniority`/`companySize`/`skill` resolve LinkedIn B2B facets (LinkedIn only). Defaults to `interest` for backward compatibility with the deprecated /v1/ads/interests alias.
|
|
50364
50584
|
*/
|
|
50365
|
-
dimension?: 'geo' | 'interest' | 'interestSuggestion' | 'interestKeyword' | 'behavior' | 'hashtag' | 'income' | 'language' | 'workPosition' | 'workEmployer' | 'workIndustry' | 'industry' | 'jobFunction' | 'seniority' | 'companySize' | 'community' | 'conversationKeyword';
|
|
50585
|
+
dimension?: 'geo' | 'interest' | 'interestSuggestion' | 'interestKeyword' | 'behavior' | 'hashtag' | 'income' | 'language' | 'workPosition' | 'workEmployer' | 'workIndustry' | 'industry' | 'jobFunction' | 'seniority' | 'companySize' | 'skill' | 'community' | 'conversationKeyword';
|
|
50366
50586
|
/**
|
|
50367
50587
|
* Only used when `dimension=geo`. The kind of location to resolve. `all` searches every type in one relevance-ranked call. Defaults to `city`.
|
|
50368
50588
|
*/
|
|
@@ -50389,7 +50609,7 @@ export type SearchAdTargetingResponse = ({
|
|
|
50389
50609
|
*/
|
|
50390
50610
|
name: string;
|
|
50391
50611
|
/**
|
|
50392
|
-
* What the result is. Equals the requested dimension (interest, interestSuggestion, interestKeyword, behavior, hashtag, income, language, workPosition, workEmployer, workIndustry, industry, jobFunction, seniority, companySize, community, conversationKeyword), or the location level for geo (country, region, city, zip, metro, ...).
|
|
50612
|
+
* What the result is. Equals the requested dimension (interest, interestSuggestion, interestKeyword, behavior, hashtag, income, language, workPosition, workEmployer, workIndustry, industry, jobFunction, seniority, companySize, skill, community, conversationKeyword), or the location level for geo (country, region, city, zip, metro, ...).
|
|
50393
50613
|
*/
|
|
50394
50614
|
type: string;
|
|
50395
50615
|
/**
|
|
@@ -54959,6 +55179,51 @@ export type GetCommerceStoreResponse = ({
|
|
|
54959
55179
|
|
|
54960
55180
|
export type GetCommerceStoreError = (ErrorResponse | unknown);
|
|
54961
55181
|
|
|
55182
|
+
export type ListCommerceOrdersData = {
|
|
55183
|
+
query: {
|
|
55184
|
+
/**
|
|
55185
|
+
* Connected store SocialAccount id.
|
|
55186
|
+
*/
|
|
55187
|
+
accountId: string;
|
|
55188
|
+
createdAfter?: string;
|
|
55189
|
+
createdBefore?: string;
|
|
55190
|
+
cursor?: string;
|
|
55191
|
+
limit?: number;
|
|
55192
|
+
/**
|
|
55193
|
+
* Only orders changed after this time, oldest change first.
|
|
55194
|
+
*/
|
|
55195
|
+
updatedAfter?: string;
|
|
55196
|
+
};
|
|
55197
|
+
};
|
|
55198
|
+
|
|
55199
|
+
export type ListCommerceOrdersResponse = ({
|
|
55200
|
+
orders?: Array<CommerceOrder>;
|
|
55201
|
+
nextCursor?: (string) | null;
|
|
55202
|
+
});
|
|
55203
|
+
|
|
55204
|
+
export type ListCommerceOrdersError = (ErrorResponse | unknown);
|
|
55205
|
+
|
|
55206
|
+
export type GetCommerceOrderData = {
|
|
55207
|
+
path: {
|
|
55208
|
+
/**
|
|
55209
|
+
* Platform-native order id.
|
|
55210
|
+
*/
|
|
55211
|
+
orderId: string;
|
|
55212
|
+
};
|
|
55213
|
+
query: {
|
|
55214
|
+
/**
|
|
55215
|
+
* Connected store SocialAccount id.
|
|
55216
|
+
*/
|
|
55217
|
+
accountId: string;
|
|
55218
|
+
};
|
|
55219
|
+
};
|
|
55220
|
+
|
|
55221
|
+
export type GetCommerceOrderResponse = ({
|
|
55222
|
+
order?: CommerceOrder;
|
|
55223
|
+
});
|
|
55224
|
+
|
|
55225
|
+
export type GetCommerceOrderError = (ErrorResponse | unknown);
|
|
55226
|
+
|
|
54962
55227
|
export type ListCommerceProductsData = {
|
|
54963
55228
|
query: {
|
|
54964
55229
|
/**
|