@zernio/node 0.2.972 → 0.2.973
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 +21 -0
- package/dist/index.d.mts +711 -53
- package/dist/index.d.ts +711 -53
- package/dist/index.js +138 -1
- package/dist/index.mjs +138 -1
- package/package.json +1 -1
- package/src/client.ts +48 -0
- package/src/generated/sdk.gen.ts +227 -1
- package/src/generated/types.gen.ts +762 -52
|
@@ -5930,7 +5930,7 @@ export type InboxWebhookConversationDetail = {
|
|
|
5930
5930
|
* The platform's conversation id, equal to `conversation.platformConversationId` on inbox webhooks (whose `conversation.id` is Zernio's internal id). Both are accepted by the conversation endpoints.
|
|
5931
5931
|
*/
|
|
5932
5932
|
id: string;
|
|
5933
|
-
platform: 'instagram' | 'facebook' | 'telegram' | 'whatsapp' | 'twitter' | 'reddit' | 'bluesky' | 'sms' | 'slack' | 'tiktok' | 'imessage';
|
|
5933
|
+
platform: 'instagram' | 'facebook' | 'telegram' | 'whatsapp' | 'twitter' | 'reddit' | 'bluesky' | 'sms' | 'rcs' | 'slack' | 'tiktok' | 'imessage';
|
|
5934
5934
|
/**
|
|
5935
5935
|
* Same value as `id`.
|
|
5936
5936
|
*/
|
|
@@ -5958,7 +5958,7 @@ export type InboxWebhookConversationDetail = {
|
|
|
5958
5958
|
contactId?: string;
|
|
5959
5959
|
};
|
|
5960
5960
|
|
|
5961
|
-
export type platform5 = 'instagram' | 'facebook' | 'telegram' | 'whatsapp' | 'twitter' | 'reddit' | 'bluesky' | 'sms' | 'slack' | 'tiktok' | 'imessage';
|
|
5961
|
+
export type platform5 = 'instagram' | 'facebook' | 'telegram' | 'whatsapp' | 'twitter' | 'reddit' | 'bluesky' | 'sms' | 'rcs' | 'slack' | 'tiktok' | 'imessage';
|
|
5962
5962
|
|
|
5963
5963
|
/**
|
|
5964
5964
|
* The message object included in inbox webhook payloads.
|
|
@@ -8340,6 +8340,335 @@ export type QueueUpdateResponse = {
|
|
|
8340
8340
|
isNewQueue?: boolean;
|
|
8341
8341
|
};
|
|
8342
8342
|
|
|
8343
|
+
export type RcsAgent = {
|
|
8344
|
+
id?: string;
|
|
8345
|
+
profileId?: string;
|
|
8346
|
+
/**
|
|
8347
|
+
* The rcs inbox account, created once the agent exists with the carriers.
|
|
8348
|
+
*/
|
|
8349
|
+
accountId?: (string) | null;
|
|
8350
|
+
/**
|
|
8351
|
+
* Launch market (ISO 3166-1 alpha-2). US agents run through the carriers automatically; other markets are filed by our team and skip the testing and launch_review steps (send the launch request while the agent is still in review).
|
|
8352
|
+
*/
|
|
8353
|
+
country?: string;
|
|
8354
|
+
status?: 'requested' | 'changes_requested' | 'brand_vetting' | 'agent_review' | 'testing' | 'launch_review' | 'launching' | 'live' | 'rejected' | 'deactivated';
|
|
8355
|
+
displayName?: string;
|
|
8356
|
+
useCase?: 'MULTI_USE' | 'PROMOTIONAL' | 'TRANSACTIONAL' | 'OTP';
|
|
8357
|
+
profile?: RcsAgentProfile;
|
|
8358
|
+
brand?: (RcsBrand | null);
|
|
8359
|
+
launchRequest?: (RcsLaunchRequest | null);
|
|
8360
|
+
carrierApprovals?: Array<RcsCarrierApproval>;
|
|
8361
|
+
testDevices?: Array<RcsTestDevice>;
|
|
8362
|
+
smsFallbackFrom?: (string) | null;
|
|
8363
|
+
/**
|
|
8364
|
+
* Our note while status is changes_requested.
|
|
8365
|
+
*/
|
|
8366
|
+
reviewNote?: (string) | null;
|
|
8367
|
+
declineReason?: (string) | null;
|
|
8368
|
+
requestedAt?: (string) | null;
|
|
8369
|
+
submittedAt?: (string) | null;
|
|
8370
|
+
liveAt?: (string) | null;
|
|
8371
|
+
createdAt?: string;
|
|
8372
|
+
};
|
|
8373
|
+
|
|
8374
|
+
export type status22 = 'requested' | 'changes_requested' | 'brand_vetting' | 'agent_review' | 'testing' | 'launch_review' | 'launching' | 'live' | 'rejected' | 'deactivated';
|
|
8375
|
+
|
|
8376
|
+
export type useCase = 'MULTI_USE' | 'PROMOTIONAL' | 'TRANSACTIONAL' | 'OTP';
|
|
8377
|
+
|
|
8378
|
+
/**
|
|
8379
|
+
* The agent's public profile. At least one of phone, website or email is required.
|
|
8380
|
+
*/
|
|
8381
|
+
export type RcsAgentProfile = {
|
|
8382
|
+
description: string;
|
|
8383
|
+
/**
|
|
8384
|
+
* 224x224, max 50 KB. Upload any image through POST /v1/rcs/assets to get a compliant URL.
|
|
8385
|
+
*/
|
|
8386
|
+
logoUrl: string;
|
|
8387
|
+
/**
|
|
8388
|
+
* Banner, 1440x448, max 200 KB. Upload through POST /v1/rcs/assets.
|
|
8389
|
+
*/
|
|
8390
|
+
heroUrl: string;
|
|
8391
|
+
/**
|
|
8392
|
+
* Hex colour, e.g. #1A73E8. Needs 4.5:1 contrast against white.
|
|
8393
|
+
*/
|
|
8394
|
+
brandColor: string;
|
|
8395
|
+
privacyPolicyUrl: string;
|
|
8396
|
+
termsUrl: string;
|
|
8397
|
+
phone?: {
|
|
8398
|
+
/**
|
|
8399
|
+
* E.164
|
|
8400
|
+
*/
|
|
8401
|
+
number: string;
|
|
8402
|
+
label: string;
|
|
8403
|
+
};
|
|
8404
|
+
website?: {
|
|
8405
|
+
url: string;
|
|
8406
|
+
label: string;
|
|
8407
|
+
};
|
|
8408
|
+
email?: {
|
|
8409
|
+
address: string;
|
|
8410
|
+
label: string;
|
|
8411
|
+
};
|
|
8412
|
+
};
|
|
8413
|
+
|
|
8414
|
+
export type RcsBrand = RcsBrandInput & {
|
|
8415
|
+
id?: string;
|
|
8416
|
+
/**
|
|
8417
|
+
* draft = not filed yet (still editable).
|
|
8418
|
+
*/
|
|
8419
|
+
status?: 'draft' | 'vetting' | 'verified' | 'rejected';
|
|
8420
|
+
createdAt?: string;
|
|
8421
|
+
};
|
|
8422
|
+
|
|
8423
|
+
/**
|
|
8424
|
+
* draft = not filed yet (still editable).
|
|
8425
|
+
*/
|
|
8426
|
+
export type status23 = 'draft' | 'vetting' | 'verified' | 'rejected';
|
|
8427
|
+
|
|
8428
|
+
export type RcsBrandInput = {
|
|
8429
|
+
displayName: string;
|
|
8430
|
+
/**
|
|
8431
|
+
* Exactly as on IRS records.
|
|
8432
|
+
*/
|
|
8433
|
+
legalName: string;
|
|
8434
|
+
legalEntityType: 'LIMITED_LIABILITY_COMPANY' | 'SOLE_PROPRIETORSHIP' | 'PARTNERSHIP' | 'CORPORATION' | 'S_CORPORATION';
|
|
8435
|
+
organizationType: 'PRIVATE_PROFIT' | 'PUBLIC_PROFIT' | 'NON_PROFIT' | 'GOVERNMENT';
|
|
8436
|
+
websiteUrl: string;
|
|
8437
|
+
/**
|
|
8438
|
+
* US: the EIN, 9 digits, optionally NN-NNNNNNN. Elsewhere: the national tax or company registration id.
|
|
8439
|
+
*/
|
|
8440
|
+
taxId: string;
|
|
8441
|
+
/**
|
|
8442
|
+
* EXCHANGE:SYMBOL. Required for PUBLIC_PROFIT.
|
|
8443
|
+
*/
|
|
8444
|
+
stockSymbol?: string;
|
|
8445
|
+
address: {
|
|
8446
|
+
line1: string;
|
|
8447
|
+
line2?: string;
|
|
8448
|
+
city: string;
|
|
8449
|
+
/**
|
|
8450
|
+
* Required in the US.
|
|
8451
|
+
*/
|
|
8452
|
+
state?: string;
|
|
8453
|
+
postalCode: string;
|
|
8454
|
+
/**
|
|
8455
|
+
* ISO 3166-1 alpha-2. Sets the launch market of agents under this brand. Spain (ES) is accepted but launches are paused at the carriers.
|
|
8456
|
+
*/
|
|
8457
|
+
country: 'US' | 'GB' | 'AT' | 'BD' | 'BR' | 'CD' | 'DE' | 'ES' | 'FR' | 'IN' | 'IT' | 'MX' | 'NG' | 'NL' | 'NO' | 'PT' | 'SE' | 'SG' | 'ZA';
|
|
8458
|
+
};
|
|
8459
|
+
contact: {
|
|
8460
|
+
firstName: string;
|
|
8461
|
+
lastName: string;
|
|
8462
|
+
title?: string;
|
|
8463
|
+
/**
|
|
8464
|
+
* A personal address on the company domain; free-mail and group addresses (info@, support@) are rejected by the carriers.
|
|
8465
|
+
*/
|
|
8466
|
+
email: string;
|
|
8467
|
+
/**
|
|
8468
|
+
* E.164
|
|
8469
|
+
*/
|
|
8470
|
+
phone: string;
|
|
8471
|
+
};
|
|
8472
|
+
};
|
|
8473
|
+
|
|
8474
|
+
export type legalEntityType = 'LIMITED_LIABILITY_COMPANY' | 'SOLE_PROPRIETORSHIP' | 'PARTNERSHIP' | 'CORPORATION' | 'S_CORPORATION';
|
|
8475
|
+
|
|
8476
|
+
export type organizationType2 = 'PRIVATE_PROFIT' | 'PUBLIC_PROFIT' | 'NON_PROFIT' | 'GOVERNMENT';
|
|
8477
|
+
|
|
8478
|
+
/**
|
|
8479
|
+
* ISO 3166-1 alpha-2. Sets the launch market of agents under this brand. Spain (ES) is accepted but launches are paused at the carriers.
|
|
8480
|
+
*/
|
|
8481
|
+
export type country = 'US' | 'GB' | 'AT' | 'BD' | 'BR' | 'CD' | 'DE' | 'ES' | 'FR' | 'IN' | 'IT' | 'MX' | 'NG' | 'NL' | 'NO' | 'PT' | 'SE' | 'SG' | 'ZA';
|
|
8482
|
+
|
|
8483
|
+
export type RcsCapability = {
|
|
8484
|
+
phoneNumber?: string;
|
|
8485
|
+
rcsCapable?: boolean;
|
|
8486
|
+
/**
|
|
8487
|
+
* e.g. RICHCARD_STANDALONE, RICHCARD_CAROUSEL, ACTION_OPEN_URL, ACTION_DIAL. Absent when not capable.
|
|
8488
|
+
*/
|
|
8489
|
+
features?: Array<(string)>;
|
|
8490
|
+
};
|
|
8491
|
+
|
|
8492
|
+
/**
|
|
8493
|
+
* Needs a title, description or media.
|
|
8494
|
+
*/
|
|
8495
|
+
export type RcsCard = {
|
|
8496
|
+
title?: string;
|
|
8497
|
+
description?: string;
|
|
8498
|
+
media?: RcsMedia;
|
|
8499
|
+
suggestions?: Array<RcsSuggestion>;
|
|
8500
|
+
};
|
|
8501
|
+
|
|
8502
|
+
export type RcsCarrierApproval = {
|
|
8503
|
+
approvalId?: string;
|
|
8504
|
+
scope?: 'carrier' | 'hub' | 'bot';
|
|
8505
|
+
status?: 'PENDING' | 'SUBMITTED' | 'APPROVED' | 'REJECTED';
|
|
8506
|
+
carrier?: (string) | null;
|
|
8507
|
+
approvedAt?: (string) | null;
|
|
8508
|
+
rejectedReason?: (string) | null;
|
|
8509
|
+
};
|
|
8510
|
+
|
|
8511
|
+
export type scope2 = 'carrier' | 'hub' | 'bot';
|
|
8512
|
+
|
|
8513
|
+
export type status24 = 'PENDING' | 'SUBMITTED' | 'APPROVED' | 'REJECTED';
|
|
8514
|
+
|
|
8515
|
+
/**
|
|
8516
|
+
* Message content. `suggestions` (max 11) render as chips under the message.
|
|
8517
|
+
*/
|
|
8518
|
+
export type RcsContent = {
|
|
8519
|
+
type: 'text';
|
|
8520
|
+
text: string;
|
|
8521
|
+
suggestions?: Array<RcsSuggestion>;
|
|
8522
|
+
} | {
|
|
8523
|
+
type: 'media';
|
|
8524
|
+
media: RcsMedia;
|
|
8525
|
+
suggestions?: Array<RcsSuggestion>;
|
|
8526
|
+
} | {
|
|
8527
|
+
type: 'card';
|
|
8528
|
+
card: RcsCard;
|
|
8529
|
+
orientation?: 'VERTICAL' | 'HORIZONTAL';
|
|
8530
|
+
thumbnailAlignment?: 'LEFT' | 'RIGHT';
|
|
8531
|
+
suggestions?: Array<RcsSuggestion>;
|
|
8532
|
+
} | {
|
|
8533
|
+
type: 'carousel';
|
|
8534
|
+
cards: Array<RcsCard>;
|
|
8535
|
+
cardWidth?: 'SMALL' | 'MEDIUM';
|
|
8536
|
+
suggestions?: Array<RcsSuggestion>;
|
|
8537
|
+
};
|
|
8538
|
+
|
|
8539
|
+
export type type10 = 'text';
|
|
8540
|
+
|
|
8541
|
+
export type orientation = 'VERTICAL' | 'HORIZONTAL';
|
|
8542
|
+
|
|
8543
|
+
export type thumbnailAlignment = 'LEFT' | 'RIGHT';
|
|
8544
|
+
|
|
8545
|
+
export type cardWidth = 'SMALL' | 'MEDIUM';
|
|
8546
|
+
|
|
8547
|
+
export type RcsLaunchRequest = {
|
|
8548
|
+
companyOverview: string;
|
|
8549
|
+
agentOverview: string;
|
|
8550
|
+
interactions: Array<{
|
|
8551
|
+
type: 'TRANSACTIONAL_UPDATES' | 'CUSTOMER_SUPPORT' | 'LOYALTY_OR_REWARD' | 'MARKETING_OR_PROMOTIONAL' | 'ACCOUNT_ALERTS' | 'TWO_WAY_CONVERSATION' | 'OTHER';
|
|
8552
|
+
/**
|
|
8553
|
+
* Required when type is OTHER.
|
|
8554
|
+
*/
|
|
8555
|
+
description?: string;
|
|
8556
|
+
}>;
|
|
8557
|
+
messageExamples: Array<(string)>;
|
|
8558
|
+
consent: {
|
|
8559
|
+
optInMethods: Array<{
|
|
8560
|
+
type: 'SMS' | 'WEBSITE' | 'MOBILE_APP' | 'QR_CODE' | 'SALE_POINT' | 'OTHER';
|
|
8561
|
+
/**
|
|
8562
|
+
* Required when type is OTHER.
|
|
8563
|
+
*/
|
|
8564
|
+
description?: string;
|
|
8565
|
+
}>;
|
|
8566
|
+
/**
|
|
8567
|
+
* The opt-in wording people agree to.
|
|
8568
|
+
*/
|
|
8569
|
+
callToAction: string;
|
|
8570
|
+
/**
|
|
8571
|
+
* Required for WEBSITE opt-in.
|
|
8572
|
+
*/
|
|
8573
|
+
callToActionUrl?: string;
|
|
8574
|
+
/**
|
|
8575
|
+
* Screenshot of the opt-in. Required for WEBSITE and MOBILE_APP opt-in.
|
|
8576
|
+
*/
|
|
8577
|
+
callToActionMediaUrl?: string;
|
|
8578
|
+
doubleOptIn: boolean;
|
|
8579
|
+
/**
|
|
8580
|
+
* Required when doubleOptIn is true.
|
|
8581
|
+
*/
|
|
8582
|
+
doubleOptInMessage?: string;
|
|
8583
|
+
optInMessage: string;
|
|
8584
|
+
helpResponse: string;
|
|
8585
|
+
optOutResponse: string;
|
|
8586
|
+
};
|
|
8587
|
+
/**
|
|
8588
|
+
* Public video of a test phone sending START, STOP and HELP plus one example conversation.
|
|
8589
|
+
*/
|
|
8590
|
+
testVideoUrl: string;
|
|
8591
|
+
additionalInformation?: string;
|
|
8592
|
+
};
|
|
8593
|
+
|
|
8594
|
+
export type RcsMedia = {
|
|
8595
|
+
/**
|
|
8596
|
+
* Public image or video URL.
|
|
8597
|
+
*/
|
|
8598
|
+
url: string;
|
|
8599
|
+
/**
|
|
8600
|
+
* Max 100 KB.
|
|
8601
|
+
*/
|
|
8602
|
+
thumbnailUrl?: string;
|
|
8603
|
+
height?: 'SHORT' | 'MEDIUM' | 'TALL';
|
|
8604
|
+
};
|
|
8605
|
+
|
|
8606
|
+
export type height = 'SHORT' | 'MEDIUM' | 'TALL';
|
|
8607
|
+
|
|
8608
|
+
/**
|
|
8609
|
+
* A tappable chip. Labels are max 25 characters. postbackData (max 2048) comes back unchanged in message.received metadata as postbackPayload when tapped; defaults to the label. Any string works, JSON included: values outside A-Z a-z 0-9 - _ . are encoded on the wire and decoded for you.
|
|
8610
|
+
*/
|
|
8611
|
+
export type RcsSuggestion = {
|
|
8612
|
+
type: 'reply';
|
|
8613
|
+
text: string;
|
|
8614
|
+
postbackData?: string;
|
|
8615
|
+
} | {
|
|
8616
|
+
type: 'dial';
|
|
8617
|
+
text: string;
|
|
8618
|
+
/**
|
|
8619
|
+
* E.164
|
|
8620
|
+
*/
|
|
8621
|
+
phoneNumber: string;
|
|
8622
|
+
postbackData?: string;
|
|
8623
|
+
} | {
|
|
8624
|
+
type: 'openUrl';
|
|
8625
|
+
text: string;
|
|
8626
|
+
url: string;
|
|
8627
|
+
application?: 'BROWSER' | 'WEBVIEW';
|
|
8628
|
+
webviewViewMode?: 'FULL' | 'HALF' | 'TALL';
|
|
8629
|
+
postbackData?: string;
|
|
8630
|
+
} | {
|
|
8631
|
+
type: 'viewLocation';
|
|
8632
|
+
text: string;
|
|
8633
|
+
latitude?: number;
|
|
8634
|
+
longitude?: number;
|
|
8635
|
+
query?: string;
|
|
8636
|
+
label?: string;
|
|
8637
|
+
postbackData?: string;
|
|
8638
|
+
} | {
|
|
8639
|
+
type: 'shareLocation';
|
|
8640
|
+
text: string;
|
|
8641
|
+
postbackData?: string;
|
|
8642
|
+
} | {
|
|
8643
|
+
type: 'calendarEvent';
|
|
8644
|
+
text: string;
|
|
8645
|
+
startTime: string;
|
|
8646
|
+
endTime: string;
|
|
8647
|
+
title: string;
|
|
8648
|
+
description?: string;
|
|
8649
|
+
postbackData?: string;
|
|
8650
|
+
};
|
|
8651
|
+
|
|
8652
|
+
export type type11 = 'reply';
|
|
8653
|
+
|
|
8654
|
+
export type application = 'BROWSER' | 'WEBVIEW';
|
|
8655
|
+
|
|
8656
|
+
export type webviewViewMode = 'FULL' | 'HALF' | 'TALL';
|
|
8657
|
+
|
|
8658
|
+
export type RcsTestDevice = {
|
|
8659
|
+
testDeviceId?: string;
|
|
8660
|
+
phoneNumber?: string;
|
|
8661
|
+
/**
|
|
8662
|
+
* The phone must accept the invite in its messaging app before it receives messages.
|
|
8663
|
+
*/
|
|
8664
|
+
inviteStatus?: 'PENDING' | 'ACCEPTED' | 'DECLINED';
|
|
8665
|
+
};
|
|
8666
|
+
|
|
8667
|
+
/**
|
|
8668
|
+
* The phone must accept the invite in its messaging app before it receives messages.
|
|
8669
|
+
*/
|
|
8670
|
+
export type inviteStatus = 'PENDING' | 'ACCEPTED' | 'DECLINED';
|
|
8671
|
+
|
|
8343
8672
|
/**
|
|
8344
8673
|
* Configure automatic post recycling (reposting at regular intervals).
|
|
8345
8674
|
* After the post is published, the system creates new scheduled copies at the
|
|
@@ -9375,25 +9704,9 @@ export type TrackingTag = {
|
|
|
9375
9704
|
/**
|
|
9376
9705
|
* Platforms where each conversion is its own object: the tag's conversion events, with the id a site sends for each.
|
|
9377
9706
|
*/
|
|
9378
|
-
events?: Array<
|
|
9379
|
-
id: string;
|
|
9380
|
-
name: string;
|
|
9381
|
-
/**
|
|
9382
|
-
* Platform category of the event.
|
|
9383
|
-
*/
|
|
9384
|
-
type?: string;
|
|
9385
|
-
/**
|
|
9386
|
-
* The neutral site event this conversion is fired for, when it maps to one.
|
|
9387
|
-
*/
|
|
9388
|
-
siteEvent?: 'page_view' | 'view_content' | 'add_to_cart' | 'search' | 'initiate_checkout' | 'add_payment_info' | 'purchase';
|
|
9389
|
-
/**
|
|
9390
|
-
* What the site sends to fire this event (Google conversion label, LinkedIn conversion rule id, X `tw-` event id).
|
|
9391
|
-
*/
|
|
9392
|
-
siteEventId?: string;
|
|
9393
|
-
status?: string;
|
|
9394
|
-
}>;
|
|
9707
|
+
events?: Array<TrackingTagEvent>;
|
|
9395
9708
|
name: string;
|
|
9396
|
-
platform: 'metaads' | 'openaiads' | 'tiktokads' | 'googleads';
|
|
9709
|
+
platform: 'metaads' | 'openaiads' | 'tiktokads' | 'googleads' | 'xads';
|
|
9397
9710
|
/**
|
|
9398
9711
|
* Platform-native flavor of the tag (Meta: `pixel`).
|
|
9399
9712
|
*/
|
|
@@ -9440,13 +9753,73 @@ export type TrackingTag = {
|
|
|
9440
9753
|
ownerAdAccountId?: string;
|
|
9441
9754
|
};
|
|
9442
9755
|
|
|
9443
|
-
export type platform11 = 'metaads' | 'openaiads' | 'tiktokads' | 'googleads';
|
|
9756
|
+
export type platform11 = 'metaads' | 'openaiads' | 'tiktokads' | 'googleads' | 'xads';
|
|
9444
9757
|
|
|
9445
9758
|
/**
|
|
9446
9759
|
* Platform-native flavor of the tag (Meta: `pixel`).
|
|
9447
9760
|
*/
|
|
9448
9761
|
export type kind2 = 'pixel' | 'tag' | 'insight_tag';
|
|
9449
9762
|
|
|
9763
|
+
/**
|
|
9764
|
+
* A conversion event tied to a tracking tag (Google conversion action, LinkedIn conversion rule, X web event tag, OpenAI event setting, TikTok pixel event, Meta custom conversion).
|
|
9765
|
+
*/
|
|
9766
|
+
export type TrackingTagEvent = {
|
|
9767
|
+
/**
|
|
9768
|
+
* Platform-native event id, the `{eventId}` of the per-event routes.
|
|
9769
|
+
*/
|
|
9770
|
+
id: string;
|
|
9771
|
+
name: string;
|
|
9772
|
+
/**
|
|
9773
|
+
* Platform event type or category.
|
|
9774
|
+
*/
|
|
9775
|
+
type?: string;
|
|
9776
|
+
/**
|
|
9777
|
+
* The neutral site event this conversion is fired for, when it maps to one.
|
|
9778
|
+
*/
|
|
9779
|
+
siteEvent?: 'page_view' | 'view_content' | 'add_to_cart' | 'search' | 'initiate_checkout' | 'add_payment_info' | 'purchase';
|
|
9780
|
+
/**
|
|
9781
|
+
* What the site sends to fire this event (Google conversion label, LinkedIn conversion rule id, X `tw-` event id).
|
|
9782
|
+
*/
|
|
9783
|
+
siteEventId?: string;
|
|
9784
|
+
status?: string;
|
|
9785
|
+
defaultValue?: number;
|
|
9786
|
+
currency?: string;
|
|
9787
|
+
clickWindowDays?: number;
|
|
9788
|
+
viewWindowDays?: number;
|
|
9789
|
+
};
|
|
9790
|
+
|
|
9791
|
+
/**
|
|
9792
|
+
* The neutral site event this conversion is fired for, when it maps to one.
|
|
9793
|
+
*/
|
|
9794
|
+
export type siteEvent = 'page_view' | 'view_content' | 'add_to_cart' | 'search' | 'initiate_checkout' | 'add_payment_info' | 'purchase';
|
|
9795
|
+
|
|
9796
|
+
/**
|
|
9797
|
+
* Conversion event fields. Each platform stores a subset; a field it does not store answers 400 naming the supported ones.
|
|
9798
|
+
*/
|
|
9799
|
+
export type TrackingTagEventInput = {
|
|
9800
|
+
/**
|
|
9801
|
+
* Scopes the lookup on platforms whose tag ids live inside an ad account.
|
|
9802
|
+
*/
|
|
9803
|
+
adAccountId?: string;
|
|
9804
|
+
name?: string;
|
|
9805
|
+
/**
|
|
9806
|
+
* The platform's own event type enum value (e.g. `PURCHASE`).
|
|
9807
|
+
*/
|
|
9808
|
+
type?: string;
|
|
9809
|
+
/**
|
|
9810
|
+
* Neutral alternative to `type`, mapped to the platform's closest type.
|
|
9811
|
+
*/
|
|
9812
|
+
siteEvent?: 'page_view' | 'view_content' | 'add_to_cart' | 'search' | 'initiate_checkout' | 'add_payment_info' | 'purchase';
|
|
9813
|
+
enabled?: boolean;
|
|
9814
|
+
defaultValue?: number;
|
|
9815
|
+
/**
|
|
9816
|
+
* ISO 4217 code.
|
|
9817
|
+
*/
|
|
9818
|
+
currency?: string;
|
|
9819
|
+
clickWindowDays?: number;
|
|
9820
|
+
viewWindowDays?: number;
|
|
9821
|
+
};
|
|
9822
|
+
|
|
9450
9823
|
/**
|
|
9451
9824
|
* Why a pixel cannot be installed on a WordPress site.
|
|
9452
9825
|
*/
|
|
@@ -9536,7 +9909,7 @@ export type UploadedFile = {
|
|
|
9536
9909
|
mimeType?: string;
|
|
9537
9910
|
};
|
|
9538
9911
|
|
|
9539
|
-
export type
|
|
9912
|
+
export type type12 = 'image' | 'video' | 'document';
|
|
9540
9913
|
|
|
9541
9914
|
export type UploadTokenResponse = {
|
|
9542
9915
|
token?: string;
|
|
@@ -9545,7 +9918,7 @@ export type UploadTokenResponse = {
|
|
|
9545
9918
|
status?: 'pending' | 'completed' | 'expired';
|
|
9546
9919
|
};
|
|
9547
9920
|
|
|
9548
|
-
export type
|
|
9921
|
+
export type status25 = 'pending' | 'completed' | 'expired';
|
|
9549
9922
|
|
|
9550
9923
|
export type UploadTokenStatusResponse = {
|
|
9551
9924
|
token?: string;
|
|
@@ -10044,7 +10417,7 @@ export type Verification = {
|
|
|
10044
10417
|
resend?: boolean;
|
|
10045
10418
|
};
|
|
10046
10419
|
|
|
10047
|
-
export type
|
|
10420
|
+
export type status26 = 'pending' | 'approved' | 'expired' | 'max_attempts_reached' | 'canceled' | 'delivery_failed';
|
|
10048
10421
|
|
|
10049
10422
|
export type channel4 = 'sms';
|
|
10050
10423
|
|
|
@@ -10071,7 +10444,7 @@ export type Webhook = {
|
|
|
10071
10444
|
/**
|
|
10072
10445
|
* Events subscribed to
|
|
10073
10446
|
*/
|
|
10074
|
-
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.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.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')>;
|
|
10447
|
+
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.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.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')>;
|
|
10075
10448
|
/**
|
|
10076
10449
|
* Whether webhook delivery is enabled
|
|
10077
10450
|
*/
|
|
@@ -10193,7 +10566,7 @@ export type WebhookLog = {
|
|
|
10193
10566
|
/**
|
|
10194
10567
|
* Delivery outcome
|
|
10195
10568
|
*/
|
|
10196
|
-
export type
|
|
10569
|
+
export type status27 = 'success' | 'failed';
|
|
10197
10570
|
|
|
10198
10571
|
/**
|
|
10199
10572
|
* Webhook payload for `account.ads.initial_sync_completed` events.
|
|
@@ -10305,7 +10678,7 @@ export type event = 'account.ads.initial_sync_completed';
|
|
|
10305
10678
|
/**
|
|
10306
10679
|
* Overall outcome of the initial sync.
|
|
10307
10680
|
*/
|
|
10308
|
-
export type
|
|
10681
|
+
export type status28 = 'success' | 'failure';
|
|
10309
10682
|
|
|
10310
10683
|
/**
|
|
10311
10684
|
* Stable category for UX branching. New values may be added; existing ones are
|
|
@@ -11218,7 +11591,7 @@ export type WebhookPayloadMessage = {
|
|
|
11218
11591
|
* Internal conversation ID
|
|
11219
11592
|
*/
|
|
11220
11593
|
conversationId: string;
|
|
11221
|
-
platform: 'instagram' | 'facebook' | 'telegram' | 'whatsapp' | 'sms' | 'twitter' | 'bluesky' | 'reddit' | 'slack' | 'tiktok' | 'imessage';
|
|
11594
|
+
platform: 'instagram' | 'facebook' | 'telegram' | 'whatsapp' | 'sms' | 'rcs' | 'twitter' | 'bluesky' | 'reddit' | 'slack' | 'tiktok' | 'imessage';
|
|
11222
11595
|
/**
|
|
11223
11596
|
* Platform's message ID
|
|
11224
11597
|
*/
|
|
@@ -11803,10 +12176,10 @@ export type event18 = 'message.deleted';
|
|
|
11803
12176
|
* delivery state for an outgoing message.
|
|
11804
12177
|
*
|
|
11805
12178
|
* Platform support:
|
|
11806
|
-
* * message.delivered: WhatsApp, Facebook Messenger, SMS.
|
|
11807
|
-
* * message.read: WhatsApp, Facebook Messenger, Instagram. Not SMS
|
|
12179
|
+
* * message.delivered: WhatsApp, Facebook Messenger, SMS, RCS.
|
|
12180
|
+
* * message.read: WhatsApp, Facebook Messenger, Instagram, RCS. Not SMS
|
|
11808
12181
|
* (carriers report delivery, never read).
|
|
11809
|
-
* * message.failed: WhatsApp and
|
|
12182
|
+
* * message.failed: WhatsApp, SMS and RCS (other platforms don't expose
|
|
11810
12183
|
* per-message failure via webhook). On SMS, `error.code` is the
|
|
11811
12184
|
* carrier's numeric code and `error.message` its reason.
|
|
11812
12185
|
*
|
|
@@ -12337,7 +12710,7 @@ export type event24 = 'post.platform.published' | 'post.platform.failed' | 'post
|
|
|
12337
12710
|
/**
|
|
12338
12711
|
* Terminal status this event fires on. Matches the event suffix.
|
|
12339
12712
|
*/
|
|
12340
|
-
export type
|
|
12713
|
+
export type status29 = 'published' | 'failed' | 'deleted';
|
|
12341
12714
|
|
|
12342
12715
|
/**
|
|
12343
12716
|
* Webhook payload for reaction received events (WhatsApp, Telegram, Slack, Instagram, Facebook Messenger, TikTok)
|
|
@@ -12603,7 +12976,7 @@ export type platform15 = 'whatsapp';
|
|
|
12603
12976
|
/**
|
|
12604
12977
|
* Normalized from Meta's `decision` (REJECTED -> DECLINED, DEFERRED -> PENDING_REVIEW; the review is still open on DEFERRED, not a rejection).
|
|
12605
12978
|
*/
|
|
12606
|
-
export type
|
|
12979
|
+
export type status30 = 'APPROVED' | 'DECLINED' | 'PENDING_REVIEW';
|
|
12607
12980
|
|
|
12608
12981
|
/**
|
|
12609
12982
|
* Webhook payload for the `whatsapp.template.category_updated` event.
|
|
@@ -12752,7 +13125,7 @@ export type event32 = 'whatsapp.template.status_updated';
|
|
|
12752
13125
|
* request before the template is actually removed.
|
|
12753
13126
|
*
|
|
12754
13127
|
*/
|
|
12755
|
-
export type
|
|
13128
|
+
export type status31 = 'APPROVED' | 'REJECTED' | 'PENDING' | 'PAUSED' | 'DISABLED' | 'IN_APPEAL' | 'PENDING_DELETION';
|
|
12756
13129
|
|
|
12757
13130
|
export type WhatsAppBodyComponent = {
|
|
12758
13131
|
type: 'body';
|
|
@@ -12906,7 +13279,7 @@ export type WhatsAppSandboxSession = {
|
|
|
12906
13279
|
* list responses.
|
|
12907
13280
|
*
|
|
12908
13281
|
*/
|
|
12909
|
-
export type
|
|
13282
|
+
export type status32 = 'pending' | 'active';
|
|
12910
13283
|
|
|
12911
13284
|
export type WhatsAppTemplateButton = {
|
|
12912
13285
|
type: 'quick_reply' | 'url' | 'phone_number' | 'otp' | 'copy_code' | 'flow' | 'mpm' | 'catalog';
|
|
@@ -12940,7 +13313,7 @@ export type WhatsAppTemplateButton = {
|
|
|
12940
13313
|
navigate_screen?: string;
|
|
12941
13314
|
};
|
|
12942
13315
|
|
|
12943
|
-
export type
|
|
13316
|
+
export type type13 = 'quick_reply' | 'url' | 'phone_number' | 'otp' | 'copy_code' | 'flow' | 'mpm' | 'catalog';
|
|
12944
13317
|
|
|
12945
13318
|
/**
|
|
12946
13319
|
* Required when type is otp
|
|
@@ -12982,7 +13355,7 @@ export type WhatsAppTemplateLookupError = {
|
|
|
12982
13355
|
};
|
|
12983
13356
|
};
|
|
12984
13357
|
|
|
12985
|
-
export type
|
|
13358
|
+
export type type14 = 'platform_error';
|
|
12986
13359
|
|
|
12987
13360
|
export type code = 'platform_api_error';
|
|
12988
13361
|
|
|
@@ -13064,7 +13437,7 @@ export type WorkflowExecutionEvent = {
|
|
|
13064
13437
|
|
|
13065
13438
|
export type action2 = 'execution_started' | 'execution_completed' | 'execution_exited' | 'execution_paused' | 'execution_resumed' | 'node_started' | 'node_completed' | 'node_failed' | 'node_skipped';
|
|
13066
13439
|
|
|
13067
|
-
export type
|
|
13440
|
+
export type status33 = 'success' | 'failed' | 'pending';
|
|
13068
13441
|
|
|
13069
13442
|
/**
|
|
13070
13443
|
* A node in a workflow graph. `config` shape depends on `type`.
|
|
@@ -13141,7 +13514,7 @@ export type WorkflowNode = {
|
|
|
13141
13514
|
* integrations (webhook, ai, handoff, start_call).
|
|
13142
13515
|
*
|
|
13143
13516
|
*/
|
|
13144
|
-
export type
|
|
13517
|
+
export type type15 = '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';
|
|
13145
13518
|
|
|
13146
13519
|
/**
|
|
13147
13520
|
* A single X API operation with its per-call price and the Zernio platform methods that trigger it.
|
|
@@ -13277,7 +13650,7 @@ export type XArticleBlock = {
|
|
|
13277
13650
|
entity_ranges?: Array<XArticleEntityRange>;
|
|
13278
13651
|
};
|
|
13279
13652
|
|
|
13280
|
-
export type
|
|
13653
|
+
export type type16 = 'unstyled' | 'header-one' | 'header-two' | 'header-three' | 'unordered-list-item' | 'ordered-list-item' | 'blockquote' | 'atomic';
|
|
13281
13654
|
|
|
13282
13655
|
/**
|
|
13283
13656
|
* X's snake_case content-state shape. Standard DraftJS camelCase fields such as entityMap, inlineStyleRanges, and entityRanges are rejected.
|
|
@@ -13356,7 +13729,7 @@ export type XArticleEntity = {
|
|
|
13356
13729
|
|
|
13357
13730
|
export type mutability = 'immutable' | 'mutable' | 'segmented';
|
|
13358
13731
|
|
|
13359
|
-
export type
|
|
13732
|
+
export type type17 = 'divider' | 'latex';
|
|
13360
13733
|
|
|
13361
13734
|
/**
|
|
13362
13735
|
* The referenced entity must exist, and offset plus length must not exceed the containing block's text length.
|
|
@@ -23396,7 +23769,7 @@ export type CreateWebhookSettingsData = {
|
|
|
23396
23769
|
/**
|
|
23397
23770
|
* Events to subscribe to (at least one required)
|
|
23398
23771
|
*/
|
|
23399
|
-
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.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.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')>;
|
|
23772
|
+
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.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.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')>;
|
|
23400
23773
|
/**
|
|
23401
23774
|
* Enable or disable webhook delivery. Defaults to `true` when omitted.
|
|
23402
23775
|
*/
|
|
@@ -23464,7 +23837,7 @@ export type UpdateWebhookSettingsData = {
|
|
|
23464
23837
|
/**
|
|
23465
23838
|
* Events to subscribe to. Must contain at least one event if provided.
|
|
23466
23839
|
*/
|
|
23467
|
-
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.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.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')>;
|
|
23840
|
+
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.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.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')>;
|
|
23468
23841
|
/**
|
|
23469
23842
|
* Enable or disable webhook delivery
|
|
23470
23843
|
*/
|
|
@@ -24258,7 +24631,7 @@ export type SearchInboxConversationsData = {
|
|
|
24258
24631
|
/**
|
|
24259
24632
|
* Filter by platform (searchable platforms only)
|
|
24260
24633
|
*/
|
|
24261
|
-
platform?: 'facebook' | 'instagram' | 'telegram' | 'whatsapp' | 'sms' | 'slack' | 'imessage';
|
|
24634
|
+
platform?: 'facebook' | 'instagram' | 'telegram' | 'whatsapp' | 'sms' | 'rcs' | 'slack' | 'imessage';
|
|
24262
24635
|
/**
|
|
24263
24636
|
* Filter by profile ID
|
|
24264
24637
|
*/
|
|
@@ -28856,6 +29229,248 @@ export type SendSmsError = (ErrorResponse | {
|
|
|
28856
29229
|
error?: string;
|
|
28857
29230
|
} | unknown);
|
|
28858
29231
|
|
|
29232
|
+
export type ListRcsBrandsResponse = ({
|
|
29233
|
+
brands?: Array<RcsBrand>;
|
|
29234
|
+
});
|
|
29235
|
+
|
|
29236
|
+
export type ListRcsBrandsError = ({
|
|
29237
|
+
error?: string;
|
|
29238
|
+
} | unknown);
|
|
29239
|
+
|
|
29240
|
+
export type ListRcsAgentsData = {
|
|
29241
|
+
query?: {
|
|
29242
|
+
/**
|
|
29243
|
+
* Include rejected and deactivated agents.
|
|
29244
|
+
*/
|
|
29245
|
+
includeClosed?: boolean;
|
|
29246
|
+
};
|
|
29247
|
+
};
|
|
29248
|
+
|
|
29249
|
+
export type ListRcsAgentsResponse = ({
|
|
29250
|
+
agents?: Array<RcsAgent>;
|
|
29251
|
+
});
|
|
29252
|
+
|
|
29253
|
+
export type ListRcsAgentsError = (ErrorResponse | {
|
|
29254
|
+
error?: string;
|
|
29255
|
+
} | unknown);
|
|
29256
|
+
|
|
29257
|
+
export type CreateRcsAgentData = {
|
|
29258
|
+
body: {
|
|
29259
|
+
profileId: string;
|
|
29260
|
+
brandId?: string;
|
|
29261
|
+
brand?: RcsBrandInput;
|
|
29262
|
+
/**
|
|
29263
|
+
* Shown as the sender name.
|
|
29264
|
+
*/
|
|
29265
|
+
displayName: string;
|
|
29266
|
+
useCase: 'MULTI_USE' | 'PROMOTIONAL' | 'TRANSACTIONAL' | 'OTP';
|
|
29267
|
+
profile: RcsAgentProfile;
|
|
29268
|
+
/**
|
|
29269
|
+
* One of your SMS-enabled numbers. Phones without RCS get the message as SMS from it.
|
|
29270
|
+
*/
|
|
29271
|
+
smsFallbackFrom?: string;
|
|
29272
|
+
};
|
|
29273
|
+
headers?: {
|
|
29274
|
+
/**
|
|
29275
|
+
* Optional client-generated unique key (e.g. a UUID) that makes retries safe. Same key + same body replays the original response; same key + different body → 422; key still processing → 409.
|
|
29276
|
+
*/
|
|
29277
|
+
'Idempotency-Key'?: string;
|
|
29278
|
+
};
|
|
29279
|
+
};
|
|
29280
|
+
|
|
29281
|
+
export type CreateRcsAgentResponse = ({
|
|
29282
|
+
agent?: RcsAgent;
|
|
29283
|
+
});
|
|
29284
|
+
|
|
29285
|
+
export type CreateRcsAgentError = (ErrorResponse | {
|
|
29286
|
+
error?: string;
|
|
29287
|
+
} | unknown);
|
|
29288
|
+
|
|
29289
|
+
export type GetRcsAgentData = {
|
|
29290
|
+
path: {
|
|
29291
|
+
agentId: string;
|
|
29292
|
+
};
|
|
29293
|
+
};
|
|
29294
|
+
|
|
29295
|
+
export type GetRcsAgentResponse = ({
|
|
29296
|
+
agent?: RcsAgent;
|
|
29297
|
+
});
|
|
29298
|
+
|
|
29299
|
+
export type GetRcsAgentError = (ErrorResponse | {
|
|
29300
|
+
error?: string;
|
|
29301
|
+
} | unknown);
|
|
29302
|
+
|
|
29303
|
+
export type UpdateRcsAgentData = {
|
|
29304
|
+
body: {
|
|
29305
|
+
displayName?: string;
|
|
29306
|
+
useCase?: 'MULTI_USE' | 'PROMOTIONAL' | 'TRANSACTIONAL' | 'OTP';
|
|
29307
|
+
profile?: RcsAgentProfile;
|
|
29308
|
+
brand?: RcsBrandInput;
|
|
29309
|
+
smsFallbackFrom?: (string) | null;
|
|
29310
|
+
};
|
|
29311
|
+
path: {
|
|
29312
|
+
agentId: string;
|
|
29313
|
+
};
|
|
29314
|
+
};
|
|
29315
|
+
|
|
29316
|
+
export type UpdateRcsAgentResponse = ({
|
|
29317
|
+
agent?: RcsAgent;
|
|
29318
|
+
});
|
|
29319
|
+
|
|
29320
|
+
export type UpdateRcsAgentError = (ErrorResponse | {
|
|
29321
|
+
error?: string;
|
|
29322
|
+
} | unknown);
|
|
29323
|
+
|
|
29324
|
+
export type DeactivateRcsAgentData = {
|
|
29325
|
+
path: {
|
|
29326
|
+
agentId: string;
|
|
29327
|
+
};
|
|
29328
|
+
};
|
|
29329
|
+
|
|
29330
|
+
export type DeactivateRcsAgentResponse = ({
|
|
29331
|
+
agent?: RcsAgent;
|
|
29332
|
+
});
|
|
29333
|
+
|
|
29334
|
+
export type DeactivateRcsAgentError = (ErrorResponse | {
|
|
29335
|
+
error?: string;
|
|
29336
|
+
} | unknown);
|
|
29337
|
+
|
|
29338
|
+
export type RequestRcsAgentLaunchData = {
|
|
29339
|
+
body: RcsLaunchRequest;
|
|
29340
|
+
path: {
|
|
29341
|
+
agentId: string;
|
|
29342
|
+
};
|
|
29343
|
+
};
|
|
29344
|
+
|
|
29345
|
+
export type RequestRcsAgentLaunchResponse = ({
|
|
29346
|
+
agent?: RcsAgent;
|
|
29347
|
+
});
|
|
29348
|
+
|
|
29349
|
+
export type RequestRcsAgentLaunchError = (ErrorResponse | {
|
|
29350
|
+
error?: string;
|
|
29351
|
+
} | unknown);
|
|
29352
|
+
|
|
29353
|
+
export type ListRcsTestDevicesData = {
|
|
29354
|
+
path: {
|
|
29355
|
+
agentId: string;
|
|
29356
|
+
};
|
|
29357
|
+
};
|
|
29358
|
+
|
|
29359
|
+
export type ListRcsTestDevicesResponse = ({
|
|
29360
|
+
testDevices?: Array<RcsTestDevice>;
|
|
29361
|
+
});
|
|
29362
|
+
|
|
29363
|
+
export type ListRcsTestDevicesError = (ErrorResponse | {
|
|
29364
|
+
error?: string;
|
|
29365
|
+
} | unknown);
|
|
29366
|
+
|
|
29367
|
+
export type AddRcsTestDeviceData = {
|
|
29368
|
+
body: {
|
|
29369
|
+
/**
|
|
29370
|
+
* E.164
|
|
29371
|
+
*/
|
|
29372
|
+
phoneNumber: string;
|
|
29373
|
+
};
|
|
29374
|
+
path: {
|
|
29375
|
+
agentId: string;
|
|
29376
|
+
};
|
|
29377
|
+
};
|
|
29378
|
+
|
|
29379
|
+
export type AddRcsTestDeviceResponse = ({
|
|
29380
|
+
testDevice?: RcsTestDevice;
|
|
29381
|
+
});
|
|
29382
|
+
|
|
29383
|
+
export type AddRcsTestDeviceError = (unknown | {
|
|
29384
|
+
error?: string;
|
|
29385
|
+
});
|
|
29386
|
+
|
|
29387
|
+
export type RemoveRcsTestDeviceData = {
|
|
29388
|
+
path: {
|
|
29389
|
+
agentId: string;
|
|
29390
|
+
testDeviceId: string;
|
|
29391
|
+
};
|
|
29392
|
+
};
|
|
29393
|
+
|
|
29394
|
+
export type RemoveRcsTestDeviceResponse = ({
|
|
29395
|
+
success?: boolean;
|
|
29396
|
+
});
|
|
29397
|
+
|
|
29398
|
+
export type RemoveRcsTestDeviceError = (ErrorResponse | {
|
|
29399
|
+
error?: string;
|
|
29400
|
+
} | unknown);
|
|
29401
|
+
|
|
29402
|
+
export type UploadRcsAssetData = {
|
|
29403
|
+
body: {
|
|
29404
|
+
/**
|
|
29405
|
+
* PNG, JPEG or WebP.
|
|
29406
|
+
*/
|
|
29407
|
+
file: (Blob | File);
|
|
29408
|
+
kind: 'logo' | 'banner';
|
|
29409
|
+
};
|
|
29410
|
+
};
|
|
29411
|
+
|
|
29412
|
+
export type UploadRcsAssetResponse = ({
|
|
29413
|
+
url?: string;
|
|
29414
|
+
});
|
|
29415
|
+
|
|
29416
|
+
export type UploadRcsAssetError = (ErrorResponse | {
|
|
29417
|
+
error?: string;
|
|
29418
|
+
} | unknown);
|
|
29419
|
+
|
|
29420
|
+
export type SendRcsMessageData = {
|
|
29421
|
+
body: {
|
|
29422
|
+
agentId: string;
|
|
29423
|
+
/**
|
|
29424
|
+
* Recipient number (E.164; formatting is normalized).
|
|
29425
|
+
*/
|
|
29426
|
+
to: string;
|
|
29427
|
+
text?: string;
|
|
29428
|
+
content?: RcsContent;
|
|
29429
|
+
fallbackText?: string;
|
|
29430
|
+
/**
|
|
29431
|
+
* Seconds before an undelivered message expires.
|
|
29432
|
+
*/
|
|
29433
|
+
ttlSeconds?: number;
|
|
29434
|
+
};
|
|
29435
|
+
headers?: {
|
|
29436
|
+
/**
|
|
29437
|
+
* Optional client-generated unique key (e.g. a UUID) that makes retries safe. Same key + same body replays the original response; same key + different body → 422; key still processing → 409.
|
|
29438
|
+
*/
|
|
29439
|
+
'Idempotency-Key'?: string;
|
|
29440
|
+
};
|
|
29441
|
+
};
|
|
29442
|
+
|
|
29443
|
+
export type SendRcsMessageResponse = ({
|
|
29444
|
+
/**
|
|
29445
|
+
* Message ID
|
|
29446
|
+
*/
|
|
29447
|
+
id?: string;
|
|
29448
|
+
conversationId?: string;
|
|
29449
|
+
status?: 'sent';
|
|
29450
|
+
});
|
|
29451
|
+
|
|
29452
|
+
export type SendRcsMessageError = (ErrorResponse | {
|
|
29453
|
+
error?: string;
|
|
29454
|
+
} | unknown);
|
|
29455
|
+
|
|
29456
|
+
export type GetRcsCapabilitiesData = {
|
|
29457
|
+
query: {
|
|
29458
|
+
agentId: string;
|
|
29459
|
+
/**
|
|
29460
|
+
* Comma-separated E.164 numbers, max 100.
|
|
29461
|
+
*/
|
|
29462
|
+
numbers: string;
|
|
29463
|
+
};
|
|
29464
|
+
};
|
|
29465
|
+
|
|
29466
|
+
export type GetRcsCapabilitiesResponse = ({
|
|
29467
|
+
capabilities?: Array<RcsCapability>;
|
|
29468
|
+
});
|
|
29469
|
+
|
|
29470
|
+
export type GetRcsCapabilitiesError = (ErrorResponse | {
|
|
29471
|
+
error?: string;
|
|
29472
|
+
} | unknown);
|
|
29473
|
+
|
|
28859
29474
|
export type LookupSmsNumberData = {
|
|
28860
29475
|
query: {
|
|
28861
29476
|
/**
|
|
@@ -48897,7 +49512,7 @@ export type ListTrackingTagsData = {
|
|
|
48897
49512
|
};
|
|
48898
49513
|
|
|
48899
49514
|
export type ListTrackingTagsResponse = ({
|
|
48900
|
-
platform?: 'metaads' | 'openaiads' | 'tiktokads' | 'googleads';
|
|
49515
|
+
platform?: 'metaads' | 'openaiads' | 'tiktokads' | 'googleads' | 'xads';
|
|
48901
49516
|
tags?: Array<TrackingTag>;
|
|
48902
49517
|
});
|
|
48903
49518
|
|
|
@@ -48926,7 +49541,7 @@ export type CreateTrackingTagData = {
|
|
|
48926
49541
|
};
|
|
48927
49542
|
|
|
48928
49543
|
export type CreateTrackingTagResponse = ({
|
|
48929
|
-
platform?: 'metaads' | 'openaiads' | 'tiktokads' | 'googleads';
|
|
49544
|
+
platform?: 'metaads' | 'openaiads' | 'tiktokads' | 'googleads' | 'xads';
|
|
48930
49545
|
tag?: TrackingTag;
|
|
48931
49546
|
});
|
|
48932
49547
|
|
|
@@ -48951,7 +49566,7 @@ export type GetTrackingTagData = {
|
|
|
48951
49566
|
};
|
|
48952
49567
|
|
|
48953
49568
|
export type GetTrackingTagResponse = ({
|
|
48954
|
-
platform?: 'metaads' | 'tiktokads' | 'googleads';
|
|
49569
|
+
platform?: 'metaads' | 'tiktokads' | 'googleads' | 'xads';
|
|
48955
49570
|
tag?: TrackingTag;
|
|
48956
49571
|
});
|
|
48957
49572
|
|
|
@@ -48991,7 +49606,7 @@ export type UpdateTrackingTagData = {
|
|
|
48991
49606
|
};
|
|
48992
49607
|
|
|
48993
49608
|
export type UpdateTrackingTagResponse = ({
|
|
48994
|
-
platform?: 'metaads' | 'tiktokads' | 'googleads';
|
|
49609
|
+
platform?: 'metaads' | 'tiktokads' | 'googleads' | 'xads';
|
|
48995
49610
|
tag?: TrackingTag;
|
|
48996
49611
|
});
|
|
48997
49612
|
|
|
@@ -49094,7 +49709,7 @@ export type InstallTrackingTagOnStoreData = {
|
|
|
49094
49709
|
};
|
|
49095
49710
|
|
|
49096
49711
|
export type InstallTrackingTagOnStoreResponse = ({
|
|
49097
|
-
platform?: 'metaads' | 'tiktokads' | 'googleads';
|
|
49712
|
+
platform?: 'metaads' | 'tiktokads' | 'googleads' | 'xads';
|
|
49098
49713
|
install?: (StorePixelInstall & {
|
|
49099
49714
|
/**
|
|
49100
49715
|
* Shopify only: the pixel this install replaced on the store, if any.
|
|
@@ -49149,7 +49764,7 @@ export type GetTrackingTagStoreInstallData = {
|
|
|
49149
49764
|
};
|
|
49150
49765
|
|
|
49151
49766
|
export type GetTrackingTagStoreInstallResponse = ({
|
|
49152
|
-
platform?: 'metaads' | 'tiktokads' | 'googleads';
|
|
49767
|
+
platform?: 'metaads' | 'tiktokads' | 'googleads' | 'xads';
|
|
49153
49768
|
install?: (StorePixelInstall & {
|
|
49154
49769
|
/**
|
|
49155
49770
|
* WordPress only.
|
|
@@ -49199,7 +49814,7 @@ export type RemoveTrackingTagFromStoreData = {
|
|
|
49199
49814
|
};
|
|
49200
49815
|
|
|
49201
49816
|
export type RemoveTrackingTagFromStoreResponse = ({
|
|
49202
|
-
platform?: 'metaads' | 'tiktokads' | 'googleads';
|
|
49817
|
+
platform?: 'metaads' | 'tiktokads' | 'googleads' | 'xads';
|
|
49203
49818
|
install?: (StorePixelInstall & {
|
|
49204
49819
|
/**
|
|
49205
49820
|
* WordPress only: number of Zernio widgets deleted.
|
|
@@ -49212,6 +49827,101 @@ export type RemoveTrackingTagFromStoreError = (ErrorResponse | {
|
|
|
49212
49827
|
error?: string;
|
|
49213
49828
|
} | unknown);
|
|
49214
49829
|
|
|
49830
|
+
export type ListTrackingTagEventsData = {
|
|
49831
|
+
path: {
|
|
49832
|
+
accountId: string;
|
|
49833
|
+
/**
|
|
49834
|
+
* Tag id (`TrackingTag.id`).
|
|
49835
|
+
*/
|
|
49836
|
+
tagId: string;
|
|
49837
|
+
};
|
|
49838
|
+
query?: {
|
|
49839
|
+
/**
|
|
49840
|
+
* Scopes the lookup on platforms whose tag ids live inside an ad account.
|
|
49841
|
+
*/
|
|
49842
|
+
adAccountId?: string;
|
|
49843
|
+
};
|
|
49844
|
+
};
|
|
49845
|
+
|
|
49846
|
+
export type ListTrackingTagEventsResponse = ({
|
|
49847
|
+
platform?: string;
|
|
49848
|
+
events?: Array<TrackingTagEvent>;
|
|
49849
|
+
});
|
|
49850
|
+
|
|
49851
|
+
export type ListTrackingTagEventsError = (ErrorResponse | {
|
|
49852
|
+
error?: string;
|
|
49853
|
+
} | unknown);
|
|
49854
|
+
|
|
49855
|
+
export type CreateTrackingTagEventData = {
|
|
49856
|
+
body: (TrackingTagEventInput & {
|
|
49857
|
+
[key: string]: unknown;
|
|
49858
|
+
});
|
|
49859
|
+
path: {
|
|
49860
|
+
accountId: string;
|
|
49861
|
+
/**
|
|
49862
|
+
* Tag id (`TrackingTag.id`).
|
|
49863
|
+
*/
|
|
49864
|
+
tagId: string;
|
|
49865
|
+
};
|
|
49866
|
+
};
|
|
49867
|
+
|
|
49868
|
+
export type CreateTrackingTagEventResponse = ({
|
|
49869
|
+
platform?: string;
|
|
49870
|
+
event?: TrackingTagEvent;
|
|
49871
|
+
});
|
|
49872
|
+
|
|
49873
|
+
export type CreateTrackingTagEventError = (ErrorResponse | {
|
|
49874
|
+
error?: string;
|
|
49875
|
+
} | unknown);
|
|
49876
|
+
|
|
49877
|
+
export type UpdateTrackingTagEventData = {
|
|
49878
|
+
body: TrackingTagEventInput;
|
|
49879
|
+
path: {
|
|
49880
|
+
accountId: string;
|
|
49881
|
+
/**
|
|
49882
|
+
* Event id (`TrackingTagEvent.id`).
|
|
49883
|
+
*/
|
|
49884
|
+
eventId: string;
|
|
49885
|
+
tagId: string;
|
|
49886
|
+
};
|
|
49887
|
+
};
|
|
49888
|
+
|
|
49889
|
+
export type UpdateTrackingTagEventResponse = ({
|
|
49890
|
+
platform?: string;
|
|
49891
|
+
event?: TrackingTagEvent;
|
|
49892
|
+
});
|
|
49893
|
+
|
|
49894
|
+
export type UpdateTrackingTagEventError = (ErrorResponse | {
|
|
49895
|
+
error?: string;
|
|
49896
|
+
} | unknown);
|
|
49897
|
+
|
|
49898
|
+
export type DeleteTrackingTagEventData = {
|
|
49899
|
+
path: {
|
|
49900
|
+
accountId: string;
|
|
49901
|
+
/**
|
|
49902
|
+
* Event id (`TrackingTagEvent.id`).
|
|
49903
|
+
*/
|
|
49904
|
+
eventId: string;
|
|
49905
|
+
tagId: string;
|
|
49906
|
+
};
|
|
49907
|
+
query?: {
|
|
49908
|
+
/**
|
|
49909
|
+
* Scopes the lookup on platforms whose tag ids live inside an ad account.
|
|
49910
|
+
*/
|
|
49911
|
+
adAccountId?: string;
|
|
49912
|
+
};
|
|
49913
|
+
};
|
|
49914
|
+
|
|
49915
|
+
export type DeleteTrackingTagEventResponse = ({
|
|
49916
|
+
platform?: string;
|
|
49917
|
+
eventId?: string;
|
|
49918
|
+
state?: 'deleted' | 'archived' | 'disabled';
|
|
49919
|
+
});
|
|
49920
|
+
|
|
49921
|
+
export type DeleteTrackingTagEventError = (ErrorResponse | {
|
|
49922
|
+
error?: string;
|
|
49923
|
+
} | unknown);
|
|
49924
|
+
|
|
49215
49925
|
export type GetTrackingTagStatsData = {
|
|
49216
49926
|
path: {
|
|
49217
49927
|
accountId: string;
|
|
@@ -49241,7 +49951,7 @@ export type GetTrackingTagStatsData = {
|
|
|
49241
49951
|
};
|
|
49242
49952
|
|
|
49243
49953
|
export type GetTrackingTagStatsResponse = ({
|
|
49244
|
-
platform?: 'metaads' | 'tiktokads' | 'googleads';
|
|
49954
|
+
platform?: 'metaads' | 'tiktokads' | 'googleads' | 'xads';
|
|
49245
49955
|
stats?: {
|
|
49246
49956
|
aggregation?: string;
|
|
49247
49957
|
startTime?: number;
|