@getlatedev/node 0.2.355 → 0.2.356

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
@@ -961,7 +961,7 @@ type Ad = {
961
961
  /**
962
962
  * Available goals vary by platform. Meta (Facebook/Instagram) supports all 9 (incl. `lead_conversion` = website pixel lead optimization and `catalog_sales` = Advantage+ catalog ads). TikTok supports the 7 non-`lead_conversion` goals. LinkedIn supports all except app_promotion / lead_conversion. Twitter/X supports engagement, traffic, awareness, video_views, app_promotion. Pinterest and Google Ads support only engagement, traffic, awareness, video_views.
963
963
  */
964
- goal?: 'engagement' | 'traffic' | 'awareness' | 'video_views' | 'lead_generation' | 'lead_conversion' | 'conversions' | 'app_promotion' | 'catalog_sales';
964
+ goal?: 'engagement' | 'traffic' | 'awareness' | 'video_views' | 'lead_generation' | 'lead_conversion' | 'conversions' | 'app_promotion' | 'catalog_sales' | 'job_applicants';
965
965
  /**
966
966
  * True for ads synced from platform ad managers
967
967
  */
@@ -1154,7 +1154,7 @@ type adType = 'boost' | 'standalone';
1154
1154
  /**
1155
1155
  * Available goals vary by platform. Meta (Facebook/Instagram) supports all 9 (incl. `lead_conversion` = website pixel lead optimization and `catalog_sales` = Advantage+ catalog ads). TikTok supports the 7 non-`lead_conversion` goals. LinkedIn supports all except app_promotion / lead_conversion. Twitter/X supports engagement, traffic, awareness, video_views, app_promotion. Pinterest and Google Ads support only engagement, traffic, awareness, video_views.
1156
1156
  */
1157
- type goal = 'engagement' | 'traffic' | 'awareness' | 'video_views' | 'lead_generation' | 'lead_conversion' | 'conversions' | 'app_promotion' | 'catalog_sales';
1157
+ type goal = 'engagement' | 'traffic' | 'awareness' | 'video_views' | 'lead_generation' | 'lead_conversion' | 'conversions' | 'app_promotion' | 'catalog_sales' | 'job_applicants';
1158
1158
  type type = 'daily' | 'lifetime';
1159
1159
  /**
1160
1160
  * Budget amount in the ad account's native currency (see the campaign's `currency` field for the code).
@@ -3389,6 +3389,43 @@ type LinkedInAdsPlatformData = {
3389
3389
  */
3390
3390
  showMemberProfilePhoto?: boolean;
3391
3391
  };
3392
+ /**
3393
+ * POST /v1/ads/create only. Dynamic Jobs Ad promoting your open roles,
3394
+ * personalized with the viewer's profile photo. Requires goal
3395
+ * job_applicants and a Company Page with active job postings.
3396
+ * headline and buttonLabel take exactly one of
3397
+ * preApproved or custom. logoUrl and organizationName default to the
3398
+ * Company Page's. Mutually exclusive with the other creative sources.
3399
+ *
3400
+ */
3401
+ jobs?: {
3402
+ headline: {
3403
+ /**
3404
+ * LinkedIn preset id, not reviewed. Example MEMBER_READY_FOR_YOUR_DREAM_JOB.
3405
+ */
3406
+ preApproved?: string;
3407
+ /**
3408
+ * Free text, reviewed by LinkedIn.
3409
+ */
3410
+ custom?: string;
3411
+ };
3412
+ buttonLabel: {
3413
+ /**
3414
+ * LinkedIn preset id, not reviewed. One of SEE_MORE_JOBS, VIEW_MORE, CAREERS_AT_COMPANY.
3415
+ */
3416
+ preApproved?: string;
3417
+ /**
3418
+ * Free text, reviewed by LinkedIn.
3419
+ */
3420
+ custom?: string;
3421
+ };
3422
+ logoUrl?: string;
3423
+ organizationName?: string;
3424
+ /**
3425
+ * Defaults to true.
3426
+ */
3427
+ showMemberProfilePhoto?: boolean;
3428
+ };
3392
3429
  /**
3393
3430
  * POST /v1/ads/create only. Classic right-rail Text Ad. The copy lives
3394
3431
  * here; ad-level body and headline are not used. Mutually exclusive
@@ -3404,6 +3441,57 @@ type LinkedInAdsPlatformData = {
3404
3441
  */
3405
3442
  imageUrl?: string;
3406
3443
  };
