@wildix/wilma-tools-client 1.0.1

package/dist-types/commands/UpdateConnectorCommand.d.ts

@@ -0,0 +1,143 @@
+import { Command as $Command } from "@smithy/core/client";
+import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import type { UpdateConnectorInput, UpdateConnectorOutput } from "../models/models_0";
+import type { ServiceInputTypes, ServiceOutputTypes, WilmaToolsClientResolvedConfig } from "../WilmaToolsClient";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link UpdateConnectorCommand}.
+ */
+export interface UpdateConnectorCommandInput extends UpdateConnectorInput {
+}
+/**
+ * @public
+ *
+ * The output of {@link UpdateConnectorCommand}.
+ */
+export interface UpdateConnectorCommandOutput extends UpdateConnectorOutput, __MetadataBearer {
+}
+declare const UpdateConnectorCommand_base: {
+    new (input: UpdateConnectorCommandInput): import("@smithy/core/client").CommandImpl<UpdateConnectorCommandInput, UpdateConnectorCommandOutput, WilmaToolsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (input: UpdateConnectorCommandInput): import("@smithy/core/client").CommandImpl<UpdateConnectorCommandInput, UpdateConnectorCommandOutput, WilmaToolsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
+};
+/**
+ * Replaces the editable configuration of a connector.
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { WilmaToolsClient, UpdateConnectorCommand } from "@wildix/wilma-tools-client"; // ES Modules import
+ * // const { WilmaToolsClient, UpdateConnectorCommand } = require("@wildix/wilma-tools-client"); // CommonJS import
+ * // import type { WilmaToolsClientConfig } from "@wildix/wilma-tools-client";
+ * const config = {}; // type is WilmaToolsClientConfig
+ * const client = new WilmaToolsClient(config);
+ * const input = { // UpdateConnectorInput
+ *   definition: { // ConnectorDefinitionRef
+ *     key: "STRING_VALUE", // required
+ *     version: "STRING_VALUE", // required
+ *   },
+ *   configuration: "DOCUMENT_VALUE", // required
+ *   authorization: { // ConnectorAuthorization Union: only one key present
+ *     shared: { // ConnectorSharedAuthorization
+ *       connection: { // ConnectionRef
+ *         id: "STRING_VALUE", // required
+ *       },
+ *     },
+ *     user: {},
+ *   },
+ *   name: "STRING_VALUE", // required
+ *   description: "STRING_VALUE", // required
+ *   grant: { // ConnectorToolGrant Union: only one key present
+ *     read: {},
+ *     readWrite: {},
+ *     all: {},
+ *     tools: [ // ConnectorEnabledTools
+ *       "STRING_VALUE",
+ *     ],
+ *   },
+ *   companyId: "STRING_VALUE",
+ *   connectorId: "STRING_VALUE", // required
+ *   revision: Number("int"), // required
+ * };
+ * const command = new UpdateConnectorCommand(input);
+ * const response = await client.send(command);
+ * // { // UpdateConnectorOutput
+ * //   connector: { // Connector
+ * //     definition: { // ConnectorDefinitionRef
+ * //       key: "STRING_VALUE", // required
+ * //       version: "STRING_VALUE", // required
+ * //     },
+ * //     configuration: "DOCUMENT_VALUE", // required
+ * //     authorization: { // ConnectorAuthorization Union: only one key present
+ * //       shared: { // ConnectorSharedAuthorization
+ * //         connection: { // ConnectionRef
+ * //           id: "STRING_VALUE", // required
+ * //         },
+ * //       },
+ * //       user: {},
+ * //     },
+ * //     name: "STRING_VALUE", // required
+ * //     description: "STRING_VALUE", // required
+ * //     grant: { // ConnectorToolGrant Union: only one key present
+ * //       read: {},
+ * //       readWrite: {},
+ * //       all: {},
+ * //       tools: [ // ConnectorEnabledTools
+ * //         "STRING_VALUE",
+ * //       ],
+ * //     },
+ * //     id: "STRING_VALUE", // required
+ * //     companyId: "STRING_VALUE", // required
+ * //     revision: Number("int"), // required
+ * //   },
+ * // };
+ *
+ * ```
+ *
+ * @param UpdateConnectorCommandInput - {@link UpdateConnectorCommandInput}
+ * @returns {@link UpdateConnectorCommandOutput}
+ * @see {@link UpdateConnectorCommandInput} for command's `input` shape.
+ * @see {@link UpdateConnectorCommandOutput} for command's `response` shape.
+ * @see {@link WilmaToolsClientResolvedConfig | config} for WilmaToolsClient's `config` shape.
+ *
+ * @throws {@link ValidationException} (client fault)
+ *
+ * @throws {@link NotFoundException} (client fault)
+ *
+ * @throws {@link ForbiddenException} (client fault)
+ *
+ * @throws {@link RevisionConflictException} (client fault)
+ *  The resource was modified concurrently; re-read it and retry with the latest revision.
+ *
+ * @throws {@link UnauthorizedException} (client fault)
+ *
+ * @throws {@link AlreadyExistException} (client fault)
+ *
+ * @throws {@link ToolExecutionException} (client fault)
+ *
+ * @throws {@link ToolExecutionServerException} (server fault)
+ *
+ * @throws {@link WilmaToolsServiceException}
+ * <p>Base exception class for all service exceptions from WilmaTools service.</p>
+ *
+ *
+ * @public
+ */
+export declare class UpdateConnectorCommand extends UpdateConnectorCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: UpdateConnectorInput;
+            output: UpdateConnectorOutput;
+        };
+        sdk: {
+            input: UpdateConnectorCommandInput;
+            output: UpdateConnectorCommandOutput;
+        };
+    };
+}

