@wildix/wim-tools-client 0.0.16 → 0.0.18

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.
Files changed (16) hide show
  1. package/dist-cjs/models/models_0.js +31 -44
  2. package/dist-cjs/protocols/Aws_restJson1.js +30 -111
  3. package/dist-es/models/models_0.js +28 -42
  4. package/dist-es/protocols/Aws_restJson1.js +32 -113
  5. package/dist-types/commands/CreateToolCommand.d.ts +16 -98
  6. package/dist-types/commands/DeleteToolCommand.d.ts +6 -4
  7. package/dist-types/commands/DescribeToolsCommand.d.ts +6 -5
  8. package/dist-types/commands/ExecuteToolCommand.d.ts +6 -5
  9. package/dist-types/commands/GetToolCommand.d.ts +11 -51
  10. package/dist-types/commands/ListToolsCommand.d.ts +11 -51
  11. package/dist-types/commands/UpdateToolCommand.d.ts +16 -98
  12. package/dist-types/models/models_0.d.ts +326 -199
  13. package/dist-types/runtimeConfig.browser.d.ts +6 -1
  14. package/dist-types/runtimeConfig.d.ts +6 -1
  15. package/dist-types/runtimeConfig.native.d.ts +6 -1
  16. package/package.json +1 -1
package/dist-types/commands/GetToolCommand.d.ts CHANGED
@@ -27,8 +27,7 @@ declare const GetToolCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * @public
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
- * company: "STRING_VALUE",
38
+ * companyId: "STRING_VALUE",
40
39
  * toolId: "STRING_VALUE", // required
41
40
  * };
42
41
  * const command = new GetToolCommand(input);
@@ -47,13 +46,12 @@ declare const GetToolCommand_base: {
47
46
  * // company: "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} (server fault)
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. */
package/dist-types/commands/ListToolsCommand.d.ts CHANGED
@@ -27,8 +27,7 @@ declare const ListToolsCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * @public
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
- * company: "STRING_VALUE",
38
+ * companyId: "STRING_VALUE",
40
39
  * };
41
40
  * const command = new ListToolsCommand(input);
42
41
  * const response = await client.send(command);
