@zernio/node 0.2.518 → 0.2.520

package/dist/index.d.mts

@@ -47,6 +47,12 @@ interface ClientOptions {
  */
 declare class Zernio {
     private _options;
+    /**
+     * HTTP client owned by this instance. Every namespace method below is bound
+     * to it, so two Zernio instances in the same process never see each other's
+     * credentials.
+     */
+    private _client;
     /**
      * API key used for authentication.
      */
@@ -55,6 +61,13 @@ declare class Zernio {
      * Base URL for API requests.
      */
     baseURL: string;
+    /**
+     * Routes a generated operation through this instance's client, preserving the
+     * operation's own signature. Reads `_client` when the method is called, not
+     * when it is bound, because class fields initialize before the constructor
+     * body runs.
+     */
+    private _bind;
     /**
      * validate API
      */
@@ -2785,6 +2798,15 @@ type ConversionEvent = {
          * Meta advanced matching (ge). 'f' or 'm'; hashed server-side. Meta only.
          */
         gender?: string;
+        /**
+         * Meta lead ID from a Lead Ad submission, as a string. Required
+         * for Conversion Leads CRM events: send it with
+         * `actionSource: 'crm'` and
+         * `platformData: { event_source: 'crm', lead_event_source: '<CRM name>' }`.
+         * Forwarded unhashed to Meta's `user_data.lead_id`. Meta only.
+         *
+         */
+        leadId?: string;
         /**
          * Platform click identifiers captured from the originating ad click.
          */
@@ -2840,7 +2862,13 @@ type ConversionEvent = {
      */
     actionSource?: 'web' | 'app' | 'offline' | 'crm' | 'phone_call' | 'system_generated';
     /**
-     * Escape hatch for platform-specific fields we haven't normalized. Forwarded as-is.
+     * Escape hatch for platform-specific fields we haven't normalized.
+     * On Meta, keys are shallow-merged into `custom_data` only: fields
+     * Zernio already builds (`value`, `currency`, `contents`,
+     * `num_items`) always win on collision, and `user_data` (hashed
+     * match keys) is never touched. Use first-class fields (e.g.
+     * `user.leadId`) for anything that must reach `user_data`.
+     *
      */
     platformData?: {
         [key: string]: unknown;
@@ -25132,6 +25160,14 @@ type ListCommentAutomationsResponse = ({
          * Tag applied to a contact when they click a tracked link.
          */
         clickTag?: string;
+        /**
+         * Seconds waited after the trigger before the DM is sent. Absent when the DM goes out immediately.
+         */
+        dmDelaySeconds?: number;
+        /**
+         * Seconds waited before the public reply is posted. Absent when it follows the DM immediately.
+         */
+        commentReplyDelaySeconds?: number;
         isActive?: boolean;
         stats?: {
             triggered?: number;
@@ -25236,6 +25272,14 @@ type CreateCommentAutomationData = {
          * Optional tag applied to a contact when they click a tracked link (requires linkTracking). Lets you segment clickers for broadcasts/sequences.
          */
         clickTag?: string;
+        /**
+         * Seconds to wait after the trigger before sending the DM. Omit or send 0 to reply immediately (the default). Max 86400 (24h). The trigger is still matched and deduplicated the moment the comment arrives, so a delay only moves when the response is sent.
+         */
+        dmDelaySeconds?: number;
+        /**
+         * Seconds to wait before posting the public comment reply. Omit or send 0 to post it right after the DM (the default). The reply never goes out before the DM, so a value below dmDelaySeconds is raised to it. Ignored when trigger=story_reply, which has no public reply.
+         */
+        commentReplyDelaySeconds?: number;
         audience?: CommentAutomationAudience;
         followGate?: CommentAutomationFollowGate;
     };
@@ -25277,6 +25321,14 @@ type CreateCommentAutomationResponse = ({
         commentReplyVariations?: Array<(string)>;
         linkTracking?: boolean;
         clickTag?: string;
+        /**
+         * Seconds waited after the trigger before the DM is sent. Absent when the DM goes out immediately.
+         */
+        dmDelaySeconds?: number;
+        /**
+         * Seconds waited before the public reply is posted. Absent when it follows the DM immediately.
+         */
+        commentReplyDelaySeconds?: number;
         audience?: CommentAutomationAudience;
         followGate?: CommentAutomationFollowGate;
         isActive?: boolean;
@@ -25336,6 +25388,14 @@ type GetCommentAutomationResponse = ({
         commentReplyVariations?: Array<(string)>;
         linkTracking?: boolean;
         clickTag?: string;
+        /**
+         * Seconds waited after the trigger before the DM is sent. Absent when the DM goes out immediately.
+         */
+        dmDelaySeconds?: number;
+        /**
+         * Seconds waited before the public reply is posted. Absent when it follows the DM immediately.
+         */
+        commentReplyDelaySeconds?: number;
         audience?: CommentAutomationAudience;
         followGate?: CommentAutomationFollowGate;
         isActive?: boolean;
@@ -25354,9 +25414,9 @@ type GetCommentAutomationResponse = ({
         commenterName?: string;
         commentText?: string;
         /**
-         * DM outcome. 'gated' = the follow-gate confirmation DM went out and we are waiting for the tap; it flips to 'sent' or 'skipped' when they tap.
+         * DM outcome. 'pending' = the automation has a dmDelaySeconds and the response is queued but not sent yet. 'gated' = the follow-gate confirmation DM went out and we are waiting for the tap; it flips to 'sent' or 'skipped' when they tap.
          */
-        status?: 'sent' | 'failed' | 'skipped' | 'gated';
+        status?: 'pending' | 'sent' | 'failed' | 'skipped' | 'gated';
         /**
          * How the audience rule resolved. Absent on automations without one.
          */
@@ -25378,6 +25438,10 @@ type GetCommentAutomationResponse = ({
          * Public-reply error message if commentReplyStatus is failed
          */
         commentReplyError?: string;
+        /**
+         * When the next queued send fires. Present only while something is still pending.
+         */
+        nextDueAt?: string;
         createdAt?: string;
     }>;
 });
@@ -25426,6 +25490,14 @@ type UpdateCommentAutomationData = {
          * Tag applied to a contact when they click a tracked link (requires linkTracking). Empty string clears it.
          */
         clickTag?: string;
+        /**
+         * Seconds to wait after the trigger before sending the DM. Send 0 to clear the delay and reply immediately.
+         */
+        dmDelaySeconds?: number;
+        /**
+         * Seconds to wait before posting the public comment reply. Send 0 to clear it. The reply never goes out before the DM.
+         */
+        commentReplyDelaySeconds?: number;
         audience?: CommentAutomationAudience;
         followGate?: CommentAutomationFollowGate;
         isActive?: boolean;
@@ -25494,7 +25566,7 @@ type ListCommentAutomationLogsData = {
         /**
          * Filter by result status
          */
-        status?: 'sent' | 'failed' | 'skipped' | 'gated';
+        status?: 'pending' | 'sent' | 'failed' | 'skipped' | 'gated';
     };
 };
 type ListCommentAutomationLogsResponse = ({
@@ -25506,9 +25578,9 @@ type ListCommentAutomationLogsResponse = ({
         commenterName?: string;
         commentText?: string;
         /**
-         * DM outcome. 'gated' = the follow-gate confirmation DM went out and we are waiting for the tap; it flips to 'sent' or 'skipped' when they tap.
+         * DM outcome. 'pending' = the automation has a dmDelaySeconds and the response is queued but not sent yet. 'gated' = the follow-gate confirmation DM went out and we are waiting for the tap; it flips to 'sent' or 'skipped' when they tap.
          */
-        status?: 'sent' | 'failed' | 'skipped' | 'gated';
+        status?: 'pending' | 'sent' | 'failed' | 'skipped' | 'gated';
         /**
          * How the audience rule resolved. Absent on automations without one.
          */
@@ -25530,6 +25602,10 @@ type ListCommentAutomationLogsResponse = ({
          * Public-reply error message if commentReplyStatus is failed
          */
         commentReplyError?: string;
+        /**
+         * When the next queued send fires. Present only while something is still pending.
+         */
+        nextDueAt?: string;
         createdAt?: string;
     }>;
     pagination?: {

package/dist/index.d.ts

@@ -47,6 +47,12 @@ interface ClientOptions {
  */
 declare class Zernio {
     private _options;
+    /**
+     * HTTP client owned by this instance. Every namespace method below is bound
+     * to it, so two Zernio instances in the same process never see each other's
+     * credentials.
+     */
+    private _client;
     /**
      * API key used for authentication.
      */
@@ -55,6 +61,13 @@ declare class Zernio {
      * Base URL for API requests.
      */
     baseURL: string;
+    /**
+     * Routes a generated operation through this instance's client, preserving the
+     * operation's own signature. Reads `_client` when the method is called, not
+     * when it is bound, because class fields initialize before the constructor
+     * body runs.
+     */
+    private _bind;
     /**
      * validate API
      */
@@ -2785,6 +2798,15 @@ type ConversionEvent = {
          * Meta advanced matching (ge). 'f' or 'm'; hashed server-side. Meta only.
          */
         gender?: string;
+        /**
+         * Meta lead ID from a Lead Ad submission, as a string. Required
+         * for Conversion Leads CRM events: send it with
+         * `actionSource: 'crm'` and
+         * `platformData: { event_source: 'crm', lead_event_source: '<CRM name>' }`.
+         * Forwarded unhashed to Meta's `user_data.lead_id`. Meta only.
+         *
+         */
+        leadId?: string;
         /**
          * Platform click identifiers captured from the originating ad click.
          */
@@ -2840,7 +2862,13 @@ type ConversionEvent = {
      */
     actionSource?: 'web' | 'app' | 'offline' | 'crm' | 'phone_call' | 'system_generated';
     /**
-     * Escape hatch for platform-specific fields we haven't normalized. Forwarded as-is.
+     * Escape hatch for platform-specific fields we haven't normalized.
+     * On Meta, keys are shallow-merged into `custom_data` only: fields
+     * Zernio already builds (`value`, `currency`, `contents`,
+     * `num_items`) always win on collision, and `user_data` (hashed
+     * match keys) is never touched. Use first-class fields (e.g.
+     * `user.leadId`) for anything that must reach `user_data`.
+     *
      */
     platformData?: {
         [key: string]: unknown;
@@ -25132,6 +25160,14 @@ type ListCommentAutomationsResponse = ({
          * Tag applied to a contact when they click a tracked link.
          */
         clickTag?: string;
+        /**
+         * Seconds waited after the trigger before the DM is sent. Absent when the DM goes out immediately.
+         */
+        dmDelaySeconds?: number;
+        /**
+         * Seconds waited before the public reply is posted. Absent when it follows the DM immediately.
+         */
+        commentReplyDelaySeconds?: number;
         isActive?: boolean;
         stats?: {
             triggered?: number;
@@ -25236,6 +25272,14 @@ type CreateCommentAutomationData = {
          * Optional tag applied to a contact when they click a tracked link (requires linkTracking). Lets you segment clickers for broadcasts/sequences.
          */
         clickTag?: string;
+        /**
+         * Seconds to wait after the trigger before sending the DM. Omit or send 0 to reply immediately (the default). Max 86400 (24h). The trigger is still matched and deduplicated the moment the comment arrives, so a delay only moves when the response is sent.
+         */
+        dmDelaySeconds?: number;
+        /**
+         * Seconds to wait before posting the public comment reply. Omit or send 0 to post it right after the DM (the default). The reply never goes out before the DM, so a value below dmDelaySeconds is raised to it. Ignored when trigger=story_reply, which has no public reply.
+         */
+        commentReplyDelaySeconds?: number;
         audience?: CommentAutomationAudience;
         followGate?: CommentAutomationFollowGate;
     };
@@ -25277,6 +25321,14 @@ type CreateCommentAutomationResponse = ({
         commentReplyVariations?: Array<(string)>;
         linkTracking?: boolean;
         clickTag?: string;
+        /**
+         * Seconds waited after the trigger before the DM is sent. Absent when the DM goes out immediately.
+         */
+        dmDelaySeconds?: number;
+        /**
+         * Seconds waited before the public reply is posted. Absent when it follows the DM immediately.
+         */
+        commentReplyDelaySeconds?: number;
         audience?: CommentAutomationAudience;
         followGate?: CommentAutomationFollowGate;
         isActive?: boolean;
@@ -25336,6 +25388,14 @@ type GetCommentAutomationResponse = ({
         commentReplyVariations?: Array<(string)>;
         linkTracking?: boolean;
         clickTag?: string;
+        /**
+         * Seconds waited after the trigger before the DM is sent. Absent when the DM goes out immediately.
+         */
+        dmDelaySeconds?: number;
+        /**
+         * Seconds waited before the public reply is posted. Absent when it follows the DM immediately.
+         */
+        commentReplyDelaySeconds?: number;
         audience?: CommentAutomationAudience;
         followGate?: CommentAutomationFollowGate;
         isActive?: boolean;
@@ -25354,9 +25414,9 @@ type GetCommentAutomationResponse = ({
         commenterName?: string;
         commentText?: string;
         /**
-         * DM outcome. 'gated' = the follow-gate confirmation DM went out and we are waiting for the tap; it flips to 'sent' or 'skipped' when they tap.
+         * DM outcome. 'pending' = the automation has a dmDelaySeconds and the response is queued but not sent yet. 'gated' = the follow-gate confirmation DM went out and we are waiting for the tap; it flips to 'sent' or 'skipped' when they tap.
          */
-        status?: 'sent' | 'failed' | 'skipped' | 'gated';
+        status?: 'pending' | 'sent' | 'failed' | 'skipped' | 'gated';
         /**
          * How the audience rule resolved. Absent on automations without one.
          */
@@ -25378,6 +25438,10 @@ type GetCommentAutomationResponse = ({
          * Public-reply error message if commentReplyStatus is failed
          */
         commentReplyError?: string;
+        /**
+         * When the next queued send fires. Present only while something is still pending.
+         */
+        nextDueAt?: string;
         createdAt?: string;
     }>;
 });
@@ -25426,6 +25490,14 @@ type UpdateCommentAutomationData = {
          * Tag applied to a contact when they click a tracked link (requires linkTracking). Empty string clears it.
          */
         clickTag?: string;
+        /**
+         * Seconds to wait after the trigger before sending the DM. Send 0 to clear the delay and reply immediately.
+         */
+        dmDelaySeconds?: number;
+        /**
+         * Seconds to wait before posting the public comment reply. Send 0 to clear it. The reply never goes out before the DM.
+         */
+        commentReplyDelaySeconds?: number;
         audience?: CommentAutomationAudience;
         followGate?: CommentAutomationFollowGate;
         isActive?: boolean;
@@ -25494,7 +25566,7 @@ type ListCommentAutomationLogsData = {
         /**
          * Filter by result status
          */
-        status?: 'sent' | 'failed' | 'skipped' | 'gated';
+        status?: 'pending' | 'sent' | 'failed' | 'skipped' | 'gated';
     };
 };
 type ListCommentAutomationLogsResponse = ({
@@ -25506,9 +25578,9 @@ type ListCommentAutomationLogsResponse = ({
         commenterName?: string;
         commentText?: string;
         /**
-         * DM outcome. 'gated' = the follow-gate confirmation DM went out and we are waiting for the tap; it flips to 'sent' or 'skipped' when they tap.
+         * DM outcome. 'pending' = the automation has a dmDelaySeconds and the response is queued but not sent yet. 'gated' = the follow-gate confirmation DM went out and we are waiting for the tap; it flips to 'sent' or 'skipped' when they tap.
          */
-        status?: 'sent' | 'failed' | 'skipped' | 'gated';
+        status?: 'pending' | 'sent' | 'failed' | 'skipped' | 'gated';
         /**
          * How the audience rule resolved. Absent on automations without one.
          */
@@ -25530,6 +25602,10 @@ type ListCommentAutomationLogsResponse = ({
          * Public-reply error message if commentReplyStatus is failed
          */
         commentReplyError?: string;
+        /**
+         * When the next queued send fires. Present only while something is still pending.
+         */
+        nextDueAt?: string;
         createdAt?: string;
     }>;
     pagination?: {