package/dist-types/commands/UpdateToolCommand.d.ts

@@ -0,0 +1,183 @@
+import { Command as $Command } from "@smithy/core/client";
+import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import type { UpdateToolInput, UpdateToolOutput } from "../models/models_0";
+import type { ServiceInputTypes, ServiceOutputTypes, WilmaToolsClientResolvedConfig } from "../WilmaToolsClient";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link UpdateToolCommand}.
+ */
+export interface UpdateToolCommandInput extends UpdateToolInput {
+}
+/**
+ * @public
+ *
+ * The output of {@link UpdateToolCommand}.
+ */
+export interface UpdateToolCommandOutput extends UpdateToolOutput, __MetadataBearer {
+}
+declare const UpdateToolCommand_base: {
+    new (input: UpdateToolCommandInput): import("@smithy/core/client").CommandImpl<UpdateToolCommandInput, UpdateToolCommandOutput, WilmaToolsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (input: UpdateToolCommandInput): import("@smithy/core/client").CommandImpl<UpdateToolCommandInput, UpdateToolCommandOutput, WilmaToolsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
+};
+/**
+ * Update a tool by its ID.
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { WilmaToolsClient, UpdateToolCommand } from "@wildix/wilma-tools-client"; // ES Modules import
+ * // const { WilmaToolsClient, UpdateToolCommand } = require("@wildix/wilma-tools-client"); // CommonJS import
+ * // import type { WilmaToolsClientConfig } from "@wildix/wilma-tools-client";
+ * const config = {}; // type is WilmaToolsClientConfig
+ * const client = new WilmaToolsClient(config);
+ * const input = { // UpdateToolInput
+ *   companyId: "STRING_VALUE",
+ *   toolId: "STRING_VALUE", // required
+ *   revision: Number("int"), // required
+ *   name: "STRING_VALUE", // required
+ *   category: "STRING_VALUE", // required
+ *   description: "STRING_VALUE",
+ *   input: { // ToolInput
+ *     schema: "DOCUMENT_VALUE", // required
+ *   },
+ *   handler: { // ToolHandler Union: only one key present
+ *     connector: { // ToolConnectorHandler
+ *       definition: { // ConnectorDefinitionRef
+ *         key: "STRING_VALUE", // required
+ *         version: "STRING_VALUE", // required
+ *       },
+ *       configuration: "DOCUMENT_VALUE", // required
+ *       authorization: { // ConnectorAuthorization Union: only one key present
+ *         shared: { // ConnectorSharedAuthorization
+ *           connection: { // ConnectionRef
+ *             id: "STRING_VALUE", // required
+ *           },
+ *         },
+ *         user: {},
+ *       },
+ *       toolId: "STRING_VALUE", // required
+ *       toolConfiguration: "DOCUMENT_VALUE",
+ *     },
+ *     mcp: { // ToolMcpHandler
+ *       serverUrl: "STRING_VALUE", // required
+ *       authorization: { // ToolMcpAuthorization Union: only one key present
+ *         connection: {
+ *           id: "STRING_VALUE", // required
+ *         },
+ *         customHeaders: { // ToolMcpHeadersMap
+ *           "<keys>": "STRING_VALUE",
+ *         },
+ *       },
+ *       tools: [ // ToolMcpEnabledToolsList // required
+ *         "STRING_VALUE",
+ *       ],
+ *     },
+ *     mcpTool: { // ToolMcpToolHandler
+ *       mcpToolId: "STRING_VALUE", // required
+ *       mcpToolName: "STRING_VALUE", // required
+ *     },
+ *   },
+ * };
+ * const command = new UpdateToolCommand(input);
+ * const response = await client.send(command);
+ * // { // UpdateToolOutput
+ * //   tool: { // Tool
+ * //     id: "STRING_VALUE", // required
+ * //     companyId: "STRING_VALUE", // required
+ * //     name: "STRING_VALUE", // required
+ * //     category: "STRING_VALUE", // required
+ * //     description: "STRING_VALUE",
+ * //     input: { // ToolInput
+ * //       schema: "DOCUMENT_VALUE", // required
+ * //     },
+ * //     handler: { // ToolHandler Union: only one key present
+ * //       connector: { // ToolConnectorHandler
+ * //         definition: { // ConnectorDefinitionRef
+ * //           key: "STRING_VALUE", // required
+ * //           version: "STRING_VALUE", // required
+ * //         },
+ * //         configuration: "DOCUMENT_VALUE", // required
+ * //         authorization: { // ConnectorAuthorization Union: only one key present
+ * //           shared: { // ConnectorSharedAuthorization
+ * //             connection: { // ConnectionRef
+ * //               id: "STRING_VALUE", // required
+ * //             },
+ * //           },
+ * //           user: {},
+ * //         },
+ * //         toolId: "STRING_VALUE", // required
+ * //         toolConfiguration: "DOCUMENT_VALUE",
+ * //       },
+ * //       mcp: { // ToolMcpHandler
+ * //         serverUrl: "STRING_VALUE", // required
+ * //         authorization: { // ToolMcpAuthorization Union: only one key present
+ * //           connection: {
+ * //             id: "STRING_VALUE", // required
+ * //           },
+ * //           customHeaders: { // ToolMcpHeadersMap
+ * //             "<keys>": "STRING_VALUE",
+ * //           },
+ * //         },
+ * //         tools: [ // ToolMcpEnabledToolsList // required
+ * //           "STRING_VALUE",
+ * //         ],
+ * //       },
+ * //       mcpTool: { // ToolMcpToolHandler
+ * //         mcpToolId: "STRING_VALUE", // required
+ * //         mcpToolName: "STRING_VALUE", // required
+ * //       },
+ * //     },
+ * //     revision: Number("int"), // required
+ * //   },
+ * // };
+ *
+ * ```
+ *
+ * @param UpdateToolCommandInput - {@link UpdateToolCommandInput}
+ * @returns {@link UpdateToolCommandOutput}
+ * @see {@link UpdateToolCommandInput} for command's `input` shape.
+ * @see {@link UpdateToolCommandOutput} for command's `response` shape.
+ * @see {@link WilmaToolsClientResolvedConfig | config} for WilmaToolsClient's `config` shape.
+ *
+ * @throws {@link ValidationException} (client fault)
+ *
+ * @throws {@link NotFoundException} (client fault)
+ *
+ * @throws {@link RevisionConflictException} (client fault)
+ *  The resource was modified concurrently; re-read it and retry with the latest revision.
+ *
+ * @throws {@link UnauthorizedException} (client fault)
+ *
+ * @throws {@link ForbiddenException} (client fault)
+ *
+ * @throws {@link AlreadyExistException} (client fault)
+ *
+ * @throws {@link ToolExecutionException} (client fault)
+ *
+ * @throws {@link ToolExecutionServerException} (server fault)
+ *
+ * @throws {@link WilmaToolsServiceException}
+ * <p>Base exception class for all service exceptions from WilmaTools service.</p>
+ *
+ *
+ * @public
+ */
+export declare class UpdateToolCommand extends UpdateToolCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: UpdateToolInput;
+            output: UpdateToolOutput;
+        };
+        sdk: {
+            input: UpdateToolCommandInput;
+            output: UpdateToolCommandOutput;
+        };
+    };
+}

