@getlatedev/node 0.2.356 → 0.2.358

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
@@ -22747,7 +22747,16 @@ type GetCampaignAnalyticsData = {
22747
22747
  };
22748
22748
  query?: {
22749
22749
  /**
22750
- * Comma-separated breakdown dimensions (Meta only): age, gender, country, publisher_platform, device_platform, region, platform_position, impression_device, video_asset, image_asset, body_asset, title_asset.
22750
+ * Comma-separated breakdown dimensions.
22751
+ *
22752
+ * **Meta**: age, gender, country, publisher_platform, device_platform, region,
22753
+ * platform_position, impression_device, video_asset, image_asset, body_asset, title_asset.
22754
+ *
22755
+ * **LinkedIn** (firmographics): job_title, job_function, seniority, industry,
22756
+ * company, company_size, country, region. Rows carry the raw pivot `value`
22757
+ * plus a resolved `name`. LinkedIn serves these aggregated over the whole
22758
+ * range, delays the data 12-24h, and omits segments with fewer than 3 events.
22759
+ *
22751
22760
  */
22752
22761
  breakdowns?: string;
22753
22762
  /**
@@ -22803,7 +22812,17 @@ type GetAdAnalyticsData = {
22803
22812
  };
22804
22813
  query?: {
22805
22814
  /**
22806
- * Comma-separated breakdown dimensions. Meta: age, gender, country, publisher_platform, device_platform, region. TikTok: gender, age, country_code, platform, ac, language.
22815
+ * Comma-separated breakdown dimensions.
22816
+ *
22817
+ * **Meta**: age, gender, country, publisher_platform, device_platform, region.
22818
+ *
22819
+ * **TikTok**: gender, age, country_code, platform, ac, language.
22820
+ *
22821
+ * **LinkedIn** (firmographics): job_title, job_function, seniority, industry,
22822
+ * company, company_size, country, region. Rows carry the raw pivot `value`
22823
+ * plus a resolved `name`. LinkedIn serves these aggregated over the whole
22824
+ * range, delays the data 12-24h, and omits segments with fewer than 3 events.
22825
+ *
22807
22826
  */
22808
22827
  breakdowns?: string;
22809
22828
  /**
@@ -24437,9 +24456,9 @@ type ListAdAudiencesData = {
24437
24456
  adAccountId: string;
24438
24457
  platform?: 'facebook' | 'instagram' | 'googleads' | 'tiktok' | 'tiktokads' | 'pinterest' | 'linkedin' | 'linkedinads' | 'twitter' | 'xads';
24439
24458
  /**
24440
- * Filter to one audience type. `saved_targeting` returns stored TargetingSpec audiences (each item carries a `spec`); the other types return uploaded/derived audiences.
24459
+ * Filter to one audience type. `saved_targeting` returns stored TargetingSpec audiences; the other types return uploaded/derived audiences.
24441
24460
  */
24442
- type?: 'customer_list' | 'website' | 'lookalike' | 'saved_targeting';
24461
+ type?: 'customer_list' | 'company_list' | 'engagement' | 'website' | 'website_retargeting' | 'lookalike' | 'saved_targeting';
24443
24462
  };
24444
24463
  };
