@zernio/node 0.2.86 → 0.2.87

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
@@ -2687,7 +2687,7 @@ type ReviewWebhookReview = {
2687
2687
  */
2688
2688
  hasReply: boolean;
2689
2689
  /**
2690
- * Present when `hasReply` is true.
2690
+ * Present when hasReply is true.
2691
2691
  */
2692
2692
  reply?: {
2693
2693
  text: string;
@@ -3158,8 +3158,8 @@ type WebhookPayloadComment = {
3158
3158
  parentCommentId: (string) | null;
3159
3159
  /**
3160
3160
  * Ad context. Present only when the comment was made on paid content.
3161
- * Instagram: populated from the webhook payload's `value.media.ad_id`/`ad_title`.
3162
- * Facebook: populated via a Graph API lookup of the parent post's `promotion_status`.
3161
+ * Instagram: populated from the webhook payload's value.media.ad_id and value.media.ad_title.
3162
+ * Facebook: populated via a Graph API lookup of the parent post's promotion_status.
3163
3163
  * Absent for comments on organic posts that are not currently promoted.
3164
3164
  *
3165
3165
  */
@@ -3175,7 +3175,7 @@ type WebhookPayloadComment = {
3175
3175
  /**
3176
3176
  * Facebook promotion status returned by Graph API. Common values:
3177
3177
  * "active" (organic post currently boosted), "ineligible" (dark
3178
- * post / ad creative not promotable because it already is an ad).
3178
+ * post or ad creative, not promotable because it already is an ad).
3179
3179
  *
3180
3180
  */
3181
3181
  promotionStatus?: string;
@@ -3598,7 +3598,7 @@ type WebhookPayloadPost = {
3598
3598
  };
3599
3599
  type event9 = 'post.scheduled' | 'post.published' | 'post.failed' | 'post.partial' | 'post.cancelled' | 'post.recycled';
3600
3600
  /**
3601
- * Webhook payload for the `review.new` event (new review posted on a connected account).
3601
+ * Webhook payload for the review.new event (new review posted on a connected account).
3602
3602
  */
3603
3603
  type WebhookPayloadReviewNew = {
3604
3604
  /**
@@ -3616,10 +3616,10 @@ type WebhookPayloadReviewNew = {
3616
3616
  };
3617
3617
  type event10 = 'review.new';
3618
3618
  /**
3619
- * Webhook payload for the `review.updated` event. Fired when the reviewer edits
3619
+ * Webhook payload for the review.updated event. Fired when the reviewer edits
3620
3620
  * their text or rating, or when a reply is added (via the API or directly on the
3621
- * platform). Same shape as `review.new`; when a reply is present `review.hasReply`
3622
- * is `true` and `review.reply` is populated.
3621
+ * platform). Same shape as review.new. When a reply is present, review.hasReply
3622
+ * is true and review.reply is populated.
3623
3623
  *
3624
3624
  */
3625
3625
  type WebhookPayloadReviewUpdated = {
@@ -12205,7 +12205,7 @@ type GetAdCommentsResponse = ({
12205
12205
  */
12206
12206
  platformAdId: string;
12207
12207
  /**
12208
- * Underlying post ID the comments belong to (effective_object_story_id for FB, effective_instagram_media_id for IG).
12208
+ * Underlying post ID the comments belong to. effective_object_story_id for Facebook, effective_instagram_media_id for Instagram.
12209
12209
  */
12210
12210
  effectiveStoryId: string;
12211
12211
  /**
package/dist/index.d.ts CHANGED
@@ -2687,7 +2687,7 @@ type ReviewWebhookReview = {
2687
2687
  */
2688
2688
  hasReply: boolean;
2689
2689
  /**
2690
- * Present when `hasReply` is true.
2690
+ * Present when hasReply is true.
2691
2691
  */
2692
2692
  reply?: {
2693
2693
  text: string;
@@ -3158,8 +3158,8 @@ type WebhookPayloadComment = {
3158
3158
  parentCommentId: (string) | null;
3159
3159
  /**
3160
3160
  * Ad context. Present only when the comment was made on paid content.
3161
- * Instagram: populated from the webhook payload's `value.media.ad_id`/`ad_title`.
3162
- * Facebook: populated via a Graph API lookup of the parent post's `promotion_status`.
3161
+ * Instagram: populated from the webhook payload's value.media.ad_id and value.media.ad_title.
3162
+ * Facebook: populated via a Graph API lookup of the parent post's promotion_status.
3163
3163
  * Absent for comments on organic posts that are not currently promoted.
3164
3164
  *
3165
3165
  */
@@ -3175,7 +3175,7 @@ type WebhookPayloadComment = {
3175
3175
  /**
3176
3176
  * Facebook promotion status returned by Graph API. Common values:
3177
3177
  * "active" (organic post currently boosted), "ineligible" (dark
3178
- * post / ad creative not promotable because it already is an ad).
3178
+ * post or ad creative, not promotable because it already is an ad).
3179
3179
  *
3180
3180
  */
3181
3181
  promotionStatus?: string;
@@ -3598,7 +3598,7 @@ type WebhookPayloadPost = {
3598
3598
  };
3599
3599
  type event9 = 'post.scheduled' | 'post.published' | 'post.failed' | 'post.partial' | 'post.cancelled' | 'post.recycled';
3600
3600
  /**
3601
- * Webhook payload for the `review.new` event (new review posted on a connected account).
3601
+ * Webhook payload for the review.new event (new review posted on a connected account).
3602
3602
  */
3603
3603
  type WebhookPayloadReviewNew = {
3604
3604
  /**
@@ -3616,10 +3616,10 @@ type WebhookPayloadReviewNew = {
3616
3616
  };
3617
3617
  type event10 = 'review.new';
3618
3618
  /**
3619
- * Webhook payload for the `review.updated` event. Fired when the reviewer edits
3619
+ * Webhook payload for the review.updated event. Fired when the reviewer edits
3620
3620
  * their text or rating, or when a reply is added (via the API or directly on the
3621
- * platform). Same shape as `review.new`; when a reply is present `review.hasReply`
3622
- * is `true` and `review.reply` is populated.
3621
+ * platform). Same shape as review.new. When a reply is present, review.hasReply
3622
+ * is true and review.reply is populated.
3623
3623
  *
3624
3624
  */
3625
3625
  type WebhookPayloadReviewUpdated = {
@@ -12205,7 +12205,7 @@ type GetAdCommentsResponse = ({
12205
12205
  */
12206
12206
  platformAdId: string;
12207
12207
  /**
12208
- * Underlying post ID the comments belong to (effective_object_story_id for FB, effective_instagram_media_id for IG).
12208
+ * Underlying post ID the comments belong to. effective_object_story_id for Facebook, effective_instagram_media_id for Instagram.
12209
12209
  */
12210
12210
  effectiveStoryId: string;
12211
12211
  /**
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@zernio/node",
3
- "version": "0.2.86",
3
+ "version": "0.2.87",
4
4
  "description": "The official Node.js library for the Zernio API",
5
5
  "main": "dist/index.js",
6
6
  "module": "dist/index.mjs",
@@ -3160,17 +3160,17 @@ export const getAdAnalytics = <ThrowOnError extends boolean = false>(options: Op
3160
3160
  * List comments on an ad
3161
3161
  * Returns comments on an ad's underlying creative post. Useful for moderating or analyzing
3162
3162
  * engagement on dark posts (ad creatives that never went live organically), which the
3163
- * regular `/v1/inbox/comments/{postId}` endpoint cannot serve because dark posts aren't
3164
- * in Zernio's post database.
3163
+ * regular GET /v1/inbox/comments/{postId} endpoint cannot serve because dark posts are
3164
+ * not in Zernio's post database.
3165
3165
  *
3166
- * Resolves the ad's creative `effective_object_story_id` (Facebook) or
3167
- * `effective_instagram_media_id` (Instagram) via the Marketing API on each call
3166
+ * Resolves the ad's creative effective_object_story_id (Facebook) or
3167
+ * effective_instagram_media_id (Instagram) via the Marketing API on each call
3168
3168
  * (cached in-process by the platform client), then fetches comments from the Graph API.
3169
3169
  *
3170
- * **Meta-only**: other ad platforms (TikTok, LinkedIn, Pinterest, Google, X) do not
3171
- * expose a public per-ad comments API and return `feature_not_available`.
3170
+ * Meta-only. Other ad platforms (TikTok, LinkedIn, Pinterest, Google, X) do not
3171
+ * expose a public per-ad comments API and return feature_not_available.
3172
3172
  *
3173
- * Requires the Ads add-on. Response shape matches `/v1/inbox/comments/{postId}`.
3173
+ * Requires the Ads add-on. Response shape matches GET /v1/inbox/comments/{postId}.
3174
3174
  *
3175
3175
  */
3176
3176
  export const getAdComments = <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<GetAdCommentsData, ThrowOnError>) => {
@@ -2195,7 +2195,7 @@ export type ReviewWebhookReview = {
2195
2195
  */
2196
2196
  hasReply: boolean;
2197
2197
  /**
2198
- * Present when `hasReply` is true.
2198
+ * Present when hasReply is true.
2199
2199
  */
2200
2200
  reply?: {
2201
2201
  text: string;
@@ -2696,8 +2696,8 @@ export type WebhookPayloadComment = {
2696
2696
  parentCommentId: (string) | null;
2697
2697
  /**
2698
2698
  * Ad context. Present only when the comment was made on paid content.
2699
- * Instagram: populated from the webhook payload's `value.media.ad_id`/`ad_title`.
2700
- * Facebook: populated via a Graph API lookup of the parent post's `promotion_status`.
2699
+ * Instagram: populated from the webhook payload's value.media.ad_id and value.media.ad_title.
2700
+ * Facebook: populated via a Graph API lookup of the parent post's promotion_status.
2701
2701
  * Absent for comments on organic posts that are not currently promoted.
2702
2702
  *
2703
2703
  */
@@ -2713,7 +2713,7 @@ export type WebhookPayloadComment = {
2713
2713
  /**
2714
2714
  * Facebook promotion status returned by Graph API. Common values:
2715
2715
  * "active" (organic post currently boosted), "ineligible" (dark
2716
- * post / ad creative not promotable because it already is an ad).
2716
+ * post or ad creative, not promotable because it already is an ad).
2717
2717
  *
2718
2718
  */
2719
2719
  promotionStatus?: string;
@@ -3152,7 +3152,7 @@ export type WebhookPayloadPost = {
3152
3152
  export type event9 = 'post.scheduled' | 'post.published' | 'post.failed' | 'post.partial' | 'post.cancelled' | 'post.recycled';
3153
3153
 
3154
3154
  /**
3155
- * Webhook payload for the `review.new` event (new review posted on a connected account).
3155
+ * Webhook payload for the review.new event (new review posted on a connected account).
3156
3156
  */
3157
3157
  export type WebhookPayloadReviewNew = {
3158
3158
  /**
@@ -3172,10 +3172,10 @@ export type WebhookPayloadReviewNew = {
3172
3172
  export type event10 = 'review.new';
3173
3173
 
3174
3174
  /**
3175
- * Webhook payload for the `review.updated` event. Fired when the reviewer edits
3175
+ * Webhook payload for the review.updated event. Fired when the reviewer edits
3176
3176
  * their text or rating, or when a reply is added (via the API or directly on the
3177
- * platform). Same shape as `review.new`; when a reply is present `review.hasReply`
3178
- * is `true` and `review.reply` is populated.
3177
+ * platform). Same shape as review.new. When a reply is present, review.hasReply
3178
+ * is true and review.reply is populated.
3179
3179
  *
3180
3180
  */
3181
3181
  export type WebhookPayloadReviewUpdated = {
@@ -12515,7 +12515,7 @@ export type GetAdCommentsResponse = ({
12515
12515
  */
12516
12516
  platformAdId: string;
12517
12517
  /**
12518
- * Underlying post ID the comments belong to (effective_object_story_id for FB, effective_instagram_media_id for IG).
12518
+ * Underlying post ID the comments belong to. effective_object_story_id for Facebook, effective_instagram_media_id for Instagram.
12519
12519
  */
12520
12520
  effectiveStoryId: string;
12521
12521
  /**