@getlatedev/node 0.2.261 → 0.2.263

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.mts CHANGED
@@ -805,7 +805,7 @@ type AccountWithFollowerStats = SocialAccount & {
805
805
  */
806
806
  mediaCount?: number;
807
807
  /**
808
- * Total videos (YouTube
808
+ * Total videos (YouTube, TikTok)
809
809
  */
810
810
  videoCount?: number;
811
811
  /**
@@ -1904,7 +1904,7 @@ type DiscordPlatformData = {
1904
1904
  };
1905
1905
  footer?: {
1906
1906
  /**
1907
- * Footer text (max 2
1907
+ * Footer text (max 2,048 chars)
1908
1908
  */
1909
1909
  text?: string;
1910
1910
  icon_url?: string;
@@ -1926,7 +1926,7 @@ type DiscordPlatformData = {
1926
1926
  */
1927
1927
  name: string;
1928
1928
  /**
1929
- * Field value (max 1
1929
+ * Field value (max 1,024 chars)
1930
1930
  */
1931
1931
  value: string;
1932
1932
  /**
@@ -3366,7 +3366,7 @@ type RedditPost = {
3366
3366
  author?: string;
3367
3367
  subreddit?: string;
3368
3368
  /**
3369
- * Post URL (may be a gallery URL
3369
+ * Post URL (may be a gallery URL, external link, or self-post URL)
3370
3370
  */
3371
3371
  url?: string;
3372
3372
  /**
@@ -3456,7 +3456,7 @@ type SharedAdAccount = {
3456
3456
  id: string;
3457
3457
  name?: string;
3458
3458
  /**
3459
- * Business Manager id that owns the ad account
3459
+ * Business Manager id that owns the ad account, when reported.
3460
3460
  */
3461
3461
  businessId?: string;
3462
3462
  };
@@ -4814,7 +4814,7 @@ type WebhookPayloadConversationStarted = {
4814
4814
  platform: 'instagram' | 'facebook' | 'telegram' | 'whatsapp' | 'twitter' | 'reddit' | 'bluesky';
4815
4815
  platformConversationId: string;
4816
4816
  /**
4817
- * Contact's platform identifier (IGSID
4817
+ * Contact's platform identifier (IGSID, PSID, wa_id, etc.)
4818
4818
  */
4819
4819
  participantId?: string;
4820
4820
  participantName: string;
@@ -8799,7 +8799,7 @@ type ConfigureTikTokAdsBrandIdentityData = {
8799
8799
  type ConfigureTikTokAdsBrandIdentityResponse = ({
8800
8800
  success?: boolean;
8801
8801
  /**
8802
- * The TikTok-assigned identity_id
8802
+ * The TikTok-assigned identity_id, cached on the account.
8803
8803
  */
8804
8804
  identityId?: string;
8805
8805
  displayName?: string;
@@ -9114,7 +9114,7 @@ type GetGoogleBusinessVerificationsResponse = ({
9114
9114
  */
9115
9115
  voiceOfMerchantState?: {
9116
9116
  /**
9117
- * True when the listing is verified and published (eligible to surface reviews
9117
+ * True when the listing is verified and published (eligible to surface reviews, edits, etc.).
9118
9118
  */
9119
9119
  hasVoiceOfMerchant?: boolean;
9120
9120
  /**
@@ -10080,7 +10080,7 @@ type BatchGetGoogleBusinessReviewsResponse = ({
10080
10080
  */
10081
10081
  name?: string;
10082
10082
  /**
10083
- * The review object (reviewId
10083
+ * The review object (reviewId, starRating, comment, reviewer, createTime, updateTime, reviewReply)
10084
10084
  */
10085
10085
  review?: {
10086
10086
  [key: string]: unknown;
@@ -12740,7 +12740,7 @@ type GetInboxConversationMessagesResponse = ({
12740
12740
  reactions?: Array<{
12741
12741
  emoji?: string;
12742
12742
  /**
12743
- * true if the connected account reacted
12743
+ * true if the connected account reacted, false if the contact did.
12744
12744
  */
12745
12745
  fromMe?: boolean;
12746
12746
  reactedAt?: string;
@@ -13083,7 +13083,7 @@ type SendInboxMessageData = {
13083
13083
  */
13084
13084
  text?: string;
13085
13085
  /**
13086
- * Callback data (inline_keyboard only
13086
+ * Callback data (inline_keyboard only, max 64 bytes)
13087
13087
  */
13088
13088
  callbackData?: string;
13089
13089
  /**
@@ -13657,11 +13657,11 @@ type GetInboxPostCommentsResponse = ({
13657
13657
  canReply?: boolean;
13658
13658
  canDelete?: boolean;
13659
13659
  /**
13660
- * Whether this comment can be hidden (Facebook
13660
+ * Whether this comment can be hidden (Facebook, Instagram, Threads)
13661
13661
  */
13662
13662
  canHide?: boolean;
13663
13663
  /**
13664
- * Whether this comment can be liked (Facebook
13664
+ * Whether this comment can be liked (Facebook, Twitter/X, Bluesky, Reddit)
13665
13665
  */
13666
13666
  canLike?: boolean;
13667
13667
  /**
@@ -13715,11 +13715,11 @@ type GetInboxPostCommentsResponse = ({
13715
13715
  */
13716
13716
  selftext?: string;
13717
13717
  /**
13718
- * Reddit username
13718
+ * Reddit username, without the u/ prefix
13719
13719
  */
13720
13720
  author?: string;
13721
13721
  /**
13722
- * Subreddit name
13722
+ * Subreddit name, without the r/ prefix
13723
13723
  */
13724
13724
  subreddit?: string;
13725
13725
  /**
@@ -13727,7 +13727,7 @@ type GetInboxPostCommentsResponse = ({
13727
13727
  */
13728
13728
  permalink?: string;
13729
13729
  /**
13730
- * For link posts
13730
+ * For link posts, the external URL; for self-posts, the Reddit permalink
13731
13731
  */
13732
13732
  url?: string;
13733
13733
  /**
@@ -14486,7 +14486,7 @@ type EnableWhatsAppCallingData = {
14486
14486
  forwardTo: string;
14487
14487
  sipAuthUsername?: string;
14488
14488
  /**
14489
- * Stored encrypted
14489
+ * Stored encrypted, never returned by any endpoint.
14490
14490
  */
14491
14491
  sipAuthPassword?: string;
14492
14492
  recordingEnabled?: boolean;
@@ -14541,7 +14541,7 @@ type GetWhatsAppCallPermissionsData = {
14541
14541
  query: {
14542
14542
  accountId: string;
14543
14543
  /**
14544
- * Consumer wa_id (E.164
14544
+ * Consumer wa_id (E.164, leading + optional)
14545
14545
  */
14546
14546
  to: string;
14547
14547
  };
@@ -14566,7 +14566,7 @@ type InitiateWhatsAppCallData = {
14566
14566
  body: {
14567
14567
  accountId: string;
14568
14568
  /**
14569
- * Consumer wa_id (E.164
14569
+ * Consumer wa_id (E.164, leading + optional)
14570
14570
  */
14571
14571
  to: string;
14572
14572
  /**
@@ -15130,7 +15130,7 @@ type GetWhatsAppPhoneNumbersResponse = ({
15130
15130
  country?: string;
15131
15131
  status?: 'pending_payment' | 'pending_regulatory' | 'regulatory_declined' | 'provisioning' | 'verifying' | 'active' | 'suspended' | 'releasing' | 'released';
15132
15132
  /**
15133
- * For regulated numbers
15133
+ * For regulated numbers, who it's registered for (company or person) — set from the submitted KYC.
15134
15134
  */
15135
15135
  registrantName?: (string) | null;
15136
15136
  /**
@@ -15472,7 +15472,7 @@ type ValidateWhatsAppNumberKycAddressData = {
15472
15472
  */
15473
15473
  locality: string;
15474
15474
  /**
15475
- * State / province / region. When omitted
15475
+ * State / province / region. When omitted, the pre-check is skipped (the final submit still validates).
15476
15476
  */
15477
15477
  administrative_area?: string;
15478
15478
  postal_code: string;
@@ -17318,7 +17318,7 @@ type TriggerWorkflowData = {
17318
17318
  */
17319
17319
  conversationId?: string;
17320
17320
  /**
17321
- * Simulated inbound text
17321
+ * Simulated inbound text, seeded as the run's lastMessage variable
17322
17322
  */
17323
17323
  text?: string;
17324
17324
  };
@@ -17415,7 +17415,7 @@ type ListWorkflowVersionsResponse = ({
17415
17415
  */
17416
17416
  createdByEmail?: (string) | null;
17417
17417
  /**
17418
- * When non-null
17418
+ * When non-null, this snapshot was created by restoring that version
17419
17419
  */
17420
17420
  restoredFromVersion?: (number) | null;
17421
17421
  createdAt?: string;
@@ -18436,7 +18436,11 @@ type GetAdTreeData = {
18436
18436
  */
18437
18437
  adAccountId?: string;
18438
18438
  /**
18439
- * Start of metrics date range (YYYY-MM-DD). Defaults to 90 days ago.
18439
+ * Restrict the tree to a single campaign by its platform campaign id (the id the platform assigns, e.g. Meta's numeric campaign id). Filters the campaign set itself, so it works regardless of account size and pagination — pass this when you already hold a campaign id instead of paging the tree to find it. Mirrors the `campaignId` filter on GET /v1/ads.
18440
+ */
18441
+ campaignId?: string;
18442
+ /**
18443
+ * Start of the METRICS date range (YYYY-MM-DD). Affects only the spend/impression numbers overlaid on each node, NOT which campaigns are returned. Defaults to 90 days ago.
18440
18444
  */
18441
18445
  fromDate?: string;
18442
18446
  /**
@@ -20300,7 +20304,7 @@ type GetConversionsQualityError = ({
20300
20304
  type SendConversionsData = {
20301
20305
  body: {
20302
20306
  /**
20303
- * SocialAccount ID (metaads, googleads, or linkedinads).
20307
+ * SocialAccount ID (metaads, googleads, linkedinads, or tiktokads).
20304
20308
  */
20305
20309
  accountId: string;
20306
20310
  /**
@@ -20329,7 +20333,7 @@ type SendConversionsData = {
20329
20333
  };
20330
20334
  };
20331
20335
  type SendConversionsResponse = ({
20332
- platform?: 'metaads' | 'googleads' | 'linkedinads';
20336
+ platform?: 'metaads' | 'googleads' | 'linkedinads' | 'tiktokads';
20333
20337
  /**
20334
20338
  * Events accepted by the platform.
20335
20339
  */
@@ -20437,13 +20441,13 @@ type AdjustConversionsError = (unknown | {
20437
20441
  type ListConversionDestinationsData = {
20438
20442
  path: {
20439
20443
  /**
20440
- * SocialAccount ID (metaads, googleads, or linkedinads).
20444
+ * SocialAccount ID (metaads, googleads, linkedinads, or tiktokads).
20441
20445
  */
20442
20446
  accountId: string;
20443
20447
  };
20444
20448
  };
20445
20449
  type ListConversionDestinationsResponse = ({
20446
- platform?: 'metaads' | 'googleads' | 'linkedinads';
20450
+ platform?: 'metaads' | 'googleads' | 'linkedinads' | 'tiktokads';
20447
20451
  destinations?: Array<{
20448
20452
  /**
20449
20453
  * Destination identifier. Meta: pixel ID. Google:
package/dist/index.d.ts CHANGED
@@ -805,7 +805,7 @@ type AccountWithFollowerStats = SocialAccount & {
805
805
  */
806
806
  mediaCount?: number;
807
807
  /**
808
- * Total videos (YouTube
808
+ * Total videos (YouTube, TikTok)
809
809
  */
810
810
  videoCount?: number;
811
811
  /**
@@ -1904,7 +1904,7 @@ type DiscordPlatformData = {
1904
1904
  };
1905
1905
  footer?: {
1906
1906
  /**
1907
- * Footer text (max 2
1907
+ * Footer text (max 2,048 chars)
1908
1908
  */
1909
1909
  text?: string;
1910
1910
  icon_url?: string;
@@ -1926,7 +1926,7 @@ type DiscordPlatformData = {
1926
1926
  */
1927
1927
  name: string;
1928
1928
  /**
1929
- * Field value (max 1
1929
+ * Field value (max 1,024 chars)
1930
1930
  */
1931
1931
  value: string;
1932
1932
  /**
@@ -3366,7 +3366,7 @@ type RedditPost = {
3366
3366
  author?: string;
3367
3367
  subreddit?: string;
3368
3368
  /**
3369
- * Post URL (may be a gallery URL
3369
+ * Post URL (may be a gallery URL, external link, or self-post URL)
3370
3370
  */
3371
3371
  url?: string;
3372
3372
  /**
@@ -3456,7 +3456,7 @@ type SharedAdAccount = {
3456
3456
  id: string;
3457
3457
  name?: string;
3458
3458
  /**
3459
- * Business Manager id that owns the ad account
3459
+ * Business Manager id that owns the ad account, when reported.
3460
3460
  */
3461
3461
  businessId?: string;
3462
3462
  };
@@ -4814,7 +4814,7 @@ type WebhookPayloadConversationStarted = {
4814
4814
  platform: 'instagram' | 'facebook' | 'telegram' | 'whatsapp' | 'twitter' | 'reddit' | 'bluesky';
4815
4815
  platformConversationId: string;
4816
4816
  /**
4817
- * Contact's platform identifier (IGSID
4817
+ * Contact's platform identifier (IGSID, PSID, wa_id, etc.)
4818
4818
  */
4819
4819
  participantId?: string;
4820
4820
  participantName: string;
@@ -8799,7 +8799,7 @@ type ConfigureTikTokAdsBrandIdentityData = {
8799
8799
  type ConfigureTikTokAdsBrandIdentityResponse = ({
8800
8800
  success?: boolean;
8801
8801
  /**
8802
- * The TikTok-assigned identity_id
8802
+ * The TikTok-assigned identity_id, cached on the account.
8803
8803
  */
8804
8804
  identityId?: string;
8805
8805
  displayName?: string;
@@ -9114,7 +9114,7 @@ type GetGoogleBusinessVerificationsResponse = ({
9114
9114
  */
9115
9115
  voiceOfMerchantState?: {
9116
9116
  /**
9117
- * True when the listing is verified and published (eligible to surface reviews
9117
+ * True when the listing is verified and published (eligible to surface reviews, edits, etc.).
9118
9118
  */
9119
9119
  hasVoiceOfMerchant?: boolean;
9120
9120
  /**
@@ -10080,7 +10080,7 @@ type BatchGetGoogleBusinessReviewsResponse = ({
10080
10080
  */
10081
10081
  name?: string;
10082
10082
  /**
10083
- * The review object (reviewId
10083
+ * The review object (reviewId, starRating, comment, reviewer, createTime, updateTime, reviewReply)
10084
10084
  */
10085
10085
  review?: {
10086
10086
  [key: string]: unknown;
@@ -12740,7 +12740,7 @@ type GetInboxConversationMessagesResponse = ({
12740
12740
  reactions?: Array<{
12741
12741
  emoji?: string;
12742
12742
  /**
12743
- * true if the connected account reacted
12743
+ * true if the connected account reacted, false if the contact did.
12744
12744
  */
12745
12745
  fromMe?: boolean;
12746
12746
  reactedAt?: string;
@@ -13083,7 +13083,7 @@ type SendInboxMessageData = {
13083
13083
  */
13084
13084
  text?: string;
13085
13085
  /**
13086
- * Callback data (inline_keyboard only
13086
+ * Callback data (inline_keyboard only, max 64 bytes)
13087
13087
  */
13088
13088
  callbackData?: string;
13089
13089
  /**
@@ -13657,11 +13657,11 @@ type GetInboxPostCommentsResponse = ({
13657
13657
  canReply?: boolean;
13658
13658
  canDelete?: boolean;
13659
13659
  /**
13660
- * Whether this comment can be hidden (Facebook
13660
+ * Whether this comment can be hidden (Facebook, Instagram, Threads)
13661
13661
  */
13662
13662
  canHide?: boolean;
13663
13663
  /**
13664
- * Whether this comment can be liked (Facebook
13664
+ * Whether this comment can be liked (Facebook, Twitter/X, Bluesky, Reddit)
13665
13665
  */
13666
13666
  canLike?: boolean;
13667
13667
  /**
@@ -13715,11 +13715,11 @@ type GetInboxPostCommentsResponse = ({
13715
13715
  */
13716
13716
  selftext?: string;
13717
13717
  /**
13718
- * Reddit username
13718
+ * Reddit username, without the u/ prefix
13719
13719
  */
13720
13720
  author?: string;
13721
13721
  /**
13722
- * Subreddit name
13722
+ * Subreddit name, without the r/ prefix
13723
13723
  */
13724
13724
  subreddit?: string;
13725
13725
  /**
@@ -13727,7 +13727,7 @@ type GetInboxPostCommentsResponse = ({
13727
13727
  */
13728
13728
  permalink?: string;
13729
13729
  /**
13730
- * For link posts
13730
+ * For link posts, the external URL; for self-posts, the Reddit permalink
13731
13731
  */
13732
13732
  url?: string;
13733
13733
  /**
@@ -14486,7 +14486,7 @@ type EnableWhatsAppCallingData = {
14486
14486
  forwardTo: string;
14487
14487
  sipAuthUsername?: string;
14488
14488
  /**
14489
- * Stored encrypted
14489
+ * Stored encrypted, never returned by any endpoint.
14490
14490
  */
14491
14491
  sipAuthPassword?: string;
14492
14492
  recordingEnabled?: boolean;
@@ -14541,7 +14541,7 @@ type GetWhatsAppCallPermissionsData = {
14541
14541
  query: {
14542
14542
  accountId: string;
14543
14543
  /**
14544
- * Consumer wa_id (E.164
14544
+ * Consumer wa_id (E.164, leading + optional)
14545
14545
  */
14546
14546
  to: string;
14547
14547
  };
@@ -14566,7 +14566,7 @@ type InitiateWhatsAppCallData = {
14566
14566
  body: {
14567
14567
  accountId: string;
14568
14568
  /**
14569
- * Consumer wa_id (E.164
14569
+ * Consumer wa_id (E.164, leading + optional)
14570
14570
  */
14571
14571
  to: string;
14572
14572
  /**
@@ -15130,7 +15130,7 @@ type GetWhatsAppPhoneNumbersResponse = ({
15130
15130
  country?: string;
15131
15131
  status?: 'pending_payment' | 'pending_regulatory' | 'regulatory_declined' | 'provisioning' | 'verifying' | 'active' | 'suspended' | 'releasing' | 'released';
15132
15132
  /**
15133
- * For regulated numbers
15133
+ * For regulated numbers, who it's registered for (company or person) — set from the submitted KYC.
15134
15134
  */
15135
15135
  registrantName?: (string) | null;
15136
15136
  /**
@@ -15472,7 +15472,7 @@ type ValidateWhatsAppNumberKycAddressData = {
15472
15472
  */
15473
15473
  locality: string;
15474
15474
  /**
15475
- * State / province / region. When omitted
15475
+ * State / province / region. When omitted, the pre-check is skipped (the final submit still validates).
15476
15476
  */
15477
15477
  administrative_area?: string;
15478
15478
  postal_code: string;
@@ -17318,7 +17318,7 @@ type TriggerWorkflowData = {
17318
17318
  */
17319
17319
  conversationId?: string;
17320
17320
  /**
17321
- * Simulated inbound text
17321
+ * Simulated inbound text, seeded as the run's lastMessage variable
17322
17322
  */
17323
17323
  text?: string;
17324
17324
  };
@@ -17415,7 +17415,7 @@ type ListWorkflowVersionsResponse = ({
17415
17415
  */
17416
17416
  createdByEmail?: (string) | null;
17417
17417
  /**
17418
- * When non-null
17418
+ * When non-null, this snapshot was created by restoring that version
17419
17419
  */
17420
17420
  restoredFromVersion?: (number) | null;
17421
17421
  createdAt?: string;
@@ -18436,7 +18436,11 @@ type GetAdTreeData = {
18436
18436
  */
18437
18437
  adAccountId?: string;
18438
18438
  /**
18439
- * Start of metrics date range (YYYY-MM-DD). Defaults to 90 days ago.
18439
+ * Restrict the tree to a single campaign by its platform campaign id (the id the platform assigns, e.g. Meta's numeric campaign id). Filters the campaign set itself, so it works regardless of account size and pagination — pass this when you already hold a campaign id instead of paging the tree to find it. Mirrors the `campaignId` filter on GET /v1/ads.
18440
+ */
18441
+ campaignId?: string;
18442
+ /**
18443
+ * Start of the METRICS date range (YYYY-MM-DD). Affects only the spend/impression numbers overlaid on each node, NOT which campaigns are returned. Defaults to 90 days ago.
18440
18444
  */
18441
18445
  fromDate?: string;
18442
18446
  /**
@@ -20300,7 +20304,7 @@ type GetConversionsQualityError = ({
20300
20304
  type SendConversionsData = {
20301
20305
  body: {
20302
20306
  /**
20303
- * SocialAccount ID (metaads, googleads, or linkedinads).
20307
+ * SocialAccount ID (metaads, googleads, linkedinads, or tiktokads).
20304
20308
  */
20305
20309
  accountId: string;
20306
20310
  /**
@@ -20329,7 +20333,7 @@ type SendConversionsData = {
20329
20333
  };
20330
20334
  };
20331
20335
  type SendConversionsResponse = ({
20332
- platform?: 'metaads' | 'googleads' | 'linkedinads';
20336
+ platform?: 'metaads' | 'googleads' | 'linkedinads' | 'tiktokads';
20333
20337
  /**
20334
20338
  * Events accepted by the platform.
20335
20339
  */
@@ -20437,13 +20441,13 @@ type AdjustConversionsError = (unknown | {
20437
20441
  type ListConversionDestinationsData = {
20438
20442
  path: {
20439
20443
  /**
20440
- * SocialAccount ID (metaads, googleads, or linkedinads).
20444
+ * SocialAccount ID (metaads, googleads, linkedinads, or tiktokads).
20441
20445
  */
20442
20446
  accountId: string;
20443
20447
  };
20444
20448
  };
20445
20449
  type ListConversionDestinationsResponse = ({
20446
- platform?: 'metaads' | 'googleads' | 'linkedinads';
20450
+ platform?: 'metaads' | 'googleads' | 'linkedinads' | 'tiktokads';
20447
20451
  destinations?: Array<{
20448
20452
  /**
20449
20453
  * Destination identifier. Meta: pixel ID. Google:
package/dist/index.js CHANGED
@@ -36,7 +36,7 @@ module.exports = __toCommonJS(index_exports);
36
36
  // package.json
37
37
  var package_default = {
38
38
  name: "@getlatedev/node",
39
- version: "0.2.261",
39
+ version: "0.2.263",
40
40
  description: "The official Node.js library for the Zernio API",
41
41
  main: "dist/index.js",
42
42
  module: "dist/index.mjs",
package/dist/index.mjs CHANGED
@@ -5,7 +5,7 @@ var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "sy
5
5
  // package.json
6
6
  var package_default = {
7
7
  name: "@getlatedev/node",
8
- version: "0.2.261",
8
+ version: "0.2.263",
9
9
  description: "The official Node.js library for the Zernio API",
10
10
  main: "dist/index.js",
11
11
  module: "dist/index.mjs",
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@getlatedev/node",
3
- "version": "0.2.261",
3
+ "version": "0.2.263",
4
4
  "description": "The official Node.js library for the Zernio API",
5
5
  "main": "dist/index.js",
6
6
  "module": "dist/index.mjs",
@@ -5221,12 +5221,18 @@ export const getConversionsQuality = <ThrowOnError extends boolean = false>(opti
5221
5221
  * - Meta (`metaads`) via Graph API
5222
5222
  * - Google Ads (`googleads`) via Data Manager API `ingestEvents`
5223
5223
  * - LinkedIn (`linkedinads`) via `/rest/conversionEvents`
5224
+ * - TikTok (`tiktokads`) via the Offline Events API `/offline/batch/` — OFFLINE conversions only
5224
5225
  *
5225
5226
  * `destinationId` semantics differ per platform:
5226
5227
  *
5227
5228
  * - Meta: pixel (dataset) ID, e.g. `123456789012345`
5228
5229
  * - Google: conversion action resource name, e.g. `customers/1234567890/conversionActions/987654321`
5229
5230
  * - LinkedIn: conversion rule ID or URN, e.g. `104012` or `urn:lla:llaPartnerConversion:104012`
5231
+ * - TikTok: Offline Event Set ID, e.g. `7057103914977558530`
5232
+ *
5233
+ * TikTok notes: this path sends OFFLINE conversions (in-store / CRM / call-center), not web-pixel
5234
+ * events. Each event must carry an email or phone (TikTok requires at least one). The connected
5235
+ * TikTok ads account must have granted the Offline Events permission; older grants must reconnect.
5230
5236
  *
5231
5237
  * Callers can list valid destinations via `GET /v1/accounts/{accountId}/conversion-destinations`.
5232
5238
  *
@@ -45,7 +45,7 @@ export type AccountWithFollowerStats = SocialAccount & {
45
45
  */
46
46
  mediaCount?: number;
47
47
  /**
48
- * Total videos (YouTube
48
+ * Total videos (YouTube, TikTok)
49
49
  */
50
50
  videoCount?: number;
51
51
  /**
@@ -1179,7 +1179,7 @@ export type DiscordPlatformData = {
1179
1179
  };
1180
1180
  footer?: {
1181
1181
  /**
1182
- * Footer text (max 2
1182
+ * Footer text (max 2,048 chars)
1183
1183
  */
1184
1184
  text?: string;
1185
1185
  icon_url?: string;
@@ -1201,7 +1201,7 @@ export type DiscordPlatformData = {
1201
1201
  */
1202
1202
  name: string;
1203
1203
  /**
1204
- * Field value (max 1
1204
+ * Field value (max 1,024 chars)
1205
1205
  */
1206
1206
  value: string;
1207
1207
  /**
@@ -2729,7 +2729,7 @@ export type RedditPost = {
2729
2729
  author?: string;
2730
2730
  subreddit?: string;
2731
2731
  /**
2732
- * Post URL (may be a gallery URL
2732
+ * Post URL (may be a gallery URL, external link, or self-post URL)
2733
2733
  */
2734
2734
  url?: string;
2735
2735
  /**
@@ -2822,7 +2822,7 @@ export type SharedAdAccount = {
2822
2822
  id: string;
2823
2823
  name?: string;
2824
2824
  /**
2825
- * Business Manager id that owns the ad account
2825
+ * Business Manager id that owns the ad account, when reported.
2826
2826
  */
2827
2827
  businessId?: string;
2828
2828
  };
@@ -4239,7 +4239,7 @@ export type WebhookPayloadConversationStarted = {
4239
4239
  platform: 'instagram' | 'facebook' | 'telegram' | 'whatsapp' | 'twitter' | 'reddit' | 'bluesky';
4240
4240
  platformConversationId: string;
4241
4241
  /**
4242
- * Contact's platform identifier (IGSID
4242
+ * Contact's platform identifier (IGSID, PSID, wa_id, etc.)
4243
4243
  */
4244
4244
  participantId?: string;
4245
4245
  participantName: string;
@@ -8491,7 +8491,7 @@ export type ConfigureTikTokAdsBrandIdentityData = {
8491
8491
  export type ConfigureTikTokAdsBrandIdentityResponse = ({
8492
8492
  success?: boolean;
8493
8493
  /**
8494
- * The TikTok-assigned identity_id
8494
+ * The TikTok-assigned identity_id, cached on the account.
8495
8495
  */
8496
8496
  identityId?: string;
8497
8497
  displayName?: string;
@@ -8824,7 +8824,7 @@ export type GetGoogleBusinessVerificationsResponse = ({
8824
8824
  */
8825
8825
  voiceOfMerchantState?: {
8826
8826
  /**
8827
- * True when the listing is verified and published (eligible to surface reviews
8827
+ * True when the listing is verified and published (eligible to surface reviews, edits, etc.).
8828
8828
  */
8829
8829
  hasVoiceOfMerchant?: boolean;
8830
8830
  /**
@@ -9850,7 +9850,7 @@ export type BatchGetGoogleBusinessReviewsResponse = ({
9850
9850
  */
9851
9851
  name?: string;
9852
9852
  /**
9853
- * The review object (reviewId
9853
+ * The review object (reviewId, starRating, comment, reviewer, createTime, updateTime, reviewReply)
9854
9854
  */
9855
9855
  review?: {
9856
9856
  [key: string]: unknown;
@@ -12716,7 +12716,7 @@ export type GetInboxConversationMessagesResponse = ({
12716
12716
  reactions?: Array<{
12717
12717
  emoji?: string;
12718
12718
  /**
12719
- * true if the connected account reacted
12719
+ * true if the connected account reacted, false if the contact did.
12720
12720
  */
12721
12721
  fromMe?: boolean;
12722
12722
  reactedAt?: string;
@@ -13061,7 +13061,7 @@ export type SendInboxMessageData = {
13061
13061
  */
13062
13062
  text?: string;
13063
13063
  /**
13064
- * Callback data (inline_keyboard only
13064
+ * Callback data (inline_keyboard only, max 64 bytes)
13065
13065
  */
13066
13066
  callbackData?: string;
13067
13067
  /**
@@ -13690,11 +13690,11 @@ export type GetInboxPostCommentsResponse = ({
13690
13690
  canReply?: boolean;
13691
13691
  canDelete?: boolean;
13692
13692
  /**
13693
- * Whether this comment can be hidden (Facebook
13693
+ * Whether this comment can be hidden (Facebook, Instagram, Threads)
13694
13694
  */
13695
13695
  canHide?: boolean;
13696
13696
  /**
13697
- * Whether this comment can be liked (Facebook
13697
+ * Whether this comment can be liked (Facebook, Twitter/X, Bluesky, Reddit)
13698
13698
  */
13699
13699
  canLike?: boolean;
13700
13700
  /**
@@ -13748,11 +13748,11 @@ export type GetInboxPostCommentsResponse = ({
13748
13748
  */
13749
13749
  selftext?: string;
13750
13750
  /**
13751
- * Reddit username
13751
+ * Reddit username, without the u/ prefix
13752
13752
  */
13753
13753
  author?: string;
13754
13754
  /**
13755
- * Subreddit name
13755
+ * Subreddit name, without the r/ prefix
13756
13756
  */
13757
13757
  subreddit?: string;
13758
13758
  /**
@@ -13760,7 +13760,7 @@ export type GetInboxPostCommentsResponse = ({
13760
13760
  */
13761
13761
  permalink?: string;
13762
13762
  /**
13763
- * For link posts
13763
+ * For link posts, the external URL; for self-posts, the Reddit permalink
13764
13764
  */
13765
13765
  url?: string;
13766
13766
  /**
@@ -14587,7 +14587,7 @@ export type EnableWhatsAppCallingData = {
14587
14587
  forwardTo: string;
14588
14588
  sipAuthUsername?: string;
14589
14589
  /**
14590
- * Stored encrypted
14590
+ * Stored encrypted, never returned by any endpoint.
14591
14591
  */
14592
14592
  sipAuthPassword?: string;
14593
14593
  recordingEnabled?: boolean;
@@ -14651,7 +14651,7 @@ export type GetWhatsAppCallPermissionsData = {
14651
14651
  query: {
14652
14652
  accountId: string;
14653
14653
  /**
14654
- * Consumer wa_id (E.164
14654
+ * Consumer wa_id (E.164, leading + optional)
14655
14655
  */
14656
14656
  to: string;
14657
14657
  };
@@ -14679,7 +14679,7 @@ export type InitiateWhatsAppCallData = {
14679
14679
  body: {
14680
14680
  accountId: string;
14681
14681
  /**
14682
- * Consumer wa_id (E.164
14682
+ * Consumer wa_id (E.164, leading + optional)
14683
14683
  */
14684
14684
  to: string;
14685
14685
  /**
@@ -15295,7 +15295,7 @@ export type GetWhatsAppPhoneNumbersResponse = ({
15295
15295
  country?: string;
15296
15296
  status?: 'pending_payment' | 'pending_regulatory' | 'regulatory_declined' | 'provisioning' | 'verifying' | 'active' | 'suspended' | 'releasing' | 'released';
15297
15297
  /**
15298
- * For regulated numbers
15298
+ * For regulated numbers, who it's registered for (company or person) — set from the submitted KYC.
15299
15299
  */
15300
15300
  registrantName?: (string) | null;
15301
15301
  /**
@@ -15659,7 +15659,7 @@ export type ValidateWhatsAppNumberKycAddressData = {
15659
15659
  */
15660
15660
  locality: string;
15661
15661
  /**
15662
- * State / province / region. When omitted
15662
+ * State / province / region. When omitted, the pre-check is skipped (the final submit still validates).
15663
15663
  */
15664
15664
  administrative_area?: string;
15665
15665
  postal_code: string;
@@ -17693,7 +17693,7 @@ export type TriggerWorkflowData = {
17693
17693
  */
17694
17694
  conversationId?: string;
17695
17695
  /**
17696
- * Simulated inbound text
17696
+ * Simulated inbound text, seeded as the run's lastMessage variable
17697
17697
  */
17698
17698
  text?: string;
17699
17699
  };
@@ -17800,7 +17800,7 @@ export type ListWorkflowVersionsResponse = ({
17800
17800
  */
17801
17801
  createdByEmail?: (string) | null;
17802
17802
  /**
17803
- * When non-null
17803
+ * When non-null, this snapshot was created by restoring that version
17804
17804
  */
17805
17805
  restoredFromVersion?: (number) | null;
17806
17806
  createdAt?: string;
@@ -18904,7 +18904,11 @@ export type GetAdTreeData = {
18904
18904
  */
18905
18905
  adAccountId?: string;
18906
18906
  /**
18907
- * Start of metrics date range (YYYY-MM-DD). Defaults to 90 days ago.
18907
+ * Restrict the tree to a single campaign by its platform campaign id (the id the platform assigns, e.g. Meta's numeric campaign id). Filters the campaign set itself, so it works regardless of account size and pagination — pass this when you already hold a campaign id instead of paging the tree to find it. Mirrors the `campaignId` filter on GET /v1/ads.
18908
+ */
18909
+ campaignId?: string;
18910
+ /**
18911
+ * Start of the METRICS date range (YYYY-MM-DD). Affects only the spend/impression numbers overlaid on each node, NOT which campaigns are returned. Defaults to 90 days ago.
18908
18912
  */
18909
18913
  fromDate?: string;
18910
18914
  /**
@@ -20861,7 +20865,7 @@ export type GetConversionsQualityError = ({
20861
20865
  export type SendConversionsData = {
20862
20866
  body: {
20863
20867
  /**
20864
- * SocialAccount ID (metaads, googleads, or linkedinads).
20868
+ * SocialAccount ID (metaads, googleads, linkedinads, or tiktokads).
20865
20869
  */
20866
20870
  accountId: string;
20867
20871
  /**
@@ -20891,7 +20895,7 @@ export type SendConversionsData = {
20891
20895
  };
20892
20896
 
20893
20897
  export type SendConversionsResponse = ({
20894
- platform?: 'metaads' | 'googleads' | 'linkedinads';
20898
+ platform?: 'metaads' | 'googleads' | 'linkedinads' | 'tiktokads';
20895
20899
  /**
20896
20900
  * Events accepted by the platform.
20897
20901
  */
@@ -21004,14 +21008,14 @@ export type AdjustConversionsError = (unknown | {
21004
21008
  export type ListConversionDestinationsData = {
21005
21009
  path: {
21006
21010
  /**
21007
- * SocialAccount ID (metaads, googleads, or linkedinads).
21011
+ * SocialAccount ID (metaads, googleads, linkedinads, or tiktokads).
21008
21012
  */
21009
21013
  accountId: string;
21010
21014
  };
21011
21015
  };
21012
21016
 
21013
21017
  export type ListConversionDestinationsResponse = ({
21014
- platform?: 'metaads' | 'googleads' | 'linkedinads';
21018
+ platform?: 'metaads' | 'googleads' | 'linkedinads' | 'tiktokads';
21015
21019
  destinations?: Array<{
21016
21020
  /**
21017
21021
  * Destination identifier. Meta: pixel ID. Google: