@zernio/node 0.2.511 → 0.2.513

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
@@ -5468,6 +5468,10 @@ type SocialAccount = {
5468
5468
  * - wabaId: WhatsApp Business Account ID
5469
5469
  * - phoneNumberId: Meta phone number ID
5470
5470
  *
5471
+ * For LinkedIn accounts, profileData carries the profile details refreshed on each daily snapshot:
5472
+ * - profileData.bio: The member's headline for personal accounts, or the organization description for organization accounts. null when the member has not set one.
5473
+ * - profileData.extraData.vanityName: The member's profile slug, i.e. the /in/{vanityName} segment of profileUrl. Personal accounts only; an organization's own slug is in metadata.organizationInfo.vanityName.
5474
+ *
5471
5475
  */
5472
5476
  metadata?: {
5473
5477
  [key: string]: unknown;
@@ -25837,6 +25841,10 @@ type UpdateAdSetData = {
25837
25841
  promotedObject?: {
25838
25842
  pixelId?: string;
25839
25843
  customEventType?: string;
25844
+ /**
25845
+ * Pixel custom-event name (custom_event_str); requires customEventType OTHER. Same pairing rules as /v1/ads/create.
25846
+ */
25847
+ customEventStr?: string;
25840
25848
  pageId?: string;
25841
25849
  applicationId?: string;
25842
25850
  objectStoreUrl?: string;
@@ -27939,7 +27947,7 @@ type CreateStandaloneAdData = {
27939
27947
  * Required on legacy and multi-creative shapes; the attach shape inherits it from the ad set. Available goals vary by platform.
27940
27948
  *
27941
27949
  * **Meta**
27942
- * - `conversions`: OUTCOME_SALES. Requires `promotedObject.pixelId` and `promotedObject.customEventType` with a commerce event such as PURCHASE or START_TRIAL, or `promotedObject.customConversionId` to optimise against a Custom Conversion instead.
27950
+ * - `conversions`: OUTCOME_SALES. Requires `promotedObject.pixelId` and `promotedObject.customEventType` with a commerce event such as PURCHASE or START_TRIAL, or `promotedObject.customConversionId` to optimise against a Custom Conversion, or `customEventType: OTHER` + `customEventStr` to optimise against a pixel custom event.
27943
27951
  * - `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 (or `promotedObject.customConversionId` to optimise against a Custom Conversion instead). Meta gates conversion events by objective, so leads-class events are rejected under `conversions`.
27944
27952
  * - `lead_generation`: OUTCOME_LEADS with instant forms. Requires `leadGenFormId`. `promotedObject.pageId` is optional and auto-filled from the connected Page.
27945
27953
  * - `app_promotion`: requires `promotedObject.applicationId` and `promotedObject.objectStoreUrl`.
@@ -28739,7 +28747,7 @@ type CreateStandaloneAdData = {
28739
28747
  * Required for goals whose ad-set optimization_goal points at a specific
28740
28748
  * event/page/app (without it Meta rejects the ad-set create with
28741
28749
  * `error_subcode: 1815430` "Please select a promoted object for your ad set"):
28742
- * - `goal: conversions` / `lead_conversion` (OFFSITE_CONVERSIONS): requires `pixelId` + `customEventType`, or `customConversionId` when optimising against a Custom Conversion (the conversion carries its own event definition)
28750
+ * - `goal: conversions` / `lead_conversion` (OFFSITE_CONVERSIONS): requires `pixelId` + `customEventType`, or `customConversionId` when optimising against a Custom Conversion (the conversion carries its own event definition). For a pixel CUSTOM event (one you named yourself in CAPI/Events Manager), send `customEventType: OTHER` + `customEventStr` with the event name.
28743
28751
  * - `goal: app_promotion` (APP_INSTALLS): requires `applicationId` + `objectStoreUrl`
28744
28752
  * - `goal: lead_generation` (LEAD_GENERATION): `pageId` is auto-filled from the connected Page when omitted
28745
28753
  *
@@ -28788,6 +28796,17 @@ type CreateStandaloneAdData = {
28788
28796
  *
28789
28797
  */
28790
28798
  customEventType?: string;
28799
+ /**
28800
+ * Meta only. Pixel custom-event name to optimise against (Meta's
28801
+ * `custom_event_str`), exactly as it appears in Events Manager and in your
28802
+ * CAPI payloads (case-sensitive, not uppercased). Requires
28803
+ * `customEventType: OTHER`, and `OTHER` requires this field (400 either way).
28804
+ * The same as picking a custom event in Ads Manager's conversion-event
28805
+ * dropdown. For rule-based Custom Conversions use `customConversionId`
28806
+ * instead.
28807
+ *
28808
+ */
28809
+ customEventStr?: string;
28791
28810
  /**
28792
28811
  * Facebook Page ID. Used by `goal: lead_generation`. Auto-filled from the
28793
28812
  * connected Page when omitted.
package/dist/index.d.ts CHANGED
@@ -5468,6 +5468,10 @@ type SocialAccount = {
5468
5468
  * - wabaId: WhatsApp Business Account ID
5469
5469
  * - phoneNumberId: Meta phone number ID
5470
5470
  *
5471
+ * For LinkedIn accounts, profileData carries the profile details refreshed on each daily snapshot:
5472
+ * - profileData.bio: The member's headline for personal accounts, or the organization description for organization accounts. null when the member has not set one.
5473
+ * - profileData.extraData.vanityName: The member's profile slug, i.e. the /in/{vanityName} segment of profileUrl. Personal accounts only; an organization's own slug is in metadata.organizationInfo.vanityName.
5474
+ *
5471
5475
  */
5472
5476
  metadata?: {
5473
5477
  [key: string]: unknown;
@@ -25837,6 +25841,10 @@ type UpdateAdSetData = {
25837
25841
  promotedObject?: {
25838
25842
  pixelId?: string;
25839
25843
  customEventType?: string;
25844
+ /**
25845
+ * Pixel custom-event name (custom_event_str); requires customEventType OTHER. Same pairing rules as /v1/ads/create.
25846
+ */
25847
+ customEventStr?: string;
25840
25848
  pageId?: string;
25841
25849
  applicationId?: string;
25842
25850
  objectStoreUrl?: string;
@@ -27939,7 +27947,7 @@ type CreateStandaloneAdData = {
27939
27947
  * Required on legacy and multi-creative shapes; the attach shape inherits it from the ad set. Available goals vary by platform.
27940
27948
  *
27941
27949
  * **Meta**
27942
- * - `conversions`: OUTCOME_SALES. Requires `promotedObject.pixelId` and `promotedObject.customEventType` with a commerce event such as PURCHASE or START_TRIAL, or `promotedObject.customConversionId` to optimise against a Custom Conversion instead.
27950
+ * - `conversions`: OUTCOME_SALES. Requires `promotedObject.pixelId` and `promotedObject.customEventType` with a commerce event such as PURCHASE or START_TRIAL, or `promotedObject.customConversionId` to optimise against a Custom Conversion, or `customEventType: OTHER` + `customEventStr` to optimise against a pixel custom event.
27943
27951
  * - `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 (or `promotedObject.customConversionId` to optimise against a Custom Conversion instead). Meta gates conversion events by objective, so leads-class events are rejected under `conversions`.
27944
27952
  * - `lead_generation`: OUTCOME_LEADS with instant forms. Requires `leadGenFormId`. `promotedObject.pageId` is optional and auto-filled from the connected Page.
27945
27953
  * - `app_promotion`: requires `promotedObject.applicationId` and `promotedObject.objectStoreUrl`.
@@ -28739,7 +28747,7 @@ type CreateStandaloneAdData = {
28739
28747
  * Required for goals whose ad-set optimization_goal points at a specific
28740
28748
  * event/page/app (without it Meta rejects the ad-set create with
28741
28749
  * `error_subcode: 1815430` "Please select a promoted object for your ad set"):
28742
- * - `goal: conversions` / `lead_conversion` (OFFSITE_CONVERSIONS): requires `pixelId` + `customEventType`, or `customConversionId` when optimising against a Custom Conversion (the conversion carries its own event definition)
28750
+ * - `goal: conversions` / `lead_conversion` (OFFSITE_CONVERSIONS): requires `pixelId` + `customEventType`, or `customConversionId` when optimising against a Custom Conversion (the conversion carries its own event definition). For a pixel CUSTOM event (one you named yourself in CAPI/Events Manager), send `customEventType: OTHER` + `customEventStr` with the event name.
28743
28751
  * - `goal: app_promotion` (APP_INSTALLS): requires `applicationId` + `objectStoreUrl`
28744
28752
  * - `goal: lead_generation` (LEAD_GENERATION): `pageId` is auto-filled from the connected Page when omitted
28745
28753
  *
@@ -28788,6 +28796,17 @@ type CreateStandaloneAdData = {
28788
28796
  *
28789
28797
  */
28790
28798
  customEventType?: string;
28799
+ /**
28800
+ * Meta only. Pixel custom-event name to optimise against (Meta's
28801
+ * `custom_event_str`), exactly as it appears in Events Manager and in your
28802
+ * CAPI payloads (case-sensitive, not uppercased). Requires
28803
+ * `customEventType: OTHER`, and `OTHER` requires this field (400 either way).
28804
+ * The same as picking a custom event in Ads Manager's conversion-event
28805
+ * dropdown. For rule-based Custom Conversions use `customConversionId`
28806
+ * instead.
28807
+ *
28808
+ */
28809
+ customEventStr?: string;
28791
28810
  /**
28792
28811
  * Facebook Page ID. Used by `goal: lead_generation`. Auto-filled from the
28793
28812
  * connected Page when omitted.
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: "@zernio/node",
39
- version: "0.2.511",
39
+ version: "0.2.513",
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: "@zernio/node",
8
- version: "0.2.511",
8
+ version: "0.2.513",
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": "@zernio/node",
3
- "version": "0.2.511",
3
+ "version": "0.2.513",
4
4
  "description": "The official Node.js library for the Zernio API",
5
5
  "main": "dist/index.js",
6
6
  "module": "dist/index.mjs",
@@ -4421,6 +4421,10 @@ export type SocialAccount = {
4421
4421
  * - wabaId: WhatsApp Business Account ID
4422
4422
  * - phoneNumberId: Meta phone number ID
4423
4423
  *
4424
+ * For LinkedIn accounts, profileData carries the profile details refreshed on each daily snapshot:
4425
+ * - profileData.bio: The member's headline for personal accounts, or the organization description for organization accounts. null when the member has not set one.
4426
+ * - profileData.extraData.vanityName: The member's profile slug, i.e. the /in/{vanityName} segment of profileUrl. Personal accounts only; an organization's own slug is in metadata.organizationInfo.vanityName.
4427
+ *
4424
4428
  */
4425
4429
  metadata?: {
4426
4430
  [key: string]: unknown;
@@ -26237,6 +26241,10 @@ export type UpdateAdSetData = {
26237
26241
  promotedObject?: {
26238
26242
  pixelId?: string;
26239
26243
  customEventType?: string;
26244
+ /**
26245
+ * Pixel custom-event name (custom_event_str); requires customEventType OTHER. Same pairing rules as /v1/ads/create.
26246
+ */
26247
+ customEventStr?: string;
26240
26248
  pageId?: string;
26241
26249
  applicationId?: string;
26242
26250
  objectStoreUrl?: string;
@@ -28477,7 +28485,7 @@ export type CreateStandaloneAdData = {
28477
28485
  * Required on legacy and multi-creative shapes; the attach shape inherits it from the ad set. Available goals vary by platform.
28478
28486
  *
28479
28487
  * **Meta**
28480
- * - `conversions`: OUTCOME_SALES. Requires `promotedObject.pixelId` and `promotedObject.customEventType` with a commerce event such as PURCHASE or START_TRIAL, or `promotedObject.customConversionId` to optimise against a Custom Conversion instead.
28488
+ * - `conversions`: OUTCOME_SALES. Requires `promotedObject.pixelId` and `promotedObject.customEventType` with a commerce event such as PURCHASE or START_TRIAL, or `promotedObject.customConversionId` to optimise against a Custom Conversion, or `customEventType: OTHER` + `customEventStr` to optimise against a pixel custom event.
28481
28489
  * - `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 (or `promotedObject.customConversionId` to optimise against a Custom Conversion instead). Meta gates conversion events by objective, so leads-class events are rejected under `conversions`.
28482
28490
  * - `lead_generation`: OUTCOME_LEADS with instant forms. Requires `leadGenFormId`. `promotedObject.pageId` is optional and auto-filled from the connected Page.
28483
28491
  * - `app_promotion`: requires `promotedObject.applicationId` and `promotedObject.objectStoreUrl`.
@@ -29277,7 +29285,7 @@ export type CreateStandaloneAdData = {
29277
29285
  * Required for goals whose ad-set optimization_goal points at a specific
29278
29286
  * event/page/app (without it Meta rejects the ad-set create with
29279
29287
  * `error_subcode: 1815430` "Please select a promoted object for your ad set"):
29280
- * - `goal: conversions` / `lead_conversion` (OFFSITE_CONVERSIONS): requires `pixelId` + `customEventType`, or `customConversionId` when optimising against a Custom Conversion (the conversion carries its own event definition)
29288
+ * - `goal: conversions` / `lead_conversion` (OFFSITE_CONVERSIONS): requires `pixelId` + `customEventType`, or `customConversionId` when optimising against a Custom Conversion (the conversion carries its own event definition). For a pixel CUSTOM event (one you named yourself in CAPI/Events Manager), send `customEventType: OTHER` + `customEventStr` with the event name.
29281
29289
  * - `goal: app_promotion` (APP_INSTALLS): requires `applicationId` + `objectStoreUrl`
29282
29290
  * - `goal: lead_generation` (LEAD_GENERATION): `pageId` is auto-filled from the connected Page when omitted
29283
29291
  *
@@ -29326,6 +29334,17 @@ export type CreateStandaloneAdData = {
29326
29334
  *
29327
29335
  */
29328
29336
  customEventType?: string;
29337
+ /**
29338
+ * Meta only. Pixel custom-event name to optimise against (Meta's
29339
+ * `custom_event_str`), exactly as it appears in Events Manager and in your
29340
+ * CAPI payloads (case-sensitive, not uppercased). Requires
29341
+ * `customEventType: OTHER`, and `OTHER` requires this field (400 either way).
29342
+ * The same as picking a custom event in Ads Manager's conversion-event
29343
+ * dropdown. For rule-based Custom Conversions use `customConversionId`
29344
+ * instead.
29345
+ *
29346
+ */
29347
+ customEventStr?: string;
29329
29348
  /**
29330
29349
  * Facebook Page ID. Used by `goal: lead_generation`. Auto-filled from the
29331
29350
  * connected Page when omitted.