3444
+ /**
3445
+ * POST /v1/ads/create only. Conversation Ad: a choose-your-path message
3446
+ * tree delivered to the member's LinkedIn inbox. Messages are flat
3447
+ * nodes wired by local ids; each button either opens a url or leads to
3448
+ * nextMessageId. Cycles, unknown ids and a missing firstMessageId
3449
+ * return a 400. LinkedIn does not deliver message ads to EU members.
3450
+ * Mutually exclusive with the other creative sources.
3451
+ *
3452
+ */
3453
+ conversation?: {
3454
+ /**
3455
+ * InMail subject shown in the inbox.
3456
+ */
3457
+ subject: string;
3458
+ /**
3459
+ * Person or organization URN. Defaults to the authoring Company
3460
+ * Page. The sender must be approved for the ad account first
3461
+ * (Campaign Manager > Manage message ad senders) or LinkedIn
3462
+ * rejects the create with SINMAIL_SENDER_NOT_APPROVED.
3463
+ *
3464
+ */
3465
+ sender?: string;
3466
+ /**
3467
+ * Optional intro body (HTML allowed).
3468
+ */
3469
+ body?: string;
3470
+ /**
3471
+ * Terms shown at the bottom of the message.
3472
+ */
3473
+ footer?: string;
3474
+ /**
3475
+ * Conversation headline. Defaults to the first message's first line.
3476
+ */
3477
+ headline?: string;
3478
+ firstMessageId: string;
3479
+ messages: Array<{
3480
+ id: string;
3481
+ text: string;
3482
+ buttons?: Array<{
3483
+ text: string;
3484
+ /**
3485
+ * Continues the conversation at this message. Exactly one of nextMessageId or url.
3486
+ */
3487
+ nextMessageId?: string;
3488
+ /**
3489
+ * Opens this landing page. Exactly one of nextMessageId or url.
3490
+ */
3491
+ url?: string;
3492
+ }>;
3493
+ }>;
3494
+ };
3407
3495
  /**
3408
3496
  * POST /v1/ads/create only. Promotes an existing LinkedIn Event; no
3409
3497
  * headline needed. Mutually exclusive with the other creative sources.
@@ -23246,9 +23334,25 @@ type CreateStandaloneAdData = {
23246
23334
  }>;
23247
23335
  };
23248
23336
  /**
23249
- * Required on legacy + multi-creative shapes. Inherited from the ad set on the attach shape. Available goals vary by platform. Meta-specific: `conversions` (OUTCOME_SALES) requires `promotedObject.pixelId` + `promotedObject.customEventType` (use a commerce event, e.g. PURCHASE, START_TRIAL); `lead_conversion` (OUTCOME_LEADS, website pixel leads) requires the same pixel + event but with a leads-class event (e.g. LEAD, SUBMIT_APPLICATION, SCHEDULE, CONTACT) — these are rejected under `conversions` because Meta gates conversion events by objective; `lead_generation` is OUTCOME_LEADS with instant forms (`leadGenFormId`), distinct from `lead_conversion`'s website pixel optimization; `app_promotion` requires `promotedObject.applicationId` + `promotedObject.objectStoreUrl`; `catalog_sales` (Advantage+ catalog ads, e.g. vehicle inventory) requires `promotedObject.productSetId` + `promotedObject.pixelId` + `promotedObject.customEventType` and builds a catalog TEMPLATE creative from the copy fields (headline/body/description/linkUrl/callToAction, which may carry catalog template tags like {{product.name}} or {{vehicle.make}}) — no imageUrl/video is sent, Meta renders the visuals per catalog item; discover catalogs via GET /v1/ads/catalogs and product sets via GET /v1/ads/catalogs/{catalogId}/product-sets; single shape only (no creatives[]/adSetId/dynamicCreative/placementAssets); `lead_generation` accepts an optional `promotedObject.pageId` (auto-filled from the connected Page when omitted). TikTok-specific: `conversions` (website-conversion ad group) requires `promotedObject.pixelId` (your TikTok Pixel ID) and accepts an optional `promotedObject.customEventType` (a TikTok `optimization_event` code like `ON_WEB_ORDER`, `INITIATE_ORDER`, `ON_WEB_REGISTER`, `FORM`); to inherit a pixel + event from an existing ad group, pass `adSetId` instead. LinkedIn-specific: `engagement`, `traffic`, `awareness`, and `video_views` are supported for standalone ads (creates a Direct Sponsored Content single image or single video ad). `traffic` requires `linkUrl`; `video_views` requires the `video` field. For `lead_generation` / `conversions` on LinkedIn — or to promote an existing post — use `POST /v1/ads/boost`.
23337
+ * Required on legacy and multi-creative shapes; the attach shape inherits it from the ad set. Available goals vary by platform.
23338
+ *
23339
+ * **Meta**
23340
+ * - `conversions`: OUTCOME_SALES. Requires `promotedObject.pixelId` and `promotedObject.customEventType` with a commerce event such as PURCHASE or START_TRIAL.
23341
+ * - `lead_conversion`: OUTCOME_LEADS optimizing website pixel leads. Same pixel and event fields, but with a leads-class event such as LEAD, SUBMIT_APPLICATION, SCHEDULE or CONTACT. Meta gates conversion events by objective, so leads-class events are rejected under `conversions`.
23342
+ * - `lead_generation`: OUTCOME_LEADS with instant forms. Requires `leadGenFormId`. `promotedObject.pageId` is optional and auto-filled from the connected Page.
23343
+ * - `app_promotion`: requires `promotedObject.applicationId` and `promotedObject.objectStoreUrl`.
23344
+ * - `catalog_sales`: Advantage+ catalog ads, for example vehicle inventory. Requires `promotedObject.productSetId`, `promotedObject.pixelId` and `promotedObject.customEventType`. Builds a catalog TEMPLATE creative from the copy fields, which may carry template tags like {{product.name}} or {{vehicle.make}}. No imageUrl or video is sent; Meta renders the visuals per catalog item. Discover catalogs via GET /v1/ads/catalogs and product sets via GET /v1/ads/catalogs/{catalogId}/product-sets. Single shape only, no creatives[], adSetId, dynamicCreative or placementAssets.
23345
+ *
23346
+ * **TikTok**
23347
+ * - `conversions`: website-conversion ad group. Requires `promotedObject.pixelId`, your TikTok Pixel ID. Accepts an optional `promotedObject.customEventType` with a TikTok optimization_event code such as ON_WEB_ORDER, INITIATE_ORDER, ON_WEB_REGISTER or FORM. To inherit pixel and event from an existing ad group, pass `adSetId` instead.
23348
+ *
23349
+ * **LinkedIn**
23350
+ * - `engagement`, `traffic`, `awareness` and `video_views` create standalone Direct Sponsored Content ads. `traffic` requires `linkUrl`; `video_views` requires `video`.
23351
+ * - `job_applicants` requires a `platformSpecificData.jobs` creative.
23352
+ * - For `lead_generation` or `conversions` on LinkedIn, or to promote an existing post, use POST /v1/ads/boost.
23353
+ *
23250
23354
  */
