@zernio/node 0.2.983 → 0.2.985

package/dist/index.d.mts

@@ -1960,7 +1960,7 @@ type Ad = {
      */
     status?: (AdStatus);
     /**
-     * The ad's own on/off toggle as configured on the platform (Meta `configured_status`, ChatGPT (OpenAI) ad `status`: ACTIVE / PAUSED, plus ARCHIVED on OpenAI), unaffected by ancestor (ad set / campaign) pauses. Distinct from `status`, which is the ancestor-cascaded delivery status. Only present for Meta and OpenAI ads synced after this field was added.
+     * The ad's own on/off switch as configured on the platform, independent of its parents: an ACTIVE ad under a paused ad set or campaign still reads ACTIVE here while `status` reads `paused`. Sources: Meta `configured_status`, TikTok ad `operation_status` (ENABLE -> ACTIVE, DISABLE -> PAUSED), ChatGPT (OpenAI) ad `status` (ACTIVE / PAUSED, plus ARCHIVED on OpenAI). Distinct from `status`, which is the ancestor-cascaded delivery status. Only present for Meta, TikTok and OpenAI ads created or synced after the field was added for that platform; null otherwise.
      */
     configuredStatus?: (string) | null;
     /**
@@ -2272,6 +2272,9 @@ type Ad = {
     targeting?: {
         [key: string]: unknown;
     };
+    /**
+     * Delivery window as UTC instants. For ads created through Zernio this is the start and end the platform stored (on TikTok, read back from the ad group and converted from the ad account timezone); `startDate` is the creation time only when no start was requested.
+     */
     schedule?: {
         startDate?: string;
         endDate?: string;
@@ -2356,7 +2359,7 @@ type AdCampaign = {
      */
     reviewStatus?: (AdReviewStatus | null);
     /**
-     * Raw platform-level campaign status (Meta `effective_status`; ChatGPT (OpenAI): the campaign's own switch, active / paused / archived).
+     * Raw platform-level campaign status (Meta `effective_status`; ChatGPT (OpenAI): the campaign's own switch, active / paused / archived; TikTok: the campaign's own switch `operation_status`, ENABLE / DISABLE).
      */
     platformCampaignStatus?: (string) | null;
     /**
@@ -3233,7 +3236,7 @@ type AdTreeCampaign = {
      */
     reviewStatus?: (AdReviewStatus | null);
     /**
-     * Raw platform-level campaign status (Meta `effective_status`: ACTIVE, PAUSED, DELETED, ARCHIVED, IN_PROCESS, WITH_ISSUES; ChatGPT (OpenAI): the campaign's own switch, active / paused / archived, independent of the delivery `status`). Distinct from per-ad `platformStatus`.
+     * Raw platform-level campaign status (Meta `effective_status`: ACTIVE, PAUSED, DELETED, ARCHIVED, IN_PROCESS, WITH_ISSUES; ChatGPT (OpenAI): the campaign's own switch, active / paused / archived, independent of the delivery `status`; TikTok: the campaign's own switch `operation_status`, ENABLE / DISABLE). Distinct from per-ad `platformStatus`.
      */
     platformCampaignStatus?: (string) | null;
     /**
@@ -38406,6 +38409,9 @@ type ListAdSetsResponse = ({
         platform?: string;
         adSetName?: (string) | null;
         status?: (string) | null;
+        /**
+         * Raw platform ad set status. On TikTok the ad group's own switch `operation_status` (ENABLE / DISABLE), independent of its campaign.
+         */
         platformAdSetStatus?: (string) | null;
         platformCampaignId?: (string) | null;
         platformAdAccountId?: string;
@@ -44104,13 +44110,17 @@ type CreateStandaloneAdData = {
             [key: string]: (number);
         };
         /**
-         * Required for lifetime budgets
+         * Required for lifetime budgets. On TikTok a value without an offset (`YYYY-MM-DD HH:MM:SS` or `YYYY-MM-DD`) is read in the ad account timezone.
          */
         endDate?: string;
         /**
-         * Meta only. Ad-set start time (ISO 8601, e.g. "2026-06-10T09:00:00Z"), mapped to the
-         * ad set's `start_time`. When omitted the ad starts delivering immediately. For lifetime
-         * budgets Meta also requires `endDate`. Same field as on `POST /v1/ads/boost`.
+         * Ad-set start time (ISO 8601, e.g. "2026-06-10T09:00:00Z"), mapped to the ad set's
+         * start (Meta `start_time`, TikTok ad group `schedule_start_time`, LinkedIn / Pinterest / X
+         * / Google campaign start). When omitted the ad starts delivering immediately. For lifetime
+         * budgets Meta also requires `endDate`. On TikTok a value without an offset
+         * (`YYYY-MM-DD HH:MM:SS` or `YYYY-MM-DD`) is read in the ad account timezone. The created
+         * ad's `schedule` echoes the start and end the platform stored, as UTC instants. Same field
+         * as on `POST /v1/ads/boost`.
          *
          */
         startDate?: string;

package/dist/index.d.ts

@@ -1960,7 +1960,7 @@ type Ad = {
      */
     status?: (AdStatus);
     /**
-     * The ad's own on/off toggle as configured on the platform (Meta `configured_status`, ChatGPT (OpenAI) ad `status`: ACTIVE / PAUSED, plus ARCHIVED on OpenAI), unaffected by ancestor (ad set / campaign) pauses. Distinct from `status`, which is the ancestor-cascaded delivery status. Only present for Meta and OpenAI ads synced after this field was added.
+     * The ad's own on/off switch as configured on the platform, independent of its parents: an ACTIVE ad under a paused ad set or campaign still reads ACTIVE here while `status` reads `paused`. Sources: Meta `configured_status`, TikTok ad `operation_status` (ENABLE -> ACTIVE, DISABLE -> PAUSED), ChatGPT (OpenAI) ad `status` (ACTIVE / PAUSED, plus ARCHIVED on OpenAI). Distinct from `status`, which is the ancestor-cascaded delivery status. Only present for Meta, TikTok and OpenAI ads created or synced after the field was added for that platform; null otherwise.
      */
     configuredStatus?: (string) | null;
     /**
@@ -2272,6 +2272,9 @@ type Ad = {
     targeting?: {
         [key: string]: unknown;
     };
+    /**
+     * Delivery window as UTC instants. For ads created through Zernio this is the start and end the platform stored (on TikTok, read back from the ad group and converted from the ad account timezone); `startDate` is the creation time only when no start was requested.
+     */
     schedule?: {
         startDate?: string;
         endDate?: string;
@@ -2356,7 +2359,7 @@ type AdCampaign = {
      */
     reviewStatus?: (AdReviewStatus | null);
     /**
-     * Raw platform-level campaign status (Meta `effective_status`; ChatGPT (OpenAI): the campaign's own switch, active / paused / archived).
+     * Raw platform-level campaign status (Meta `effective_status`; ChatGPT (OpenAI): the campaign's own switch, active / paused / archived; TikTok: the campaign's own switch `operation_status`, ENABLE / DISABLE).
      */
     platformCampaignStatus?: (string) | null;
     /**
@@ -3233,7 +3236,7 @@ type AdTreeCampaign = {
      */
     reviewStatus?: (AdReviewStatus | null);
     /**
-     * Raw platform-level campaign status (Meta `effective_status`: ACTIVE, PAUSED, DELETED, ARCHIVED, IN_PROCESS, WITH_ISSUES; ChatGPT (OpenAI): the campaign's own switch, active / paused / archived, independent of the delivery `status`). Distinct from per-ad `platformStatus`.
+     * Raw platform-level campaign status (Meta `effective_status`: ACTIVE, PAUSED, DELETED, ARCHIVED, IN_PROCESS, WITH_ISSUES; ChatGPT (OpenAI): the campaign's own switch, active / paused / archived, independent of the delivery `status`; TikTok: the campaign's own switch `operation_status`, ENABLE / DISABLE). Distinct from per-ad `platformStatus`.
      */
     platformCampaignStatus?: (string) | null;
     /**
@@ -38406,6 +38409,9 @@ type ListAdSetsResponse = ({
         platform?: string;
         adSetName?: (string) | null;
         status?: (string) | null;
+        /**
+         * Raw platform ad set status. On TikTok the ad group's own switch `operation_status` (ENABLE / DISABLE), independent of its campaign.
+         */
         platformAdSetStatus?: (string) | null;
         platformCampaignId?: (string) | null;
         platformAdAccountId?: string;
@@ -44104,13 +44110,17 @@ type CreateStandaloneAdData = {
             [key: string]: (number);
         };
         /**
-         * Required for lifetime budgets
+         * Required for lifetime budgets. On TikTok a value without an offset (`YYYY-MM-DD HH:MM:SS` or `YYYY-MM-DD`) is read in the ad account timezone.
          */
         endDate?: string;
         /**
-         * Meta only. Ad-set start time (ISO 8601, e.g. "2026-06-10T09:00:00Z"), mapped to the
-         * ad set's `start_time`. When omitted the ad starts delivering immediately. For lifetime
-         * budgets Meta also requires `endDate`. Same field as on `POST /v1/ads/boost`.
+         * Ad-set start time (ISO 8601, e.g. "2026-06-10T09:00:00Z"), mapped to the ad set's
+         * start (Meta `start_time`, TikTok ad group `schedule_start_time`, LinkedIn / Pinterest / X
+         * / Google campaign start). When omitted the ad starts delivering immediately. For lifetime
+         * budgets Meta also requires `endDate`. On TikTok a value without an offset
+         * (`YYYY-MM-DD HH:MM:SS` or `YYYY-MM-DD`) is read in the ad account timezone. The created
+         * ad's `schedule` echoes the start and end the platform stored, as UTC instants. Same field
+         * as on `POST /v1/ads/boost`.
          *
          */
         startDate?: string;

package/dist/index.js

@@ -36,7 +36,7 @@ module.exports = __toCommonJS(index_exports);
 // package.json
 var package_default = {
   name: "@zernio/node",
-  version: "0.2.983",
+  version: "0.2.985",
   description: "The official Node.js library for the Zernio API",
   main: "dist/index.js",
   module: "dist/index.mjs",

package/dist/index.mjs

@@ -5,7 +5,7 @@ var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "sy
 // package.json
 var package_default = {
   name: "@zernio/node",
-  version: "0.2.983",
+  version: "0.2.985",
   description: "The official Node.js library for the Zernio API",
   main: "dist/index.js",
   module: "dist/index.mjs",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zernio/node",
-  "version": "0.2.983",
+  "version": "0.2.985",
   "description": "The official Node.js library for the Zernio API",
   "main": "dist/index.js",
   "module": "dist/index.mjs",

package/src/generated/sdk.gen.ts

@@ -13650,6 +13650,10 @@ export const startBusinessAgentEvalRun = <ThrowOnError extends boolean = false>(
  * `siteTagId` the alphanumeric `pixel_code` from Events Manager. Connections authorized
  * before the Pixel Management permission (about 2026-05-28) answer 403 until reconnected.
  *
+ * X Ads (platform `xads`): one X Pixel per X ad account, so `TrackingTag.id` is the ad
+ * account id (base36, e.g. `18ce54d4x5t`) and `siteTagId` is the pixel id the site embeds.
+ * Ad accounts without a pixel are left out. `adAccountId` scopes the list to one ad account.
+ *
  */
 export const listTrackingTags = <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<ListTrackingTagsData, ThrowOnError>) => {
     return (options?.client ?? client).get<ListTrackingTagsResponse, ListTrackingTagsError, ThrowOnError>({
@@ -13712,6 +13716,14 @@ export const listTrackingTags = <ThrowOnError extends boolean = false>(options:
  * most 40 characters with no emoji and must be unique; TikTok refuses a duplicate name
  * (400), which is its only retry guard. TikTok has no pixel delete API.
  *
+ * Pinterest's `code` snippet. NOT idempotent and Pinterest has no dry-run and no delete for
+ * tags, so never retry blindly: list first.
+ *
+ * X Ads (platform `xads`): creates the ad account's X Pixel (its UNIVERSAL website tag) with
+ * first-party cookies on. `adAccountId` is the X ad account id; `name` is not stored (X
+ * pixels have no name). X allows one pixel per ad account and cannot delete one, so an
+ * account that already has a pixel answers 409 without writing anything.
+ *
  */
 export const createTrackingTag = <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<CreateTrackingTagData, ThrowOnError>) => {
     return (options?.client ?? client).post<CreateTrackingTagResponse, CreateTrackingTagError, ThrowOnError>({
@@ -13749,6 +13761,11 @@ export const createTrackingTag = <ThrowOnError extends boolean = false>(options:
  * the pixel events. `lastFiredTime` is not available on TikTok. Without `adAccountId` the
  * connection's advertisers are searched.
  *
+ * X Ads (platform `xads`): `tagId` is the X ad account id. Returns the pixel id as
+ * `siteTagId`, the X Pixel base code as `code`, and the conversion events the site can fire
+ * in `events` (each with `siteEventId` = `tw-<pixel>-<event>`, also the `event_id` of the X
+ * Conversions API). An ad account without a pixel answers 400.
+ *
  */
 export const getTrackingTag = <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<GetTrackingTagData, ThrowOnError>) => {
     return (options?.client ?? client).get<GetTrackingTagResponse, GetTrackingTagError, ThrowOnError>({
@@ -13796,6 +13813,14 @@ export const getTrackingTag = <ThrowOnError extends boolean = false>(options: Op
  * (enabled or disabled). TikTok has no pixel delete: the endpoint is absent from its API and
  * `POST /pixel/delete/` answers 404.
  *
+ * Pinterest (platform `pinterestads`): 501. Pinterest API v5 only creates, lists and reads
+ * tags (no update endpoint); rename a tag or change its enhanced match settings in Pinterest
+ * Ads Manager.
+ *
+ * X Ads (platform `xads`): only `firstPartyCookieStatus` (`first_party_cookie_enabled` or
+ * `first_party_cookie_disabled`), which sets the pixel's first-party cookie setting. X has
+ * no API to rename or delete a pixel.
+ *
  */
 export const updateTrackingTag = <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<UpdateTrackingTagData, ThrowOnError>) => {
     return (options?.client ?? client).patch<UpdateTrackingTagResponse, UpdateTrackingTagError, ThrowOnError>({
@@ -14026,6 +14051,10 @@ export const removeTrackingTagFromStore = <ThrowOnError extends boolean = false>
  * hours, so a just-created event can be missing. `siteEventId` is the `ttq.track()` name the
  * site fires.
  *
+ * X Ads (platform `xads`): the ad account's web event tags the site can fire. Events X
+ * auto-creates with the pixel (site visits, landing page views, one per standard type) share the
+ * pixel id, cannot be fired one by one and are left out; they still appear in stats.
+ *
  */
 export const listTrackingTagEvents = <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<ListTrackingTagEventsData, ThrowOnError>) => {
     return (options?.client ?? client).get<ListTrackingTagEventsResponse, ListTrackingTagEventsError, ThrowOnError>({
@@ -14098,6 +14127,14 @@ export const listTrackingTagEvents = <ThrowOnError extends boolean = false>(opti
  * is read back from the pixel, and while TikTok's listing has not refreshed the response
  * carries an empty `id` and `status: pending`.
  *
+ * X Ads (platform `xads`): creates a web event tag. Fields: `name`, `type` (X enum:
+ * ADDED_PAYMENT_INFO, ADD_TO_CART, ADD_TO_WISHLIST, CHECKOUT_INITIATED, CONTENT_VIEW,
+ * CUSTOM, DOWNLOAD, INSTALL, LANDING_PAGE_VIEW, LOGIN, PRODUCT_CUSTOMIZATION, PURCHASE,
+ * SEARCH, SESSION, SIGN_UP, SITE_VISIT, START_TRIAL, SUBSCRIBE) or `siteEvent`,
+ * `clickWindowDays` (1, 7, 14, 30, 60 or 90; default 30) and `viewWindowDays` (0, 1, 7, 14,
+ * 30, 60 or 90, at most the click window; default 1). Retargeting is enabled, as in Events
+ * Manager.
+ *
  */
 export const createTrackingTagEvent = <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<CreateTrackingTagEventData, ThrowOnError>) => {
     return (options?.client ?? client).post<CreateTrackingTagEventResponse, CreateTrackingTagEventError, ThrowOnError>({
@@ -14132,6 +14169,9 @@ export const createTrackingTagEvent = <ThrowOnError extends boolean = false>(opt
  * TikTok: `name`, `defaultValue` and `currency` (USD, JPY or INR); the type cannot change
  * (delete and recreate).
  *
+ * X Ads (platform `xads`): the same fields as create. Events X auto-created with the pixel
+ * cannot be changed (400).
+ *
  */
 export const updateTrackingTagEvent = <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<UpdateTrackingTagEventData, ThrowOnError>) => {
     return (options?.client ?? client).patch<UpdateTrackingTagEventResponse, UpdateTrackingTagEventError, ThrowOnError>({
@@ -14166,6 +14206,10 @@ export const updateTrackingTagEvent = <ThrowOnError extends boolean = false>(opt
  * TikTok: hard delete (`/pixel/event/delete/`); TikTok refuses events bound to an ad group
  * (400).
  *
+ * X Ads (platform `xads`): deletes the web event tag for good. Events X auto-created with
+ * the pixel cannot be deleted (400). X keeps the event's own website tag id on the account
+ * (it has no delete for website tags), left without a conversion event.
+ *
  */
 export const deleteTrackingTagEvent = <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<DeleteTrackingTagEventData, ThrowOnError>) => {
     return (options?.client ?? client).delete<DeleteTrackingTagEventResponse, DeleteTrackingTagEventError, ThrowOnError>({
@@ -14291,6 +14335,11 @@ export const getTrackingTagDiagnostics = <ThrowOnError extends boolean = false>(
  * `preview_count`), bucketed by UTC day. Defaults to the last 7 days; at most 30 days per
  * request. `aggregation` is not accepted.
  *
+ * X Ads (platform `xads`): X has no event counts per pixel or event (only campaign-level
+ * conversion metrics). Each row is one web event tag with its `status` (TRACKING,
+ * UNVERIFIED, DORMANT), `lastTrackedTime` (unix seconds, null if never seen), `autoCreated`
+ * and, for events the site can fire, `siteEventId`.
+ *
  */
 export const getTrackingTagStats = <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<GetTrackingTagStatsData, ThrowOnError>) => {
     return (options?.client ?? client).get<GetTrackingTagStatsResponse, GetTrackingTagStatsError, ThrowOnError>({

package/src/generated/types.gen.ts

@@ -92,7 +92,7 @@ export type Ad = {
      */
     status?: (AdStatus);
     /**
-     * The ad's own on/off toggle as configured on the platform (Meta `configured_status`, ChatGPT (OpenAI) ad `status`: ACTIVE / PAUSED, plus ARCHIVED on OpenAI), unaffected by ancestor (ad set / campaign) pauses. Distinct from `status`, which is the ancestor-cascaded delivery status. Only present for Meta and OpenAI ads synced after this field was added.
+     * The ad's own on/off switch as configured on the platform, independent of its parents: an ACTIVE ad under a paused ad set or campaign still reads ACTIVE here while `status` reads `paused`. Sources: Meta `configured_status`, TikTok ad `operation_status` (ENABLE -> ACTIVE, DISABLE -> PAUSED), ChatGPT (OpenAI) ad `status` (ACTIVE / PAUSED, plus ARCHIVED on OpenAI). Distinct from `status`, which is the ancestor-cascaded delivery status. Only present for Meta, TikTok and OpenAI ads created or synced after the field was added for that platform; null otherwise.
      */
     configuredStatus?: (string) | null;
     /**
@@ -404,6 +404,9 @@ export type Ad = {
     targeting?: {
         [key: string]: unknown;
     };
+    /**
+     * Delivery window as UTC instants. For ads created through Zernio this is the start and end the platform stored (on TikTok, read back from the ad group and converted from the ad account timezone); `startDate` is the creation time only when no start was requested.
+     */
     schedule?: {
         startDate?: string;
         endDate?: string;
@@ -496,7 +499,7 @@ export type AdCampaign = {
      */
     reviewStatus?: (AdReviewStatus | null);
     /**
-     * Raw platform-level campaign status (Meta `effective_status`; ChatGPT (OpenAI): the campaign's own switch, active / paused / archived).
+     * Raw platform-level campaign status (Meta `effective_status`; ChatGPT (OpenAI): the campaign's own switch, active / paused / archived; TikTok: the campaign's own switch `operation_status`, ENABLE / DISABLE).
      */
     platformCampaignStatus?: (string) | null;
     /**
@@ -1401,7 +1404,7 @@ export type AdTreeCampaign = {
      */
     reviewStatus?: (AdReviewStatus | null);
     /**
-     * Raw platform-level campaign status (Meta `effective_status`: ACTIVE, PAUSED, DELETED, ARCHIVED, IN_PROCESS, WITH_ISSUES; ChatGPT (OpenAI): the campaign's own switch, active / paused / archived, independent of the delivery `status`). Distinct from per-ad `platformStatus`.
+     * Raw platform-level campaign status (Meta `effective_status`: ACTIVE, PAUSED, DELETED, ARCHIVED, IN_PROCESS, WITH_ISSUES; ChatGPT (OpenAI): the campaign's own switch, active / paused / archived, independent of the delivery `status`; TikTok: the campaign's own switch `operation_status`, ENABLE / DISABLE). Distinct from per-ad `platformStatus`.
      */
     platformCampaignStatus?: (string) | null;
     /**
@@ -38806,6 +38809,9 @@ export type ListAdSetsResponse = ({
         platform?: string;
         adSetName?: (string) | null;
         status?: (string) | null;
+        /**
+         * Raw platform ad set status. On TikTok the ad group's own switch `operation_status` (ENABLE / DISABLE), independent of its campaign.
+         */
         platformAdSetStatus?: (string) | null;
         platformCampaignId?: (string) | null;
         platformAdAccountId?: string;
@@ -44845,13 +44851,17 @@ export type CreateStandaloneAdData = {
             [key: string]: (number);
         };
         /**
-         * Required for lifetime budgets
+         * Required for lifetime budgets. On TikTok a value without an offset (`YYYY-MM-DD HH:MM:SS` or `YYYY-MM-DD`) is read in the ad account timezone.
          */
         endDate?: string;
         /**
-         * Meta only. Ad-set start time (ISO 8601, e.g. "2026-06-10T09:00:00Z"), mapped to the
-         * ad set's `start_time`. When omitted the ad starts delivering immediately. For lifetime
-         * budgets Meta also requires `endDate`. Same field as on `POST /v1/ads/boost`.
+         * Ad-set start time (ISO 8601, e.g. "2026-06-10T09:00:00Z"), mapped to the ad set's
+         * start (Meta `start_time`, TikTok ad group `schedule_start_time`, LinkedIn / Pinterest / X
+         * / Google campaign start). When omitted the ad starts delivering immediately. For lifetime
+         * budgets Meta also requires `endDate`. On TikTok a value without an offset
+         * (`YYYY-MM-DD HH:MM:SS` or `YYYY-MM-DD`) is read in the ad account timezone. The created
+         * ad's `schedule` echoes the start and end the platform stored, as UTC instants. Same field
+         * as on `POST /v1/ads/boost`.
          *
          */
         startDate?: string;