@zernio/node 0.2.998 → 0.2.1000

package/src/generated/types.gen.ts

@@ -92,7 +92,7 @@ export type Ad = {
      */
     status?: (AdStatus);
     /**
-     * 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). On create it is read back from the platform, not copied from the request, so it can read ACTIVE for a `PAUSED` create where the platform holds the pause at the campaign (some Meta create flows). A TikTok ad created `PAUSED` is switched off at the ad, ad group and campaign and reads PAUSED. 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.
+     * 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). On create it is read back from the platform, not copied from the request: a `PAUSED` create pauses only the top-most object it creates, so an ad under a new paused campaign or ad set reads ACTIVE here with `status: paused`, and only an ad attached to an existing ad set reads PAUSED. 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;
     /**
@@ -4236,18 +4236,20 @@ export type CtwaAdRequestBody = {
      */
     objective?: 'OUTCOME_ENGAGEMENT' | 'OUTCOME_SALES' | 'OUTCOME_LEADS';
     /**
-     * Ad-level status. Defaults to `ACTIVE`. `PAUSED` skips activating the
-     * newly created ad(s) after Meta accepts them.
+     * Defaults to `ACTIVE`. `PAUSED` pauses only the top-most object this
+     * call creates: the new campaign (ad set and ads switched on), or, with
+     * `adSetId`, the new ads themselves.
      *
      */
     status?: 'ACTIVE' | 'PAUSED';
     /**
      * Campaign-level status, same semantics as `POST /v1/ads/create`. Defaults
-     * to `ACTIVE`. `PAUSED` holds activation at the campaign so it never
-     * spends before the advertiser reviews it, while the ad set and ad still
-     * switch on (one resume call brings the whole hierarchy live). Only
-     * meaningful when a new campaign is being created; rejected with a 400
-     * alongside `adSetId` (the attach shape reuses an existing campaign).
+     * to `status`. `PAUSED` holds the new campaign off while the ad set and
+     * ads switch on (one resume call brings the whole hierarchy live);
+     * `ACTIVE` with `status: PAUSED` switches the campaign on and pauses the
+     * new ad set instead. Only meaningful when a new campaign is being
+     * created; rejected with a 400 alongside `adSetId` (the attach shape
+     * reuses an existing campaign).
      *
      */
     campaignStatus?: 'ACTIVE' | 'PAUSED';
@@ -4338,19 +4340,21 @@ export type advantageAudience = 0 | 1;
 export type objective = 'OUTCOME_ENGAGEMENT' | 'OUTCOME_SALES' | 'OUTCOME_LEADS';
 
 /**
- * Ad-level status. Defaults to `ACTIVE`. `PAUSED` skips activating the
- * newly created ad(s) after Meta accepts them.
+ * Defaults to `ACTIVE`. `PAUSED` pauses only the top-most object this
+ * call creates: the new campaign (ad set and ads switched on), or, with
+ * `adSetId`, the new ads themselves.
  *
  */
 export type status13 = 'ACTIVE' | 'PAUSED';
 
 /**
  * Campaign-level status, same semantics as `POST /v1/ads/create`. Defaults
- * to `ACTIVE`. `PAUSED` holds activation at the campaign so it never
- * spends before the advertiser reviews it, while the ad set and ad still
- * switch on (one resume call brings the whole hierarchy live). Only
- * meaningful when a new campaign is being created; rejected with a 400
- * alongside `adSetId` (the attach shape reuses an existing campaign).
+ * to `status`. `PAUSED` holds the new campaign off while the ad set and
+ * ads switch on (one resume call brings the whole hierarchy live);
+ * `ACTIVE` with `status: PAUSED` switches the campaign on and pauses the
+ * new ad set instead. Only meaningful when a new campaign is being
+ * created; rejected with a 400 alongside `adSetId` (the attach shape
+ * reuses an existing campaign).
  *
  */
 export type campaignStatus = 'ACTIVE' | 'PAUSED';
@@ -6251,6 +6255,31 @@ export type ImessageAudienceContact = {
     } | null;
 };
 
