@opencx/mcp 1.11.46 → 1.11.63

package/dist/schema.d.ts

@@ -1082,10 +1082,12 @@ export interface paths {
         put?: never;
         /**
          * Send emails
-         * @description Send emails to multiple contacts, possibly with a time delay.
+         * @description
+         *     Send emails to multiple contacts, possibly with a time delay.
          *
          *     To send emails using the API, you must first verify the domain you want to
          *     send emails from. You can add and verify custom domains in the settings.
+         *
          */
         post: operations["sendEmail"];
         delete?: never;
@@ -1103,12 +1105,16 @@ export interface paths {
         };
         /**
          * List all custom domains
-         * @description List all custom domains for your organization, including their verification status and DNS records.
+         * @description
+         *     List all custom domains for your organization, including their verification status and DNS records.
+         *
          */
         get: operations["listCustomDomains"];
         /**
          * Add or update a custom domain for email sending
-         * @description Add or update a custom domain for sending emails. After adding a domain, you'll need to verify it by adding the provided DNS records.
+         * @description
+         *     Add or update a custom domain for sending emails. After adding a domain, you'll need to verify it by adding the provided DNS records.
+         *
          */
         put: operations["putCustomDomain"];
         post?: never;
@@ -1133,7 +1139,9 @@ export interface paths {
         head?: never;
         /**
          * Start verification process for a custom domain
-         * @description Start the verification process for a custom domain. Make sure you've added the DNS records before starting verification.
+         * @description
+         *     Start the verification process for a custom domain. Make sure you've added the DNS records before starting verification.
+         *
          */
         patch: operations["startVerifyingCustomDomain"];
         trace?: never;
@@ -1150,7 +1158,9 @@ export interface paths {
         post?: never;
         /**
          * Delete a custom domain
-         * @description Delete a custom domain from your organization. This will prevent you from sending emails from this domain.
+         * @description
+         *     Delete a custom domain from your organization. This will prevent you from sending emails from this domain.
+         *
          */
         delete: operations["deleteCustomDomain"];
         options?: never;
@@ -2006,10 +2016,12 @@ export interface paths {
         put?: never;
         /**
          * Add contacts to a continuous sequence
-         * @description Add contacts to a continuous sequence (`is_continuous` property of the sequence must be `true`).
+         * @description
+         *     Add contacts to a continuous sequence (`is_continuous` property of the sequence must be `true`).
          *     Contacts will *not* be added to the sequence if the sequence's `filter` does not apply to the contact.
          *
          *     Any contacts added will automatically be added to contacts if they don't already exist.
+         *
          */
         post: operations["addContactsToSequence"];
         delete?: never;
@@ -2568,6 +2580,50 @@ export interface paths {
          */
         get: operations["getCategories"];
         put?: never;
+        /**
+         * Create a category
+         * @description Create a new user-defined category.
+         */
+        post: operations["createCategory"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/insights/categories/usage": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Get category usage
+         * @description Active category counts by type, the total, and the cap.
+         */
+        get: operations["getCategoryUsage"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/insights/categories/{categoryId}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        /**
+         * Update a category
+         * @description Rename or re-describe a category. Suggested categories must be approved first.
+         */
+        put: operations["updateCategory"];
         post?: never;
         delete?: never;
         options?: never;
@@ -2575,6 +2631,46 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/insights/categories/approve": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Approve a suggested category
+         * @description Promote an AI-suggested category to a user-defined (permanent) one.
+         */
+        post: operations["approveCategory"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/insights/categories/reject": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Reject a suggested category
+         * @description Reject an AI-suggested category and reassign its insights to a fallback category.
+         */
+        post: operations["rejectCategory"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/insights/{id}": {
         parameters: {
             query?: never;
@@ -3652,6 +3748,28 @@ export interface components {
                 }[];
             }[];
         };
+        CreateVocCategoryDto: {
+            name: string;
+            description?: string | null;
+        };
+        UpdateCategoryDto: {
+            name?: string;
+            description?: string | null;
+        };
+        ApproveSuggestionDto: {
+            /** Format: uuid */
+            categoryId: string;
+        };
+        RejectSuggestionDto: {
+            reason?: string | null;
+            /** Format: uuid */
+            categoryId: string;
+            /**
+             * Format: uuid
+             * @description to assign the insights to another category
+             */
+            fallbackCategoryId: string;
+        };
         GetVocQueryDto: {
             /** @description Filter by category name */
             category?: string | null;
@@ -4050,11 +4168,9 @@ export interface components {
         CreateChatSessionInput: {
             /** Format: uuid */
             contact_id?: string;
-            /**
-             * @default {
+            /** @default {
              *       "type": "api"
-             *     }
-             */
+             *     } */
             channel: {
                 type: components["schemas"]["SessionChannel"];
             };
@@ -4380,6 +4496,10 @@ export interface components {
             metadata?: {
                 [key: string]: unknown;
             };
+            /** @description ISO 8601 instant (UTC) when the AI may start using this instruction. Null clears the start bound. */
+            start_time?: string | null;
+            /** @description ISO 8601 instant (UTC) when the AI stops using this instruction. Null clears the end bound. */
+            end_time?: string | null;
         };
         ApplyTrainingDiffDto: {
             /** @description Pre-rendered TipTap diff HTML */
@@ -4750,7 +4870,196 @@ export interface components {
             translated_language?: string | null;
             created_at?: string | null;
             updated_at?: string | null;
-            debug_json?: string | null;
+            debug_json?: ({
+                v2: {
+                    response: ({
+                        /** @constant */
+                        type: "prohibited_topic";
+                        topic: string;
+                    } | {
+                        /** @constant */
+                        type: "response_skipped";
+                    } | {
+                        /** @constant */
+                        type: "response";
+                        responseText: string;
+                        responseTextWithReferences: string;
+                        context: {
+                            knowledgeBaseItems: {
+                                itemId: string;
+                                chunkIndex: number;
+                                title: string;
+                                url?: string;
+                            }[];
+                            instructions: {
+                                id: string;
+                                title: string;
+                            }[];
+                            tools: {
+                                name: string;
+                            }[];
+                        };
+                        reasoning: ({
+                            /** @constant */
+                            type: "reasoning";
+                            content: string;
+                        } | {
+                            /** @constant */
+                            type: "tool_call";
+                            call_id: string;
+                            tool_name: string;
+                            action?: {
+                                name: string;
+                                id: string;
+                                openapi?: {
+                                    openapi_spec_id?: string;
+                                    operation_spec: unknown;
+                                    operation_id?: string;
+                                    operation_method?: string;
+                                };
+                                metadata: unknown;
+                                required_form_submission?: boolean;
+                                is_handoff_like?: boolean;
+                            };
+                            call_arguments: string;
+                            call_result: string;
+                        })[];
+                        /** @description Quick reply suggestions for the user */
+                        quickReplySuggestions: {
+                            toolName?: string | null;
+                            suggestions: string[];
+                        }[];
+                        /** @description If your answer might solve the user's issue, return true, otherwise false. Note: once the user confirms it is solved, stop returning true */
+                        mightSolveUserIssue: boolean;
+                        /** @description True if your answer to the user completely covers the issue from knowledge and tools, and no further user input is needed. False if your answer is generic or is not specific to the issue. */
+                        completelyAndFullyCoveredUserIssue?: boolean;
+                    }) & {
+                        /** @enum {string} */
+                        language: "en" | "fr" | "de" | "nl" | "pl" | "pt" | "es" | "it" | "ru" | "ja" | "ko" | "zh" | "ar" | "tr" | "sv" | "da" | "no" | "fi" | "el" | "cs" | "hu" | "th" | "vi" | "id" | "he" | "hi" | "uk" | "ro" | "bg" | "hr" | "sk" | "sl" | "sr" | "et" | "lv" | "lt" | "is" | "ga" | "ms" | "tl" | "fa" | "bn" | "ta" | "te" | "ur" | "sw" | "zu" | "af" | "sq" | "hy" | "az" | "eu" | "be" | "bs" | "ca" | "cy" | "ku" | "ckb" | "kmr";
+                    };
+                };
+                /** @default null */
+                assignment_choice_summary: {
+                    /** @constant */
+                    strategy: "least-busy";
+                    selected: {
+                        agent_id: number;
+                        agent_name: string;
+                        active_sessions: number;
+                        active_sessions_in_group: number;
+                        pending_sessions: number;
+                        remaining_capacity: number;
+                        max_capacity: number;
+                        max_capacity_in_group: number | null;
+                        is_available_globally: boolean;
+                        is_available_in_group: boolean;
+                    } | null;
+                    peers: {
+                        agent_id: number;
+                        agent_name: string;
+                        active_sessions: number;
+                        active_sessions_in_group: number;
+                        pending_sessions: number;
+                        remaining_capacity: number;
+                        max_capacity: number;
+                        max_capacity_in_group: number | null;
+                        is_available_globally: boolean;
+                        is_available_in_group: boolean;
+                    }[];
+                } | null;
+            } | {
+                actionCalls?: {
+                    action: {
+                        name: string;
+                        id: string;
+                        openapi?: {
+                            openapi_spec_id?: string;
+                            operation_spec: unknown;
+                            operation_id?: string;
+                            operation_method?: string;
+                        };
+                        metadata: unknown;
+                        required_form_submission?: boolean;
+                        is_handoff_like?: boolean;
+                    };
+                    arguments: unknown;
+                    result: unknown;
+                }[];
+                actionSearchQuery?: string;
+                knowledge?: {
+                    source: string;
+                    source_type: string;
+                    url: string;
+                }[];
+                knowledge_used?: {
+                    content: string;
+                    source: string;
+                }[];
+                work_instructions_scanned?: {
+                    content: string;
+                }[];
+                /** @description Context provided from the client. For example, dynamic metadata sent from the widget such as: the current product name on the page, the current Shopify shop domain, etc etc. */
+                client_context?: {
+                    [key: string]: unknown;
+                } | null;
+                /** @description Org-specific or message-type-specific debug data. */
+                additional_debug_data?: {
+                    [key: string]: unknown;
+                } | null;
+                whatsapp_template_request?: unknown | null;
+                rule_violation_reflections?: {
+                    rule_name: string;
+                    /** @description How the rule was violated */
+                    violation_description: string;
+                }[];
+                tool_call_results_quick_reply_suggestions?: {
+                    tool_name: string;
+                    suggestions: string[];
+                }[];
+                /** @default null */
+                assignment_choice_summary: {
+                    /** @constant */
+                    strategy: "least-busy";
+                    selected: {
+                        agent_id: number;
+                        agent_name: string;
+                        active_sessions: number;
+                        active_sessions_in_group: number;
+                        pending_sessions: number;
+                        remaining_capacity: number;
+                        max_capacity: number;
+                        max_capacity_in_group: number | null;
+                        is_available_globally: boolean;
+                        is_available_in_group: boolean;
+                    } | null;
+                    peers: {
+                        agent_id: number;
+                        agent_name: string;
+                        active_sessions: number;
+                        active_sessions_in_group: number;
+                        pending_sessions: number;
+                        remaining_capacity: number;
+                        max_capacity: number;
+                        max_capacity_in_group: number | null;
+                        is_available_globally: boolean;
+                        is_available_in_group: boolean;
+                    }[];
+                } | null;
+                destination_id?: string;
+                destination_name?: string;
+                /** @enum {string} */
+                destination_type?: "phone" | "sip" | "hangup";
+                transfer_reason?: string | null;
+                is_failover?: boolean;
+                /** @enum {string} */
+                failover_source?: "stt" | "llm" | "tts";
+                /** @enum {string} */
+                hangup_initiator?: "user" | "agent" | "system";
+                hangup_reason?: string;
+                duration_seconds?: number;
+                /** @enum {string} */
+                call_direction?: "inbound" | "outbound";
+            }) | null;
             knowledgebase_called?: boolean | null;
             /** @enum {string} */
             type: "agent_assigned_by_system" | "agent_assigned_by_user" | "agent_changed" | "agent_comment" | "agent_initiated_session" | "agent_joined" | "agent_message" | "agent_reopened_session" | "agent_took_session_from_ai" | "agent_unassigned_by_system" | "agent_unassigned_by_user" | "ai_assumed_the_session_resolved" | "ai_decided_to_resolve_the_issue" | "ai_reopened_session" | "call_history" | "call_transferred" | "closed_resolved_by_agent" | "closed_resolved_by_api" | "closed_resolved_by_contact" | "closed_resolved_by_integration" | "closed_resolved_by_system" | "closed_unresolved_by_agent" | "closed_unresolved_by_api" | "closed_unresolved_by_system" | "contact_data_updated" | "csat_requested" | "csat_submitted" | "email_draft_message" | "handoff" | "handoff_to_salesforce_miaw" | "handoff_to_zendesk" | "message" | "prohibited_topic_detected" | "sequence_message" | "sla_applied_by_agent" | "sla_applied_by_system" | "sla_first_reply_breached" | "sla_first_reply_completed_after_breach" | "sla_first_reply_fulfilled" | "sla_first_reply_metric_started" | "sla_freezed_office_hours_ended" | "sla_freezed_snoozed" | "sla_next_reply_breached" | "sla_next_reply_completed_after_breach" | "sla_next_reply_fulfilled" | "sla_next_reply_metric_started" | "sla_removed_by_agent" | "sla_removed_by_system" | "sla_resolution_breached" | "sla_resolution_completed_after_breach" | "sla_resolution_fulfilled" | "sla_resolution_metric_started" | "sla_resolution_paused_resolved" | "sla_resolution_paused_waiting_on_customer" | "sla_resolution_resumed_customer_replied" | "sla_resolution_resumed_reopened" | "sla_resumed_office_hours_started" | "sla_resumed_snooze_cancelled" | "sla_resumed_snooze_expired" | "state_checkpoint" | "sub_status_removed_by_agent" | "sub_status_removed_by_api" | "sub_status_removed_by_system" | "sub_status_set_by_agent" | "sub_status_set_by_api" | "sub_status_set_by_system" | "system_reopened_session" | "team_assigned_by_system" | "team_assigned_by_user" | "team_unassigned_by_system" | "team_unassigned_by_user" | "user_confirmed_the_session_resolved" | "workflow_message" | "workflow_note" | "workflow_triggered";
@@ -4846,6 +5155,8 @@ export interface components {
             use_org_knowledgebase: boolean;
             background_noise_preset: ("office" | "bar" | "city-street") | null;
             recording_enabled: boolean;
+            stt_keyterms: string[];
+            failover_transfer_destination_id: string | null;
         };
         PhoneAgentVoiceDto: {
             voice_id: string;
@@ -4982,6 +5293,8 @@ export interface components {
             published_by_name: string | null;
             /** Format: date-time */
             created_at: string;
+            start_time: string | null;
+            end_time: string | null;
         };
         CustomTrainingDirectoriesDto: {
             id: string;
@@ -5359,7 +5672,6 @@ export interface components {
             ended_at: string | null;
             workflow_id: string;
             duration_in_milliseconds: number | null;
-            context: unknown | null;
             wrapper_block_id: string | null;
             wrapper_block_run_id: number | null;
         };
@@ -5788,6 +6100,49 @@ export interface components {
                             tool_name: string;
                             suggestions: string[];
                         }[];
+                        /** @default null */
+                        assignment_choice_summary: {
+                            /** @constant */
+                            strategy: "least-busy";
+                            selected: {
+                                agent_id: number;
+                                agent_name: string;
+                                active_sessions: number;
+                                active_sessions_in_group: number;
+                                pending_sessions: number;
+                                remaining_capacity: number;
+                                max_capacity: number;
+                                max_capacity_in_group: number | null;
+                                is_available_globally: boolean;
+                                is_available_in_group: boolean;
+                            } | null;
+                            peers: {
+                                agent_id: number;
+                                agent_name: string;
+                                active_sessions: number;
+                                active_sessions_in_group: number;
+                                pending_sessions: number;
+                                remaining_capacity: number;
+                                max_capacity: number;
+                                max_capacity_in_group: number | null;
+                                is_available_globally: boolean;
+                                is_available_in_group: boolean;
+                            }[];
+                        } | null;
+                        destination_id?: string;
+                        destination_name?: string;
+                        /** @enum {string} */
+                        destination_type?: "phone" | "sip" | "hangup";
+                        transfer_reason?: string | null;
+                        is_failover?: boolean;
+                        /** @enum {string} */
+                        failover_source?: "stt" | "llm" | "tts";
+                        /** @enum {string} */
+                        hangup_initiator?: "user" | "agent" | "system";
+                        hangup_reason?: string;
+                        duration_seconds?: number;
+                        /** @enum {string} */
+                        call_direction?: "inbound" | "outbound";
                     };
                     mode?: {
                         id: string;
@@ -6376,6 +6731,10 @@ export interface components {
             } | null;
             /** @description When the current version was published */
             published_at: string | null;
+            /** @description Active window start (UTC). Null = no start bound. */
+            start_time: string | null;
+            /** @description Active window end (UTC). Null = no end bound. */
+            end_time: string | null;
             /** Format: date-time */
             created_at: string;
             /** Format: date-time */
@@ -6460,6 +6819,18 @@ export interface components {
             total: number;
             totalPages: number;
         };
+        PublicCategoryUsageDto: {
+            /** @description Active system (base) categories. */
+            base: number;
+            /** @description Active user-defined (custom) categories. */
+            custom: number;
+            /** @description Active AI-suggested categories. */
+            suggested: number;
+            /** @description Total active categories (base + custom + suggested). */
+            total: number;
+            /** @description Maximum total categories before the AI stops suggesting new ones. */
+            limit: number;
+        };
         SendTemplateOutputDto: {
             whatsapp_message_id: string;
             opencx_message_id: string;
@@ -12349,6 +12720,8 @@ export interface operations {
         parameters: {
             query?: {
                 type?: "base" | "suggested" | "user_defined";
+                /** @description Case-insensitive keyword match on category name or description. */
+                search?: string;
             };
             header?: never;
             path?: never;
@@ -12376,6 +12749,169 @@ export interface operations {
             };
         };
     };
+    createCategory: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["CreateVocCategoryDto"];
+            };
+        };
+        responses: {
+            /** @description Default Response */
+            201: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["PublicCategoryDto"];
+                };
+            };
+            /** @description Internal Server Error */
+            500: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ErrorDto"];
+                };
+            };
+        };
+    };
+    getCategoryUsage: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Default Response */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["PublicCategoryUsageDto"];
+                };
+            };
+            /** @description Internal Server Error */
+            500: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ErrorDto"];
+                };
+            };
+        };
+    };
+    updateCategory: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                categoryId: string;
+            };
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["UpdateCategoryDto"];
+            };
+        };
+        responses: {
+            /** @description Default Response */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["PublicCategoryDto"];
+                };
+            };
+            /** @description Internal Server Error */
+            500: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ErrorDto"];
+                };
+            };
+        };
+    };
+    approveCategory: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["ApproveSuggestionDto"];
+            };
+        };
+        responses: {
+            /** @description Default Response */
+            201: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["PublicCategoryDto"];
+                };
+            };
+            /** @description Internal Server Error */
+            500: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ErrorDto"];
+                };
+            };
+        };
+    };
+    rejectCategory: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["RejectSuggestionDto"];
+            };
+        };
+        responses: {
+            /** @description Default Response */
+            201: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["PublicCategoryDto"];
+                };
+            };
+            /** @description Internal Server Error */
+            500: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ErrorDto"];
+                };
+            };
+        };
+    };
     getVocInsight: {
         parameters: {
             query?: never;