23251
- goal?: 'engagement' | 'traffic' | 'awareness' | 'video_views' | 'lead_generation' | 'lead_conversion' | 'conversions' | 'app_promotion' | 'catalog_sales';
23355
+ goal?: 'engagement' | 'traffic' | 'awareness' | 'video_views' | 'lead_generation' | 'lead_conversion' | 'conversions' | 'app_promotion' | 'catalog_sales' | 'job_applicants';
23252
23356
  /**
23253
23357
  * 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.
23254
23358
  */
package/dist/index.d.ts CHANGED
@@ -961,7 +961,7 @@ type Ad = {
961
961
  /**
962
962
  * Available goals vary by platform. Meta (Facebook/Instagram) supports all 9 (incl. `lead_conversion` = website pixel lead optimization and `catalog_sales` = Advantage+ catalog ads). TikTok supports the 7 non-`lead_conversion` goals. LinkedIn supports all except app_promotion / lead_conversion. Twitter/X supports engagement, traffic, awareness, video_views, app_promotion. Pinterest and Google Ads support only engagement, traffic, awareness, video_views.
963
963
  */
964
- goal?: 'engagement' | 'traffic' | 'awareness' | 'video_views' | 'lead_generation' | 'lead_conversion' | 'conversions' | 'app_promotion' | 'catalog_sales';
964
+ goal?: 'engagement' | 'traffic' | 'awareness' | 'video_views' | 'lead_generation' | 'lead_conversion' | 'conversions' | 'app_promotion' | 'catalog_sales' | 'job_applicants';
965
965
  /**
966
966
  * True for ads synced from platform ad managers
967
967
  */
@@ -1154,7 +1154,7 @@ type adType = 'boost' | 'standalone';
1154
1154
  /**
1155
1155
  * Available goals vary by platform. Meta (Facebook/Instagram) supports all 9 (incl. `lead_conversion` = website pixel lead optimization and `catalog_sales` = Advantage+ catalog ads). TikTok supports the 7 non-`lead_conversion` goals. LinkedIn supports all except app_promotion / lead_conversion. Twitter/X supports engagement, traffic, awareness, video_views, app_promotion. Pinterest and Google Ads support only engagement, traffic, awareness, video_views.
1156
1156
  */
1157
- type goal = 'engagement' | 'traffic' | 'awareness' | 'video_views' | 'lead_generation' | 'lead_conversion' | 'conversions' | 'app_promotion' | 'catalog_sales';
1157
+ type goal = 'engagement' | 'traffic' | 'awareness' | 'video_views' | 'lead_generation' | 'lead_conversion' | 'conversions' | 'app_promotion' | 'catalog_sales' | 'job_applicants';
1158
1158
  type type = 'daily' | 'lifetime';
1159
1159
  /**
1160
1160
  * Budget amount in the ad account's native currency (see the campaign's `currency` field for the code).
@@ -3389,6 +3389,43 @@ type LinkedInAdsPlatformData = {
3389
3389
  */
3390
3390
  showMemberProfilePhoto?: boolean;
3391
3391
  };
