@zernio/node 0.2.140 → 0.2.142

package/src/generated/types.gen.ts

@@ -1001,6 +1001,49 @@ export type ConversionEvent = {
  */
 export type actionSource = 'web' | 'app' | 'offline' | 'crm' | 'phone_call' | 'system_generated';
 
+/**
+ * Response returned by `POST /v1/ads/ctwa` when the request used the
+ * multi-creative shape (`creatives[]`). N persisted Ad documents share
+ * the returned `platformCampaignId` and `platformAdSetId`. `adType` is
+ * the union discriminator.
+ *
+ */
+export type CtwaMultiResponse = {
+    adType: 'multi';
+    /**
+     * The persisted Ad documents (one per creative), all sharing the same
+     * `platformCampaignId` and `platformAdSetId`.
+     *
+     */
+    ads: Array<{
+        [key: string]: unknown;
+    }>;
+    platformCampaignId: string;
+    platformAdSetId: string;
+    message: string;
+};
+
+export type adType2 = 'multi';
+
+/**
+ * Response returned by `POST /v1/ads/ctwa` when the request used the
+ * single-creative shape (top-level headline / body / imageUrl|video).
+ * `adType` is the union discriminator.
+ *
+ */
+export type CtwaSingleResponse = {
+    adType: 'single';
+    /**
+     * The persisted Ad document.
+     */
+    ad: {
+        [key: string]: unknown;
+    };
+    message: string;
+};
+
+export type adType3 = 'single';
+
 /**
  * Discord message settings. Supports plain text (2,000 chars), rich embeds (up to 10), native polls, forum posts, threads, and announcement crossposts. Media attachments support images (JPEG, PNG, GIF, WebP), videos (MP4), and documents (up to 10 files, 25 MB each). Webhook identity (username + avatar) can be customized per-account via PATCH /v1/connect/discord or per-post via webhookUsername/webhookAvatarUrl.
  *
@@ -3031,7 +3074,7 @@ export type Webhook = {
     /**
      * Events subscribed to
      */
-    events?: Array<('post.scheduled' | 'post.published' | 'post.failed' | 'post.partial' | 'post.cancelled' | 'post.recycled' | 'account.connected' | 'account.disconnected' | 'account.ads.initial_sync_completed' | 'message.received' | 'message.sent' | 'message.edited' | 'message.deleted' | 'message.delivered' | 'message.read' | 'message.failed' | 'comment.received' | 'review.new' | 'review.updated')>;
+    events?: Array<('post.scheduled' | 'post.published' | 'post.failed' | 'post.partial' | 'post.cancelled' | 'post.recycled' | 'account.connected' | 'account.disconnected' | 'account.ads.initial_sync_completed' | 'message.received' | 'message.sent' | 'message.edited' | 'message.deleted' | 'message.delivered' | 'message.read' | 'message.failed' | 'comment.received' | 'review.new' | 'review.updated' | 'ad.status_changed')>;
     /**
      * Whether webhook delivery is enabled
      */
@@ -3244,6 +3287,127 @@ export type event3 = 'account.disconnected';
  */
 export type disconnectionType = 'intentional' | 'unintentional';
 
+/**
+ * Webhook payload for the `ad.status_changed` event. Currently emitted
+ * only for Meta (`metaads`).
+ *
+ * Sourced from two Meta `ad_account` webhook fields:
+ * - `in_process_ad_objects` - the ad object finished processing and
+ * exited `IN_PROCESS`. `status.raw` carries Meta's `status_name`.
+ * - `with_issues_ad_objects` - the ad object entered `WITH_ISSUES`.
+ * `status.raw` is `WITH_ISSUES` and the `error` block is populated
+ * from Meta's `error_code` / `error_summary` / `error_message`.
+ *
+ */
+export type WebhookPayloadAdStatusChanged = {
+    /**
+     * Stable webhook event ID
+     */
+    id: string;
+    event: 'ad.status_changed';
+    /**
+     * The connected ad-platform account that owns the ad object.
+     */
+    account: {
+        /**
+         * Internal Zernio account ID (same as used in /v1/accounts/{accountId}).
+         */
+        accountId: string;
+        /**
+         * Internal Zernio profile ID this account belongs to.
+         */
+        profileId: string;
+        /**
+         * Ad platform identifier. Currently always `metaads`.
+         */
+        platform: string;
+        /**
+         * Display username of the connected ad-platform account.
+         */
+        username: string;
+        /**
+         * Human-readable display name of the account, when available.
+         */
+        displayName?: string;
+    };
+    /**
+     * The ad-platform object the status change applies to.
+     */
+    adObject: {
+        /**
+         * Hierarchy level the status applies to. Mirrors Meta's `level`. Creative-level events are not forwarded.
+         */
+        level: 'CAMPAIGN' | 'AD_SET' | 'AD';
+        /**
+         * Platform-native ID of the campaign / ad set / ad. For Meta this is
+         * the bare numeric ID (e.g. `120244894077860689`).
+         *
+         */
+        platformId: string;
+        /**
+         * Platform-native ad-account ID. For Meta this uses the `act_<id>`
+         * shape.
+         *
+         */
+        platformAdAccountId: string;
+    };
+    /**
+     * Status info. Branch on `status.raw` to handle each transition.
+     */
+    status: {
+        /**
+         * Platform-native status string, forwarded verbatim. For Meta
+         * this is `status_name` from `in_process_ad_objects` (e.g.
+         * `ACTIVE`, `PAUSED`, `PENDING_REVIEW`, `ARCHIVED`, `DELETED`,
+         * `DISAPPROVED`), or `WITH_ISSUES` when sourced from
+         * `with_issues_ad_objects`. Not constrained by an `enum` — Meta
+         * may add new values.
+         *
+         */
+        raw: string;
+    };
+    /**
+     * Optional. Present on most `WITH_ISSUES` events, carrying the
+     * platform's error diagnostics. May be absent on some `WITH_ISSUES`
+     * events (Meta does not always include diagnostics). Always absent
+     * for any other `status.raw` value. Always null-check before reading.
+     *
+     */
+    error?: {
+        /**
+         * Platform-native error code, forwarded verbatim. For Meta this
+         * is `error_code` as a string. Use as the stable discriminator —
+         * `summary` and `message` are localized.
+         *
+         */
+        code: string;
+        /**
+         * Short human-readable summary (Meta `error_summary`). Localized
+         * to the ad-account owner's Meta locale — display only, do not
+         * match on it.
+         *
+         */
+        summary?: string;
+        /**
+         * Full human-readable error message (Meta `error_message`).
+         * Localized — display only.
+         *
+         */
+        message?: string;
+    };
+    /**
+     * ISO-8601 timestamp the webhook was produced.
+     */
+    timestamp: string;
+};
+
+export type event4 = 'ad.status_changed';
+
+/**
+ * Hierarchy level the status applies to. Mirrors Meta's `level`. Creative-level events are not forwarded.
+ */
+export type level = 'CAMPAIGN' | 'AD_SET' | 'AD';
+
 /**
  * Webhook payload for comment received events (Instagram, Facebook, Twitter/X, YouTube, LinkedIn, Bluesky, Reddit)
  */
@@ -3335,7 +3499,7 @@ export type WebhookPayloadComment = {
     timestamp: string;
 };
 
-export type event4 = 'comment.received';
+export type event5 = 'comment.received';
 
 export type platform7 = 'instagram' | 'facebook' | 'twitter' | 'youtube' | 'linkedin' | 'bluesky' | 'reddit';
 
@@ -3623,7 +3787,7 @@ export type WebhookPayloadMessage = {
     timestamp: string;
 };
 
-export type event5 = 'message.received';
+export type event6 = 'message.received';
 
 /**
  * WhatsApp only. Which kind of interactive reply the user sent:
@@ -3655,7 +3819,7 @@ export type WebhookPayloadMessageDeleted = {
     timestamp: string;
 };
 
-export type event6 = 'message.deleted';
+export type event7 = 'message.deleted';
 
 /**
  * Shared payload for message.delivered, message.read, and
@@ -3690,7 +3854,7 @@ export type WebhookPayloadMessageDeliveryStatus = {
     timestamp: string;
 };
 
-export type event7 = 'message.delivered' | 'message.read' | 'message.failed';
+export type event8 = 'message.delivered' | 'message.read' | 'message.failed';
 
 /**
  * Webhook payload for message.edited events. Fires when the sender
@@ -3732,7 +3896,7 @@ export type WebhookPayloadMessageEdited = {
     timestamp: string;
 };
 
-export type event8 = 'message.edited';
+export type event9 = 'message.edited';
 
 /**
  * Webhook payload for message sent events (fired when a message is sent via the API)
@@ -3808,7 +3972,7 @@ export type WebhookPayloadMessageSent = {
     timestamp: string;
 };
 
-export type event9 = 'message.sent';
+export type event10 = 'message.sent';
 
 /**
  * Webhook payload for post events
@@ -3836,7 +4000,7 @@ export type WebhookPayloadPost = {
     timestamp: string;
 };
 
-export type event10 = 'post.scheduled' | 'post.published' | 'post.failed' | 'post.partial' | 'post.cancelled' | 'post.recycled';
+export type event11 = 'post.scheduled' | 'post.published' | 'post.failed' | 'post.partial' | 'post.cancelled' | 'post.recycled';
 
 /**
  * Webhook payload for the review.new event (new review posted on a connected account).
@@ -3856,7 +4020,7 @@ export type WebhookPayloadReviewNew = {
     timestamp: string;
 };
 
-export type event11 = 'review.new';
+export type event12 = 'review.new';
 
 /**
  * Webhook payload for the review.updated event. Fired when the reviewer edits
@@ -3880,7 +4044,7 @@ export type WebhookPayloadReviewUpdated = {
     timestamp: string;
 };
 
-export type event12 = 'review.updated';
+export type event13 = 'review.updated';
 
 /**
  * Webhook payload for test deliveries
@@ -3898,7 +4062,7 @@ export type WebhookPayloadTest = {
     timestamp: string;
 };
 
-export type event13 = 'webhook.test';
+export type event14 = 'webhook.test';
 
 export type WhatsAppBodyComponent = {
     type: 'body';
@@ -7624,6 +7788,58 @@ export type BatchGetGoogleBusinessReviewsResponse = ({
 
 export type BatchGetGoogleBusinessReviewsError = (ErrorResponse);
 
+export type ReplyToGoogleBusinessReviewData = {
+    body: {
+        /**
+         * The reply text to post on the review. Must be non-empty.
+         */
+        comment: string;
+    };
+    path: {
+        /**
+         * The Zernio account ID (from /v1/accounts)
+         */
+        accountId: string;
+        /**
+         * The review ID portion (e.g. "AIe9_BGx1234567890"), not the full resource name
+         */
+        reviewId: string;
+    };
+};
+
+export type ReplyToGoogleBusinessReviewResponse = ({
+    success?: boolean;
+    reviewId?: string;
+    platform?: string;
+});
+
+export type ReplyToGoogleBusinessReviewError = (ErrorResponse | {
+    error?: string;
+});
+
+export type DeleteGoogleBusinessReviewReplyData = {
+    path: {
+        /**
+         * The Zernio account ID (from /v1/accounts)
+         */
+        accountId: string;
+        /**
+         * The review ID portion (e.g. "AIe9_BGx1234567890"), not the full resource name
+         */
+        reviewId: string;
+    };
+};
+
+export type DeleteGoogleBusinessReviewReplyResponse = ({
+    success?: boolean;
+    message?: string;
+    platform?: string;
+});
+
+export type DeleteGoogleBusinessReviewReplyError = (ErrorResponse | {
+    error?: string;
+});
+
 export type GetPendingOAuthDataData = {
     query: {
         /**
@@ -9176,7 +9392,7 @@ export type CreateWebhookSettingsData = {
         /**
          * Events to subscribe to (at least one required)
          */
-        events: Array<('post.scheduled' | 'post.published' | 'post.failed' | 'post.partial' | 'post.cancelled' | 'post.recycled' | 'account.connected' | 'account.disconnected' | 'account.ads.initial_sync_completed' | 'message.received' | 'message.sent' | 'message.edited' | 'message.deleted' | 'message.delivered' | 'message.read' | 'message.failed' | 'comment.received' | 'review.new' | 'review.updated')>;
+        events: Array<('post.scheduled' | 'post.published' | 'post.failed' | 'post.partial' | 'post.cancelled' | 'post.recycled' | 'account.connected' | 'account.disconnected' | 'account.ads.initial_sync_completed' | 'message.received' | 'message.sent' | 'message.edited' | 'message.deleted' | 'message.delivered' | 'message.read' | 'message.failed' | 'comment.received' | 'review.new' | 'review.updated' | 'ad.status_changed')>;
         /**
          * Enable or disable webhook delivery. Defaults to `true` when omitted.
          */
@@ -9220,7 +9436,7 @@ export type UpdateWebhookSettingsData = {
         /**
          * Events to subscribe to. Must contain at least one event if provided.
          */
-        events?: Array<('post.scheduled' | 'post.published' | 'post.failed' | 'post.partial' | 'post.cancelled' | 'post.recycled' | 'account.connected' | 'account.disconnected' | 'account.ads.initial_sync_completed' | 'message.received' | 'message.sent' | 'message.edited' | 'message.deleted' | 'message.delivered' | 'message.read' | 'message.failed' | 'comment.received' | 'review.new' | 'review.updated')>;
+        events?: Array<('post.scheduled' | 'post.published' | 'post.failed' | 'post.partial' | 'post.cancelled' | 'post.recycled' | 'account.connected' | 'account.disconnected' | 'account.ads.initial_sync_completed' | 'message.received' | 'message.sent' | 'message.edited' | 'message.deleted' | 'message.delivered' | 'message.read' | 'message.failed' | 'comment.received' | 'review.new' | 'review.updated' | 'ad.status_changed')>;
         /**
          * Enable or disable webhook delivery
          */
@@ -14212,6 +14428,10 @@ export type GetAdAnalyticsResponse = ({
         name?: string;
         platform?: string;
         status?: string;
+        /**
+         * ISO 4217 code of the ad account that owns this ad (e.g. USD, THB, INR). All money values in `summary` and `daily` are in this currency. Null only on legacy ads synced before currency was persisted.
+         */
+        currency?: (string) | null;
     };
     analytics?: {
         summary?: AdMetrics;
@@ -15644,22 +15864,35 @@ export type CreateCtwaAdData = {
         adAccountId: string;
         /**
          * Ad display name. Used to derive campaign / ad set names.
+         * On the multi-creative shape, each ad's Meta name gets a
+         * " #N" suffix (1-indexed) so Ads Manager shows them as a
+         * numbered batch.
+         *
          */
         name: string;
-        headline: string;
         /**
-         * Primary text shown above the image / video.
+         * Single-creative shape only. Mutually exclusive with
+         * `creatives[]`.
+         *
          */
-        body: string;
+        headline?: string;
+        /**
+         * Primary text shown above the image / video. Single-creative
+         * shape only. Mutually exclusive with `creatives[]`.
+         *
+         */
+        body?: string;
         /**
-         * Image asset for image creatives. Mutually exclusive with
-         * `video`. Required if `video` is not supplied.
+         * Image asset for single-creative shape. Mutually exclusive
+         * with `video` and with `creatives[]`. Required on the
+         * single-creative shape if `video` is not supplied.
          *
          */
         imageUrl?: string;
         /**
-         * Video creative. Mutually exclusive with `imageUrl`.
-         * Required if `imageUrl` is not supplied.
+         * Video creative for single-creative shape. Mutually
+         * exclusive with `imageUrl` and with `creatives[]`. Required
+         * on the single-creative shape if `imageUrl` is not supplied.
          *
          */
         video?: {
@@ -15671,6 +15904,42 @@ export type CreateCtwaAdData = {
              */
             thumbnailUrl: string;
         };
+        /**
+         * Multi-creative shape: N CTWA ads under one campaign + one
+         * ad set, sharing budget and targeting. Mutually exclusive
+         * with the top-level single-creative fields (`headline` /
+         * `body` / `imageUrl` / `video`). Each entry must supply its
+         * own headline, body, and exactly one of `imageUrl` /
+         * `video`.
+         *
+         */
+        creatives?: Array<{
+            headline: string;
+            /**
+             * Primary text shown above the image / video.
+             */
+            body: string;
+            /**
+             * Image asset. Mutually exclusive with this entry's
+             * `video`. Required if `video` is not supplied.
+             *
+             */
+            imageUrl?: string;
+            /**
+             * Video creative. Mutually exclusive with this entry's
+             * `imageUrl`. Required if `imageUrl` is not supplied.
+             *
+             */
+            video?: {
+                url: string;
+                /**
+                 * Required by Meta for every video creative. Used
+                 * as the ad thumbnail.
+                 *
+                 */
+                thumbnailUrl: string;
+            };
+        }>;
         /**
          * Budget amount in the ad account's currency major units
          * (e.g. dollars for USD, not cents). Must be > 0.
@@ -15720,6 +15989,31 @@ export type CreateCtwaAdData = {
          *
          */
         objective?: 'OUTCOME_ENGAGEMENT' | 'OUTCOME_SALES' | 'OUTCOME_LEADS';
+        /**
+         * Meta bid strategy applied to the shared ad set. Defaults to
+         * `LOWEST_COST_WITHOUT_CAP` (auto-bid) when omitted.
+         * `LOWEST_COST_WITH_BID_CAP` and `COST_CAP` require
+         * `bidAmount`. `LOWEST_COST_WITH_MIN_ROAS` requires
+         * `roasAverageFloor`. CTWA's `optimization_goal` is fixed to
+         * `CONVERSATIONS`, but the bid strategy is independent.
+         *
+         */
+        bidStrategy?: 'LOWEST_COST_WITHOUT_CAP' | 'LOWEST_COST_WITH_BID_CAP' | 'COST_CAP' | 'LOWEST_COST_WITH_MIN_ROAS';
+        /**
+         * Whole currency units (e.g. `5` = $5.00 on a USD account).
+         * Required when `bidStrategy` is `LOWEST_COST_WITH_BID_CAP`
+         * or `COST_CAP`; rejected otherwise.
+         *
+         */
+        bidAmount?: number;
+        /**
+         * Decimal ROAS multiplier (e.g. `2.0` = 2.0× ROAS floor).
+         * Required when `bidStrategy` is `LOWEST_COST_WITH_MIN_ROAS`;
+         * rejected otherwise. Meta enforces its own upper bound
+         * server-side.
+         *
+         */
+        roasAverageFloor?: number;
         /**
          * Name of the legal entity benefiting from the ad.
          * Required by Meta when targeting EU users (DSA Article 26).
@@ -15737,15 +16031,7 @@ export type CreateCtwaAdData = {
     };
 };
 
-export type CreateCtwaAdResponse = ({
-    /**
-     * The persisted Ad document.
-     */
-    ad?: {
-        [key: string]: unknown;
-    };
-    message?: string;
-});
+export type CreateCtwaAdResponse = ((CtwaSingleResponse | CtwaMultiResponse));
 
 export type CreateCtwaAdError = (unknown | {
     error?: string;