@wildix/wim-tools-client 4.0.2 → 4.0.5
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 +27 -1
- package/dist-cjs/commands/CreateConnectorCommand.js +20 -0
- package/dist-cjs/commands/CreateConnectorSessionCommand.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 +10 -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/schemas/schemas_0.js +360 -57
- package/dist-es/Tools.js +27 -1
- package/dist-es/commands/CreateConnectorCommand.js +16 -0
- package/dist-es/commands/CreateConnectorSessionCommand.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 +10 -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/schemas/schemas_0.js +357 -55
- package/dist-types/Tools.d.ts +87 -1
- package/dist-types/ToolsClient.d.ts +12 -2
- package/dist-types/commands/CreateConnectorCommand.d.ts +123 -0
- package/dist-types/commands/CreateConnectorSessionCommand.d.ts +95 -0
- package/dist-types/commands/CreateToolCommand.d.ts +42 -0
- package/dist-types/commands/DeleteConnectorCommand.d.ts +87 -0
- package/dist-types/commands/DescribeToolsCommand.d.ts +4 -0
- package/dist-types/commands/ExecuteConnectorCommand.d.ts +96 -0
- 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 +21 -0
- 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 +21 -0
- 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 +42 -0
- package/dist-types/commands/index.d.ts +10 -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 +861 -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/schemas/schemas_0.d.ts +44 -0
- package/package.json +1 -1
|
@@ -1,5 +1,487 @@
|
|
|
1
1
|
import type { DocumentType as __DocumentType } from "@smithy/types";
|
|
2
|
-
import type { ToolVariableType, ToolWebhookMethod } from "./enums";
|
|
2
|
+
import type { ConnectorAuthorizationMode, ToolCalendarOperation, ToolVariableType, ToolWebhookMethod } from "./enums";
|
|
3
|
+
/**
|
|
4
|
+
* Company-managed Nango connection.
|
|
5
|
+
* @public
|
|
6
|
+
*/
|
|
7
|
+
export interface ConnectorSharedAuthorization {
|
|
8
|
+
/**
|
|
9
|
+
* Nango connection identifier.
|
|
10
|
+
* @public
|
|
11
|
+
*/
|
|
12
|
+
connectionId: string;
|
|
13
|
+
}
|
|
14
|
+
/**
|
|
15
|
+
* Marker selecting authorization resolved from the executing user.
|
|
16
|
+
* @public
|
|
17
|
+
*/
|
|
18
|
+
export interface ConnectorUserAuthorization {
|
|
19
|
+
}
|
|
20
|
+
/**
|
|
21
|
+
* Credential selection for a configured connector. Credentials remain in Nango.
|
|
22
|
+
* @public
|
|
23
|
+
*/
|
|
24
|
+
export type ConnectorAuthorization = ConnectorAuthorization.SharedMember | ConnectorAuthorization.UserMember | ConnectorAuthorization.$UnknownMember;
|
|
25
|
+
/**
|
|
26
|
+
* @public
|
|
27
|
+
*/
|
|
28
|
+
export declare namespace ConnectorAuthorization {
|
|
29
|
+
/**
|
|
30
|
+
* Use one company-managed connection.
|
|
31
|
+
* @public
|
|
32
|
+
*/
|
|
33
|
+
interface SharedMember {
|
|
34
|
+
shared: ConnectorSharedAuthorization;
|
|
35
|
+
user?: never;
|
|
36
|
+
$unknown?: never;
|
|
37
|
+
}
|
|
38
|
+
/**
|
|
39
|
+
* Resolve a connection from the executing user.
|
|
40
|
+
* @public
|
|
41
|
+
*/
|
|
42
|
+
interface UserMember {
|
|
43
|
+
shared?: never;
|
|
44
|
+
user: ConnectorUserAuthorization;
|
|
45
|
+
$unknown?: never;
|
|
46
|
+
}
|
|
47
|
+
/**
|
|
48
|
+
* @public
|
|
49
|
+
*/
|
|
50
|
+
interface $UnknownMember {
|
|
51
|
+
shared?: never;
|
|
52
|
+
user?: never;
|
|
53
|
+
$unknown: [string, any];
|
|
54
|
+
}
|
|
55
|
+
/**
|
|
56
|
+
* @deprecated unused in schema-serde mode.
|
|
57
|
+
*
|
|
58
|
+
*/
|
|
59
|
+
interface Visitor<T> {
|
|
60
|
+
shared: (value: ConnectorSharedAuthorization) => T;
|
|
61
|
+
user: (value: ConnectorUserAuthorization) => T;
|
|
62
|
+
_: (name: string, value: any) => T;
|
|
63
|
+
}
|
|
64
|
+
}
|
|
65
|
+
/**
|
|
66
|
+
* Reference to one immutable connector definition.
|
|
67
|
+
* @public
|
|
68
|
+
*/
|
|
69
|
+
export interface ConnectorDefinitionRef {
|
|
70
|
+
/**
|
|
71
|
+
* Stable definition identifier.
|
|
72
|
+
* @public
|
|
73
|
+
*/
|
|
74
|
+
key: string;
|
|
75
|
+
/**
|
|
76
|
+
* Exact definition version.
|
|
77
|
+
* @public
|
|
78
|
+
*/
|
|
79
|
+
version: string;
|
|
80
|
+
}
|
|
81
|
+
/**
|
|
82
|
+
* Company-owned configured connector.
|
|
83
|
+
* @public
|
|
84
|
+
*/
|
|
85
|
+
export interface Connector {
|
|
86
|
+
/**
|
|
87
|
+
* Immutable definition used to validate configuration and execute tools.
|
|
88
|
+
* @public
|
|
89
|
+
*/
|
|
90
|
+
definition: ConnectorDefinitionRef;
|
|
91
|
+
/**
|
|
92
|
+
* Values validated against the definition configuration schema.
|
|
93
|
+
* @public
|
|
94
|
+
*/
|
|
95
|
+
configuration: __DocumentType;
|
|
96
|
+
/**
|
|
97
|
+
* Credential selection, omitted when no authorization is required. The same Nango
|
|
98
|
+
* connection reference may be reused across multiple Tools and Connectors.
|
|
99
|
+
* @public
|
|
100
|
+
*/
|
|
101
|
+
authorization?: ConnectorAuthorization | undefined;
|
|
102
|
+
/**
|
|
103
|
+
* Name exposed to administrators and AI agents.
|
|
104
|
+
* @public
|
|
105
|
+
*/
|
|
106
|
+
name: string;
|
|
107
|
+
/**
|
|
108
|
+
* Description exposed to administrators and AI agents.
|
|
109
|
+
* @public
|
|
110
|
+
*/
|
|
111
|
+
description: string;
|
|
112
|
+
/**
|
|
113
|
+
* Explicit allowlist of tools available to callers and agents.
|
|
114
|
+
* @public
|
|
115
|
+
*/
|
|
116
|
+
enabledTools: string[];
|
|
117
|
+
/**
|
|
118
|
+
* Unique connector instance identifier.
|
|
119
|
+
* @public
|
|
120
|
+
*/
|
|
121
|
+
id: string;
|
|
122
|
+
/**
|
|
123
|
+
* Company that owns this connector.
|
|
124
|
+
* @public
|
|
125
|
+
*/
|
|
126
|
+
companyId: string;
|
|
127
|
+
}
|
|
128
|
+
/**
|
|
129
|
+
* Authorization requirements declared by a connector definition.
|
|
130
|
+
* @public
|
|
131
|
+
*/
|
|
132
|
+
export interface ConnectorAuthorizationDefinition {
|
|
133
|
+
/**
|
|
134
|
+
* Nango provider configuration key.
|
|
135
|
+
* @public
|
|
136
|
+
*/
|
|
137
|
+
provider: string;
|
|
138
|
+
/**
|
|
139
|
+
* Credential resolution modes supported by this connector.
|
|
140
|
+
* @public
|
|
141
|
+
*/
|
|
142
|
+
modes: ConnectorAuthorizationMode[];
|
|
143
|
+
/**
|
|
144
|
+
* Base OAuth scopes required by every tool.
|
|
145
|
+
* @public
|
|
146
|
+
*/
|
|
147
|
+
scopes?: string[] | undefined;
|
|
148
|
+
}
|
|
149
|
+
/**
|
|
150
|
+
* Configuration contract rendered by management clients and validated by the service.
|
|
151
|
+
* @public
|
|
152
|
+
*/
|
|
153
|
+
export interface ConnectorConfigurationDefinition {
|
|
154
|
+
/**
|
|
155
|
+
* JSON Schema 2020-12 document describing persisted configuration.
|
|
156
|
+
* @public
|
|
157
|
+
*/
|
|
158
|
+
schema: __DocumentType;
|
|
159
|
+
/**
|
|
160
|
+
* Presentation hints for a compatible JSON Schema form renderer.
|
|
161
|
+
* @public
|
|
162
|
+
*/
|
|
163
|
+
uiSchema?: __DocumentType | undefined;
|
|
164
|
+
/**
|
|
165
|
+
* Initial values to use when creating a connector.
|
|
166
|
+
* @public
|
|
167
|
+
*/
|
|
168
|
+
initialValues?: __DocumentType | undefined;
|
|
169
|
+
}
|
|
170
|
+
/**
|
|
171
|
+
* Display metadata for a connector catalog entry.
|
|
172
|
+
* @public
|
|
173
|
+
*/
|
|
174
|
+
export interface ConnectorMetadata {
|
|
175
|
+
/**
|
|
176
|
+
* Human-readable connector name.
|
|
177
|
+
* @public
|
|
178
|
+
*/
|
|
179
|
+
title: string;
|
|
180
|
+
/**
|
|
181
|
+
* Summary of the external system and supported use cases.
|
|
182
|
+
* @public
|
|
183
|
+
*/
|
|
184
|
+
description: string;
|
|
185
|
+
/**
|
|
186
|
+
* Icon URL or renderer-known icon key.
|
|
187
|
+
* @public
|
|
188
|
+
*/
|
|
189
|
+
icon?: string | undefined;
|
|
190
|
+
/**
|
|
191
|
+
* Catalog category used for discovery and filtering.
|
|
192
|
+
* @public
|
|
193
|
+
*/
|
|
194
|
+
category?: string | undefined;
|
|
195
|
+
/**
|
|
196
|
+
* Link to external connector documentation.
|
|
197
|
+
* @public
|
|
198
|
+
*/
|
|
199
|
+
documentationUrl?: string | undefined;
|
|
200
|
+
}
|
|
201
|
+
/**
|
|
202
|
+
* Behavioral hints aligned with the Model Context Protocol tool annotations.
|
|
203
|
+
*
|
|
204
|
+
* These fields help agents decide whether confirmation is appropriate. They are
|
|
205
|
+
* not authorization controls and must not replace server-side policy checks.
|
|
206
|
+
* @public
|
|
207
|
+
*/
|
|
208
|
+
export interface ConnectorToolAnnotations {
|
|
209
|
+
/**
|
|
210
|
+
* Indicates that the tool does not modify external state.
|
|
211
|
+
* @public
|
|
212
|
+
*/
|
|
213
|
+
readOnlyHint?: boolean | undefined;
|
|
214
|
+
/**
|
|
215
|
+
* Indicates that the tool can perform destructive updates.
|
|
216
|
+
* @public
|
|
217
|
+
*/
|
|
218
|
+
destructiveHint?: boolean | undefined;
|
|
219
|
+
/**
|
|
220
|
+
* Indicates that repeated calls with identical arguments have no additional effect.
|
|
221
|
+
* @public
|
|
222
|
+
*/
|
|
223
|
+
idempotentHint?: boolean | undefined;
|
|
224
|
+
/**
|
|
225
|
+
* Indicates that the tool can interact with entities outside a closed domain.
|
|
226
|
+
* @public
|
|
227
|
+
*/
|
|
228
|
+
openWorldHint?: boolean | undefined;
|
|
229
|
+
}
|
|
230
|
+
/**
|
|
231
|
+
* @public
|
|
232
|
+
*/
|
|
233
|
+
export interface ToolVariable {
|
|
234
|
+
/**
|
|
235
|
+
* Name of the tool variable, e.g.: 'myvar'
|
|
236
|
+
* @public
|
|
237
|
+
*/
|
|
238
|
+
name: string;
|
|
239
|
+
/**
|
|
240
|
+
* Type of the tool variable, e.g.: 'string', 'number', 'boolean', 'string_array', 'number_array'
|
|
241
|
+
* @public
|
|
242
|
+
*/
|
|
243
|
+
type: ToolVariableType;
|
|
244
|
+
/**
|
|
245
|
+
* Whether the variable is optional
|
|
246
|
+
* @public
|
|
247
|
+
*/
|
|
248
|
+
optional: boolean;
|
|
249
|
+
/**
|
|
250
|
+
* Description used by people and AI agents.
|
|
251
|
+
* @public
|
|
252
|
+
*/
|
|
253
|
+
description?: string | undefined;
|
|
254
|
+
/**
|
|
255
|
+
* Allowed values when type is string.
|
|
256
|
+
* @public
|
|
257
|
+
*/
|
|
258
|
+
enum?: string[] | undefined;
|
|
259
|
+
/**
|
|
260
|
+
* Value format hint when type is string, such as email or uri.
|
|
261
|
+
* @public
|
|
262
|
+
*/
|
|
263
|
+
format?: string | undefined;
|
|
264
|
+
/**
|
|
265
|
+
* Nested JSON Schema when type is schema.
|
|
266
|
+
* @public
|
|
267
|
+
*/
|
|
268
|
+
schema?: __DocumentType | undefined;
|
|
269
|
+
}
|
|
270
|
+
/**
|
|
271
|
+
* @public
|
|
272
|
+
*/
|
|
273
|
+
export interface ToolInput {
|
|
274
|
+
/**
|
|
275
|
+
* Agent arguments for the tool.
|
|
276
|
+
* @public
|
|
277
|
+
*/
|
|
278
|
+
variables: ToolVariable[];
|
|
279
|
+
}
|
|
280
|
+
/**
|
|
281
|
+
* Tool exposed by a connector definition.
|
|
282
|
+
* @public
|
|
283
|
+
*/
|
|
284
|
+
export interface ConnectorTool {
|
|
285
|
+
/**
|
|
286
|
+
* Stable dispatch identifier used in `ExecuteConnector` input keys.
|
|
287
|
+
* @public
|
|
288
|
+
*/
|
|
289
|
+
id: string;
|
|
290
|
+
/**
|
|
291
|
+
* Agent-facing tool name.
|
|
292
|
+
* @public
|
|
293
|
+
*/
|
|
294
|
+
name: string;
|
|
295
|
+
/**
|
|
296
|
+
* Description used by people and AI agents to select the tool.
|
|
297
|
+
* @public
|
|
298
|
+
*/
|
|
299
|
+
description: string;
|
|
300
|
+
/**
|
|
301
|
+
* Tool arguments exposed to agents, using the same contract as `Tool.input`.
|
|
302
|
+
* @public
|
|
303
|
+
*/
|
|
304
|
+
input: ToolInput;
|
|
305
|
+
/**
|
|
306
|
+
* Additional OAuth scopes required by this tool.
|
|
307
|
+
* @public
|
|
308
|
+
*/
|
|
309
|
+
authorizationScopes?: string[] | undefined;
|
|
310
|
+
/**
|
|
311
|
+
* Behavioral hints for agents and approval systems.
|
|
312
|
+
* @public
|
|
313
|
+
*/
|
|
314
|
+
annotations?: ConnectorToolAnnotations | undefined;
|
|
315
|
+
}
|
|
316
|
+
/**
|
|
317
|
+
* Immutable server-owned connector definition.
|
|
318
|
+
* @public
|
|
319
|
+
*/
|
|
320
|
+
export interface ConnectorDefinition {
|
|
321
|
+
/**
|
|
322
|
+
* Stable key and exact immutable version.
|
|
323
|
+
* @public
|
|
324
|
+
*/
|
|
325
|
+
ref: ConnectorDefinitionRef;
|
|
326
|
+
/**
|
|
327
|
+
* Catalog display metadata.
|
|
328
|
+
* @public
|
|
329
|
+
*/
|
|
330
|
+
metadata: ConnectorMetadata;
|
|
331
|
+
/**
|
|
332
|
+
* Connector instance configuration contract.
|
|
333
|
+
* @public
|
|
334
|
+
*/
|
|
335
|
+
configuration: ConnectorConfigurationDefinition;
|
|
336
|
+
/**
|
|
337
|
+
* Authorization requirements, omitted when the connector needs no credentials.
|
|
338
|
+
* @public
|
|
339
|
+
*/
|
|
340
|
+
authorization?: ConnectorAuthorizationDefinition | undefined;
|
|
341
|
+
/**
|
|
342
|
+
* Tools available in this definition version.
|
|
343
|
+
* @public
|
|
344
|
+
*/
|
|
345
|
+
tools: ConnectorTool[];
|
|
346
|
+
/**
|
|
347
|
+
* Whether new instances should avoid this definition.
|
|
348
|
+
* @public
|
|
349
|
+
*/
|
|
350
|
+
deprecated?: boolean | undefined;
|
|
351
|
+
/**
|
|
352
|
+
* Suggested replacement when this definition is deprecated.
|
|
353
|
+
* @public
|
|
354
|
+
*/
|
|
355
|
+
replacedBy?: ConnectorDefinitionRef | undefined;
|
|
356
|
+
}
|
|
357
|
+
/**
|
|
358
|
+
* Result of executing a connector.
|
|
359
|
+
* @public
|
|
360
|
+
*/
|
|
361
|
+
export interface ConnectorExecutionResult {
|
|
362
|
+
/**
|
|
363
|
+
* Structured tool output.
|
|
364
|
+
* @public
|
|
365
|
+
*/
|
|
366
|
+
output: __DocumentType;
|
|
367
|
+
/**
|
|
368
|
+
* Identifier used to correlate logs and traces.
|
|
369
|
+
* @public
|
|
370
|
+
*/
|
|
371
|
+
executionId: string;
|
|
372
|
+
/**
|
|
373
|
+
* Definition version used for validation and execution.
|
|
374
|
+
* @public
|
|
375
|
+
*/
|
|
376
|
+
definitionVersion: string;
|
|
377
|
+
}
|
|
378
|
+
/**
|
|
379
|
+
* Fields supplied when a connector is created or replaced.
|
|
380
|
+
* @public
|
|
381
|
+
*/
|
|
382
|
+
export interface CreateConnectorInput {
|
|
383
|
+
/**
|
|
384
|
+
* Immutable definition used to validate configuration and execute tools.
|
|
385
|
+
* @public
|
|
386
|
+
*/
|
|
387
|
+
definition: ConnectorDefinitionRef;
|
|
388
|
+
/**
|
|
389
|
+
* Values validated against the definition configuration schema.
|
|
390
|
+
* @public
|
|
391
|
+
*/
|
|
392
|
+
configuration: __DocumentType;
|
|
393
|
+
/**
|
|
394
|
+
* Credential selection, omitted when no authorization is required. The same Nango
|
|
395
|
+
* connection reference may be reused across multiple Tools and Connectors.
|
|
396
|
+
* @public
|
|
397
|
+
*/
|
|
398
|
+
authorization?: ConnectorAuthorization | undefined;
|
|
399
|
+
/**
|
|
400
|
+
* Name exposed to administrators and AI agents.
|
|
401
|
+
* @public
|
|
402
|
+
*/
|
|
403
|
+
name: string;
|
|
404
|
+
/**
|
|
405
|
+
* Description exposed to administrators and AI agents.
|
|
406
|
+
* @public
|
|
407
|
+
*/
|
|
408
|
+
description: string;
|
|
409
|
+
/**
|
|
410
|
+
* Explicit allowlist of tools available to callers and agents.
|
|
411
|
+
* @public
|
|
412
|
+
*/
|
|
413
|
+
enabledTools: string[];
|
|
414
|
+
/**
|
|
415
|
+
* The unique identifier of the tenant when a service token is used.
|
|
416
|
+
* @public
|
|
417
|
+
*/
|
|
418
|
+
companyId?: string | undefined;
|
|
419
|
+
}
|
|
420
|
+
/**
|
|
421
|
+
* @public
|
|
422
|
+
*/
|
|
423
|
+
export interface CreateConnectorOutput {
|
|
424
|
+
/**
|
|
425
|
+
* Created connector.
|
|
426
|
+
* @public
|
|
427
|
+
*/
|
|
428
|
+
connector: Connector;
|
|
429
|
+
}
|
|
430
|
+
/**
|
|
431
|
+
* @public
|
|
432
|
+
*/
|
|
433
|
+
export interface CreateConnectorSessionInput {
|
|
434
|
+
/**
|
|
435
|
+
* The unique identifier of the tenant when a service token is used.
|
|
436
|
+
* @public
|
|
437
|
+
*/
|
|
438
|
+
companyId?: string | undefined;
|
|
439
|
+
/**
|
|
440
|
+
* Stable connector definition key.
|
|
441
|
+
* @public
|
|
442
|
+
*/
|
|
443
|
+
key: string;
|
|
444
|
+
/**
|
|
445
|
+
* Exact immutable definition version.
|
|
446
|
+
* @public
|
|
447
|
+
*/
|
|
448
|
+
version: string;
|
|
449
|
+
/**
|
|
450
|
+
* Executing user used to scope the Nango connect session.
|
|
451
|
+
* @public
|
|
452
|
+
*/
|
|
453
|
+
user?: string | undefined;
|
|
454
|
+
}
|
|
455
|
+
/**
|
|
456
|
+
* @public
|
|
457
|
+
*/
|
|
458
|
+
export interface CreateConnectorSessionOutput {
|
|
459
|
+
/**
|
|
460
|
+
* Nango connect session token used by the management client OAuth popup.
|
|
461
|
+
* @public
|
|
462
|
+
*/
|
|
463
|
+
sessionToken: string;
|
|
464
|
+
/**
|
|
465
|
+
* Nango provider config key the connection is created against.
|
|
466
|
+
* @public
|
|
467
|
+
*/
|
|
468
|
+
providerConfigKey: string;
|
|
469
|
+
/**
|
|
470
|
+
* Nango host the management client OAuth popup must target.
|
|
471
|
+
* @public
|
|
472
|
+
*/
|
|
473
|
+
nangoHost: string;
|
|
474
|
+
}
|
|
475
|
+
/**
|
|
476
|
+
* @public
|
|
477
|
+
*/
|
|
478
|
+
export interface ToolCalendarConfig {
|
|
479
|
+
/**
|
|
480
|
+
* Calendar operation executed by the tool. Use separate tools per operation and keep the operation fixed in the handler instead of passing it in runtime input.
|
|
481
|
+
* @public
|
|
482
|
+
*/
|
|
483
|
+
operation: ToolCalendarOperation;
|
|
484
|
+
}
|
|
3
485
|
/**
|
|
4
486
|
* @public
|
|
5
487
|
*/
|
|
@@ -74,6 +556,36 @@ export interface ToolChatHandler {
|
|
|
74
556
|
*/
|
|
75
557
|
config: ToolChatConfig;
|
|
76
558
|
}
|
|
559
|
+
/**
|
|
560
|
+
* Handler for a connector-backed Tool created through `CreateTool`.
|
|
561
|
+
*
|
|
562
|
+
* The service resolves agent arguments from the pinned connector tool definition.
|
|
563
|
+
* Create and update requests omit `input` when this handler is used.
|
|
564
|
+
* @public
|
|
565
|
+
*/
|
|
566
|
+
export interface ToolConnectorHandler {
|
|
567
|
+
/**
|
|
568
|
+
* Immutable definition used to validate configuration and execute tools.
|
|
569
|
+
* @public
|
|
570
|
+
*/
|
|
571
|
+
definition: ConnectorDefinitionRef;
|
|
572
|
+
/**
|
|
573
|
+
* Values validated against the definition configuration schema.
|
|
574
|
+
* @public
|
|
575
|
+
*/
|
|
576
|
+
configuration: __DocumentType;
|
|
577
|
+
/**
|
|
578
|
+
* Credential selection, omitted when no authorization is required. The same Nango
|
|
579
|
+
* connection reference may be reused across multiple Tools and Connectors.
|
|
580
|
+
* @public
|
|
581
|
+
*/
|
|
582
|
+
authorization?: ConnectorAuthorization | undefined;
|
|
583
|
+
/**
|
|
584
|
+
* Connector tool from the pinned definition executed by this Tool.
|
|
585
|
+
* @public
|
|
586
|
+
*/
|
|
587
|
+
toolId: string;
|
|
588
|
+
}
|
|
77
589
|
/**
|
|
78
590
|
* @public
|
|
79
591
|
*/
|
|
@@ -504,7 +1016,7 @@ export interface ToolWebhookConfig {
|
|
|
504
1016
|
/**
|
|
505
1017
|
* @public
|
|
506
1018
|
*/
|
|
507
|
-
export type ToolHandler = ToolHandler.ChatMember | ToolHandler.EmailMember | ToolHandler.McpMember | ToolHandler.McpToolMember | ToolHandler.SearchMember | ToolHandler.SmsMember | ToolHandler.WebhookMember | ToolHandler.$UnknownMember;
|
|
1019
|
+
export type ToolHandler = ToolHandler.CalendarMember | ToolHandler.ChatMember | ToolHandler.ConnectorMember | ToolHandler.EmailMember | ToolHandler.McpMember | ToolHandler.McpToolMember | ToolHandler.SearchMember | ToolHandler.SmsMember | ToolHandler.WebhookMember | ToolHandler.$UnknownMember;
|
|
508
1020
|
/**
|
|
509
1021
|
* @public
|
|
510
1022
|
*/
|
|
@@ -515,6 +1027,8 @@ export declare namespace ToolHandler {
|
|
|
515
1027
|
search?: never;
|
|
516
1028
|
chat?: never;
|
|
517
1029
|
sms?: never;
|
|
1030
|
+
calendar?: never;
|
|
1031
|
+
connector?: never;
|
|
518
1032
|
mcp?: never;
|
|
519
1033
|
mcpTool?: never;
|
|
520
1034
|
$unknown?: never;
|
|
@@ -525,6 +1039,8 @@ export declare namespace ToolHandler {
|
|
|
525
1039
|
search?: never;
|
|
526
1040
|
chat?: never;
|
|
527
1041
|
sms?: never;
|
|
1042
|
+
calendar?: never;
|
|
1043
|
+
connector?: never;
|
|
528
1044
|
mcp?: never;
|
|
529
1045
|
mcpTool?: never;
|
|
530
1046
|
$unknown?: never;
|
|
@@ -539,6 +1055,8 @@ export declare namespace ToolHandler {
|
|
|
539
1055
|
search: ToolSearchConfig;
|
|
540
1056
|
chat?: never;
|
|
541
1057
|
sms?: never;
|
|
1058
|
+
calendar?: never;
|
|
1059
|
+
connector?: never;
|
|
542
1060
|
mcp?: never;
|
|
543
1061
|
mcpTool?: never;
|
|
544
1062
|
$unknown?: never;
|
|
@@ -549,6 +1067,8 @@ export declare namespace ToolHandler {
|
|
|
549
1067
|
search?: never;
|
|
550
1068
|
chat: ToolChatHandler;
|
|
551
1069
|
sms?: never;
|
|
1070
|
+
calendar?: never;
|
|
1071
|
+
connector?: never;
|
|
552
1072
|
mcp?: never;
|
|
553
1073
|
mcpTool?: never;
|
|
554
1074
|
$unknown?: never;
|
|
@@ -558,7 +1078,37 @@ export declare namespace ToolHandler {
|
|
|
558
1078
|
webhook?: never;
|
|
559
1079
|
search?: never;
|
|
560
1080
|
chat?: never;
|
|
561
|
-
sms: ToolSmsHandler;
|
|
1081
|
+
sms: ToolSmsHandler;
|
|
1082
|
+
calendar?: never;
|
|
1083
|
+
connector?: never;
|
|
1084
|
+
mcp?: never;
|
|
1085
|
+
mcpTool?: never;
|
|
1086
|
+
$unknown?: never;
|
|
1087
|
+
}
|
|
1088
|
+
interface CalendarMember {
|
|
1089
|
+
email?: never;
|
|
1090
|
+
webhook?: never;
|
|
1091
|
+
search?: never;
|
|
1092
|
+
chat?: never;
|
|
1093
|
+
sms?: never;
|
|
1094
|
+
calendar: ToolCalendarConfig;
|
|
1095
|
+
connector?: never;
|
|
1096
|
+
mcp?: never;
|
|
1097
|
+
mcpTool?: never;
|
|
1098
|
+
$unknown?: never;
|
|
1099
|
+
}
|
|
1100
|
+
/**
|
|
1101
|
+
* Connector-backed Tool. Create with `CreateTool` using `handler.connector`. Authorization may reuse the same Nango connection as a Connector.
|
|
1102
|
+
* @public
|
|
1103
|
+
*/
|
|
1104
|
+
interface ConnectorMember {
|
|
1105
|
+
email?: never;
|
|
1106
|
+
webhook?: never;
|
|
1107
|
+
search?: never;
|
|
1108
|
+
chat?: never;
|
|
1109
|
+
sms?: never;
|
|
1110
|
+
calendar?: never;
|
|
1111
|
+
connector: ToolConnectorHandler;
|
|
562
1112
|
mcp?: never;
|
|
563
1113
|
mcpTool?: never;
|
|
564
1114
|
$unknown?: never;
|
|
@@ -569,6 +1119,8 @@ export declare namespace ToolHandler {
|
|
|
569
1119
|
search?: never;
|
|
570
1120
|
chat?: never;
|
|
571
1121
|
sms?: never;
|
|
1122
|
+
calendar?: never;
|
|
1123
|
+
connector?: never;
|
|
572
1124
|
mcp: ToolMcpHandler;
|
|
573
1125
|
mcpTool?: never;
|
|
574
1126
|
$unknown?: never;
|
|
@@ -579,6 +1131,8 @@ export declare namespace ToolHandler {
|
|
|
579
1131
|
search?: never;
|
|
580
1132
|
chat?: never;
|
|
581
1133
|
sms?: never;
|
|
1134
|
+
calendar?: never;
|
|
1135
|
+
connector?: never;
|
|
582
1136
|
mcp?: never;
|
|
583
1137
|
mcpTool: ToolMcpToolHandler;
|
|
584
1138
|
$unknown?: never;
|
|
@@ -592,6 +1146,8 @@ export declare namespace ToolHandler {
|
|
|
592
1146
|
search?: never;
|
|
593
1147
|
chat?: never;
|
|
594
1148
|
sms?: never;
|
|
1149
|
+
calendar?: never;
|
|
1150
|
+
connector?: never;
|
|
595
1151
|
mcp?: never;
|
|
596
1152
|
mcpTool?: never;
|
|
597
1153
|
$unknown: [string, any];
|
|
@@ -606,51 +1162,13 @@ export declare namespace ToolHandler {
|
|
|
606
1162
|
search: (value: ToolSearchConfig) => T;
|
|
607
1163
|
chat: (value: ToolChatHandler) => T;
|
|
608
1164
|
sms: (value: ToolSmsHandler) => T;
|
|
1165
|
+
calendar: (value: ToolCalendarConfig) => T;
|
|
1166
|
+
connector: (value: ToolConnectorHandler) => T;
|
|
609
1167
|
mcp: (value: ToolMcpHandler) => T;
|
|
610
1168
|
mcpTool: (value: ToolMcpToolHandler) => T;
|
|
611
1169
|
_: (name: string, value: any) => T;
|
|
612
1170
|
}
|
|
613
1171
|
}
|
|
614
|
-
/**
|
|
615
|
-
* @public
|
|
616
|
-
*/
|
|
617
|
-
export interface ToolVariable {
|
|
618
|
-
/**
|
|
619
|
-
* Name of the tool variable, e.g.: 'myvar'
|
|
620
|
-
* @public
|
|
621
|
-
*/
|
|
622
|
-
name: string;
|
|
623
|
-
/**
|
|
624
|
-
* Type of the tool variable, e.g.: 'string', 'number', 'boolean', 'string_array', 'number_array'
|
|
625
|
-
* @public
|
|
626
|
-
*/
|
|
627
|
-
type: ToolVariableType;
|
|
628
|
-
/**
|
|
629
|
-
* Whether the variable is optional
|
|
630
|
-
* @public
|
|
631
|
-
*/
|
|
632
|
-
optional: boolean;
|
|
633
|
-
/**
|
|
634
|
-
* Original description from MCP tool schema (preserved)
|
|
635
|
-
* @public
|
|
636
|
-
*/
|
|
637
|
-
description?: string | undefined;
|
|
638
|
-
/**
|
|
639
|
-
* JSON Schema in case if type is schema
|
|
640
|
-
* @public
|
|
641
|
-
*/
|
|
642
|
-
schema?: __DocumentType | undefined;
|
|
643
|
-
}
|
|
644
|
-
/**
|
|
645
|
-
* @public
|
|
646
|
-
*/
|
|
647
|
-
export interface ToolInput {
|
|
648
|
-
/**
|
|
649
|
-
* List of tool variables, used to pass data to the tool
|
|
650
|
-
* @public
|
|
651
|
-
*/
|
|
652
|
-
variables: ToolVariable[];
|
|
653
|
-
}
|
|
654
1172
|
/**
|
|
655
1173
|
* @public
|
|
656
1174
|
*/
|
|
@@ -676,10 +1194,10 @@ export interface CreateToolInput {
|
|
|
676
1194
|
*/
|
|
677
1195
|
description: string;
|
|
678
1196
|
/**
|
|
679
|
-
*
|
|
1197
|
+
* Agent arguments. Omit when handler.connector is set; the service resolves input from the pinned connector tool definition.
|
|
680
1198
|
* @public
|
|
681
1199
|
*/
|
|
682
|
-
input
|
|
1200
|
+
input?: ToolInput | undefined;
|
|
683
1201
|
/**
|
|
684
1202
|
* Handler of the tool, used to execute the tool.
|
|
685
1203
|
* @public
|
|
@@ -716,10 +1234,10 @@ export interface Tool {
|
|
|
716
1234
|
*/
|
|
717
1235
|
description: string;
|
|
718
1236
|
/**
|
|
719
|
-
*
|
|
1237
|
+
* Agent arguments. Required for built-in handlers. Omit when handler.connector is set; the service resolves input from the pinned connector tool definition.
|
|
720
1238
|
* @public
|
|
721
1239
|
*/
|
|
722
|
-
input
|
|
1240
|
+
input?: ToolInput | undefined;
|
|
723
1241
|
/**
|
|
724
1242
|
* Handler of the tool, used to execute the tool
|
|
725
1243
|
* @public
|
|
@@ -732,6 +1250,26 @@ export interface Tool {
|
|
|
732
1250
|
export interface CreateToolOutput {
|
|
733
1251
|
tool: Tool;
|
|
734
1252
|
}
|
|
1253
|
+
/**
|
|
1254
|
+
* @public
|
|
1255
|
+
*/
|
|
1256
|
+
export interface DeleteConnectorInput {
|
|
1257
|
+
/**
|
|
1258
|
+
* The unique identifier of the tenant when a service token is used.
|
|
1259
|
+
* @public
|
|
1260
|
+
*/
|
|
1261
|
+
companyId?: string | undefined;
|
|
1262
|
+
/**
|
|
1263
|
+
* Connector instance identifier.
|
|
1264
|
+
* @public
|
|
1265
|
+
*/
|
|
1266
|
+
connectorId: string;
|
|
1267
|
+
}
|
|
1268
|
+
/**
|
|
1269
|
+
* @public
|
|
1270
|
+
*/
|
|
1271
|
+
export interface DeleteConnectorOutput {
|
|
1272
|
+
}
|
|
735
1273
|
/**
|
|
736
1274
|
* @public
|
|
737
1275
|
*/
|
|
@@ -787,7 +1325,7 @@ export interface ToolDescription {
|
|
|
787
1325
|
*/
|
|
788
1326
|
description: string;
|
|
789
1327
|
/**
|
|
790
|
-
* List of tool variables
|
|
1328
|
+
* List of tool variables.
|
|
791
1329
|
* @public
|
|
792
1330
|
*/
|
|
793
1331
|
variables: ToolVariable[];
|
|
@@ -852,6 +1390,47 @@ export interface DiscoverToolsOutput {
|
|
|
852
1390
|
*/
|
|
853
1391
|
tools: DiscoveredTool[];
|
|
854
1392
|
}
|
|
1393
|
+
/**
|
|
1394
|
+
* @public
|
|
1395
|
+
*/
|
|
1396
|
+
export interface ExecuteConnectorInput {
|
|
1397
|
+
/**
|
|
1398
|
+
* The unique identifier of the tenant when a service token is used.
|
|
1399
|
+
* @public
|
|
1400
|
+
*/
|
|
1401
|
+
companyId?: string | undefined;
|
|
1402
|
+
/**
|
|
1403
|
+
* Connector instance identifier.
|
|
1404
|
+
* @public
|
|
1405
|
+
*/
|
|
1406
|
+
connectorId: string;
|
|
1407
|
+
/**
|
|
1408
|
+
* Invocation payload from the model or agent. For multi-tool connectors this
|
|
1409
|
+
* is typically an object with exactly one connector tool id key and argument object.
|
|
1410
|
+
* @public
|
|
1411
|
+
*/
|
|
1412
|
+
input: __DocumentType;
|
|
1413
|
+
/**
|
|
1414
|
+
* Service executing the connector, such as `chatbots` or `voicebots`.
|
|
1415
|
+
* @public
|
|
1416
|
+
*/
|
|
1417
|
+
service?: string | undefined;
|
|
1418
|
+
/**
|
|
1419
|
+
* User identity required by user-authorized connectors.
|
|
1420
|
+
* @public
|
|
1421
|
+
*/
|
|
1422
|
+
user?: string | undefined;
|
|
1423
|
+
}
|
|
1424
|
+
/**
|
|
1425
|
+
* @public
|
|
1426
|
+
*/
|
|
1427
|
+
export interface ExecuteConnectorOutput {
|
|
1428
|
+
/**
|
|
1429
|
+
* Structured tool result and execution metadata.
|
|
1430
|
+
* @public
|
|
1431
|
+
*/
|
|
1432
|
+
result: ConnectorExecutionResult;
|
|
1433
|
+
}
|
|
855
1434
|
/**
|
|
856
1435
|
* @public
|
|
857
1436
|
*/
|
|
@@ -902,6 +1481,61 @@ export interface ExecuteToolOutput {
|
|
|
902
1481
|
*/
|
|
903
1482
|
result: ToolExecutionResult;
|
|
904
1483
|
}
|
|
1484
|
+
/**
|
|
1485
|
+
* @public
|
|
1486
|
+
*/
|
|
1487
|
+
export interface GetConnectorInput {
|
|
1488
|
+
/**
|
|
1489
|
+
* The unique identifier of the tenant when a service token is used.
|
|
1490
|
+
* @public
|
|
1491
|
+
*/
|
|
1492
|
+
companyId?: string | undefined;
|
|
1493
|
+
/**
|
|
1494
|
+
* Connector instance identifier.
|
|
1495
|
+
* @public
|
|
1496
|
+
*/
|
|
1497
|
+
connectorId: string;
|
|
1498
|
+
}
|
|
1499
|
+
/**
|
|
1500
|
+
* @public
|
|
1501
|
+
*/
|
|
1502
|
+
export interface GetConnectorOutput {
|
|
1503
|
+
/**
|
|
1504
|
+
* Requested connector.
|
|
1505
|
+
* @public
|
|
1506
|
+
*/
|
|
1507
|
+
connector: Connector;
|
|
1508
|
+
}
|
|
1509
|
+
/**
|
|
1510
|
+
* @public
|
|
1511
|
+
*/
|
|
1512
|
+
export interface GetConnectorDefinitionInput {
|
|
1513
|
+
/**
|
|
1514
|
+
* The unique identifier of the tenant when a service token is used.
|
|
1515
|
+
* @public
|
|
1516
|
+
*/
|
|
1517
|
+
companyId?: string | undefined;
|
|
1518
|
+
/**
|
|
1519
|
+
* Stable connector definition key.
|
|
1520
|
+
* @public
|
|
1521
|
+
*/
|
|
1522
|
+
key: string;
|
|
1523
|
+
/**
|
|
1524
|
+
* Exact immutable definition version.
|
|
1525
|
+
* @public
|
|
1526
|
+
*/
|
|
1527
|
+
version: string;
|
|
1528
|
+
}
|
|
1529
|
+
/**
|
|
1530
|
+
* @public
|
|
1531
|
+
*/
|
|
1532
|
+
export interface GetConnectorDefinitionOutput {
|
|
1533
|
+
/**
|
|
1534
|
+
* Requested connector definition.
|
|
1535
|
+
* @public
|
|
1536
|
+
*/
|
|
1537
|
+
definition: ConnectorDefinition;
|
|
1538
|
+
}
|
|
905
1539
|
/**
|
|
906
1540
|
* @public
|
|
907
1541
|
*/
|
|
@@ -927,6 +1561,81 @@ export interface GetToolOutput {
|
|
|
927
1561
|
*/
|
|
928
1562
|
tool: Tool;
|
|
929
1563
|
}
|
|
1564
|
+
/**
|
|
1565
|
+
* @public
|
|
1566
|
+
*/
|
|
1567
|
+
export interface ListConnectorDefinitionsInput {
|
|
1568
|
+
/**
|
|
1569
|
+
* The unique identifier of the tenant when a service token is used.
|
|
1570
|
+
* @public
|
|
1571
|
+
*/
|
|
1572
|
+
companyId?: string | undefined;
|
|
1573
|
+
/**
|
|
1574
|
+
* Case-insensitive filter applied to connector titles, keys, and descriptions.
|
|
1575
|
+
* @public
|
|
1576
|
+
*/
|
|
1577
|
+
query?: string | undefined;
|
|
1578
|
+
/**
|
|
1579
|
+
* Maximum number of definitions to return.
|
|
1580
|
+
* @public
|
|
1581
|
+
*/
|
|
1582
|
+
pageSize?: number | undefined;
|
|
1583
|
+
/**
|
|
1584
|
+
* Token returned by the previous request.
|
|
1585
|
+
* @public
|
|
1586
|
+
*/
|
|
1587
|
+
nextToken?: string | undefined;
|
|
1588
|
+
}
|
|
1589
|
+
/**
|
|
1590
|
+
* @public
|
|
1591
|
+
*/
|
|
1592
|
+
export interface ListConnectorDefinitionsOutput {
|
|
1593
|
+
/**
|
|
1594
|
+
* Connector definitions in the current page.
|
|
1595
|
+
* @public
|
|
1596
|
+
*/
|
|
1597
|
+
definitions: ConnectorDefinition[];
|
|
1598
|
+
/**
|
|
1599
|
+
* Token for the next page, omitted when no more results exist.
|
|
1600
|
+
* @public
|
|
1601
|
+
*/
|
|
1602
|
+
nextToken?: string | undefined;
|
|
1603
|
+
}
|
|
1604
|
+
/**
|
|
1605
|
+
* @public
|
|
1606
|
+
*/
|
|
1607
|
+
export interface ListConnectorsInput {
|
|
1608
|
+
/**
|
|
1609
|
+
* The unique identifier of the tenant when a service token is used.
|
|
1610
|
+
* @public
|
|
1611
|
+
*/
|
|
1612
|
+
companyId?: string | undefined;
|
|
1613
|
+
/**
|
|
1614
|
+
* Maximum number of connectors to return.
|
|
1615
|
+
* @public
|
|
1616
|
+
*/
|
|
1617
|
+
pageSize?: number | undefined;
|
|
1618
|
+
/**
|
|
1619
|
+
* Token returned by the previous request.
|
|
1620
|
+
* @public
|
|
1621
|
+
*/
|
|
1622
|
+
nextToken?: string | undefined;
|
|
1623
|
+
}
|
|
1624
|
+
/**
|
|
1625
|
+
* @public
|
|
1626
|
+
*/
|
|
1627
|
+
export interface ListConnectorsOutput {
|
|
1628
|
+
/**
|
|
1629
|
+
* Connectors in the current page.
|
|
1630
|
+
* @public
|
|
1631
|
+
*/
|
|
1632
|
+
connectors: Connector[];
|
|
1633
|
+
/**
|
|
1634
|
+
* Token for the next page, omitted when no more results exist.
|
|
1635
|
+
* @public
|
|
1636
|
+
*/
|
|
1637
|
+
nextToken?: string | undefined;
|
|
1638
|
+
}
|
|
930
1639
|
/**
|
|
931
1640
|
* @public
|
|
932
1641
|
*/
|
|
@@ -947,6 +1656,108 @@ export interface ListToolsOutput {
|
|
|
947
1656
|
*/
|
|
948
1657
|
tools: Tool[];
|
|
949
1658
|
}
|
|
1659
|
+
/**
|
|
1660
|
+
* @public
|
|
1661
|
+
*/
|
|
1662
|
+
export interface ResolveConnectorConfigurationInput {
|
|
1663
|
+
/**
|
|
1664
|
+
* The unique identifier of the tenant when a service token is used.
|
|
1665
|
+
* @public
|
|
1666
|
+
*/
|
|
1667
|
+
companyId?: string | undefined;
|
|
1668
|
+
/**
|
|
1669
|
+
* Stable connector definition key.
|
|
1670
|
+
* @public
|
|
1671
|
+
*/
|
|
1672
|
+
key: string;
|
|
1673
|
+
/**
|
|
1674
|
+
* Exact immutable definition version.
|
|
1675
|
+
* @public
|
|
1676
|
+
*/
|
|
1677
|
+
version: string;
|
|
1678
|
+
/**
|
|
1679
|
+
* Current partial form values.
|
|
1680
|
+
* @public
|
|
1681
|
+
*/
|
|
1682
|
+
values: __DocumentType;
|
|
1683
|
+
/**
|
|
1684
|
+
* Credentials used to resolve account-dependent options.
|
|
1685
|
+
* @public
|
|
1686
|
+
*/
|
|
1687
|
+
authorization?: ConnectorAuthorization | undefined;
|
|
1688
|
+
/**
|
|
1689
|
+
* Executing user when user authorization is selected.
|
|
1690
|
+
* @public
|
|
1691
|
+
*/
|
|
1692
|
+
user?: string | undefined;
|
|
1693
|
+
}
|
|
1694
|
+
/**
|
|
1695
|
+
* @public
|
|
1696
|
+
*/
|
|
1697
|
+
export interface ResolveConnectorConfigurationOutput {
|
|
1698
|
+
/**
|
|
1699
|
+
* Configuration contract resolved for the current values and account.
|
|
1700
|
+
* @public
|
|
1701
|
+
*/
|
|
1702
|
+
configuration: ConnectorConfigurationDefinition;
|
|
1703
|
+
}
|
|
1704
|
+
/**
|
|
1705
|
+
* Fields supplied when a connector is created or replaced.
|
|
1706
|
+
* @public
|
|
1707
|
+
*/
|
|
1708
|
+
export interface UpdateConnectorInput {
|
|
1709
|
+
/**
|
|
1710
|
+
* Immutable definition used to validate configuration and execute tools.
|
|
1711
|
+
* @public
|
|
1712
|
+
*/
|
|
1713
|
+
definition: ConnectorDefinitionRef;
|
|
1714
|
+
/**
|
|
1715
|
+
* Values validated against the definition configuration schema.
|
|
1716
|
+
* @public
|
|
1717
|
+
*/
|
|
1718
|
+
configuration: __DocumentType;
|
|
1719
|
+
/**
|
|
1720
|
+
* Credential selection, omitted when no authorization is required. The same Nango
|
|
1721
|
+
* connection reference may be reused across multiple Tools and Connectors.
|
|
1722
|
+
* @public
|
|
1723
|
+
*/
|
|
1724
|
+
authorization?: ConnectorAuthorization | undefined;
|
|
1725
|
+
/**
|
|
1726
|
+
* Name exposed to administrators and AI agents.
|
|
1727
|
+
* @public
|
|
1728
|
+
*/
|
|
1729
|
+
name: string;
|
|
1730
|
+
/**
|
|
1731
|
+
* Description exposed to administrators and AI agents.
|
|
1732
|
+
* @public
|
|
1733
|
+
*/
|
|
1734
|
+
description: string;
|
|
1735
|
+
/**
|
|
1736
|
+
* Explicit allowlist of tools available to callers and agents.
|
|
1737
|
+
* @public
|
|
1738
|
+
*/
|
|
1739
|
+
enabledTools: string[];
|
|
1740
|
+
/**
|
|
1741
|
+
* The unique identifier of the tenant when a service token is used.
|
|
1742
|
+
* @public
|
|
1743
|
+
*/
|
|
1744
|
+
companyId?: string | undefined;
|
|
1745
|
+
/**
|
|
1746
|
+
* Connector instance identifier.
|
|
1747
|
+
* @public
|
|
1748
|
+
*/
|
|
1749
|
+
connectorId: string;
|
|
1750
|
+
}
|
|
1751
|
+
/**
|
|
1752
|
+
* @public
|
|
1753
|
+
*/
|
|
1754
|
+
export interface UpdateConnectorOutput {
|
|
1755
|
+
/**
|
|
1756
|
+
* Updated connector.
|
|
1757
|
+
* @public
|
|
1758
|
+
*/
|
|
1759
|
+
connector: Connector;
|
|
1760
|
+
}
|
|
950
1761
|
/**
|
|
951
1762
|
* @public
|
|
952
1763
|
*/
|
|
@@ -977,10 +1788,10 @@ export interface UpdateToolInput {
|
|
|
977
1788
|
*/
|
|
978
1789
|
description: string;
|
|
979
1790
|
/**
|
|
980
|
-
*
|
|
1791
|
+
* Agent arguments. Omit when handler.connector is set; the service resolves input from the pinned connector tool definition.
|
|
981
1792
|
* @public
|
|
982
1793
|
*/
|
|
983
|
-
input
|
|
1794
|
+
input?: ToolInput | undefined;
|
|
984
1795
|
/**
|
|
985
1796
|
* Handler of the tool, used to execute the tool.
|
|
986
1797
|
* @public
|