3392
+ /**
3393
+ * POST /v1/ads/create only. Dynamic Jobs Ad promoting your open roles,
3394
+ * personalized with the viewer's profile photo. Requires goal
3395
+ * job_applicants and a Company Page with active job postings.
3396
+ * headline and buttonLabel take exactly one of
3397
+ * preApproved or custom. logoUrl and organizationName default to the
3398
+ * Company Page's. Mutually exclusive with the other creative sources.
3399
+ *
3400
+ */
3401
+ jobs?: {
3402
+ headline: {
3403
+ /**
3404
+ * LinkedIn preset id, not reviewed. Example MEMBER_READY_FOR_YOUR_DREAM_JOB.
3405
+ */
3406
+ preApproved?: string;
3407
+ /**
3408
+ * Free text, reviewed by LinkedIn.
3409
+ */
3410
+ custom?: string;
3411
+ };
3412
+ buttonLabel: {
3413
+ /**
3414
+ * LinkedIn preset id, not reviewed. One of SEE_MORE_JOBS, VIEW_MORE, CAREERS_AT_COMPANY.
3415
+ */
3416
+ preApproved?: string;
3417
+ /**
3418
+ * Free text, reviewed by LinkedIn.
3419
+ */
3420
+ custom?: string;
3421
+ };
3422
+ logoUrl?: string;
3423
+ organizationName?: string;
3424
+ /**
3425
+ * Defaults to true.
3426
+ */
3427
+ showMemberProfilePhoto?: boolean;
3428
+ };
3392
3429
  /**
3393
3430
  * POST /v1/ads/create only. Classic right-rail Text Ad. The copy lives
3394
3431
  * here; ad-level body and headline are not used. Mutually exclusive
@@ -3404,6 +3441,57 @@ type LinkedInAdsPlatformData = {
3404
3441
  */
3405
3442
  imageUrl?: string;
3406
3443
  };
