@zernio/node 0.2.824 → 0.2.826

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
@@ -6316,7 +6316,13 @@ type InboxWebhookAccount = {
6316
6316
  * The conversation context included in inbox webhook payloads.
6317
6317
  */
6318
6318
  type InboxWebhookConversation = {
6319
+ /**
6320
+ * Zernio's internal conversation id (also the message's conversationId). Accepted by every /v1/inbox/conversations/{conversationId} endpoint.
6321
+ */
6319
6322
  id: string;
6323
+ /**
6324
+ * The platform's conversation id. This is the `id` GET /v1/inbox/conversations returns for the same conversation (on Instagram and Messenger it is the participant's IGSID / PSID), so key your records on it to match webhooks with list rows. Also accepted by the conversation endpoints.
6325
+ */
6320
6326
  platformConversationId: string;
6321
6327
  participantId?: string;
6322
6328
  participantName?: string;
@@ -6340,10 +6346,13 @@ type status11 = 'active' | 'archived';
6340
6346
  */
6341
6347
  type InboxWebhookConversationDetail = {
6342
6348
  /**
6343
- * Internal conversation ID
6349
+ * 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.
6344
6350
  */
6345
6351
  id: string;
6346
6352
  platform: 'instagram' | 'facebook' | 'telegram' | 'whatsapp' | 'twitter' | 'reddit' | 'bluesky' | 'sms' | 'slack' | 'tiktok';
6353
+ /**
6354
+ * Same value as `id`.
6355
+ */
6347
6356
  platformConversationId: string;
6348
6357
  /**
6349
6358
  * Contact's platform identifier (IGSID, PSID, wa_id, etc.)
@@ -38242,7 +38251,10 @@ type BoostPostData = {
38242
38251
  */
38243
38252
  status?: 'ACTIVE' | 'PAUSED';
38244
38253
  /**
38245
- * Meta only. Explicit ad-set `optimization_goal` override. When omitted,
38254
+ * Meta, or TikTok with `goal: video_views`. TikTok: ENGAGED_VIEW (6-second
38255
+ * Focused View, the default) or ENGAGED_VIEW_FIFTEEN (15-second views), both
38256
+ * billed per view (CPV); any other value is a 400. Meta: explicit ad-set
38257
+ * `optimization_goal` override. When omitted,
38246
38258
  * defaults to the value derived from `goal`. Messaging boosts always
38247
38259
  * use CONVERSATIONS and reject another optimizationGoal. Otherwise the value must be compatible
38248
38260
  * with the objective Meta derives from `goal`, not with the objective used
@@ -38329,7 +38341,7 @@ type CreateStandaloneAdData = {
38329
38341
  */
38330
38342
  goal?: 'engagement' | 'traffic' | 'awareness' | 'video_views' | 'lead_generation' | 'lead_conversion' | 'conversions' | 'app_promotion' | 'catalog_sales' | 'page_likes' | 'job_applicants';
38331
38343
  /**
38332
- * Meta only. Explicit ad-set `optimization_goal` (e.g. `LANDING_PAGE_VIEWS`, `LINK_CLICKS`, `REACH`, `IMPRESSIONS`, `OFFSITE_CONVERSIONS`, `THRUPLAY`, `LEAD_GENERATION`). Overrides the default derived from `goal` (e.g. `traffic` defaults to `LINK_CLICKS`). Forwarded verbatim to Meta, which validates compatibility with the campaign objective and rejects incompatible combinations.
38344
+ * Meta, or TikTok with goal video_views (ENGAGED_VIEW, the 6-second default, or ENGAGED_VIEW_FIFTEEN; both bill per view). Meta: Explicit ad-set `optimization_goal` (e.g. `LANDING_PAGE_VIEWS`, `LINK_CLICKS`, `REACH`, `IMPRESSIONS`, `OFFSITE_CONVERSIONS`, `THRUPLAY`, `LEAD_GENERATION`). Overrides the default derived from `goal` (e.g. `traffic` defaults to `LINK_CLICKS`). Forwarded verbatim to Meta, which validates compatibility with the campaign objective and rejects incompatible combinations.
38333
38345
  */
38334
38346
  optimizationGoal?: string;
38335
38347
  /**
package/dist/index.d.ts CHANGED
@@ -6316,7 +6316,13 @@ type InboxWebhookAccount = {
6316
6316
  * The conversation context included in inbox webhook payloads.
6317
6317
  */
6318
6318
  type InboxWebhookConversation = {
6319
+ /**
6320
+ * Zernio's internal conversation id (also the message's conversationId). Accepted by every /v1/inbox/conversations/{conversationId} endpoint.
6321
+ */
6319
6322
  id: string;
6323
+ /**
6324
+ * The platform's conversation id. This is the `id` GET /v1/inbox/conversations returns for the same conversation (on Instagram and Messenger it is the participant's IGSID / PSID), so key your records on it to match webhooks with list rows. Also accepted by the conversation endpoints.
6325
+ */
6320
6326
  platformConversationId: string;
6321
6327
  participantId?: string;
6322
6328
  participantName?: string;
@@ -6340,10 +6346,13 @@ type status11 = 'active' | 'archived';
6340
6346
  */
6341
6347
  type InboxWebhookConversationDetail = {
6342
6348
  /**
6343
- * Internal conversation ID
6349
+ * 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.
6344
6350
  */
6345
6351
  id: string;
6346
6352
  platform: 'instagram' | 'facebook' | 'telegram' | 'whatsapp' | 'twitter' | 'reddit' | 'bluesky' | 'sms' | 'slack' | 'tiktok';
6353
+ /**
6354
+ * Same value as `id`.
6355
+ */
6347
6356
  platformConversationId: string;
6348
6357
  /**
6349
6358
  * Contact's platform identifier (IGSID, PSID, wa_id, etc.)
@@ -38242,7 +38251,10 @@ type BoostPostData = {
38242
38251
  */
38243
38252
  status?: 'ACTIVE' | 'PAUSED';
38244
38253
  /**
38245
- * Meta only. Explicit ad-set `optimization_goal` override. When omitted,
38254
+ * Meta, or TikTok with `goal: video_views`. TikTok: ENGAGED_VIEW (6-second
38255
+ * Focused View, the default) or ENGAGED_VIEW_FIFTEEN (15-second views), both
38256
+ * billed per view (CPV); any other value is a 400. Meta: explicit ad-set
38257
+ * `optimization_goal` override. When omitted,
38246
38258
  * defaults to the value derived from `goal`. Messaging boosts always
38247
38259
  * use CONVERSATIONS and reject another optimizationGoal. Otherwise the value must be compatible
38248
38260
  * with the objective Meta derives from `goal`, not with the objective used
@@ -38329,7 +38341,7 @@ type CreateStandaloneAdData = {
38329
38341
  */
38330
38342
  goal?: 'engagement' | 'traffic' | 'awareness' | 'video_views' | 'lead_generation' | 'lead_conversion' | 'conversions' | 'app_promotion' | 'catalog_sales' | 'page_likes' | 'job_applicants';
38331
38343
  /**
38332
- * Meta only. Explicit ad-set `optimization_goal` (e.g. `LANDING_PAGE_VIEWS`, `LINK_CLICKS`, `REACH`, `IMPRESSIONS`, `OFFSITE_CONVERSIONS`, `THRUPLAY`, `LEAD_GENERATION`). Overrides the default derived from `goal` (e.g. `traffic` defaults to `LINK_CLICKS`). Forwarded verbatim to Meta, which validates compatibility with the campaign objective and rejects incompatible combinations.
38344
+ * Meta, or TikTok with goal video_views (ENGAGED_VIEW, the 6-second default, or ENGAGED_VIEW_FIFTEEN; both bill per view). Meta: Explicit ad-set `optimization_goal` (e.g. `LANDING_PAGE_VIEWS`, `LINK_CLICKS`, `REACH`, `IMPRESSIONS`, `OFFSITE_CONVERSIONS`, `THRUPLAY`, `LEAD_GENERATION`). Overrides the default derived from `goal` (e.g. `traffic` defaults to `LINK_CLICKS`). Forwarded verbatim to Meta, which validates compatibility with the campaign objective and rejects incompatible combinations.
38333
38345
  */
38334
38346
  optimizationGoal?: string;
38335
38347
  /**
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: "@zernio/node",
39
- version: "0.2.824",
39
+ version: "0.2.826",
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: "@zernio/node",
8
- version: "0.2.824",
8
+ version: "0.2.826",
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": "@zernio/node",
3
- "version": "0.2.824",
3
+ "version": "0.2.826",
4
4
  "description": "The official Node.js library for the Zernio API",
5
5
  "main": "dist/index.js",
6
6
  "module": "dist/index.mjs",
@@ -4847,7 +4847,13 @@ export type InboxWebhookAccount = {
4847
4847
  * The conversation context included in inbox webhook payloads.
4848
4848
  */
4849
4849
  export type InboxWebhookConversation = {
4850
+ /**
4851
+ * Zernio's internal conversation id (also the message's conversationId). Accepted by every /v1/inbox/conversations/{conversationId} endpoint.
4852
+ */
4850
4853
  id: string;
4854
+ /**
4855
+ * The platform's conversation id. This is the `id` GET /v1/inbox/conversations returns for the same conversation (on Instagram and Messenger it is the participant's IGSID / PSID), so key your records on it to match webhooks with list rows. Also accepted by the conversation endpoints.
4856
+ */
4851
4857
  platformConversationId: string;
4852
4858
  participantId?: string;
4853
4859
  participantName?: string;
@@ -4873,10 +4879,13 @@ export type status11 = 'active' | 'archived';
4873
4879
  */
4874
4880
  export type InboxWebhookConversationDetail = {
4875
4881
  /**
4876
- * Internal conversation ID
4882
+ * 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.
4877
4883
  */
4878
4884
  id: string;
4879
4885
  platform: 'instagram' | 'facebook' | 'telegram' | 'whatsapp' | 'twitter' | 'reddit' | 'bluesky' | 'sms' | 'slack' | 'tiktok';
4886
+ /**
4887
+ * Same value as `id`.
4888
+ */
4880
4889
  platformConversationId: string;
4881
4890
  /**
4882
4891
  * Contact's platform identifier (IGSID, PSID, wa_id, etc.)
@@ -38852,7 +38861,10 @@ export type BoostPostData = {
38852
38861
  */
38853
38862
  status?: 'ACTIVE' | 'PAUSED';
38854
38863
  /**
38855
- * Meta only. Explicit ad-set `optimization_goal` override. When omitted,
38864
+ * Meta, or TikTok with `goal: video_views`. TikTok: ENGAGED_VIEW (6-second
38865
+ * Focused View, the default) or ENGAGED_VIEW_FIFTEEN (15-second views), both
38866
+ * billed per view (CPV); any other value is a 400. Meta: explicit ad-set
38867
+ * `optimization_goal` override. When omitted,
38856
38868
  * defaults to the value derived from `goal`. Messaging boosts always
38857
38869
  * use CONVERSATIONS and reject another optimizationGoal. Otherwise the value must be compatible
38858
38870
  * with the objective Meta derives from `goal`, not with the objective used
@@ -38945,7 +38957,7 @@ export type CreateStandaloneAdData = {
38945
38957
  */
38946
38958
  goal?: 'engagement' | 'traffic' | 'awareness' | 'video_views' | 'lead_generation' | 'lead_conversion' | 'conversions' | 'app_promotion' | 'catalog_sales' | 'page_likes' | 'job_applicants';
38947
38959
  /**
38948
- * Meta only. Explicit ad-set `optimization_goal` (e.g. `LANDING_PAGE_VIEWS`, `LINK_CLICKS`, `REACH`, `IMPRESSIONS`, `OFFSITE_CONVERSIONS`, `THRUPLAY`, `LEAD_GENERATION`). Overrides the default derived from `goal` (e.g. `traffic` defaults to `LINK_CLICKS`). Forwarded verbatim to Meta, which validates compatibility with the campaign objective and rejects incompatible combinations.
38960
+ * Meta, or TikTok with goal video_views (ENGAGED_VIEW, the 6-second default, or ENGAGED_VIEW_FIFTEEN; both bill per view). Meta: Explicit ad-set `optimization_goal` (e.g. `LANDING_PAGE_VIEWS`, `LINK_CLICKS`, `REACH`, `IMPRESSIONS`, `OFFSITE_CONVERSIONS`, `THRUPLAY`, `LEAD_GENERATION`). Overrides the default derived from `goal` (e.g. `traffic` defaults to `LINK_CLICKS`). Forwarded verbatim to Meta, which validates compatibility with the campaign objective and rejects incompatible combinations.
38949
38961
  */
38950
38962
  optimizationGoal?: string;
38951
38963
  /**