package/dist-types/commands/index.d.ts

@@ -0,0 +1,19 @@
+export * from "./CreateConnectorCommand";
+export * from "./CreateToolCommand";
+export * from "./DeleteConnectorCommand";
+export * from "./DeleteToolCommand";
+export * from "./DescribeCapabilitiesCommand";
+export * from "./DescribeConnectorsCommand";
+export * from "./DescribeToolsCommand";
+export * from "./DiscoverToolsCommand";
+export * from "./ExecuteConnectorCommand";
+export * from "./ExecuteToolCommand";
+export * from "./GetConnectorCommand";
+export * from "./GetConnectorDefinitionCommand";
+export * from "./GetToolCommand";
+export * from "./ListConnectorDefinitionsCommand";
+export * from "./ListConnectorsCommand";
+export * from "./ListToolsCommand";
+export * from "./ResolveConnectorConfigurationCommand";
+export * from "./UpdateConnectorCommand";
+export * from "./UpdateToolCommand";

package/dist-types/endpoint/EndpointParameters.d.ts

@@ -0,0 +1,41 @@
+import type { Endpoint, EndpointParameters as __EndpointParameters, EndpointV2, Provider } from "@smithy/types";
+/**
+ * @public
+ */
+export interface ClientInputEndpointParameters {
+    clientContextParams?: {
+        env?: string | undefined | Provider<string | undefined>;
+    };
+    env?: string | undefined | Provider<string | undefined>;
+    endpoint?: string | Provider<string> | Endpoint | Provider<Endpoint> | EndpointV2 | Provider<EndpointV2>;
+}
+/**
+ * @public
+ */
+export type ClientResolvedEndpointParameters = Omit<ClientInputEndpointParameters, "endpoint"> & {
+    defaultSigningName: string;
+};
+/**
+ * @internal
+ */
+export declare const resolveClientEndpointParameters: <T>(options: T & ClientInputEndpointParameters) => T & ClientResolvedEndpointParameters;
+/**
+ * @internal
+ */
+export declare const commonParams: {
+    readonly env: {
+        readonly type: "clientContextParams";
+        readonly name: "env";
+    };
+    readonly endpoint: {
+        readonly type: "builtInParams";
+        readonly name: "endpoint";
+    };
+};
+/**
+ * @internal
+ */
+export interface EndpointParameters extends __EndpointParameters {
+    env?: string | undefined;
+    endpoint?: string | undefined;
+}