3444
+ /**
3445
+ * POST /v1/ads/create only. Conversation Ad: a choose-your-path message
3446
+ * tree delivered to the member's LinkedIn inbox. Messages are flat
3447
+ * nodes wired by local ids; each button either opens a url or leads to
3448
+ * nextMessageId. Cycles, unknown ids and a missing firstMessageId
3449
+ * return a 400. LinkedIn does not deliver message ads to EU members.
3450
+ * Mutually exclusive with the other creative sources.
3451
+ *
3452
+ */
3453
+ conversation?: {
3454
+ /**
3455
+ * InMail subject shown in the inbox.
3456
+ */
3457
+ subject: string;
3458
+ /**
3459
+ * Person or organization URN. Defaults to the authoring Company
3460
+ * Page. The sender must be approved for the ad account first
3461
+ * (Campaign Manager > Manage message ad senders) or LinkedIn
3462
+ * rejects the create with SINMAIL_SENDER_NOT_APPROVED.
3463
+ *
3464
+ */
3465
+ sender?: string;
3466
+ /**
3467
+ * Optional intro body (HTML allowed).
3468
+ */
3469
+ body?: string;
3470
+ /**
3471
+ * Terms shown at the bottom of the message.
3472
+ */
3473
+ footer?: string;
3474
+ /**
3475
+ * Conversation headline. Defaults to the first message's first line.
3476
+ */
3477
+ headline?: string;
3478
+ firstMessageId: string;
3479
+ messages: Array<{
3480
+ id: string;
3481
+ text: string;
3482
+ buttons?: Array<{
3483
+ text: string;
3484
+ /**
3485
+ * Continues the conversation at this message. Exactly one of nextMessageId or url.
3486
+ */
3487
+ nextMessageId?: string;
3488
+ /**
3489
+ * Opens this landing page. Exactly one of nextMessageId or url.
3490
+ */
3491
+ url?: string;
3492
+ }>;
3493
+ }>;
3494
+ };
3407
3495
  /**
3408
3496
  * POST /v1/ads/create only. Promotes an existing LinkedIn Event; no
3409
3497
  * headline needed. Mutually exclusive with the other creative sources.
@@ -23246,9 +23334,25 @@ type CreateStandaloneAdData = {
23246
23334
  }>;
23247
23335
  };
23248
23336
  /**
23249
- * Required on legacy + multi-creative shapes. Inherited from the ad set on the attach shape. Available goals vary by platform. Meta-specific: `conversions` (OUTCOME_SALES) requires `promotedObject.pixelId` + `promotedObject.customEventType` (use a commerce event, e.g. PURCHASE, START_TRIAL); `lead_conversion` (OUTCOME_LEADS, website pixel leads) requires the same pixel + event but with a leads-class event (e.g. LEAD, SUBMIT_APPLICATION, SCHEDULE, CONTACT) — these are rejected under `conversions` because Meta gates conversion events by objective; `lead_generation` is OUTCOME_LEADS with instant forms (`leadGenFormId`), distinct from `lead_conversion`'s website pixel optimization; `app_promotion` requires `promotedObject.applicationId` + `promotedObject.objectStoreUrl`; `catalog_sales` (Advantage+ catalog ads, e.g. vehicle inventory) requires `promotedObject.productSetId` + `promotedObject.pixelId` + `promotedObject.customEventType` and builds a catalog TEMPLATE creative from the copy fields (headline/body/description/linkUrl/callToAction, which may carry catalog template tags like {{product.name}} or {{vehicle.make}}) — no imageUrl/video is sent, Meta renders the visuals per catalog item; discover catalogs via GET /v1/ads/catalogs and product sets via GET /v1/ads/catalogs/{catalogId}/product-sets; single shape only (no creatives[]/adSetId/dynamicCreative/placementAssets); `lead_generation` accepts an optional `promotedObject.pageId` (auto-filled from the connected Page when omitted). TikTok-specific: `conversions` (website-conversion ad group) requires `promotedObject.pixelId` (your TikTok Pixel ID) and accepts an optional `promotedObject.customEventType` (a TikTok `optimization_event` code like `ON_WEB_ORDER`, `INITIATE_ORDER`, `ON_WEB_REGISTER`, `FORM`); to inherit a pixel + event from an existing ad group, pass `adSetId` instead. LinkedIn-specific: `engagement`, `traffic`, `awareness`, and `video_views` are supported for standalone ads (creates a Direct Sponsored Content single image or single video ad). `traffic` requires `linkUrl`; `video_views` requires the `video` field. For `lead_generation` / `conversions` on LinkedIn — or to promote an existing post — use `POST /v1/ads/boost`.
23337
+ * Required on legacy and multi-creative shapes; the attach shape inherits it from the ad set. Available goals vary by platform.
23338
+ *
23339
+ * **Meta**
23340
+ * - `conversions`: OUTCOME_SALES. Requires `promotedObject.pixelId` and `promotedObject.customEventType` with a commerce event such as PURCHASE or START_TRIAL.
23341
+ * - `lead_conversion`: OUTCOME_LEADS optimizing website pixel leads. Same pixel and event fields, but with a leads-class event such as LEAD, SUBMIT_APPLICATION, SCHEDULE or CONTACT. Meta gates conversion events by objective, so leads-class events are rejected under `conversions`.
23342
+ * - `lead_generation`: OUTCOME_LEADS with instant forms. Requires `leadGenFormId`. `promotedObject.pageId` is optional and auto-filled from the connected Page.
23343
+ * - `app_promotion`: requires `promotedObject.applicationId` and `promotedObject.objectStoreUrl`.
23344
+ * - `catalog_sales`: Advantage+ catalog ads, for example vehicle inventory. Requires `promotedObject.productSetId`, `promotedObject.pixelId` and `promotedObject.customEventType`. Builds a catalog TEMPLATE creative from the copy fields, which may carry template tags like {{product.name}} or {{vehicle.make}}. No imageUrl or video is sent; Meta renders the visuals per catalog item. Discover catalogs via GET /v1/ads/catalogs and product sets via GET /v1/ads/catalogs/{catalogId}/product-sets. Single shape only, no creatives[], adSetId, dynamicCreative or placementAssets.
23345
+ *
23346
+ * **TikTok**
23347
+ * - `conversions`: website-conversion ad group. Requires `promotedObject.pixelId`, your TikTok Pixel ID. Accepts an optional `promotedObject.customEventType` with a TikTok optimization_event code such as ON_WEB_ORDER, INITIATE_ORDER, ON_WEB_REGISTER or FORM. To inherit pixel and event from an existing ad group, pass `adSetId` instead.
23348
+ *
23349
+ * **LinkedIn**
23350
+ * - `engagement`, `traffic`, `awareness` and `video_views` create standalone Direct Sponsored Content ads. `traffic` requires `linkUrl`; `video_views` requires `video`.
23351
+ * - `job_applicants` requires a `platformSpecificData.jobs` creative.
23352
+ * - For `lead_generation` or `conversions` on LinkedIn, or to promote an existing post, use POST /v1/ads/boost.
23353
+ *
23250
23354
  */
