@zernio/node 0.2.996 → 0.2.997

package/dist/index.d.mts

@@ -37807,19 +37807,27 @@ type UpdateAdCampaignStatusData = {
 };
 type UpdateAdCampaignStatusResponse = ({
     /**
-     * The status written to the campaign
+     * The campaign's delivery status derived from its switch as read back (`paused` when the switch is off). Echoes the request when the platform could not be read.
      */
     status?: 'active' | 'paused';
     /**
-     * Number of ads whose own stored status changed too. 0 is normal on a resume whose ads are all awaiting the platform.
+     * The campaign's own switch as read back from the platform, in the raw platform vocabulary (Meta effective_status, TikTok ENABLE / DISABLE, Google ENABLED / PAUSED, ChatGPT (OpenAI) status). Null when the platform could not be read, which is always the case on Pinterest, LinkedIn and X (no single-campaign read).
      */
-    updated?: number;
+    platformCampaignStatus?: (string) | null;
     /**
-     * Number of ads whose own status was left as it was
+     * When the switch was read back. Null when it could not be read.
      */
-    skipped?: number;
+    statusReadAt?: (string) | null;
+    /**
+     * 1 when the campaign's switch was written.
+     */
+    updated?: 0 | 1;
     /**
-     * Why each group of ads was skipped
+     * 1 when a live read showed the campaign already in the requested state, so nothing was written.
+     */
+    skipped?: 0 | 1;
+    /**
+     * Why the write was skipped, for example "Campaign already switched off".
      */
     skippedReasons?: Array<(string)>;
 });
@@ -38204,8 +38212,12 @@ type BulkUpdateAdCampaignStatusResponse = ({
     results?: Array<{
         platformCampaignId?: string;
         platform?: string;
-        updated?: number;
-        skipped?: number;
+        updated?: 0 | 1;
+        skipped?: 0 | 1;
+        /**
+         * The campaign's own switch read back from the platform; null when it could not be read.
+         */
+        platformCampaignStatus?: (string) | null;
         error?: string;
     }>;
 });
