@zernio/node 0.2.558 → 0.2.560
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 +40 -1
- package/dist/index.d.ts +40 -1
- package/dist/index.js +1 -1
- package/dist/index.mjs +1 -1
- package/package.json +1 -1
- package/src/generated/types.gen.ts +40 -1
package/dist/index.d.mts
CHANGED
|
@@ -8254,6 +8254,29 @@ type WebhookPayloadMessage = {
|
|
|
8254
8254
|
flow_id?: string;
|
|
8255
8255
|
};
|
|
8256
8256
|
} | null;
|
|
8257
|
+
/**
|
|
8258
|
+
* WhatsApp only. Meta's own reason this message has no
|
|
8259
|
+
* renderable body. Present when Meta attached an error to the
|
|
8260
|
+
* inbound payload; in practice the `unsupported`, `errors` and
|
|
8261
|
+
* `unknown` types (code 131051: message type currently not
|
|
8262
|
+
* supported). `text` on those messages is the fixed
|
|
8263
|
+
* `[Unsupported message]` placeholder.
|
|
8264
|
+
*
|
|
8265
|
+
*/
|
|
8266
|
+
unsupported?: {
|
|
8267
|
+
/**
|
|
8268
|
+
* Meta's numeric error code (e.g. 131051).
|
|
8269
|
+
*/
|
|
8270
|
+
code?: number;
|
|
8271
|
+
/**
|
|
8272
|
+
* Meta's short error title.
|
|
8273
|
+
*/
|
|
8274
|
+
title?: string;
|
|
8275
|
+
/**
|
|
8276
|
+
* Meta's human-readable error detail string.
|
|
8277
|
+
*/
|
|
8278
|
+
details?: string;
|
|
8279
|
+
};
|
|
8257
8280
|
} | null;
|
|
8258
8281
|
/**
|
|
8259
8282
|
* UTC time at which Zernio generated this event (set once when the event payload is built, before delivery is queued). Retries and redeliveries keep the original value, so it reflects the event, not the delivery attempt.
|
|
@@ -26872,11 +26895,19 @@ type ListAdCampaignsData = {
|
|
|
26872
26895
|
* Start of metrics date range (YYYY-MM-DD, inclusive). Defaults to 90 days ago when both date params are omitted.
|
|
26873
26896
|
*/
|
|
26874
26897
|
fromDate?: string;
|
|
26898
|
+
/**
|
|
26899
|
+
* Return only campaigns that delivered between `fromDate` and `toDate` — spend above zero, or impressions served at zero spend. Unlike `status`, which reads a campaign's CURRENT state, this filters on what happened inside the window. Filters the campaign set itself, so `pagination.total` counts only matching campaigns. Mirrors the same filter on /v1/ads/tree.
|
|
26900
|
+
*/
|
|
26901
|
+
hasDelivery?: boolean;
|
|
26875
26902
|
/**
|
|
26876
26903
|
* Meta only. Campaign reads aggregate over ad documents, so a campaign with ZERO ads is normally invisible here — the state the two-step create (campaign, then ads via `existingCampaignId`) leaves behind whenever Meta rejects the ad step. Set true to list those too, with `adCount: 0` and zeroed metrics. Requires `accountId` and `adAccountId`, since an empty campaign has no ad row to resolve a token or ad account from.
|
|
26877
26904
|
*/
|
|
26878
26905
|
includeEmpty?: boolean;
|
|
26879
26906
|
limit?: number;
|
|
26907
|
+
/**
|
|
26908
|
+
* Return only campaigns whose spend between `fromDate` and `toDate` reaches this amount, in each campaign's OWN currency (the `currency` field on the campaign). Implies `hasDelivery`; `minSpend=0` applies no filter. Mirrors the same filter on /v1/ads/tree.
|
|
26909
|
+
*/
|
|
26910
|
+
minSpend?: number;
|
|
26880
26911
|
/**
|
|
26881
26912
|
* Page number (1-based)
|
|
26882
26913
|
*/
|
|
@@ -27459,13 +27490,21 @@ type GetAdTreeData = {
|
|
|
27459
27490
|
*/
|
|
27460
27491
|
dailyLevel?: 'campaign' | 'adset' | 'ad';
|
|
27461
27492
|
/**
|
|
27462
|
-
* Start of the METRICS date range (YYYY-MM-DD).
|
|
27493
|
+
* Start of the METRICS date range (YYYY-MM-DD). On its own it affects only the spend/impression numbers overlaid on each node, not which campaigns are returned — pass `hasDelivery` or `minSpend` to also filter the campaign set to this window. Defaults to 90 days ago.
|
|
27463
27494
|
*/
|
|
27464
27495
|
fromDate?: string;
|
|
27496
|
+
/**
|
|
27497
|
+
* Return only campaigns that delivered between `fromDate` and `toDate` — spend above zero, or impressions served at zero spend. Unlike `status`, which reads a campaign's CURRENT state, this filters on what happened inside the window, so a campaign that spent then and is paused today is still returned. Filters the campaign set itself, so `pagination.total` counts only matching campaigns.
|
|
27498
|
+
*/
|
|
27499
|
+
hasDelivery?: boolean;
|
|
27465
27500
|
/**
|
|
27466
27501
|
* Campaigns per page
|
|
27467
27502
|
*/
|
|
27468
27503
|
limit?: number;
|
|
27504
|
+
/**
|
|
27505
|
+
* Return only campaigns whose spend between `fromDate` and `toDate` reaches this amount. Expressed in each campaign's OWN currency (the `currency` field on the campaign node): spend is stored per ad account in its native currency and one response can span several. Implies `hasDelivery`; `minSpend=0` applies no filter.
|
|
27506
|
+
*/
|
|
27507
|
+
minSpend?: number;
|
|
27469
27508
|
/**
|
|
27470
27509
|
* Page number (1-based)
|
|
27471
27510
|
*/
|
package/dist/index.d.ts
CHANGED
|
@@ -8254,6 +8254,29 @@ type WebhookPayloadMessage = {
|
|
|
8254
8254
|
flow_id?: string;
|
|
8255
8255
|
};
|
|
8256
8256
|
} | null;
|
|
8257
|
+
/**
|
|
8258
|
+
* WhatsApp only. Meta's own reason this message has no
|
|
8259
|
+
* renderable body. Present when Meta attached an error to the
|
|
8260
|
+
* inbound payload; in practice the `unsupported`, `errors` and
|
|
8261
|
+
* `unknown` types (code 131051: message type currently not
|
|
8262
|
+
* supported). `text` on those messages is the fixed
|
|
8263
|
+
* `[Unsupported message]` placeholder.
|
|
8264
|
+
*
|
|
8265
|
+
*/
|
|
8266
|
+
unsupported?: {
|
|
8267
|
+
/**
|
|
8268
|
+
* Meta's numeric error code (e.g. 131051).
|
|
8269
|
+
*/
|
|
8270
|
+
code?: number;
|
|
8271
|
+
/**
|
|
8272
|
+
* Meta's short error title.
|
|
8273
|
+
*/
|
|
8274
|
+
title?: string;
|
|
8275
|
+
/**
|
|
8276
|
+
* Meta's human-readable error detail string.
|
|
8277
|
+
*/
|
|
8278
|
+
details?: string;
|
|
8279
|
+
};
|
|
8257
8280
|
} | null;
|
|
8258
8281
|
/**
|
|
8259
8282
|
* UTC time at which Zernio generated this event (set once when the event payload is built, before delivery is queued). Retries and redeliveries keep the original value, so it reflects the event, not the delivery attempt.
|
|
@@ -26872,11 +26895,19 @@ type ListAdCampaignsData = {
|
|
|
26872
26895
|
* Start of metrics date range (YYYY-MM-DD, inclusive). Defaults to 90 days ago when both date params are omitted.
|
|
26873
26896
|
*/
|
|
26874
26897
|
fromDate?: string;
|
|
26898
|
+
/**
|
|
26899
|
+
* Return only campaigns that delivered between `fromDate` and `toDate` — spend above zero, or impressions served at zero spend. Unlike `status`, which reads a campaign's CURRENT state, this filters on what happened inside the window. Filters the campaign set itself, so `pagination.total` counts only matching campaigns. Mirrors the same filter on /v1/ads/tree.
|
|
26900
|
+
*/
|
|
26901
|
+
hasDelivery?: boolean;
|
|
26875
26902
|
/**
|
|
26876
26903
|
* Meta only. Campaign reads aggregate over ad documents, so a campaign with ZERO ads is normally invisible here — the state the two-step create (campaign, then ads via `existingCampaignId`) leaves behind whenever Meta rejects the ad step. Set true to list those too, with `adCount: 0` and zeroed metrics. Requires `accountId` and `adAccountId`, since an empty campaign has no ad row to resolve a token or ad account from.
|
|
26877
26904
|
*/
|
|
26878
26905
|
includeEmpty?: boolean;
|
|
26879
26906
|
limit?: number;
|
|
26907
|
+
/**
|
|
26908
|
+
* Return only campaigns whose spend between `fromDate` and `toDate` reaches this amount, in each campaign's OWN currency (the `currency` field on the campaign). Implies `hasDelivery`; `minSpend=0` applies no filter. Mirrors the same filter on /v1/ads/tree.
|
|
26909
|
+
*/
|
|
26910
|
+
minSpend?: number;
|
|
26880
26911
|
/**
|
|
26881
26912
|
* Page number (1-based)
|
|
26882
26913
|
*/
|
|
@@ -27459,13 +27490,21 @@ type GetAdTreeData = {
|
|
|
27459
27490
|
*/
|
|
27460
27491
|
dailyLevel?: 'campaign' | 'adset' | 'ad';
|
|
27461
27492
|
/**
|
|
27462
|
-
* Start of the METRICS date range (YYYY-MM-DD).
|
|
27493
|
+
* Start of the METRICS date range (YYYY-MM-DD). On its own it affects only the spend/impression numbers overlaid on each node, not which campaigns are returned — pass `hasDelivery` or `minSpend` to also filter the campaign set to this window. Defaults to 90 days ago.
|
|
27463
27494
|
*/
|
|
27464
27495
|
fromDate?: string;
|
|
27496
|
+
/**
|
|
27497
|
+
* Return only campaigns that delivered between `fromDate` and `toDate` — spend above zero, or impressions served at zero spend. Unlike `status`, which reads a campaign's CURRENT state, this filters on what happened inside the window, so a campaign that spent then and is paused today is still returned. Filters the campaign set itself, so `pagination.total` counts only matching campaigns.
|
|
27498
|
+
*/
|
|
27499
|
+
hasDelivery?: boolean;
|
|
27465
27500
|
/**
|
|
27466
27501
|
* Campaigns per page
|
|
27467
27502
|
*/
|
|
27468
27503
|
limit?: number;
|
|
27504
|
+
/**
|
|
27505
|
+
* Return only campaigns whose spend between `fromDate` and `toDate` reaches this amount. Expressed in each campaign's OWN currency (the `currency` field on the campaign node): spend is stored per ad account in its native currency and one response can span several. Implies `hasDelivery`; `minSpend=0` applies no filter.
|
|
27506
|
+
*/
|
|
27507
|
+
minSpend?: number;
|
|
27469
27508
|
/**
|
|
27470
27509
|
* Page number (1-based)
|
|
27471
27510
|
*/
|
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.
|
|
39
|
+
version: "0.2.560",
|
|
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.
|
|
8
|
+
version: "0.2.560",
|
|
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
|
@@ -7239,6 +7239,29 @@ export type WebhookPayloadMessage = {
|
|
|
7239
7239
|
flow_id?: string;
|
|
7240
7240
|
};
|
|
7241
7241
|
} | null;
|
|
7242
|
+
/**
|
|
7243
|
+
* WhatsApp only. Meta's own reason this message has no
|
|
7244
|
+
* renderable body. Present when Meta attached an error to the
|
|
7245
|
+
* inbound payload; in practice the `unsupported`, `errors` and
|
|
7246
|
+
* `unknown` types (code 131051: message type currently not
|
|
7247
|
+
* supported). `text` on those messages is the fixed
|
|
7248
|
+
* `[Unsupported message]` placeholder.
|
|
7249
|
+
*
|
|
7250
|
+
*/
|
|
7251
|
+
unsupported?: {
|
|
7252
|
+
/**
|
|
7253
|
+
* Meta's numeric error code (e.g. 131051).
|
|
7254
|
+
*/
|
|
7255
|
+
code?: number;
|
|
7256
|
+
/**
|
|
7257
|
+
* Meta's short error title.
|
|
7258
|
+
*/
|
|
7259
|
+
title?: string;
|
|
7260
|
+
/**
|
|
7261
|
+
* Meta's human-readable error detail string.
|
|
7262
|
+
*/
|
|
7263
|
+
details?: string;
|
|
7264
|
+
};
|
|
7242
7265
|
} | null;
|
|
7243
7266
|
/**
|
|
7244
7267
|
* UTC time at which Zernio generated this event (set once when the event payload is built, before delivery is queued). Retries and redeliveries keep the original value, so it reflects the event, not the delivery attempt.
|
|
@@ -27237,11 +27260,19 @@ export type ListAdCampaignsData = {
|
|
|
27237
27260
|
* Start of metrics date range (YYYY-MM-DD, inclusive). Defaults to 90 days ago when both date params are omitted.
|
|
27238
27261
|
*/
|
|
27239
27262
|
fromDate?: string;
|
|
27263
|
+
/**
|
|
27264
|
+
* Return only campaigns that delivered between `fromDate` and `toDate` — spend above zero, or impressions served at zero spend. Unlike `status`, which reads a campaign's CURRENT state, this filters on what happened inside the window. Filters the campaign set itself, so `pagination.total` counts only matching campaigns. Mirrors the same filter on /v1/ads/tree.
|
|
27265
|
+
*/
|
|
27266
|
+
hasDelivery?: boolean;
|
|
27240
27267
|
/**
|
|
27241
27268
|
* Meta only. Campaign reads aggregate over ad documents, so a campaign with ZERO ads is normally invisible here — the state the two-step create (campaign, then ads via `existingCampaignId`) leaves behind whenever Meta rejects the ad step. Set true to list those too, with `adCount: 0` and zeroed metrics. Requires `accountId` and `adAccountId`, since an empty campaign has no ad row to resolve a token or ad account from.
|
|
27242
27269
|
*/
|
|
27243
27270
|
includeEmpty?: boolean;
|
|
27244
27271
|
limit?: number;
|
|
27272
|
+
/**
|
|
27273
|
+
* Return only campaigns whose spend between `fromDate` and `toDate` reaches this amount, in each campaign's OWN currency (the `currency` field on the campaign). Implies `hasDelivery`; `minSpend=0` applies no filter. Mirrors the same filter on /v1/ads/tree.
|
|
27274
|
+
*/
|
|
27275
|
+
minSpend?: number;
|
|
27245
27276
|
/**
|
|
27246
27277
|
* Page number (1-based)
|
|
27247
27278
|
*/
|
|
@@ -27860,13 +27891,21 @@ export type GetAdTreeData = {
|
|
|
27860
27891
|
*/
|
|
27861
27892
|
dailyLevel?: 'campaign' | 'adset' | 'ad';
|
|
27862
27893
|
/**
|
|
27863
|
-
* Start of the METRICS date range (YYYY-MM-DD).
|
|
27894
|
+
* Start of the METRICS date range (YYYY-MM-DD). On its own it affects only the spend/impression numbers overlaid on each node, not which campaigns are returned — pass `hasDelivery` or `minSpend` to also filter the campaign set to this window. Defaults to 90 days ago.
|
|
27864
27895
|
*/
|
|
27865
27896
|
fromDate?: string;
|
|
27897
|
+
/**
|
|
27898
|
+
* Return only campaigns that delivered between `fromDate` and `toDate` — spend above zero, or impressions served at zero spend. Unlike `status`, which reads a campaign's CURRENT state, this filters on what happened inside the window, so a campaign that spent then and is paused today is still returned. Filters the campaign set itself, so `pagination.total` counts only matching campaigns.
|
|
27899
|
+
*/
|
|
27900
|
+
hasDelivery?: boolean;
|
|
27866
27901
|
/**
|
|
27867
27902
|
* Campaigns per page
|
|
27868
27903
|
*/
|
|
27869
27904
|
limit?: number;
|
|
27905
|
+
/**
|
|
27906
|
+
* Return only campaigns whose spend between `fromDate` and `toDate` reaches this amount. Expressed in each campaign's OWN currency (the `currency` field on the campaign node): spend is stored per ad account in its native currency and one response can span several. Implies `hasDelivery`; `minSpend=0` applies no filter.
|
|
27907
|
+
*/
|
|
27908
|
+
minSpend?: number;
|
|
27870
27909
|
/**
|
|
27871
27910
|
* Page number (1-based)
|
|
27872
27911
|
*/
|