@@ -47,13 +46,12 @@ declare const ListToolsCommand_base: {
47
46
  * // company: "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} (server fault)
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. */
package/dist-types/commands/UpdateToolCommand.d.ts CHANGED
@@ -27,8 +27,7 @@ declare const UpdateToolCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * @public
31
- *
30
+ * Update 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,17 +35,16 @@ declare const UpdateToolCommand_base: {
36
35
  * // const { ToolsClient, UpdateToolCommand } = require("@wildix/wim-tools-client"); // CommonJS import
37
36
  * const client = new ToolsClient(config);
38
37
  * const input = { // UpdateToolInput
39
- * company: "STRING_VALUE",
38
+ * companyId: "STRING_VALUE",
40
39
  * toolId: "STRING_VALUE", // required
41
40
  * name: "STRING_VALUE", // required
42
41
  * category: "STRING_VALUE", // required
43
- * description: "STRING_VALUE",
42
+ * description: "STRING_VALUE", // required
44
43
  * input: { // ToolInput
45
44
  * variables: [ // ToolVariableList // required
46
45
  * { // ToolVariable
47
46
  * name: "STRING_VALUE", // required
48
47
  * type: "string" || "number" || "boolean" || "string_array" || "number_array", // required
49
- * required: true || false,
50
48
  * },
51
49
  * ],
52
50
  * },
@@ -73,9 +71,9 @@ declare const UpdateToolCommand_base: {
73
71
  * smtp: { // ToolSmtpConfig
74
72
  * host: "STRING_VALUE", // required
75
73
  * port: Number("int"), // required
76
- * username: "STRING_VALUE",
77
- * password: "STRING_VALUE",
78
- * secure: true || false,
74
+ * username: "STRING_VALUE", // required
75
+ * password: "STRING_VALUE", // required
76
+ * secure: true || false, // required
79
77
  * },
80
78
  * from: {// Union: only one key present
81
79
  * static: "STRING_VALUE",
@@ -89,53 +87,12 @@ declare const UpdateToolCommand_base: {
89
87
  * },
90
88
  * subject: "<ToolStringValue>", // required
91
89
  * text: "<ToolStringValue>", // required
92
- * html: "<ToolStringValue>",
90
+ * html: "<ToolStringValue>", // required
93
91
  * cc: "<ToolStringValue>",
94
92
  * bcc: "<ToolStringValue>",
95
93
  * replyTo: "<ToolStringValue>",
96
94
  * },
97
95
  * },
98
- * sms: { // ToolSmsHandler
99
- * serviceUri: "<ToolStringValue>", // required
100
- * recipientId: "<ToolStringValue>",
101
- * recipientNumber: "<ToolStringValue>", // required
102
- * message: "<ToolStringValue>", // required
103
- * },
104
- * chat: { // ToolChatHandler Union: only one key present
105
- * direct: { // ToolDirectMessageConfig
106
- * memberEmail: "<ToolStringValue>",
107
- * memberPhone: "<ToolStringValue>",
108
- * memberId: "<ToolStringValue>",
109
- * text: "<ToolStringValue>", // required
110
- * },
111
- * channel: { // ToolChannelMessageConfig
112
- * channelId: "<ToolStringValue>", // required
113
- * text: "<ToolStringValue>", // required
114
- * },
115
- * },
116
- * webhook: { // ToolWebhookHandler
117
- * url: "<ToolStringValue>", // required
118
- * body: "<ToolStringValue>", // required
119
- * key: "<ToolStringValue>",
120
- * secret: "<ToolStringValue>", // required
121
- * timeout: Number("int"),
122
- * },
123
- * mcp: { // ToolMcpHandler
124
- * serverUrl: "STRING_VALUE", // required
125
- * transport: "http" || "stdio" || "sse", // required
126
- * authentication: { // ToolAuthentication
127
- * type: "Bearer" || "Basic" || "ApiKey", // required
128
- * token: "STRING_VALUE", // required
129
- * },
130
- * timeout: Number("int"),
131
- * tools: [ // ToolMcpToolConfigList
132
- * { // ToolMcpToolConfig
133
- * mcpToolId: "STRING_VALUE", // required
134
- * description: "STRING_VALUE",
135
- * parameters: "DOCUMENT_VALUE",
136
- * },
137
- * ],
138
- * },
139
96
  * },
140
97
  * };
141
98
  * const command = new UpdateToolCommand(input);
@@ -146,13 +103,12 @@ declare const UpdateToolCommand_base: {
146
103
  * // company: "STRING_VALUE", // required
147
104
  * // name: "STRING_VALUE", // required
148
105
  * // category: "STRING_VALUE", // required
149
- * // description: "STRING_VALUE",
106
+ * // description: "STRING_VALUE", // required
150
107
  * // input: { // ToolInput
151
108
  * // variables: [ // ToolVariableList // required
152
109
  * // { // ToolVariable
153
110
  * // name: "STRING_VALUE", // required
154
111
  * // type: "string" || "number" || "boolean" || "string_array" || "number_array", // required
155
- * // required: true || false,
156
112
  * // },
157
113
  * // ],
158
114
  * // },
@@ -179,9 +135,9 @@ declare const UpdateToolCommand_base: {
179
135
  * // smtp: { // ToolSmtpConfig
180
136
  * // host: "STRING_VALUE", // required
181
137
  * // port: Number("int"), // required
182
- * // username: "STRING_VALUE",
183
- * // password: "STRING_VALUE",
184
- * // secure: true || false,
138
+ * // username: "STRING_VALUE", // required
139
+ * // password: "STRING_VALUE", // required
140
+ * // secure: true || false, // required
185
141
  * // },
186
142
  * // from: {// Union: only one key present
187
143
  * // static: "STRING_VALUE",
@@ -195,53 +151,12 @@ declare const UpdateToolCommand_base: {
195
151
  * // },
196
152
  * // subject: "<ToolStringValue>", // required
197
153
  * // text: "<ToolStringValue>", // required
198
- * // html: "<ToolStringValue>",
154
+ * // html: "<ToolStringValue>", // required
199
155
  * // cc: "<ToolStringValue>",
200
156
  * // bcc: "<ToolStringValue>",
201
157
  * // replyTo: "<ToolStringValue>",
202
158
  * // },
203
159
  * // },
204
- * // sms: { // ToolSmsHandler
205
- * // serviceUri: "<ToolStringValue>", // required
206
- * // recipientId: "<ToolStringValue>",
207
- * // recipientNumber: "<ToolStringValue>", // required
208
- * // message: "<ToolStringValue>", // required
209
- * // },
210
- * // chat: { // ToolChatHandler Union: only one key present
211
- * // direct: { // ToolDirectMessageConfig
212
- * // memberEmail: "<ToolStringValue>",
213
- * // memberPhone: "<ToolStringValue>",
214
- * // memberId: "<ToolStringValue>",
215
- * // text: "<ToolStringValue>", // required
216
- * // },
217
- * // channel: { // ToolChannelMessageConfig
218
- * // channelId: "<ToolStringValue>", // required
219
- * // text: "<ToolStringValue>", // required
220
- * // },
221
- * // },
222
- * // webhook: { // ToolWebhookHandler
223
- * // url: "<ToolStringValue>", // required
224
- * // body: "<ToolStringValue>", // required
225
- * // key: "<ToolStringValue>",
226
- * // secret: "<ToolStringValue>", // required
227
- * // timeout: Number("int"),
228
- * // },
229
- * // mcp: { // ToolMcpHandler
230
- * // serverUrl: "STRING_VALUE", // required
231
- * // transport: "http" || "stdio" || "sse", // required
232
- * // authentication: { // ToolAuthentication
233
- * // type: "Bearer" || "Basic" || "ApiKey", // required
234
- * // token: "STRING_VALUE", // required
235
- * // },
236
- * // timeout: Number("int"),
237
- * // tools: [ // ToolMcpToolConfigList
238
- * // { // ToolMcpToolConfig
239
- * // mcpToolId: "STRING_VALUE", // required
240
- * // description: "STRING_VALUE",
241
- * // parameters: "DOCUMENT_VALUE",
242
- * // },
243
- * // ],
244
- * // },
245
160
  * // },
246
161
  * // },
247
162
  * // };
@@ -260,12 +175,15 @@ declare const UpdateToolCommand_base: {
260
175
  *
261
176
  * @throws {@link AlreadyExistException} (client fault)
262
177
  *
263
- * @throws {@link ToolExecutionException} (server fault)
178
+ * @throws {@link ToolExecutionException} (client fault)
179
+ *
180
+ * @throws {@link ToolExecutionServerException} (server fault)
264
181
  *
265
182
  * @throws {@link ToolsServiceException}
266
183
  * <p>Base exception class for all service exceptions from Tools service.</p>
267
184
  *
268
185
  *
186
+ * @public
269
187
  */
270
188
  export declare class UpdateToolCommand extends UpdateToolCommand_base {
271
189
  /** @internal type navigation helper, not in runtime. */