package/dist-types/endpoint/bdd.d.ts

@@ -0,0 +1,2 @@
+import { BinaryDecisionDiagram } from "@smithy/core/endpoints";
+export declare const bdd: BinaryDecisionDiagram;

package/dist-types/endpoint/endpointResolver.d.ts

@@ -0,0 +1,8 @@
+import type { EndpointV2, Logger } from "@smithy/types";
+import type { EndpointParameters } from "./EndpointParameters";
+/**
+ * @internal
+ */
+export declare const defaultEndpointResolver: (endpointParams: EndpointParameters, context?: {
+    logger?: Logger;
+}) => EndpointV2;

package/dist-types/extensionConfiguration.d.ts

@@ -0,0 +1,8 @@
+import type { HttpHandlerExtensionConfiguration } from "@smithy/core/protocols";
+import type { DefaultExtensionConfiguration } from "@smithy/types";
+import type { HttpAuthExtensionConfiguration } from "./auth/httpAuthExtensionConfiguration";
+/**
+ * @internal
+ */
+export interface WilmaToolsExtensionConfiguration extends HttpHandlerExtensionConfiguration, DefaultExtensionConfiguration, HttpAuthExtensionConfiguration {
+}

package/dist-types/index.d.ts

@@ -0,0 +1,25 @@
+/**
+ * Tools and connectors platform for the Wilma agent ecosystem. Successor of wim-tools:
+ *     same tool model (built-in email/webhook/search/chat/sms/calendar/MCP handlers plus
+ *     execution) extended with connectors — company-owned instances of immutable server-side
+ *     connector definitions that expose one or more executable tools, with credentials kept in
+ *     wilma-secrets. Serves the connector catalog (definitions), configured connectors, connector-backed
+ *     Tools and direct connector execution. Consumed server-to-server by the agent channel
+ *     runtimes (wilma-assistant, wilma-chat, wilma-voice) and by the legacy bot runtimes
+ *     (xbees-users bots, wim-voicebots) via their connector capability. Hosted on the shared
+ *     Wilma API domain under the /v2/tools path prefix.
+ *
+ * @packageDocumentation
+ */
+export * from "./WilmaToolsClient";
+export * from "./WilmaTools";
+export type { ClientInputEndpointParameters } from "./endpoint/EndpointParameters";
+export type { RuntimeExtension } from "./runtimeExtensions";
+export type { WilmaToolsExtensionConfiguration } from "./extensionConfiguration";
+export * from "./commands";
+export * from "./schemas/schemas_0";
+export * from "./pagination";
+export * from "./models/enums";
+export * from "./models/errors";
+export * from "./models/models_0";
+export { WilmaToolsServiceException } from "./models/WilmaToolsServiceException";

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