23251
- goal?: 'engagement' | 'traffic' | 'awareness' | 'video_views' | 'lead_generation' | 'lead_conversion' | 'conversions' | 'app_promotion' | 'catalog_sales';
23355
+ goal?: 'engagement' | 'traffic' | 'awareness' | 'video_views' | 'lead_generation' | 'lead_conversion' | 'conversions' | 'app_promotion' | 'catalog_sales' | 'job_applicants';
23252
23356
  /**
23253
23357
  * 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.
23254
23358
  */
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.355",
39
+ version: "0.2.356",
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.355",
8
+ version: "0.2.356",
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.355",
3
+ "version": "0.2.356",
4
4
  "description": "The official Node.js library for the Zernio API",
5
5
  "main": "dist/index.js",
6
6
  "module": "dist/index.mjs",
@@ -92,7 +92,7 @@ export type Ad = {
92
92
  /**
93
93
  * Available goals vary by platform. Meta (Facebook/Instagram) supports all 9 (incl. `lead_conversion` = website pixel lead optimization and `catalog_sales` = Advantage+ catalog ads). TikTok supports the 7 non-`lead_conversion` goals. LinkedIn supports all except app_promotion / lead_conversion. Twitter/X supports engagement, traffic, awareness, video_views, app_promotion. Pinterest and Google Ads support only engagement, traffic, awareness, video_views.
94
94
  */
95
- goal?: 'engagement' | 'traffic' | 'awareness' | 'video_views' | 'lead_generation' | 'lead_conversion' | 'conversions' | 'app_promotion' | 'catalog_sales';
95
+ goal?: 'engagement' | 'traffic' | 'awareness' | 'video_views' | 'lead_generation' | 'lead_conversion' | 'conversions' | 'app_promotion' | 'catalog_sales' | 'job_applicants';
96
96
  /**
97
97
  * True for ads synced from platform ad managers
98
98
  */
@@ -288,7 +288,7 @@ export type adType = 'boost' | 'standalone';
288
288
  /**
289
289
  * Available goals vary by platform. Meta (Facebook/Instagram) supports all 9 (incl. `lead_conversion` = website pixel lead optimization and `catalog_sales` = Advantage+ catalog ads). TikTok supports the 7 non-`lead_conversion` goals. LinkedIn supports all except app_promotion / lead_conversion. Twitter/X supports engagement, traffic, awareness, video_views, app_promotion. Pinterest and Google Ads support only engagement, traffic, awareness, video_views.
290
290
  */
291
- export type goal = 'engagement' | 'traffic' | 'awareness' | 'video_views' | 'lead_generation' | 'lead_conversion' | 'conversions' | 'app_promotion' | 'catalog_sales';
291
+ export type goal = 'engagement' | 'traffic' | 'awareness' | 'video_views' | 'lead_generation' | 'lead_conversion' | 'conversions' | 'app_promotion' | 'catalog_sales' | 'job_applicants';
292
292
 
293
293
  export type type = 'daily' | 'lifetime';
294
294
 
@@ -2607,6 +2607,43 @@ export type LinkedInAdsPlatformData = {
2607
2607
  */
2608
2608
  showMemberProfilePhoto?: boolean;
2609
2609
  };
2610
+ /**
2611
+ * POST /v1/ads/create only. Dynamic Jobs Ad promoting your open roles,
2612
+ * personalized with the viewer's profile photo. Requires goal
2613
+ * job_applicants and a Company Page with active job postings.
2614
+ * headline and buttonLabel take exactly one of
2615
+ * preApproved or custom. logoUrl and organizationName default to the
2616
+ * Company Page's. Mutually exclusive with the other creative sources.
2617
+ *
2618
+ */
2619
+ jobs?: {
2620
+ headline: {
2621
+ /**
2622
+ * LinkedIn preset id, not reviewed. Example MEMBER_READY_FOR_YOUR_DREAM_JOB.
2623
+ */
2624
+ preApproved?: string;
2625
+ /**
2626
+ * Free text, reviewed by LinkedIn.
2627
+ */
2628
+ custom?: string;
2629
+ };
2630
+ buttonLabel: {
2631
+ /**
2632
+ * LinkedIn preset id, not reviewed. One of SEE_MORE_JOBS, VIEW_MORE, CAREERS_AT_COMPANY.
2633
+ */
2634
+ preApproved?: string;
2635
+ /**
2636
+ * Free text, reviewed by LinkedIn.
2637
+ */
2638
+ custom?: string;
2639
+ };
2640
+ logoUrl?: string;
2641
+ organizationName?: string;
2642
+ /**
2643
+ * Defaults to true.
2644
+ */
2645
+ showMemberProfilePhoto?: boolean;
2646
+ };
2610
2647
  /**
2611
2648
  * POST /v1/ads/create only. Classic right-rail Text Ad. The copy lives
2612
2649
  * here; ad-level body and headline are not used. Mutually exclusive
@@ -2622,6 +2659,57 @@ export type LinkedInAdsPlatformData = {
2622
2659
  */
2623
2660
  imageUrl?: string;
2624
2661
  };
