@getlatedev/node 0.2.1166 → 0.2.1168

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
@@ -12248,7 +12248,7 @@ type SupportRun = {
12248
12248
  */
12249
12249
  threadId: string;
12250
12250
  /**
12251
- * queued and running are in progress. needs_human means Ana handed the question to a person instead of answering; when `supportTicket` is set, a Zernio teammate has been notified and will follow up by email.
12251
+ * queued and running are in progress. needs_human means the assistant handed the question to a person instead of answering; when `supportTicket` is set, a Zernio teammate has been notified and will follow up by email.
12252
12252
  */
12253
12253
  status: 'queued' | 'running' | 'completed' | 'needs_human' | 'failed';
12254
12254
  /**
@@ -12256,7 +12256,11 @@ type SupportRun = {
12256
12256
  */
12257
12257
  stopReason: ('answered' | 'human_review' | 'cost_cap' | 'deadline' | 'max_iterations' | 'error' | 'expired') | null;
12258
12258
  /**
12259
- * Ana's answer. Null while the run is in progress or when it failed.
12259
+ * The question as asked, with leading and trailing whitespace trimmed. Null only on runs created before this field was added.
12260
+ */
12261
+ question: (string) | null;
12262
+ /**
12263
+ * The assistant's answer. Null while the run is in progress or when it failed.
12260
12264
  */
12261
12265
  answer: (string) | null;
12262
12266
  usage: SupportRunUsage;
@@ -12272,7 +12276,7 @@ type SupportRun = {
12272
12276
  startedAt: (string) | null;
12273
12277
  finishedAt: (string) | null;
12274
12278
  /**
12275
- * Set when Ana opened a support ticket with the Zernio team. Null otherwise. A teammate follows up by email with the user whose API key started the run.
12279
+ * Set when the assistant opened a support ticket with the Zernio team. Null otherwise. A teammate follows up by email with the user whose API key started the run.
12276
12280
  */
12277
12281
  supportTicket: {
12278
12282
  openedAt: string;
@@ -12283,7 +12287,7 @@ type SupportRun = {
12283
12287
  pollAfterSeconds?: number;
12284
12288
  };
12285
12289
  /**
12286
- * queued and running are in progress. needs_human means Ana handed the question to a person instead of answering; when `supportTicket` is set, a Zernio teammate has been notified and will follow up by email.
12290
+ * queued and running are in progress. needs_human means the assistant handed the question to a person instead of answering; when `supportTicket` is set, a Zernio teammate has been notified and will follow up by email.
12287
12291
  */
12288
12292
  type status29 = 'queued' | 'running' | 'completed' | 'needs_human' | 'failed';
12289
12293
  /**
@@ -14577,8 +14581,11 @@ type WebhookPayloadComment = {
14577
14581
  /**
14578
14582
  * Ad context. Present only when the comment was made on paid content.
14579
14583
  * Instagram: populated from the webhook payload's value.media.ad_id, value.media.ad_title and value.media.original_media_id, each only when Meta includes it.
14580
- * Facebook: populated via a Graph API lookup of the parent post's promotion_status.
14581
- * Absent for comments on organic posts that are not currently promoted.
14584
+ * Facebook: populated from a Graph API lookup of the parent post. Present when the post is an
14585
+ * ad dark post (isDarkPost true, whatever its promotionStatus) or an organic post that is or was
14586
+ * boosted (promotionStatus "active", "extendable" or "finished"). Meta does not link a dark post
14587
+ * back to its ad, so id and title are never set on Facebook.
14588
+ * Absent for comments on organic posts that are not promoted.
14582
14589
  *
14583
14590
  */
14584
14591
  ad?: {
@@ -14595,12 +14602,16 @@ type WebhookPayloadComment = {
14595
14602
  */
14596
14603
  originalMediaId?: string;
14597
14604
  /**
14598
- * Facebook promotion status returned by Graph API. Common values:
14599
- * "active" (organic post currently boosted), "ineligible" (dark
14600
- * post or ad creative, not promotable because it already is an ad).
14605
+ * Facebook only. The parent post's promotion_status as the Graph API returns it, for example
14606
+ * "active" (organic post currently boosted). Ad dark posts usually report "inactive" and
14607
+ * sometimes "ineligible", so use isDarkPost, not this value, to tell an ad comment apart.
14601
14608
  *
14602
14609
  */
14603
14610
  promotionStatus?: string;
14611
+ /**
14612
+ * Facebook only: true when the post is an unpublished ad creative (dark post), false for a boosted organic post.
14613
+ */
14614
+ isDarkPost?: boolean;
14604
14615
  };
14605
14616
  /**
14606
14617
  * Facebook only. Present on graphic-only comments (sticker, GIF, photo) that
@@ -38574,7 +38585,7 @@ type AskSupportQuestionData = {
38574
38585
  */
38575
38586
  threadId?: string;
38576
38587
  /**
38577
- * Ids Ana should look at. Each must belong to your workspace.
38588
+ * Ids the assistant should look at. Each must belong to your workspace.
38578
38589
  */
38579
38590
  context?: {
38580
38591
  postId?: string;
package/dist/index.d.ts CHANGED
@@ -12248,7 +12248,7 @@ type SupportRun = {
12248
12248
  */
12249
12249
  threadId: string;
12250
12250
  /**
12251
- * queued and running are in progress. needs_human means Ana handed the question to a person instead of answering; when `supportTicket` is set, a Zernio teammate has been notified and will follow up by email.
12251
+ * queued and running are in progress. needs_human means the assistant handed the question to a person instead of answering; when `supportTicket` is set, a Zernio teammate has been notified and will follow up by email.
12252
12252
  */
12253
12253
  status: 'queued' | 'running' | 'completed' | 'needs_human' | 'failed';
12254
12254
  /**
@@ -12256,7 +12256,11 @@ type SupportRun = {
12256
12256
  */
12257
12257
  stopReason: ('answered' | 'human_review' | 'cost_cap' | 'deadline' | 'max_iterations' | 'error' | 'expired') | null;
12258
12258
  /**
12259
- * Ana's answer. Null while the run is in progress or when it failed.
12259
+ * The question as asked, with leading and trailing whitespace trimmed. Null only on runs created before this field was added.
12260
+ */
12261
+ question: (string) | null;
12262
+ /**
12263
+ * The assistant's answer. Null while the run is in progress or when it failed.
12260
12264
  */
12261
12265
  answer: (string) | null;
12262
12266
  usage: SupportRunUsage;
@@ -12272,7 +12276,7 @@ type SupportRun = {
12272
12276
  startedAt: (string) | null;
12273
12277
  finishedAt: (string) | null;
12274
12278
  /**
12275
- * Set when Ana opened a support ticket with the Zernio team. Null otherwise. A teammate follows up by email with the user whose API key started the run.
12279
+ * Set when the assistant opened a support ticket with the Zernio team. Null otherwise. A teammate follows up by email with the user whose API key started the run.
12276
12280
  */
12277
12281
  supportTicket: {
12278
12282
  openedAt: string;
@@ -12283,7 +12287,7 @@ type SupportRun = {
12283
12287
  pollAfterSeconds?: number;
12284
12288
  };
12285
12289
  /**
12286
- * queued and running are in progress. needs_human means Ana handed the question to a person instead of answering; when `supportTicket` is set, a Zernio teammate has been notified and will follow up by email.
12290
+ * queued and running are in progress. needs_human means the assistant handed the question to a person instead of answering; when `supportTicket` is set, a Zernio teammate has been notified and will follow up by email.
12287
12291
  */
12288
12292
  type status29 = 'queued' | 'running' | 'completed' | 'needs_human' | 'failed';
12289
12293
  /**
@@ -14577,8 +14581,11 @@ type WebhookPayloadComment = {
14577
14581
  /**
14578
14582
  * Ad context. Present only when the comment was made on paid content.
14579
14583
  * Instagram: populated from the webhook payload's value.media.ad_id, value.media.ad_title and value.media.original_media_id, each only when Meta includes it.
14580
- * Facebook: populated via a Graph API lookup of the parent post's promotion_status.
14581
- * Absent for comments on organic posts that are not currently promoted.
14584
+ * Facebook: populated from a Graph API lookup of the parent post. Present when the post is an
14585
+ * ad dark post (isDarkPost true, whatever its promotionStatus) or an organic post that is or was
14586
+ * boosted (promotionStatus "active", "extendable" or "finished"). Meta does not link a dark post
14587
+ * back to its ad, so id and title are never set on Facebook.
14588
+ * Absent for comments on organic posts that are not promoted.
14582
14589
  *
14583
14590
  */
14584
14591
  ad?: {
@@ -14595,12 +14602,16 @@ type WebhookPayloadComment = {
14595
14602
  */
14596
14603
  originalMediaId?: string;
14597
14604
  /**
14598
- * Facebook promotion status returned by Graph API. Common values:
14599
- * "active" (organic post currently boosted), "ineligible" (dark
14600
- * post or ad creative, not promotable because it already is an ad).
14605
+ * Facebook only. The parent post's promotion_status as the Graph API returns it, for example
14606
+ * "active" (organic post currently boosted). Ad dark posts usually report "inactive" and
14607
+ * sometimes "ineligible", so use isDarkPost, not this value, to tell an ad comment apart.
14601
14608
  *
14602
14609
  */
14603
14610
  promotionStatus?: string;
14611
+ /**
14612
+ * Facebook only: true when the post is an unpublished ad creative (dark post), false for a boosted organic post.
14613
+ */
14614
+ isDarkPost?: boolean;
14604
14615
  };
14605
14616
  /**
14606
14617
  * Facebook only. Present on graphic-only comments (sticker, GIF, photo) that
@@ -38574,7 +38585,7 @@ type AskSupportQuestionData = {
38574
38585
  */
38575
38586
  threadId?: string;
38576
38587
  /**
38577
- * Ids Ana should look at. Each must belong to your workspace.
38588
+ * Ids the assistant should look at. Each must belong to your workspace.
38578
38589
  */
38579
38590
  context?: {
38580
38591
  postId?: string;
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.1166",
39
+ version: "0.2.1168",
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.1166",
8
+ version: "0.2.1168",
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.1166",
3
+ "version": "0.2.1168",
4
4
  "description": "The official Node.js library for the Zernio API",
5
5
  "main": "dist/index.js",
6
6
  "module": "dist/index.mjs",
@@ -9022,7 +9022,7 @@ export const addBroadcastRecipients = <ThrowOnError extends boolean = false>(opt
9022
9022
 
9023
9023
  /**
9024
9024
  * List a thread's support answers
9025
- * Lists the runs of one thread that your team started, with Ana's answers, oldest first. Replies from the Zernio team after a support ticket arrive by email and are not included. Runs are kept for 90 days. Page through a long thread with `limit` and `cursor`: pass `nextCursor` as `cursor` until it is null.
9025
+ * Lists the runs of one thread that your team started, with each question and its answer, oldest first. Replies from the Zernio team after a support ticket arrive by email and are not included. Runs are kept for 90 days. Page through a long thread with `limit` and `cursor`: pass `nextCursor` as `cursor` until it is null.
9026
9026
  */
9027
9027
  export const listSupportAnswers = <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<ListSupportAnswersData, ThrowOnError>) => {
9028
9028
  return (options?.client ?? client).get<ListSupportAnswersResponse, ListSupportAnswersError, ThrowOnError>({
@@ -9033,13 +9033,13 @@ export const listSupportAnswers = <ThrowOnError extends boolean = false>(options
9033
9033
 
9034
9034
  /**
9035
9035
  * Ask a support question
9036
- * Asks Ana, the Zernio support agent, a question about your workspace. Each question
9036
+ * Asks the Zernio Support Assistant a question about your workspace. Each question
9037
9037
  * starts a run that answers asynchronously: this returns 202 with a `runId`, and the
9038
9038
  * answer arrives through the `support.run.completed` and `support.run.failed` webhooks.
9039
9039
  * `GET /v1/support/runs/{runId}` is the fallback. Pass `threadId` to continue an earlier
9040
- * conversation, and `context` to point Ana at a post, account or profile. When Ana finds
9041
- * a problem on Zernio's side she opens a support ticket with the team (see
9042
- * `supportTicket` on the run) and the run ends as `needs_human`.
9040
+ * conversation, and `context` to point the assistant at a post, account or profile.
9041
+ * When the assistant finds a problem on Zernio's side it opens a support ticket with
9042
+ * the team (see `supportTicket` on the run) and the run ends as `needs_human`.
9043
9043
  *
9044
9044
  * **Pricing.** You pay per question, once it finishes. The exact amount charged is the
9045
9045
  * run's `costUsd`.
@@ -9070,7 +9070,7 @@ export const askSupportQuestion = <ThrowOnError extends boolean = false>(options
9070
9070
 
9071
9071
  /**
9072
9072
  * Get a support answer
9073
- * Returns a run started by your team, with Ana's answer once it is ready. Prefer the `support.run.completed` and `support.run.failed` webhooks; use this as the fallback, waiting `pollAfterSeconds` between polls. `costUsd` is the amount billed for the question, never above `maxCostUsd`, and 0 for a failed run (pricing on Ask a support question).
9073
+ * Returns a run started by your team, with the answer once it is ready. Prefer the `support.run.completed` and `support.run.failed` webhooks; use this as the fallback, waiting `pollAfterSeconds` between polls. `costUsd` is the amount billed for the question, never above `maxCostUsd`, and 0 for a failed run (pricing on Ask a support question).
9074
9074
  */
9075
9075
  export const getSupportAnswer = <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<GetSupportAnswerData, ThrowOnError>) => {
9076
9076
  return (options?.client ?? client).get<GetSupportAnswerResponse, GetSupportAnswerError, ThrowOnError>({
@@ -10710,7 +10710,7 @@ export type SupportRun = {
10710
10710
  */
10711
10711
  threadId: string;
10712
10712
  /**
10713
- * queued and running are in progress. needs_human means Ana handed the question to a person instead of answering; when `supportTicket` is set, a Zernio teammate has been notified and will follow up by email.
10713
+ * queued and running are in progress. needs_human means the assistant handed the question to a person instead of answering; when `supportTicket` is set, a Zernio teammate has been notified and will follow up by email.
10714
10714
  */
10715
10715
  status: 'queued' | 'running' | 'completed' | 'needs_human' | 'failed';
10716
10716
  /**
@@ -10718,7 +10718,11 @@ export type SupportRun = {
10718
10718
  */
10719
10719
  stopReason: ('answered' | 'human_review' | 'cost_cap' | 'deadline' | 'max_iterations' | 'error' | 'expired') | null;
10720
10720
  /**
10721
- * Ana's answer. Null while the run is in progress or when it failed.
10721
+ * The question as asked, with leading and trailing whitespace trimmed. Null only on runs created before this field was added.
10722
+ */
10723
+ question: (string) | null;
10724
+ /**
10725
+ * The assistant's answer. Null while the run is in progress or when it failed.
10722
10726
  */
10723
10727
  answer: (string) | null;
10724
10728
  usage: SupportRunUsage;
@@ -10734,7 +10738,7 @@ export type SupportRun = {
10734
10738
  startedAt: (string) | null;
10735
10739
  finishedAt: (string) | null;
10736
10740
  /**
10737
- * Set when Ana opened a support ticket with the Zernio team. Null otherwise. A teammate follows up by email with the user whose API key started the run.
10741
+ * Set when the assistant opened a support ticket with the Zernio team. Null otherwise. A teammate follows up by email with the user whose API key started the run.
10738
10742
  */
10739
10743
  supportTicket: {
10740
10744
  openedAt: string;
@@ -10746,7 +10750,7 @@ export type SupportRun = {
10746
10750
  };
10747
10751
 
10748
10752
  /**
10749
- * queued and running are in progress. needs_human means Ana handed the question to a person instead of answering; when `supportTicket` is set, a Zernio teammate has been notified and will follow up by email.
10753
+ * queued and running are in progress. needs_human means the assistant handed the question to a person instead of answering; when `supportTicket` is set, a Zernio teammate has been notified and will follow up by email.
10750
10754
  */
10751
10755
  export type status29 = 'queued' | 'running' | 'completed' | 'needs_human' | 'failed';
10752
10756
 
@@ -13129,8 +13133,11 @@ export type WebhookPayloadComment = {
13129
13133
  /**
13130
13134
  * Ad context. Present only when the comment was made on paid content.
13131
13135
  * Instagram: populated from the webhook payload's value.media.ad_id, value.media.ad_title and value.media.original_media_id, each only when Meta includes it.
13132
- * Facebook: populated via a Graph API lookup of the parent post's promotion_status.
13133
- * Absent for comments on organic posts that are not currently promoted.
13136
+ * Facebook: populated from a Graph API lookup of the parent post. Present when the post is an
13137
+ * ad dark post (isDarkPost true, whatever its promotionStatus) or an organic post that is or was
13138
+ * boosted (promotionStatus "active", "extendable" or "finished"). Meta does not link a dark post
13139
+ * back to its ad, so id and title are never set on Facebook.
13140
+ * Absent for comments on organic posts that are not promoted.
13134
13141
  *
13135
13142
  */
13136
13143
  ad?: {
@@ -13147,12 +13154,16 @@ export type WebhookPayloadComment = {
13147
13154
  */
13148
13155
  originalMediaId?: string;
13149
13156
  /**
13150
- * Facebook promotion status returned by Graph API. Common values:
13151
- * "active" (organic post currently boosted), "ineligible" (dark
13152
- * post or ad creative, not promotable because it already is an ad).
13157
+ * Facebook only. The parent post's promotion_status as the Graph API returns it, for example
13158
+ * "active" (organic post currently boosted). Ad dark posts usually report "inactive" and
13159
+ * sometimes "ineligible", so use isDarkPost, not this value, to tell an ad comment apart.
13153
13160
  *
13154
13161
  */
13155
13162
  promotionStatus?: string;
13163
+ /**
13164
+ * Facebook only: true when the post is an unpublished ad creative (dark post), false for a boosted organic post.
13165
+ */
13166
+ isDarkPost?: boolean;
13156
13167
  };
13157
13168
  /**
13158
13169
  * Facebook only. Present on graphic-only comments (sticker, GIF, photo) that
@@ -38846,7 +38857,7 @@ export type AskSupportQuestionData = {
38846
38857
  */
38847
38858
  threadId?: string;
38848
38859
  /**
38849
- * Ids Ana should look at. Each must belong to your workspace.
38860
+ * Ids the assistant should look at. Each must belong to your workspace.
38850
38861
  */
38851
38862
  context?: {
38852
38863
  postId?: string;