@wildix/wim-tools-client 4.0.1 → 4.0.4
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 +25 -1
- package/dist-cjs/ToolsClient.js +2 -0
- package/dist-cjs/commands/CreateConnectorCommand.js +20 -0
- package/dist-cjs/commands/DeleteConnectorCommand.js +20 -0
- package/dist-cjs/commands/ExecuteConnectorCommand.js +20 -0
- package/dist-cjs/commands/GetConnectorCommand.js +20 -0
- package/dist-cjs/commands/GetConnectorDefinitionCommand.js +20 -0
- package/dist-cjs/commands/ListConnectorDefinitionsCommand.js +20 -0
- package/dist-cjs/commands/ListConnectorsCommand.js +20 -0
- package/dist-cjs/commands/ResolveConnectorConfigurationCommand.js +20 -0
- package/dist-cjs/commands/UpdateConnectorCommand.js +20 -0
- package/dist-cjs/commands/index.js +9 -0
- package/dist-cjs/index.js +1 -0
- package/dist-cjs/models/enums.js +18 -7
- package/dist-cjs/pagination/Interfaces.js +2 -0
- package/dist-cjs/pagination/ListConnectorDefinitionsPaginator.js +7 -0
- package/dist-cjs/pagination/ListConnectorsPaginator.js +7 -0
- package/dist-cjs/pagination/index.js +6 -0
- package/dist-cjs/runtimeConfig.shared.js +10 -0
- package/dist-cjs/schemas/schemas_0.js +340 -57
- package/dist-es/Tools.js +25 -1
- package/dist-es/ToolsClient.js +2 -0
- package/dist-es/commands/CreateConnectorCommand.js +16 -0
- package/dist-es/commands/DeleteConnectorCommand.js +16 -0
- package/dist-es/commands/ExecuteConnectorCommand.js +16 -0
- package/dist-es/commands/GetConnectorCommand.js +16 -0
- package/dist-es/commands/GetConnectorDefinitionCommand.js +16 -0
- package/dist-es/commands/ListConnectorDefinitionsCommand.js +16 -0
- package/dist-es/commands/ListConnectorsCommand.js +16 -0
- package/dist-es/commands/ResolveConnectorConfigurationCommand.js +16 -0
- package/dist-es/commands/UpdateConnectorCommand.js +16 -0
- package/dist-es/commands/index.js +9 -0
- package/dist-es/index.js +1 -0
- package/dist-es/models/enums.js +17 -6
- package/dist-es/pagination/Interfaces.js +1 -0
- package/dist-es/pagination/ListConnectorDefinitionsPaginator.js +4 -0
- package/dist-es/pagination/ListConnectorsPaginator.js +4 -0
- package/dist-es/pagination/index.js +3 -0
- package/dist-es/runtimeConfig.shared.js +10 -0
- package/dist-es/schemas/schemas_0.js +338 -55
- package/dist-types/Tools.d.ts +80 -1
- package/dist-types/ToolsClient.d.ts +11 -2
- package/dist-types/commands/CreateConnectorCommand.d.ts +123 -0
- package/dist-types/commands/CreateToolCommand.d.ts +43 -3
- package/dist-types/commands/DeleteConnectorCommand.d.ts +87 -0
- package/dist-types/commands/DeleteToolCommand.d.ts +1 -3
- package/dist-types/commands/DescribeToolsCommand.d.ts +5 -3
- package/dist-types/commands/DiscoverToolsCommand.d.ts +1 -3
- package/dist-types/commands/ExecuteConnectorCommand.d.ts +96 -0
- package/dist-types/commands/ExecuteToolCommand.d.ts +1 -3
- package/dist-types/commands/GetConnectorCommand.d.ts +108 -0
- package/dist-types/commands/GetConnectorDefinitionCommand.d.ts +152 -0
- package/dist-types/commands/GetToolCommand.d.ts +22 -3
- package/dist-types/commands/ListConnectorDefinitionsCommand.d.ts +156 -0
- package/dist-types/commands/ListConnectorsCommand.d.ts +112 -0
- package/dist-types/commands/ListToolsCommand.d.ts +22 -3
- package/dist-types/commands/ResolveConnectorConfigurationCommand.d.ts +102 -0
- package/dist-types/commands/UpdateConnectorCommand.d.ts +124 -0
- package/dist-types/commands/UpdateToolCommand.d.ts +43 -3
- package/dist-types/commands/index.d.ts +9 -0
- package/dist-types/index.d.ts +1 -0
- package/dist-types/models/enums.d.ts +40 -7
- package/dist-types/models/models_0.d.ts +816 -50
- package/dist-types/pagination/Interfaces.d.ts +8 -0
- package/dist-types/pagination/ListConnectorDefinitionsPaginator.d.ts +7 -0
- package/dist-types/pagination/ListConnectorsPaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +3 -0
- package/dist-types/runtimeConfig.browser.d.ts +1 -0
- package/dist-types/runtimeConfig.d.ts +1 -0
- package/dist-types/runtimeConfig.native.d.ts +1 -0
- package/dist-types/schemas/schemas_0.d.ts +41 -0
- package/package.json +1 -1
|
@@ -0,0 +1,108 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/core/client";
|
|
2
|
+
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import type { GetConnectorInput, GetConnectorOutput } from "../models/models_0";
|
|
4
|
+
import type { ServiceInputTypes, ServiceOutputTypes, ToolsClientResolvedConfig } from "../ToolsClient";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link GetConnectorCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface GetConnectorCommandInput extends GetConnectorInput {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link GetConnectorCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface GetConnectorCommandOutput extends GetConnectorOutput, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const GetConnectorCommand_base: {
|
|
25
|
+
new (input: GetConnectorCommandInput): import("@smithy/core/client").CommandImpl<GetConnectorCommandInput, GetConnectorCommandOutput, ToolsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (input: GetConnectorCommandInput): import("@smithy/core/client").CommandImpl<GetConnectorCommandInput, GetConnectorCommandOutput, ToolsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* Gets a configured connector.
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { ToolsClient, GetConnectorCommand } from "@wildix/wim-tools-client"; // ES Modules import
|
|
35
|
+
* // const { ToolsClient, GetConnectorCommand } = require("@wildix/wim-tools-client"); // CommonJS import
|
|
36
|
+
* // import type { ToolsClientConfig } from "@wildix/wim-tools-client";
|
|
37
|
+
* const config = {}; // type is ToolsClientConfig
|
|
38
|
+
* const client = new ToolsClient(config);
|
|
39
|
+
* const input = { // GetConnectorInput
|
|
40
|
+
* companyId: "STRING_VALUE",
|
|
41
|
+
* connectorId: "STRING_VALUE", // required
|
|
42
|
+
* };
|
|
43
|
+
* const command = new GetConnectorCommand(input);
|
|
44
|
+
* const response = await client.send(command);
|
|
45
|
+
* // { // GetConnectorOutput
|
|
46
|
+
* // connector: { // Connector
|
|
47
|
+
* // definition: { // ConnectorDefinitionRef
|
|
48
|
+
* // key: "STRING_VALUE", // required
|
|
49
|
+
* // version: "STRING_VALUE", // required
|
|
50
|
+
* // },
|
|
51
|
+
* // configuration: "DOCUMENT_VALUE", // required
|
|
52
|
+
* // authorization: { // ConnectorAuthorization Union: only one key present
|
|
53
|
+
* // shared: { // ConnectorSharedAuthorization
|
|
54
|
+
* // connectionId: "STRING_VALUE", // required
|
|
55
|
+
* // },
|
|
56
|
+
* // user: {},
|
|
57
|
+
* // },
|
|
58
|
+
* // name: "STRING_VALUE", // required
|
|
59
|
+
* // description: "STRING_VALUE", // required
|
|
60
|
+
* // enabledTools: [ // ConnectorEnabledTools // required
|
|
61
|
+
* // "STRING_VALUE",
|
|
62
|
+
* // ],
|
|
63
|
+
* // id: "STRING_VALUE", // required
|
|
64
|
+
* // companyId: "STRING_VALUE", // required
|
|
65
|
+
* // },
|
|
66
|
+
* // };
|
|
67
|
+
*
|
|
68
|
+
* ```
|
|
69
|
+
*
|
|
70
|
+
* @param GetConnectorCommandInput - {@link GetConnectorCommandInput}
|
|
71
|
+
* @returns {@link GetConnectorCommandOutput}
|
|
72
|
+
* @see {@link GetConnectorCommandInput} for command's `input` shape.
|
|
73
|
+
* @see {@link GetConnectorCommandOutput} for command's `response` shape.
|
|
74
|
+
* @see {@link ToolsClientResolvedConfig | config} for ToolsClient's `config` shape.
|
|
75
|
+
*
|
|
76
|
+
* @throws {@link ValidationException} (client fault)
|
|
77
|
+
*
|
|
78
|
+
* @throws {@link NotFoundException} (client fault)
|
|
79
|
+
*
|
|
80
|
+
* @throws {@link UnauthorizedException} (client fault)
|
|
81
|
+
*
|
|
82
|
+
* @throws {@link ForbiddenException} (client fault)
|
|
83
|
+
*
|
|
84
|
+
* @throws {@link AlreadyExistException} (client fault)
|
|
85
|
+
*
|
|
86
|
+
* @throws {@link ToolExecutionException} (client fault)
|
|
87
|
+
*
|
|
88
|
+
* @throws {@link ToolExecutionServerException} (server fault)
|
|
89
|
+
*
|
|
90
|
+
* @throws {@link ToolsServiceException}
|
|
91
|
+
* <p>Base exception class for all service exceptions from Tools service.</p>
|
|
92
|
+
*
|
|
93
|
+
*
|
|
94
|
+
* @public
|
|
95
|
+
*/
|
|
96
|
+
export declare class GetConnectorCommand extends GetConnectorCommand_base {
|
|
97
|
+
/** @internal type navigation helper, not in runtime. */
|
|
98
|
+
protected static __types: {
|
|
99
|
+
api: {
|
|
100
|
+
input: GetConnectorInput;
|
|
101
|
+
output: GetConnectorOutput;
|
|
102
|
+
};
|
|
103
|
+
sdk: {
|
|
104
|
+
input: GetConnectorCommandInput;
|
|
105
|
+
output: GetConnectorCommandOutput;
|
|
106
|
+
};
|
|
107
|
+
};
|
|
108
|
+
}
|
|
@@ -0,0 +1,152 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/core/client";
|
|
2
|
+
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import type { GetConnectorDefinitionInput, GetConnectorDefinitionOutput } from "../models/models_0";
|
|
4
|
+
import type { ServiceInputTypes, ServiceOutputTypes, ToolsClientResolvedConfig } from "../ToolsClient";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link GetConnectorDefinitionCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface GetConnectorDefinitionCommandInput extends GetConnectorDefinitionInput {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link GetConnectorDefinitionCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface GetConnectorDefinitionCommandOutput extends GetConnectorDefinitionOutput, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const GetConnectorDefinitionCommand_base: {
|
|
25
|
+
new (input: GetConnectorDefinitionCommandInput): import("@smithy/core/client").CommandImpl<GetConnectorDefinitionCommandInput, GetConnectorDefinitionCommandOutput, ToolsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (input: GetConnectorDefinitionCommandInput): import("@smithy/core/client").CommandImpl<GetConnectorDefinitionCommandInput, GetConnectorDefinitionCommandOutput, ToolsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* Gets one immutable connector definition.
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { ToolsClient, GetConnectorDefinitionCommand } from "@wildix/wim-tools-client"; // ES Modules import
|
|
35
|
+
* // const { ToolsClient, GetConnectorDefinitionCommand } = require("@wildix/wim-tools-client"); // CommonJS import
|
|
36
|
+
* // import type { ToolsClientConfig } from "@wildix/wim-tools-client";
|
|
37
|
+
* const config = {}; // type is ToolsClientConfig
|
|
38
|
+
* const client = new ToolsClient(config);
|
|
39
|
+
* const input = { // GetConnectorDefinitionInput
|
|
40
|
+
* companyId: "STRING_VALUE",
|
|
41
|
+
* key: "STRING_VALUE", // required
|
|
42
|
+
* version: "STRING_VALUE", // required
|
|
43
|
+
* };
|
|
44
|
+
* const command = new GetConnectorDefinitionCommand(input);
|
|
45
|
+
* const response = await client.send(command);
|
|
46
|
+
* // { // GetConnectorDefinitionOutput
|
|
47
|
+
* // definition: { // ConnectorDefinition
|
|
48
|
+
* // ref: { // ConnectorDefinitionRef
|
|
49
|
+
* // key: "STRING_VALUE", // required
|
|
50
|
+
* // version: "STRING_VALUE", // required
|
|
51
|
+
* // },
|
|
52
|
+
* // metadata: { // ConnectorMetadata
|
|
53
|
+
* // title: "STRING_VALUE", // required
|
|
54
|
+
* // description: "STRING_VALUE", // required
|
|
55
|
+
* // icon: "STRING_VALUE",
|
|
56
|
+
* // category: "STRING_VALUE",
|
|
57
|
+
* // documentationUrl: "STRING_VALUE",
|
|
58
|
+
* // },
|
|
59
|
+
* // configuration: { // ConnectorConfigurationDefinition
|
|
60
|
+
* // schema: "DOCUMENT_VALUE", // required
|
|
61
|
+
* // uiSchema: "DOCUMENT_VALUE",
|
|
62
|
+
* // initialValues: "DOCUMENT_VALUE",
|
|
63
|
+
* // },
|
|
64
|
+
* // authorization: { // ConnectorAuthorizationDefinition
|
|
65
|
+
* // provider: "STRING_VALUE", // required
|
|
66
|
+
* // modes: [ // ConnectorAuthorizationModes // required
|
|
67
|
+
* // "shared" || "user",
|
|
68
|
+
* // ],
|
|
69
|
+
* // scopes: [ // ConnectorAuthorizationScopes
|
|
70
|
+
* // "STRING_VALUE",
|
|
71
|
+
* // ],
|
|
72
|
+
* // },
|
|
73
|
+
* // tools: [ // ConnectorTools // required
|
|
74
|
+
* // { // ConnectorTool
|
|
75
|
+
* // id: "STRING_VALUE", // required
|
|
76
|
+
* // name: "STRING_VALUE", // required
|
|
77
|
+
* // description: "STRING_VALUE", // required
|
|
78
|
+
* // input: { // ToolInput
|
|
79
|
+
* // variables: [ // ToolVariableList // required
|
|
80
|
+
* // { // ToolVariable
|
|
81
|
+
* // name: "STRING_VALUE", // required
|
|
82
|
+
* // type: "string" || "number" || "boolean" || "string_array" || "number_array" || "schema", // required
|
|
83
|
+
* // optional: true || false, // required
|
|
84
|
+
* // description: "STRING_VALUE",
|
|
85
|
+
* // enum: [ // ToolVariableEnumValues
|
|
86
|
+
* // "STRING_VALUE",
|
|
87
|
+
* // ],
|
|
88
|
+
* // format: "STRING_VALUE",
|
|
89
|
+
* // schema: "DOCUMENT_VALUE",
|
|
90
|
+
* // },
|
|
91
|
+
* // ],
|
|
92
|
+
* // },
|
|
93
|
+
* // authorizationScopes: [
|
|
94
|
+
* // "STRING_VALUE",
|
|
95
|
+
* // ],
|
|
96
|
+
* // annotations: { // ConnectorToolAnnotations
|
|
97
|
+
* // readOnlyHint: true || false,
|
|
98
|
+
* // destructiveHint: true || false,
|
|
99
|
+
* // idempotentHint: true || false,
|
|
100
|
+
* // openWorldHint: true || false,
|
|
101
|
+
* // },
|
|
102
|
+
* // },
|
|
103
|
+
* // ],
|
|
104
|
+
* // deprecated: true || false,
|
|
105
|
+
* // replacedBy: {
|
|
106
|
+
* // key: "STRING_VALUE", // required
|
|
107
|
+
* // version: "STRING_VALUE", // required
|
|
108
|
+
* // },
|
|
109
|
+
* // },
|
|
110
|
+
* // };
|
|
111
|
+
*
|
|
112
|
+
* ```
|
|
113
|
+
*
|
|
114
|
+
* @param GetConnectorDefinitionCommandInput - {@link GetConnectorDefinitionCommandInput}
|
|
115
|
+
* @returns {@link GetConnectorDefinitionCommandOutput}
|
|
116
|
+
* @see {@link GetConnectorDefinitionCommandInput} for command's `input` shape.
|
|
117
|
+
* @see {@link GetConnectorDefinitionCommandOutput} for command's `response` shape.
|
|
118
|
+
* @see {@link ToolsClientResolvedConfig | config} for ToolsClient's `config` shape.
|
|
119
|
+
*
|
|
120
|
+
* @throws {@link ValidationException} (client fault)
|
|
121
|
+
*
|
|
122
|
+
* @throws {@link NotFoundException} (client fault)
|
|
123
|
+
*
|
|
124
|
+
* @throws {@link UnauthorizedException} (client fault)
|
|
125
|
+
*
|
|
126
|
+
* @throws {@link ForbiddenException} (client fault)
|
|
127
|
+
*
|
|
128
|
+
* @throws {@link AlreadyExistException} (client fault)
|
|
129
|
+
*
|
|
130
|
+
* @throws {@link ToolExecutionException} (client fault)
|
|
131
|
+
*
|
|
132
|
+
* @throws {@link ToolExecutionServerException} (server fault)
|
|
133
|
+
*
|
|
134
|
+
* @throws {@link ToolsServiceException}
|
|
135
|
+
* <p>Base exception class for all service exceptions from Tools service.</p>
|
|
136
|
+
*
|
|
137
|
+
*
|
|
138
|
+
* @public
|
|
139
|
+
*/
|
|
140
|
+
export declare class GetConnectorDefinitionCommand extends GetConnectorDefinitionCommand_base {
|
|
141
|
+
/** @internal type navigation helper, not in runtime. */
|
|
142
|
+
protected static __types: {
|
|
143
|
+
api: {
|
|
144
|
+
input: GetConnectorDefinitionInput;
|
|
145
|
+
output: GetConnectorDefinitionOutput;
|
|
146
|
+
};
|
|
147
|
+
sdk: {
|
|
148
|
+
input: GetConnectorDefinitionCommandInput;
|
|
149
|
+
output: GetConnectorDefinitionCommandOutput;
|
|
150
|
+
};
|
|
151
|
+
};
|
|
152
|
+
}
|
|
@@ -24,9 +24,7 @@ export interface GetToolCommandOutput extends GetToolOutput, __MetadataBearer {
|
|
|
24
24
|
declare const GetToolCommand_base: {
|
|
25
25
|
new (input: GetToolCommandInput): import("@smithy/core/client").CommandImpl<GetToolCommandInput, GetToolCommandOutput, ToolsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
26
|
new (input: GetToolCommandInput): import("@smithy/core/client").CommandImpl<GetToolCommandInput, GetToolCommandOutput, ToolsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
-
getEndpointParameterInstructions():
|
|
28
|
-
[x: string]: unknown;
|
|
29
|
-
};
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
|
|
30
28
|
};
|
|
31
29
|
/**
|
|
32
30
|
* Get a tool by its ID.
|
|
@@ -58,6 +56,10 @@ declare const GetToolCommand_base: {
|
|
|
58
56
|
* // type: "string" || "number" || "boolean" || "string_array" || "number_array" || "schema", // required
|
|
59
57
|
* // optional: true || false, // required
|
|
60
58
|
* // description: "STRING_VALUE",
|
|
59
|
+
* // enum: [ // ToolVariableEnumValues
|
|
60
|
+
* // "STRING_VALUE",
|
|
61
|
+
* // ],
|
|
62
|
+
* // format: "STRING_VALUE",
|
|
61
63
|
* // schema: "DOCUMENT_VALUE",
|
|
62
64
|
* // },
|
|
63
65
|
* // ],
|
|
@@ -139,6 +141,23 @@ declare const GetToolCommand_base: {
|
|
|
139
141
|
* // message: "STRING_VALUE", // required
|
|
140
142
|
* // },
|
|
141
143
|
* // },
|
|
144
|
+
* // calendar: { // ToolCalendarConfig
|
|
145
|
+
* // operation: "get_slots" || "schedule" || "reschedule" || "cancel" || "list_resource_events", // required
|
|
146
|
+
* // },
|
|
147
|
+
* // connector: { // ToolConnectorHandler
|
|
148
|
+
* // definition: { // ConnectorDefinitionRef
|
|
149
|
+
* // key: "STRING_VALUE", // required
|
|
150
|
+
* // version: "STRING_VALUE", // required
|
|
151
|
+
* // },
|
|
152
|
+
* // configuration: "DOCUMENT_VALUE", // required
|
|
153
|
+
* // authorization: { // ConnectorAuthorization Union: only one key present
|
|
154
|
+
* // shared: { // ConnectorSharedAuthorization
|
|
155
|
+
* // connectionId: "STRING_VALUE", // required
|
|
156
|
+
* // },
|
|
157
|
+
* // user: {},
|
|
158
|
+
* // },
|
|
159
|
+
* // toolId: "STRING_VALUE", // required
|
|
160
|
+
* // },
|
|
142
161
|
* // mcp: { // ToolMcpHandler
|
|
143
162
|
* // serverUrl: "STRING_VALUE", // required
|
|
144
163
|
* // authorization: { // ToolMcpAuthorization Union: only one key present
|
|
@@ -0,0 +1,156 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/core/client";
|
|
2
|
+
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import type { ListConnectorDefinitionsInput, ListConnectorDefinitionsOutput } from "../models/models_0";
|
|
4
|
+
import type { ServiceInputTypes, ServiceOutputTypes, ToolsClientResolvedConfig } from "../ToolsClient";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link ListConnectorDefinitionsCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface ListConnectorDefinitionsCommandInput extends ListConnectorDefinitionsInput {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link ListConnectorDefinitionsCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface ListConnectorDefinitionsCommandOutput extends ListConnectorDefinitionsOutput, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const ListConnectorDefinitionsCommand_base: {
|
|
25
|
+
new (input: ListConnectorDefinitionsCommandInput): import("@smithy/core/client").CommandImpl<ListConnectorDefinitionsCommandInput, ListConnectorDefinitionsCommandOutput, ToolsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (...[input]: [] | [ListConnectorDefinitionsCommandInput]): import("@smithy/core/client").CommandImpl<ListConnectorDefinitionsCommandInput, ListConnectorDefinitionsCommandOutput, ToolsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* Lists immutable connector definitions available from the server catalog.
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { ToolsClient, ListConnectorDefinitionsCommand } from "@wildix/wim-tools-client"; // ES Modules import
|
|
35
|
+
* // const { ToolsClient, ListConnectorDefinitionsCommand } = require("@wildix/wim-tools-client"); // CommonJS import
|
|
36
|
+
* // import type { ToolsClientConfig } from "@wildix/wim-tools-client";
|
|
37
|
+
* const config = {}; // type is ToolsClientConfig
|
|
38
|
+
* const client = new ToolsClient(config);
|
|
39
|
+
* const input = { // ListConnectorDefinitionsInput
|
|
40
|
+
* companyId: "STRING_VALUE",
|
|
41
|
+
* query: "STRING_VALUE",
|
|
42
|
+
* pageSize: Number("int"),
|
|
43
|
+
* nextToken: "STRING_VALUE",
|
|
44
|
+
* };
|
|
45
|
+
* const command = new ListConnectorDefinitionsCommand(input);
|
|
46
|
+
* const response = await client.send(command);
|
|
47
|
+
* // { // ListConnectorDefinitionsOutput
|
|
48
|
+
* // definitions: [ // ConnectorDefinitions // required
|
|
49
|
+
* // { // ConnectorDefinition
|
|
50
|
+
* // ref: { // ConnectorDefinitionRef
|
|
51
|
+
* // key: "STRING_VALUE", // required
|
|
52
|
+
* // version: "STRING_VALUE", // required
|
|
53
|
+
* // },
|
|
54
|
+
* // metadata: { // ConnectorMetadata
|
|
55
|
+
* // title: "STRING_VALUE", // required
|
|
56
|
+
* // description: "STRING_VALUE", // required
|
|
57
|
+
* // icon: "STRING_VALUE",
|
|
58
|
+
* // category: "STRING_VALUE",
|
|
59
|
+
* // documentationUrl: "STRING_VALUE",
|
|
60
|
+
* // },
|
|
61
|
+
* // configuration: { // ConnectorConfigurationDefinition
|
|
62
|
+
* // schema: "DOCUMENT_VALUE", // required
|
|
63
|
+
* // uiSchema: "DOCUMENT_VALUE",
|
|
64
|
+
* // initialValues: "DOCUMENT_VALUE",
|
|
65
|
+
* // },
|
|
66
|
+
* // authorization: { // ConnectorAuthorizationDefinition
|
|
67
|
+
* // provider: "STRING_VALUE", // required
|
|
68
|
+
* // modes: [ // ConnectorAuthorizationModes // required
|
|
69
|
+
* // "shared" || "user",
|
|
70
|
+
* // ],
|
|
71
|
+
* // scopes: [ // ConnectorAuthorizationScopes
|
|
72
|
+
* // "STRING_VALUE",
|
|
73
|
+
* // ],
|
|
74
|
+
* // },
|
|
75
|
+
* // tools: [ // ConnectorTools // required
|
|
76
|
+
* // { // ConnectorTool
|
|
77
|
+
* // id: "STRING_VALUE", // required
|
|
78
|
+
* // name: "STRING_VALUE", // required
|
|
79
|
+
* // description: "STRING_VALUE", // required
|
|
80
|
+
* // input: { // ToolInput
|
|
81
|
+
* // variables: [ // ToolVariableList // required
|
|
82
|
+
* // { // ToolVariable
|
|
83
|
+
* // name: "STRING_VALUE", // required
|
|
84
|
+
* // type: "string" || "number" || "boolean" || "string_array" || "number_array" || "schema", // required
|
|
85
|
+
* // optional: true || false, // required
|
|
86
|
+
* // description: "STRING_VALUE",
|
|
87
|
+
* // enum: [ // ToolVariableEnumValues
|
|
88
|
+
* // "STRING_VALUE",
|
|
89
|
+
* // ],
|
|
90
|
+
* // format: "STRING_VALUE",
|
|
91
|
+
* // schema: "DOCUMENT_VALUE",
|
|
92
|
+
* // },
|
|
93
|
+
* // ],
|
|
94
|
+
* // },
|
|
95
|
+
* // authorizationScopes: [
|
|
96
|
+
* // "STRING_VALUE",
|
|
97
|
+
* // ],
|
|
98
|
+
* // annotations: { // ConnectorToolAnnotations
|
|
99
|
+
* // readOnlyHint: true || false,
|
|
100
|
+
* // destructiveHint: true || false,
|
|
101
|
+
* // idempotentHint: true || false,
|
|
102
|
+
* // openWorldHint: true || false,
|
|
103
|
+
* // },
|
|
104
|
+
* // },
|
|
105
|
+
* // ],
|
|
106
|
+
* // deprecated: true || false,
|
|
107
|
+
* // replacedBy: {
|
|
108
|
+
* // key: "STRING_VALUE", // required
|
|
109
|
+
* // version: "STRING_VALUE", // required
|
|
110
|
+
* // },
|
|
111
|
+
* // },
|
|
112
|
+
* // ],
|
|
113
|
+
* // nextToken: "STRING_VALUE",
|
|
114
|
+
* // };
|
|
115
|
+
*
|
|
116
|
+
* ```
|
|
117
|
+
*
|
|
118
|
+
* @param ListConnectorDefinitionsCommandInput - {@link ListConnectorDefinitionsCommandInput}
|
|
119
|
+
* @returns {@link ListConnectorDefinitionsCommandOutput}
|
|
120
|
+
* @see {@link ListConnectorDefinitionsCommandInput} for command's `input` shape.
|
|
121
|
+
* @see {@link ListConnectorDefinitionsCommandOutput} for command's `response` shape.
|
|
122
|
+
* @see {@link ToolsClientResolvedConfig | config} for ToolsClient's `config` shape.
|
|
123
|
+
*
|
|
124
|
+
* @throws {@link ValidationException} (client fault)
|
|
125
|
+
*
|
|
126
|
+
* @throws {@link UnauthorizedException} (client fault)
|
|
127
|
+
*
|
|
128
|
+
* @throws {@link ForbiddenException} (client fault)
|
|
129
|
+
*
|
|
130
|
+
* @throws {@link NotFoundException} (client fault)
|
|
131
|
+
*
|
|
132
|
+
* @throws {@link AlreadyExistException} (client fault)
|
|
133
|
+
*
|
|
134
|
+
* @throws {@link ToolExecutionException} (client fault)
|
|
135
|
+
*
|
|
136
|
+
* @throws {@link ToolExecutionServerException} (server fault)
|
|
137
|
+
*
|
|
138
|
+
* @throws {@link ToolsServiceException}
|
|
139
|
+
* <p>Base exception class for all service exceptions from Tools service.</p>
|
|
140
|
+
*
|
|
141
|
+
*
|
|
142
|
+
* @public
|
|
143
|
+
*/
|
|
144
|
+
export declare class ListConnectorDefinitionsCommand extends ListConnectorDefinitionsCommand_base {
|
|
145
|
+
/** @internal type navigation helper, not in runtime. */
|
|
146
|
+
protected static __types: {
|
|
147
|
+
api: {
|
|
148
|
+
input: ListConnectorDefinitionsInput;
|
|
149
|
+
output: ListConnectorDefinitionsOutput;
|
|
150
|
+
};
|
|
151
|
+
sdk: {
|
|
152
|
+
input: ListConnectorDefinitionsCommandInput;
|
|
153
|
+
output: ListConnectorDefinitionsCommandOutput;
|
|
154
|
+
};
|
|
155
|
+
};
|
|
156
|
+
}
|
|
@@ -0,0 +1,112 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/core/client";
|
|
2
|
+
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import type { ListConnectorsInput, ListConnectorsOutput } from "../models/models_0";
|
|
4
|
+
import type { ServiceInputTypes, ServiceOutputTypes, ToolsClientResolvedConfig } from "../ToolsClient";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link ListConnectorsCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface ListConnectorsCommandInput extends ListConnectorsInput {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link ListConnectorsCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface ListConnectorsCommandOutput extends ListConnectorsOutput, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const ListConnectorsCommand_base: {
|
|
25
|
+
new (input: ListConnectorsCommandInput): import("@smithy/core/client").CommandImpl<ListConnectorsCommandInput, ListConnectorsCommandOutput, ToolsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (...[input]: [] | [ListConnectorsCommandInput]): import("@smithy/core/client").CommandImpl<ListConnectorsCommandInput, ListConnectorsCommandOutput, ToolsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* Lists configured connectors owned by the current company.
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { ToolsClient, ListConnectorsCommand } from "@wildix/wim-tools-client"; // ES Modules import
|
|
35
|
+
* // const { ToolsClient, ListConnectorsCommand } = require("@wildix/wim-tools-client"); // CommonJS import
|
|
36
|
+
* // import type { ToolsClientConfig } from "@wildix/wim-tools-client";
|
|
37
|
+
* const config = {}; // type is ToolsClientConfig
|
|
38
|
+
* const client = new ToolsClient(config);
|
|
39
|
+
* const input = { // ListConnectorsInput
|
|
40
|
+
* companyId: "STRING_VALUE",
|
|
41
|
+
* pageSize: Number("int"),
|
|
42
|
+
* nextToken: "STRING_VALUE",
|
|
43
|
+
* };
|
|
44
|
+
* const command = new ListConnectorsCommand(input);
|
|
45
|
+
* const response = await client.send(command);
|
|
46
|
+
* // { // ListConnectorsOutput
|
|
47
|
+
* // connectors: [ // Connectors // required
|
|
48
|
+
* // { // Connector
|
|
49
|
+
* // definition: { // ConnectorDefinitionRef
|
|
50
|
+
* // key: "STRING_VALUE", // required
|
|
51
|
+
* // version: "STRING_VALUE", // required
|
|
52
|
+
* // },
|
|
53
|
+
* // configuration: "DOCUMENT_VALUE", // required
|
|
54
|
+
* // authorization: { // ConnectorAuthorization Union: only one key present
|
|
55
|
+
* // shared: { // ConnectorSharedAuthorization
|
|
56
|
+
* // connectionId: "STRING_VALUE", // required
|
|
57
|
+
* // },
|
|
58
|
+
* // user: {},
|
|
59
|
+
* // },
|
|
60
|
+
* // name: "STRING_VALUE", // required
|
|
61
|
+
* // description: "STRING_VALUE", // required
|
|
62
|
+
* // enabledTools: [ // ConnectorEnabledTools // required
|
|
63
|
+
* // "STRING_VALUE",
|
|
64
|
+
* // ],
|
|
65
|
+
* // id: "STRING_VALUE", // required
|
|
66
|
+
* // companyId: "STRING_VALUE", // required
|
|
67
|
+
* // },
|
|
68
|
+
* // ],
|
|
69
|
+
* // nextToken: "STRING_VALUE",
|
|
70
|
+
* // };
|
|
71
|
+
*
|
|
72
|
+
* ```
|
|
73
|
+
*
|
|
74
|
+
* @param ListConnectorsCommandInput - {@link ListConnectorsCommandInput}
|
|
75
|
+
* @returns {@link ListConnectorsCommandOutput}
|
|
76
|
+
* @see {@link ListConnectorsCommandInput} for command's `input` shape.
|
|
77
|
+
* @see {@link ListConnectorsCommandOutput} for command's `response` shape.
|
|
78
|
+
* @see {@link ToolsClientResolvedConfig | config} for ToolsClient's `config` shape.
|
|
79
|
+
*
|
|
80
|
+
* @throws {@link ValidationException} (client fault)
|
|
81
|
+
*
|
|
82
|
+
* @throws {@link UnauthorizedException} (client fault)
|
|
83
|
+
*
|
|
84
|
+
* @throws {@link ForbiddenException} (client fault)
|
|
85
|
+
*
|
|
86
|
+
* @throws {@link NotFoundException} (client fault)
|
|
87
|
+
*
|
|
88
|
+
* @throws {@link AlreadyExistException} (client fault)
|
|
89
|
+
*
|
|
90
|
+
* @throws {@link ToolExecutionException} (client fault)
|
|
91
|
+
*
|
|
92
|
+
* @throws {@link ToolExecutionServerException} (server fault)
|
|
93
|
+
*
|
|
94
|
+
* @throws {@link ToolsServiceException}
|
|
95
|
+
* <p>Base exception class for all service exceptions from Tools service.</p>
|
|
96
|
+
*
|
|
97
|
+
*
|
|
98
|
+
* @public
|
|
99
|
+
*/
|
|
100
|
+
export declare class ListConnectorsCommand extends ListConnectorsCommand_base {
|
|
101
|
+
/** @internal type navigation helper, not in runtime. */
|
|
102
|
+
protected static __types: {
|
|
103
|
+
api: {
|
|
104
|
+
input: ListConnectorsInput;
|
|
105
|
+
output: ListConnectorsOutput;
|
|
106
|
+
};
|
|
107
|
+
sdk: {
|
|
108
|
+
input: ListConnectorsCommandInput;
|
|
109
|
+
output: ListConnectorsCommandOutput;
|
|
110
|
+
};
|
|
111
|
+
};
|
|
112
|
+
}
|
|
@@ -24,9 +24,7 @@ export interface ListToolsCommandOutput extends ListToolsOutput, __MetadataBeare
|
|
|
24
24
|
declare const ListToolsCommand_base: {
|
|
25
25
|
new (input: ListToolsCommandInput): import("@smithy/core/client").CommandImpl<ListToolsCommandInput, ListToolsCommandOutput, ToolsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
26
|
new (...[input]: [] | [ListToolsCommandInput]): import("@smithy/core/client").CommandImpl<ListToolsCommandInput, ListToolsCommandOutput, ToolsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
-
getEndpointParameterInstructions():
|
|
28
|
-
[x: string]: unknown;
|
|
29
|
-
};
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
|
|
30
28
|
};
|
|
31
29
|
/**
|
|
32
30
|
* List all tools for the current company.
|
|
@@ -58,6 +56,10 @@ declare const ListToolsCommand_base: {
|
|
|
58
56
|
* // type: "string" || "number" || "boolean" || "string_array" || "number_array" || "schema", // required
|
|
59
57
|
* // optional: true || false, // required
|
|
60
58
|
* // description: "STRING_VALUE",
|
|
59
|
+
* // enum: [ // ToolVariableEnumValues
|
|
60
|
+
* // "STRING_VALUE",
|
|
61
|
+
* // ],
|
|
62
|
+
* // format: "STRING_VALUE",
|
|
61
63
|
* // schema: "DOCUMENT_VALUE",
|
|
62
64
|
* // },
|
|
63
65
|
* // ],
|
|
@@ -139,6 +141,23 @@ declare const ListToolsCommand_base: {
|
|
|
139
141
|
* // message: "STRING_VALUE", // required
|
|
140
142
|
* // },
|
|
141
143
|
* // },
|
|
144
|
+
* // calendar: { // ToolCalendarConfig
|
|
145
|
+
* // operation: "get_slots" || "schedule" || "reschedule" || "cancel" || "list_resource_events", // required
|
|
146
|
+
* // },
|
|
147
|
+
* // connector: { // ToolConnectorHandler
|
|
148
|
+
* // definition: { // ConnectorDefinitionRef
|
|
149
|
+
* // key: "STRING_VALUE", // required
|
|
150
|
+
* // version: "STRING_VALUE", // required
|
|
151
|
+
* // },
|
|
152
|
+
* // configuration: "DOCUMENT_VALUE", // required
|
|
153
|
+
* // authorization: { // ConnectorAuthorization Union: only one key present
|
|
154
|
+
* // shared: { // ConnectorSharedAuthorization
|
|
155
|
+
* // connectionId: "STRING_VALUE", // required
|
|
156
|
+
* // },
|
|
157
|
+
* // user: {},
|
|
158
|
+
* // },
|
|
159
|
+
* // toolId: "STRING_VALUE", // required
|
|
160
|
+
* // },
|
|
142
161
|
* // mcp: { // ToolMcpHandler
|
|
143
162
|
* // serverUrl: "STRING_VALUE", // required
|
|
144
163
|
* // authorization: { // ToolMcpAuthorization Union: only one key present
|