2662
+ /**
2663
+ * POST /v1/ads/create only. Conversation Ad: a choose-your-path message
2664
+ * tree delivered to the member's LinkedIn inbox. Messages are flat
2665
+ * nodes wired by local ids; each button either opens a url or leads to
2666
+ * nextMessageId. Cycles, unknown ids and a missing firstMessageId
2667
+ * return a 400. LinkedIn does not deliver message ads to EU members.
2668
+ * Mutually exclusive with the other creative sources.
2669
+ *
2670
+ */
2671
+ conversation?: {
2672
+ /**
2673
+ * InMail subject shown in the inbox.
2674
+ */
2675
+ subject: string;
2676
+ /**
2677
+ * Person or organization URN. Defaults to the authoring Company
2678
+ * Page. The sender must be approved for the ad account first
2679
+ * (Campaign Manager > Manage message ad senders) or LinkedIn
2680
+ * rejects the create with SINMAIL_SENDER_NOT_APPROVED.
2681
+ *
2682
+ */
2683
+ sender?: string;
2684
+ /**
2685
+ * Optional intro body (HTML allowed).
2686
+ */
2687
+ body?: string;
2688
+ /**
2689
+ * Terms shown at the bottom of the message.
2690
+ */
2691
+ footer?: string;
2692
+ /**
2693
+ * Conversation headline. Defaults to the first message's first line.
2694
+ */
2695
+ headline?: string;
2696
+ firstMessageId: string;
2697
+ messages: Array<{
2698
+ id: string;
2699
+ text: string;
2700
+ buttons?: Array<{
2701
+ text: string;
2702
+ /**
2703
+ * Continues the conversation at this message. Exactly one of nextMessageId or url.
2704
+ */
2705
+ nextMessageId?: string;
2706
+ /**
2707
+ * Opens this landing page. Exactly one of nextMessageId or url.
2708
+ */
2709
+ url?: string;
2710
+ }>;
2711
+ }>;
2712
+ };
2625
2713
  /**
2626
2714
  * POST /v1/ads/create only. Promotes an existing LinkedIn Event; no
2627
2715
  * headline needed. Mutually exclusive with the other creative sources.
@@ -23900,9 +23988,25 @@ export type CreateStandaloneAdData = {
23900
23988
  }>;
23901
23989
  };
23902
23990
  /**
23903
- * Required on legacy + multi-creative shapes. Inherited from the ad set on the attach shape. Available goals vary by platform. Meta-specific: `conversions` (OUTCOME_SALES) requires `promotedObject.pixelId` + `promotedObject.customEventType` (use a commerce event, e.g. PURCHASE, START_TRIAL); `lead_conversion` (OUTCOME_LEADS, website pixel leads) requires the same pixel + event but with a leads-class event (e.g. LEAD, SUBMIT_APPLICATION, SCHEDULE, CONTACT) — these are rejected under `conversions` because Meta gates conversion events by objective; `lead_generation` is OUTCOME_LEADS with instant forms (`leadGenFormId`), distinct from `lead_conversion`'s website pixel optimization; `app_promotion` requires `promotedObject.applicationId` + `promotedObject.objectStoreUrl`; `catalog_sales` (Advantage+ catalog ads, e.g. vehicle inventory) requires `promotedObject.productSetId` + `promotedObject.pixelId` + `promotedObject.customEventType` and builds a catalog TEMPLATE creative from the copy fields (headline/body/description/linkUrl/callToAction, which may carry catalog template tags like {{product.name}} or {{vehicle.make}}) — no imageUrl/video is sent, Meta renders the visuals per catalog item; discover catalogs via GET /v1/ads/catalogs and product sets via GET /v1/ads/catalogs/{catalogId}/product-sets; single shape only (no creatives[]/adSetId/dynamicCreative/placementAssets); `lead_generation` accepts an optional `promotedObject.pageId` (auto-filled from the connected Page when omitted). TikTok-specific: `conversions` (website-conversion ad group) requires `promotedObject.pixelId` (your TikTok Pixel ID) and accepts an optional `promotedObject.customEventType` (a TikTok `optimization_event` code like `ON_WEB_ORDER`, `INITIATE_ORDER`, `ON_WEB_REGISTER`, `FORM`); to inherit a pixel + event from an existing ad group, pass `adSetId` instead. LinkedIn-specific: `engagement`, `traffic`, `awareness`, and `video_views` are supported for standalone ads (creates a Direct Sponsored Content single image or single video ad). `traffic` requires `linkUrl`; `video_views` requires the `video` field. For `lead_generation` / `conversions` on LinkedIn — or to promote an existing post — use `POST /v1/ads/boost`.
23991
+ * Required on legacy and multi-creative shapes; the attach shape inherits it from the ad set. Available goals vary by platform.
23992
+ *
23993
+ * **Meta**
23994
+ * - `conversions`: OUTCOME_SALES. Requires `promotedObject.pixelId` and `promotedObject.customEventType` with a commerce event such as PURCHASE or START_TRIAL.
23995
+ * - `lead_conversion`: OUTCOME_LEADS optimizing website pixel leads. Same pixel and event fields, but with a leads-class event such as LEAD, SUBMIT_APPLICATION, SCHEDULE or CONTACT. Meta gates conversion events by objective, so leads-class events are rejected under `conversions`.
23996
+ * - `lead_generation`: OUTCOME_LEADS with instant forms. Requires `leadGenFormId`. `promotedObject.pageId` is optional and auto-filled from the connected Page.
23997
+ * - `app_promotion`: requires `promotedObject.applicationId` and `promotedObject.objectStoreUrl`.
23998
+ * - `catalog_sales`: Advantage+ catalog ads, for example vehicle inventory. Requires `promotedObject.productSetId`, `promotedObject.pixelId` and `promotedObject.customEventType`. Builds a catalog TEMPLATE creative from the copy fields, which may carry template tags like {{product.name}} or {{vehicle.make}}. No imageUrl or video is sent; Meta renders the visuals per catalog item. Discover catalogs via GET /v1/ads/catalogs and product sets via GET /v1/ads/catalogs/{catalogId}/product-sets. Single shape only, no creatives[], adSetId, dynamicCreative or placementAssets.
23999
+ *
24000
+ * **TikTok**
24001
+ * - `conversions`: website-conversion ad group. Requires `promotedObject.pixelId`, your TikTok Pixel ID. Accepts an optional `promotedObject.customEventType` with a TikTok optimization_event code such as ON_WEB_ORDER, INITIATE_ORDER, ON_WEB_REGISTER or FORM. To inherit pixel and event from an existing ad group, pass `adSetId` instead.
24002
+ *
24003
+ * **LinkedIn**
24004
+ * - `engagement`, `traffic`, `awareness` and `video_views` create standalone Direct Sponsored Content ads. `traffic` requires `linkUrl`; `video_views` requires `video`.
24005
+ * - `job_applicants` requires a `platformSpecificData.jobs` creative.
24006
+ * - For `lead_generation` or `conversions` on LinkedIn, or to promote an existing post, use POST /v1/ads/boost.
24007
+ *
23904
24008
  */
23905
- goal?: 'engagement' | 'traffic' | 'awareness' | 'video_views' | 'lead_generation' | 'lead_conversion' | 'conversions' | 'app_promotion' | 'catalog_sales';
24009
+ goal?: 'engagement' | 'traffic' | 'awareness' | 'video_views' | 'lead_generation' | 'lead_conversion' | 'conversions' | 'app_promotion' | 'catalog_sales' | 'job_applicants';
23906
24010
  /**
23907
24011
  * 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.
23908
24012
  */