@wildix/wim-tools-client 0.0.17 → 0.0.18

package/dist-types/models/models_0.d.ts

@@ -42,18 +42,30 @@ export type ToolStringValue = ToolStringValue.StaticMember | ToolStringValue.Tem
  * @public
  */
 export declare namespace ToolStringValue {
+    /**
+     * A static string value like: 'text'
+     * @public
+     */
     interface StaticMember {
         static: string;
         variable?: never;
         template?: never;
         $unknown?: never;
     }
+    /**
+     * A variable value like: \{\{variable_name\}\}
+     * @public
+     */
     interface VariableMember {
         static?: never;
         variable: string;
         template?: never;
         $unknown?: never;
     }
+    /**
+     * A template string value like: some text with \{\{variable_name\}\}
+     * @public
+     */
     interface TemplateMember {
         static?: never;
         variable?: never;
@@ -80,82 +92,101 @@ export declare namespace ToolStringValue {
 /**
  * @public
  */
-export interface ToolChannelMessageConfig {
-    channelId: ToolStringValue;
-    text: ToolStringValue;
-}
-/**
- * @public
- */
-export interface ToolDirectMessageConfig {
-    memberEmail?: ToolStringValue | undefined;
-    memberPhone?: ToolStringValue | undefined;
-    memberId?: ToolStringValue | undefined;
-    text: ToolStringValue;
-}
-/**
- * @public
- */
-export type ToolChatHandler = ToolChatHandler.ChannelMember | ToolChatHandler.DirectMember | ToolChatHandler.$UnknownMember;
-/**
- * @public
- */
-export declare namespace ToolChatHandler {
-    interface DirectMember {
-        direct: ToolDirectMessageConfig;
-        channel?: never;
-        $unknown?: never;
-    }
-    interface ChannelMember {
-        direct?: never;
-        channel: ToolChannelMessageConfig;
-        $unknown?: never;
-    }
+export interface ToolSmtpConfig {
     /**
+     * SMTP server host, e.g.: 'smtp.gmail.com'
      * @public
      */
-    interface $UnknownMember {
-        direct?: never;
-        channel?: never;
-        $unknown: [string, any];
-    }
-    interface Visitor<T> {
-        direct: (value: ToolDirectMessageConfig) => T;
-        channel: (value: ToolChannelMessageConfig) => T;
-        _: (name: string, value: any) => T;
-    }
-    const visit: <T>(value: ToolChatHandler, visitor: Visitor<T>) => T;
-}
-/**
- * @public
- */
-export interface ToolSmtpConfig {
     host: string;
+    /**
+     * SMTP server port, e.g.: '587'
+     * @public
+     */
     port: number;
-    username?: string | undefined;
-    password?: string | undefined;
-    secure?: boolean | undefined;
+    /**
+     * SMTP server username for authentication, e.g.: 'john.doe@gmail.com'
+     * @public
+     */
+    username: string;
+    /**
+     * SMTP server password
+     * @public
+     */
+    password: string;
+    /**
+     * SMTP server secure connection
+     * @public
+     */
+    secure: boolean;
 }
 /**
  * @public
  */
 export interface ToolCustomEmailConfig {
+    /**
+     * SMTP server provider configuration.
+     * @public
+     */
     smtp: ToolSmtpConfig;
+    /**
+     * From email address associated with the SMTP server, e.g.: 'john.doe@gmail.com'
+     * @public
+     */
     from: ToolStringValue;
+    /**
+     * To email address, e.g.: 'jane.doe@example.com'
+     * @public
+     */
     to: ToolStringValue;
+    /**
+     * Subject of the email.
+     * @public
+     */
     subject: ToolStringValue;
+    /**
+     * Text of the email.
+     * @public
+     */
     text: ToolStringValue;
-    html?: ToolStringValue | undefined;
+    /**
+     * HTML content of the email
+     * @public
+     */
+    html: ToolStringValue;
+    /**
+     * CC email addresses
+     * @public
+     */
     cc?: ToolStringValue | undefined;
+    /**
+     * BCC email addresses
+     * @public
+     */
     bcc?: ToolStringValue | undefined;
+    /**
+     * Reply-to email address
+     * @public
+     */
     replyTo?: ToolStringValue | undefined;
 }
 /**
  * @public
  */
 export interface ToolWnsEmailConfig {
+    /**
+     * To email address, e.g.: 'jane.doe@example.com'.
+     * @public
+     */
     to: ToolStringValue;
+    /**
+     * Subject of the email.
+     * @public
+     */
     subject: ToolStringValue;
+    /**
+     * Text of the email.
+     * @public
+     */
     text: ToolStringValue;
 }
 /**
@@ -166,11 +197,19 @@ export type ToolEmailHandler = ToolEmailHandler.CustomMember | ToolEmailHandler.
  * @public
  */
 export declare namespace ToolEmailHandler {
+    /**
+     * Wildix Notifications Service email handler of the tool.
+     * @public
+     */
     interface WnsMember {
         wns: ToolWnsEmailConfig;
         custom?: never;
         $unknown?: never;
     }
+    /**
+     * Custom  SMTP server as a service email handler of the tool.
+     * @public
+     */
     interface CustomMember {
         wns?: never;
         custom: ToolCustomEmailConfig;
@@ -191,134 +230,20 @@ export declare namespace ToolEmailHandler {
     }
     const visit: <T>(value: ToolEmailHandler, visitor: Visitor<T>) => T;
 }
-/**
- * @public
- * @enum
- */
-export declare const ToolAuthorizationType: {
-    readonly API_KEY: "ApiKey";
-    readonly BASIC: "Basic";
-    readonly BEARER: "Bearer";
-};
-/**
- * @public
- */
-export type ToolAuthorizationType = typeof ToolAuthorizationType[keyof typeof ToolAuthorizationType];
-/**
- * @public
- */
-export interface ToolAuthentication {
-    type: ToolAuthorizationType;
-    token: string;
-}
-/**
- * @public
- */
-export interface ToolMcpToolConfig {
-    mcpToolId: string;
-    /**
-     * Optional description override for the tool
-     * @public
-     */
-    description?: string | undefined;
-    /**
-     * Parameter mappings for the MCP tool
-     * @public
-     */
-    parameters?: __DocumentType | undefined;
-}
-/**
- * @public
- * @enum
- */
-export declare const ToolMcpTransport: {
-    readonly HTTP: "http";
-    readonly SSE: "sse";
-    readonly STDIO: "stdio";
-};
 /**
  * @public
  */
-export type ToolMcpTransport = typeof ToolMcpTransport[keyof typeof ToolMcpTransport];
+export type ToolHandler = ToolHandler.EmailMember | ToolHandler.$UnknownMember;
 /**
  * @public
  */
-export interface ToolMcpHandler {
-    serverUrl: string;
-    transport: ToolMcpTransport;
-    authentication?: ToolAuthentication | undefined;
-    timeout?: number | undefined;
+export declare namespace ToolHandler {
     /**
-     * List of MCP tools to expose from this server
+     * Email handler of the tool.
      * @public
      */
-    tools?: (ToolMcpToolConfig)[] | undefined;
-}
-/**
- * @public
- */
-export interface ToolSmsHandler {
-    serviceUri: ToolStringValue;
-    recipientId?: ToolStringValue | undefined;
-    recipientNumber: ToolStringValue;
-    message: ToolStringValue;
-}
-/**
- * @public
- */
-export interface ToolWebhookHandler {
-    url: ToolStringValue;
-    body: ToolStringValue;
-    key?: ToolStringValue | undefined;
-    secret: ToolStringValue;
-    timeout?: number | undefined;
-}
-/**
- * @public
- */
-export type ToolHandler = ToolHandler.ChatMember | ToolHandler.EmailMember | ToolHandler.McpMember | ToolHandler.SmsMember | ToolHandler.WebhookMember | ToolHandler.$UnknownMember;
-/**
- * @public
- */
-export declare namespace ToolHandler {
     interface EmailMember {
         email: ToolEmailHandler;
-        sms?: never;
-        chat?: never;
-        webhook?: never;
-        mcp?: never;
-        $unknown?: never;
-    }
-    interface SmsMember {
-        email?: never;
-        sms: ToolSmsHandler;
-        chat?: never;
-        webhook?: never;
-        mcp?: never;
-        $unknown?: never;
-    }
-    interface ChatMember {
-        email?: never;
-        sms?: never;
-        chat: ToolChatHandler;
-        webhook?: never;
-        mcp?: never;
-        $unknown?: never;
-    }
-    interface WebhookMember {
-        email?: never;
-        sms?: never;
-        chat?: never;
-        webhook: ToolWebhookHandler;
-        mcp?: never;
-        $unknown?: never;
-    }
-    interface McpMember {
-        email?: never;
-        sms?: never;
-        chat?: never;
-        webhook?: never;
-        mcp: ToolMcpHandler;
         $unknown?: never;
     }
     /**
@@ -326,18 +251,10 @@ export declare namespace ToolHandler {
      */
     interface $UnknownMember {
         email?: never;
-        sms?: never;
-        chat?: never;
-        webhook?: never;
-        mcp?: never;
         $unknown: [string, any];
     }
     interface Visitor<T> {
         email: (value: ToolEmailHandler) => T;
-        sms: (value: ToolSmsHandler) => T;
-        chat: (value: ToolChatHandler) => T;
-        webhook: (value: ToolWebhookHandler) => T;
-        mcp: (value: ToolMcpHandler) => T;
         _: (name: string, value: any) => T;
     }
     const visit: <T>(value: ToolHandler, visitor: Visitor<T>) => T;
@@ -361,37 +278,100 @@ export type ToolVariableType = typeof ToolVariableType[keyof typeof ToolVariable
  * @public
  */
 export interface ToolVariable {
+    /**
+     * Name of the tool variable, e.g.: 'myvar'
+     * @public
+     */
     name: string;
+    /**
+     * Type of the tool variable, e.g.: 'string', 'number', 'boolean', 'string_array', 'number_array'
+     * @public
+     */
     type: ToolVariableType;
-    required?: boolean | undefined;
 }
 /**
  * @public
  */
 export interface ToolInput {
+    /**
+     * List of tool variables, used to pass data to the tool
+     * @public
+     */
     variables: (ToolVariable)[];
 }
 /**
  * @public
  */
 export interface CreateToolInput {
-    company?: string | undefined;
+    /**
+     * The unique identifier of the tenant when a service token is used.
+     * @public
+     */
+    companyId?: string | undefined;
+    /**
+     * Name of the tool, e.g.: 'send_email'
+     * @public
+     */
     name: string;
+    /**
+     * Category of the tool, e.g.: 'Support'
+     * @public
+     */
     category: string;
-    description?: string | undefined;
+    /**
+     * Description of the tool, used by AI to understand the purpose of the tool.
+     * @public
+     */
+    description: string;
+    /**
+     * Input of the tool, used to pass data to the tool.
+     * @public
+     */
     input: ToolInput;
+    /**
+     * Handler of the tool, used to execute the tool.
+     * @public
+     */
     handler: ToolHandler;
 }
 /**
  * @public
  */
 export interface Tool {
+    /**
+     * Unique identifier of the tool
+     * @public
+     */
     id: string;
+    /**
+     * Company ID that owns this tool
+     * @public
+     */
     company: string;
+    /**
+     * Name of the tool, e.g.: 'send_email'
+     * @public
+     */
     name: string;
+    /**
+     * Category of the tool, e.g.: 'Support'
+     * @public
+     */
     category: string;
-    description?: string | undefined;
+    /**
+     * Description of the tool, used by AI to understand the purpose of the tool
+     * @public
+     */
+    description: string;
+    /**
+     * Input of the tool, used to pass data to the tool
+     * @public
+     */
     input: ToolInput;
+    /**
+     * Handler of the tool, used to execute the tool
+     * @public
+     */
     handler: ToolHandler;
 }
 /**
@@ -405,18 +385,46 @@ export interface CreateToolOutput {
  */
 export declare class ToolExecutionException extends __BaseException {
     readonly name: "ToolExecutionException";
-    readonly $fault: "server";
+    readonly $fault: "client";
+    /**
+     * Details about the execution error, typically related to invalid configuration or input
+     * @public
+     */
     details?: __DocumentType | undefined;
     /**
      * @internal
      */
     constructor(opts: __ExceptionOptionType<ToolExecutionException, __BaseException>);
 }
+/**
+ * @public
+ */
+export declare class ToolExecutionServerException extends __BaseException {
+    readonly name: "ToolExecutionServerException";
+    readonly $fault: "server";
+    /**
+     * Details about the server failure during tool execution
+     * @public
+     */
+    details?: __DocumentType | undefined;
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<ToolExecutionServerException, __BaseException>);
+}
 /**
  * @public
  */
 export interface DeleteToolInput {
-    company?: string | undefined;
+    /**
+     * The unique identifier of the tenant when a service token is used.
+     * @public
+     */
+    companyId?: string | undefined;
+    /**
+     * Unique identifier of the tool.
+     * @public
+     */
     toolId: string;
 }
 /**
@@ -428,94 +436,214 @@ export interface DeleteToolOutput {
  * @public
  */
 export interface DescribeToolsInput {
-    company?: string | undefined;
+    /**
+     * The unique identifier of the tenant when a service token is used.
+     * @public
+     */
+    companyId?: string | undefined;
+    /**
+     * List of tool IDs.
+     * @public
+     */
     ids: (string)[];
 }
 /**
  * @public
  */
 export interface ToolDescription {
+    /**
+     * Unique identifier of the tool
+     * @public
+     */
     id: string;
+    /**
+     * Name of the tool, e.g.: 'send_email'
+     * @public
+     */
     name: string;
+    /**
+     * Description of the tool, used by AI to understand the purpose of the tool
+     * @public
+     */
     description: string;
+    /**
+     * List of tool variables, used to pass data to the tool
+     * @public
+     */
     variables: (ToolVariable)[];
 }
 /**
  * @public
  */
 export interface DescribeToolsOutput {
+    /**
+     * List of tool descriptions.
+     * @public
+     */
     descriptions: (ToolDescription)[];
 }
 /**
  * @public
  */
 export interface ExecuteToolInput {
-    company?: string | undefined;
+    /**
+     * The unique identifier of the tenant when a service token is used.
+     * @public
+     */
+    companyId?: string | undefined;
+    /**
+     * Unique identifier of the tool.
+     * @public
+     */
     id: string;
+    /**
+     * Input of the tool, used to pass data to the tool.
+     * @public
+     */
     input: __DocumentType;
+    /**
+     * Optional parameter, by which service the tool is executed, e.g. chatbots.
+     * @public
+     */
     service?: string | undefined;
+    /**
+     * Optional parameter, for which user the tool is executed, e.g. john.doe@example.com.
+     * @public
+     */
     user?: string | undefined;
 }
 /**
  * @public
  */
 export interface ToolExecutionError {
+    /**
+     * Message of the tool execution error
+     * @public
+     */
     message: string;
 }
 /**
  * @public
  */
 export interface ToolExecutionResult {
+    /**
+     * Response status code of the tool execution
+     * @public
+     */
     statusCode: number;
+    /**
+     * Output of the tool execution
+     * @public
+     */
     output: __DocumentType;
-    error?: ToolExecutionError | undefined;
+    /**
+     * Error of the tool execution
+     * @public
+     */
+    error: ToolExecutionError;
 }
 /**
  * @public
  */
 export interface ExecuteToolOutput {
+    /**
+     * Result of the tool execution.
+     * @public
+     */
     result: ToolExecutionResult;
 }
 /**
  * @public
  */
 export interface GetToolInput {
-    company?: string | undefined;
+    /**
+     * The unique identifier of the tenant when a service token is used.
+     * @public
+     */
+    companyId?: string | undefined;
+    /**
+     * Unique identifier of the tool.
+     * @public
+     */
     toolId: string;
 }
 /**
  * @public
  */
 export interface GetToolOutput {
+    /**
+     * Tool object with configuration.
+     * @public
+     */
     tool: Tool;
 }
 /**
  * @public
  */
 export interface ListToolsInput {
-    company?: string | undefined;
+    /**
+     * The unique identifier of the tenant when a service token is used.
+     * @public
+     */
+    companyId?: string | undefined;
 }
 /**
  * @public
  */
 export interface ListToolsOutput {
+    /**
+     * List of tools.
+     * @public
+     */
     tools: (Tool)[];
 }
 /**
  * @public
  */
 export interface UpdateToolInput {
-    company?: string | undefined;
+    /**
+     * The unique identifier of the tenant when a service token is used.
+     * @public
+     */
+    companyId?: string | undefined;
+    /**
+     * Unique identifier of the tool.
+     * @public
+     */
     toolId: string;
+    /**
+     * Name of the tool, e.g.: 'send_email'
+     * @public
+     */
     name: string;
+    /**
+     * Category of the tool, e.g.: 'Support'
+     * @public
+     */
     category: string;
-    description?: string | undefined;
+    /**
+     * Description of the tool, used by AI to understand the purpose of the tool.
+     * @public
+     */
+    description: string;
+    /**
+     * Input of the tool, used to pass data to the tool.
+     * @public
+     */
     input: ToolInput;
+    /**
+     * Handler of the tool, used to execute the tool.
+     * @public
+     */
     handler: ToolHandler;
 }
 /**
  * @public
  */
 export interface UpdateToolOutput {
+    /**
+     * Updated tool object with configuration.
+     * @public
+     */
     tool: Tool;
 }