@zernio/node 0.2.541 → 0.2.542

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
@@ -5036,11 +5036,11 @@ type MediaUploadResponse = {
5036
5036
  type MetaAdsPlatformData = {
5037
5037
  bidStrategy?: BidStrategy;
5038
5038
  /**
5039
- * Whole currency units (USD: 5 = $5.00). Required when bidStrategy is LOWEST_COST_WITH_BID_CAP or COST_CAP.
5039
+ * Whole currency units (USD: 5 = $5.00). Required when bidStrategy is LOWEST_COST_WITH_BID_CAP or COST_CAP. May also be sent alone, WITHOUT bidStrategy, to set the cap on an ad set joining a COST_CAP / LOWEST_COST_WITH_BID_CAP campaign (the strategy is inherited from the campaign). On POST /v1/ads/create that shape requires existingCampaignId and is a 400 otherwise; on POST /v1/ads/boost it is promoted to LOWEST_COST_WITH_BID_CAP.
5040
5040
  */
5041
5041
  bidAmount?: number;
5042
5042
  /**
5043
- * Decimal ROAS multiplier (2.0 = 2.0x). Required when bidStrategy is LOWEST_COST_WITH_MIN_ROAS.
5043
+ * Decimal ROAS multiplier (2.0 = 2.0x). Required when bidStrategy is LOWEST_COST_WITH_MIN_ROAS; sending it without bidStrategy is a 400.
5044
5044
  */
5045
5045
  roasAverageFloor?: number;
5046
5046
  };
@@ -26407,7 +26407,7 @@ type CreateAdCampaignData = {
26407
26407
  */
26408
26408
  bidStrategy?: 'LOWEST_COST_WITHOUT_CAP' | 'LOWEST_COST_WITH_BID_CAP' | 'COST_CAP' | 'LOWEST_COST_WITH_MIN_ROAS';
26409
26409
  /**
26410
- * Whole currency units (USD: 5 = $5.00). Required for LOWEST_COST_WITH_BID_CAP and COST_CAP; ignored otherwise.
26410
+ * Whole currency units (USD: 5 = $5.00). Required for LOWEST_COST_WITH_BID_CAP and COST_CAP; ignored otherwise. Validated here but NOT stored by Meta: the campaign object has no bid_amount field, only bid_strategy lives on it. The amount takes effect once an ad set joins this campaign (existingCampaignId on POST /v1/ads/create) and supplies its own bidAmount there.
26411
26411
  */
26412
26412
  bidAmount?: number;
26413
26413
  /**
@@ -26794,7 +26794,10 @@ type UpdateAdSetData = {
26794
26794
  /**
26795
26795
  * Bid cap in WHOLE currency units (USD: 5 = $5.00; JPY: 100 = ¥100). Required when
26796
26796
  * bidStrategy is LOWEST_COST_WITH_BID_CAP or COST_CAP. Internally converted to Meta's
26797
- * smallest-denomination integer, or (on OpenAI) to micros (× 1,000,000).
26797
+ * smallest-denomination integer, or (on OpenAI) to micros (× 1,000,000). Meta only:
26798
+ * may be sent alone, WITHOUT bidStrategy, to update the cap amount on an ad set whose
26799
+ * parent campaign is COST_CAP or LOWEST_COST_WITH_BID_CAP (the strategy is inherited
26800
+ * from the campaign and is left untouched).
26798
26801
  *
26799
26802
  */
26800
26803
  bidAmount?: number;
@@ -29747,7 +29750,14 @@ type CreateStandaloneAdData = {
29747
29750
  * Deprecated: send it inside `platformSpecificData` instead (Meta today; TikTok's nested shape is planned). The flat field keeps working during the deprecation window; sending both shapes returns a 400.
29748
29751
  *
29749
29752
  * Bid cap in WHOLE currency units (USD: 5 = $5.00; JPY: 100 = ¥100). Required when
29750
- * `bidStrategy` is `LOWEST_COST_WITH_BID_CAP` or `COST_CAP`.
29753
+ * `bidStrategy` is `LOWEST_COST_WITH_BID_CAP` or `COST_CAP`. Meta only: sending
29754
+ * `bidAmount` WITHOUT `bidStrategy` requires `existingCampaignId` (400 otherwise),
29755
+ * and sets the new ad set's cap under the joined campaign's COST_CAP /
29756
+ * LOWEST_COST_WITH_BID_CAP parent. The strategy itself is inherited from the
29757
+ * campaign. Restating bidStrategy here is accepted but has no effect on the ad set.
29758
+ *
29759
+ * Rejected with 400 in `adSetId` attach mode: that shape inherits its cap from
29760
+ * the platform. Use `PUT /v1/ads/ad-sets/{adSetId}` there instead.
29751
29761
  *
29752
29762
  * @deprecated
29753
29763
  */
@@ -29756,8 +29766,11 @@ type CreateStandaloneAdData = {
29756
29766
  * Deprecated: send it inside `platformSpecificData` instead (Meta today; TikTok's nested shape is planned). The flat field keeps working during the deprecation window; sending both shapes returns a 400.
29757
29767
  *
29758
29768
  * Minimum ROAS as a decimal multiplier (e.g. 2.0 = 2.0x ROAS). Required when
29759
- * `bidStrategy` is `LOWEST_COST_WITH_MIN_ROAS`. Sent to Meta as
29760
- * `bid_constraints.roas_average_floor` × 10000.
29769
+ * `bidStrategy` is `LOWEST_COST_WITH_MIN_ROAS`. Sending it without `bidStrategy`
29770
+ * is a 400. Sent to Meta as
29771
+ * `bid_constraints.roas_average_floor` × 10000. Known gap: a CBO campaign's
29772
+ * ROAS floor lives on the campaign only (set via `POST /v1/ads/campaigns`);
29773
+ * there is no supported way to set it while joining a CBO campaign here.
29761
29774
  *
29762
29775
  * @deprecated
29763
29776
  */
@@ -29797,7 +29810,8 @@ type CreateStandaloneAdData = {
29797
29810
  * **Meta**: `bidStrategy`, `bidAmount` and `roasAverageFloor` may be
29798
29811
  * sent here instead of at the root — the preferred home going forward.
29799
29812
  * Sending the bid fields in BOTH places returns a 400
29800
- * (`mutually_exclusive_fields`).
29813
+ * (`mutually_exclusive_fields`), and sending any of them in
29814
+ * `adSetId` attach mode is a 400 too (the ad set already has its bid).
29801
29815
  *
29802
29816
  */
29803
29817
  platformSpecificData?: (LinkedInAdsPlatformData | MetaAdsPlatformData);
package/dist/index.d.ts CHANGED
@@ -5036,11 +5036,11 @@ type MediaUploadResponse = {
5036
5036
  type MetaAdsPlatformData = {
5037
5037
  bidStrategy?: BidStrategy;
5038
5038
  /**
5039
- * Whole currency units (USD: 5 = $5.00). Required when bidStrategy is LOWEST_COST_WITH_BID_CAP or COST_CAP.
5039
+ * Whole currency units (USD: 5 = $5.00). Required when bidStrategy is LOWEST_COST_WITH_BID_CAP or COST_CAP. May also be sent alone, WITHOUT bidStrategy, to set the cap on an ad set joining a COST_CAP / LOWEST_COST_WITH_BID_CAP campaign (the strategy is inherited from the campaign). On POST /v1/ads/create that shape requires existingCampaignId and is a 400 otherwise; on POST /v1/ads/boost it is promoted to LOWEST_COST_WITH_BID_CAP.
5040
5040
  */
5041
5041
  bidAmount?: number;
5042
5042
  /**
5043
- * Decimal ROAS multiplier (2.0 = 2.0x). Required when bidStrategy is LOWEST_COST_WITH_MIN_ROAS.
5043
+ * Decimal ROAS multiplier (2.0 = 2.0x). Required when bidStrategy is LOWEST_COST_WITH_MIN_ROAS; sending it without bidStrategy is a 400.
5044
5044
  */
5045
5045
  roasAverageFloor?: number;
5046
5046
  };
@@ -26407,7 +26407,7 @@ type CreateAdCampaignData = {
26407
26407
  */
26408
26408
  bidStrategy?: 'LOWEST_COST_WITHOUT_CAP' | 'LOWEST_COST_WITH_BID_CAP' | 'COST_CAP' | 'LOWEST_COST_WITH_MIN_ROAS';
26409
26409
  /**
26410
- * Whole currency units (USD: 5 = $5.00). Required for LOWEST_COST_WITH_BID_CAP and COST_CAP; ignored otherwise.
26410
+ * Whole currency units (USD: 5 = $5.00). Required for LOWEST_COST_WITH_BID_CAP and COST_CAP; ignored otherwise. Validated here but NOT stored by Meta: the campaign object has no bid_amount field, only bid_strategy lives on it. The amount takes effect once an ad set joins this campaign (existingCampaignId on POST /v1/ads/create) and supplies its own bidAmount there.
26411
26411
  */
26412
26412
  bidAmount?: number;
26413
26413
  /**
@@ -26794,7 +26794,10 @@ type UpdateAdSetData = {
26794
26794
  /**
26795
26795
  * Bid cap in WHOLE currency units (USD: 5 = $5.00; JPY: 100 = ¥100). Required when
26796
26796
  * bidStrategy is LOWEST_COST_WITH_BID_CAP or COST_CAP. Internally converted to Meta's
26797
- * smallest-denomination integer, or (on OpenAI) to micros (× 1,000,000).
26797
+ * smallest-denomination integer, or (on OpenAI) to micros (× 1,000,000). Meta only:
26798
+ * may be sent alone, WITHOUT bidStrategy, to update the cap amount on an ad set whose
26799
+ * parent campaign is COST_CAP or LOWEST_COST_WITH_BID_CAP (the strategy is inherited
26800
+ * from the campaign and is left untouched).
26798
26801
  *
26799
26802
  */
26800
26803
  bidAmount?: number;
@@ -29747,7 +29750,14 @@ type CreateStandaloneAdData = {
29747
29750
  * Deprecated: send it inside `platformSpecificData` instead (Meta today; TikTok's nested shape is planned). The flat field keeps working during the deprecation window; sending both shapes returns a 400.
29748
29751
  *
29749
29752
  * Bid cap in WHOLE currency units (USD: 5 = $5.00; JPY: 100 = ¥100). Required when
29750
- * `bidStrategy` is `LOWEST_COST_WITH_BID_CAP` or `COST_CAP`.
29753
+ * `bidStrategy` is `LOWEST_COST_WITH_BID_CAP` or `COST_CAP`. Meta only: sending
29754
+ * `bidAmount` WITHOUT `bidStrategy` requires `existingCampaignId` (400 otherwise),
29755
+ * and sets the new ad set's cap under the joined campaign's COST_CAP /
29756
+ * LOWEST_COST_WITH_BID_CAP parent. The strategy itself is inherited from the
29757
+ * campaign. Restating bidStrategy here is accepted but has no effect on the ad set.
29758
+ *
29759
+ * Rejected with 400 in `adSetId` attach mode: that shape inherits its cap from
29760
+ * the platform. Use `PUT /v1/ads/ad-sets/{adSetId}` there instead.
29751
29761
  *
29752
29762
  * @deprecated
29753
29763
  */
@@ -29756,8 +29766,11 @@ type CreateStandaloneAdData = {
29756
29766
  * Deprecated: send it inside `platformSpecificData` instead (Meta today; TikTok's nested shape is planned). The flat field keeps working during the deprecation window; sending both shapes returns a 400.
29757
29767
  *
29758
29768
  * Minimum ROAS as a decimal multiplier (e.g. 2.0 = 2.0x ROAS). Required when
29759
- * `bidStrategy` is `LOWEST_COST_WITH_MIN_ROAS`. Sent to Meta as
29760
- * `bid_constraints.roas_average_floor` × 10000.
29769
+ * `bidStrategy` is `LOWEST_COST_WITH_MIN_ROAS`. Sending it without `bidStrategy`
29770
+ * is a 400. Sent to Meta as
29771
+ * `bid_constraints.roas_average_floor` × 10000. Known gap: a CBO campaign's
29772
+ * ROAS floor lives on the campaign only (set via `POST /v1/ads/campaigns`);
29773
+ * there is no supported way to set it while joining a CBO campaign here.
29761
29774
  *
29762
29775
  * @deprecated
29763
29776
  */
@@ -29797,7 +29810,8 @@ type CreateStandaloneAdData = {
29797
29810
  * **Meta**: `bidStrategy`, `bidAmount` and `roasAverageFloor` may be
29798
29811
  * sent here instead of at the root — the preferred home going forward.
29799
29812
  * Sending the bid fields in BOTH places returns a 400
29800
- * (`mutually_exclusive_fields`).
29813
+ * (`mutually_exclusive_fields`), and sending any of them in
29814
+ * `adSetId` attach mode is a 400 too (the ad set already has its bid).
29801
29815
  *
29802
29816
  */
29803
29817
  platformSpecificData?: (LinkedInAdsPlatformData | MetaAdsPlatformData);
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.541",
39
+ version: "0.2.542",
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.541",
8
+ version: "0.2.542",
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.541",
3
+ "version": "0.2.542",
4
4
  "description": "The official Node.js library for the Zernio API",
5
5
  "main": "dist/index.js",
6
6
  "module": "dist/index.mjs",
@@ -7175,6 +7175,10 @@ export const getAdSetDetails = <ThrowOnError extends boolean = false>(options: O
7175
7175
  * - `LOWEST_COST_WITHOUT_CAP`: no `bidAmount`, no `roasAverageFloor`.
7176
7176
  * - `LOWEST_COST_WITH_BID_CAP` / `COST_CAP`: `bidAmount` REQUIRED (whole currency units).
7177
7177
  * - `LOWEST_COST_WITH_MIN_ROAS`: `roasAverageFloor` REQUIRED (decimal multiplier, e.g. 2.0 = 2.0x ROAS).
7178
+ * - Meta only: send `bidAmount` WITHOUT `bidStrategy` to change the cap amount on an ad set
7179
+ * under a COST_CAP / LOWEST_COST_WITH_BID_CAP parent campaign, leaving the strategy itself
7180
+ * (inherited from the campaign) untouched. `roasAverageFloor` without `bidStrategy` is
7181
+ * rejected (it has no meaning outside LOWEST_COST_WITH_MIN_ROAS).
7178
7182
  *
7179
7183
  * Delivery settings are validated by Meta against the campaign objective;
7180
7184
  * incompatible combinations (e.g. a billingEvent the optimization goal
@@ -3921,11 +3921,11 @@ export type MediaUploadResponse = {
3921
3921
  export type MetaAdsPlatformData = {
3922
3922
  bidStrategy?: BidStrategy;
3923
3923
  /**
3924
- * Whole currency units (USD: 5 = $5.00). Required when bidStrategy is LOWEST_COST_WITH_BID_CAP or COST_CAP.
3924
+ * Whole currency units (USD: 5 = $5.00). Required when bidStrategy is LOWEST_COST_WITH_BID_CAP or COST_CAP. May also be sent alone, WITHOUT bidStrategy, to set the cap on an ad set joining a COST_CAP / LOWEST_COST_WITH_BID_CAP campaign (the strategy is inherited from the campaign). On POST /v1/ads/create that shape requires existingCampaignId and is a 400 otherwise; on POST /v1/ads/boost it is promoted to LOWEST_COST_WITH_BID_CAP.
3925
3925
  */
3926
3926
  bidAmount?: number;
3927
3927
  /**
3928
- * Decimal ROAS multiplier (2.0 = 2.0x). Required when bidStrategy is LOWEST_COST_WITH_MIN_ROAS.
3928
+ * Decimal ROAS multiplier (2.0 = 2.0x). Required when bidStrategy is LOWEST_COST_WITH_MIN_ROAS; sending it without bidStrategy is a 400.
3929
3929
  */
3930
3930
  roasAverageFloor?: number;
3931
3931
  };
@@ -26785,7 +26785,7 @@ export type CreateAdCampaignData = {
26785
26785
  */
26786
26786
  bidStrategy?: 'LOWEST_COST_WITHOUT_CAP' | 'LOWEST_COST_WITH_BID_CAP' | 'COST_CAP' | 'LOWEST_COST_WITH_MIN_ROAS';
26787
26787
  /**
26788
- * Whole currency units (USD: 5 = $5.00). Required for LOWEST_COST_WITH_BID_CAP and COST_CAP; ignored otherwise.
26788
+ * Whole currency units (USD: 5 = $5.00). Required for LOWEST_COST_WITH_BID_CAP and COST_CAP; ignored otherwise. Validated here but NOT stored by Meta: the campaign object has no bid_amount field, only bid_strategy lives on it. The amount takes effect once an ad set joins this campaign (existingCampaignId on POST /v1/ads/create) and supplies its own bidAmount there.
26789
26789
  */
26790
26790
  bidAmount?: number;
26791
26791
  /**
@@ -27199,7 +27199,10 @@ export type UpdateAdSetData = {
27199
27199
  /**
27200
27200
  * Bid cap in WHOLE currency units (USD: 5 = $5.00; JPY: 100 = ¥100). Required when
27201
27201
  * bidStrategy is LOWEST_COST_WITH_BID_CAP or COST_CAP. Internally converted to Meta's
27202
- * smallest-denomination integer, or (on OpenAI) to micros (× 1,000,000).
27202
+ * smallest-denomination integer, or (on OpenAI) to micros (× 1,000,000). Meta only:
27203
+ * may be sent alone, WITHOUT bidStrategy, to update the cap amount on an ad set whose
27204
+ * parent campaign is COST_CAP or LOWEST_COST_WITH_BID_CAP (the strategy is inherited
27205
+ * from the campaign and is left untouched).
27203
27206
  *
27204
27207
  */
27205
27208
  bidAmount?: number;
@@ -30293,7 +30296,14 @@ export type CreateStandaloneAdData = {
30293
30296
  * Deprecated: send it inside `platformSpecificData` instead (Meta today; TikTok's nested shape is planned). The flat field keeps working during the deprecation window; sending both shapes returns a 400.
30294
30297
  *
30295
30298
  * Bid cap in WHOLE currency units (USD: 5 = $5.00; JPY: 100 = ¥100). Required when
30296
- * `bidStrategy` is `LOWEST_COST_WITH_BID_CAP` or `COST_CAP`.
30299
+ * `bidStrategy` is `LOWEST_COST_WITH_BID_CAP` or `COST_CAP`. Meta only: sending
30300
+ * `bidAmount` WITHOUT `bidStrategy` requires `existingCampaignId` (400 otherwise),
30301
+ * and sets the new ad set's cap under the joined campaign's COST_CAP /
30302
+ * LOWEST_COST_WITH_BID_CAP parent. The strategy itself is inherited from the
30303
+ * campaign. Restating bidStrategy here is accepted but has no effect on the ad set.
30304
+ *
30305
+ * Rejected with 400 in `adSetId` attach mode: that shape inherits its cap from
30306
+ * the platform. Use `PUT /v1/ads/ad-sets/{adSetId}` there instead.
30297
30307
  *
30298
30308
  * @deprecated
30299
30309
  */
@@ -30302,8 +30312,11 @@ export type CreateStandaloneAdData = {
30302
30312
  * Deprecated: send it inside `platformSpecificData` instead (Meta today; TikTok's nested shape is planned). The flat field keeps working during the deprecation window; sending both shapes returns a 400.
30303
30313
  *
30304
30314
  * Minimum ROAS as a decimal multiplier (e.g. 2.0 = 2.0x ROAS). Required when
30305
- * `bidStrategy` is `LOWEST_COST_WITH_MIN_ROAS`. Sent to Meta as
30306
- * `bid_constraints.roas_average_floor` × 10000.
30315
+ * `bidStrategy` is `LOWEST_COST_WITH_MIN_ROAS`. Sending it without `bidStrategy`
30316
+ * is a 400. Sent to Meta as
30317
+ * `bid_constraints.roas_average_floor` × 10000. Known gap: a CBO campaign's
30318
+ * ROAS floor lives on the campaign only (set via `POST /v1/ads/campaigns`);
30319
+ * there is no supported way to set it while joining a CBO campaign here.
30307
30320
  *
30308
30321
  * @deprecated
30309
30322
  */
@@ -30343,7 +30356,8 @@ export type CreateStandaloneAdData = {
30343
30356
  * **Meta**: `bidStrategy`, `bidAmount` and `roasAverageFloor` may be
30344
30357
  * sent here instead of at the root — the preferred home going forward.
30345
30358
  * Sending the bid fields in BOTH places returns a 400
30346
- * (`mutually_exclusive_fields`).
30359
+ * (`mutually_exclusive_fields`), and sending any of them in
30360
+ * `adSetId` attach mode is a 400 too (the ad set already has its bid).
30347
30361
  *
30348
30362
  */
30349
30363
  platformSpecificData?: (LinkedInAdsPlatformData | MetaAdsPlatformData);