@@ -0,0 +1,14 @@
+import { type ServiceExceptionOptions as __ServiceExceptionOptions, ServiceException as __ServiceException } from "@smithy/core/client";
+export type { __ServiceExceptionOptions };
+export { __ServiceException };
+/**
+ * @public
+ *
+ * Base exception class for all service exceptions from WilmaTools service.
+ */
+export declare class WilmaToolsServiceException extends __ServiceException {
+    /**
+     * @internal
+     */
+    constructor(options: __ServiceExceptionOptions);
+}

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

@@ -0,0 +1,46 @@
+/**
+ * @public
+ * @enum
+ */
+export declare const ConnectorAuthorizationMode: {
+    /**
+     * One company-managed (SHARED) connection is used for all executions. Whether that
+     * connection authorizes interactively or from a machine credential (OAuth2
+     * client-credentials, API key) is a provider detail resolved in wilma-secrets, not a
+     * separate mode here.
+     */
+    readonly SHARED: "shared";
+    /**
+     * Resolved from the executing user's own authorization for this connector's provider
+     * (a wilma-secrets USER connection, keyed by provider + user). No company connection is
+     * needed at create time; each user connects the provider for themselves.
+     */
+    readonly USER: "user";
+};
+/**
+ * @public
+ */
+export type ConnectorAuthorizationMode = (typeof ConnectorAuthorizationMode)[keyof typeof ConnectorAuthorizationMode];
+/**
+ * @public
+ * @enum
+ */
+export declare const ConnectorToolAccess: {
+    /**
+     * Deletes or performs otherwise irreversible external changes. Enabled only by the `all`
+     * grant (or an explicit tool allowlist).
+     */
+    readonly DESTRUCTIVE: "destructive";
+    /**
+     * Does not modify external state (list, get, search, query). Enabled by every grant.
+     */
+    readonly READ: "read";
+    /**
+     * Creates or updates external state. Enabled by `readWrite` and `all` grants.
+     */
+    readonly WRITE: "write";
+};
+/**
+ * @public
+ */
+export type ConnectorToolAccess = (typeof ConnectorToolAccess)[keyof typeof ConnectorToolAccess];

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

@@ -0,0 +1,108 @@
+import type { ExceptionOptionType as __ExceptionOptionType } from "@smithy/core/client";
+import type { DocumentType as __DocumentType } from "@smithy/types";
+import { WilmaToolsServiceException as __BaseException } from "./WilmaToolsServiceException";
+/**
+ * @public
+ */
+export declare class AlreadyExistException extends __BaseException {
+    readonly name: "AlreadyExistException";
+    readonly $fault: "client";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<AlreadyExistException, __BaseException>);
+}
+/**
+ * @public
+ */
+export declare class ForbiddenException extends __BaseException {
+    readonly name: "ForbiddenException";
+    readonly $fault: "client";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<ForbiddenException, __BaseException>);
+}
+/**
+ * @public
+ */
+export declare class NotFoundException extends __BaseException {
+    readonly name: "NotFoundException";
+    readonly $fault: "client";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<NotFoundException, __BaseException>);
+}
+/**
+ * @public
+ */
+export declare class UnauthorizedException extends __BaseException {
+    readonly name: "UnauthorizedException";
+    readonly $fault: "client";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<UnauthorizedException, __BaseException>);
+}
+/**
+ * @public
+ */
+export declare class ValidationException extends __BaseException {
+    readonly name: "ValidationException";
+    readonly $fault: "client";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
+}
+/**
+ * The resource was modified concurrently; re-read it and retry with the latest revision.
+ * @public
+ */
+export declare class RevisionConflictException extends __BaseException {
+    readonly name: "RevisionConflictException";
+    readonly $fault: "client";
+    type?: string | undefined;
+    /**
+     * The current revision of the resource on the server.
+     * @public
+     */
+    currentRevision?: number | undefined;
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<RevisionConflictException, __BaseException>);
+}
+/**
+ * @public
+ */
+export declare class ToolExecutionException extends __BaseException {
+    readonly name: "ToolExecutionException";
+    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>);
+}