@zernio/node 0.2.1509 → 0.2.1511

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
@@ -52141,9 +52141,9 @@ type ListAdCampaignsData = {
52141
52141
  */
52142
52142
  source?: 'zernio' | 'all';
52143
52143
  /**
52144
- * Filter by derived campaign status (post-aggregation)
52144
+ * Filter by derived campaign status (post-aggregation). `not_deleted` keeps every status except `cancelled`.
52145
52145
  */
52146
- status?: AdStatus;
52146
+ status?: (AdStatus | 'not_deleted');
52147
52147
  /**
52148
52148
  * End of metrics date range (YYYY-MM-DD, inclusive). Defaults to today. Max 730-day range.
52149
52149
  */
@@ -54052,9 +54052,9 @@ type GetAdTreeData = {
54052
54052
  */
54053
54053
  source?: 'zernio' | 'all';
54054
54054
  /**
54055
- * Filter by derived campaign status (post-aggregation)
54055
+ * Filter by derived campaign status (post-aggregation). `not_deleted` keeps every status except `cancelled`.
54056
54056
  */
54057
- status?: AdStatus;
54057
+ status?: (AdStatus | 'not_deleted');
54058
54058
  /**
54059
54059
  * Set to `1` to also return a daily breakdown (mirrors Meta Insights' `time_increment=1`). Only `1` (daily) is supported. See `dailyLevel` to control which levels carry it.
54060
54060
  *
@@ -57133,6 +57133,14 @@ type CreateAdCreativeData = {
57133
57133
  description?: string;
57134
57134
  callToAction?: string;
57135
57135
  }>;
57136
+ /**
57137
+ * Meta only. The Instagram account the creative runs as, mapped to `instagram_user_id`: an id from `GET /v1/ads/instagram-accounts`, including a Page-backed one.
57138
+ *
57139
+ * - Given, it is never swapped. One the ad account cannot use returns 400 `insufficient_permissions` on `instagramAccountId`.
57140
+ * - Omitted, it uses the account linked to the Page. When the ad account has no access to that one, it retries once with an authorized Instagram account, or returns 422 on `instagramAccountId` when there is none.
57141
+ *
57142
+ */
57143
+ instagramAccountId?: string;
57136
57144
  /**
57137
57145
  * Only with `carouselCards` (a 400 without them). Sets `link_data.multi_share_optimized`:
57138
57146
  *
@@ -59883,7 +59891,7 @@ type CreateStandaloneAdData = {
59883
59891
  */
59884
59892
  adSetName?: string;
59885
59893
  /**
59886
- * Meta only. Exact ad name (the single-creative ad object's name). Overrides the default, which is `name`. (For per-ad names on the multi-creative shape, set `name` on each `creatives[]` entry instead.)
59894
+ * Meta only. Exact ad name, overriding the default `name`. On the multi-creative shape it names every ad, numbered `#1`, `#2`... when there are several, unless a `creatives[]` entry sets its own `name`.
59887
59895
  */
59888
59896
  adName?: string;
59889
59897
  tracking?: AdTracking;
package/dist/index.d.ts CHANGED
@@ -52141,9 +52141,9 @@ type ListAdCampaignsData = {
52141
52141
  */
52142
52142
  source?: 'zernio' | 'all';
52143
52143
  /**
52144
- * Filter by derived campaign status (post-aggregation)
52144
+ * Filter by derived campaign status (post-aggregation). `not_deleted` keeps every status except `cancelled`.
52145
52145
  */
52146
- status?: AdStatus;
52146
+ status?: (AdStatus | 'not_deleted');
52147
52147
  /**
52148
52148
  * End of metrics date range (YYYY-MM-DD, inclusive). Defaults to today. Max 730-day range.
52149
52149
  */
@@ -54052,9 +54052,9 @@ type GetAdTreeData = {
54052
54052
  */
54053
54053
  source?: 'zernio' | 'all';
54054
54054
  /**
54055
- * Filter by derived campaign status (post-aggregation)
54055
+ * Filter by derived campaign status (post-aggregation). `not_deleted` keeps every status except `cancelled`.
54056
54056
  */
54057
- status?: AdStatus;
54057
+ status?: (AdStatus | 'not_deleted');
54058
54058
  /**
54059
54059
  * Set to `1` to also return a daily breakdown (mirrors Meta Insights' `time_increment=1`). Only `1` (daily) is supported. See `dailyLevel` to control which levels carry it.
54060
54060
  *
@@ -57133,6 +57133,14 @@ type CreateAdCreativeData = {
57133
57133
  description?: string;
57134
57134
  callToAction?: string;
57135
57135
  }>;
57136
+ /**
57137
+ * Meta only. The Instagram account the creative runs as, mapped to `instagram_user_id`: an id from `GET /v1/ads/instagram-accounts`, including a Page-backed one.
57138
+ *
57139
+ * - Given, it is never swapped. One the ad account cannot use returns 400 `insufficient_permissions` on `instagramAccountId`.
57140
+ * - Omitted, it uses the account linked to the Page. When the ad account has no access to that one, it retries once with an authorized Instagram account, or returns 422 on `instagramAccountId` when there is none.
57141
+ *
57142
+ */
57143
+ instagramAccountId?: string;
57136
57144
  /**
57137
57145
  * Only with `carouselCards` (a 400 without them). Sets `link_data.multi_share_optimized`:
57138
57146
  *
@@ -59883,7 +59891,7 @@ type CreateStandaloneAdData = {
59883
59891
  */
59884
59892
  adSetName?: string;
59885
59893
  /**
59886
- * Meta only. Exact ad name (the single-creative ad object's name). Overrides the default, which is `name`. (For per-ad names on the multi-creative shape, set `name` on each `creatives[]` entry instead.)
59894
+ * Meta only. Exact ad name, overriding the default `name`. On the multi-creative shape it names every ad, numbered `#1`, `#2`... when there are several, unless a `creatives[]` entry sets its own `name`.
59887
59895
  */
59888
59896
  adName?: string;
59889
59897
  tracking?: AdTracking;
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.1509",
39
+ version: "0.2.1511",
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.1509",
8
+ version: "0.2.1511",
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.1509",
3
+ "version": "0.2.1511",
4
4
  "description": "The official Node.js library for the Zernio API",
5
5
  "main": "dist/index.js",
6
6
  "module": "dist/index.mjs",
@@ -13691,7 +13691,7 @@ export const updateAdSetStatus = <ThrowOnError extends boolean = false>(options:
13691
13691
  *
13692
13692
  * Deleting an ad or a campaign is a soft delete: the Ad documents move to `status: cancelled` and are kept indefinitely. Their historical spend still counts toward the metrics of any date range they fall in. There is no pruning job and no retention window.
13693
13693
  *
13694
- * Filter on `status` if your view should hide them, but do that after reading the totals, not before.
13694
+ * Pass `status=not_deleted` if your view should hide them, but do that after reading the totals, not before.
13695
13695
  *
13696
13696
  */
13697
13697
  export const getAdTree = <ThrowOnError extends boolean = false>(options?: OptionsLegacyParser<GetAdTreeData, ThrowOnError>) => {
@@ -15399,7 +15399,7 @@ export const listAdCreatives = <ThrowOnError extends boolean = false>(options: O
15399
15399
  *
15400
15400
  * ### Other fields
15401
15401
  *
15402
- * - The Page (and linked Instagram account, when present) is resolved from `accountId` as the story actor.
15402
+ * - The Page (and linked Instagram account, when present) is resolved from `accountId` as the story actor. `instagramAccountId` overrides the Instagram account.
15403
15403
  * - `creativeFeatures` configures Advantage+ enhancements.
15404
15404
  * - `promotion` is not supported and any object is rejected with 400.
15405
15405
  *
@@ -52938,9 +52938,9 @@ export type ListAdCampaignsData = {
52938
52938
  */
52939
52939
  source?: 'zernio' | 'all';
52940
52940
  /**
52941
- * Filter by derived campaign status (post-aggregation)
52941
+ * Filter by derived campaign status (post-aggregation). `not_deleted` keeps every status except `cancelled`.
52942
52942
  */
52943
- status?: AdStatus;
52943
+ status?: (AdStatus | 'not_deleted');
52944
52944
  /**
52945
52945
  * End of metrics date range (YYYY-MM-DD, inclusive). Defaults to today. Max 730-day range.
52946
52946
  */
@@ -54921,9 +54921,9 @@ export type GetAdTreeData = {
54921
54921
  */
54922
54922
  source?: 'zernio' | 'all';
54923
54923
  /**
54924
- * Filter by derived campaign status (post-aggregation)
54924
+ * Filter by derived campaign status (post-aggregation). `not_deleted` keeps every status except `cancelled`.
54925
54925
  */
54926
- status?: AdStatus;
54926
+ status?: (AdStatus | 'not_deleted');
54927
54927
  /**
54928
54928
  * Set to `1` to also return a daily breakdown (mirrors Meta Insights' `time_increment=1`). Only `1` (daily) is supported. See `dailyLevel` to control which levels carry it.
54929
54929
  *
@@ -58191,6 +58191,14 @@ export type CreateAdCreativeData = {
58191
58191
  description?: string;
58192
58192
  callToAction?: string;
58193
58193
  }>;
58194
+ /**
58195
+ * Meta only. The Instagram account the creative runs as, mapped to `instagram_user_id`: an id from `GET /v1/ads/instagram-accounts`, including a Page-backed one.
58196
+ *
58197
+ * - Given, it is never swapped. One the ad account cannot use returns 400 `insufficient_permissions` on `instagramAccountId`.
58198
+ * - Omitted, it uses the account linked to the Page. When the ad account has no access to that one, it retries once with an authorized Instagram account, or returns 422 on `instagramAccountId` when there is none.
58199
+ *
58200
+ */
58201
+ instagramAccountId?: string;
58194
58202
  /**
58195
58203
  * Only with `carouselCards` (a 400 without them). Sets `link_data.multi_share_optimized`:
58196
58204
  *
@@ -61115,7 +61123,7 @@ export type CreateStandaloneAdData = {
61115
61123
  */
61116
61124
  adSetName?: string;
61117
61125
  /**
61118
- * Meta only. Exact ad name (the single-creative ad object's name). Overrides the default, which is `name`. (For per-ad names on the multi-creative shape, set `name` on each `creatives[]` entry instead.)
61126
+ * Meta only. Exact ad name, overriding the default `name`. On the multi-creative shape it names every ad, numbered `#1`, `#2`... when there are several, unless a `creatives[]` entry sets its own `name`.
61119
61127
  */
61120
61128
  adName?: string;
61121
61129
  tracking?: AdTracking;