@getlatedev/node 0.2.581 → 0.2.583

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
@@ -4051,6 +4051,9 @@ type ExternalPostSummary = {
4051
4051
  views?: number;
4052
4052
  reach?: number;
4053
4053
  impressions?: number;
4054
+ /**
4055
+ * Percentage, rounded to 2 decimals. Same definition as PostAnalytics.engagementRate: (likes + comments + shares + saves) / (impressions or reach or views) * 100, where the denominator is the first of the three that is non-zero. Clicks and follows are never counted.
4056
+ */
4054
4057
  engagementRate?: number;
4055
4058
  /**
4056
4059
  * When these metrics were last refreshed
@@ -5329,7 +5332,7 @@ type LinkedInAggregateAnalyticsTotalResponse = {
5329
5332
  */
5330
5333
  sends?: number;
5331
5334
  /**
5332
- * Overall engagement rate as percentage
5335
+ * Overall engagement rate, as a percentage rounded to 2 decimals: (reactions + comments + shares + saves + sends) / impressions * 100. Clicks are not counted, and there is no fallback denominator, so this is 0 whenever impressions is 0. This is NOT the same formula as PostAnalytics.engagementRate on GET /v1/analytics.
5333
5336
  */
5334
5337
  engagementRate?: number;
5335
5338
  };
@@ -5669,6 +5672,9 @@ type PostAnalytics = {
5669
5672
  * Video length in seconds. Currently Instagram Reels only; combine with igReelsAvgWatchTime (ms) to estimate retention. Null when unknown (other platforms, non-video media, or when Instagram does not expose the media URL, e.g. reels with copyrighted audio).
5670
5673
  */
5671
5674
  videoDurationSeconds?: (number) | null;
5675
+ /**
5676
+ * Percentage, rounded to 2 decimals: (likes + comments + shares + saves) / (impressions or reach or views) * 100. Clicks and follows are never counted. The denominator is the FIRST of impressions, reach, views that is non-zero, so it is not the same basis on every post: a post with impressions divides by impressions, one without falls back to reach, then to views. If you need a single consistent basis (e.g. interactions / reach), compute it from the raw fields above. The engagementRate on the LinkedIn account endpoints is a different formula.
5677
+ */
5672
5678
  engagementRate?: number;
5673
5679
  lastUpdated?: string;
5674
5680
  };