@@ -38862,20 +38874,23 @@ type UpdateAdSetResponse = ({
     budget?: AdBudget;
     budgetLevel?: 'adset';
     /**
-     * The status written to the ad set switch
+     * As in PUT /v1/ads/ad-sets/{adSetId}/status: delivery derived from the switches read back.
      */
     status?: 'active' | 'paused';
     /**
-     * Number of ads whose own stored status changed alongside the ad set switch
+     * The ad set's own switch read back from the platform; null when it could not be read.
      */
-    statusUpdated?: number;
+    platformAdSetStatus?: (string) | null;
+    platformCampaignStatus?: (string) | null;
+    statusReadAt?: (string) | null;
     /**
-     * Number of ads whose own status was left as it was
+     * 1 when the ad set's switch was written.
      */
-    statusSkipped?: number;
+    statusUpdated?: 0 | 1;
     /**
-     * Why each group of ads was skipped
+     * 1 when a live read showed it already in the requested state.
      */
+    statusSkipped?: 0 | 1;
     statusSkippedReasons?: Array<(string)>;
     bidStrategy?: BidStrategy;
     bidAmount?: (number) | null;
@@ -38919,19 +38934,31 @@ type UpdateAdSetStatusData = {
 };
 type UpdateAdSetStatusResponse = ({
     /**
-     * The status written to the ad set switch
+     * The ad set's delivery status derived from the switches read back: `paused` when its own switch or its campaign's switch is off. Echoes the request when the platform could not be read.
      */
     status?: 'active' | 'paused';
     /**
-     * Number of ads whose own stored status changed too. 0 is normal on a resume whose ads are all awaiting the platform.
+     * The ad set's own switch as read back from the platform, in the raw platform vocabulary (Meta effective_status, TikTok ENABLE / DISABLE, Google ENABLED / PAUSED, LinkedIn and Pinterest ACTIVE / PAUSED, ChatGPT (OpenAI) status). Null when the platform could not be read, which is always the case on X.
      */
-    updated?: number;
+    platformAdSetStatus?: (string) | null;
     /**
-     * Number of ads whose own status was left as it was
+     * The parent campaign's switch, read in the same call where the platform returns it, otherwise the stored value.
      */
-    skipped?: number;
+    platformCampaignStatus?: (string) | null;
+    /**
+     * When the ad set switch was read back. Null when it could not be read.
+     */
+    statusReadAt?: (string) | null;
+    /**
+     * 1 when the ad set's switch was written.
+     */
+    updated?: 0 | 1;
+    /**
+     * 1 when a live read showed the ad set already in the requested state, so nothing was written.
+     */
+    skipped?: 0 | 1;
     /**
-     * Why each group of ads was skipped (for example "2 ads already switched off", read from each ad's own switch)
+     * Why the write was skipped, for example "Ad set already switched off".
      */
     skippedReasons?: Array<(string)>;
 });

package/dist/index.d.ts

@@ -37807,19 +37807,27 @@ type UpdateAdCampaignStatusData = {
 };
 type UpdateAdCampaignStatusResponse = ({
     /**
-     * The status written to the campaign
+     * The campaign's delivery status derived from its switch as read back (`paused` when the switch is off). Echoes the request when the platform could not be read.
      */
     status?: 'active' | 'paused';
     /**
-     * Number of ads whose own stored status changed too. 0 is normal on a resume whose ads are all awaiting the platform.
+     * The campaign's own switch as read back from the platform, in the raw platform vocabulary (Meta effective_status, TikTok ENABLE / DISABLE, Google ENABLED / PAUSED, ChatGPT (OpenAI) status). Null when the platform could not be read, which is always the case on Pinterest, LinkedIn and X (no single-campaign read).
      */
-    updated?: number;
+    platformCampaignStatus?: (string) | null;
     /**
-     * Number of ads whose own status was left as it was
+     * When the switch was read back. Null when it could not be read.
      */
-    skipped?: number;
+    statusReadAt?: (string) | null;
+    /**
+     * 1 when the campaign's switch was written.
+     */
+    updated?: 0 | 1;
     /**
-     * Why each group of ads was skipped
+     * 1 when a live read showed the campaign already in the requested state, so nothing was written.
+     */
+    skipped?: 0 | 1;
+    /**
+     * Why the write was skipped, for example "Campaign already switched off".
      */
     skippedReasons?: Array<(string)>;
 });
@@ -38204,8 +38212,12 @@ type BulkUpdateAdCampaignStatusResponse = ({
     results?: Array<{
         platformCampaignId?: string;
         platform?: string;
-        updated?: number;
-        skipped?: number;
+        updated?: 0 | 1;
+        skipped?: 0 | 1;
+        /**
+         * The campaign's own switch read back from the platform; null when it could not be read.
+         */
+        platformCampaignStatus?: (string) | null;
         error?: string;
     }>;
 });
@@ -38862,20 +38874,23 @@ type UpdateAdSetResponse = ({
     budget?: AdBudget;
     budgetLevel?: 'adset';
     /**
-     * The status written to the ad set switch
+     * As in PUT /v1/ads/ad-sets/{adSetId}/status: delivery derived from the switches read back.
      */
     status?: 'active' | 'paused';
     /**
-     * Number of ads whose own stored status changed alongside the ad set switch
+     * The ad set's own switch read back from the platform; null when it could not be read.
      */
-    statusUpdated?: number;
+    platformAdSetStatus?: (string) | null;
+    platformCampaignStatus?: (string) | null;
+    statusReadAt?: (string) | null;
     /**
-     * Number of ads whose own status was left as it was
+     * 1 when the ad set's switch was written.
      */
-    statusSkipped?: number;
+    statusUpdated?: 0 | 1;
     /**
-     * Why each group of ads was skipped
+     * 1 when a live read showed it already in the requested state.
      */
+    statusSkipped?: 0 | 1;
     statusSkippedReasons?: Array<(string)>;
     bidStrategy?: BidStrategy;
     bidAmount?: (number) | null;
@@ -38919,19 +38934,31 @@ type UpdateAdSetStatusData = {
 };
 type UpdateAdSetStatusResponse = ({
     /**
-     * The status written to the ad set switch
+     * The ad set's delivery status derived from the switches read back: `paused` when its own switch or its campaign's switch is off. Echoes the request when the platform could not be read.
      */
     status?: 'active' | 'paused';
     /**
-     * Number of ads whose own stored status changed too. 0 is normal on a resume whose ads are all awaiting the platform.
+     * The ad set's own switch as read back from the platform, in the raw platform vocabulary (Meta effective_status, TikTok ENABLE / DISABLE, Google ENABLED / PAUSED, LinkedIn and Pinterest ACTIVE / PAUSED, ChatGPT (OpenAI) status). Null when the platform could not be read, which is always the case on X.
      */
-    updated?: number;
+    platformAdSetStatus?: (string) | null;
     /**
-     * Number of ads whose own status was left as it was
+     * The parent campaign's switch, read in the same call where the platform returns it, otherwise the stored value.
      */
-    skipped?: number;
+    platformCampaignStatus?: (string) | null;
+    /**
+     * When the ad set switch was read back. Null when it could not be read.
+     */
+    statusReadAt?: (string) | null;
+    /**
+     * 1 when the ad set's switch was written.
+     */
+    updated?: 0 | 1;
+    /**
+     * 1 when a live read showed the ad set already in the requested state, so nothing was written.
+     */
+    skipped?: 0 | 1;
     /**
-     * Why each group of ads was skipped (for example "2 ads already switched off", read from each ad's own switch)
+     * Why the write was skipped, for example "Ad set already switched off".
      */
     skippedReasons?: Array<(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.996",
+  version: "0.2.997",
   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.996",
+  version: "0.2.997",
   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.996",
+  "version": "0.2.997",
   "description": "The official Node.js library for the Zernio API",
   "main": "dist/index.js",
   "module": "dist/index.mjs",

package/src/generated/sdk.gen.ts

@@ -9306,40 +9306,19 @@ export const createAdCampaign = <ThrowOnError extends boolean = false>(options:
 
 /**
  * Pause or resume a campaign
- * Writes the campaign's own on/off switch, then lets the platform cascade delivery to its ad sets and ads.
- *
- * **What the write touches (current semantics, per platform).** TikTok: the campaign, every
- * ad group and every ad under it that is not in a terminal status (rejected, completed,
- * cancelled), on pause and on resume alike, so a resume also switches those ad groups and ads
- * on. LinkedIn: the campaign group plus the campaigns and creatives of its non-terminal ads.
- * Google: `paused` writes the campaign alone; `active` also switches on the ad groups and ads
- * Zernio tracks under it (see below). Pinterest: the campaign plus one tracked ad and its ad
- * group. X: the campaign plus one tracked line item. Meta and ChatGPT (OpenAI): the campaign
- * switch only.
- *
- * **Counts and readback.** Before the write, each ad's own switch is read live from the
- * platform (up to 20 ads; beyond that the stored switch is used), and `updated` / `skipped`
- * are computed against that live state. After the write each ad's own switch and delivery
- * status are read again and stored, and the campaign switch is re-read and stored, so an
- * immediate GET returns what the platform now reports.
- *
- * The switch is always written, whatever delivery status the ads underneath report: an ad still in review
- * does not block resuming its campaign. The echoed `status` is the confirmation that it landed.
- *
- * `updated` / `skipped` describe only the ads whose own status changed alongside it, so
- * `updated: 0` is a normal successful response, not a no-op. Ads are skipped when they are in a terminal
- * status (rejected, completed, cancelled), already in the target state, or switched on but not yet
- * delivering. The last group keeps its `pending_review` / `error` status until the platform reports what
- * it became. `skippedReasons` names which case applies.
- *
- * On Meta this flips the campaign only. An ad set paused in its own right stays paused, so pair this with
- * PUT /v1/ads/ad-sets/{adSetId}/status when you also need the ad set switched back on.
- *
- * Google keeps an independent on/off switch at campaign, ad group and ad level and the most restrictive
- * one wins, so `active` switches the campaign on TOGETHER with the ad groups and ads Zernio tracks under
- * it, in one mutate. Without that the campaign reads ENABLED while a paused ad group or ad keeps it from
- * serving. `paused` writes the campaign alone, which already stops delivery and leaves each ad's own
- * switch as you set it.
+ * Writes the campaign's own on/off switch and nothing else, on every platform (Meta, TikTok,
+ * Google, LinkedIn campaign group, Pinterest, X, ChatGPT (OpenAI)). Its ad sets and ads keep
+ * their own switches: pausing stops their delivery through the campaign, and resuming lets
+ * each of them deliver again only if its own switch is on. An ad set or ad you paused
+ * individually stays paused; resume it with PUT /v1/ads/ad-sets/{adSetId}/status or
+ * PUT /v1/ads/{adId}/status. See the Status model in the Ad Campaigns tag.
+ *
+ * **Live read, then write.** The campaign's switch is read from the platform first. When that
+ * live read shows it already in the requested state nothing is written (`updated: 0`,
+ * `skipped: 1`, with the reason). Otherwise the switch is written (`updated: 1`), read back and
+ * stored, and the delivery status of the ads under it (up to 20) is re-read and stored, so an
+ * immediate GET returns what the platform now reports. A stored switch never skips a write, and
+ * when the platform cannot be read the write always goes out.
  *
  */
 export const updateAdCampaignStatus = <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<UpdateAdCampaignStatusData, ThrowOnError>) => {
@@ -9554,9 +9533,10 @@ export const replaceCampaignNegativeKeywords = <ThrowOnError extends boolean = f
  * Pause or resume many campaigns
  * Process up to 50 campaigns in one call. Each campaign is updated
  * concurrently and the response contains a per-campaign result so a
- * single bad row does not fail the whole batch. Each campaign is written,
- * counted and re-read exactly as PUT /v1/ads/campaigns/{campaignId}/status
- * describes, including which child ad sets and ads each platform writes.
+ * single bad row does not fail the whole batch. Each campaign is read,
+ * written and re-read exactly as PUT /v1/ads/campaigns/{campaignId}/status
+ * describes: only the campaign's own switch is written, never its ad sets'
+ * or ads'. `updated` / `skipped` count campaigns.
  *
  */
 export const bulkUpdateAdCampaignStatus = <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<BulkUpdateAdCampaignStatusData, ThrowOnError>) => {
@@ -9827,9 +9807,9 @@ export const getAdSetDetails = <ThrowOnError extends boolean = false>(options: O
  * PUT /v1/ads/campaigns/{campaignId} instead.
  *
  * `status` behaves exactly as PUT /v1/ads/ad-sets/{adSetId}/status
- * describes, including which child ads each platform writes with the ad
- * set and how `statusUpdated` / `statusSkipped` are counted against the
- * ads' live switches.
+ * describes: only the ad set's own switch is written, its ads keep
+ * theirs, and `statusUpdated` / `statusSkipped` report whether that switch
+ * was written or a live read showed it already in place.
  *
  */
 export const updateAdSet = <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<UpdateAdSetData, ThrowOnError>) => {
@@ -9865,35 +9845,23 @@ export const deleteAdSet = <ThrowOnError extends boolean = false>(options: Optio
  * status toggle and prefer a symmetric URL to
  * /v1/ads/campaigns/{campaignId}/status.
  *
- * Writes the ad set's own on/off switch on every platform (Meta
- * `configured_status`, TikTok ad group `operation_status`, Google ad group
- * status, LinkedIn campaign, Pinterest ad group, X line item, OpenAI ad
- * group), whatever delivery status its ads report: an ad still in review
- * or paused by its campaign does not block it. The echoed `status` is the
- * confirmation that it landed.
- *
- * **What the write touches (current semantics, per platform).** On TikTok the ad group AND
- * every ad under it that is not in a terminal status (rejected, completed, cancelled) are
- * written to the target state, on pause and on resume alike, so a resume also switches those
- * ads on. Pinterest and ChatGPT (OpenAI) do the same with their ads. On Meta, Google, LinkedIn
- * (campaign) and X (line item) only the ad set's own switch is written and each ad keeps its
- * own switch.
- *
- * **Counts and readback.** Before the write, each ad's own switch is read live from the
- * platform (up to 20 ads; beyond that the stored switch is used), and `updated` / `skipped`
- * are computed against that live state, not against a stored switch a change in the
- * platform's UI may have left stale. After the write each ad's own switch and delivery
- * status are read again and stored, and the ad set switch is re-read and stored, so an
- * immediate GET returns what the platform now reports.
- *
- * `updated` / `skipped` describe only the ads whose own status changed
- * alongside the switch, so `updated: 0` is a normal successful response.
- * See `skippedReasons` for which of the three cases applies (terminal,
- * own switch already in the target state, or switched on but not yet
- * delivering).
- *
- * A campaign created paused needs its campaign resumed as well: pair this
- * with PUT /v1/ads/campaigns/{campaignId}/status.
+ * Writes the ad set's own on/off switch and nothing else, on every platform
+ * (Meta `configured_status`, TikTok ad group `operation_status`, Google ad
+ * group status, LinkedIn campaign, Pinterest ad group, X line item, ChatGPT
+ * (OpenAI) ad group). Its ads keep their own switches: an ad you paused
+ * individually stays paused when the ad set resumes. The campaign above is
+ * not touched either, so an ad set resumed under a paused campaign reads
+ * `status: paused` until the campaign is resumed too. See the Status model
+ * in the Ad Campaigns tag.
+ *
+ * **Live read, then write.** The ad set's switch is read from the platform
+ * first. When that live read shows it already in the requested state
+ * nothing is written (`updated: 0`, `skipped: 1`, with the reason).
+ * Otherwise the switch is written (`updated: 1`), read back and stored, and
+ * the delivery status of its ads (up to 20) is re-read and stored, so an
+ * immediate GET returns what the platform now reports. A stored switch
+ * never skips a write, and when the platform cannot be read the write
+ * always goes out.
  *
  */
 export const updateAdSetStatus = <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<UpdateAdSetStatusData, ThrowOnError>) => {

package/src/generated/types.gen.ts

@@ -38175,19 +38175,27 @@ export type UpdateAdCampaignStatusData = {
 
 export type UpdateAdCampaignStatusResponse = ({
     /**
-     * The status written to the campaign
+     * The campaign's delivery status derived from its switch as read back (`paused` when the switch is off). Echoes the request when the platform could not be read.
      */
     status?: 'active' | 'paused';
     /**
-     * Number of ads whose own stored status changed too. 0 is normal on a resume whose ads are all awaiting the platform.
+     * The campaign's own switch as read back from the platform, in the raw platform vocabulary (Meta effective_status, TikTok ENABLE / DISABLE, Google ENABLED / PAUSED, ChatGPT (OpenAI) status). Null when the platform could not be read, which is always the case on Pinterest, LinkedIn and X (no single-campaign read).
      */
-    updated?: number;
+    platformCampaignStatus?: (string) | null;
     /**
-     * Number of ads whose own status was left as it was
+     * When the switch was read back. Null when it could not be read.
      */
-    skipped?: number;
+    statusReadAt?: (string) | null;
+    /**
+     * 1 when the campaign's switch was written.
+     */
+    updated?: 0 | 1;
     /**
-     * Why each group of ads was skipped
+     * 1 when a live read showed the campaign already in the requested state, so nothing was written.
+     */
+    skipped?: 0 | 1;
+    /**
+     * Why the write was skipped, for example "Campaign already switched off".
      */
     skippedReasons?: Array<(string)>;
 });
@@ -38599,8 +38607,12 @@ export type BulkUpdateAdCampaignStatusResponse = ({
     results?: Array<{
         platformCampaignId?: string;
         platform?: string;
-        updated?: number;
-        skipped?: number;
+        updated?: 0 | 1;
+        skipped?: 0 | 1;
+        /**
+         * The campaign's own switch read back from the platform; null when it could not be read.
+         */
+        platformCampaignStatus?: (string) | null;
         error?: string;
     }>;
 });
@@ -39284,20 +39296,23 @@ export type UpdateAdSetResponse = ({
     budget?: AdBudget;
     budgetLevel?: 'adset';
     /**
-     * The status written to the ad set switch
+     * As in PUT /v1/ads/ad-sets/{adSetId}/status: delivery derived from the switches read back.
      */
     status?: 'active' | 'paused';
     /**
-     * Number of ads whose own stored status changed alongside the ad set switch
+     * The ad set's own switch read back from the platform; null when it could not be read.
      */
-    statusUpdated?: number;
+    platformAdSetStatus?: (string) | null;
+    platformCampaignStatus?: (string) | null;
+    statusReadAt?: (string) | null;
     /**
-     * Number of ads whose own status was left as it was
+     * 1 when the ad set's switch was written.
      */
-    statusSkipped?: number;
+    statusUpdated?: 0 | 1;
     /**
-     * Why each group of ads was skipped
+     * 1 when a live read showed it already in the requested state.
      */
+    statusSkipped?: 0 | 1;
     statusSkippedReasons?: Array<(string)>;
     bidStrategy?: BidStrategy;
     bidAmount?: (number) | null;
@@ -39347,19 +39362,31 @@ export type UpdateAdSetStatusData = {
 
 export type UpdateAdSetStatusResponse = ({
     /**
-     * The status written to the ad set switch
+     * The ad set's delivery status derived from the switches read back: `paused` when its own switch or its campaign's switch is off. Echoes the request when the platform could not be read.
      */
     status?: 'active' | 'paused';
     /**
-     * Number of ads whose own stored status changed too. 0 is normal on a resume whose ads are all awaiting the platform.
+     * The ad set's own switch as read back from the platform, in the raw platform vocabulary (Meta effective_status, TikTok ENABLE / DISABLE, Google ENABLED / PAUSED, LinkedIn and Pinterest ACTIVE / PAUSED, ChatGPT (OpenAI) status). Null when the platform could not be read, which is always the case on X.
      */
-    updated?: number;
+    platformAdSetStatus?: (string) | null;
     /**
-     * Number of ads whose own status was left as it was
+     * The parent campaign's switch, read in the same call where the platform returns it, otherwise the stored value.
      */
-    skipped?: number;
+    platformCampaignStatus?: (string) | null;
+    /**
+     * When the ad set switch was read back. Null when it could not be read.
+     */
+    statusReadAt?: (string) | null;
+    /**
+     * 1 when the ad set's switch was written.
+     */
+    updated?: 0 | 1;
+    /**
+     * 1 when a live read showed the ad set already in the requested state, so nothing was written.
+     */
+    skipped?: 0 | 1;
     /**
-     * Why each group of ads was skipped (for example "2 ads already switched off", read from each ad's own switch)
+     * Why the write was skipped, for example "Ad set already switched off".
      */
     skippedReasons?: Array<(string)>;
 });