@zernio/node 0.2.867 → 0.2.869
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 +28 -39
- package/dist/index.d.ts +28 -39
- package/dist/index.js +1 -1
- package/dist/index.mjs +1 -1
- package/package.json +1 -1
- package/src/generated/sdk.gen.ts +2 -0
- package/src/generated/types.gen.ts +28 -39
package/dist/index.d.mts
CHANGED
|
@@ -22445,11 +22445,6 @@ type TestWebhookError = (unknown | {
|
|
|
22445
22445
|
});
|
|
22446
22446
|
type ListLogsData = {
|
|
22447
22447
|
query?: {
|
|
22448
|
-
/**
|
|
22449
|
-
* Alias of accountId, kept for existing callers
|
|
22450
|
-
* @deprecated
|
|
22451
|
-
*/
|
|
22452
|
-
account_id?: string;
|
|
22453
22448
|
/**
|
|
22454
22449
|
* Filter by connected account ID
|
|
22455
22450
|
*/
|
|
@@ -22458,11 +22453,6 @@ type ListLogsData = {
|
|
|
22458
22453
|
* Filter by action (e.g., post.published, message.sent, account.connected, webhook.delivered)
|
|
22459
22454
|
*/
|
|
22460
22455
|
action?: string;
|
|
22461
|
-
/**
|
|
22462
|
-
* Alias of apiKeyId, kept for existing callers
|
|
22463
|
-
* @deprecated
|
|
22464
|
-
*/
|
|
22465
|
-
api_key_id?: string;
|
|
22466
22456
|
/**
|
|
22467
22457
|
* Filter by the API key that made the request (api_request logs)
|
|
22468
22458
|
*/
|
|
@@ -22479,11 +22469,6 @@ type ListLogsData = {
|
|
|
22479
22469
|
* Precise start instant (ISO 8601); narrows within the day range
|
|
22480
22470
|
*/
|
|
22481
22471
|
from?: string;
|
|
22482
|
-
/**
|
|
22483
|
-
* Alias of includeReadReceipts, kept for existing callers
|
|
22484
|
-
* @deprecated
|
|
22485
|
-
*/
|
|
22486
|
-
include_read_receipts?: boolean;
|
|
22487
22472
|
/**
|
|
22488
22473
|
* Include message.read / message.delivered events (hidden by default for messaging logs)
|
|
22489
22474
|
*/
|
|
@@ -22496,11 +22481,6 @@ type ListLogsData = {
|
|
|
22496
22481
|
* Filter by platform
|
|
22497
22482
|
*/
|
|
22498
22483
|
platform?: 'tiktok' | 'instagram' | 'whatsapp' | 'facebook' | 'youtube' | 'linkedin' | 'twitter' | 'threads' | 'pinterest' | 'reddit' | 'bluesky' | 'googlebusiness' | 'telegram' | 'snapchat' | 'all';
|
|
22499
|
-
/**
|
|
22500
|
-
* Alias of requestId, kept for existing callers
|
|
22501
|
-
* @deprecated
|
|
22502
|
-
*/
|
|
22503
|
-
request_id?: string;
|
|
22504
22484
|
/**
|
|
22505
22485
|
* Correlation ID. Returns every log spawned by a single API request
|
|
22506
22486
|
*/
|
|
@@ -22517,11 +22497,6 @@ type ListLogsData = {
|
|
|
22517
22497
|
* Filter by status
|
|
22518
22498
|
*/
|
|
22519
22499
|
status?: 'success' | 'failed' | 'pending' | 'skipped' | 'all';
|
|
22520
|
-
/**
|
|
22521
|
-
* Alias of statusCode, kept for existing callers
|
|
22522
|
-
* @deprecated
|
|
22523
|
-
*/
|
|
22524
|
-
status_code?: number;
|
|
22525
22500
|
/**
|
|
22526
22501
|
* Filter by exact HTTP status code (api_request logs)
|
|
22527
22502
|
*/
|
|
@@ -39482,29 +39457,43 @@ type BoostPostData = {
|
|
|
39482
39457
|
minimumPurchaseCurrency?: string;
|
|
39483
39458
|
}>;
|
|
39484
39459
|
/**
|
|
39485
|
-
* TikTok
|
|
39486
|
-
*
|
|
39487
|
-
*
|
|
39460
|
+
* Meta and TikTok. What the conversion ad set optimizes toward, so a boost
|
|
39461
|
+
* of an existing organic post can run for a conversion instead of only
|
|
39462
|
+
* engagement or traffic. Required when `goal` is `conversions` (Meta also
|
|
39463
|
+
* `lead_conversion`); ignored on goals that do not optimize for a conversion.
|
|
39488
39464
|
*
|
|
39489
|
-
*
|
|
39490
|
-
*
|
|
39491
|
-
*
|
|
39492
|
-
*
|
|
39493
|
-
*
|
|
39465
|
+
* Meta: `pixelId` + `customEventType` (a commerce event such as PURCHASE
|
|
39466
|
+
* under `conversions`, a leads-class event such as LEAD under
|
|
39467
|
+
* `lead_conversion`), or `customConversionId` to optimize against a Custom
|
|
39468
|
+
* Conversion, or `customEventType: OTHER` + `customEventStr` for a pixel
|
|
39469
|
+
* custom event. Becomes the ad set `promoted_object`; without it Meta
|
|
39470
|
+
* rejects the ad set ("Please select a promoted object", subcode 1815430).
|
|
39471
|
+
* With `adSetId` the existing ad set already carries it.
|
|
39494
39472
|
*
|
|
39495
|
-
*
|
|
39496
|
-
*
|
|
39473
|
+
* TikTok: BOTH `pixelId` and `customEventType` are required. TikTok refuses
|
|
39474
|
+
* a conversion ad group with no pixel ("Please select a pixel") and one
|
|
39475
|
+
* with a pixel but no event ("Select a pixel event."). Combine freely with
|
|
39476
|
+
* `platformPostId` + `sparkAuthCode`: the pixel lives on the ad group and
|
|
39477
|
+
* the Spark item on the creative.
|
|
39497
39478
|
*
|
|
39498
39479
|
*/
|
|
39499
39480
|
promotedObject?: {
|
|
39500
39481
|
/**
|
|
39501
|
-
*
|
|
39482
|
+
* Meta Pixel id, or TikTok Pixel (numeric id or the alphanumeric pixel code from Events Manager, resolved for you).
|
|
39483
|
+
*/
|
|
39484
|
+
pixelId?: string;
|
|
39485
|
+
/**
|
|
39486
|
+
* Meta: standard pixel event (PURCHASE, LEAD, ...) or OTHER with customEventStr. TikTok: optimization_event code (e.g. ON_WEB_ORDER, SHOPPING, FORM) or the exact event name shown in Events Manager, resolved to its code; the event must already exist on that pixel.
|
|
39487
|
+
*/
|
|
39488
|
+
customEventType?: string;
|
|
39489
|
+
/**
|
|
39490
|
+
* Meta only. Pixel custom event name as it appears in Events Manager; requires customEventType OTHER.
|
|
39502
39491
|
*/
|
|
39503
|
-
|
|
39492
|
+
customEventStr?: string;
|
|
39504
39493
|
/**
|
|
39505
|
-
*
|
|
39494
|
+
* Meta only. Custom Conversion to optimize against, instead of pixelId + customEventType.
|
|
39506
39495
|
*/
|
|
39507
|
-
|
|
39496
|
+
customConversionId?: string;
|
|
39508
39497
|
};
|
|
39509
39498
|
/**
|
|
39510
39499
|
* Legal entity that benefits from the ad. Required when targeting EU users
|
package/dist/index.d.ts
CHANGED
|
@@ -22445,11 +22445,6 @@ type TestWebhookError = (unknown | {
|
|
|
22445
22445
|
});
|
|
22446
22446
|
type ListLogsData = {
|
|
22447
22447
|
query?: {
|
|
22448
|
-
/**
|
|
22449
|
-
* Alias of accountId, kept for existing callers
|
|
22450
|
-
* @deprecated
|
|
22451
|
-
*/
|
|
22452
|
-
account_id?: string;
|
|
22453
22448
|
/**
|
|
22454
22449
|
* Filter by connected account ID
|
|
22455
22450
|
*/
|
|
@@ -22458,11 +22453,6 @@ type ListLogsData = {
|
|
|
22458
22453
|
* Filter by action (e.g., post.published, message.sent, account.connected, webhook.delivered)
|
|
22459
22454
|
*/
|
|
22460
22455
|
action?: string;
|
|
22461
|
-
/**
|
|
22462
|
-
* Alias of apiKeyId, kept for existing callers
|
|
22463
|
-
* @deprecated
|
|
22464
|
-
*/
|
|
22465
|
-
api_key_id?: string;
|
|
22466
22456
|
/**
|
|
22467
22457
|
* Filter by the API key that made the request (api_request logs)
|
|
22468
22458
|
*/
|
|
@@ -22479,11 +22469,6 @@ type ListLogsData = {
|
|
|
22479
22469
|
* Precise start instant (ISO 8601); narrows within the day range
|
|
22480
22470
|
*/
|
|
22481
22471
|
from?: string;
|
|
22482
|
-
/**
|
|
22483
|
-
* Alias of includeReadReceipts, kept for existing callers
|
|
22484
|
-
* @deprecated
|
|
22485
|
-
*/
|
|
22486
|
-
include_read_receipts?: boolean;
|
|
22487
22472
|
/**
|
|
22488
22473
|
* Include message.read / message.delivered events (hidden by default for messaging logs)
|
|
22489
22474
|
*/
|
|
@@ -22496,11 +22481,6 @@ type ListLogsData = {
|
|
|
22496
22481
|
* Filter by platform
|
|
22497
22482
|
*/
|
|
22498
22483
|
platform?: 'tiktok' | 'instagram' | 'whatsapp' | 'facebook' | 'youtube' | 'linkedin' | 'twitter' | 'threads' | 'pinterest' | 'reddit' | 'bluesky' | 'googlebusiness' | 'telegram' | 'snapchat' | 'all';
|
|
22499
|
-
/**
|
|
22500
|
-
* Alias of requestId, kept for existing callers
|
|
22501
|
-
* @deprecated
|
|
22502
|
-
*/
|
|
22503
|
-
request_id?: string;
|
|
22504
22484
|
/**
|
|
22505
22485
|
* Correlation ID. Returns every log spawned by a single API request
|
|
22506
22486
|
*/
|
|
@@ -22517,11 +22497,6 @@ type ListLogsData = {
|
|
|
22517
22497
|
* Filter by status
|
|
22518
22498
|
*/
|
|
22519
22499
|
status?: 'success' | 'failed' | 'pending' | 'skipped' | 'all';
|
|
22520
|
-
/**
|
|
22521
|
-
* Alias of statusCode, kept for existing callers
|
|
22522
|
-
* @deprecated
|
|
22523
|
-
*/
|
|
22524
|
-
status_code?: number;
|
|
22525
22500
|
/**
|
|
22526
22501
|
* Filter by exact HTTP status code (api_request logs)
|
|
22527
22502
|
*/
|
|
@@ -39482,29 +39457,43 @@ type BoostPostData = {
|
|
|
39482
39457
|
minimumPurchaseCurrency?: string;
|
|
39483
39458
|
}>;
|
|
39484
39459
|
/**
|
|
39485
|
-
* TikTok
|
|
39486
|
-
*
|
|
39487
|
-
*
|
|
39460
|
+
* Meta and TikTok. What the conversion ad set optimizes toward, so a boost
|
|
39461
|
+
* of an existing organic post can run for a conversion instead of only
|
|
39462
|
+
* engagement or traffic. Required when `goal` is `conversions` (Meta also
|
|
39463
|
+
* `lead_conversion`); ignored on goals that do not optimize for a conversion.
|
|
39488
39464
|
*
|
|
39489
|
-
*
|
|
39490
|
-
*
|
|
39491
|
-
*
|
|
39492
|
-
*
|
|
39493
|
-
*
|
|
39465
|
+
* Meta: `pixelId` + `customEventType` (a commerce event such as PURCHASE
|
|
39466
|
+
* under `conversions`, a leads-class event such as LEAD under
|
|
39467
|
+
* `lead_conversion`), or `customConversionId` to optimize against a Custom
|
|
39468
|
+
* Conversion, or `customEventType: OTHER` + `customEventStr` for a pixel
|
|
39469
|
+
* custom event. Becomes the ad set `promoted_object`; without it Meta
|
|
39470
|
+
* rejects the ad set ("Please select a promoted object", subcode 1815430).
|
|
39471
|
+
* With `adSetId` the existing ad set already carries it.
|
|
39494
39472
|
*
|
|
39495
|
-
*
|
|
39496
|
-
*
|
|
39473
|
+
* TikTok: BOTH `pixelId` and `customEventType` are required. TikTok refuses
|
|
39474
|
+
* a conversion ad group with no pixel ("Please select a pixel") and one
|
|
39475
|
+
* with a pixel but no event ("Select a pixel event."). Combine freely with
|
|
39476
|
+
* `platformPostId` + `sparkAuthCode`: the pixel lives on the ad group and
|
|
39477
|
+
* the Spark item on the creative.
|
|
39497
39478
|
*
|
|
39498
39479
|
*/
|
|
39499
39480
|
promotedObject?: {
|
|
39500
39481
|
/**
|
|
39501
|
-
*
|
|
39482
|
+
* Meta Pixel id, or TikTok Pixel (numeric id or the alphanumeric pixel code from Events Manager, resolved for you).
|
|
39483
|
+
*/
|
|
39484
|
+
pixelId?: string;
|
|
39485
|
+
/**
|
|
39486
|
+
* Meta: standard pixel event (PURCHASE, LEAD, ...) or OTHER with customEventStr. TikTok: optimization_event code (e.g. ON_WEB_ORDER, SHOPPING, FORM) or the exact event name shown in Events Manager, resolved to its code; the event must already exist on that pixel.
|
|
39487
|
+
*/
|
|
39488
|
+
customEventType?: string;
|
|
39489
|
+
/**
|
|
39490
|
+
* Meta only. Pixel custom event name as it appears in Events Manager; requires customEventType OTHER.
|
|
39502
39491
|
*/
|
|
39503
|
-
|
|
39492
|
+
customEventStr?: string;
|
|
39504
39493
|
/**
|
|
39505
|
-
*
|
|
39494
|
+
* Meta only. Custom Conversion to optimize against, instead of pixelId + customEventType.
|
|
39506
39495
|
*/
|
|
39507
|
-
|
|
39496
|
+
customConversionId?: string;
|
|
39508
39497
|
};
|
|
39509
39498
|
/**
|
|
39510
39499
|
* Legal entity that benefits from the ad. Required when targeting EU users
|
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.869",
|
|
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.869",
|
|
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
package/src/generated/sdk.gen.ts
CHANGED
|
@@ -3668,6 +3668,8 @@ export const testWebhook = <ThrowOnError extends boolean = false>(options: Optio
|
|
|
3668
3668
|
* List activity logs
|
|
3669
3669
|
* Unified logs endpoint. Returns logs for publishing, connections, webhooks, and messaging.
|
|
3670
3670
|
* Filter by type, platform, status, and time range. Logs are retained for 90 days.
|
|
3671
|
+
* Legacy query aliases remain accepted: `account_id` for `accountId`, `request_id` for `requestId`,
|
|
3672
|
+
* `status_code` for `statusCode`, `api_key_id` for `apiKeyId`, and `include_read_receipts` for `includeReadReceipts`.
|
|
3671
3673
|
*
|
|
3672
3674
|
*/
|
|
3673
3675
|
export const listLogs = <ThrowOnError extends boolean = false>(options?: OptionsLegacyParser<ListLogsData, ThrowOnError>) => {
|
|
@@ -21890,11 +21890,6 @@ export type TestWebhookError = (unknown | {
|
|
|
21890
21890
|
|
|
21891
21891
|
export type ListLogsData = {
|
|
21892
21892
|
query?: {
|
|
21893
|
-
/**
|
|
21894
|
-
* Alias of accountId, kept for existing callers
|
|
21895
|
-
* @deprecated
|
|
21896
|
-
*/
|
|
21897
|
-
account_id?: string;
|
|
21898
21893
|
/**
|
|
21899
21894
|
* Filter by connected account ID
|
|
21900
21895
|
*/
|
|
@@ -21903,11 +21898,6 @@ export type ListLogsData = {
|
|
|
21903
21898
|
* Filter by action (e.g., post.published, message.sent, account.connected, webhook.delivered)
|
|
21904
21899
|
*/
|
|
21905
21900
|
action?: string;
|
|
21906
|
-
/**
|
|
21907
|
-
* Alias of apiKeyId, kept for existing callers
|
|
21908
|
-
* @deprecated
|
|
21909
|
-
*/
|
|
21910
|
-
api_key_id?: string;
|
|
21911
21901
|
/**
|
|
21912
21902
|
* Filter by the API key that made the request (api_request logs)
|
|
21913
21903
|
*/
|
|
@@ -21924,11 +21914,6 @@ export type ListLogsData = {
|
|
|
21924
21914
|
* Precise start instant (ISO 8601); narrows within the day range
|
|
21925
21915
|
*/
|
|
21926
21916
|
from?: string;
|
|
21927
|
-
/**
|
|
21928
|
-
* Alias of includeReadReceipts, kept for existing callers
|
|
21929
|
-
* @deprecated
|
|
21930
|
-
*/
|
|
21931
|
-
include_read_receipts?: boolean;
|
|
21932
21917
|
/**
|
|
21933
21918
|
* Include message.read / message.delivered events (hidden by default for messaging logs)
|
|
21934
21919
|
*/
|
|
@@ -21941,11 +21926,6 @@ export type ListLogsData = {
|
|
|
21941
21926
|
* Filter by platform
|
|
21942
21927
|
*/
|
|
21943
21928
|
platform?: 'tiktok' | 'instagram' | 'whatsapp' | 'facebook' | 'youtube' | 'linkedin' | 'twitter' | 'threads' | 'pinterest' | 'reddit' | 'bluesky' | 'googlebusiness' | 'telegram' | 'snapchat' | 'all';
|
|
21944
|
-
/**
|
|
21945
|
-
* Alias of requestId, kept for existing callers
|
|
21946
|
-
* @deprecated
|
|
21947
|
-
*/
|
|
21948
|
-
request_id?: string;
|
|
21949
21929
|
/**
|
|
21950
21930
|
* Correlation ID. Returns every log spawned by a single API request
|
|
21951
21931
|
*/
|
|
@@ -21962,11 +21942,6 @@ export type ListLogsData = {
|
|
|
21962
21942
|
* Filter by status
|
|
21963
21943
|
*/
|
|
21964
21944
|
status?: 'success' | 'failed' | 'pending' | 'skipped' | 'all';
|
|
21965
|
-
/**
|
|
21966
|
-
* Alias of statusCode, kept for existing callers
|
|
21967
|
-
* @deprecated
|
|
21968
|
-
*/
|
|
21969
|
-
status_code?: number;
|
|
21970
21945
|
/**
|
|
21971
21946
|
* Filter by exact HTTP status code (api_request logs)
|
|
21972
21947
|
*/
|
|
@@ -40127,29 +40102,43 @@ export type BoostPostData = {
|
|
|
40127
40102
|
minimumPurchaseCurrency?: string;
|
|
40128
40103
|
}>;
|
|
40129
40104
|
/**
|
|
40130
|
-
* TikTok
|
|
40131
|
-
*
|
|
40132
|
-
*
|
|
40105
|
+
* Meta and TikTok. What the conversion ad set optimizes toward, so a boost
|
|
40106
|
+
* of an existing organic post can run for a conversion instead of only
|
|
40107
|
+
* engagement or traffic. Required when `goal` is `conversions` (Meta also
|
|
40108
|
+
* `lead_conversion`); ignored on goals that do not optimize for a conversion.
|
|
40133
40109
|
*
|
|
40134
|
-
*
|
|
40135
|
-
*
|
|
40136
|
-
*
|
|
40137
|
-
*
|
|
40138
|
-
*
|
|
40110
|
+
* Meta: `pixelId` + `customEventType` (a commerce event such as PURCHASE
|
|
40111
|
+
* under `conversions`, a leads-class event such as LEAD under
|
|
40112
|
+
* `lead_conversion`), or `customConversionId` to optimize against a Custom
|
|
40113
|
+
* Conversion, or `customEventType: OTHER` + `customEventStr` for a pixel
|
|
40114
|
+
* custom event. Becomes the ad set `promoted_object`; without it Meta
|
|
40115
|
+
* rejects the ad set ("Please select a promoted object", subcode 1815430).
|
|
40116
|
+
* With `adSetId` the existing ad set already carries it.
|
|
40139
40117
|
*
|
|
40140
|
-
*
|
|
40141
|
-
*
|
|
40118
|
+
* TikTok: BOTH `pixelId` and `customEventType` are required. TikTok refuses
|
|
40119
|
+
* a conversion ad group with no pixel ("Please select a pixel") and one
|
|
40120
|
+
* with a pixel but no event ("Select a pixel event."). Combine freely with
|
|
40121
|
+
* `platformPostId` + `sparkAuthCode`: the pixel lives on the ad group and
|
|
40122
|
+
* the Spark item on the creative.
|
|
40142
40123
|
*
|
|
40143
40124
|
*/
|
|
40144
40125
|
promotedObject?: {
|
|
40145
40126
|
/**
|
|
40146
|
-
*
|
|
40127
|
+
* Meta Pixel id, or TikTok Pixel (numeric id or the alphanumeric pixel code from Events Manager, resolved for you).
|
|
40128
|
+
*/
|
|
40129
|
+
pixelId?: string;
|
|
40130
|
+
/**
|
|
40131
|
+
* Meta: standard pixel event (PURCHASE, LEAD, ...) or OTHER with customEventStr. TikTok: optimization_event code (e.g. ON_WEB_ORDER, SHOPPING, FORM) or the exact event name shown in Events Manager, resolved to its code; the event must already exist on that pixel.
|
|
40132
|
+
*/
|
|
40133
|
+
customEventType?: string;
|
|
40134
|
+
/**
|
|
40135
|
+
* Meta only. Pixel custom event name as it appears in Events Manager; requires customEventType OTHER.
|
|
40147
40136
|
*/
|
|
40148
|
-
|
|
40137
|
+
customEventStr?: string;
|
|
40149
40138
|
/**
|
|
40150
|
-
*
|
|
40139
|
+
* Meta only. Custom Conversion to optimize against, instead of pixelId + customEventType.
|
|
40151
40140
|
*/
|
|
40152
|
-
|
|
40141
|
+
customConversionId?: string;
|
|
40153
40142
|
};
|
|
40154
40143
|
/**
|
|
40155
40144
|
* Legal entity that benefits from the ad. Required when targeting EU users
|