@@ -15236,7 +15242,7 @@ type GetLinkedInPostAnalyticsResponse = ({
15236
15242
  */
15237
15243
  views?: number;
15238
15244
  /**
15239
- * Engagement rate as percentage
15245
+ * Engagement rate, as a percentage rounded to 2 decimals: (likes + comments + shares + clicks + saves + sends) / impressions * 100. Unlike PostAnalytics.engagementRate on GET /v1/analytics, this one DOES count clicks and has no fallback denominator, so it is 0 whenever impressions is 0. For organization accounts the value is the rate LinkedIn returns, not one computed here.
15240
15246
  */
15241
15247
  engagementRate?: number;
15242
15248
  };
@@ -25659,7 +25665,7 @@ type ListBroadcastRecipientsResponse = ({
25659
25665
  contactId?: string;
25660
25666
  channelId?: string;
25661
25667
  platformIdentifier?: string;
25662
- contactName?: string;
25668
+ contactName?: (string) | null;
25663
25669
  status?: 'pending' | 'sent' | 'delivered' | 'read' | 'failed';
25664
25670
  messageId?: string;
25665
25671
  error?: string;
@@ -26388,10 +26394,10 @@ type ListSequenceEnrollmentsResponse = ({
26388
26394
  contactName?: string;
26389
26395
  currentStepIndex?: number;
26390
26396
  status?: 'active' | 'completed' | 'exited' | 'paused';
26391
- exitReason?: string;
26392
- nextStepAt?: string;
26397
+ exitReason?: (string) | null;
26398
+ nextStepAt?: (string) | null;
26393
26399
  stepsSent?: number;
26394
- lastStepSentAt?: string;
26400
+ lastStepSentAt?: (string) | null;
26395
26401
  createdAt?: string;
26396
26402
  }>;
26397
26403
  pagination?: {
package/dist/index.d.ts CHANGED
@@ -4051,6 +4051,9 @@ type ExternalPostSummary = {
4051
4051
  views?: number;
4052
4052
  reach?: number;
4053
4053
  impressions?: number;
4054
+ /**
4055
+ * Percentage, rounded to 2 decimals. Same definition as PostAnalytics.engagementRate: (likes + comments + shares + saves) / (impressions or reach or views) * 100, where the denominator is the first of the three that is non-zero. Clicks and follows are never counted.
4056
+ */
4054
4057
  engagementRate?: number;
4055
4058
  /**
4056
4059
  * When these metrics were last refreshed
@@ -5329,7 +5332,7 @@ type LinkedInAggregateAnalyticsTotalResponse = {
5329
5332
  */
5330
5333
  sends?: number;
5331
5334
  /**
5332
- * Overall engagement rate as percentage
5335
+ * Overall engagement rate, as a percentage rounded to 2 decimals: (reactions + comments + shares + saves + sends) / impressions * 100. Clicks are not counted, and there is no fallback denominator, so this is 0 whenever impressions is 0. This is NOT the same formula as PostAnalytics.engagementRate on GET /v1/analytics.
5333
5336
  */
5334
5337
  engagementRate?: number;
5335
5338
  };
@@ -5669,6 +5672,9 @@ type PostAnalytics = {
5669
5672
  * Video length in seconds. Currently Instagram Reels only; combine with igReelsAvgWatchTime (ms) to estimate retention. Null when unknown (other platforms, non-video media, or when Instagram does not expose the media URL, e.g. reels with copyrighted audio).
5670
5673
  */
5671
5674
  videoDurationSeconds?: (number) | null;
5675
+ /**
5676
+ * Percentage, rounded to 2 decimals: (likes + comments + shares + saves) / (impressions or reach or views) * 100. Clicks and follows are never counted. The denominator is the FIRST of impressions, reach, views that is non-zero, so it is not the same basis on every post: a post with impressions divides by impressions, one without falls back to reach, then to views. If you need a single consistent basis (e.g. interactions / reach), compute it from the raw fields above. The engagementRate on the LinkedIn account endpoints is a different formula.
5677
+ */
5672
5678
  engagementRate?: number;
5673
5679
  lastUpdated?: string;
5674
5680
  };
@@ -15236,7 +15242,7 @@ type GetLinkedInPostAnalyticsResponse = ({
15236
15242
  */
15237
15243
  views?: number;
15238
15244
  /**
15239
- * Engagement rate as percentage
15245
+ * Engagement rate, as a percentage rounded to 2 decimals: (likes + comments + shares + clicks + saves + sends) / impressions * 100. Unlike PostAnalytics.engagementRate on GET /v1/analytics, this one DOES count clicks and has no fallback denominator, so it is 0 whenever impressions is 0. For organization accounts the value is the rate LinkedIn returns, not one computed here.
15240
15246
  */
15241
15247
  engagementRate?: number;
15242
15248
  };
@@ -25659,7 +25665,7 @@ type ListBroadcastRecipientsResponse = ({
25659
25665
  contactId?: string;
25660
25666
  channelId?: string;
25661
25667
  platformIdentifier?: string;
25662
- contactName?: string;
25668
+ contactName?: (string) | null;
25663
25669
  status?: 'pending' | 'sent' | 'delivered' | 'read' | 'failed';
25664
25670
  messageId?: string;
25665
25671
  error?: string;
@@ -26388,10 +26394,10 @@ type ListSequenceEnrollmentsResponse = ({
26388
26394
  contactName?: string;
26389
26395
  currentStepIndex?: number;
26390
26396
  status?: 'active' | 'completed' | 'exited' | 'paused';
26391
- exitReason?: string;
26392
- nextStepAt?: string;
26397
+ exitReason?: (string) | null;
26398
+ nextStepAt?: (string) | null;
26393
26399
  stepsSent?: number;
26394
- lastStepSentAt?: string;
26400
+ lastStepSentAt?: (string) | null;
26395
26401
  createdAt?: string;
26396
26402
  }>;
26397
26403
  pagination?: {
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.581",
39
+ version: "0.2.583",
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.581",
8
+ version: "0.2.583",
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.581",
3
+ "version": "0.2.583",
4
4
  "description": "The official Node.js library for the Zernio API",
5
5
  "main": "dist/index.js",
6
6
  "module": "dist/index.mjs",
@@ -2852,6 +2852,9 @@ export type ExternalPostSummary = {
2852
2852
  views?: number;
2853
2853
  reach?: number;
2854
2854
  impressions?: number;
2855
+ /**
2856
+ * Percentage, rounded to 2 decimals. Same definition as PostAnalytics.engagementRate: (likes + comments + shares + saves) / (impressions or reach or views) * 100, where the denominator is the first of the three that is non-zero. Clicks and follows are never counted.
2857
+ */
2855
2858
  engagementRate?: number;
2856
2859
  /**
2857
2860
  * When these metrics were last refreshed
@@ -4174,7 +4177,7 @@ export type LinkedInAggregateAnalyticsTotalResponse = {
4174
4177
  */
4175
4178
  sends?: number;
4176
4179
  /**
4177
- * Overall engagement rate as percentage
4180
+ * Overall engagement rate, as a percentage rounded to 2 decimals: (reactions + comments + shares + saves + sends) / impressions * 100. Clicks are not counted, and there is no fallback denominator, so this is 0 whenever impressions is 0. This is NOT the same formula as PostAnalytics.engagementRate on GET /v1/analytics.
4178
4181
  */
4179
4182
  engagementRate?: number;
4180
4183
  };
@@ -4538,6 +4541,9 @@ export type PostAnalytics = {
4538
4541
  * Video length in seconds. Currently Instagram Reels only; combine with igReelsAvgWatchTime (ms) to estimate retention. Null when unknown (other platforms, non-video media, or when Instagram does not expose the media URL, e.g. reels with copyrighted audio).
4539
4542
  */
4540
4543
  videoDurationSeconds?: (number) | null;
4544
+ /**
4545
+ * Percentage, rounded to 2 decimals: (likes + comments + shares + saves) / (impressions or reach or views) * 100. Clicks and follows are never counted. The denominator is the FIRST of impressions, reach, views that is non-zero, so it is not the same basis on every post: a post with impressions divides by impressions, one without falls back to reach, then to views. If you need a single consistent basis (e.g. interactions / reach), compute it from the raw fields above. The engagementRate on the LinkedIn account endpoints is a different formula.
4546
+ */
4541
4547
  engagementRate?: number;
4542
4548
  lastUpdated?: string;
4543
4549
  };
@@ -14668,7 +14674,7 @@ export type GetLinkedInPostAnalyticsResponse = ({
14668
14674
  */
14669
14675
  views?: number;
14670
14676
  /**
14671
- * Engagement rate as percentage
14677
+ * Engagement rate, as a percentage rounded to 2 decimals: (likes + comments + shares + clicks + saves + sends) / impressions * 100. Unlike PostAnalytics.engagementRate on GET /v1/analytics, this one DOES count clicks and has no fallback denominator, so it is 0 whenever impressions is 0. For organization accounts the value is the rate LinkedIn returns, not one computed here.
14672
14678
  */
14673
14679
  engagementRate?: number;
14674
14680
  };
@@ -25915,7 +25921,7 @@ export type ListBroadcastRecipientsResponse = ({
25915
25921
  contactId?: string;
25916
25922
  channelId?: string;
25917
25923
  platformIdentifier?: string;
25918
- contactName?: string;
25924
+ contactName?: (string) | null;
25919
25925
  status?: 'pending' | 'sent' | 'delivered' | 'read' | 'failed';
25920
25926
  messageId?: string;
25921
25927
  error?: string;
@@ -26719,10 +26725,10 @@ export type ListSequenceEnrollmentsResponse = ({
26719
26725
  contactName?: string;
26720
26726
  currentStepIndex?: number;
26721
26727
  status?: 'active' | 'completed' | 'exited' | 'paused';
26722
- exitReason?: string;
26723
- nextStepAt?: string;
26728
+ exitReason?: (string) | null;
26729
+ nextStepAt?: (string) | null;
26724
26730
  stepsSent?: number;
26725
- lastStepSentAt?: string;
26731
+ lastStepSentAt?: (string) | null;
26726
26732
  createdAt?: string;
26727
26733
  }>;
26728
26734
  pagination?: {