24445
24464
  type ListAdAudiencesResponse = ({
@@ -24452,7 +24471,7 @@ type ListAdAudiencesResponse = ({
24452
24471
  platformAudienceId?: string;
24453
24472
  name?: string;
24454
24473
  description?: string;
24455
- type?: 'customer_list' | 'website' | 'lookalike' | 'saved_targeting';
24474
+ type?: 'customer_list' | 'company_list' | 'engagement' | 'website' | 'website_retargeting' | 'lookalike' | 'saved_targeting';
24456
24475
  /**
24457
24476
  * Present (and the only meaningful payload) when `type` is `saved_targeting`. Null for uploaded/derived audience types.
24458
24477
  */
@@ -24474,7 +24493,61 @@ type CreateAdAudienceData = {
24474
24493
  adAccountId: string;
24475
24494
  name: string;
24476
24495
  description?: string;
24477
- type: 'customer_list' | 'website' | 'lookalike';
24496
+ type: 'customer_list' | 'company_list' | 'engagement' | 'website' | 'website_retargeting' | 'lookalike';
24497
+ /**
24498
+ * Required for website_retargeting audiences (LinkedIn only).
24499
+ * Each rule is a URL pattern; a member who visits any
24500
+ * matching page enters the segment. Needs the LinkedIn
24501
+ * Insight Tag installed on the customer's site — the
24502
+ * segment only starts filling once the tag reports visits.
24503
+ *
24504
+ */
24505
+ matchRules?: Array<{
24506
+ matchType: 'EXACT' | 'STARTS_WITH' | 'CONTAINS' | 'ENDS_WITH';
24507
+ matchValue: string;
24508
+ }>;
24509
+ /**
24510
+ * Required for engagement audiences (LinkedIn only): what
24511
+ * members engaged with — a video/leadgen/single-image ad
24512
+ * campaign, a Company Page or an Event page.
24513
+ *
24514
+ */
24515
+ sourceType?: 'VIDEO_ADS' | 'LEAD_GEN_FORMS' | 'ORGANIZATION_PAGES' | 'EVENT_PAGES' | 'SINGLE_IMAGE_ADS';
24516
+ /**
24517
+ * Required for engagement audiences. The action, validated
24518
+ * by LinkedIn against `sourceType`. Common values:
24519
+ * VIDEO_ADS FIRST_QUARTILE / MIDPOINT / THIRD_QUARTILE /
24520
+ * FULL_COMPLETE; LEAD_GEN_FORMS VIEW_FORM /
24521
+ * LEAD_FORM_SUBMIT; ORGANIZATION_PAGES VIEW / CTA_CLICK;
24522
+ * EVENT_PAGES RSVPED / VIDEO_VIEWED / ENGAGEMENT / CLICK.
24523
+ *
24524
+ */
24525
+ trigger?: string;
24526
+ /**
24527
+ * Required for engagement audiences. Rolling window.
24528
+ */
24529
+ lookbackDays?: 30 | 60 | 90 | 180 | 365;
24530
+ /**
24531
+ * Required for engagement audiences. Campaign URNs for the
24532
+ * ad source types, organization URNs for pages and events.
24533
+ * LinkedIn creates one rule per source, all sharing the
24534
+ * same trigger and lookbackDays.
24535
+ *
24536
+ */
24537
+ engagementSources?: Array<(string)>;
24538
+ /**
24539
+ * Required for company_list audiences (LinkedIn only): plain-text
24540
+ * company rows for account targeting. Each row needs at least one
24541
+ * identifier. LinkedIn recommends 1,000+ companies for a usable
24542
+ * match rate and takes up to 48h to process the list.
24543
+ *
24544
+ */
24545
+ companies?: Array<{
24546
+ name?: string;
24547
+ domain?: string;
24548
+ website?: string;
24549
+ linkedinPageUrl?: string;
24550
+ }>;
24478
24551
  /**
24479
24552
  * Required for website audiences
24480
24553
  */
package/dist/index.d.ts CHANGED
@@ -22747,7 +22747,16 @@ type GetCampaignAnalyticsData = {
22747
22747
  };
22748
22748
  query?: {
22749
22749
  /**
22750
- * Comma-separated breakdown dimensions (Meta only): age, gender, country, publisher_platform, device_platform, region, platform_position, impression_device, video_asset, image_asset, body_asset, title_asset.
22750
+ * Comma-separated breakdown dimensions.
22751
+ *
22752
+ * **Meta**: age, gender, country, publisher_platform, device_platform, region,
22753
+ * platform_position, impression_device, video_asset, image_asset, body_asset, title_asset.
22754
+ *
22755
+ * **LinkedIn** (firmographics): job_title, job_function, seniority, industry,
22756
+ * company, company_size, country, region. Rows carry the raw pivot `value`
22757
+ * plus a resolved `name`. LinkedIn serves these aggregated over the whole
22758
+ * range, delays the data 12-24h, and omits segments with fewer than 3 events.
22759
+ *
22751
22760
  */
22752
22761
  breakdowns?: string;
22753
22762
  /**
@@ -22803,7 +22812,17 @@ type GetAdAnalyticsData = {
22803
22812
  };
22804
22813
  query?: {
22805
22814
  /**
22806
- * Comma-separated breakdown dimensions. Meta: age, gender, country, publisher_platform, device_platform, region. TikTok: gender, age, country_code, platform, ac, language.
22815
+ * Comma-separated breakdown dimensions.
22816
+ *
22817
+ * **Meta**: age, gender, country, publisher_platform, device_platform, region.
22818
+ *
22819
+ * **TikTok**: gender, age, country_code, platform, ac, language.
22820
+ *
22821
+ * **LinkedIn** (firmographics): job_title, job_function, seniority, industry,
22822
+ * company, company_size, country, region. Rows carry the raw pivot `value`
22823
+ * plus a resolved `name`. LinkedIn serves these aggregated over the whole
22824
+ * range, delays the data 12-24h, and omits segments with fewer than 3 events.
22825
+ *
22807
22826
  */
22808
22827
  breakdowns?: string;
22809
22828
  /**
@@ -24437,9 +24456,9 @@ type ListAdAudiencesData = {
24437
24456
  adAccountId: string;
24438
24457
  platform?: 'facebook' | 'instagram' | 'googleads' | 'tiktok' | 'tiktokads' | 'pinterest' | 'linkedin' | 'linkedinads' | 'twitter' | 'xads';
24439
24458
  /**
24440
- * Filter to one audience type. `saved_targeting` returns stored TargetingSpec audiences (each item carries a `spec`); the other types return uploaded/derived audiences.
24459
+ * Filter to one audience type. `saved_targeting` returns stored TargetingSpec audiences; the other types return uploaded/derived audiences.
24441
24460
  */
24442
- type?: 'customer_list' | 'website' | 'lookalike' | 'saved_targeting';
24461
+ type?: 'customer_list' | 'company_list' | 'engagement' | 'website' | 'website_retargeting' | 'lookalike' | 'saved_targeting';
24443
24462
  };
24444
24463
  };
24445
24464
  type ListAdAudiencesResponse = ({
@@ -24452,7 +24471,7 @@ type ListAdAudiencesResponse = ({
24452
24471
  platformAudienceId?: string;
24453
24472
  name?: string;
24454
24473
  description?: string;
24455
- type?: 'customer_list' | 'website' | 'lookalike' | 'saved_targeting';
24474
+ type?: 'customer_list' | 'company_list' | 'engagement' | 'website' | 'website_retargeting' | 'lookalike' | 'saved_targeting';
24456
24475
  /**
24457
24476
  * Present (and the only meaningful payload) when `type` is `saved_targeting`. Null for uploaded/derived audience types.
24458
24477
  */
@@ -24474,7 +24493,61 @@ type CreateAdAudienceData = {
24474
24493
  adAccountId: string;
24475
24494
  name: string;
24476
24495
  description?: string;
24477
- type: 'customer_list' | 'website' | 'lookalike';
24496
+ type: 'customer_list' | 'company_list' | 'engagement' | 'website' | 'website_retargeting' | 'lookalike';
24497
+ /**
24498
+ * Required for website_retargeting audiences (LinkedIn only).
24499
+ * Each rule is a URL pattern; a member who visits any
24500
+ * matching page enters the segment. Needs the LinkedIn
24501
+ * Insight Tag installed on the customer's site — the
24502
+ * segment only starts filling once the tag reports visits.
24503
+ *
24504
+ */
24505
+ matchRules?: Array<{
24506
+ matchType: 'EXACT' | 'STARTS_WITH' | 'CONTAINS' | 'ENDS_WITH';
24507
+ matchValue: string;
24508
+ }>;
24509
+ /**
24510
+ * Required for engagement audiences (LinkedIn only): what
24511
+ * members engaged with — a video/leadgen/single-image ad
24512
+ * campaign, a Company Page or an Event page.
24513
+ *
24514
+ */
24515
+ sourceType?: 'VIDEO_ADS' | 'LEAD_GEN_FORMS' | 'ORGANIZATION_PAGES' | 'EVENT_PAGES' | 'SINGLE_IMAGE_ADS';
24516
+ /**
24517
+ * Required for engagement audiences. The action, validated
24518
+ * by LinkedIn against `sourceType`. Common values:
24519
+ * VIDEO_ADS FIRST_QUARTILE / MIDPOINT / THIRD_QUARTILE /
24520
+ * FULL_COMPLETE; LEAD_GEN_FORMS VIEW_FORM /
24521
+ * LEAD_FORM_SUBMIT; ORGANIZATION_PAGES VIEW / CTA_CLICK;
24522
+ * EVENT_PAGES RSVPED / VIDEO_VIEWED / ENGAGEMENT / CLICK.
24523
+ *
24524
+ */
24525
+ trigger?: string;
24526
+ /**
24527
+ * Required for engagement audiences. Rolling window.
24528
+ */
24529
+ lookbackDays?: 30 | 60 | 90 | 180 | 365;
24530
+ /**
24531
+ * Required for engagement audiences. Campaign URNs for the
24532
+ * ad source types, organization URNs for pages and events.
24533
+ * LinkedIn creates one rule per source, all sharing the
24534
+ * same trigger and lookbackDays.
24535
+ *
24536
+ */
24537
+ engagementSources?: Array<(string)>;
24538
+ /**
24539
+ * Required for company_list audiences (LinkedIn only): plain-text
24540
+ * company rows for account targeting. Each row needs at least one
24541
+ * identifier. LinkedIn recommends 1,000+ companies for a usable
24542
+ * match rate and takes up to 48h to process the list.
24543
+ *
24544
+ */
24545
+ companies?: Array<{
24546
+ name?: string;
24547
+ domain?: string;
24548
+ website?: string;
24549
+ linkedinPageUrl?: string;
24550
+ }>;
24478
24551
  /**
24479
24552
  * Required for website audiences
24480
24553
  */
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.356",
39
+ version: "0.2.358",
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.356",
8
+ version: "0.2.358",
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.356",
3
+ "version": "0.2.358",
4
4
  "description": "The official Node.js library for the Zernio API",
5
5
  "main": "dist/index.js",
6
6
  "module": "dist/index.mjs",
@@ -23368,7 +23368,16 @@ export type GetCampaignAnalyticsData = {
23368
23368
  };
23369
23369
  query?: {
23370
23370
  /**
23371
- * Comma-separated breakdown dimensions (Meta only): age, gender, country, publisher_platform, device_platform, region, platform_position, impression_device, video_asset, image_asset, body_asset, title_asset.
23371
+ * Comma-separated breakdown dimensions.
23372
+ *
23373
+ * **Meta**: age, gender, country, publisher_platform, device_platform, region,
23374
+ * platform_position, impression_device, video_asset, image_asset, body_asset, title_asset.
23375
+ *
23376
+ * **LinkedIn** (firmographics): job_title, job_function, seniority, industry,
23377
+ * company, company_size, country, region. Rows carry the raw pivot `value`
23378
+ * plus a resolved `name`. LinkedIn serves these aggregated over the whole
23379
+ * range, delays the data 12-24h, and omits segments with fewer than 3 events.
23380
+ *
23372
23381
  */
23373
23382
  breakdowns?: string;
23374
23383
  /**
@@ -23427,7 +23436,17 @@ export type GetAdAnalyticsData = {
23427
23436
  };
23428
23437
  query?: {
23429
23438
  /**
23430
- * Comma-separated breakdown dimensions. Meta: age, gender, country, publisher_platform, device_platform, region. TikTok: gender, age, country_code, platform, ac, language.
23439
+ * Comma-separated breakdown dimensions.
23440
+ *
23441
+ * **Meta**: age, gender, country, publisher_platform, device_platform, region.
23442
+ *
23443
+ * **TikTok**: gender, age, country_code, platform, ac, language.
23444
+ *
23445
+ * **LinkedIn** (firmographics): job_title, job_function, seniority, industry,
23446
+ * company, company_size, country, region. Rows carry the raw pivot `value`
23447
+ * plus a resolved `name`. LinkedIn serves these aggregated over the whole
23448
+ * range, delays the data 12-24h, and omits segments with fewer than 3 events.
23449
+ *
23431
23450
  */
23432
23451
  breakdowns?: string;
23433
23452
  /**
@@ -25130,9 +25149,9 @@ export type ListAdAudiencesData = {
25130
25149
  adAccountId: string;
25131
25150
  platform?: 'facebook' | 'instagram' | 'googleads' | 'tiktok' | 'tiktokads' | 'pinterest' | 'linkedin' | 'linkedinads' | 'twitter' | 'xads';
25132
25151
  /**
25133
- * Filter to one audience type. `saved_targeting` returns stored TargetingSpec audiences (each item carries a `spec`); the other types return uploaded/derived audiences.
25152
+ * Filter to one audience type. `saved_targeting` returns stored TargetingSpec audiences; the other types return uploaded/derived audiences.
25134
25153
  */
25135
- type?: 'customer_list' | 'website' | 'lookalike' | 'saved_targeting';
25154
+ type?: 'customer_list' | 'company_list' | 'engagement' | 'website' | 'website_retargeting' | 'lookalike' | 'saved_targeting';
25136
25155
  };
25137
25156
  };
25138
25157
 
@@ -25146,7 +25165,7 @@ export type ListAdAudiencesResponse = ({
25146
25165
  platformAudienceId?: string;
25147
25166
  name?: string;
25148
25167
  description?: string;
25149
- type?: 'customer_list' | 'website' | 'lookalike' | 'saved_targeting';
25168
+ type?: 'customer_list' | 'company_list' | 'engagement' | 'website' | 'website_retargeting' | 'lookalike' | 'saved_targeting';
25150
25169
  /**
25151
25170
  * Present (and the only meaningful payload) when `type` is `saved_targeting`. Null for uploaded/derived audience types.
25152
25171
  */
@@ -25170,7 +25189,61 @@ export type CreateAdAudienceData = {
25170
25189
  adAccountId: string;
25171
25190
  name: string;
25172
25191
  description?: string;
25173
- type: 'customer_list' | 'website' | 'lookalike';
25192
+ type: 'customer_list' | 'company_list' | 'engagement' | 'website' | 'website_retargeting' | 'lookalike';
25193
+ /**
25194
+ * Required for website_retargeting audiences (LinkedIn only).
25195
+ * Each rule is a URL pattern; a member who visits any
25196
+ * matching page enters the segment. Needs the LinkedIn
25197
+ * Insight Tag installed on the customer's site — the
25198
+ * segment only starts filling once the tag reports visits.
25199
+ *
25200
+ */
25201
+ matchRules?: Array<{
25202
+ matchType: 'EXACT' | 'STARTS_WITH' | 'CONTAINS' | 'ENDS_WITH';
25203
+ matchValue: string;
25204
+ }>;
25205
+ /**
25206
+ * Required for engagement audiences (LinkedIn only): what
25207
+ * members engaged with — a video/leadgen/single-image ad
25208
+ * campaign, a Company Page or an Event page.
25209
+ *
25210
+ */
25211
+ sourceType?: 'VIDEO_ADS' | 'LEAD_GEN_FORMS' | 'ORGANIZATION_PAGES' | 'EVENT_PAGES' | 'SINGLE_IMAGE_ADS';
25212
+ /**
25213
+ * Required for engagement audiences. The action, validated
25214
+ * by LinkedIn against `sourceType`. Common values:
25215
+ * VIDEO_ADS FIRST_QUARTILE / MIDPOINT / THIRD_QUARTILE /
25216
+ * FULL_COMPLETE; LEAD_GEN_FORMS VIEW_FORM /
25217
+ * LEAD_FORM_SUBMIT; ORGANIZATION_PAGES VIEW / CTA_CLICK;
25218
+ * EVENT_PAGES RSVPED / VIDEO_VIEWED / ENGAGEMENT / CLICK.
25219
+ *
25220
+ */
25221
+ trigger?: string;
25222
+ /**
25223
+ * Required for engagement audiences. Rolling window.
25224
+ */
25225
+ lookbackDays?: 30 | 60 | 90 | 180 | 365;
25226
+ /**
25227
+ * Required for engagement audiences. Campaign URNs for the
25228
+ * ad source types, organization URNs for pages and events.
25229
+ * LinkedIn creates one rule per source, all sharing the
25230
+ * same trigger and lookbackDays.
25231
+ *
25232
+ */
25233
+ engagementSources?: Array<(string)>;
25234
+ /**
25235
+ * Required for company_list audiences (LinkedIn only): plain-text
25236
+ * company rows for account targeting. Each row needs at least one
25237
+ * identifier. LinkedIn recommends 1,000+ companies for a usable
25238
+ * match rate and takes up to 48h to process the list.
25239
+ *
25240
+ */
25241
+ companies?: Array<{
25242
+ name?: string;
25243
+ domain?: string;
25244
+ website?: string;
25245
+ linkedinPageUrl?: string;
25246
+ }>;
25174
25247
  /**
25175
25248
  * Required for website audiences
25176
25249
  */