@zernio/node 0.2.188 → 0.2.190

package/src/generated/types.gen.ts

@@ -4836,6 +4836,49 @@ export type WhatsAppHeaderComponent = {
 
 export type format = 'text' | 'image' | 'video' | 'gif' | 'document' | 'location';
 
+/**
+ * A per-user activation session against the shared WhatsApp sandbox number.
+ * Transitions `pending → active` when the inbound webhook receives a reply
+ * from the matching phone (the reply itself proves ownership).
+ *
+ */
+export type WhatsAppSandboxSession = {
+    /**
+     * Session id. Use this to revoke via DELETE.
+     */
+    id: string;
+    /**
+     * Digits-only E.164 form (no +, spaces, or dashes).
+     */
+    phoneE164: string;
+    /**
+     * `pending` until the phone replies to the activation template, then
+     * `active`. Expired sessions are pruned by TTL and never appear in
+     * list responses.
+     *
+     */
+    status: 'pending' | 'active';
+    /**
+     * UTC timestamp at which the session becomes invalid. Pending sessions
+     * get a 24h window; activated sessions get 7 days.
+     *
+     */
+    expiresAt: string;
+    /**
+     * When the session transitioned `pending → active`, or null.
+     */
+    activatedAt?: (string) | null;
+    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 status9 = 'pending' | 'active';
+
 export type WhatsAppTemplateButton = {
     type: 'quick_reply' | 'url' | 'phone_number' | 'otp' | 'flow' | 'mpm' | 'catalog';
     text: string;
@@ -4874,6 +4917,53 @@ export type otp_type = 'copy_code' | 'one_tap' | 'zero_tap';
 
 export type WhatsAppTemplateComponent = WhatsAppHeaderComponent | WhatsAppBodyComponent | WhatsAppFooterComponent | WhatsAppButtonsComponent;
 
+/**
+ * A directed edge between two nodes.
+ */
+export type WorkflowEdge = {
+    id: string;
+    /**
+     * Source node id
+     */
+    source: string;
+    /**
+     * Target node id
+     */
+    target: string;
+    /**
+     * Selects a branch output of a multi-output node: a condition rule id or 'default'; 'reply' or 'timeout' for wait_for_reply; 'success' or 'error' for webhook. Null = the node's single/default output.
+     *
+     */
+    sourceHandle?: (string) | null;
+};
+
+/**
+ * A node in a workflow graph. `config` shape depends on `type`.
+ */
+export type WorkflowNode = {
+    /**
+     * Stable node id referenced by edges
+     */
+    id: string;
+    type: 'trigger' | 'send_message' | 'wait_for_reply' | 'condition' | 'set_variable' | 'delay' | 'webhook' | 'handoff' | 'end';
+    /**
+     * Type-specific settings. trigger: { keywords:[string], matchType: any|contains|exact|regex, onlyFirstMessage:boolean }. send_message: { messageType: text|template|media|interactive, text, template:{name,language,variableMapping}, media:{mediaType,url,caption}, interactive } (template/interactive are WhatsApp-only). wait_for_reply: { timeoutMinutes:int, saveAs:string }. condition: { rules:[{ id, variable, operator: equals|not_equals|contains|not_contains|starts_with|ends_with|exists|not_exists|matches, value }] }. set_variable: { assignments:[{ name, value }] }. delay: { delayMinutes:int }. webhook: { url, method, headers, bodyTemplate, saveAs }. handoff: { note, assignTo }. String fields support {{variable}} interpolation.
+     *
+     */
+    config?: {
+        [key: string]: unknown;
+    };
+    /**
+     * Canvas coordinates (ignored by the executor; used by the future visual builder).
+     */
+    position?: {
+        x?: number;
+        y?: number;
+    };
+};
+
+export type type7 = 'trigger' | 'send_message' | 'wait_for_reply' | 'condition' | 'set_variable' | 'delay' | 'webhook' | 'handoff' | 'end';
+
 /**
  * A single X API operation with its per-call price and the Zernio platform methods that trigger it.
  */
@@ -13379,6 +13469,22 @@ export type GetWhatsAppPhoneNumbersResponse = ({
         metaVerificationStatus?: string;
         createdAt?: string;
     }>;
+    /**
+     * The shared WhatsApp sandbox (one Zernio-owned number, all users test
+     * against it). Present when the sandbox is configured; null otherwise.
+     * The `accountId` lets you address the sandbox in compose endpoints.
+     * `template` is the only template a sandbox send is allowed to use.
+     *
+     */
+    sandbox?: {
+        phoneNumber?: string;
+        accountId?: (string) | null;
+        template?: {
+            name?: string;
+            language?: string;
+        };
+        isSandbox?: boolean;
+    } | null;
 });
 
 export type GetWhatsAppPhoneNumbersError = ({
@@ -13465,6 +13571,53 @@ export type ReleaseWhatsAppPhoneNumberError = (unknown | {
     error?: string;
 });
 
+export type ListWhatsAppSandboxSessionsResponse = ({
+    sessions?: Array<WhatsAppSandboxSession>;
+    /**
+     * The shared sandbox phone number in E.164 form.
+     */
+    sandboxNumber?: (string) | null;
+});
+
+export type ListWhatsAppSandboxSessionsError = ({
+    error?: string;
+} | unknown);
+
+export type CreateWhatsAppSandboxSessionData = {
+    body: {
+        /**
+         * Recipient phone in international format. Digits, spaces, dashes and a leading `+` are all accepted; the server normalizes to E.164 digits-only.
+         */
+        phone: string;
+    };
+};
+
+export type CreateWhatsAppSandboxSessionResponse = ({
+    session?: WhatsAppSandboxSession;
+    sandboxNumber?: string;
+});
+
+export type CreateWhatsAppSandboxSessionError = (unknown | {
+    error?: string;
+});
+
+export type DeleteWhatsAppSandboxSessionData = {
+    path: {
+        /**
+         * The session id returned by POST /v1/whatsapp/sandbox/sessions.
+         */
+        sessionId: string;
+    };
+};
+
+export type DeleteWhatsAppSandboxSessionResponse = ({
+    success?: boolean;
+});
+
+export type DeleteWhatsAppSandboxSessionError = (unknown | {
+    error?: string;
+});
+
 export type ListWhatsAppGroupChatsData = {
     query: {
         /**
@@ -15026,6 +15179,275 @@ export type AddBroadcastRecipientsError = ({
     error?: string;
 });
 
+export type ListWorkflowsData = {
+    query?: {
+        limit?: number;
+        /**
+         * Filter by profile. Omit to list across all profiles
+         */
+        profileId?: string;
+        skip?: number;
+        status?: 'draft' | 'active' | 'paused';
+    };
+};
+
+export type ListWorkflowsResponse = ({
+    success?: boolean;
+    workflows?: Array<{
+        id?: string;
+        name?: string;
+        description?: string;
+        platform?: string;
+        accountId?: string;
+        accountName?: string;
+        status?: 'draft' | 'active' | 'paused';
+        nodeCount?: number;
+        totalStarted?: number;
+        totalCompleted?: number;
+        totalExited?: number;
+        createdAt?: string;
+    }>;
+    pagination?: {
+        total?: number;
+        limit?: number;
+        skip?: number;
+        hasMore?: boolean;
+    };
+});
+
+export type ListWorkflowsError = ({
+    error?: string;
+});
+
+export type CreateWorkflowData = {
+    body: {
+        profileId: string;
+        accountId: string;
+        platform?: 'whatsapp' | 'instagram' | 'facebook' | 'telegram' | 'twitter' | 'bluesky' | 'reddit';
+        name: string;
+        description?: string;
+        nodes?: Array<WorkflowNode>;
+        edges?: Array<WorkflowEdge>;
+        /**
+         * The trigger node id; derived from the single trigger node if omitted
+         */
+        entryNodeId?: string;
+    };
+};
+
+export type CreateWorkflowResponse = ({
+    success?: boolean;
+    workflow?: {
+        id?: string;
+        name?: string;
+        description?: string;
+        platform?: string;
+        status?: string;
+        nodeCount?: number;
+        entryNodeId?: string;
+        createdAt?: string;
+    };
+});
+
+export type CreateWorkflowError = (unknown | {
+    error?: string;
+});
+
+export type GetWorkflowData = {
+    path: {
+        workflowId: string;
+    };
+};
+
+export type GetWorkflowResponse = ({
+    success?: boolean;
+    workflow?: {
+        id?: string;
+        name?: string;
+        description?: string;
+        platform?: string;
+        accountId?: string;
+        profileId?: string;
+        status?: 'draft' | 'active' | 'paused';
+        entryNodeId?: string;
+        nodes?: Array<WorkflowNode>;
+        edges?: Array<WorkflowEdge>;
+        totalStarted?: number;
+        totalCompleted?: number;
+        totalExited?: number;
+        createdAt?: string;
+        updatedAt?: string;
+    };
+});
+
+export type GetWorkflowError = ({
+    error?: string;
+});
+
+export type UpdateWorkflowData = {
+    body?: {
+        name?: string;
+        description?: string;
+        nodes?: Array<WorkflowNode>;
+        edges?: Array<WorkflowEdge>;
+        entryNodeId?: (string) | null;
+    };
+    path: {
+        workflowId: string;
+    };
+};
+
+export type UpdateWorkflowResponse = ({
+    success?: boolean;
+    workflow?: {
+        id?: string;
+        name?: string;
+        description?: string;
+        status?: string;
+        entryNodeId?: string;
+        nodeCount?: number;
+        updatedAt?: string;
+    };
+});
+
+export type UpdateWorkflowError = (unknown | {
+    error?: string;
+});
+
+export type DeleteWorkflowData = {
+    path: {
+        workflowId: string;
+    };
+};
+
+export type DeleteWorkflowResponse = (unknown);
+
+export type DeleteWorkflowError = ({
+    error?: string;
+});
+
+export type ActivateWorkflowData = {
+    path: {
+        workflowId: string;
+    };
+};
+
+export type ActivateWorkflowResponse = ({
+    success?: boolean;
+    workflow?: {
+        id?: string;
+        status?: string;
+        entryNodeId?: string;
+    };
+});
+
+export type ActivateWorkflowError = (unknown | {
+    error?: string;
+});
+
+export type PauseWorkflowData = {
+    path: {
+        workflowId: string;
+    };
+};
+
+export type PauseWorkflowResponse = ({
+    success?: boolean;
+    workflow?: {
+        id?: string;
+        status?: string;
+    };
+});
+
+export type PauseWorkflowError = ({
+    error?: string;
+});
+
+export type ListWorkflowExecutionsData = {
+    path: {
+        workflowId: string;
+    };
+    query?: {
+        limit?: number;
+        skip?: number;
+        status?: 'running' | 'waiting' | 'completed' | 'exited' | 'failed';
+    };
+};
+
+export type ListWorkflowExecutionsResponse = ({
+    success?: boolean;
+    executions?: Array<{
+        id?: string;
+        status?: 'running' | 'waiting' | 'completed' | 'exited' | 'failed';
+        currentNodeId?: string;
+        waitingFor?: {
+            kind?: 'timer' | 'reply';
+            nodeId?: string;
+        } | null;
+        variables?: {
+            [key: string]: unknown;
+        };
+        platformIdentifier?: string;
+        conversationId?: string;
+        stepCount?: number;
+        lastError?: (string) | null;
+        resumeAt?: (string) | null;
+        createdAt?: string;
+        updatedAt?: string;
+        completedAt?: (string) | null;
+    }>;
+    pagination?: {
+        total?: number;
+        limit?: number;
+        skip?: number;
+        hasMore?: boolean;
+    };
+});
+
+export type ListWorkflowExecutionsError = ({
+    error?: string;
+});
+
+export type TriggerWorkflowData = {
+    body: {
+        /**
+         * Recipient phone (WhatsApp only)
+         */
+        to?: string;
+        /**
+         * An existing conversation to run in (required for non-WhatsApp workflows)
+         */
+        conversationId?: string;
+        /**
+         * Simulated inbound text
+         */
+        text?: string;
+    };
+    path: {
+        workflowId: string;
+    };
+};
+
+export type TriggerWorkflowResponse = ({
+    success?: boolean;
+    execution?: {
+        id?: string;
+        status?: string;
+        currentNodeId?: string;
+        waitingFor?: {
+            [key: string]: unknown;
+        } | null;
+        variables?: {
+            [key: string]: unknown;
+        };
+        conversationId?: string;
+    } | null;
+});
+
+export type TriggerWorkflowError = (unknown | {
+    error?: string;
+});
+
 export type ListSequencesData = {
     query?: {
         limit?: number;