@wildix/wim-tools-client 0.0.17 → 0.0.19
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist-cjs/models/models_0.js +18 -31
- package/dist-cjs/protocols/Aws_restJson1.js +30 -110
- package/dist-es/models/models_0.js +16 -30
- package/dist-es/protocols/Aws_restJson1.js +32 -112
- package/dist-types/commands/CreateToolCommand.d.ts +17 -99
- package/dist-types/commands/DeleteToolCommand.d.ts +6 -4
- package/dist-types/commands/DescribeToolsCommand.d.ts +6 -5
- package/dist-types/commands/ExecuteToolCommand.d.ts +6 -4
- package/dist-types/commands/GetToolCommand.d.ts +12 -52
- package/dist-types/commands/ListToolsCommand.d.ts +12 -52
- package/dist-types/commands/UpdateToolCommand.d.ts +17 -99
- package/dist-types/models/models_0.d.ts +318 -190
- package/dist-types/runtimeConfig.browser.d.ts +6 -1
- package/dist-types/runtimeConfig.d.ts +6 -1
- package/dist-types/runtimeConfig.native.d.ts +6 -1
- package/package.json +1 -1
|
@@ -27,8 +27,7 @@ declare const CreateToolCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
*
|
|
31
|
-
*
|
|
30
|
+
* Create a new tool.
|
|
32
31
|
* @example
|
|
33
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
34
33
|
* ```javascript
|
|
@@ -36,16 +35,15 @@ declare const CreateToolCommand_base: {
|
|
|
36
35
|
* // const { ToolsClient, CreateToolCommand } = require("@wildix/wim-tools-client"); // CommonJS import
|
|
37
36
|
* const client = new ToolsClient(config);
|
|
38
37
|
* const input = { // CreateToolInput
|
|
39
|
-
*
|
|
38
|
+
* companyId: "STRING_VALUE",
|
|
40
39
|
* name: "STRING_VALUE", // required
|
|
41
40
|
* category: "STRING_VALUE", // required
|
|
42
|
-
* description: "STRING_VALUE",
|
|
41
|
+
* description: "STRING_VALUE", // required
|
|
43
42
|
* input: { // ToolInput
|
|
44
43
|
* variables: [ // ToolVariableList // required
|
|
45
44
|
* { // ToolVariable
|
|
46
45
|
* name: "STRING_VALUE", // required
|
|
47
46
|
* type: "string" || "number" || "boolean" || "string_array" || "number_array", // required
|
|
48
|
-
* required: true || false,
|
|
49
47
|
* },
|
|
50
48
|
* ],
|
|
51
49
|
* },
|
|
@@ -72,9 +70,9 @@ declare const CreateToolCommand_base: {
|
|
|
72
70
|
* smtp: { // ToolSmtpConfig
|
|
73
71
|
* host: "STRING_VALUE", // required
|
|
74
72
|
* port: Number("int"), // required
|
|
75
|
-
* username: "STRING_VALUE",
|
|
76
|
-
* password: "STRING_VALUE",
|
|
77
|
-
* secure: true || false,
|
|
73
|
+
* username: "STRING_VALUE", // required
|
|
74
|
+
* password: "STRING_VALUE", // required
|
|
75
|
+
* secure: true || false, // required
|
|
78
76
|
* },
|
|
79
77
|
* from: {// Union: only one key present
|
|
80
78
|
* static: "STRING_VALUE",
|
|
@@ -88,53 +86,12 @@ declare const CreateToolCommand_base: {
|
|
|
88
86
|
* },
|
|
89
87
|
* subject: "<ToolStringValue>", // required
|
|
90
88
|
* text: "<ToolStringValue>", // required
|
|
91
|
-
* html: "<ToolStringValue>",
|
|
89
|
+
* html: "<ToolStringValue>", // required
|
|
92
90
|
* cc: "<ToolStringValue>",
|
|
93
91
|
* bcc: "<ToolStringValue>",
|
|
94
92
|
* replyTo: "<ToolStringValue>",
|
|
95
93
|
* },
|
|
96
94
|
* },
|
|
97
|
-
* sms: { // ToolSmsHandler
|
|
98
|
-
* serviceUri: "<ToolStringValue>", // required
|
|
99
|
-
* recipientId: "<ToolStringValue>",
|
|
100
|
-
* recipientNumber: "<ToolStringValue>", // required
|
|
101
|
-
* message: "<ToolStringValue>", // required
|
|
102
|
-
* },
|
|
103
|
-
* chat: { // ToolChatHandler Union: only one key present
|
|
104
|
-
* direct: { // ToolDirectMessageConfig
|
|
105
|
-
* memberEmail: "<ToolStringValue>",
|
|
106
|
-
* memberPhone: "<ToolStringValue>",
|
|
107
|
-
* memberId: "<ToolStringValue>",
|
|
108
|
-
* text: "<ToolStringValue>", // required
|
|
109
|
-
* },
|
|
110
|
-
* channel: { // ToolChannelMessageConfig
|
|
111
|
-
* channelId: "<ToolStringValue>", // required
|
|
112
|
-
* text: "<ToolStringValue>", // required
|
|
113
|
-
* },
|
|
114
|
-
* },
|
|
115
|
-
* webhook: { // ToolWebhookHandler
|
|
116
|
-
* url: "<ToolStringValue>", // required
|
|
117
|
-
* body: "<ToolStringValue>", // required
|
|
118
|
-
* key: "<ToolStringValue>",
|
|
119
|
-
* secret: "<ToolStringValue>", // required
|
|
120
|
-
* timeout: Number("int"),
|
|
121
|
-
* },
|
|
122
|
-
* mcp: { // ToolMcpHandler
|
|
123
|
-
* serverUrl: "STRING_VALUE", // required
|
|
124
|
-
* transport: "http" || "stdio" || "sse", // required
|
|
125
|
-
* authentication: { // ToolAuthentication
|
|
126
|
-
* type: "Bearer" || "Basic" || "ApiKey", // required
|
|
127
|
-
* token: "STRING_VALUE", // required
|
|
128
|
-
* },
|
|
129
|
-
* timeout: Number("int"),
|
|
130
|
-
* tools: [ // ToolMcpToolConfigList
|
|
131
|
-
* { // ToolMcpToolConfig
|
|
132
|
-
* mcpToolId: "STRING_VALUE", // required
|
|
133
|
-
* description: "STRING_VALUE",
|
|
134
|
-
* parameters: "DOCUMENT_VALUE",
|
|
135
|
-
* },
|
|
136
|
-
* ],
|
|
137
|
-
* },
|
|
138
95
|
* },
|
|
139
96
|
* };
|
|
140
97
|
* const command = new CreateToolCommand(input);
|
|
@@ -142,16 +99,15 @@ declare const CreateToolCommand_base: {
|
|
|
142
99
|
* // { // CreateToolOutput
|
|
143
100
|
* // tool: { // Tool
|
|
144
101
|
* // id: "STRING_VALUE", // required
|
|
145
|
-
* //
|
|
102
|
+
* // companyId: "STRING_VALUE", // required
|
|
146
103
|
* // name: "STRING_VALUE", // required
|
|
147
104
|
* // category: "STRING_VALUE", // required
|
|
148
|
-
* // description: "STRING_VALUE",
|
|
105
|
+
* // description: "STRING_VALUE", // required
|
|
149
106
|
* // input: { // ToolInput
|
|
150
107
|
* // variables: [ // ToolVariableList // required
|
|
151
108
|
* // { // ToolVariable
|
|
152
109
|
* // name: "STRING_VALUE", // required
|
|
153
110
|
* // type: "string" || "number" || "boolean" || "string_array" || "number_array", // required
|
|
154
|
-
* // required: true || false,
|
|
155
111
|
* // },
|
|
156
112
|
* // ],
|
|
157
113
|
* // },
|
|
@@ -178,9 +134,9 @@ declare const CreateToolCommand_base: {
|
|
|
178
134
|
* // smtp: { // ToolSmtpConfig
|
|
179
135
|
* // host: "STRING_VALUE", // required
|
|
180
136
|
* // port: Number("int"), // required
|
|
181
|
-
* // username: "STRING_VALUE",
|
|
182
|
-
* // password: "STRING_VALUE",
|
|
183
|
-
* // secure: true || false,
|
|
137
|
+
* // username: "STRING_VALUE", // required
|
|
138
|
+
* // password: "STRING_VALUE", // required
|
|
139
|
+
* // secure: true || false, // required
|
|
184
140
|
* // },
|
|
185
141
|
* // from: {// Union: only one key present
|
|
186
142
|
* // static: "STRING_VALUE",
|
|
@@ -194,53 +150,12 @@ declare const CreateToolCommand_base: {
|
|
|
194
150
|
* // },
|
|
195
151
|
* // subject: "<ToolStringValue>", // required
|
|
196
152
|
* // text: "<ToolStringValue>", // required
|
|
197
|
-
* // html: "<ToolStringValue>",
|
|
153
|
+
* // html: "<ToolStringValue>", // required
|
|
198
154
|
* // cc: "<ToolStringValue>",
|
|
199
155
|
* // bcc: "<ToolStringValue>",
|
|
200
156
|
* // replyTo: "<ToolStringValue>",
|
|
201
157
|
* // },
|
|
202
158
|
* // },
|
|
203
|
-
* // sms: { // ToolSmsHandler
|
|
204
|
-
* // serviceUri: "<ToolStringValue>", // required
|
|
205
|
-
* // recipientId: "<ToolStringValue>",
|
|
206
|
-
* // recipientNumber: "<ToolStringValue>", // required
|
|
207
|
-
* // message: "<ToolStringValue>", // required
|
|
208
|
-
* // },
|
|
209
|
-
* // chat: { // ToolChatHandler Union: only one key present
|
|
210
|
-
* // direct: { // ToolDirectMessageConfig
|
|
211
|
-
* // memberEmail: "<ToolStringValue>",
|
|
212
|
-
* // memberPhone: "<ToolStringValue>",
|
|
213
|
-
* // memberId: "<ToolStringValue>",
|
|
214
|
-
* // text: "<ToolStringValue>", // required
|
|
215
|
-
* // },
|
|
216
|
-
* // channel: { // ToolChannelMessageConfig
|
|
217
|
-
* // channelId: "<ToolStringValue>", // required
|
|
218
|
-
* // text: "<ToolStringValue>", // required
|
|
219
|
-
* // },
|
|
220
|
-
* // },
|
|
221
|
-
* // webhook: { // ToolWebhookHandler
|
|
222
|
-
* // url: "<ToolStringValue>", // required
|
|
223
|
-
* // body: "<ToolStringValue>", // required
|
|
224
|
-
* // key: "<ToolStringValue>",
|
|
225
|
-
* // secret: "<ToolStringValue>", // required
|
|
226
|
-
* // timeout: Number("int"),
|
|
227
|
-
* // },
|
|
228
|
-
* // mcp: { // ToolMcpHandler
|
|
229
|
-
* // serverUrl: "STRING_VALUE", // required
|
|
230
|
-
* // transport: "http" || "stdio" || "sse", // required
|
|
231
|
-
* // authentication: { // ToolAuthentication
|
|
232
|
-
* // type: "Bearer" || "Basic" || "ApiKey", // required
|
|
233
|
-
* // token: "STRING_VALUE", // required
|
|
234
|
-
* // },
|
|
235
|
-
* // timeout: Number("int"),
|
|
236
|
-
* // tools: [ // ToolMcpToolConfigList
|
|
237
|
-
* // { // ToolMcpToolConfig
|
|
238
|
-
* // mcpToolId: "STRING_VALUE", // required
|
|
239
|
-
* // description: "STRING_VALUE",
|
|
240
|
-
* // parameters: "DOCUMENT_VALUE",
|
|
241
|
-
* // },
|
|
242
|
-
* // ],
|
|
243
|
-
* // },
|
|
244
159
|
* // },
|
|
245
160
|
* // },
|
|
246
161
|
* // };
|
|
@@ -259,12 +174,15 @@ declare const CreateToolCommand_base: {
|
|
|
259
174
|
*
|
|
260
175
|
* @throws {@link NotFoundException} (client fault)
|
|
261
176
|
*
|
|
262
|
-
* @throws {@link ToolExecutionException} (
|
|
177
|
+
* @throws {@link ToolExecutionException} (client fault)
|
|
178
|
+
*
|
|
179
|
+
* @throws {@link ToolExecutionServerException} (server fault)
|
|
263
180
|
*
|
|
264
181
|
* @throws {@link ToolsServiceException}
|
|
265
182
|
* <p>Base exception class for all service exceptions from Tools service.</p>
|
|
266
183
|
*
|
|
267
184
|
*
|
|
185
|
+
* @public
|
|
268
186
|
*/
|
|
269
187
|
export declare class CreateToolCommand extends CreateToolCommand_base {
|
|
270
188
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -27,8 +27,7 @@ declare const DeleteToolCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
*
|
|
31
|
-
*
|
|
30
|
+
* Delete a tool by its ID.
|
|
32
31
|
* @example
|
|
33
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
34
33
|
* ```javascript
|
|
@@ -36,7 +35,7 @@ declare const DeleteToolCommand_base: {
|
|
|
36
35
|
* // const { ToolsClient, DeleteToolCommand } = require("@wildix/wim-tools-client"); // CommonJS import
|
|
37
36
|
* const client = new ToolsClient(config);
|
|
38
37
|
* const input = { // DeleteToolInput
|
|
39
|
-
*
|
|
38
|
+
* companyId: "STRING_VALUE",
|
|
40
39
|
* toolId: "STRING_VALUE", // required
|
|
41
40
|
* };
|
|
42
41
|
* const command = new DeleteToolCommand(input);
|
|
@@ -57,12 +56,15 @@ declare const DeleteToolCommand_base: {
|
|
|
57
56
|
*
|
|
58
57
|
* @throws {@link AlreadyExistException} (client fault)
|
|
59
58
|
*
|
|
60
|
-
* @throws {@link ToolExecutionException} (
|
|
59
|
+
* @throws {@link ToolExecutionException} (client fault)
|
|
60
|
+
*
|
|
61
|
+
* @throws {@link ToolExecutionServerException} (server fault)
|
|
61
62
|
*
|
|
62
63
|
* @throws {@link ToolsServiceException}
|
|
63
64
|
* <p>Base exception class for all service exceptions from Tools service.</p>
|
|
64
65
|
*
|
|
65
66
|
*
|
|
67
|
+
* @public
|
|
66
68
|
*/
|
|
67
69
|
export declare class DeleteToolCommand extends DeleteToolCommand_base {
|
|
68
70
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -27,8 +27,7 @@ declare const DescribeToolsCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
*
|
|
31
|
-
*
|
|
30
|
+
* Describe multiple tools by their IDs.
|
|
32
31
|
* @example
|
|
33
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
34
33
|
* ```javascript
|
|
@@ -36,7 +35,7 @@ declare const DescribeToolsCommand_base: {
|
|
|
36
35
|
* // const { ToolsClient, DescribeToolsCommand } = require("@wildix/wim-tools-client"); // CommonJS import
|
|
37
36
|
* const client = new ToolsClient(config);
|
|
38
37
|
* const input = { // DescribeToolsInput
|
|
39
|
-
*
|
|
38
|
+
* companyId: "STRING_VALUE",
|
|
40
39
|
* ids: [ // ToolIdList // required
|
|
41
40
|
* "STRING_VALUE",
|
|
42
41
|
* ],
|
|
@@ -53,7 +52,6 @@ declare const DescribeToolsCommand_base: {
|
|
|
53
52
|
* // { // ToolVariable
|
|
54
53
|
* // name: "STRING_VALUE", // required
|
|
55
54
|
* // type: "string" || "number" || "boolean" || "string_array" || "number_array", // required
|
|
56
|
-
* // required: true || false,
|
|
57
55
|
* // },
|
|
58
56
|
* // ],
|
|
59
57
|
* // },
|
|
@@ -74,12 +72,15 @@ declare const DescribeToolsCommand_base: {
|
|
|
74
72
|
*
|
|
75
73
|
* @throws {@link AlreadyExistException} (client fault)
|
|
76
74
|
*
|
|
77
|
-
* @throws {@link ToolExecutionException} (
|
|
75
|
+
* @throws {@link ToolExecutionException} (client fault)
|
|
76
|
+
*
|
|
77
|
+
* @throws {@link ToolExecutionServerException} (server fault)
|
|
78
78
|
*
|
|
79
79
|
* @throws {@link ToolsServiceException}
|
|
80
80
|
* <p>Base exception class for all service exceptions from Tools service.</p>
|
|
81
81
|
*
|
|
82
82
|
*
|
|
83
|
+
* @public
|
|
83
84
|
*/
|
|
84
85
|
export declare class DescribeToolsCommand extends DescribeToolsCommand_base {
|
|
85
86
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -27,8 +27,7 @@ declare const ExecuteToolCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
*
|
|
31
|
-
*
|
|
30
|
+
* Execute a tool with the provided input.
|
|
32
31
|
* @example
|
|
33
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
34
33
|
* ```javascript
|
|
@@ -36,7 +35,7 @@ declare const ExecuteToolCommand_base: {
|
|
|
36
35
|
* // const { ToolsClient, ExecuteToolCommand } = require("@wildix/wim-tools-client"); // CommonJS import
|
|
37
36
|
* const client = new ToolsClient(config);
|
|
38
37
|
* const input = { // ExecuteToolInput
|
|
39
|
-
*
|
|
38
|
+
* companyId: "STRING_VALUE",
|
|
40
39
|
* id: "STRING_VALUE", // required
|
|
41
40
|
* input: "DOCUMENT_VALUE", // required
|
|
42
41
|
* service: "STRING_VALUE",
|
|
@@ -66,7 +65,9 @@ declare const ExecuteToolCommand_base: {
|
|
|
66
65
|
*
|
|
67
66
|
* @throws {@link NotFoundException} (client fault)
|
|
68
67
|
*
|
|
69
|
-
* @throws {@link ToolExecutionException} (
|
|
68
|
+
* @throws {@link ToolExecutionException} (client fault)
|
|
69
|
+
*
|
|
70
|
+
* @throws {@link ToolExecutionServerException} (server fault)
|
|
70
71
|
*
|
|
71
72
|
* @throws {@link AlreadyExistException} (client fault)
|
|
72
73
|
*
|
|
@@ -74,6 +75,7 @@ declare const ExecuteToolCommand_base: {
|
|
|
74
75
|
* <p>Base exception class for all service exceptions from Tools service.</p>
|
|
75
76
|
*
|
|
76
77
|
*
|
|
78
|
+
* @public
|
|
77
79
|
*/
|
|
78
80
|
export declare class ExecuteToolCommand extends ExecuteToolCommand_base {
|
|
79
81
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -27,8 +27,7 @@ declare const GetToolCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
*
|
|
31
|
-
*
|
|
30
|
+
* Get a tool by its ID.
|
|
32
31
|
* @example
|
|
33
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
34
33
|
* ```javascript
|
|
@@ -36,7 +35,7 @@ declare const GetToolCommand_base: {
|
|
|
36
35
|
* // const { ToolsClient, GetToolCommand } = require("@wildix/wim-tools-client"); // CommonJS import
|
|
37
36
|
* const client = new ToolsClient(config);
|
|
38
37
|
* const input = { // GetToolInput
|
|
39
|
-
*
|
|
38
|
+
* companyId: "STRING_VALUE",
|
|
40
39
|
* toolId: "STRING_VALUE", // required
|
|
41
40
|
* };
|
|
42
41
|
* const command = new GetToolCommand(input);
|
|
@@ -44,16 +43,15 @@ declare const GetToolCommand_base: {
|
|
|
44
43
|
* // { // GetToolOutput
|
|
45
44
|
* // tool: { // Tool
|
|
46
45
|
* // id: "STRING_VALUE", // required
|
|
47
|
-
* //
|
|
46
|
+
* // companyId: "STRING_VALUE", // required
|
|
48
47
|
* // name: "STRING_VALUE", // required
|
|
49
48
|
* // category: "STRING_VALUE", // required
|
|
50
|
-
* // description: "STRING_VALUE",
|
|
49
|
+
* // description: "STRING_VALUE", // required
|
|
51
50
|
* // input: { // ToolInput
|
|
52
51
|
* // variables: [ // ToolVariableList // required
|
|
53
52
|
* // { // ToolVariable
|
|
54
53
|
* // name: "STRING_VALUE", // required
|
|
55
54
|
* // type: "string" || "number" || "boolean" || "string_array" || "number_array", // required
|
|
56
|
-
* // required: true || false,
|
|
57
55
|
* // },
|
|
58
56
|
* // ],
|
|
59
57
|
* // },
|
|
@@ -80,9 +78,9 @@ declare const GetToolCommand_base: {
|
|
|
80
78
|
* // smtp: { // ToolSmtpConfig
|
|
81
79
|
* // host: "STRING_VALUE", // required
|
|
82
80
|
* // port: Number("int"), // required
|
|
83
|
-
* // username: "STRING_VALUE",
|
|
84
|
-
* // password: "STRING_VALUE",
|
|
85
|
-
* // secure: true || false,
|
|
81
|
+
* // username: "STRING_VALUE", // required
|
|
82
|
+
* // password: "STRING_VALUE", // required
|
|
83
|
+
* // secure: true || false, // required
|
|
86
84
|
* // },
|
|
87
85
|
* // from: {// Union: only one key present
|
|
88
86
|
* // static: "STRING_VALUE",
|
|
@@ -96,53 +94,12 @@ declare const GetToolCommand_base: {
|
|
|
96
94
|
* // },
|
|
97
95
|
* // subject: "<ToolStringValue>", // required
|
|
98
96
|
* // text: "<ToolStringValue>", // required
|
|
99
|
-
* // html: "<ToolStringValue>",
|
|
97
|
+
* // html: "<ToolStringValue>", // required
|
|
100
98
|
* // cc: "<ToolStringValue>",
|
|
101
99
|
* // bcc: "<ToolStringValue>",
|
|
102
100
|
* // replyTo: "<ToolStringValue>",
|
|
103
101
|
* // },
|
|
104
102
|
* // },
|
|
105
|
-
* // sms: { // ToolSmsHandler
|
|
106
|
-
* // serviceUri: "<ToolStringValue>", // required
|
|
107
|
-
* // recipientId: "<ToolStringValue>",
|
|
108
|
-
* // recipientNumber: "<ToolStringValue>", // required
|
|
109
|
-
* // message: "<ToolStringValue>", // required
|
|
110
|
-
* // },
|
|
111
|
-
* // chat: { // ToolChatHandler Union: only one key present
|
|
112
|
-
* // direct: { // ToolDirectMessageConfig
|
|
113
|
-
* // memberEmail: "<ToolStringValue>",
|
|
114
|
-
* // memberPhone: "<ToolStringValue>",
|
|
115
|
-
* // memberId: "<ToolStringValue>",
|
|
116
|
-
* // text: "<ToolStringValue>", // required
|
|
117
|
-
* // },
|
|
118
|
-
* // channel: { // ToolChannelMessageConfig
|
|
119
|
-
* // channelId: "<ToolStringValue>", // required
|
|
120
|
-
* // text: "<ToolStringValue>", // required
|
|
121
|
-
* // },
|
|
122
|
-
* // },
|
|
123
|
-
* // webhook: { // ToolWebhookHandler
|
|
124
|
-
* // url: "<ToolStringValue>", // required
|
|
125
|
-
* // body: "<ToolStringValue>", // required
|
|
126
|
-
* // key: "<ToolStringValue>",
|
|
127
|
-
* // secret: "<ToolStringValue>", // required
|
|
128
|
-
* // timeout: Number("int"),
|
|
129
|
-
* // },
|
|
130
|
-
* // mcp: { // ToolMcpHandler
|
|
131
|
-
* // serverUrl: "STRING_VALUE", // required
|
|
132
|
-
* // transport: "http" || "stdio" || "sse", // required
|
|
133
|
-
* // authentication: { // ToolAuthentication
|
|
134
|
-
* // type: "Bearer" || "Basic" || "ApiKey", // required
|
|
135
|
-
* // token: "STRING_VALUE", // required
|
|
136
|
-
* // },
|
|
137
|
-
* // timeout: Number("int"),
|
|
138
|
-
* // tools: [ // ToolMcpToolConfigList
|
|
139
|
-
* // { // ToolMcpToolConfig
|
|
140
|
-
* // mcpToolId: "STRING_VALUE", // required
|
|
141
|
-
* // description: "STRING_VALUE",
|
|
142
|
-
* // parameters: "DOCUMENT_VALUE",
|
|
143
|
-
* // },
|
|
144
|
-
* // ],
|
|
145
|
-
* // },
|
|
146
103
|
* // },
|
|
147
104
|
* // },
|
|
148
105
|
* // };
|
|
@@ -161,12 +118,15 @@ declare const GetToolCommand_base: {
|
|
|
161
118
|
*
|
|
162
119
|
* @throws {@link AlreadyExistException} (client fault)
|
|
163
120
|
*
|
|
164
|
-
* @throws {@link ToolExecutionException} (
|
|
121
|
+
* @throws {@link ToolExecutionException} (client fault)
|
|
122
|
+
*
|
|
123
|
+
* @throws {@link ToolExecutionServerException} (server fault)
|
|
165
124
|
*
|
|
166
125
|
* @throws {@link ToolsServiceException}
|
|
167
126
|
* <p>Base exception class for all service exceptions from Tools service.</p>
|
|
168
127
|
*
|
|
169
128
|
*
|
|
129
|
+
* @public
|
|
170
130
|
*/
|
|
171
131
|
export declare class GetToolCommand extends GetToolCommand_base {
|
|
172
132
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -27,8 +27,7 @@ declare const ListToolsCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
*
|
|
31
|
-
*
|
|
30
|
+
* List all tools for the current company.
|
|
32
31
|
* @example
|
|
33
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
34
33
|
* ```javascript
|
|
@@ -36,7 +35,7 @@ declare const ListToolsCommand_base: {
|
|
|
36
35
|
* // const { ToolsClient, ListToolsCommand } = require("@wildix/wim-tools-client"); // CommonJS import
|
|
37
36
|
* const client = new ToolsClient(config);
|
|
38
37
|
* const input = { // ListToolsInput
|
|
39
|
-
*
|
|
38
|
+
* companyId: "STRING_VALUE",
|
|
40
39
|
* };
|
|
41
40
|
* const command = new ListToolsCommand(input);
|
|
42
41
|
* const response = await client.send(command);
|
|
@@ -44,16 +43,15 @@ declare const ListToolsCommand_base: {
|
|
|
44
43
|
* // tools: [ // ToolsList // required
|
|
45
44
|
* // { // Tool
|
|
46
45
|
* // id: "STRING_VALUE", // required
|
|
47
|
-
* //
|
|
46
|
+
* // companyId: "STRING_VALUE", // required
|
|
48
47
|
* // name: "STRING_VALUE", // required
|
|
49
48
|
* // category: "STRING_VALUE", // required
|
|
50
|
-
* // description: "STRING_VALUE",
|
|
49
|
+
* // description: "STRING_VALUE", // required
|
|
51
50
|
* // input: { // ToolInput
|
|
52
51
|
* // variables: [ // ToolVariableList // required
|
|
53
52
|
* // { // ToolVariable
|
|
54
53
|
* // name: "STRING_VALUE", // required
|
|
55
54
|
* // type: "string" || "number" || "boolean" || "string_array" || "number_array", // required
|
|
56
|
-
* // required: true || false,
|
|
57
55
|
* // },
|
|
58
56
|
* // ],
|
|
59
57
|
* // },
|
|
@@ -80,9 +78,9 @@ declare const ListToolsCommand_base: {
|
|
|
80
78
|
* // smtp: { // ToolSmtpConfig
|
|
81
79
|
* // host: "STRING_VALUE", // required
|
|
82
80
|
* // port: Number("int"), // required
|
|
83
|
-
* // username: "STRING_VALUE",
|
|
84
|
-
* // password: "STRING_VALUE",
|
|
85
|
-
* // secure: true || false,
|
|
81
|
+
* // username: "STRING_VALUE", // required
|
|
82
|
+
* // password: "STRING_VALUE", // required
|
|
83
|
+
* // secure: true || false, // required
|
|
86
84
|
* // },
|
|
87
85
|
* // from: {// Union: only one key present
|
|
88
86
|
* // static: "STRING_VALUE",
|
|
@@ -96,53 +94,12 @@ declare const ListToolsCommand_base: {
|
|
|
96
94
|
* // },
|
|
97
95
|
* // subject: "<ToolStringValue>", // required
|
|
98
96
|
* // text: "<ToolStringValue>", // required
|
|
99
|
-
* // html: "<ToolStringValue>",
|
|
97
|
+
* // html: "<ToolStringValue>", // required
|
|
100
98
|
* // cc: "<ToolStringValue>",
|
|
101
99
|
* // bcc: "<ToolStringValue>",
|
|
102
100
|
* // replyTo: "<ToolStringValue>",
|
|
103
101
|
* // },
|
|
104
102
|
* // },
|
|
105
|
-
* // sms: { // ToolSmsHandler
|
|
106
|
-
* // serviceUri: "<ToolStringValue>", // required
|
|
107
|
-
* // recipientId: "<ToolStringValue>",
|
|
108
|
-
* // recipientNumber: "<ToolStringValue>", // required
|
|
109
|
-
* // message: "<ToolStringValue>", // required
|
|
110
|
-
* // },
|
|
111
|
-
* // chat: { // ToolChatHandler Union: only one key present
|
|
112
|
-
* // direct: { // ToolDirectMessageConfig
|
|
113
|
-
* // memberEmail: "<ToolStringValue>",
|
|
114
|
-
* // memberPhone: "<ToolStringValue>",
|
|
115
|
-
* // memberId: "<ToolStringValue>",
|
|
116
|
-
* // text: "<ToolStringValue>", // required
|
|
117
|
-
* // },
|
|
118
|
-
* // channel: { // ToolChannelMessageConfig
|
|
119
|
-
* // channelId: "<ToolStringValue>", // required
|
|
120
|
-
* // text: "<ToolStringValue>", // required
|
|
121
|
-
* // },
|
|
122
|
-
* // },
|
|
123
|
-
* // webhook: { // ToolWebhookHandler
|
|
124
|
-
* // url: "<ToolStringValue>", // required
|
|
125
|
-
* // body: "<ToolStringValue>", // required
|
|
126
|
-
* // key: "<ToolStringValue>",
|
|
127
|
-
* // secret: "<ToolStringValue>", // required
|
|
128
|
-
* // timeout: Number("int"),
|
|
129
|
-
* // },
|
|
130
|
-
* // mcp: { // ToolMcpHandler
|
|
131
|
-
* // serverUrl: "STRING_VALUE", // required
|
|
132
|
-
* // transport: "http" || "stdio" || "sse", // required
|
|
133
|
-
* // authentication: { // ToolAuthentication
|
|
134
|
-
* // type: "Bearer" || "Basic" || "ApiKey", // required
|
|
135
|
-
* // token: "STRING_VALUE", // required
|
|
136
|
-
* // },
|
|
137
|
-
* // timeout: Number("int"),
|
|
138
|
-
* // tools: [ // ToolMcpToolConfigList
|
|
139
|
-
* // { // ToolMcpToolConfig
|
|
140
|
-
* // mcpToolId: "STRING_VALUE", // required
|
|
141
|
-
* // description: "STRING_VALUE",
|
|
142
|
-
* // parameters: "DOCUMENT_VALUE",
|
|
143
|
-
* // },
|
|
144
|
-
* // ],
|
|
145
|
-
* // },
|
|
146
103
|
* // },
|
|
147
104
|
* // },
|
|
148
105
|
* // ],
|
|
@@ -162,12 +119,15 @@ declare const ListToolsCommand_base: {
|
|
|
162
119
|
*
|
|
163
120
|
* @throws {@link AlreadyExistException} (client fault)
|
|
164
121
|
*
|
|
165
|
-
* @throws {@link ToolExecutionException} (
|
|
122
|
+
* @throws {@link ToolExecutionException} (client fault)
|
|
123
|
+
*
|
|
124
|
+
* @throws {@link ToolExecutionServerException} (server fault)
|
|
166
125
|
*
|
|
167
126
|
* @throws {@link ToolsServiceException}
|
|
168
127
|
* <p>Base exception class for all service exceptions from Tools service.</p>
|
|
169
128
|
*
|
|
170
129
|
*
|
|
130
|
+
* @public
|
|
171
131
|
*/
|
|
172
132
|
export declare class ListToolsCommand extends ListToolsCommand_base {
|
|
173
133
|
/** @internal type navigation helper, not in runtime. */
|