@zernio/node 0.2.1035 → 0.2.1037

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
@@ -4825,6 +4825,14 @@ type CommentAutomationAudience = {
4825
4825
  *
4826
4826
  */
4827
4827
  whenUnknown?: 'send' | 'skip' | 'verify';
4828
+ /**
4829
+ * Send `followGate.message` with its button to EVERY commenter and deliver the real
4830
+ * DM when they tap it, with no follow check at any point. Cannot be combined with a
4831
+ * `followerStatus` other than `any` or with `minFollowerCount` (400); `whenUnknown`
4832
+ * is ignored. Instagram only. A PATCH that sends `audience` without this field clears it.
4833
+ *
4834
+ */
4835
+ tapToUnlock?: boolean;
4828
4836
  };
4829
4837
  type followerStatus = 'any' | 'follower' | 'non_follower';
4830
4838
  /**
@@ -4842,11 +4850,11 @@ type whenUnknown = 'send' | 'skip' | 'verify';
4842
4850
  */
4843
4851
  type CommentAutomationFollowGate = {
4844
4852
  /**
4845
- * Confirmation DM sent when whenUnknown=verify.
4853
+ * Confirmation DM sent when whenUnknown=verify or tapToUnlock=true. The default copy asks for a follow under whenUnknown=verify and only for the tap under tapToUnlock.
4846
4854
  */
4847
4855
  message?: string;
4848
4856
  /**
4849
- * Confirm button label. Defaults to "I'm following".
4857
+ * Confirm button label. Defaults to "I'm following" (whenUnknown=verify) or "Unlock" (tapToUnlock).
4850
4858
  */
4851
4859
  buttonLabel?: string;
4852
4860
  /**
@@ -6094,7 +6102,7 @@ type CtwaAdRequestBody = {
6094
6102
  [key: string]: unknown;
6095
6103
  };
6096
6104
  /**
6097
- * Meta behavior ids. Each dimension is its own flexible_spec entry: OR within, AND across.
6105
+ * Behavior ids from /v1/ads/targeting/search?dimension=behavior. Meta: each dimension is its own flexible_spec entry (OR within, AND across). TikTok: video/creator interaction categories, sent as the ad group's actions.
6098
6106
  */
6099
6107
  behaviors?: Array<{
6100
6108
  id: string;
@@ -11610,7 +11618,7 @@ type TargetingSpec = {
11610
11618
  name?: string;
11611
11619
  }>;
11612
11620
  /**
11613
- * Behaviour entities from /v1/ads/targeting/search?dimension=behavior. Supported on Meta only (TikTok behaviours are rejected with a 400).
11621
+ * Behaviour entities from /v1/ads/targeting/search?dimension=behavior (Meta and TikTok). On TikTok they target people who interacted with videos (watched to the end, liked, commented or shared, last 15 days) or creators (followed or viewed the profile) in the picked categories, and the ad group uses the TikTok placement only.
11614
11622
  */
11615
11623
  behaviors?: Array<{
11616
11624
  id: string;
@@ -45476,7 +45484,7 @@ type CreateStandaloneAdData = {
45476
45484
  address?: string;
45477
45485
  }>;
45478
45486
  /**
45479
- * Behaviour entities from /v1/ads/targeting/search?dimension=behavior. Supported on Meta only (TikTok behaviours are rejected with a 400). Each must include id.
45487
+ * Behaviour entities from /v1/ads/targeting/search?dimension=behavior (Meta and TikTok). On TikTok they target people who interacted with videos (watched to the end, liked, commented or shared, last 15 days) or creators (followed or viewed the profile) in the picked categories, and the ad group uses the TikTok placement only. Each must include id.
45480
45488
  */
45481
45489
  behaviors?: Array<{
45482
45490
  id: string;
package/dist/index.d.ts CHANGED
@@ -4825,6 +4825,14 @@ type CommentAutomationAudience = {
4825
4825
  *
4826
4826
  */
4827
4827
  whenUnknown?: 'send' | 'skip' | 'verify';
4828
+ /**
4829
+ * Send `followGate.message` with its button to EVERY commenter and deliver the real
4830
+ * DM when they tap it, with no follow check at any point. Cannot be combined with a
4831
+ * `followerStatus` other than `any` or with `minFollowerCount` (400); `whenUnknown`
4832
+ * is ignored. Instagram only. A PATCH that sends `audience` without this field clears it.
4833
+ *
4834
+ */
4835
+ tapToUnlock?: boolean;
4828
4836
  };
4829
4837
  type followerStatus = 'any' | 'follower' | 'non_follower';
4830
4838
  /**
@@ -4842,11 +4850,11 @@ type whenUnknown = 'send' | 'skip' | 'verify';
4842
4850
  */
4843
4851
  type CommentAutomationFollowGate = {
4844
4852
  /**
4845
- * Confirmation DM sent when whenUnknown=verify.
4853
+ * Confirmation DM sent when whenUnknown=verify or tapToUnlock=true. The default copy asks for a follow under whenUnknown=verify and only for the tap under tapToUnlock.
4846
4854
  */
4847
4855
  message?: string;
4848
4856
  /**
4849
- * Confirm button label. Defaults to "I'm following".
4857
+ * Confirm button label. Defaults to "I'm following" (whenUnknown=verify) or "Unlock" (tapToUnlock).
4850
4858
  */
4851
4859
  buttonLabel?: string;
4852
4860
  /**
@@ -6094,7 +6102,7 @@ type CtwaAdRequestBody = {
6094
6102
  [key: string]: unknown;
6095
6103
  };
6096
6104
  /**
6097
- * Meta behavior ids. Each dimension is its own flexible_spec entry: OR within, AND across.
6105
+ * Behavior ids from /v1/ads/targeting/search?dimension=behavior. Meta: each dimension is its own flexible_spec entry (OR within, AND across). TikTok: video/creator interaction categories, sent as the ad group's actions.
6098
6106
  */
6099
6107
  behaviors?: Array<{
6100
6108
  id: string;
@@ -11610,7 +11618,7 @@ type TargetingSpec = {
11610
11618
  name?: string;
11611
11619
  }>;
11612
11620
  /**
11613
- * Behaviour entities from /v1/ads/targeting/search?dimension=behavior. Supported on Meta only (TikTok behaviours are rejected with a 400).
11621
+ * Behaviour entities from /v1/ads/targeting/search?dimension=behavior (Meta and TikTok). On TikTok they target people who interacted with videos (watched to the end, liked, commented or shared, last 15 days) or creators (followed or viewed the profile) in the picked categories, and the ad group uses the TikTok placement only.
11614
11622
  */
11615
11623
  behaviors?: Array<{
11616
11624
  id: string;
@@ -45476,7 +45484,7 @@ type CreateStandaloneAdData = {
45476
45484
  address?: string;
45477
45485
  }>;
45478
45486
  /**
45479
- * Behaviour entities from /v1/ads/targeting/search?dimension=behavior. Supported on Meta only (TikTok behaviours are rejected with a 400). Each must include id.
45487
+ * Behaviour entities from /v1/ads/targeting/search?dimension=behavior (Meta and TikTok). On TikTok they target people who interacted with videos (watched to the end, liked, commented or shared, last 15 days) or creators (followed or viewed the profile) in the picked categories, and the ad group uses the TikTok placement only. Each must include id.
45480
45488
  */
45481
45489
  behaviors?: Array<{
45482
45490
  id: 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: "@zernio/node",
39
- version: "0.2.1035",
39
+ version: "0.2.1037",
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.1035",
8
+ version: "0.2.1037",
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.1035",
3
+ "version": "0.2.1037",
4
4
  "description": "The official Node.js library for the Zernio API",
5
5
  "main": "dist/index.js",
6
6
  "module": "dist/index.mjs",
@@ -9041,7 +9041,9 @@ export const listCommentAutomations = <ThrowOnError extends boolean = false>(opt
9041
9041
  * follow relationship for people who have messaged the account, so `audience.whenUnknown`
9042
9042
  * decides what happens for everyone else - including `verify`, which sends a one-tap
9043
9043
  * confirmation DM (`followGate`) and then delivers the real DM automatically. People we
9044
- * already know follow you skip the tap entirely.
9044
+ * already know follow you skip the tap entirely. Set `audience.tapToUnlock: true` instead
9045
+ * to send that button DM to every commenter and deliver the real DM on the tap with no
9046
+ * follow check.
9045
9047
  *
9046
9048
  * Set `alsoMatchInDms: true` on a `comment` automation to also answer people who send
9047
9049
  * a keyword as a direct message instead of commenting it. One automation then covers
@@ -11999,8 +12001,11 @@ export const searchAdInterests = <ThrowOnError extends boolean = false>(options:
11999
12001
  *
12000
12002
  * - `geo`: locations, further scoped by `geoType`
12001
12003
  * - `interest`
12002
- * - `behavior`: Meta-only, matched by name against Meta's fixed behaviors catalog
12003
- * (e.g. `Small business owners`, `Frequent Travelers`); ids feed `TargetingSpec.behaviors`
12004
+ * - `behavior`: Meta and TikTok, matched by name; ids feed `TargetingSpec.behaviors`.
12005
+ * Meta: its fixed behaviors catalog (e.g. `Small business owners`, `Frequent Travelers`).
12006
+ * TikTok: video and creator interaction categories (e.g. `Software & Apps`), with ids like
12007
+ * `video:1913101` or `creator:24001` and `path` starting with `Video interactions` or
12008
+ * `Creator interactions`
12004
12009
  * - `income`: the household-income tiers the platform can target (Meta, TikTok, Google).
12005
12010
  * The id is the normalized tier (`top_5`, `top_10`, `top_10_25`, `top_25_50`) to pass as
12006
12011
  * `TargetingSpec.incomeTier`, never a platform segment id. Meta's tiers are US-only
@@ -2986,6 +2986,14 @@ export type CommentAutomationAudience = {
2986
2986
  *
2987
2987
  */
2988
2988
  whenUnknown?: 'send' | 'skip' | 'verify';
2989
+ /**
2990
+ * Send `followGate.message` with its button to EVERY commenter and deliver the real
2991
+ * DM when they tap it, with no follow check at any point. Cannot be combined with a
2992
+ * `followerStatus` other than `any` or with `minFollowerCount` (400); `whenUnknown`
2993
+ * is ignored. Instagram only. A PATCH that sends `audience` without this field clears it.
2994
+ *
2995
+ */
2996
+ tapToUnlock?: boolean;
2989
2997
  };
2990
2998
 
2991
2999
  export type followerStatus = 'any' | 'follower' | 'non_follower';
@@ -3006,11 +3014,11 @@ export type whenUnknown = 'send' | 'skip' | 'verify';
3006
3014
  */
3007
3015
  export type CommentAutomationFollowGate = {
3008
3016
  /**
3009
- * Confirmation DM sent when whenUnknown=verify.
3017
+ * Confirmation DM sent when whenUnknown=verify or tapToUnlock=true. The default copy asks for a follow under whenUnknown=verify and only for the tap under tapToUnlock.
3010
3018
  */
3011
3019
  message?: string;
3012
3020
  /**
3013
- * Confirm button label. Defaults to "I'm following".
3021
+ * Confirm button label. Defaults to "I'm following" (whenUnknown=verify) or "Unlock" (tapToUnlock).
3014
3022
  */
3015
3023
  buttonLabel?: string;
3016
3024
  /**
@@ -4302,7 +4310,7 @@ export type CtwaAdRequestBody = {
4302
4310
  [key: string]: unknown;
4303
4311
  };
4304
4312
  /**
4305
- * Meta behavior ids. Each dimension is its own flexible_spec entry: OR within, AND across.
4313
+ * Behavior ids from /v1/ads/targeting/search?dimension=behavior. Meta: each dimension is its own flexible_spec entry (OR within, AND across). TikTok: video/creator interaction categories, sent as the ad group's actions.
4306
4314
  */
4307
4315
  behaviors?: Array<{
4308
4316
  id: string;
@@ -10088,7 +10096,7 @@ export type TargetingSpec = {
10088
10096
  name?: string;
10089
10097
  }>;
10090
10098
  /**
10091
- * Behaviour entities from /v1/ads/targeting/search?dimension=behavior. Supported on Meta only (TikTok behaviours are rejected with a 400).
10099
+ * Behaviour entities from /v1/ads/targeting/search?dimension=behavior (Meta and TikTok). On TikTok they target people who interacted with videos (watched to the end, liked, commented or shared, last 15 days) or creators (followed or viewed the profile) in the picked categories, and the ad group uses the TikTok placement only.
10092
10100
  */
10093
10101
  behaviors?: Array<{
10094
10102
  id: string;
@@ -46205,7 +46213,7 @@ export type CreateStandaloneAdData = {
46205
46213
  address?: string;
46206
46214
  }>;
46207
46215
  /**
46208
- * Behaviour entities from /v1/ads/targeting/search?dimension=behavior. Supported on Meta only (TikTok behaviours are rejected with a 400). Each must include id.
46216
+ * Behaviour entities from /v1/ads/targeting/search?dimension=behavior (Meta and TikTok). On TikTok they target people who interacted with videos (watched to the end, liked, commented or shared, last 15 days) or creators (followed or viewed the profile) in the picked categories, and the ad group uses the TikTok placement only. Each must include id.
46209
46217
  */
46210
46218
  behaviors?: Array<{
46211
46219
  id: string;