@opencx/mcp 1.15.28 → 1.15.30

package/dist/schema.d.ts

@@ -398,7 +398,7 @@ export interface paths {
         put?: never;
         /**
          * Assign or unassign a chat session
-         * @description Assign a chat session to a human agent by user ID, or set assignee_id to null to unassign it.
+         * @description Assign a chat session to a human agent, named either by `assignee_id` or by `assignee_email` — exactly one. The email is matched case-insensitively against this organization’s members, so a sync can assign straight from the address it already holds. Send either field as null to unassign. A teammate who is not a member of this organization is rejected.
          */
         post: operations["assignChatSession"];
         delete?: never;
@@ -616,6 +616,50 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/chat/sessions/{session_id}/follow-ups": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * List the AI follow-ups scheduled on a chat session
+         * @description Every follow-up scheduled on this session, pending ones first. A follow-up stays listed after it fires or is cancelled, with `is_active` false.
+         */
+        get: operations["listChatSessionFollowUps"];
+        put?: never;
+        /**
+         * Schedule an AI follow-up on a chat session
+         * @description Schedules the AI to continue this session later with the given prompt as guidance. At most 5 pending and 50 total follow-ups per session (409 when exceeded). Requires the scheduled follow-ups feature (403 otherwise).
+         */
+        post: operations["createChatSessionFollowUp"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/chat/sessions/{session_id}/follow-ups/{follow_up_id}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        post?: never;
+        /**
+         * Cancel a pending AI follow-up
+         * @description Cancels a pending follow-up so it never fires. Cancelling one that already fired or was cancelled is a no-op and returns it as is.
+         */
+        delete: operations["cancelChatSessionFollowUp"];
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/companies": {
         parameters: {
             query?: never;
@@ -3136,7 +3180,7 @@ export interface paths {
         };
         /**
          * List the mailboxes this org can bind as sequence email senders
-         * @description Every email mailbox of the organization with its bindability verdict AND its health NUMBERS. `eligible` mailboxes are accepted by setSequenceSenders on the email channel; ineligible ones carry the reason (`not_active` — still provisioning or paused; `domain_not_live` — its domain lapsed, so sending would fail authentication). `health` carries warm-up status, inbox rate, spam rate, an overall score, warming-since, and the share of recent real sends that hard-bounced with its sample size. There is deliberately no pass/fail: a null is "not known yet" (common for a new mailbox), never "bad", and nothing here blocks a send or a binding.
+         * @description Every email mailbox of the organization with its bindability verdict AND its health NUMBERS. `eligible` mailboxes are accepted by setSequenceSenders on the email channel — including a mailbox still provisioning (`pending`/`created`): binding it early is safe, sending itself waits for the mailbox to finish becoming `active` on its own. Ineligible ones carry the reason (`not_active` — a human hold or the mailbox being removed, neither of which resolves on its own; `domain_not_live` — its domain lapsed, so sending would fail authentication). `health` carries warm-up status, inbox rate, spam rate, an overall score, warming-since, and the share of recent real sends that hard-bounced with its sample size. There is deliberately no pass/fail: a null is "not known yet" (common for a new mailbox), never "bad", and nothing here blocks a send or a binding.
          */
         get: operations["listEmailSenders"];
         put?: never;
@@ -3282,7 +3326,10 @@ export interface paths {
         };
         get?: never;
         put?: never;
-        /** Launch an outbound sequence — arms candidates for sending */
+        /**
+         * Launch an outbound sequence — arms candidates for sending
+         * @description If the launch preview carries a regulatory_notice (voice steps into regulated countries), show it to a person and pass regulatory_acknowledged: true so the confirmation is recorded with the notice text. Informational — never blocks.
+         */
         post: operations["launchSequence"];
         delete?: never;
         options?: never;
@@ -6213,6 +6260,8 @@ export interface components {
             support_office_hours_id?: string | null;
             /** @enum {string} */
             support_assignment_strategy?: "least-busy" | "round-robin" | "unassigned";
+            /** @description Seconds between automatic assignments to the same agent under the least-busy strategy: 0 turns pacing off, otherwise 15 to 3600. */
+            auto_assign_interval_seconds?: number;
         };
         CreateMiniAppDto: {
             name: string;
@@ -6517,6 +6566,10 @@ export interface components {
                 type?: "string" | "number" | "boolean" | "date" | "string[]" | "number[]";
             }[];
         };
+        LaunchSequenceInputDto: {
+            /** @description True when the user was shown the regulatory notice and confirmed it — recorded with the notice text as shown, purely as a record. Never required; the launch behaves identically without it. */
+            regulatory_acknowledged?: boolean | null;
+        };
         SetSequenceStepsDto: {
             /** @description The full step list, replacing whatever is stored. Same validation as create: step 0 must have delay_minutes 0. */
             steps: ({
@@ -7215,7 +7268,9 @@ export interface components {
         };
         SessionAssigneeUpdateInput: {
             /** @description Agent user ID to assign, or null to unassign the session */
-            assignee_id: number | null;
+            assignee_id?: number | null;
+            /** @description Email of the agent to assign, matched case-insensitively against this organization’s members, or null to unassign the session */
+            assignee_email?: string | null;
         };
         SessionTeamTransferInput: {
             /**
@@ -7347,6 +7402,12 @@ export interface components {
              */
             limit: number;
         };
+        CreateChatSessionFollowUpInput: {
+            /** @description Minutes from now until the AI continues the session (1–43200, i.e. up to 30 days). The reply runs at the first whole minute at or after that moment. */
+            delay_minutes: number;
+            /** @description Guidance for the fired reply — what to check or say when the session is continued. Not shown to the contact. */
+            prompt: string;
+        };
         UpdatePublicKnowledgebaseItem: {
             /** @description Contact segment ids this item should be restricted to. Pass [] to make it available to all contacts. */
             restricted_to_segments?: string[];
@@ -7368,11 +7429,6 @@ export interface components {
             channel: "web" | "email" | "phone" | "whatsapp" | "slack" | "sms" | "instagram" | "messenger" | "api" | "web_voice";
             /** @description Set true to enable autopilot, false to disable */
             autopilot_enabled: boolean;
-            /**
-             * @description AI agent version to use for this channel
-             * @enum {string}
-             */
-            ai_agent_version?: "v1" | "v2";
         };
         UpdateProhibitedTopicsInputDto: {
             /** @description Full replacement list of prohibited topics. Each entry is either a name string or an object with a name and an optional description. A name-only entry keeps whatever description that topic already has. Empty array clears all topics. Duplicates and blank entries are removed. */
@@ -8303,7 +8359,7 @@ export interface components {
                         /** @constant */
                         type: "response_skipped";
                         /** @enum {string} */
-                        reason?: "empty_response" | "potential_answers_dead_end" | "silent_handoff" | "assist_human_handling_recommended" | "superseded_by_newer_run" | "flagged_as_spam";
+                        reason?: "empty_response" | "potential_answers_dead_end" | "silent_handoff" | "assist_human_handling_recommended" | "superseded_by_newer_run" | "interrupted" | "flagged_as_spam";
                         reasoning?: ({
                             /** @constant */
                             type: "reasoning";
@@ -8447,6 +8503,10 @@ export interface components {
                             id: string;
                             name: string;
                         }[];
+                        /** @default null */
+                        pacing_until: string | null;
+                        /** @default null */
+                        skip_reason: "pacing" | null;
                     } | null;
                     peers: {
                         agent_id: number;
@@ -8464,6 +8524,10 @@ export interface components {
                             id: string;
                             name: string;
                         }[];
+                        /** @default null */
+                        pacing_until: string | null;
+                        /** @default null */
+                        skip_reason: "pacing" | null;
                     }[];
                     /** @default [] */
                     required_skills: {
@@ -8549,6 +8613,10 @@ export interface components {
                             id: string;
                             name: string;
                         }[];
+                        /** @default null */
+                        pacing_until: string | null;
+                        /** @default null */
+                        skip_reason: "pacing" | null;
                     } | null;
                     peers: {
                         agent_id: number;
@@ -8566,6 +8634,10 @@ export interface components {
                             id: string;
                             name: string;
                         }[];
+                        /** @default null */
+                        pacing_until: string | null;
+                        /** @default null */
+                        skip_reason: "pacing" | null;
                     }[];
                     /** @default [] */
                     required_skills: {
@@ -9137,6 +9209,7 @@ export interface components {
             support_office_hours_id: string | null;
             /** @enum {string} */
             support_assignment_strategy: "least-busy" | "round-robin" | "unassigned";
+            auto_assign_interval_seconds: number;
             zendesk_group_id: string | null;
             zendesk_group_channels: components["schemas"]["SessionChannel"][] | null;
             created_at: string | null;
@@ -10275,6 +10348,49 @@ export interface components {
                 nullable: boolean;
             }[];
         };
+        SequenceRegulatoryNoticeDto: {
+            /** @description ISO 3166-1 alpha-2, sorted. */
+            countries: string[];
+            /** @description The checklist the confirmation refers to — show it with the country rules. */
+            points: string[];
+            cards: {
+                /** @description ISO 3166-1 alpha-2. */
+                code: string;
+                name: string;
+                /** @enum {string} */
+                consent: "opt_in" | "opt_out" | "opt_in_b2c_opt_out_b2b" | "unregulated" | "unknown";
+                consent_note: string;
+                hours: {
+                    weekdays: string;
+                    saturday: string;
+                    sunday: string;
+                    holidays: string;
+                    /** @enum {string} */
+                    clock: "called_party" | "national" | "unknown";
+                    /**
+                     * @description Say "required" only for statute/regulation; the rest is guidance.
+                     * @enum {string}
+                     */
+                    basis: "statute" | "regulation" | "code_of_conduct" | "regulator_guidance" | "partial" | "none" | "unknown";
+                    note: string;
+                };
+                frequency: string | null;
+                dnc: string;
+                ai_disclosure: string;
+                recording: string;
+                origination: string;
+                /** @enum {string} */
+                origination_kind: "foreign_origin_prohibited" | "local_number_required" | "dedicated_prefix_required" | "registered_series_required" | "own_listed_number_required" | "cli_must_be_presented" | "none_found";
+                penalties: string;
+                /** @description Automated marketing calls are a prohibited class here regardless of consent. */
+                prohibited: boolean;
+                links: {
+                    name: string;
+                    url: string;
+                }[];
+                last_reviewed: string;
+            }[];
+        };
         LaunchPreviewDto: {
             /** @description A FORECAST of how many would start sending, not a promise: consent and suppression are re-checked at claim time and fail closed. */
             will_send: number;
@@ -10303,6 +10419,8 @@ export interface components {
                 language: string;
                 status: string;
             }[];
+            /** @description Informational: present when the campaign has voice steps reaching a catalogued country. Show it before launching and pass regulatory_acknowledged: true when the user confirms — the launch itself never refuses over it. Null: nothing to show. */
+            regulatory_notice: components["schemas"]["SequenceRegulatoryNoticeDto"] | null;
         };
         SequenceSendersDto: {
             senders: {
@@ -11381,9 +11499,31 @@ export interface components {
             /** Format: uuid */
             id: string;
         };
+        SessionTagOutput: {
+            tag_name: string;
+            /** Format: date-time */
+            created_at: string;
+        };
+        /** @description Current session assignment. AI and unassigned sessions have no assignee ID. */
+        ChatSessionAssignee: {
+            /** @constant */
+            type: "human";
+            /** @description Human user ID, matching the numeric ID in GET /users. */
+            id: number;
+            /** @description Current organization display name, matching GET /users, or null if the user is no longer a member of this organization or cannot be found. The recorded human ID is retained. */
+            name: string | null;
+        } | {
+            /** @constant */
+            type: "ai";
+        } | {
+            /** @constant */
+            type: "none";
+        };
         GetChatSessionOutput: {
             /** Format: uuid */
             id: string;
+            /** @description All tags currently assigned to this session, ordered by tag name. Empty when no tags are assigned. */
+            tags: components["schemas"]["SessionTagOutput"][];
             /** @enum {string} */
             status: "open" | "closed_resolved" | "closed_unresolved";
             /** @description Id of the custom status refining `status`, or null when only the built-in status applies. Resolve it with GET /custom-statuses. */
@@ -11415,7 +11555,12 @@ export interface components {
                 } | null;
             };
             language?: string;
+            /**
+             * @deprecated
+             * @description Deprecated: use assignee. Contains the recorded human user ID as a string, or null for AI and unassigned sessions. Use assignee.type to distinguish them. This deprecation applies only to response fields; assignment requests still accept assignee_id.
+             */
             assignee_id?: string | null;
+            assignee: components["schemas"]["ChatSessionAssignee"];
             /** @description Session-level custom data stored on the chat session. */
             custom_data?: {
                 [key: string]: string | number | boolean;
@@ -11426,6 +11571,15 @@ export interface components {
                 name: string;
                 description?: string;
             };
+            /** @description Support team assigned to this session. Null when no team can be resolved within the session organization. */
+            support_team: {
+                /**
+                 * Format: uuid
+                 * @description Stable team ID, preserved when the team is renamed.
+                 */
+                id: string;
+                name: string;
+            } | null;
             handoff?: {
                 /** @enum {string} */
                 sentiment?: "angry" | "happy" | "neutral";
@@ -11444,6 +11598,8 @@ export interface components {
             created_at: string;
             /** Format: date-time */
             updated_at: string;
+            /** @description Timestamp of the first recorded human reply to this session. Null when no human reply has been recorded. */
+            first_human_message_at: string | null;
         };
         SessionAssigneeUpdateOutput: {
             no_change: boolean;
@@ -11456,11 +11612,6 @@ export interface components {
             no_change: boolean;
             session: components["schemas"]["GetChatSessionOutput"];
         };
-        SessionTagOutput: {
-            tag_name: string;
-            /** Format: date-time */
-            created_at: string;
-        };
         SessionTagMutationOutput: {
             /** Format: uuid */
             session_id: string;
@@ -11560,6 +11711,10 @@ export interface components {
                                     id: string;
                                     name: string;
                                 }[];
+                                /** @default null */
+                                pacing_until: string | null;
+                                /** @default null */
+                                skip_reason: "pacing" | null;
                             } | null;
                             peers: {
                                 agent_id: number;
@@ -11577,6 +11732,10 @@ export interface components {
                                     id: string;
                                     name: string;
                                 }[];
+                                /** @default null */
+                                pacing_until: string | null;
+                                /** @default null */
+                                skip_reason: "pacing" | null;
                             }[];
                             /** @default [] */
                             required_skills: {
@@ -11913,6 +12072,28 @@ export interface components {
                 };
             };
         };
+        ChatSessionFollowUpOutput: {
+            /** @description Follow-up id — stable across the follow-up’s lifetime */
+            id: string;
+            session_id: string;
+            ticket_number: number;
+            prompt: string;
+            /**
+             * Format: date-time
+             * @description When the follow-up fires (UTC)
+             */
+            fire_at: string;
+            is_active: boolean;
+            /** Format: date-time */
+            created_at: string;
+        };
+        ChatSessionFollowUpListOutput: {
+            follow_ups: components["schemas"]["ChatSessionFollowUpOutput"][];
+            limits: {
+                max_active_per_session: number;
+                max_total_per_session: number;
+            };
+        };
         ContactSegment: {
             id: string;
             name: string;
@@ -12159,11 +12340,6 @@ export interface components {
                 channel: string;
                 /** @description Whether the AI autopilot is enabled on this channel */
                 autopilot_enabled: boolean;
-                /**
-                 * @description AI agent version used on this channel
-                 * @enum {string}
-                 */
-                ai_agent_version: "v1" | "v2";
             }[];
         };
         ProhibitedTopicsResponseDto: {
@@ -12649,7 +12825,7 @@ export interface components {
                  * @description Which jsonb bag the key was observed in: contact vs session, verified vs not.
                  * @enum {string}
                  */
-                source: "contact_custom_data" | "contact_non_verified_custom_data" | "session_custom_data" | "session_editable_custom_data";
+                source: "company_custom_data" | "contact_custom_data" | "contact_non_verified_custom_data" | "session_custom_data" | "session_editable_custom_data";
             }[];
             total: number;
         };
@@ -14618,6 +14794,108 @@ export interface operations {
             };
         };
     };
+    listChatSessionFollowUps: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                /** @description The unique identifier of the chat session */
+                session_id: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Default Response */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ChatSessionFollowUpListOutput"];
+                };
+            };
+            /** @description Internal Server Error */
+            500: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ErrorDto"];
+                };
+            };
+        };
+    };
+    createChatSessionFollowUp: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                /** @description The unique identifier of the chat session */
+                session_id: string;
+            };
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["CreateChatSessionFollowUpInput"];
+            };
+        };
+        responses: {
+            /** @description Default Response */
+            201: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ChatSessionFollowUpOutput"];
+                };
+            };
+            /** @description Internal Server Error */
+            500: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ErrorDto"];
+                };
+            };
+        };
+    };
+    cancelChatSessionFollowUp: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                /** @description The unique identifier of the chat session */
+                session_id: string;
+                /** @description The follow-up id returned when it was scheduled */
+                follow_up_id: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Default Response */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ChatSessionFollowUpOutput"];
+                };
+            };
+            /** @description Internal Server Error */
+            500: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ErrorDto"];
+                };
+            };
+        };
+    };
     listCompanies: {
         parameters: {
             query?: {
@@ -20576,7 +20854,11 @@ export interface operations {
             };
             cookie?: never;
         };
-        requestBody?: never;
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["LaunchSequenceInputDto"] | null;
+            };
+        };
         responses: {
             /** @description Default Response */
             201: {
@@ -21269,7 +21551,7 @@ export interface operations {
         parameters: {
             query?: {
                 /** @description Filter to specific bags; default: all four. */
-                sources?: ("contact_custom_data" | "contact_non_verified_custom_data" | "session_custom_data" | "session_editable_custom_data")[];
+                sources?: ("company_custom_data" | "contact_custom_data" | "contact_non_verified_custom_data" | "session_custom_data" | "session_editable_custom_data")[];
                 /** @description Case-insensitive substring match on the key. */
                 search?: string;
                 /** @description Default 500. */