+export type ImessageSandboxContact = {
+    id?: string;
+    /**
+     * Phone (E.164) or lowercase Apple ID email
+     */
+    handle?: string;
+    status?: 'pending' | 'active';
+    /**
+     * Send this from the handle to the sandbox line to activate it
+     */
+    joinText?: string;
+    /**
+     * Opens Messages on the sandbox line with joinText prefilled
+     */
+    joinLink?: string;
+    activatedAt?: (string) | null;
+    /**
+     * Replies are allowed for 24 hours after this
+     */
+    lastInboundAt?: (string) | null;
+    createdAt?: string;
+};
+
+export type status19 = 'pending' | 'active';
+
 /**
  * An iMessage sender registered as an account on a profile.
  */
@@ -6318,7 +6347,7 @@ export type kind = 'phone' | 'email';
 
 export type region = 'US' | 'GB';
 
-export type status19 = 'ordering' | 'activating' | 'active' | 'suspended' | 'canceled' | 'failed';
+export type status20 = 'ordering' | 'activating' | 'active' | 'suspended' | 'canceled' | 'failed';
 
 /**
  * Attachment snapshot inside an edit-history entry.
@@ -6390,7 +6419,7 @@ export type InboxWebhookConversation = {
     contactId?: string;
 };
 
-export type status20 = 'active' | 'archived';
+export type status21 = 'active' | 'archived';
 
 /**
  * The conversation object included in conversation lifecycle webhook payloads (conversation.started, conversation.control_changed).
@@ -8107,7 +8136,7 @@ export type OwnedPhoneNumber = {
     }>;
 };
 
-export type status21 = 'pending_payment' | 'pending_regulatory' | 'regulatory_declined' | 'provisioning' | 'verifying' | 'active' | 'suspended' | 'releasing' | 'released';
+export type status22 = 'pending_payment' | 'pending_regulatory' | 'regulatory_declined' | 'provisioning' | 'verifying' | 'active' | 'suspended' | 'releasing' | 'released';
 
 export type metaVerificationStatus = 'pending' | 'code_requested' | 'verified' | 'expired';
 
@@ -8237,7 +8266,7 @@ export type PlatformAnalytics = {
     errorMessage?: (string) | null;
 };
 
-export type status22 = 'published' | 'failed';
+export type status23 = 'published' | 'failed';
 
 /**
  * Sync state of analytics for this platform
@@ -8637,7 +8666,7 @@ export type Product = {
     publishedAt?: (string) | null;
 };
 
-export type status23 = 'active' | 'draft' | 'archived';
+export type status24 = 'active' | 'draft' | 'archived';
 
 export type ProductImage = {
     url?: string;
@@ -8844,7 +8873,7 @@ export type RcsAgent = {
     createdAt?: string;
 };
 
-export type status24 = 'requested' | 'changes_requested' | 'brand_vetting' | 'agent_review' | 'testing' | 'launch_review' | 'launching' | 'live' | 'rejected' | 'deactivated';
+export type status25 = 'requested' | 'changes_requested' | 'brand_vetting' | 'agent_review' | 'testing' | 'launch_review' | 'launching' | 'live' | 'rejected' | 'deactivated';
 
 export type useCase = 'MULTI_USE' | 'PROMOTIONAL' | 'TRANSACTIONAL' | 'OTP';
 
@@ -8896,7 +8925,7 @@ export type RcsBrand = RcsBrandInput & {
 /**
  * draft = not filed yet (still editable).
  */
