@wildix/wim-tools-client 0.0.8 → 0.0.10
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/Tools.js +4 -2
- package/dist-cjs/ToolsClient.js +14 -13
- package/dist-cjs/commands/{AddToolCommand.js → CreateToolCommand.js} +7 -7
- package/dist-cjs/commands/DescribeToolsCommand.js +21 -0
- package/dist-cjs/commands/index.js +2 -1
- package/dist-cjs/models/models_0.js +85 -22
- package/dist-cjs/protocols/Aws_restJson1.js +70 -84
- package/dist-es/Tools.js +4 -2
- package/dist-es/ToolsClient.js +14 -13
- package/dist-es/commands/{AddToolCommand.js → CreateToolCommand.js} +6 -6
- package/dist-es/commands/DescribeToolsCommand.js +17 -0
- package/dist-es/commands/index.js +2 -1
- package/dist-es/models/models_0.js +82 -19
- package/dist-es/protocols/Aws_restJson1.js +67 -83
- package/dist-types/Tools.d.ts +12 -5
- package/dist-types/ToolsClient.d.ts +10 -7
- package/dist-types/commands/CreateToolCommand.d.ts +303 -0
- package/dist-types/commands/DeleteToolCommand.d.ts +5 -5
- package/dist-types/commands/DescribeToolsCommand.d.ts +97 -0
- package/dist-types/commands/ExecuteToolCommand.d.ts +13 -16
- package/dist-types/commands/GetToolCommand.d.ts +114 -11
- package/dist-types/commands/ListToolsCommand.d.ts +114 -22
- package/dist-types/commands/UpdateToolCommand.d.ts +222 -13
- package/dist-types/commands/index.d.ts +2 -1
- package/dist-types/models/models_0.d.ts +380 -273
- package/dist-types/protocols/Aws_restJson1.d.ts +14 -5
- package/dist-types/runtimeConfig.browser.d.ts +3 -5
- package/dist-types/runtimeConfig.d.ts +3 -5
- package/dist-types/runtimeConfig.native.d.ts +3 -5
- package/package.json +1 -1
- package/dist-types/commands/AddToolCommand.d.ts +0 -98
|
@@ -0,0 +1,303 @@
|
|
|
1
|
+
import { ServiceInputTypes, ServiceOutputTypes, ToolsClientResolvedConfig } from "../ToolsClient";
|
|
2
|
+
import { CreateToolInput, CreateToolOutput } from "../models/models_0";
|
|
3
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
4
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link CreateToolCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface CreateToolCommandInput extends CreateToolInput {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link CreateToolCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface CreateToolCommandOutput extends CreateToolOutput, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const CreateToolCommand_base: {
|
|
25
|
+
new (input: CreateToolCommandInput): import("@smithy/smithy-client").CommandImpl<CreateToolCommandInput, CreateToolCommandOutput, ToolsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (__0_0: CreateToolCommandInput): import("@smithy/smithy-client").CommandImpl<CreateToolCommandInput, CreateToolCommandOutput, ToolsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* @public
|
|
31
|
+
*
|
|
32
|
+
* @example
|
|
33
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
34
|
+
* ```javascript
|
|
35
|
+
* import { ToolsClient, CreateToolCommand } from "@wildix/wim-tools-client"; // ES Modules import
|
|
36
|
+
* // const { ToolsClient, CreateToolCommand } = require("@wildix/wim-tools-client"); // CommonJS import
|
|
37
|
+
* const client = new ToolsClient(config);
|
|
38
|
+
* const input = { // CreateToolInput
|
|
39
|
+
* company: "STRING_VALUE",
|
|
40
|
+
* name: "STRING_VALUE", // required
|
|
41
|
+
* description: "STRING_VALUE", // required
|
|
42
|
+
* input: { // ToolInput
|
|
43
|
+
* variables: [ // ToolVariableList // required
|
|
44
|
+
* { // ToolVariable
|
|
45
|
+
* name: "STRING_VALUE", // required
|
|
46
|
+
* type: "string" || "number" || "boolean" || "string_array" || "number_array" || "object", // required
|
|
47
|
+
* description: "STRING_VALUE", // required
|
|
48
|
+
* required: true || false,
|
|
49
|
+
* },
|
|
50
|
+
* ],
|
|
51
|
+
* },
|
|
52
|
+
* handler: { // ToolHandler Union: only one key present
|
|
53
|
+
* email: { // ToolEmailHandler Union: only one key present
|
|
54
|
+
* wns: { // ToolWnsEmailConfig
|
|
55
|
+
* to: { // ToolStringValue Union: only one key present
|
|
56
|
+
* static: "STRING_VALUE",
|
|
57
|
+
* variable: "STRING_VALUE",
|
|
58
|
+
* template: "STRING_VALUE",
|
|
59
|
+
* },
|
|
60
|
+
* subject: {// Union: only one key present
|
|
61
|
+
* static: "STRING_VALUE",
|
|
62
|
+
* variable: "STRING_VALUE",
|
|
63
|
+
* template: "STRING_VALUE",
|
|
64
|
+
* },
|
|
65
|
+
* text: {// Union: only one key present
|
|
66
|
+
* static: "STRING_VALUE",
|
|
67
|
+
* variable: "STRING_VALUE",
|
|
68
|
+
* template: "STRING_VALUE",
|
|
69
|
+
* },
|
|
70
|
+
* },
|
|
71
|
+
* custom: { // ToolCustomEmailConfig
|
|
72
|
+
* smtp: { // ToolSmtpConfig
|
|
73
|
+
* host: "STRING_VALUE", // required
|
|
74
|
+
* port: Number("int"), // required
|
|
75
|
+
* username: "STRING_VALUE",
|
|
76
|
+
* password: "STRING_VALUE",
|
|
77
|
+
* secure: true || false,
|
|
78
|
+
* },
|
|
79
|
+
* from: {// Union: only one key present
|
|
80
|
+
* static: "STRING_VALUE",
|
|
81
|
+
* variable: "STRING_VALUE",
|
|
82
|
+
* template: "STRING_VALUE",
|
|
83
|
+
* },
|
|
84
|
+
* to: {// Union: only one key present
|
|
85
|
+
* static: "STRING_VALUE",
|
|
86
|
+
* variable: "STRING_VALUE",
|
|
87
|
+
* template: "STRING_VALUE",
|
|
88
|
+
* },
|
|
89
|
+
* subject: "<ToolStringValue>", // required
|
|
90
|
+
* text: "<ToolStringValue>", // required
|
|
91
|
+
* html: "<ToolStringValue>",
|
|
92
|
+
* cc: "<ToolStringValue>",
|
|
93
|
+
* bcc: "<ToolStringValue>",
|
|
94
|
+
* replyTo: "<ToolStringValue>",
|
|
95
|
+
* },
|
|
96
|
+
* },
|
|
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: [ // ToolMcpToolList // required
|
|
131
|
+
* { // ToolMcpTool
|
|
132
|
+
* name: "STRING_VALUE", // required
|
|
133
|
+
* input: {
|
|
134
|
+
* variables: [ // required
|
|
135
|
+
* {
|
|
136
|
+
* name: "STRING_VALUE", // required
|
|
137
|
+
* type: "string" || "number" || "boolean" || "string_array" || "number_array" || "object", // required
|
|
138
|
+
* description: "STRING_VALUE", // required
|
|
139
|
+
* required: true || false,
|
|
140
|
+
* },
|
|
141
|
+
* ],
|
|
142
|
+
* },
|
|
143
|
+
* params: { // ToolMcpToolParams // required
|
|
144
|
+
* "<keys>": "<ToolStringValue>",
|
|
145
|
+
* },
|
|
146
|
+
* },
|
|
147
|
+
* ],
|
|
148
|
+
* },
|
|
149
|
+
* },
|
|
150
|
+
* };
|
|
151
|
+
* const command = new CreateToolCommand(input);
|
|
152
|
+
* const response = await client.send(command);
|
|
153
|
+
* // { // CreateToolOutput
|
|
154
|
+
* // tool: { // Tool
|
|
155
|
+
* // id: "STRING_VALUE", // required
|
|
156
|
+
* // company: "STRING_VALUE", // required
|
|
157
|
+
* // name: "STRING_VALUE", // required
|
|
158
|
+
* // description: "STRING_VALUE",
|
|
159
|
+
* // input: { // ToolInput
|
|
160
|
+
* // variables: [ // ToolVariableList // required
|
|
161
|
+
* // { // ToolVariable
|
|
162
|
+
* // name: "STRING_VALUE", // required
|
|
163
|
+
* // type: "string" || "number" || "boolean" || "string_array" || "number_array" || "object", // required
|
|
164
|
+
* // description: "STRING_VALUE", // required
|
|
165
|
+
* // required: true || false,
|
|
166
|
+
* // },
|
|
167
|
+
* // ],
|
|
168
|
+
* // },
|
|
169
|
+
* // handler: { // ToolHandler Union: only one key present
|
|
170
|
+
* // email: { // ToolEmailHandler Union: only one key present
|
|
171
|
+
* // wns: { // ToolWnsEmailConfig
|
|
172
|
+
* // to: { // ToolStringValue Union: only one key present
|
|
173
|
+
* // static: "STRING_VALUE",
|
|
174
|
+
* // variable: "STRING_VALUE",
|
|
175
|
+
* // template: "STRING_VALUE",
|
|
176
|
+
* // },
|
|
177
|
+
* // subject: {// Union: only one key present
|
|
178
|
+
* // static: "STRING_VALUE",
|
|
179
|
+
* // variable: "STRING_VALUE",
|
|
180
|
+
* // template: "STRING_VALUE",
|
|
181
|
+
* // },
|
|
182
|
+
* // text: {// Union: only one key present
|
|
183
|
+
* // static: "STRING_VALUE",
|
|
184
|
+
* // variable: "STRING_VALUE",
|
|
185
|
+
* // template: "STRING_VALUE",
|
|
186
|
+
* // },
|
|
187
|
+
* // },
|
|
188
|
+
* // custom: { // ToolCustomEmailConfig
|
|
189
|
+
* // smtp: { // ToolSmtpConfig
|
|
190
|
+
* // host: "STRING_VALUE", // required
|
|
191
|
+
* // port: Number("int"), // required
|
|
192
|
+
* // username: "STRING_VALUE",
|
|
193
|
+
* // password: "STRING_VALUE",
|
|
194
|
+
* // secure: true || false,
|
|
195
|
+
* // },
|
|
196
|
+
* // from: {// Union: only one key present
|
|
197
|
+
* // static: "STRING_VALUE",
|
|
198
|
+
* // variable: "STRING_VALUE",
|
|
199
|
+
* // template: "STRING_VALUE",
|
|
200
|
+
* // },
|
|
201
|
+
* // to: {// Union: only one key present
|
|
202
|
+
* // static: "STRING_VALUE",
|
|
203
|
+
* // variable: "STRING_VALUE",
|
|
204
|
+
* // template: "STRING_VALUE",
|
|
205
|
+
* // },
|
|
206
|
+
* // subject: "<ToolStringValue>", // required
|
|
207
|
+
* // text: "<ToolStringValue>", // required
|
|
208
|
+
* // html: "<ToolStringValue>",
|
|
209
|
+
* // cc: "<ToolStringValue>",
|
|
210
|
+
* // bcc: "<ToolStringValue>",
|
|
211
|
+
* // replyTo: "<ToolStringValue>",
|
|
212
|
+
* // },
|
|
213
|
+
* // },
|
|
214
|
+
* // sms: { // ToolSmsHandler
|
|
215
|
+
* // serviceUri: "<ToolStringValue>", // required
|
|
216
|
+
* // recipientId: "<ToolStringValue>",
|
|
217
|
+
* // recipientNumber: "<ToolStringValue>", // required
|
|
218
|
+
* // message: "<ToolStringValue>", // required
|
|
219
|
+
* // },
|
|
220
|
+
* // chat: { // ToolChatHandler Union: only one key present
|
|
221
|
+
* // direct: { // ToolDirectMessageConfig
|
|
222
|
+
* // memberEmail: "<ToolStringValue>",
|
|
223
|
+
* // memberPhone: "<ToolStringValue>",
|
|
224
|
+
* // memberId: "<ToolStringValue>",
|
|
225
|
+
* // text: "<ToolStringValue>", // required
|
|
226
|
+
* // },
|
|
227
|
+
* // channel: { // ToolChannelMessageConfig
|
|
228
|
+
* // channelId: "<ToolStringValue>", // required
|
|
229
|
+
* // text: "<ToolStringValue>", // required
|
|
230
|
+
* // },
|
|
231
|
+
* // },
|
|
232
|
+
* // webhook: { // ToolWebhookHandler
|
|
233
|
+
* // url: "<ToolStringValue>", // required
|
|
234
|
+
* // body: "<ToolStringValue>", // required
|
|
235
|
+
* // key: "<ToolStringValue>",
|
|
236
|
+
* // secret: "<ToolStringValue>", // required
|
|
237
|
+
* // timeout: Number("int"),
|
|
238
|
+
* // },
|
|
239
|
+
* // mcp: { // ToolMcpHandler
|
|
240
|
+
* // serverUrl: "STRING_VALUE", // required
|
|
241
|
+
* // transport: "http" || "stdio" || "sse", // required
|
|
242
|
+
* // authentication: { // ToolAuthentication
|
|
243
|
+
* // type: "Bearer" || "Basic" || "ApiKey", // required
|
|
244
|
+
* // token: "STRING_VALUE", // required
|
|
245
|
+
* // },
|
|
246
|
+
* // timeout: Number("int"),
|
|
247
|
+
* // tools: [ // ToolMcpToolList // required
|
|
248
|
+
* // { // ToolMcpTool
|
|
249
|
+
* // name: "STRING_VALUE", // required
|
|
250
|
+
* // input: {
|
|
251
|
+
* // variables: [ // required
|
|
252
|
+
* // {
|
|
253
|
+
* // name: "STRING_VALUE", // required
|
|
254
|
+
* // type: "string" || "number" || "boolean" || "string_array" || "number_array" || "object", // required
|
|
255
|
+
* // description: "STRING_VALUE", // required
|
|
256
|
+
* // required: true || false,
|
|
257
|
+
* // },
|
|
258
|
+
* // ],
|
|
259
|
+
* // },
|
|
260
|
+
* // params: { // ToolMcpToolParams // required
|
|
261
|
+
* // "<keys>": "<ToolStringValue>",
|
|
262
|
+
* // },
|
|
263
|
+
* // },
|
|
264
|
+
* // ],
|
|
265
|
+
* // },
|
|
266
|
+
* // },
|
|
267
|
+
* // },
|
|
268
|
+
* // };
|
|
269
|
+
*
|
|
270
|
+
* ```
|
|
271
|
+
*
|
|
272
|
+
* @param CreateToolCommandInput - {@link CreateToolCommandInput}
|
|
273
|
+
* @returns {@link CreateToolCommandOutput}
|
|
274
|
+
* @see {@link CreateToolCommandInput} for command's `input` shape.
|
|
275
|
+
* @see {@link CreateToolCommandOutput} for command's `response` shape.
|
|
276
|
+
* @see {@link ToolsClientResolvedConfig | config} for ToolsClient's `config` shape.
|
|
277
|
+
*
|
|
278
|
+
* @throws {@link ValidationException} (client fault)
|
|
279
|
+
*
|
|
280
|
+
* @throws {@link AlreadyExistException} (client fault)
|
|
281
|
+
*
|
|
282
|
+
* @throws {@link NotFoundException} (client fault)
|
|
283
|
+
*
|
|
284
|
+
* @throws {@link ToolExecutionException} (server fault)
|
|
285
|
+
*
|
|
286
|
+
* @throws {@link ToolsServiceException}
|
|
287
|
+
* <p>Base exception class for all service exceptions from Tools service.</p>
|
|
288
|
+
*
|
|
289
|
+
*
|
|
290
|
+
*/
|
|
291
|
+
export declare class CreateToolCommand extends CreateToolCommand_base {
|
|
292
|
+
/** @internal type navigation helper, not in runtime. */
|
|
293
|
+
protected static __types: {
|
|
294
|
+
api: {
|
|
295
|
+
input: CreateToolInput;
|
|
296
|
+
output: CreateToolOutput;
|
|
297
|
+
};
|
|
298
|
+
sdk: {
|
|
299
|
+
input: CreateToolCommandInput;
|
|
300
|
+
output: CreateToolCommandOutput;
|
|
301
|
+
};
|
|
302
|
+
};
|
|
303
|
+
}
|
|
@@ -27,7 +27,8 @@ declare const DeleteToolCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
*
|
|
30
|
+
* @public
|
|
31
|
+
*
|
|
31
32
|
* @example
|
|
32
33
|
* Use a bare-bones client and the command you need to make an API call.
|
|
33
34
|
* ```javascript
|
|
@@ -52,17 +53,16 @@ declare const DeleteToolCommand_base: {
|
|
|
52
53
|
*
|
|
53
54
|
* @throws {@link ValidationException} (client fault)
|
|
54
55
|
*
|
|
55
|
-
* @throws {@link
|
|
56
|
-
*
|
|
56
|
+
* @throws {@link NotFoundException} (client fault)
|
|
57
|
+
*
|
|
58
|
+
* @throws {@link AlreadyExistException} (client fault)
|
|
57
59
|
*
|
|
58
60
|
* @throws {@link ToolExecutionException} (server fault)
|
|
59
|
-
* Tool execution failed error
|
|
60
61
|
*
|
|
61
62
|
* @throws {@link ToolsServiceException}
|
|
62
63
|
* <p>Base exception class for all service exceptions from Tools service.</p>
|
|
63
64
|
*
|
|
64
65
|
*
|
|
65
|
-
* @public
|
|
66
66
|
*/
|
|
67
67
|
export declare class DeleteToolCommand extends DeleteToolCommand_base {
|
|
68
68
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -0,0 +1,97 @@
|
|
|
1
|
+
import { ServiceInputTypes, ServiceOutputTypes, ToolsClientResolvedConfig } from "../ToolsClient";
|
|
2
|
+
import { DescribeToolsInput, DescribeToolsOutput } from "../models/models_0";
|
|
3
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
4
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link DescribeToolsCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface DescribeToolsCommandInput extends DescribeToolsInput {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link DescribeToolsCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface DescribeToolsCommandOutput extends DescribeToolsOutput, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const DescribeToolsCommand_base: {
|
|
25
|
+
new (input: DescribeToolsCommandInput): import("@smithy/smithy-client").CommandImpl<DescribeToolsCommandInput, DescribeToolsCommandOutput, ToolsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (__0_0: DescribeToolsCommandInput): import("@smithy/smithy-client").CommandImpl<DescribeToolsCommandInput, DescribeToolsCommandOutput, ToolsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* @public
|
|
31
|
+
*
|
|
32
|
+
* @example
|
|
33
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
34
|
+
* ```javascript
|
|
35
|
+
* import { ToolsClient, DescribeToolsCommand } from "@wildix/wim-tools-client"; // ES Modules import
|
|
36
|
+
* // const { ToolsClient, DescribeToolsCommand } = require("@wildix/wim-tools-client"); // CommonJS import
|
|
37
|
+
* const client = new ToolsClient(config);
|
|
38
|
+
* const input = { // DescribeToolsInput
|
|
39
|
+
* company: "STRING_VALUE",
|
|
40
|
+
* ids: [ // ToolIdList // required
|
|
41
|
+
* "STRING_VALUE",
|
|
42
|
+
* ],
|
|
43
|
+
* };
|
|
44
|
+
* const command = new DescribeToolsCommand(input);
|
|
45
|
+
* const response = await client.send(command);
|
|
46
|
+
* // { // DescribeToolsOutput
|
|
47
|
+
* // descriptions: [ // ToolDescriptionList // required
|
|
48
|
+
* // { // ToolDescription
|
|
49
|
+
* // id: "STRING_VALUE", // required
|
|
50
|
+
* // name: "STRING_VALUE", // required
|
|
51
|
+
* // description: "STRING_VALUE", // required
|
|
52
|
+
* // variables: [ // ToolVariableList // required
|
|
53
|
+
* // { // ToolVariable
|
|
54
|
+
* // name: "STRING_VALUE", // required
|
|
55
|
+
* // type: "string" || "number" || "boolean" || "string_array" || "number_array" || "object", // required
|
|
56
|
+
* // description: "STRING_VALUE", // required
|
|
57
|
+
* // required: true || false,
|
|
58
|
+
* // },
|
|
59
|
+
* // ],
|
|
60
|
+
* // },
|
|
61
|
+
* // ],
|
|
62
|
+
* // };
|
|
63
|
+
*
|
|
64
|
+
* ```
|
|
65
|
+
*
|
|
66
|
+
* @param DescribeToolsCommandInput - {@link DescribeToolsCommandInput}
|
|
67
|
+
* @returns {@link DescribeToolsCommandOutput}
|
|
68
|
+
* @see {@link DescribeToolsCommandInput} for command's `input` shape.
|
|
69
|
+
* @see {@link DescribeToolsCommandOutput} for command's `response` shape.
|
|
70
|
+
* @see {@link ToolsClientResolvedConfig | config} for ToolsClient's `config` shape.
|
|
71
|
+
*
|
|
72
|
+
* @throws {@link ValidationException} (client fault)
|
|
73
|
+
*
|
|
74
|
+
* @throws {@link NotFoundException} (client fault)
|
|
75
|
+
*
|
|
76
|
+
* @throws {@link AlreadyExistException} (client fault)
|
|
77
|
+
*
|
|
78
|
+
* @throws {@link ToolExecutionException} (server fault)
|
|
79
|
+
*
|
|
80
|
+
* @throws {@link ToolsServiceException}
|
|
81
|
+
* <p>Base exception class for all service exceptions from Tools service.</p>
|
|
82
|
+
*
|
|
83
|
+
*
|
|
84
|
+
*/
|
|
85
|
+
export declare class DescribeToolsCommand extends DescribeToolsCommand_base {
|
|
86
|
+
/** @internal type navigation helper, not in runtime. */
|
|
87
|
+
protected static __types: {
|
|
88
|
+
api: {
|
|
89
|
+
input: DescribeToolsInput;
|
|
90
|
+
output: DescribeToolsOutput;
|
|
91
|
+
};
|
|
92
|
+
sdk: {
|
|
93
|
+
input: DescribeToolsCommandInput;
|
|
94
|
+
output: DescribeToolsCommandOutput;
|
|
95
|
+
};
|
|
96
|
+
};
|
|
97
|
+
}
|
|
@@ -27,7 +27,8 @@ declare const ExecuteToolCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
*
|
|
30
|
+
* @public
|
|
31
|
+
*
|
|
31
32
|
* @example
|
|
32
33
|
* Use a bare-bones client and the command you need to make an API call.
|
|
33
34
|
* ```javascript
|
|
@@ -36,21 +37,18 @@ declare const ExecuteToolCommand_base: {
|
|
|
36
37
|
* const client = new ToolsClient(config);
|
|
37
38
|
* const input = { // ExecuteToolInput
|
|
38
39
|
* company: "STRING_VALUE",
|
|
39
|
-
*
|
|
40
|
-
*
|
|
41
|
-
* context: { // ExecutionContext
|
|
42
|
-
* company: "STRING_VALUE", // required
|
|
43
|
-
* sessionId: "STRING_VALUE",
|
|
44
|
-
* },
|
|
40
|
+
* id: "STRING_VALUE", // required
|
|
41
|
+
* input: "DOCUMENT_VALUE", // required
|
|
45
42
|
* };
|
|
46
43
|
* const command = new ExecuteToolCommand(input);
|
|
47
44
|
* const response = await client.send(command);
|
|
48
45
|
* // { // ExecuteToolOutput
|
|
49
|
-
* // result: { //
|
|
50
|
-
* //
|
|
51
|
-
* //
|
|
52
|
-
* // error:
|
|
53
|
-
* //
|
|
46
|
+
* // result: { // ToolExecutionResult
|
|
47
|
+
* // statusCode: Number("int"), // required
|
|
48
|
+
* // output: "DOCUMENT_VALUE", // required
|
|
49
|
+
* // error: { // ToolExecutionError
|
|
50
|
+
* // message: "STRING_VALUE", // required
|
|
51
|
+
* // },
|
|
54
52
|
* // },
|
|
55
53
|
* // };
|
|
56
54
|
*
|
|
@@ -64,17 +62,16 @@ declare const ExecuteToolCommand_base: {
|
|
|
64
62
|
*
|
|
65
63
|
* @throws {@link ValidationException} (client fault)
|
|
66
64
|
*
|
|
67
|
-
* @throws {@link
|
|
68
|
-
* Tool not found error
|
|
65
|
+
* @throws {@link NotFoundException} (client fault)
|
|
69
66
|
*
|
|
70
67
|
* @throws {@link ToolExecutionException} (server fault)
|
|
71
|
-
*
|
|
68
|
+
*
|
|
69
|
+
* @throws {@link AlreadyExistException} (client fault)
|
|
72
70
|
*
|
|
73
71
|
* @throws {@link ToolsServiceException}
|
|
74
72
|
* <p>Base exception class for all service exceptions from Tools service.</p>
|
|
75
73
|
*
|
|
76
74
|
*
|
|
77
|
-
* @public
|
|
78
75
|
*/
|
|
79
76
|
export declare class ExecuteToolCommand extends ExecuteToolCommand_base {
|
|
80
77
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -27,7 +27,8 @@ declare const GetToolCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
*
|
|
30
|
+
* @public
|
|
31
|
+
*
|
|
31
32
|
* @example
|
|
32
33
|
* Use a bare-bones client and the command you need to make an API call.
|
|
33
34
|
* ```javascript
|
|
@@ -45,12 +46,115 @@ declare const GetToolCommand_base: {
|
|
|
45
46
|
* // id: "STRING_VALUE", // required
|
|
46
47
|
* // company: "STRING_VALUE", // required
|
|
47
48
|
* // name: "STRING_VALUE", // required
|
|
48
|
-
* // description: "STRING_VALUE",
|
|
49
|
-
* //
|
|
50
|
-
* //
|
|
51
|
-
* //
|
|
52
|
-
* //
|
|
53
|
-
* //
|
|
49
|
+
* // description: "STRING_VALUE",
|
|
50
|
+
* // input: { // ToolInput
|
|
51
|
+
* // variables: [ // ToolVariableList // required
|
|
52
|
+
* // { // ToolVariable
|
|
53
|
+
* // name: "STRING_VALUE", // required
|
|
54
|
+
* // type: "string" || "number" || "boolean" || "string_array" || "number_array" || "object", // required
|
|
55
|
+
* // description: "STRING_VALUE", // required
|
|
56
|
+
* // required: true || false,
|
|
57
|
+
* // },
|
|
58
|
+
* // ],
|
|
59
|
+
* // },
|
|
60
|
+
* // handler: { // ToolHandler Union: only one key present
|
|
61
|
+
* // email: { // ToolEmailHandler Union: only one key present
|
|
62
|
+
* // wns: { // ToolWnsEmailConfig
|
|
63
|
+
* // to: { // ToolStringValue Union: only one key present
|
|
64
|
+
* // static: "STRING_VALUE",
|
|
65
|
+
* // variable: "STRING_VALUE",
|
|
66
|
+
* // template: "STRING_VALUE",
|
|
67
|
+
* // },
|
|
68
|
+
* // subject: {// Union: only one key present
|
|
69
|
+
* // static: "STRING_VALUE",
|
|
70
|
+
* // variable: "STRING_VALUE",
|
|
71
|
+
* // template: "STRING_VALUE",
|
|
72
|
+
* // },
|
|
73
|
+
* // text: {// Union: only one key present
|
|
74
|
+
* // static: "STRING_VALUE",
|
|
75
|
+
* // variable: "STRING_VALUE",
|
|
76
|
+
* // template: "STRING_VALUE",
|
|
77
|
+
* // },
|
|
78
|
+
* // },
|
|
79
|
+
* // custom: { // ToolCustomEmailConfig
|
|
80
|
+
* // smtp: { // ToolSmtpConfig
|
|
81
|
+
* // host: "STRING_VALUE", // required
|
|
82
|
+
* // port: Number("int"), // required
|
|
83
|
+
* // username: "STRING_VALUE",
|
|
84
|
+
* // password: "STRING_VALUE",
|
|
85
|
+
* // secure: true || false,
|
|
86
|
+
* // },
|
|
87
|
+
* // from: {// Union: only one key present
|
|
88
|
+
* // static: "STRING_VALUE",
|
|
89
|
+
* // variable: "STRING_VALUE",
|
|
90
|
+
* // template: "STRING_VALUE",
|
|
91
|
+
* // },
|
|
92
|
+
* // to: {// Union: only one key present
|
|
93
|
+
* // static: "STRING_VALUE",
|
|
94
|
+
* // variable: "STRING_VALUE",
|
|
95
|
+
* // template: "STRING_VALUE",
|
|
96
|
+
* // },
|
|
97
|
+
* // subject: "<ToolStringValue>", // required
|
|
98
|
+
* // text: "<ToolStringValue>", // required
|
|
99
|
+
* // html: "<ToolStringValue>",
|
|
100
|
+
* // cc: "<ToolStringValue>",
|
|
101
|
+
* // bcc: "<ToolStringValue>",
|
|
102
|
+
* // replyTo: "<ToolStringValue>",
|
|
103
|
+
* // },
|
|
104
|
+
* // },
|
|
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: [ // ToolMcpToolList // required
|
|
139
|
+
* // { // ToolMcpTool
|
|
140
|
+
* // name: "STRING_VALUE", // required
|
|
141
|
+
* // input: {
|
|
142
|
+
* // variables: [ // required
|
|
143
|
+
* // {
|
|
144
|
+
* // name: "STRING_VALUE", // required
|
|
145
|
+
* // type: "string" || "number" || "boolean" || "string_array" || "number_array" || "object", // required
|
|
146
|
+
* // description: "STRING_VALUE", // required
|
|
147
|
+
* // required: true || false,
|
|
148
|
+
* // },
|
|
149
|
+
* // ],
|
|
150
|
+
* // },
|
|
151
|
+
* // params: { // ToolMcpToolParams // required
|
|
152
|
+
* // "<keys>": "<ToolStringValue>",
|
|
153
|
+
* // },
|
|
154
|
+
* // },
|
|
155
|
+
* // ],
|
|
156
|
+
* // },
|
|
157
|
+
* // },
|
|
54
158
|
* // },
|
|
55
159
|
* // };
|
|
56
160
|
*
|
|
@@ -64,17 +168,16 @@ declare const GetToolCommand_base: {
|
|
|
64
168
|
*
|
|
65
169
|
* @throws {@link ValidationException} (client fault)
|
|
66
170
|
*
|
|
67
|
-
* @throws {@link
|
|
68
|
-
*
|
|
171
|
+
* @throws {@link NotFoundException} (client fault)
|
|
172
|
+
*
|
|
173
|
+
* @throws {@link AlreadyExistException} (client fault)
|
|
69
174
|
*
|
|
70
175
|
* @throws {@link ToolExecutionException} (server fault)
|
|
71
|
-
* Tool execution failed error
|
|
72
176
|
*
|
|
73
177
|
* @throws {@link ToolsServiceException}
|
|
74
178
|
* <p>Base exception class for all service exceptions from Tools service.</p>
|
|
75
179
|
*
|
|
76
180
|
*
|
|
77
|
-
* @public
|
|
78
181
|
*/
|
|
79
182
|
export declare class GetToolCommand extends GetToolCommand_base {
|
|
80
183
|
/** @internal type navigation helper, not in runtime. */
|