-export type status25 = 'draft' | 'vetting' | 'verified' | 'rejected';
+export type status26 = 'draft' | 'vetting' | 'verified' | 'rejected';
 
 export type RcsBrandInput = {
     displayName: string;
@@ -8983,7 +9012,7 @@ export type RcsCarrierApproval = {
 
 export type scope2 = 'carrier' | 'hub' | 'bot';
 
-export type status26 = 'PENDING' | 'SUBMITTED' | 'APPROVED' | 'REJECTED';
+export type status27 = 'PENDING' | 'SUBMITTED' | 'APPROVED' | 'REJECTED';
 
 /**
  * Message content. `suggestions` (max 11) render as chips under the message.
@@ -10482,7 +10511,7 @@ export type UploadTokenResponse = {
     status?: 'pending' | 'completed' | 'expired';
 };
 
-export type status27 = 'pending' | 'completed' | 'expired';
+export type status28 = 'pending' | 'completed' | 'expired';
 
 export type UploadTokenStatusResponse = {
     token?: string;
@@ -10981,7 +11010,7 @@ export type Verification = {
     resend?: boolean;
 };
 
-export type status28 = 'pending' | 'approved' | 'expired' | 'max_attempts_reached' | 'canceled' | 'delivery_failed';
+export type status29 = 'pending' | 'approved' | 'expired' | 'max_attempts_reached' | 'canceled' | 'delivery_failed';
 
 export type channel4 = 'sms';
 
@@ -11130,7 +11159,7 @@ export type WebhookLog = {
 /**
  * Delivery outcome
  */
-export type status29 = 'success' | 'failed';
+export type status30 = 'success' | 'failed';
 
 /**
  * Webhook payload for `account.ads.initial_sync_completed` events.
@@ -11242,7 +11271,7 @@ export type event = 'account.ads.initial_sync_completed';
 /**
  * Overall outcome of the initial sync.
  */
-export type status30 = 'success' | 'failure';
+export type status31 = 'success' | 'failure';
 
 /**
  * Stable category for UX branching. New values may be added; existing ones are
@@ -13313,7 +13342,7 @@ export type event25 = 'post.platform.published' | 'post.platform.failed' | 'post
 /**
  * Terminal status this event fires on. Matches the event suffix.
  */
-export type status31 = 'published' | 'failed' | 'deleted';
+export type status32 = 'published' | 'failed' | 'deleted';
 
 /**
  * Webhook payload for reaction received events (WhatsApp, Telegram, Slack, Instagram, Facebook Messenger, TikTok)
@@ -13579,7 +13608,7 @@ export type platform16 = 'whatsapp';
 /**
  * Normalized from Meta's `decision` (REJECTED -> DECLINED, DEFERRED -> PENDING_REVIEW; the review is still open on DEFERRED, not a rejection).
  */
-export type status32 = 'APPROVED' | 'DECLINED' | 'PENDING_REVIEW';
+export type status33 = 'APPROVED' | 'DECLINED' | 'PENDING_REVIEW';
 
 /**
  * Webhook payload for the `whatsapp.template.category_updated` event.
@@ -13728,7 +13757,7 @@ export type event33 = 'whatsapp.template.status_updated';
  * request before the template is actually removed.
  *
  */
-export type status33 = 'APPROVED' | 'REJECTED' | 'PENDING' | 'PAUSED' | 'DISABLED' | 'IN_APPEAL' | 'PENDING_DELETION';
+export type status34 = 'APPROVED' | 'REJECTED' | 'PENDING' | 'PAUSED' | 'DISABLED' | 'IN_APPEAL' | 'PENDING_DELETION';
 
 export type WhatsAppBodyComponent = {
     type: 'body';
@@ -13876,14 +13905,6 @@ export type WhatsAppSandboxSession = {
     createdAt?: (string) | null;
 };
 
-/**
- * `pending` until the phone replies to the activation template, then
- * `active`. Expired sessions are pruned by TTL and never appear in
- * list responses.
- *
- */
-export type status34 = 'pending' | 'active';
-
 export type WhatsAppTemplateButton = {
     type: 'quick_reply' | 'url' | 'phone_number' | 'otp' | 'copy_code' | 'flow' | 'mpm' | 'catalog';
     /**
@@ -29595,6 +29616,56 @@ export type ListImessageAudienceError = (ErrorResponse | {
     error?: string;
 });
 
+export type ListImessageSandboxContactsResponse = ({
+    sandbox?: {
+        /**
+         * Use as accountId to reply from the sandbox line
+         */
+        accountId?: string;
+        /**
+         * The sandbox line to message
+         */
+        handle?: string;
+        contactLimit?: number;
+    };
+    contacts?: Array<ImessageSandboxContact>;
+});
+
+export type ListImessageSandboxContactsError = ({
+    error?: string;
+} | unknown);
+
+export type AddImessageSandboxContactData = {
+    body: {
+        /**
+         * Phone in international format (+15551234567) or an Apple ID email
+         */
+        handle: string;
+    };
+};
+
+export type AddImessageSandboxContactResponse = ({
+    contact?: ImessageSandboxContact;
+});
+
+export type AddImessageSandboxContactError = (ErrorResponse | {
+    error?: string;
+} | unknown);
+
+export type RemoveImessageSandboxContactData = {
+    path: {
+        contactId: string;
+    };
+};
+
+export type RemoveImessageSandboxContactResponse = ({
+    success?: boolean;
+});
+
+export type RemoveImessageSandboxContactError = (ErrorResponse | {
+    error?: string;
+} | unknown);
+
 export type SetImessageSubscriptionData = {
     body: {
         accountId: string;
@@ -44627,7 +44698,7 @@ export type BoostPostData = {
          */
         leadGenFormId?: string;
         /**
-         * Meta, TikTok, LinkedIn, and Google. Publish state of the created entities. Omitted or ACTIVE publishes live (default); PAUSED creates them paused so you can review before they spend. On Meta a new campaign stays paused until explicitly activated; an attached ad is itself paused. On Google the pause is held on the campaign the boost creates (ad group and ad switched on), so PUT /v1/ads/campaigns/{campaignId}/status with `active` brings it live. On LinkedIn the whole campaign group, campaign, and creative hierarchy stays PAUSED (intendedStatus PAUSED on each).
+         * Publish state of the created entities, on every platform. Omitted or ACTIVE publishes live (default); PAUSED pauses only the top-most object this boost creates and switches everything below it on: a new campaign is held paused with its ad set and ad on (one PUT /v1/ads/campaigns/{campaignId}/status with `active` brings it live); into an existing campaign (TikTok `existingCampaignId`) the new ad set is held paused; attached to an existing ad set (`adSetId`) the new ad itself is paused. On LinkedIn the held campaign group is PAUSED, its campaign and creative ACTIVE. X has no per-ad switch, so its lowest level is the line item.
          */
         status?: 'ACTIVE' | 'PAUSED';
         /**
@@ -44965,11 +45036,11 @@ export type CreateStandaloneAdData = {
          */
         budgetType?: 'daily' | 'lifetime';
         /**
-         * Google Performance Max accepts PAUSED only and always creates a paused campaign. Google Search and Display, Meta, TikTok, LinkedIn, and ChatGPT (OpenAI): publish state of the created entities. Omitted or ACTIVE publishes live (default, back-compat); PAUSED creates them paused so you can review before they spend. On Meta the pause is held on the campaign this call creates, leaving the ad set and ad switched on, so a single PUT /v1/ads/campaigns/{campaignId}/status with `active` brings the whole thing live. It is held at every level instead when the pause cannot rely on the campaign: `existingCampaignId` (that campaign may be running and is never touched) or `campaignStatus: ACTIVE`. Google Search and Display follow the same rule, and because Google keeps an independent switch at campaign, ad group and ad level, a PAUSED create leaves the campaign it creates PAUSED at Google. On TikTok the whole campaign > ad group > ad hierarchy stays paused. On LinkedIn the whole campaign group, campaign, and creative hierarchy stays PAUSED (intendedStatus PAUSED on each). ChatGPT (OpenAI) follows the Meta rule: the pause is held on the campaign this call creates.
+         * Publish state of the created entities, on every platform. Omitted or ACTIVE publishes live (default, back-compat); PAUSED pauses only the TOP-MOST object this call creates and switches everything below it on, so one resume of that object brings the new tree live and nothing that already existed is touched: a new campaign is held paused with its ad set and ad on; with `existingCampaignId` the new ad set is held paused with its ad on; with `adSetId` the new ad itself is paused. `campaignStatus: ACTIVE` with `status: PAUSED` moves the pause down to the new ad set. LinkedIn: a held campaign group is PAUSED with its campaign and creative ACTIVE; a new campaign in an existing group stays DRAFT. X has no per-ad switch, so its lowest level is the line item. Google Performance Max and Demand Gen accept PAUSED only (the campaign is created paused).
          */
         status?: 'ACTIVE' | 'PAUSED';
         /**
-         * Meta, Google, and ChatGPT (OpenAI). Overrides `status` for the campaign level alone, so you can create a live campaign whose ad set and ad stay paused, or the reverse. Omitted, it follows `status`.
+         * Meta, Google, and ChatGPT (OpenAI). Overrides `status` for the new campaign alone. `PAUSED` holds the campaign off with its ad set and ad on; `ACTIVE` with `status: PAUSED` switches the campaign on and holds the new ad set paused (its ad on). Omitted, it follows `status`.
          */
         campaignStatus?: 'ACTIVE' | 'PAUSED';
         /**